AutoIt: Grundlagen: Variablen

< AutoIt

Wer sich an seine Schulzeit zurück erinnert kann vielleicht etwas mit dem Begriff „Variable“ anfangen. Im Mathematikunterricht wurde uns gelehrt dass Variablen „Platzhalter“ sind. Dies ist auch in der Programmierung so. Aber anders als in der Mathematik können in Variablen nicht nur Zahlen, sondern auch Worte und Zeichen hinterlegt werden. Diese hinterlegten Werte können nach belieben gelesen und verändert werden. Somit sind Variablen ein zentraler Punkt in der Programmierung.

Jede Variable hat seinen eigenen Bezeichner den der Programmierer selber festlegen kann. Variablen werden stetig mit einem Dollarzeichen ( $ ) eingeleitet, danach folgt der Bezeichner. Für den Bezeichner dürfen alle Zahlen sowie Groß- und Kleinbuchstaben von A bis Z verwendet werden. Als einziges Sonderzeichen steht uns auch der Unterstrich ( _ ) zur Verfügung. Mithilfe eines Gleichheitszeichen können wir der Variable einen Wert zuweisen.

$var = 123
MsgBox(0, '', $var)

$var = 'Text'
MsgBox(0, '', $var)

Variablen deklarieren

Mit der Deklaration einer Variable ist in AutoIt gemeint ihr einen Gültigkeitsbereich und gegebenenfalls einen Wert zuzuordnen. Variablen sind nämlich nicht überall ansprechbar. Je nach ihrem Gültigkeitsbereich können auf bestimmte Variablen nur in besonderen Situationen angesprochen werden. AutoIt unterscheidet konkret nur zwischen globale und lokale Variablen.

Globale Variablen

Wie der Name vielleicht schon vermuten lässt können globale Variablen überall aus dem Skript angesprochen werden. Um eine globale Variable zu deklarieren steht uns das Schlüsselwort „Global“ zur Verfügung. Eine globale Variable muss nur einmal im ganzen Skript als global markiert sein. Danach steht diese ständig zur Verfügung.

Global $var

; Die Funktion IsDeclared zeigt uns an ob eine Variable deklariert wurde.
; Der Rückgabewert der Funktion beträgt für globale Variablen gleich 1.
MsgBox(0, '', IsDeclared('var'))

; Da wir der Variable noch keinen Wert zugewiesen haben ist diese leer.
MsgBox(0, '', $var)

Lokale Variablen

Im Gegensatz zu globalen Variablen lassen sich lokale Variablen nicht überall im Skript ansprechen. Allerdings gilt diese Regelung nur, wenn die Variable in einer eigenen Funktion lokal deklariert wird. Um eine lokale Variable zu deklarieren steht uns in AutoIt das Schlüsselwort „Local“ zur Verfügung.

Global $GlobaleVariable = 123


; Hier rufen wir unsere selbst geschriebene Funktion auf.
EigeneFunktion()

; Der Rückgabewert 0 zeigt uns an, dass die Variable noch nicht existiert.
; Da wir lokale Variable in einer eigenen Funktion untergebracht haben,
; wird diese nach dem verlassen der Funktion wieder gelöscht.
MsgBox(0, 'Skript - IsDeclared', IsDeclared('LokaleVariable'))

;~ MsgBox(0, 'Skript - Lokale Variable', $LokaleVariable) ; Dies würde eine Fehlermeldung erzeugen...


; Wie man eigene Funktionen schreibt und verwendet wird noch auf einer eigenen Seite erklärt.
Func EigeneFunktion()
	Local $LokaleVariable = 'Text'

	; Der Rückgabewert -1 zeigt uns an, dass die Variable nur lokal zur Verfügung steht.
	MsgBox(0, 'Eigene Funktion - IsDeclared', IsDeclared('LokaleVariable'))

	; Hier wird sowohl die globale, als auch die lokale Variable abgerufen.
	MsgBox(0, 'Eigene Funktion - Globale Variable', $GlobaleVariable)
	MsgBox(0, 'Eigene Funktion - Lokale Variable', $LokaleVariable)
EndFunc

