minor changes in docs

Author: ArtInLines

README.md

@@ -4,14 +4,14 @@ A MiniJava Compiler written in Rust.
 
 ## MiniJava
 
-MiniJava is a subset of Java. It is a simple object-oriented language that supports classes, single inheritance(not 
+MiniJava is a subset of Java. It is a simple object-oriented language that supports classes, single inheritance(not
 supported in this compiler), and strong typing.
 
 ## Build
 
 ### Requirements
 
-- [Rust](https://rustup.rs/)
+-   [Rust](https://rustup.rs/)
 
 ### Build
 
@@ -22,29 +22,25 @@ cargo build --release
 ## Usage
 
 ```bash
-cargo r -r -- <input_file> <output_file>
+cargo r -r -- <input_file> [<output_file>]
 ```
 
-# Disclaimer
-This compiler was done as a student project and doesn't support many language features and may contain bugs. It is not intended to be used in production.
+## Documentation
 
-However, it was a great learning experience, and we hope it can be useful to someone else.
+A more detailed documentation on how to use the separate parts of the compiler is given in [User-Doc](./docs/User-Doc.md). A detailed documentation on how the project was done is given in [Project-Doc](./docs/Project-Doc.md).
 
-## Parsing
-Parsing is done using a [Pest grammar](https://pest.rs/).
+## Disclaimer
 
-## Type Checking
-I do not know what to write about type checking as i am clueless
+This compiler was done as a student project and doesn't support many language features and may contain bugs. It is not intended to be used in production.
 
-## Code Generation
-Code generation is done manually to generate Java Bytecode. The code generation uses two passes. 
-The first pass generates all instructions and the second one is used to convert relative jumps into absolute jumps.
+However, it was a great learning experience, and we hope it can be useful to someone else.
 
 ## Authors
-- Flippchen
-- Marion
-- mfloto
-- Nereuxofficial
-- Sander
-- Tori
-- Val
+
+-   Philipp Wolf (Flippchen)
+-   Maximilian Floto (mfloto)
+-   Marion Hinkel (MarionHinkel)
+-   Benedikt Brandmaier (Nereuxofficial)
+-   Tori Gönnheimer (ToriTheGreenOne)
+-   Sander Stella (SanderForGodot)
+-   Val Richter (ArtInLines)

docs/Project-Doc.md

@@ -1,5 +1,6 @@
 ## Supported types
-- Welche Types, Strukturen und deren Kombinationen werden unterstützt?
+
+-   Welche Types, Strukturen und deren Kombinationen werden unterstützt?
 
 ## Parser
 
@@ -19,32 +20,33 @@ Funktionsweise des Typecheckers:
 Der Typechecker iteriert über alle übergebenen Klassen und prüft auf mehrfache Klassendeklarationen. Die Felddeklarationen werden in einem neuen getypten Klassenobjekt gespeichert, in dem alle weiteren getypten Methoden und deren Statements gespeichert werden. Anschließend iteriert der Typechecker über alle Methoden und prüft auf mehrfache Methodendeklarationen und typisiert die Methodenparameter. Nachdem alle Statements typisiert wurden, wird der Rückgabetyp der Methode geprüft und die Methode im getypten Klassenobjekt gespeichert. Nach dem Überprüfen und Typisieren der Klasse wird diese in einen Vektor an getypten Klassen gespeichert. Nachdem alle Klassen getypt wurden, wird der Vektor an getypten Klassen zurückgegeben.
 
 Folgende Funktionen werden vom Typechecker übernommen:
--  Liest alle definierten Types/Strukturen
--  Typisierung aller Variablen und Ausdrücke
--  Checken von mehreren Klassen
--  Checken der Rückgabe-Typen von Methoden
--  Ersetzen von LocalOrFieldVar durch LocalVar oder FieldVar
 
+-   Liest alle definierten Types/Strukturen
+-   Typisierung aller Variablen und Ausdrücke
+-   Checken von mehreren Klassen
+-   Checken der Rückgabe-Typen von Methoden
+-   Ersetzen von LocalOrFieldVar durch LocalVar oder FieldVar
 
 Folgende Fehler werden vom Typechecker erkannt:
--  Mehrfache Deklaration einer Klasse
--  Mehrfache Deklaration einer Methode
--  Type-Mismatch bei Methodenrückgabe
--  Type-Mismatch bei Methodenaufruf
--  Type-Mismatch bei Methodenparametern
--  Type-Mismatch bei FieldDecl
--  Type-Mismatch bei Unary/Binary-Operationen
--  Mehrfache Deklaration von FieldDecl
--  Mehrfache Deklaration von LocalOrFieldVar
--  Nicht deklarierte Variable
--  Unbekannte Methode bei Methodenaufruf
--  Verwendung einer nicht deklarierten Variable
--  Panic bei TypedExpr in AST
--  Bedingung von If/While-Statement ist kein Bool
+
+-   Mehrfache Deklaration einer Klasse
+-   Mehrfache Deklaration einer Methode
+-   Type-Mismatch bei Methodenrückgabe
+-   Type-Mismatch bei Methodenaufruf
+-   Type-Mismatch bei Methodenparametern
+-   Type-Mismatch bei FieldDecl
+-   Type-Mismatch bei Unary/Binary-Operationen
+-   Mehrfache Deklaration von FieldDecl
+-   Mehrfache Deklaration von LocalOrFieldVar
+-   Nicht deklarierte Variable
+-   Unbekannte Methode bei Methodenaufruf
+-   Verwendung einer nicht deklarierten Variable
+-   Panic bei TypedExpr in AST
+-   Bedingung von If/While-Statement ist kein Bool
 
 ## Codegenerierung
 
-ByteCode-Umwandlung, Bugfixes, StackSize und viele Improvements: Val Richter
+ByteCode-Umwandlung, Bugfixes, StackSize und viele Verbesserungen: Val Richter
 
 Definition DIR(Duck Intermediate Representation), ConstantPool, LocalVarPool, Methoden zur Instruction-generierung, BugFixes, etwas ByteCode-Umwandlung und Umwandlung relativer in absolute Jumps: Marion Hinkel und Benedikt Brandmaier im Pair Programming
 
@@ -60,7 +62,7 @@ hatten häufig off-by-one Errors.
 
 Zudem musste eine StackMapTable implementiert werden, da die JVM sonst unsere Klassen nicht lädt.
 Das Troubleshooten von Testfehlern war auch sehr aufwending da oft javap gar nicht erst den Fehler im Klassencode ausgab
-und wir mit einem Hex-Editor die Klassen von Hand analysieren mussten, da es auch kein anderes Tool gab, um solche Fehler 
+und wir mit einem Hex-Editor die Klassen von Hand analysieren mussten, da es auch kein anderes Tool gab, um solche Fehler
 auszugeben und die Zeit fehlte ein Eigenes zu schreiben.
 
 Da es auch keine Dokumentation gibt, die in etwa zeigt, welcher Bytecode für welche Operationen genutzt wird, mussten wir
@@ -69,15 +71,13 @@ in die wir manuell Java Code eingeben und schauten, was für Bytecode bei versch
 wird, was sehr zeitaufwendig war.
 
 Auch sehr schwierig war die Implementation einer StackMapTable, da Java diese erwartet. Diese ist eine Tabelle, die für
-jede Instruktion die Typen der Elemente auf dem Stack in komprimiertem Format angibt. Diese Tabelle muss manuell 
+jede Instruktion die Typen der Elemente auf dem Stack in komprimiertem Format angibt. Diese Tabelle muss manuell
 erstellt werden und über die Typen aller Variablen, die in den Stack geschrieben wurden Bescheid wissen.
 
 ## Testing
 
--   Wer hat welche Arbeit beim Testing gemacht?
--   Wie funktioniert das Testing genau?
-
 Das Testen des Codegens war sehr aufwendig, er besteht aus diesen Schritten:
+
 1. Ein handgeschriebener TAST wird geladen
 2. Eine Java Klasse wird erstellt die jede Methode im TAST aufruft
 3. Die java Klasse wird mit javac kompiliert und ausgeführt, wobei die Ausgabe in einer Variable gespeichert wird
@@ -90,9 +90,6 @@ Das Testen des Codegens war sehr aufwendig, er besteht aus diesen Schritten:
 
 ## AST-Definition
 
--   Wer hat wie zur endgültigen Definition des ASTs beigetragen?
--   v.a. interessant, dass während der Arbeit der einzelnen Teams, der AST iterativ verändert wurde
-
-## Projektmanagement
+Die genaue Definition des ASTs, die verwendet wurde, ist in [AST-Klassendiagramm](./AST-Klassendiagramm.png) als UML-Diagramm dargestellt. Zusätzlich lassen sich in [hier](./Notizen%20zum%20AST.md) einige Erklärungen zum Diagramm finden.
 
--   Welche Arbeit lief von wem ins Projektmanagement?
+![Klassendiagramm](AST-Klassendiagramm.png)

docs/User-Doc.md

@@ -1,36 +1,43 @@
-TBD
-
-- Jeweils erwähnen wie man die Teile kompiliert und laufen lassen kann. Nicht vergessen: Wie sollte die Eingabe aussehen und wie sieht die Ausgabe dann aus?
-- Vielleicht sollten wir Command-Line Befehle für jeden der Teile im Binary Crate zur Verfügung stellen?
-
 ## Vorbedingungen
+
 [Rust installieren](https://rustup.rs/):
+
 ```bash
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 ```
-- [JDK 20](https://www.oracle.com/java/technologies/downloads/)(Wird in Tests für die Validierung des Codegens benötigt)
+
+-   [JDK 20](https://www.oracle.com/java/technologies/downloads/) (Wird in Tests für die Validierung des Codegens benötigt)
 
 # Ausführen
+
 Um eine .java in eine .class-datei zu kompilieren:
+
 ```bash
-cargo run -- <input_file>
+cargo r -r -- <input_file> [<output_file>]
 ```
 
 # Testen
+
 1. Projekt bauen: `cargo build`
 
 ## Parser
 
-2. Parser tests ausführen: `cargo test test_parser`
+2. Parser tests ausführen: `cargo test --lib test_parser`
+
+Spezifischen Test ausführen: `cargo test --lib <test_name>::test_parser`
+
 ## Typchecker
 
-2. Typechecker tests ausführen: `cargo test test_typechecker`
+2. Typechecker tests ausführen: `cargo test --lib test_typechecker`
 
-Spezifischen Test ausführen: `cargo test <test_name>::test_typechecker`
+Spezifischen Test ausführen: `cargo test --lib <test_name>::test_typechecker`
 
 ## Codegenerierung
 
-2. Codegenerierung tests ausführen: `cargo test test_codegen`
+2. Codegenerierung tests ausführen: `cargo test --lib test_codegen`
+
+Spezifischen Test ausführen: `cargo test --lib <test_name>::test_codegen`
 
 ## Testing
-Zur ausführung aller tests: `cargo test`
+
+Zur ausführung aller tests: `cargo test --lib`. Dabei sollte beachtet werden, dass die Tests teilweise die selben Dateien schreiben und entsprechend Probleme aufkommen können, wenn alle Tests auf einmal ausgeführt werden. Diese Probleme treten nicht auf, wenn die Teile des Compilers (Parser, Typchecker, Codegenerierung) einzeln getestet werden.