SciTE - Option "MustDeclareVars" mittels Property automatisch setzen

In der Shoutbox tauchte die Frage auf, ob es eine Einstellung gibt, dass AutoIt-Skripte immer die Option "MustDeclareVars" enthalten.

Das ist nicht vorgesehen. Eine Lösung wären Abbrevs (muss man also zumindest einmal in jedem Skript ausführen). Die andere Variante stelle ich hier mit einem Lua-Skript bereit:

Das Ereignis OnBeforeSave wird dazu ausgewertet in Abhängigkeit von einer Property, die wir in der SciTEUser.properties hinterlegen.

Das Skript wird aktiv, sowie ein au3-Skript gespeichert wird.

EDIT: Per Property lässt sich jetzt einstellen, ob die Optionsprüfung nur bei neuen Skripts (1) oder bei jedem Skript(2), das in SciTE geöffnet, und dann gespeichert wird Anwendung findet.

EDIT_2: Zusätzlich kann gewählt werden, ob bei neuen Skripten die Option in Zeile 1 oder (wenn vorhanden) hinter dem TimeStamp eingefügt wird. Dazu muss in der SciTEStartup.lua in der Reihenfolge zuerst das TimeStamp-Skript aufgerufen werden. -- Aktuelle Version: v 0.2

- Opt.MustDeclareVars.au3=0 (oder Eintrag nicht vorhanden)

Option ist im Text mit Flag "0" - keine Aktion / mit Flag 1 - Flag wird auf "0" gesetzt

Option ist nicht im Text - keine Aktion

- Opt.MustDeclareVars.au3=1

Neue Datei wird gespeichert - Option wird an Position 0 (erste Zeile) eingefügt

- Opt.MustDeclareVars.au3=2

Bei allen au3-Skripten wird die Optionsprüfung durchgeführt

Die erste sichtbare Zeile im Editor und ebenso die Cursorposition bleiben unverändert.

#~ au3-Skripte ohne/mit(nur neue Datei)/mit(jede Datei) Option "MustDeclareVars" (0/1/2) speichern
Opt.MustDeclareVars.au3=1
#~ Nur bei Neuskripten UND wenn zuerst TimeStamp gesetzt wird (Aufrufreihenfolge in SciTEStartup.lua)
#~ Option einfügen in Zeile hinter TimeStamp (und Leerzeile): "1", sonst erste Zeile: "0" (oder Property nicht besetzt/vorhanden)
Opt.MustDeclareVars.TimeStamp.First=1

Das Lua-Skript Au3OptMustDeclareVars.lua speichert ihr in eurem Skriptordner mit den Lua-Dateien.

Die Datei muss nun noch im Startupskript (SciTEStartup.lua) hinterlegt werden.

Habt ihr einen eigenen Ordner für Lua-Skripte (empfohlen), dann muss dieser über eine Property in der SciTEUser.properties benannt werden und beim Startup geladen werden (Eintrag AM ANFANG):

EDIT: Der Teil mit "LUA_USER_PATH" ist jetzt ZWINGEND erforderlich.

local sUserLua = props["Lua.User.Scripts.Path"]

LUA_USER_PATH = sUserLua .. "\\?.dll;" .. sUserLua .. "\\?\\?.dll;"
package.cpath = LUA_USER_PATH .. package.cpath

LUA_USER_LUA = sUserLua .. "\\?.lua;" .. sUserLua .. "\\?\\?.lua;"
package.path = LUA_USER_LUA .. package.path

Um nicht immer den kpl. Pfad beim Laden angeben zu müssen empfiehlt es sich eine Funktion zum Laden der Userskripte AM ENDE des Startup-Skriptes einzufügen:

--------------------------------------------------------------------------------
--  Calls LoadLuaFile() with directory from Lua-User-Script property
--------------------------------------------------------------------------------
function LoadUserLuaFile(file)
    LoadLuaFile(file, props["Lua.User.Scripts.Path"] .. "\\")
end    -- LoadUserLuaFile()
--------------------------------------------------------------------------------

LoadUserLuaFile("Au3OptMustDeclareVars.lua")