Das „Dim“ Schlüsselwort

Mithilfe des Schlüsselwortes „Dim“ können wir ebenfalls eine Variable deklarieren. Jedoch wird auch hier die Variable entweder global oder lokal definiert. Der einzige Unterschied jedoch ist, dass das Schlüsselwort „Dim“ anhand der gegebenen Umständen selber aussucht wie die Variable deklariert werden soll. Unter folgenden Voraussetzungen kannst du erkennen ob eine mit „Dim“ deklarierte Variable nun global oder lokal definiert wurde:

Wenn die Variable vorher schon als global definiert wurde, so wird die Variable erneut mit leerem Inhalt global deklariert.
Wenn die Variable vorher schon als lokal definiert wurde, so wird die Variable erneut mit leerem Inhalt lokal deklariert.
Wird die Variable mit „Dim“ außerhalb einer Funktion deklariert, so ist diese global verfügbar.
Wird die Variable mit „Dim“ innerhalb einer Funktion deklariert, so ist diese lokal verfügbar.

Global $globalVar
Dim $dimGlobalVar


MyFunc()


Func MyFunc()
	Local $localVar
	Local $dimLocalVar

	MsgBox(0, 'Globale Variable', IsDeclared('globalVar'))
	MsgBox(0, 'Lokale Variable', IsDeclared('localVar'))
	MsgBox(0, 'Dim - Globale Variable', IsDeclared('dimGlobalVar'))
	MsgBox(0, 'Dim - Lokale Variable', IsDeclared('dimLocalVar'))
EndFunc

Hinweis

Prinzipiell verhält sich das „einfache“ erstellen einer Variable genauso als ob wir die Variable mit „Dim“ deklarieren. Der einzige Unterschied jedoch ist, dass wir die Variable nicht deklarieren sondern nur erstellen.

Dim $var1 ; Variable wird deklariert.
$var2 = 0 ; Variable wird erstellt.

Dabei handelt es sich nur um einen kleinen Unterschied der etwas mit einer einstellbaren AutoIt Option zu tun hat. Für den Anfänger jedoch irrelevant. Jedoch solltest du wissen dass es dort eine Unterscheidung gibt.

Warum sollte ich eine Variable deklarieren?

Dies hat verschiedene Gründe. Einmal gehört es zum guten Programmierstil den Gültigkeitsbereich einer Variable festzulegen. Zum anderen können damit Fehlerquellen direkt von Anfang an eingedämmt werden. Zwar ist es prinzipiell möglich Variablen zu verwenden ohne ihnen speziell ein Gültigkeitsbereich zuzuordnen, jedoch Fehleranfälliger. Siehe dazu folgende Situation:

Du programmierst für einen Freund (welcher ebenfalls Programmierer ist) eine kleine Funktion:

Func MyFunc()
	$var = 123
	MsgBox(0, 'MyFunc', $var)
EndFunc

Dein Freund versucht nun deine Funktion in sein geschriebenes Programm zu integrieren. Das klappt auch ganz gut, jedoch stellt dein Freund fest dass nun irgendwas mit seinem Programm nicht stimmt...

$var = 777

MyFunc()

MsgBox(0, 'Skript', $var)



Func MyFunc()
	$var = 123
	MsgBox(0, 'MyFunc', $var)
EndFunc

Was ist denn jetzt los? Sollte die Message Box in Zeile 5 nicht eigentlich eine 777 ausgeben?

Vielleicht hast du ja schon den Fehler erkannt. Da sich eine erstellte Variable wie eine mit „Dim“ deklarierte Variable verhält, wird in der Funktion auf die globale Variable zugegriffen. Das bedeutet dass der bereits vorhandene Wert einfach überschrieben wird. Nun gut, versuchen wir doch einfach mal den Fehler mithilfe von „Dim“ zu bereinigen:

Dim $var = 777

MyFunc()

MsgBox(0, 'Skript', $var)



Func MyFunc()
	Dim $var = 123
	MsgBox(0, 'MyFunc', $var)
EndFunc

