API-Referenz
Willkommen zur API-Referenz von TinyPl0. Die API-Referenz wird aus XML-Kommentaren generiert. Für Schulungszwecke sind auch interne und private Member enthalten, um tiefe Einblicke in die Implementierung zu ermöglichen. Die Zugriffsebene wird in der DocFX-Ansicht entsprechend gekennzeichnet.
Überblick der Module
TinyPl0 ist in drei Module unterteilt, die zusammen einen vollständigen Compiler und eine virtuelle Maschine bilden:
🔧 Pl0.Core – Compiler & Codegenerierung
Das Herzstück von TinyPl0. Dieses Modul enthält:
- Lexer: Tokenisierung des Quellcodes mit Positionsinformationen
- Parser: Syntaxanalyse mit Symbol- und Scoperesolution
- Compiler: P-Code-Generierung
- Symboltabelle: Verwaltung von Variablen, Konstanten und Prozeduren
Wichtigste Klassen:
- Pl0Compiler – Haupteinstiegspunkt für die Kompilierung
- Pl0Lexer – Lexikalische Analyse
- Pl0Parser – Syntaxanalyse
- SymbolTable – Symbol- und Scope-Verwaltung
📖 Detaillierte Core-API-Referenz
💻 Pl0.Cli – Kommandozeilen-Interface
Das Eingabe-Frontende. Dieses Modul stellt bereit:
- Kommandozeilen-Parser für Pascal-kompatible Compiler-Switches
- Befehlsdefinitionen (
compile,run,run-pcode) - P-Code-Listing-Ausgabe für didaktische Zwecke
- Fehler- und Warnungsausgabe
Wichtigste Klassen:
- CliCommand – Kommandodefinition
- CliOptionsParser – Options-Parser
- CompilerCliOptions – Compiler-Optionen-Struktur
- CliHelpPrinter – Hilfeausgabe
📖 Detaillierte CLI-API-Referenz
🏃 Pl0.Vm – Virtuelle Maschine
Der Laufzeit-Engine. Dieses Modul implementiert:
- Stack-basierte virtuelle Maschine für P-Code-Instruktionen
- I/O-Abstraktionen (Console, gepuffert)
- Laufzeit-Fehlerbehandlung und Diagnosen
- Ergebnisobjekte mit Ausführungsstatistiken
Wichtigste Klassen:
- VirtualMachine – Hauptinterpreter
- VmExecutionResult – Ausführungsergebnis
- IPl0Io – I/O-Abstraktion
- ConsolePl0Io – Konsolenimplementierung
📖 Detaillierte VM-API-Referenz
Namespaces
Vollständige Namespace-Übersicht:
Tipps für die Nutzung
Tip
Beginnen Sie mit Pl0Compiler in der Core-API, um zu verstehen, wie der Compiler aufgebaut ist. Die Methode Compile() zeigt den Ablauf vom Quellcode zum P-Code.
Note
Der Quellcode ist auf GitHub verfügbar. Nutzen Sie die API-Referenz zusammen mit dem Quellcode, um die Implementierung zu durchschauen.
Direkt zur vollständigen API-Referenz
Wenn Sie ohne Umwege in die generierte API-Navigation wechseln möchten, nutzen Sie den folgenden Link: