C Code Gen

Table of Contents

1. Cmake
   1. Cmake Win32
   2. Cmake Unix
2. Build ExampleProject
3. Use Parser
4. Hinweise

Cmake

Cmake_Win32

1. In Haupverzeichnis wechseln (dort wo der Ordner C_Code_Gen und CMakeLists.txt und Readme.md liegt)
2. neuen Ordner namens "build" anlegen
3. in build Ordner wechseln

cd ./build

4. cmd in dem build Ordner öffnen

5. "cmake -DCMAKE_PREFIX_PATH=C:\UserData\z180338\tools\xerces-c -G "MinGW Makefiles" .." in cmd eingeben

cmake -DCMAKE_PREFIX_PATH="Path to xerces-c" -G "MinGW Makefiles" ..

Bsp:

cmake -DCMAKE_PREFIX_PATH=C:\UserData\z180338\tools\xerces-c -G "MinGW Makefiles" ..

6. "cmake --build ." eingeben

cmake --build .

Die Fertige exe kann dann unter build/C_Code_Gen gefunden werden

Cmake_Unix

1. In Haupverzeichnis wechseln (dort wo der Ordner C_Code_Gen und CMakeLists.txt und Readme.md liegt)

2. neuen Ordner namens "build" anlegen

mkdir build

3. in build Ordner wechseln

cd ./build

4. terminal in build ordner öffnen

5. "cmake -DCMAKE_PREFIX_PATH="$Path to xerces install" .." in terminal eingeben

cmake -DCMAKE_PREFIX_PATH="$Path to xerces install" .. 

Beispiel:

cmake -DCMAKE_PREFIX_PATH="/opt/xerces-c" .. 

wenn dies fehlschlägt, dann in den Hauptordner wechseln, von dort in C_Code_Gen wechseln und die Datei CMakeLists.txt öffnen. Dort wir in Zeile 10 set(CMAKE_PREFIX_PATH "/opt/xerces-c") zu dem Installations Pfad von xerces gesetzt.
"make" in terminal eingeben

make

Das fertige Programm kann dann unter /build/C_Code_Gen gefunden werden

XML

in der Example.xml kann angepasst werden, wie der Code Generator Code erzeugt. Die Example.xml muss angepasst werden, wenn der Parser etwas anderes machen soll als die Beispiel Implementation

Build_ExampleProject

Nach dem die C_Code_gen.exe (Win) oder C_Code_Gen ausgeführt wurde, wurden 4 neue Dateien erzeugt. (exampleMain.cpp, HeaderFileName.h, SourceFileName.cpp und CMakeLists.txt) Wobei HeaderFileName.h, SourceFileName.cpp vorher in der XML definiert wurden und deswegen anders heißen werden. Diese Dateien sollten in einen Neuen Projektordner Kopiert werden. Der Neue Ordner sollte die Strucktur:

Projekt
|
|---exampleMain.cpp
|---HeaderFileName.h
|---SourceFileName.cpp
|---CMakeLists.txt

haben.

1. Externe Methoden Implementieren:

Hierzu wird die exampleMain.cpp geöffnet. Dann wird nach einer Klasse namens "Klasse" gesucht, welche von dem angegeben ClassName erbt. Hier sind nun beispiel Implementierungen vorhanden, die beliebig geändert werden können.

2. build

1. Im Projekt Ordner neuen Ordner namens build anlegen (Dieser Ordner sollte nicht direkt in dem 'build'- Ordner Aus dem 1. Schritt liegen, da dies zu Fehlern führen kann. Es ist am Besten außerhalb des Projektes einen Neuen Ordner für die generierten Dateien anzulegen, in welchem man dann den neuen 'build' - Ordner erstellt, oder aber mindestens einen Unterordner in dem 'build' - Ordner anzulegen und die generierten Dateien mit der generierten CMakeLists.txt und ExampleMain.cpp.
2. CMD (Win) oder Terminal(Unix) öffnen
3. In build Ordner wechseln

cd ./build

4. "cmake .." eingeben

cmake ..

Beispiel minGW:

cmake -G "MinGW Makefiles" ..

5. cmake --build . (Win) oder make (Linux) eingeben Windows

cmake --build .

Unix

make

6. Es sollte nun im "build" Ordner ein weiter Ordner "Debug" sein, in welchem sich nun im Debug Ordner eine ExampleMain.exe befindet (Win).
7. Es sollte nun im "build" ein ExampleMain Programm zu sehen sein. (Unix)

Use_Parser

Das Programm auszühren und dann mit --help die Hilfe ausgeben lassen Win

ExampleMain.exe [args]
ExampleMain.exe -v

Unix

ExampleMain [args]
ExampleMain -v

Hinweise

Hinweis zur generierung der Getter Methoden:

Da in den Requirements immer der longOpt-Name als name in den Methoden gewünscht war haben wir in unserem code wenn ein '-' wie bei sign-per-line vorkommt, dieses '-' aus dem namen gelöscht und zu signperline (Bsp.: isSetsignperline()) gemacht.

Hinweis zur Angabe von zusätzlichen Argumenten:

in unserem generierten Argument-Parser werden zusätzliche Argumente ohne Zusätze einfach mit einem Leerzeichen getrennt hinter das Hauptargument geschrieben. Bsp.: --out-path C:\Users\ --sign-per-line 10 -v

Hinweis zur Zeilenlimitierung von sign-per-line

{ReqFunc4} Dieses Requirement wurde von uns zunächst zweideutig gesehen, ob dabei das Attribut aus der XML - Datei in Zeile 3 gemeint ist, oder ob man den optionalen Übergabeparameter aus der Option --sign-per-line auslesen soll. Wir haben uns am Ende darauf geeinigt den Wert aus dem Attribut aus Zeile 3 zu benutzen, jedoch funktionierte das Programm auch mit der getter-Funktion der --sign-per-line Option.

Autoren: Michael Hornstein, Jacob Hochbaum, Johannes Muessig