Tja, leider ist der gleiche Fehler immer noch vorhanden. Aus diesem Grund wird „Dim“ auch nur in einigen Ausnahmefällen verwendet. Um solche Fehler zu vermeiden werden Variablen grundsätzlich nur mit „Global“ sowie „Local“ deklariert. Das Skript muss also folgendermaßen aussehen:

Global $var = 777

MyFunc()

MsgBox(0, 'Skript', $var)



Func MyFunc()
	Local $var = 123
	MsgBox(0, 'MyFunc', $var)
EndFunc

Klar hätte man bei diesem Beispiel einfach einen anderen Bezeichner für einen der beiden Variablen nutzen können. Aber sobald man richtige Projekte startet ist es Schluss mit lustig. Nach knapp 3000 Codezeilen weiß selbst der erfahrenste Programmierer nicht mehr alle Bezeichnungen seiner globalen Variablen. Besonders dann wenn dieser eine Pause von 1 bis 3 Monaten eingelegt hat. Um also solche Fehler zu umgehen, und nicht versehentlich auf globale Variablen zuzugreifen, wird der Gültigkeitsbereich für jede Variable festgelegt.

Konstanten

Eine speziellere Form von Variablen stellen die Konstanten dar. Anders als bei normalen Variablen können die Inhalte von Konstanten nicht verändert werden. Somit ist es nicht möglich eine Konstante, während ihrer Lebenszeit, neu zu deklarieren. Aus diesem Grund muss der zu beinhaltende Wert direkt bei der Deklaration angegeben werden. Auch hier kann man wieder zwischen einer globalen sowie lokalen Variable (in diesem Fall Konstante) unterscheiden. Eine Konstante wird, zusätzlich zu der optionalen Angabe des Gültigkeitsbereich, mit dem Schlüsselwort „Const“ deklariert.

Const $var = 123

Globale Konstanten

Globale Konstanten verhalten sich genauso wie globale Variablen. Der einzige Unterschied jedoch ist, dass deren Inhalt nicht verändert werden kann. Eine globale Konstante existiert bis zum Programmende. Bis dahin kann keine neue Variable mit dem gleichen Bezeichner deklariert werden.

Global Const $var = 123

;~ $var = 777 ; Dies würde eine Fehlermeldung erzeugen...

MsgBox(0, '', $var)

Lokale Konstanten

Lokale Konstanten verhalten sich genauso wie lokale Variablen. Der einzige Unterschied jedoch ist, dass der Inhalt nicht verändert werden kann solange die Konstante existiert. Beim verlassen der Funktion wird auch die Konstante gelöscht.

MyFunc()
MyFunc()
MyFunc()



Func MyFunc()
	; Random erzeugt eine zufällige Zahl.
	Local Const $var = Random()

;~ 	$var = 777 ; Dies würde eine Fehlermeldung erzeugen...
	MsgBox(0, '', $var)
EndFunc

Konstanten mit dem Schlüsselwort „Dim“

Wie bei den Variablen sucht sich „Dim“, je nach Situation, seinen Gültigkeitsbereich selber aus. Jedoch sollte es vermieden werden Konstanten sowohl nur mit „Const“ als auch mit „Dim Const“ zu deklarieren. Die Problematik dahinter ist die Gleiche wie bei den normalen Variablen.

Konstanten mit dem Schlüsselwort „Enum“

Eine etwas speziellere Möglichkeit um mehrere Konstanten zu definieren stellt das Verwenden des Schlüsselwortes „Enum“ dar. Mithilfe dieses Schlüsselwortes können mehrere Konstanten (mit unterschiedlichen oder gleichen Inhalt) deklariert werden. Dabei ist der Inhalt abhängig von der Position des verwendeten Bezeichners.

Enum $a, $b, $c, $d, $e, $f

MsgBox(0, '', _
	'a = ' & $a & @CRLF & _
	'b = ' & $b & @CRLF & _
	'c = ' & $c & @CRLF & _
	'd = ' & $d & @CRLF & _
	'e = ' & $e & @CRLF & _
	'f = ' & $f)

Zudem ist es möglich auch Konstanten einzeln einen Wert zuzuweisen. Es muss jedoch beachtet werden dass sich der Inhalt aller nachfolgenden Konstanten ändert.

