Blatt 10: DevDungeon & Syntax Highlighting (Reguläre Ausdrücke)

(1 Punkt)

DevDungeon: Brücken-Troll

Klonen Sie das Projekt DevDungeon und laden Sie es in Ihrer IDE als Gradle-Projekt. Betrachten Sie das Sub-Projekt "devDungeon". Dies ist ein von einem Studierenden (@Flamtky) erstelltes Spiel mit mehreren Leveln, in denen Sie spielerisch verschiedene Aufgaben in-game und ex-game lösen müssen.

Starten Sie den DevDungeon mit ./gradlew devDungeon:runDevDungeon. Spielen Sie sich für diese Aufgabe durch das vierte Level ("Bridge Guard Riddle")¹.

In diesem Level gibt es im oberen Teil eine Art Brücke, die von einem Brücken-Troll bewacht wird.

Diesen müssen Sie besiegen, um die Brücke passieren und die Belohnung (einen magischen Schild) zu bekommen. Den Schild können Sie im nächsten Level gut gebrauchen: Der Schild schützt Ihren Hero vor Schäden, auch wenn er nur einen Treffer verträgt und sich dann über eine gewisse Zeit regenerieren muss, bevor er wieder funktionstüchtig ist.

Hinweis: Sie können natürlich wie immer auch "außen herum" gehen und die Brücke vermeiden, um ins nächste Level zu kommen. Das ist aber ziemlich gefährlich, und Sie bekommen den magischen Schild nicht, den Sie für das letzte Level ziemlich dringend brauchen.

Hinweis: Aktuell ist das Projekt DevDungeon an einigen Stellen noch Work-in-Progress, beispielsweise fehlt häufig noch die Javadoc. Alle Gradle-Tasks, die von Checkstyle-Tasks abhängen (checkstyleMain, check, build, ...) werden deshalb fehlschlagen. Sie können den DevDungeon aber wie oben beschrieben mit ./gradlew devDungeon:runDevDungeon (bzw. über den Task devDungeon:runDevDungeon aus der IDE heraus) starten.

WICHTIG: Achten Sie bitte darauf, dass im Projektpfad keine Leerzeichen und keine Sonderzeichen (Umlaute o.ä.) vorkommen! Dies kann zu seltsamen Fehler führen. Bitte auch darauf achten, dass Sie als JDK ein Java SE 21 (LTS) verwenden.

A10.1: RegExp mit dem Brücken-Troll (20%)

Suchen Sie den Brücken-Troll auf und sprechen Sie ihn an. Er wird Ihnen eine Reihe von Fragen zum Thema reguläre Ausdrücke stellen, die Sie korrekt beantworten müssen.

Machen Sie Screenshots von den Fragen und Ihren Antworten, die Sie im Praktikum vorstellen und diskutieren.

A10.2: Command-Pattern mit der Klasse BridgeControlCommand (30%)

Leider lässt sich der Brücken-Troll offenbar weder durch Diskussion noch durch Kampf besiegen. Aber vielleicht können Sie die Brücke "aufmachen", so dass er in die Tiefe stürzt? Die Tiles der Brücke bestehen aus sogenannten PitTiles: Wenn diese offen sind, fällt man hindurch; wenn sie geschlossen sind, kann man gefahrlos darauf treten (außer, es ist eine Verzögerung aktiviert :-) ... Allerdings müssten Sie danach die Brücke auch wieder schließen, um selbst darüber hinweg laufen zu können ...

Schauen Sie sich die Info-Box am Eingang zur Brücke an. Der Hebel bedient mit Hilfe des Command-Patterns die Brücke. Für die Commands gibt es die Klasse BridgeControlCommand im Package entities.levercommands, wobei die Methode BridgeControlCommand#execute das Command ausführt und die Methode BridgeControlCommand#undo das Command wieder rückgängig macht.

Implementieren Sie die beiden Methoden und starten Sie das Spiel erneut.

Hinweis: Mit der Methode Game.currentLevel().tileAt() können Sie auf ein Tile an einer bestimmte Koordinate zugreifen.

