Teil 3: Ein externer Codegenerator für Copy and Paste
Auch eine veraltete Entwicklungsumgebung, die keinerlei Plug-in-Möglichkeiten bietet, kann durch einen externen Codegenerator aufgewertet werden, dessen erzeugte Teile des Quellcodes mit Copy and Paste in den 4GL-Codeeditor übertragen werden. Nach dem Ansatz „we build to learn“ werde ich auch in diesem Teil der Serie wieder kleine Teilaufgaben angehen, die sich mit meiner 4GL-Arbeit kombinieren lassen. Es ist eine Erarbeitung von Xtext in kleinen Schritten. Dennoch ist immer wieder erstaunlich, wie viel Nutzen man schon aus wenigen Zeilen Xtext- bzw. Xtend-Code ziehen kann.
JavaFX Xtended
Nachdem wir uns bisher in dieser Artikelreihe mit dem Erzeugen und Nutzen von Ladedateien beschäftigt haben, werden wir für unsere 4GL-Entwicklung, die keinerlei „Active Annotations“ und ähnliche Herrlichkeiten zur dynamischen Codierung kennt, einen externen Codegenerator erstellen, dessen Erzeugnisse wir per Copy and Paste in die 4GL-Entwicklungsumgebung übernehmen werden. Neben einer drastischen Erhöhung der Produktivität (besonders bei Langsamtippern wie mir) trägt dies auch zur Qualitätssicherung bei, da im gesamten Boilerplate-Text Tippfehler ausgeschlossen sind.
Es beginnt alles mit einem Lückentext
Je öfter ich als Langsamtipper gezwungen bin, immer wieder den gleichen Text einzutippen, desto größer wird mein Verlangen, dies zumindest in einem Textbaustein abzulegen, bei dem ich nur noch den variablen Teil ersetzen muss. Diese Templates werden innerhalb des Eclipse-Ecosystems besonders schön unterstützt, wie wir schon in Teil 1 gesehen haben.
Da wir in unserer DSL-Grammatik eine Eingabemöglichkeit für freien Code geschaffen haben, wenn dieser in «» eingeschlossen ist, können wir ein Template dadurch aufbauen, indem wir aus dem 4GL-Quellcode ein Muster per Copy and Paste in das Eclipse-Template übernehmen. Wir ersetzen die Variablen durch die Platzhalter "${variable}" und haben so unsere Eingabevorlage erstellt. Hier haben wir den gesamten Quellcodetext „offen“ in unserem DSL-Editor, und der Generator fügt ganz einfach diesen Text in die generierte Datei ein (Abb. 1).
Abb. 1: Dieses Template liefert die Grundlage für die DSL, mit TAB springt man von Variable zu VariableDie Abbildungen 2 und 3 zeigen die einzelnen Schritte der Ersetzung.
Abb. 2 und 3: Wir müssen die Variablen unseres Lückentexts nur einmal angeben, alle anderen Vorkommen werden automatisch aktualisiertWenn wir später die Einarbeitung des Lückentexts in den Generator verlagert haben, wandelt sich das Template in einen Steuerungsbefehl, der aber ebenso als Template den Nutzer unterstützt (Abb. 4).
Abb. 4: Nach der Auslagerung mittels „mergefile“ können wir unser Template deutlich verkleinern: unser DSL-Inhalt wird wesentlich übersichtlicherWir haben in unserer 4GL eine Reihe von Hilfsroutinen in einer Art Framework zusammengestellt und können die bereitgestellten Routinen überschreiben. Die Absicherung ist etwas kompliziert, da ein @overwrite nicht unterstützt wird. Wir sehen, dass viele Namen immer wieder vorkommen, wie hier bei der Abarbeitung eines Datensatzes (actioncode="OCC") in einer Schleife über eine Tabelle (entityname="UXGROUP"):
#ifundefined OCC_UXGROUP
entry OCC_UXGROUP
#define OCC_UXGROUP
variables
endvariables
;call RETR_UCGROUP("U_VLAB=%%UBASE.UXGROUP%%%·;U_GLAB=%%ULABEL.UXGROUP%%%")
call MAKE_DSL_UXGROUP_1()
end ; OCC_UXGROUP
#endif ; undefined OCC_UXGROUP
Ausgehend von einer recht einfachen Konstruktion, die uns aber schon einen Eclipse-fähigen DSL-Editor zur Nutzung von Texttemplates erzeugt, werden wir unseren Codegenerator schrittweise um neue Funktionalität erweitern. Dem einmalig zu erbringenden Arbeitsaufwand stehen wiederkehrende Vorteile bei Produktivität und Fehlerreduktion entgegen; eine Rechnung, die praktisch immer aufgeht.
Schritt 1: Freie Texteingabe
Für die freie Eingabe von Quelltext verwenden wir den Ansatz, der auch in Xtend genutzt wird: eingerahmt von « und », die normalerweise nicht in Quellcodes auftauchen, wird der gesamte Text als Block übernommen. In Xtext wird dies durch die folgenden Angaben erreicht, die das until token (->) nutzen:
Model:
modules+=Freecode+;
Freecode: text=ML_FREECODE;
terminal ML_FREECODE : '«' -> '»' ;
Bei diesen Angaben werden in Xtend die einrahmenden Zeichen mitgegeben; wir entfernen sie durch den substring-Befehl in der decodeFreeCode-Hilfsroutine, die einfach aufgerufen wird:
def String decodeFreeCode(String freeCode)
{freeCode.substring(1,freeCode.length-1)}
def makeTheCode(Resource resource, Model sm) '''
«FOR Freecode modul : sm.modules»
«decodeFreeCode(modul.text)»
«ENDFOR»
'''
Da Guillemets nicht auf der Tastatur vorkommen « ALT+0187 im Ziffernblock bzw. » ALT-0171), haben wir zur Unterstützung für den Kontext Freecode ein Texttemplate FreeText eingerichtet:
«${cursor}»
Schritt 2: Freie Texteingabe mit Eclipse-Texttemplates
Da wir in unserer DSL-Grammatik schon eine Eingabemöglichkeit für „freien“ Code geschaffen haben, wenn dieser in «» eingeschlossen ist, können wir ein Template dadurch aufbauen, dass wir aus dem 4GL-Quellcode ein Muster per Copy and Paste in das Eclipse-Template übernehmen. Wir ersetzen die variablen Teile unseres Lückentexts durch die Platzhalter ${variable} und haben so mit geringem Arbeitsaufwand unsere Eingabevorlage erstellt:
«#ifundefined ${actioncode}_${entityname}
entry ${actioncode}_${entityname}
#define ${actioncode}_${entityname}
variables
endvariables
;call RETR_UCGROUP("U_VLAB=%%UBASE.${entityname}%%%•;U_GLAB=%%ULABEL.${entityname}%%%")
call MAKE_DSL_${entityname}_1()
end ; ${actioncode}_${entityname}
#endif ; undefined ${actioncode}_${entityname}»
Durch die Nutzung der Platzhalter haben wir den Luxus, dass der eingegebene Text auf alle anderen Vorkommen automatisch übertragen wird; außerdem können wir mittels TAB zum nächsten Platzhalter springen.
Schritt 3: Texttemplates in Datei auslagern
Bisher haben wir unseren Code aus Texttemplates zusammengebaut und so schon in unserer DSL-Datei den gesamten Ausgabecode zusammengestellt. In einem nächsten Schritt werden wir diese Templates in eine Textdatei auslagern (natürlich ohne die für den Freecode nötigen «»).
Das Verzeichnis für diese Dateien ist auf der gleichen...