Enum $a = 5, $b, $c, $d = 10, $e, $f

MsgBox(0, '', _
	'a = ' & $a & @CRLF & _
	'b = ' & $b & @CRLF & _
	'c = ' & $c & @CRLF & _
	'd = ' & $d & @CRLF & _
	'e = ' & $e & @CRLF & _
	'f = ' & $f)

Um die Inhalte der Konstanten in einem bestimmten Schema zu ändern, können wir das Schlüsselwort „Step“ hinzufügen. Dadurch erhalten wir eine gewisse Entscheidungsfreiheit was das verändern des Inhaltes der Konstanten angeht. Uns stehen 3 Optionen zur Verfügung:

Step + (?) >> Alle nachfolgenden Konstanten erhöhen sich um (?). (Addition)
Step - (?) >> Alle nachfolgenden Konstanten vermindern sich um (?). (Subtraktion)
Step * (?) >> Alle nachfolgenden Konstanten verändern sich um (?). (Multiplikation)

Beispiel Addition

Enum Step +2 $a, $b, $c, $d, $e, $f

MsgBox(0, '', _
	'a = ' & $a & @CRLF & _
	'b = ' & $b & @CRLF & _
	'c = ' & $c & @CRLF & _
	'd = ' & $d & @CRLF & _
	'e = ' & $e & @CRLF & _
	'f = ' & $f)

Beispiel Subtraktion

Enum Step -1 $a, $b, $c, $d, $e, $f

MsgBox(0, '', _
	'a = ' & $a & @CRLF & _
	'b = ' & $b & @CRLF & _
	'c = ' & $c & @CRLF & _
	'd = ' & $d & @CRLF & _
	'e = ' & $e & @CRLF & _
	'f = ' & $f)

Beispiel Multiplikation

Enum Step *2 $a = 1, $b, $c, $d, $e, $f

MsgBox(0, '', _
	'a = ' & $a & @CRLF & _
	'b = ' & $b & @CRLF & _
	'c = ' & $c & @CRLF & _
	'd = ' & $d & @CRLF & _
	'e = ' & $e & @CRLF & _
	'f = ' & $f)

Hinweis

Auch Konstanten die mithilfe von „Enum“ deklariert werden, können einen Gültigkeitsbereich zugeordnet werden. Die Regeln sind die gleichen wie bei normalen Konstanten sowie Variablen.

Global Enum ; ...
Local Enum ; ...
Dim Enum ; ...
Enum ; ...

Arrays

Mithilfe von Arrays lassen sich größere Datenmengen unter einem Bezeichner unterbringen. Jedoch ist ein einzelner Zugriff auf bestimmte Daten möglich. Ein Array besteht aus Dimensionen und Indizes. Die Dimension gibt dabei die Größenordnung an (beispielsweise 1D, 2D oder auch 3D). Mit dem Index oder die Indizes können auf einzelne Elemente zugegriffen werden. Ein Array wird ansonsten wie eine normale Variable behandelt.

Die Deklaration eines Arrays

Anders als Variablen lassen sich Arrays nicht einfach erstellen, sondern müssen mit einem der 4 Schlüsselwörtern „Global“, „Local“, „Dim“ und/oder „Const“ deklariert werden. Dabei müssen die Anzahl der Elemente sowie die Dimension des Arrays direkt festgelegt werden.

Dim $Array[5] 		; 1-dimensionales(x-Achse) Array mit 5 Elementen.
Dim $Array[10][5]	; 2-dimensionales(x-Achse, y-Achse) Array mit 10*5 Elementen.
Dim $Array[3][6][9]	; 3-dimensionales(x-Achse, y-Achse, z-Achse) Array mit 3*6*9 Elementen.

Folgendes kann man sich unter einem N dimensionales Array vorstellen:

1D Array >> Hier reicht es aus sich das Array als einfache Liste vorzustellen.
2D Array >> Darunter kann man sich eine Tabelle vorstellen mit x an Spalten und y an Zeilen.
3D Array >> Bei einem 3D Array kann man sich einen Raum darstellen mit der Breite x, der Tiefe y und der Höhe z.
4D Array >> Ein vierdimensionales Array wird zumeist in der Entwicklung von Spielen im zusammenhang mit DirectX-Vektoren genutzt und beschreibt die Breite x, die Höhe y, die Tiefe z und die waagerechte Zeit- und Schattenreferenzvariable k.