EDIT: Es wird jetzt die Shell.dll für SciTE-Lua verwendet. Das Einbinden externer Bibliotheken habe ich hier im Detail beschrieben. Den Ordner shell in den Ordner mit den Lua-Skripten kopieren. Und dann, wie im verlinkten Thread beschrieben, die dll registrieren. Die angehängte ZIP entpacken und den Ordner umbenennen zu shell. (Ordnername und Dll-Name müssen identisch sein.

Falls ihr das Lua-Skript in den Lua-Ordner in SciTE speichert, muss AM ENDE der Startdatei eingefügt werden: LoadLuaFile("Au3OptMustDeclareVars.lua")

EDIT: Hatte ich vergessen zu erwähnen - SciTE muss neu gestartet werden!

Wo der Eintrag in der SciTEUser.properties steht ist schnurz. Das "am Anfang" bezog sich auf die Ergänzung des Startup-Luaskripts um die Nutzung eines eigenen Lua-Ordners.

Deine Einträge sind soweit OK.

Aber (hatte ich vergessen explizit zu erwähnen) - hast du SciTE auch neu gestartet?

Zitat von Musashi

Aktiviert man die LUA Skripte, dann wird beim Speichern eines .au3-Skriptes die Zeile Opt("MustDeclareVars", 1)

eingetragen, oder ? Das betrifft dann aber auch Fremdskripte (z.B. aus dem Forum), die ohne die Option MustDeclareVars=1 erstellt wurden.

Folge : Speichert man solche Skripte, bekommt man später haufenweise Syntaxerrors.

Genau, das gilt für alle Skripte - aber nur, wenn du diese speicherst. Das Öffnen und Ansehen ändert nichts am Skript und somit sehe ich da auch kein Problem.

Ich habe aber bereits vor Jahren ein Skript veröffentlicht, das alle Variablen eines Skriptes nachträglich deklariert.

Zitat von Moombas

Ich habe in deiner Au3OptMustDeclareVars.lua den Eintrag local mustdeclare = tonumber(props["Opt.MustDeclareVars.au3"]) or 0 geändert in local mustdeclare = tonumber(props["Opt.MustDeclareVars.au3"]) or 1. Jetzt gehts!

Sehr seltsam. Properties sind immer Text, deshalb wandele ich den gelesenen Wert in eine Zahl und weise den Wert 0 zu, falls die Property nicht existiert. Dann gibt tonumber() nämlich "nil" zurück. val = x or y bewirkt, dass x übernommen wird, aber wenn x = nil, wird y übernommen.

Dein Eintrag bewirkt jetzt, dass ohne Property immer die Option gesetzt wird.

Zitat von Bitnugger

Kannst du nicht überprüfen, ob die zu speichernde Datei noch nicht exisitiert (dann wäre es ein selbst erstelltes Scripts), und nur dann die Zeile einfügen, wenn Opt.MustDeclareVars.au3=1 ist?

Ja, tatsächlich - das geht. --- Werde ich noch einfügen. Füge dann als Option eine Property zum Überprüfen aller Skripte ein.

Aber kannst du mal testen, ob TimeStamp bei dir noch funktioniert, wenn du dieses Skript aktivierst?

Eigentlich ist das egal, wenn ich in verschiedenen Skripten dieselbe interne Funktion (OnBeforeSave) mehrfach aufrufe. Intern landet sowieso jedes Skript beim Laden in einem Globalen Array. Die Aufrufe der Event-Funktionen landen dann auf einem Stack und werden nacheinander abgearbeitet.

Bei mir ist jetzt folgender Effekt:

In SciTEStartup.lua:

- Aufruf TimeStamp.lua und danach Aufruf MustDeclare.lua: Nur das Skript für MustDeclare wird ausgeführt

- Aufrufreihenfolge umgekehrt: Nur TimeStamp wird ausgeführt

Also immer das zuletzt geladene Skript wird verwendet.

Das habe ich noch nie erlebt. Ich verwende die Event-Funktionen dutzendfach (z.B. in meiner OHK.lua und den zugehörigen Funktionen) ohne jede Kollision. Im Moment habe ich dafür keine Erklärung. Mal drüber schlafen.

So, da hatte ich mir ja ein Ei gelegt - zu lange keine Lua-Skripte mehr geschrieben.

Ich habe sowohl im TimeStamp-Skript, als auch in diesem Skript vergessen, eine neue Event-Klasse anzulegen für das verwendete Ereignis und die Funktionsaufrufe direkt in das zentrale Ereignis eingesetzt. Und da kann natürlich nur ein Wert landen - immer der letzte.

Ich habe das jetzt hier korrigiert und auch die Property entsprechend Bitnugger 's Vorschlag erweitert.

EDIT: Ich hatte gerade bemerkt, dass mein Lua-Skript im Editor noch nicht gespeichert war. Somit kann es sein, dass die hochgeladene Version noch einen Fehler hat. Habe jetzt die letzte Version geladen.

Übrigens, wer die TimeStamp.lua nutzt - bitte gleich mal am Skriptanfang ändern

-- declare table to hold helper functions
local f = {}

f.TimeStamp = EventClass:new(Common)

-- BEFORE SAVE==============================================BEGIN
function f.TimeStamp:OnBeforeSave(fname)
    local tFile = {Dir = props['FileDir'], Name = props['FileName'], Ext = props['FileExt']:lower()}
    if tFile.Ext == nil or (tFile.Ext ~= 'au3' and tFile.Ext ~= 'lua') then return end
    local stamp = tonumber(props["SetTimeStamp."..tFile.Ext])
    if stamp == 1 then f.InsertTimestamp(tFile) end
end
-- BEFORE SAVE================================================END

Zitat von Bitnugger

Kannst du in dem TimeStamp-Skript noch eine Option einbauen, damit es auch mit Python-Scripts funktioniert?

SetTimeStamp.py=1

Erledigt.

Das Optionsskript habe ich jetzt erweitert.

Falls ihr das TimeStamp-Skript auch verwendet, könnt ihr nun wählen, ob die Option in Zeile 1 oder erst nach dem TimeStamp (und der folgenden Leerzeile) eingefügt wird. Finde ich optisch ansprechender.

Aktuelle Version: v 0.2

Zitat

Was spricht denn dagegen?

Dann müsste man neue Skripte immer über das Template erstellen, statt aus SciTE heraus - habe ich z. B. noch nie gemacht.

Aber natürlich kann man das als zusätzliche Option auch verwenden, damit man über das Kontextmenü des Explorers neue Skripte mit Opt erstellen kann.

Zitat

Ein vorhandenes Template könnte man mit LUA automatisch einfügen, wenn eine leere Datei gespeichert wird.

Dann brauchte man, genau wie jetzt, ein zusätzliches Lua Skript.

Da wäre es doch überlegenswert, optional die Informationen, die im Template sind, auch hiermit einfügen zu lassen.

Ich persönlich habe noch keinen Bedarf gehabt das Template zu nutzen. Wenn ich eine UDF oder ein Programm erstellt habe, schreibe ich zum Abschluss sowieso detaillierte Erklärungen zum Skript. Sinnvoller wäre da (für mich), das Template einzufügen, wenn man fertig ist. Dann kann man automatisiert eine Funktions - und Parameterübersicht einfügen.

Ist halt alles Geschmackssache - alles ist möglich.