ANTLR4 - Przykładowa implementacja w C#

[H1M4W4R1]

Preludium

W poprzednim artykule wkradł się błąd i zabrakło znaku + w typach liczbowych. Bez niego ANTLR4 będzie wyrzucał błąd jeżeli liczba będzie miała więcej niż 1 znak.

Treść

Oto część druga… Dzisiaj zajmiemy się tworzeniem narzędzia wykonującego kod naszego języka.

Pierwsze co musimy zrobić to stworzyć projekt w Visual Studio (możesz użyć również VSCode, aczkolwiek do C# preferuję pełną wersję).

Następnie dodaj rozszerzenie “Antlr4.Runtime.Standard” w wersji 4.9 jeżeli korzystasz z poprzedniego artykułu i rozszerzenia do VSCode (lub innej zgodnej z używaną przez Ciebie wersją biblioteki Antlr4). Skopiuj też folder z gramatykami do głównego folderu projektu.

Teraz potrzebna nam będzie struktura programu. Głównie klasa, która będzie odwiedzała nasz “kod” oraz klasy pomocnicze. Z klas pomocniczych stworzyłem rejestr oraz liczbę, by je w łatwy sposób odróżnić. Klasom nadałem interfejs argumentu (zgody z naszą gramatyką).

W głównym pliku projektu dodałem instrukcje dla ANTLR4, by odczytał plik input.txt znajdujący się w folderze z plikiem wykonywalnym, a następnie by wykonał kod.

Teraz czas stworzyć klasę “gościa”. Zacznij od implementacji. Typ generyczny odnosi się do wartości zwracanej przez naszego gościa, zazwyczaj jest to object lub object?.

Gość może wizytować instrukcje parsera. By to zrobił należy zaimplementować nadpisanie metody Visit..X, gdzie X to nazwa naszej instrukcji np. line lub program zaczynająca się od dużej litery.

W instrukcji programu wystarczy, że przeiterujemy się przez wszystkie linie i nie zwrócimy żadnej wartości.

W przypadku rejestru i liczby powinniśmy stworzyć stosowną klasę zależną i przypisać jej wartość adresu albo samej liczby.

W międzyczasie możemy stworzyć na szybko podstawę instrukcji odwiedzenia linii - sprawdzamy czy linia ma operator, jeżeli nie to idziemy do następnej.

Jeżeli jednak tak, to odczytujemy operator oraz odwiedzamy wszystkie argumenty zapisując je do listy.

Brakuje nam odwiedzenia liczby jako wartości stałej. Implementujemy więc metodę VisitNumtype, która konwertuje tekst na stosowną wartość liczbową korzystając z biblioteki statycznych metod Convert.

Teraz przydałoby się odwiedzić argument. W naszym przypadku argumentem jest albo rejestr albo liczba, a że tworzenie ich jest zaimplementowane wewnątrz stosownych metod, to po prostu odwiedzamy te metody i zwracamy wartość. W innym przypadku zwracamy null.

Czas zaimplementować operatory. Ja byłem leniwy i zaimplementowałem tylko dwa podstawowe - mov oraz prt.  W przypadku operatora mov wystarczy sprawdzić czy argument miejsca docelowego jest rejestrem oraz typ argumentu źródłowego i stosownie do niego zapisać wartość, albo odczytać wartość z rejestru i ją przepisać do nowego miejsca.

Print to nic innego jak odczytanie kolejnych wartości jako znaków (char) z pamięci zaczynając od podanego punktu aż do napotkania symbolu \0.

A oto rezultat:

Kod:

mov #0x48 0x0000
mov #0x65 0x0001
mov #0x6C 0x0002
mov #0x6C 0x0003
mov #0x6F 0x0004
mov #0x21 0x0005
mov #0x00 0x0006

prt 0x0000

I wykonany program 😉 

Appendix

Tak wiem, że opisałem kod po łebkach, ale jest on na tyle samodeskryptywny, że obrazą byłoby tłumaczyć go linijka po linijce 😄  Jeżeli coś będzie niezrozumiałe, pytaj śmiało.

Edytowano Wrzesień 14, 2022 przez H1M4W4R1

[Treker (Damian Szymański)]

Artykuł został właśnie zatwierdzony, więc od teraz jest widoczny publicznie 🙂

[amisztal0]

Fajny artykuł. Ten ANTLR4 to dosyć ciekawe narzędzie.