A10.3: Syntaxhighlighting mit RegExp (50%)

Klonen Sie die Vorgaben "Syntax Highlighting" und laden Sie das Projekt als Gradle-Projekt in Ihre IDE.

Im Package highlighting finden Sie einige Klassen, mit denen man ein einfaches Syntax Highlighting durchführen kann. Dazu arbeitet der Lexer mit sogenannten "Token" (Instanzen der Klasse Token). Diese haben einen regulären Ausdruck, um bestimmte Teile im Code zu erkennen, beispielsweise Keywords oder Kommentare und anderes. Der Lexer wendet alle Token auf den aktuellen Eingabezeichenstrom an (Methode Token#test()), und die Token prüfen mit "ihrem" regulären Ausdruck, ob die jeweils passende Eingabesequenz vorliegt. Die regulären Ausdrücke übergeben Sie dem Token-Konstruktor als entsprechendes Pattern-Objekt.

• Die Klasse Token speichert dazu ein Pattern (einen vorkompilierten regulären Ausdruck) sowie eine Farbe, die später beim Syntax Highlighting für dieses Token genutzt werden soll. Bei der Anwendung eines Tokens auf einen String (Methode Token#test) wird das gespeicherte Pattern auf den String angewendet und eine Liste aller passenden Stellen im String zurückgegeben (List<Lexem>).

  Neben dem jeweiligen Pattern kennt jedes Token noch eine matchingGroup: Dies ist ein Integer, der die relevante Matching-Group im regulären Ausdruck bezeichnet. Wenn Sie keine eigenen Gruppen in einem regulären Ausdruck eingebaut haben, nutzen Sie hier einfach den Wert 0.

  Zusätzlich kennt jedes Token noch die Farbe für das Syntax-Highlighting in der von uns als Vorgabe realisierten Swing-GUI (Instanz von Color).

• Der Lexer sammelt eine Liste von Token und wendet sie in der übergebenen Reihenfolge auf den Eingabestring an (Methode Lexer#tokenize).

• Die Klasse LexerUI dient zum Anzeigen des ursprünglichen Textes und des Ergebnisses. Hier sieht man recht schnell, ob die Pattern bereits passen ... Man kann auf der linken Seite auch den Text editieren, und auf der rechten Seite des Fensters wird dann automatisch das Syntax Highlighting erneut durchgeführt.

• Die Klasse Main dient zum Definieren der konkreten Token (=> Aufgabe) und auch zum Starten der Demo.

Aufgabe: Definieren Sie alle in Main#setupTokens genannten Token, indem Sie jeweils einen passenden regulären Ausdruck formulieren und als Pattern in den Konstruktor geben zusammen mit einer Farbe, mit der dieses Token hervorgehoben werden soll:

• Strings: alles zwischen " und dem nächsten "
• Character: genau ein Zeichen zwischen ' und '
• Keywords: package, import, class, public, private, final, return, null, new (jeweils freistehend, also nicht "newx" o.ä.)
• Annotation: beginnt mit @, enthält Buchstaben oder Minuszeichen
• Einzeiliger Kommentar: beginnend mit // bis zum Zeilenende
• Mehrzeiliger Kommentar: alles zwischen /* und dem nächsten */
• Javadoc-Kommentar: alles zwischen /** und dem nächsten */

Sie können auch mit Matching Groups arbeiten und im Token eine bestimmte Gruppe hervorheben lassen. Dazu geben Sie einfach die Nummer der Matching-Group mit in den Token-Konstruktor. (Wenn Sie nichts übergeben, wird der gesamte Match genommen - das entspricht dem Wert 0).

Sollten Token ineinander geschachtelt sein, erkennt der Lexer dies automatisch. Sie brauchen sich keine Gedanken dazu machen, in welcher Reihenfolge die Token eingefügt und abgearbeitet werden. Beispiel: Im regulären Ausdruck für den einzeiligen Kommentar brauchen Sie keine Keywords, Annotationen, Strings usw. erkennen.