Development/KDevelop-PG-Qt Introduction
This is a German article. There's not yet any English version!
KDevelop-PG-Qt ist der Parser-Generator aus KDevplatform. Er wird für einige KDevelop-Sprachunterstützungs-Plugins verwendet (Ruby, PHP, Java...).
Das Programm
Anwendung
Das Programm KDevelop-PG-Qt findet sich im [1] . Dort finden sich auch drei kleine Beispiele.
svn co svn://anonsvn.kde.org/home/kde/trunk/playground/devtools/
Das Programm verlangt eine .g-Datei als Eingabe:
./kdev-pg-qt --output=''prefix'' syntax.g
Alle Dateien werden dann mit dem angegebenen Präfix erstellt und es gibt auch den namespace für den erzeugten Code an.
Ausgabe
Das Programm gibt Informationen über sogenannte Konflikte aus und erzeugt mehrere Dateien (jeweils mit dem gewählten Präfix).
ast.h
Hier wird eine Datenstruktur definiert, in der der Parsetree gespeichert wird. Die Knoten des Baums sind alle structs mit dem Postfix AstNode, die Zeiger auf die möglichen Unterelemente enthalten.
parser.h und parser.cpp
Hier werden ein enum für die Tokens definiert und das eigentliche Parsen erledigt. Für jeden Nicht-Terminal existiert eine Funktion parseNicht_terminal_name. Die Parser-Klasse verlangt einen Tokenizer. Möchte man nun eine Token-Folge parsen, erzeugt man einen Pointer auf die Wurzel (z.B. DocumentAstNode*) und ruft parseDocument(&root) auf. Bei Erfolg wird in root der Parsetree abgelegt.
visitor.h und visitor.cpp
Diese beiden Dateien definieren eine abstrakte Basis-Klasse zur Traversierung über den Parsetree.
defaultvisitor.h und defaultvisitor.cpp
Die hier definierte Klasse ist eine Implementierung des visitors, die automatisch die Unterknoten eines Knotens besucht. Möchte man über den gesamten Parsetree traversieren, ist diese Klasse als Basisklasse gut geeignet.
CLI-Optionen
- --namespace=namespace - Einen Namespace unabhängig vom Datei-Präfix festlegen (dann darf das Präfix auch / enthalten)
- --no-ast - Die ast.h-Datei wird nicht erstellt, dazu später mehr
- --debug-visitor - Code zur Ausgabe des Parse-Trees wird erzeugt
- --serialize-visitor - Code zur Serialisierung über ein QIODevice wird erstellt
- --symbols - Alle Nicht-Terminale werden in eine Datei kdev-pg-symbols geschrieben
- --rules - Alle Regeln werden mit Informationen zum syntaktischen Zusammenhang (hilfreich zur Konflikt-Behebun) in eine Datei namens kdev-pg-rules geschrieben
- --help - Eine (nicht besonders aufschlussreiche) Hilfe wird angezeigt
Tokenizer
Wie bereits kurz erwähnt erfordert KDevelop-PG-Qt einen fertigen Tokenizer. Entweder man schreibt sich diesen selbst oder man verwendet ein Tool wie Flex. Mit den Beispielen sollte es kein Problem sein, sich solch einen Tokenizer zu konstruieren. Zwischen den meisten Sprachen unterscheidet sich die Syntax von Kommentaren, Literalen etc. nicht großartig, so dass hier wenig zu tun ist. Das Hinzufügen von einfachen Tokens ist eine Triviale Angelegenheit:
"special-command" return Parser::Token_SPECIAL_COMMAND;
Das war es im wesentlichen, wenn man vorhandene Dateien (java.ll ist exzellent) als Vorlage verwendet.
Der Tokenizer sollte in der Regel solche oder ähnliche Aufgaben übernehmen:
- Umwandlung von Schlüsselwörtern und Sonderzeichen mit besonderer Bedeutung in Tokens
- Umwandlung von Literalen und Bezeichnern in Tokens
- Herausstreichen von allem, was die Syntax nicht beeinflusst: Kommentare, unnötige Leerzeichen (natürlich nicht in Python) u.ä.
- Handeln der Zeichen-Kodierung
Eben alles, was mit dem Tokenizer genau so einfach oder einfacher als mit KDevelop-PG-Qt gemacht werden kann.
Schreiben von .g-Dateien
Typ2-Grammatiken
Die verwendeten Typ2-Grammatiken werdenso aufgebaut, das sich jeweils ein Nicht-Terminal (Symbol) aus weiteren Nicht-Terminalen und Terminalen (Tokens) zusammensetzt. Bei der Grundstruktur kann man sich an die Semantik der Sprache halten, allerdings wird man immer wieder kleine Helfer benötigen. Ein C++-Dokument besteht beispielsweise aus vielen Deklarationen. Klassen-Definitionen sind ein Beispiel. Diese bestehen wiederum aus dem Token CLASS, einem Namen, dem Token {, Klassen-Element-Deklarationen, dem Token } und dem Token ;. Klassen-Element-Deklaration ist ein solcher Helfer. Kein normaler C++-Entwickler benutzt solch ein Wort, sie helfen jedoch die Struktur des Codes aufzuschlüsseln.
Grundlegende Syntax
Nun kann man einmal versuchen solche Beschreibungen in der KDevelop-PG-Qt-Syntax zu fassen:
class_declaration
| struct_declaration
| function_declaration
| union_declaration
| namespace_declaration
| typedef_declaration
| extern_declaration
-> declaration ;;
Das |-Zeichen steht für ein oder. Jede Regel endet mit zwei Semikola. Diese Unter-Deklarationen müssen nun wiederum definiert werden. Dabei werden Nicht-Terminale klein und Tokens groß geschrieben.
CLASS IDENTIFIER SEMICOLON
| CLASS IDENTIFIER LBRACE class_declaration* RBRACE SEMICOLON
-> class_declaration ;;
Ein neues Zeichen ist aufgetaucht: Der Stern bedeutet wie in regulären Ausdrücken, dass etwas 0-unendlich mal auftreten darf. Das Zeichen 0 steht für eine leere Token-Folge. Klammerung ist beliebig möglich.
Speicherung im Parsetree
Mit dieser einfachen Regel-Deklaration wird zwar die Token-Folge geparst, jedoch wird kein Parsetree gespeichert. Dies lässt sich leicht ändern:
class_declaration=class_declaration
| struct_declaration=struct_declaration
| function_declaration=function_declaration
| union_declaration=union_declaration
| namespace_declaration=namespace_declaration
| typedef_declaration=typedef_declaration
| extern_declaration=extern_declaration
-> declaration ;;
In der Klasse DeclarationAstNode werden nun Zeiger auf Class_declarationAstNode, Struct_declarationAstNode etc. angelegt. Beim Parsen werden diese Zeiger belegt. (in diesem Fall natürlich immer nur einer, die anderen werden auf NULL gesetzt)
Möchte man Wiederholungen speichern, so wird auch noch eine Listenstruktur zur Verfügung gestellt, hierfür muss dem Variablennamen eine Raute (#) vorangestellt werden:
CLASS IDENTIFIER SEMICOLON
| CLASS IDENTIFIER LBRACE (#class_declaration=class_declaration)* RBRACE SEMICOLON
-> class_declaration ;;
Variablen können mehrfach benutzt werden:
#one=one (#one=one)*
-> one_or_more ;;
Unabhängig davon, wo die Variable #one benutzt wird: Ein Element wird an die selbe Liste angehängt.
Angabe der Tokens
An einer Stelle müssen alle Tokens aufgezählt werden. Aus ihnen wird ein enum in parser.h erstellt. Der zusätzlich anzugebende Name wird zur Anzeige von Fehlermeldungen u.ä. verwendet:
%token T1 ("T1-Name"), T2 ("T2-Name"), COMMA (";"), SEMICOLON (";") ;;
Spezielle Zeichen...
...für Regeln
Einige weitere Zeichen erleichtern die Arbeit:
(#one=one)+
-> one_or_more ;;
...entspricht genau obigem Beispiel.
Ebenfalls häufig verwendet ist das '@':
#item=item @ COMMA
-> comma_separated_list ;;
...sorgt genau dafür, dass zwischen den Items ein Komma stehen muss.
Dieses Syntax-Element ist zur Zeit leider auskommentiert:
?(item=item)
-> optional_item ;;
...entspricht genau:
(0 | item=item)
-> optional_item ;;
Verwendet man an Stelle des Gleichheitszeichens den Doppelpunkt (:), so wird lediglich während des Parsens eine lokale Variable für den Unterbaum eingerichtet wird.
...für manuellen Code
Manchmal muss im Parser manuell geschriebener Code eingebaut werden. Beispiele sind:
- Eine eigene Fehler-Behandlung
- Erzeugen der Tokens (wenn man es nicht von außerhalb machen möchte)
- Setzen bestimmter Variablen in den Nodes und dem Parser-Objekt (beispielsweise ließe sich bei einem C++-Parser zwischenspeichern, ob sich der Parser gerade in einem private, protected oder public Abschnitt befindet. In den Nodes der Elemente ließe sich eine solche Information speichern.
- Zusätzliche Prüfungen, die sich am schnellsten in C++ durchführen lassen
[:
// Code
- ]
...fügt der Datei parser.cpp den angegebenen Code hinzu.
Wird diese Konstrukt innerhalb einer Regel verwendet, so wird der Code an der entsprechenden Stelle des Parsens eingefügt.
?[:
// Boolescher Ausdruck
- ]
...sorgt dafür, dass der Boolesche Ausdruck Voraussetzung für die aktuelle Regel wird.
%parserclass ( [private|protected|public] declaration)
[:
// Code
- ]
...fügt der Parser-Klasse in der Datei parser.h im entsprechenden Abschnitt Code hinzu.
Wer Elemente hinzufügt, braucht auch Zugriff auf Konstruktor und Destruktor:
%parserclass ( [constructor|desctructor] )
[:
// Code
- ]
...fügt den entsprechenden Funktionen den Code hinzu.
%ast_extra_members
[:
// Code
- ]
...fügt jeder Knoten-Klasse Code hinzu. (ast.h)
Konflikte
Erste Versuche, so einen Parser zu erzeugen, werden wahrscheinlich fehlschlagen. Es wird ein Konflikt angezeigt und das Parsen funktioniert nicht richtig.
Ein Beispiel für einen sogenannten FIRST/FIRST-Konflikt:
CLASS IDENTIFIER SEMICOLON
-> class_declaration ;;
CLASS IDENTIFIER LBRACE class_content RBRACE SEMICOLON
-> class_definition ;;
class_declaration
| class_definition
-> class_expression ;;
Ausgabe:
** WARNING found FIRST/FIRST conflict in "class_exp"
Manchmal kann man mit Warnungen leben, deshalb wird Code erzeugt, eine class_expression wird jedoch nicht korrekt ausgewertet werden. Enthält der Code z.B. eine class_definition, so wird der Parser zuerst in die Funktion für die class_declaration hineinspringen, da er das führende Token CLASS identifiziert hat. Das Semikolon wird jedoch nicht gefunden und es kommt zu einer Fehlermeldung.
Backtracking
Wer solche Grammatiken nur von der Theorie her kennt, den wird diese Vorgehensweise vielleicht verwundern. Denn in der BNF wäre so eine Angabe beispielsweise vollkommen in Ordnung. Der Parser könnte zum Beispiel zurück springen und die nächste Alternative ausprobieren. Dies ist jedoch nicht immer erforderlich und für eine gesteigerte Effizienz wird nach Möglichkeit darauf verzichtet. Es gibt jedoch eine Möglichkeit, die ganzen Konflikte zu umgehen, denn KDevelop-PG-Qt unterstützt besagtes Backtracking:
try/rollback(class_declaration)
catch(class_definition)
-> class_expression ;;
So lassen sich alle Konflikte auflösen, dieses Vorgehensweise geht allerdings auf Kosten der Effizienz. Außerdem sollte die Reihenfolge beachtet werden (zur Effizienzsteigerung und zum korrekten Aufbau des Parsetrees).
Elegante Lösungen
In sehr vielen Fällen finden sich elegantere Lösungen. So auch in unserem Beispiel:
LBRACE class_content RBRACE
-> class_definition ;;
CLASS IDENTIFIER (0 | class_definition) SEMICOLON
-> class_expression ;;
Nun gibt es keine Konflikte mehr.
FIRST/FOLLOW-Konflikte
Von FIRST/FOLLOW-Konflikten spricht man dann, wenn es uneindeutig ist, wo ein Symbol endet und wo das Eltern-Symbol forgesetzt wird. Ein stupides Beispiel:
item*
-> item_list ;;
item_list item*
-> items ;;
Die Uneindeutigkeit ist offensichtlich. try/rollback hilft bei ernstzunehmenden Problemen (der Parser funktioniert nicht), oft lassen sich diese Konflikte allerdings auch ignorieren, jedoch sollte man sich darüber im klaren sein, dass der Parser greedy ist, also die item_list den größtmöglichen Platz einnehmen wird. Führt dies zu einer Unterteilung, die später zu Widersprüchen führt, helfen nur try/rollback oder eine Umstrukturierung.
try/recover
try/recover(expression)
-> symbol ;;
Dies entspricht in etwa:
[: ParserState *state = copyCurrentState(); :]
try/rollback(expression)
catch( [: restoreState(state); :] )
-> symbol ;;
Das heißt, man muss die Element-Funktionen copyCurrentState und restoreState sowie einen Typen ParserState definieren. Die Deklaration der beiden Funktionen erfolgt automatisch bei der Verwendung von try/recover. Dieses Verfahren ist anscheinend sinnvoll, wenn der Parsing-Prozess unter Zuhilfenahme von zusätzlichen Zuständen durchgeführt wird. Der Java-Parser benutzt das Feature sehr ausgiebig. Ich bin jedoch in diesem Verfahren nicht firm und durchschaue nicht ganz das Ziel bei dieser Vorgehensweise. Für zusätzliche Erklärung (oder Korrekturen) wäre ich sehr dankbar.