Technisch kann in AutoIt ein Array mit bis zu 64 Dimensionen erzeugt werden. Praktisch aber reicht maximal ein 3D Array aus, da alles andere unseren Vorstellungen entrinnen würde.

Auf das Array zugreifen

Der Zugriff auf das Array erfolgt ein wenig anders als bei einer Variable. Wir haben bei der Deklaration sowohl die Dimension, als auch die Anzahl der Elemente angegeben. Damit AutoIt nun weiß welches Element gemeint ist, muss mit einem Index (oder bei mehreren Dimensionen mit Indizes) gearbeitet werden. Wichtig ist jedoch, dass das erste Element nicht bei dem Index [1] liegt, sondern bei [0]. Das bedeutet bei [5] Elementen eines 1D Arrays haben wir die Indizes [0], [1], [2], [3] und [4] zur Verfügung. Möchte man auf das dritte Element zugreifen, so muss der Index [2] verwendet werden.

Dim $Array[5] ; 5 Elemente
$Array[0] = 'Erstes Element'
$Array[1] = 'Zweites Element'
$Array[2] = 'Drittes Element'
$Array[3] = 'Viertes Element'
$Array[4] = 'Fünftes Element'
;~ $Array[5] = 'Sechstes Element' ; Dies würde eine Fehlermeldung erzeugen...

MsgBox(0, '', $Array[2])

Hinweis

Die Inhalte eines Arrays lassen sich auch direkt bei der Deklaration festlegen.

Dim $Array[] = [1, 2, 3] ; 1D Array mit 3 Elementen.
Dim $Array[][] = [[1, 2], [3, 4]] ; 2D Array mit 2*2 Elementen.
Dim $Array[][][] = [[[1, 2], [3, 4]], [[5, 6], [7, 8]]] ; 3D Array mit 2*2*2 Elementen.

MsgBox(0, '', '[0][0][0] = ' & $Array[0][0][0] & @CRLF & _
			  '[0][0][1] = ' & $Array[0][0][1] & @CRLF & _
			  '[0][1][0] = ' & $Array[0][1][0] & @CRLF & _
			  '[0][1][1] = ' & $Array[0][1][1] & @CRLF & _
			  '[1][0][0] = ' & $Array[1][0][0] & @CRLF & _
			  '[1][0][1] = ' & $Array[1][0][1] & @CRLF & _
			  '[1][1][0] = ' & $Array[1][1][0] & @CRLF & _
			  '[1][1][1] = ' & $Array[1][1][1])

Statische Variablen

Der wesentliche Unterschied zwischen einer normalen und einer statischen Variable ist die Lebenszeit. Eine statische Variable wird mit dem Schlüsselwort „Static“ deklariert. Dazu kann der Gültigkeitsbereich „Global“ oder „Local“ angegeben werden. Da sich jedoch eine statische globale Variable in AutoIt genauso verhält wie eine globale Variable, wird darauf nicht näher eingegangen.

Global Static ; ...
Static Global ; ...
Local Static ; ...
Static Local ; ...
Static ; ...

Lokale statische Variablen

Normalerweise wird eine lokale Variable, nach dem verlassen einer Funktion, gelöscht. Bei einer lokalen statischen Variable ist dies nicht so, diese existiert dennoch weiter. Jedoch kann nach wie vor nur in der Funktion auf die statische Variable zugegriffen werden. Auch Arrays können statisch deklariert werden.

MyFunc()
MyFunc()
MyFunc()

;~ MsgBox(0, '', $var) ; Dies würde eine Fehlermeldung erzeugen...

Func MyFunc()
	Local Static $var
	$var += 1
	MsgBox(0, '', $var)
EndFunc

Hinweis

Statische Variablen sind nur im Zusammenhang von Funktionen interessant. Aus diesem Grund wird an dieser Stelle nicht weiter darauf eingegangen.