Hauptprogramm: eas3

• Initialisierungen und Aufräumarbeiten
• Kommandointerpreterschleife
• Verwaltung und Kontrolle des Datenflusses zwischen den Modulen (bindet alle Module ein und ruft die entsprechenden Subroutinen auf)
• Dispatcher für Interpreterroutinen
• Dispatcher für Ausfuehren

Variablenverwaltung: eas3varmod

• Dieses Modul importiert alle Module die vom Hauptprogramm benutzt werden. Es verwaltet die notwendigen Variablen, die vom Hauptprogramm an die entsprechenden Subroutinen übergeben werden.
• alle Variablen werden innerhalb dieses Moduls initialisiert und eine Möglichkeit zur Ausgabe der Variablen v.a. für Debugging-Zwecke geschaffen (nicht dokumentierter Befehl GLOBALVARS).
  Beim anlegen neuer Datenstrukturen sollte die Initialisierung hier erfolgen und die Möglichkeit zur Ausgabe entsprechend erweitert werden (Routinen eas3var_defaults und eas3var_print)
• Kein Modul (außer eas3 selbst) darf eas3varmod direkt oder indirekt einbinden!

Hilfsmodule:

Kommando- und Programm-Module:

Diese Module enthalten die eigentliche Funktionalität von EAS3. Jedes dieser Module enthält mindestens Routinen zur Interpretation der Kommandozeile des entsprechenden Befehls (*_cmd), einen Fehlerstring (*_msg), der sämtliche Fehlermeldungen dieses Moduls enthält und gegebenenfalls Routinen der ausführbaren Programme (*_prg), die erst durch AUSFUEHREN gestartet werden. Außerdem werden lokale Typdefinitionen, soweit sie in eas3varmod benötigt werden, exportiert. Von diesen Modulen werden aber keine weiteren Symbole exportiert (alles was sonst noch in diesen Modulen deklariert wird sollte PRIVATE sein).

Parsermodul

Im Parsermodul sind sämtliche Hilfsroutinen zusammengefaßt, die zur Interpretation der eingegebenen Kommandozeile benötigt werden. Dies sind einerseits Routinenen, welche nur in der Hauptschleife von eas3 benutzt werden, um die Eingabe zu lesen und einen eindeutig definierten String bestehend aus Kommandowort und Argumentliste zu generieren, und andererseits handelt es sich um Routinen zum Wandeln der Characterdaten der einzelnen Argumente in das gewünschte interne Format (Integer (get_unit, get_int), Real (get_real), Dateinamensstring (get_string), Indexintervall (get_range), Schlüsselwort (get_key)) oder zum Zählen (counttoken) oder Manipulieren (get_token, tocapital) der Befehlsargumente. Die Funktionalität der in parsermod abgelegten Routinen ist im Kopf des Moduls kurz erklärt. Der genaue Aufruf der Routinen ist den bereits bestehenden Beispielen bzw. der Definition der Subroutinen/Funktionen in pasermod zu entnehmen.

Grundsätzlich ist folgendes Vorgehen zu empfehlen:

Eine Kommandointerpreterroutine (*_cmd) wird vom eas3_dispatcher aufgerufen und bekommt die Argumentliste des jeweiligen Befehls übergeben. Daraufhin kann mit counttoken festgestellt werden, ob die geforderte Argumentanzahl (durch Komma getrennte Token) vorliegen. Anschließend kann schrittweise (mit get_token) immer ein Token von links von der Argumentliste abgeschnitten werden und je nach erwartetem Argumenttyp an die entsprechende Parserroutine zur Umwandlung weitergegeben werden.

Fehlerbehandlung

Die Fehlerbehandlung erfolgt auf zwei grundsätzlich verschiedene Methoden:

1. Methode mit errormod: Durch Aufruf der Routine fterr('Routinenname: Fehlerstring') wird die Programmausführung sofort mit der Fehlermeldung abgebrochen. Diese Methode wird nur im Hauptprogramm und im IO-Modul eas3rwmod benutzt.
2. Methode mit messagemod: Wenn in einer Routine ein Fehler auftritt bricht nicht die Routine selbst die Programmausführung ab, sondern die Routine setzt eine Statusvariable, welche anzeigt was für ein Fehler aufgetreten ist. Die Fehlermeldungen sind in einem String definiert der von dem Modul in dem die Routine definiert ist exportiert wird. Negative Statuswerte bedeuten Fehler, positive Statuswerte bedeuten Warnungen, während der Statuswert 0 für eine fehlerfreie Ausführung der Subroutine steht. Direkt nach dem Aufruf der Routine wird mit call message_check("routinenname",status,...) diese Statusvariable überprüft und gegebenenfalls eine entsprechende Fehlermeldung oder Warnung generiert. Der Programmabbruch erfolgt dann zentral gesteuert innerhalb der Routine message_check. (Diese Methode wird benutzt, um mit dem INTERAKTIV-Kommando auch beim Auftreten von Fehlern nicht das Programm abzubrechen, sondern nur eine Fehlermeldung auszugeben.)

neuen Befehl einbauen

Zunächst muß ein Kommandointerpreter (*_cmd) geschrieben werden und bei einem ausführbaren Programm auch die entsprechende ausführbare Routine (*_prg), welche dann von AUSFUEHREN aufgerufen wird. Die (*_cmd)-Routine eines ausführbaren Programmes muß am Ende den Programmzähler prg%nprg hochsetzen und sicherstellen, daß wirklich nur eine ausführbare Routine innerhalb eines AUSFUEHREN-Blockes vom Benutzer aufgerufen wird. Die Routinen werden zusammen mit einem entsprechenden Fehlerstring (*_msg), der alle notwendigen Fehlermeldungen enthält, und den notwendigen Konstanten- und Typdefinitionen in ein Modul gepackt. Das neue Modul muß dann vom eas3varmod eingebunden werden. Im Hauptprogramm ist der Gesamtfehlerstring um den Modulfehlerstring zu erweitern (verketten der entsprechenden Modulvariable (modulname_msg) mit dem Gesamtfehlerstring). Variablen zur Verwaltung der Befehlsoptionen werden in eas3varmod angelegt, initialisiert (eas3var_init) und in die Ausgaberoutine (eas3var_print) eingetragen.

Anschließend muß das neue Kommandowort im Hauptprogramm in der eas3cmdlist hinzugefügt und der Zähler CMDLISTLEN entsprechend erhöht werden. Der Aufruf für die Kommandointerpreterroutine mit den entsprechenden Argumenten muß in eas3_dispatcher hinzugefügt werden, während der Aufruf des ausführbaren Programmes in der Routine ausfuehren im Hauptprogramm hinzugefügt werden muß. Zum Schluß muß noch das Makefile angepaßt werden.

Wenn das neue Kommando funktioniert sollte natürlich auch die Dokumentation erweitert werden.

Und schon nach wenigen Stunden / Wochen wird man viel Freude an dem neuen Kommando haben! ;-)