From b917e990d87ff52c7b514b3a44f55655b201d023 Mon Sep 17 00:00:00 2001
From: philippkuest <100705472+philippkuest@users.noreply.github.com>
Date: Sun, 24 Jul 2022 09:21:09 +0000
Subject: [PATCH 01/11] Feature/i93 add example program (#112)

* Added example code

* changes

* Added checks for exclusion, arguments and optional

* Added doxygen comments

* Changed attributes of ExampleCode to be more abstract

* printVersion is overridden in ExtendedGeneratedCode.h

* minor

* minor

* minor

* doxygen

* Added new line to version

* Renamed getter for generatedClass

* Fixed where code logic is places

Co-authored-by: Tobias Goetz <tobigoetz98@gmail.com>
---
 CMakeLists.txt                              |  6 ++
 src/SourceCodeWriter.cpp                    |  2 +-
 src3/ExampleProgram.cpp                     | 85 +++++++++++++++++++++
 src3/ExampleProgram.h                       | 20 +++++
 src3/ExtendedGeneratedCode.cpp              |  5 ++
 src3/ExtendedGeneratedCode.h                | 18 +++++
 {exampleProgram => src3}/exampleProgram.xml | 10 +--
 7 files changed, 139 insertions(+), 7 deletions(-)
 create mode 100644 src3/ExampleProgram.cpp
 create mode 100644 src3/ExampleProgram.h
 create mode 100644 src3/ExtendedGeneratedCode.cpp
 create mode 100644 src3/ExtendedGeneratedCode.h
 rename {exampleProgram => src3}/exampleProgram.xml (68%)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index fdfc5cc..4ca7f5c 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -17,6 +17,12 @@ add_executable(
         ${Source_Files2}
 )
 
+file(GLOB Source_Files2 src3/*.cpp)
+add_executable(
+        ExampleProgram
+        ${Source_Files2}
+)
+
 
 
 find_package (Boost REQUIRED)
diff --git a/src/SourceCodeWriter.cpp b/src/SourceCodeWriter.cpp
index f2ba625..0466f93 100644
--- a/src/SourceCodeWriter.cpp
+++ b/src/SourceCodeWriter.cpp
@@ -499,7 +499,7 @@ void SourceCodeWriter::createHeaderPrintVersion() {
 }
 
 void SourceCodeWriter::createSourcePrintVersion() {
-    fprintf(getSourceFile(), "void %s::printVersion(){\nprintf(\"version: 1.0.0\");\n}\n",
+    fprintf(getSourceFile(), "void %s::printVersion(){\nprintf(\"version: 1.0.0\\n\");\n}\n",
             getGetOptSetup()->getClassName().c_str());
 
 }
diff --git a/src3/ExampleProgram.cpp b/src3/ExampleProgram.cpp
new file mode 100644
index 0000000..eb43d46
--- /dev/null
+++ b/src3/ExampleProgram.cpp
@@ -0,0 +1,85 @@
+#include "ExampleProgram.h"
+#include "generatedCode.h"
+
+/**
+ * @brief Constructor, that generates a object of ExtendedGeneratedCode
+ */
+ExampleProgram::ExampleProgram(GC::GeneratedClass *generatedClass) {
+    this->generatedClass = generatedClass;
+}
+
+/**
+ * @brief Getter for generatedClass
+ * @return object of class ExtendedGeneratedCode
+ */
+GC::GeneratedClass *ExampleProgram::getGeneratedClass() {
+    return generatedClass;
+}
+
+/**
+ * @brief prints in command line if option 'version' was set
+ * @param ep object of class ExampleProgram
+ */
+void checkVersion(ExampleProgram ep){
+    if(ep.getGeneratedClass()->isSetVersion()){
+        //ep.getGeneratedClass()->printVersion();
+        printf("The option 'version' was called --> isSetVersion=true\n");
+    } else {
+        printf("The option 'version' was not called --> isSetVersion=false\n");
+    }
+}
+
+/**
+ * @brief prints in command line if option 'exclusion' was set
+ * @param ep object of class ExampleProgram
+ */
+void checkExclusion(ExampleProgram ep){
+    if(ep.getGeneratedClass()->isSetExclusion()){
+        printf("The option 'exclusion' was called --> isSetExclusion=true\n");
+    } else {
+        printf("The option 'exclusion' was not called --> isSetExclusion=false\n");
+    }
+}
+
+/**
+ * @brief prints in command line if option 'arguments' was set and depending on it the argument
+ * @param ep object of class ExampleProgram
+ */
+void checkArguments(ExampleProgram ep){
+    if(ep.getGeneratedClass()->isSetArguments()){
+        printf("The option 'arguments' was called --> isSetExclusion=true\n");
+        printf("The argument is: %d\n", ep.getGeneratedClass()->getValueOfArguments());
+    } else {
+        printf("The option 'arguments' was not called --> isSetExclusion=false\n");
+    }
+}
+
+/**
+ * @brief prints in command line if option 'arguments' was set and depending on it the argument
+ * @param ep object of class ExampleProgram
+ */
+void checkOptional(ExampleProgram ep){
+    if(ep.getGeneratedClass()->isSetOptional()){
+        printf("The option 'optional' was called --> isSetOptional=true\n");
+        printf("The argument is: %d\n", ep.getGeneratedClass()->getValueOfOptional());
+    } else {
+        printf("The option 'optional' was not called --> isSetOptional=false\n");
+    }
+}
+
+/**
+ * @brief Generates object of class ExampleProgram, calls parseOptions and checks which options were set
+ * @param argc amount of arguments
+ * @param argv array of arguments
+ */
+int main(int argc, char* argv[] ) {
+    ExampleProgram exampleProgram = ExampleProgram(new ExtendedGeneratedCode());
+    exampleProgram.getGeneratedClass()->parseOptions(argc, argv);
+
+    checkVersion(exampleProgram);
+    checkExclusion(exampleProgram);
+    checkArguments(exampleProgram);
+    checkOptional(exampleProgram);
+
+    return 0;
+}
\ No newline at end of file
diff --git a/src3/ExampleProgram.h b/src3/ExampleProgram.h
new file mode 100644
index 0000000..8013976
--- /dev/null
+++ b/src3/ExampleProgram.h
@@ -0,0 +1,20 @@
+#ifndef CODEGENERATOR_EXAMPLEPROGRAM_H
+#define CODEGENERATOR_EXAMPLEPROGRAM_H
+
+
+#include "ExtendedGeneratedCode.h"
+
+class ExampleProgram {
+private:
+    GC::GeneratedClass *generatedClass = nullptr;
+protected:
+public:
+    //Constructor
+    explicit ExampleProgram(GC::GeneratedClass *generatedClass);
+
+    //Getter
+    GC::GeneratedClass *getGeneratedClass();
+};
+
+
+#endif //CODEGENERATOR_EXAMPLEPROGRAM_H
diff --git a/src3/ExtendedGeneratedCode.cpp b/src3/ExtendedGeneratedCode.cpp
new file mode 100644
index 0000000..b99f03d
--- /dev/null
+++ b/src3/ExtendedGeneratedCode.cpp
@@ -0,0 +1,5 @@
+#include "ExtendedGeneratedCode.h"
+
+void ExtendedGeneratedCode::printVersion() {
+    printf("Version: 2.0.0\n");
+}
diff --git a/src3/ExtendedGeneratedCode.h b/src3/ExtendedGeneratedCode.h
new file mode 100644
index 0000000..ee3231d
--- /dev/null
+++ b/src3/ExtendedGeneratedCode.h
@@ -0,0 +1,18 @@
+#ifndef CODEGENERATOR_EXTENDEDGENERATEDCODE_H
+#define CODEGENERATOR_EXTENDEDGENERATEDCODE_H
+
+#include "generatedCode.h"
+
+/**
+ * class with inheritance to generated class to use getopt of generated files
+ */
+class ExtendedGeneratedCode: public GC::GeneratedClass {
+
+    /**
+     * @brief overrides printVersion function in generated Code
+     */
+    void printVersion() override;
+};
+
+
+#endif //CODEGENERATOR_EXTENDEDGENERATEDCODE_H
diff --git a/exampleProgram/exampleProgram.xml b/src3/exampleProgram.xml
similarity index 68%
rename from exampleProgram/exampleProgram.xml
rename to src3/exampleProgram.xml
index a209984..7feafdf 100644
--- a/exampleProgram/exampleProgram.xml
+++ b/src3/exampleProgram.xml
@@ -4,12 +4,10 @@
     <HeaderFileName>generatedCode.h</HeaderFileName>
     <SourceFileName>generatedCode.cpp</SourceFileName>
     <NameSpace>GC</NameSpace>
-    <ClassName>generatedClass</ClassName>
+    <ClassName>GeneratedClass</ClassName>
     <OverAllDescription>
-        <Block>Erstellt einen Rumpf zum einlesen von Argumente aus der Kommandozeile.</Block>
-        <Block>Es kann sowohl mit innenliegenden Container wie externer Klassenanbindung eine Datenhaltung erfolgen.</Block>
-        <Block>Sobald ein Methodenaufruf abstrakt ist, wird die Basisklasse abstrakt.</Block>
-        <Block>Fuer die Formatierung der generierten Dateien wird astyle verwendet.</Block>
+        <Block>Gibt die verschiedenen Werte aus, welche von getOpt angenommen wurden.</Block>
+        <Block>Dies geschieht in der Kommandozeile.</Block>
     </OverAllDescription>
     <SampleUsage>
         <Sample>getoptgen -h</Sample>
@@ -18,7 +16,7 @@
         <!-- ReqFunc51 -->
         <Option Ref="1" Exclusion="2" ShortOpt="h" LongOpt="help" ConnectToInternalMethod="printHelp" Description="Hilfe ausgeben" />
         <!-- ReqFunc52 -->
-        <Option ShortOpt="v" Interface="Version" ConnectToInternalMethod="printVersion" Description="Gibt die Version des Programms aus" />
+        <Option ShortOpt="v" LongOpt="version" Interface="Version" ConnectToInternalMethod="printVersion" Description="Gibt die Version des Programms aus" />
         <!-- ReqFunc53 -->
         <Option Ref="2" Exclusion="1" LongOpt="exclusion" Description="Dies darf nicht mit help aufgerufen werden" />
         <!-- ReqFunc54 -->

From 906f455039df328a1bf0a26bb228db7803375182 Mon Sep 17 00:00:00 2001
From: philippkuest <100705472+philippkuest@users.noreply.github.com>
Date: Sun, 24 Jul 2022 09:29:14 +0000
Subject: [PATCH 02/11] =?UTF-8?q?=C3=B6=20-->=20oe;=20=C3=BC=20-->=20ue=20?=
 =?UTF-8?q?(#132)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 src3/exampleProgram.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src3/exampleProgram.xml b/src3/exampleProgram.xml
index 7feafdf..a628a2d 100644
--- a/src3/exampleProgram.xml
+++ b/src3/exampleProgram.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <GetOptSetup SignPerLine="79">
-    <Author Name="Tobias Götz, Noel Kempter, Niklas Holl, Sebastian Wolf, Philipp Küst" Mail="goetz.tobias-it21@it.dhbw-ravensburg.de" />
+    <Author Name="Tobias Goetz, Noel Kempter, Niklas Holl, Sebastian Wolf, Philipp Kuest" Mail="goetz.tobias-it21@it.dhbw-ravensburg.de" />
     <HeaderFileName>generatedCode.h</HeaderFileName>
     <SourceFileName>generatedCode.cpp</SourceFileName>
     <NameSpace>GC</NameSpace>

From 07d0420e324a91abb8a7c54b9e612abbe5fd07b8 Mon Sep 17 00:00:00 2001
From: Sebastian Wolf <67585359+swolf2211@users.noreply.github.com>
Date: Sun, 24 Jul 2022 11:29:51 +0200
Subject: [PATCH 03/11] feature/i11 create help function (#124)

* Working implementation, getting back printHelp() function with formatted help text.

* Rearranged code, added Tokenizer from Requirements Program examples to Justify.cpp.

* removed unnecesarry variable

* added some comments

* minor changes

* comments and minor changes

* printHelpText with sorted params, description needs to be overworked

* fixed wrong description bug

* Added Classname, implemented printHelp in SourceCodeWriter.cpp

* added comments

* reworked getParamLength and fixed bug

* made concatParams static

* fixed linter warnings, reworked concatParams method

* changed paramLength variable

* Improved sort Options

* Made variable names more readable

* Reworked helper function

* Removed unnecessary code

* Improved finding out the longest parameter

* Improved variable naming

* Fixed wrong variable used

* Fixed issue with maxOptionParamLength not being set correctly

Co-authored-by: Tobias Goetz <tobigoetz98@gmail.com>
---
 src/HelpText.cpp         | 191 ++++++++++++++++++++++++++++
 src/HelpText.h           |  55 ++++++++
 src/Justify.cpp          | 262 +++++++++++++++++++++++++++++++++++++++
 src/Justify.h            |  37 ++++++
 src/SourceCodeWriter.cpp |  13 ++
 src/SourceCodeWriter.h   |  12 ++
 6 files changed, 570 insertions(+)
 create mode 100644 src/HelpText.cpp
 create mode 100644 src/HelpText.h
 create mode 100644 src/Justify.cpp
 create mode 100644 src/Justify.h

diff --git a/src/HelpText.cpp b/src/HelpText.cpp
new file mode 100644
index 0000000..46c30ec
--- /dev/null
+++ b/src/HelpText.cpp
@@ -0,0 +1,191 @@
+#include "HelpText.h"
+
+HelpText::HelpText(GetOptSetup *getOptSetup)
+{
+    this->getOptSetup = getOptSetup;
+}
+HelpText::~HelpText() = default;
+
+/**
+ * @brief concatenate the description strings to one string
+ * @brief and add to printHelpText
+ */
+void HelpText::parseDescription()
+{
+    string new_description;
+
+    for (int i = 0; i < getOptSetup->getOverAllDescriptions().size(); i++)
+    {
+        // Add empty space in front of every string except the first
+        if (i > 0) {
+            new_description.append(" ");
+        }
+        // concatenate strings
+        new_description.append(getOptSetup->getOverAllDescriptions()[i]);
+    }
+    // justify and add to printHelpText
+    printHelpText.append("Description:\\n" + justify.justifyTheText(new_description, getOptSetup->getSignPerLine(), false, 0) + "\\n");
+}
+
+bool compareOptions(const Option &a, const Option &b) {
+    if (a.getShortOpt() != '\0' && b.getShortOpt() != '\0') {
+        return a.getShortOpt() < b.getShortOpt();
+    }
+    else if (a.getShortOpt() != '\0') {
+        return true;
+    }
+    else if (b.getShortOpt() != '\0') {
+        return false;
+    }
+    else {
+        return a.getLongOpt() < b.getLongOpt();
+    }
+}
+
+/**
+ * @brief concatenate short opt and long opt to one string
+ * different checks if shortOpt and LongOpt are empty
+ * to concatenate the right signs to the string
+ * @param i iteration counter to determine which option is parsed
+ * @return concatenated opts as string
+ */
+vector<string> HelpText::concatParams(const vector<Option>& options)
+{
+    vector<string> opts;
+
+    for (const auto & option : options) {
+        string opt;
+        // check if shortOpt isn't empty
+        if (option.getShortOpt() != '\0')
+        {
+            // for e.g. -h
+            opt += '-';
+            opt += option.getShortOpt();
+            // check if longOpt isn't empty
+            if (!option.getLongOpt().empty())
+            {
+                // for e.g. , --help
+                opt.append(", --" + option.getLongOpt());
+            }
+        }
+
+            // check if only longOpt isn't empty
+        else if (!option.getLongOpt().empty())
+        {
+            // for e.g. --help
+            opt.append("--" + option.getLongOpt());
+        }
+
+        // Find out the longest parameter length
+        if (opt.size() > maxOptionParamLength) {
+            maxOptionParamLength = (int) opt.length();
+        }
+        opts.push_back(opt);
+    }
+    return opts;
+}
+
+/**
+ * @brief concatenate the options to one string
+ * @brief and add to printHelpText
+ * call the getMaxParamLength() Method. Get concatenated params
+ * by calling concatParams function with i as iterator.
+ * write strings to buffer with a spacing using set()
+ * calculate a new signPerLine to space out the
+ * option description accordingly to the length
+ * of param and the shift.
+ * calculate a new shift for every line of the description
+ * that is pushed to the next line because of signPerLine,
+ * in order to shift the line to the right, matching the above.
+ * Justify the description text. Write justified text to
+ * class variable.
+ */
+void HelpText::parseOption()
+{
+    // sorting options
+    vector<Option> sortedOpts = getOptSetup->getOptions();
+    std::sort(sortedOpts.begin(), sortedOpts.end(), compareOptions);
+
+    // concatenate params
+    vector<string> opts = concatParams(sortedOpts);
+
+    // concatenate the options
+    std::stringstream buffer;
+    buffer << std::left << std::setw(maxOptionParamLength + shift) << "Parameters";
+    buffer << "Description" << "\\n";
+
+    for (int i = 0; i < sortedOpts.size(); i++)
+    {
+        // get the concatenated params
+        buffer << std::left << std::setw(maxOptionParamLength + shift) << opts[i];
+
+        // check if description isn't empty
+        if (!getOptSetup->getOptions()[i].getDescription().empty())
+        {
+            // subtract the length of the params and the shift
+            // to get the new signPerLine for the options
+            // needs to be less because of the Params and the shift
+            int new_signPerLine = getOptSetup->getSignPerLine() - maxOptionParamLength - shift;
+            // new shift for every description line after the first, to match the first line
+            int optionShift = maxOptionParamLength + shift;
+
+            // justify the description text
+            string new_description = justify.justifyTheText(sortedOpts[i].getDescription(), new_signPerLine, true, optionShift);
+            buffer << new_description;
+        }
+    }
+    buffer << "\\n";
+    printHelpText.append(buffer.str());
+}
+
+/**
+ * @brief concatenate usage strings to one string
+ * @brief and add to printHelpText
+ * @return all usage strings as a string with line break.
+ */
+void HelpText::parseUsage()
+{
+    string new_usage;
+    for (const auto & sampleUsage : getOptSetup->getSampleUsages()) {
+        new_usage.append(sampleUsage + "\\n");
+    }
+    printHelpText.append("Usage:\\n" + justify.justifyTheText(new_usage, getOptSetup->getSignPerLine(), false, 0));
+}
+
+/**
+ * @brief concatenate the author information to one string
+ * @brief and add to printHelpText
+ */
+void HelpText::parseAuthor()
+{
+    printHelpText.append("Author:\\n" + justify.justifyTheText(getOptSetup->getAuthor().getName() + ", " + getOptSetup->getAuthor().getMail(), getOptSetup->getSignPerLine(), false, 0));
+}
+
+/**
+ * @brief add function wrapper and call parse methods
+ * @return getHelp() Function with message as string
+ */
+string HelpText::parseHelpMessage()
+{
+    // add function beginning to string
+    printHelpText.append("void ");
+    printHelpText.append(getOptSetup->getClassName());
+    printHelpText.append("::printHelp(){puts(\"");
+
+    // parse the description and add text to string
+    parseDescription();
+
+    // parse the option and add text to string
+    parseOption();
+
+    // parse the usage and add text to string
+    parseUsage();
+
+    // parse the author and add text to string
+    parseAuthor();
+
+    // add function ending to string
+    printHelpText.append(R"(");})");
+
+    return printHelpText;
+}
diff --git a/src/HelpText.h b/src/HelpText.h
new file mode 100644
index 0000000..a6bdb7c
--- /dev/null
+++ b/src/HelpText.h
@@ -0,0 +1,55 @@
+#ifndef CODEGENERATOR_HELPTEXT_H
+#define CODEGENERATOR_HELPTEXT_H
+
+#include "Justify.h"
+#include "models/GetOptSetup.h"
+#include <iostream>
+#include <vector>
+#include <algorithm>
+
+using namespace std;
+
+class HelpText
+{
+public:
+    explicit HelpText(GetOptSetup *getOptSetup);
+    ~HelpText();
+
+    string parseHelpMessage();
+
+private:
+    void parseDescription();
+    void parseUsage();
+    void parseAuthor();
+    void parseOption();
+
+    vector<string> concatParams(const vector<Option>& sortedOpts);
+    /**
+     * @brief printHelp Text
+     * stores the string for the printHelp method.
+     */
+    string printHelpText;
+    /**
+     * @brief Length of longest Parameter
+     * Stores the length of the longest
+     * parameter in options.
+     */
+    int maxOptionParamLength = 0;
+    /**
+     * @brief shift
+     * extra shift / space can be defined
+     * for the space between parameters
+     * and description in options.
+     */
+    const int shift = 5;
+    /**
+     * @brief Justify object
+     */
+    Justify justify;
+    /**
+     * @brief GetOptSetup object
+     */
+    GetOptSetup *getOptSetup;
+};
+
+#endif //CODEGENERATOR_HELPTEXT_H
diff --git a/src/Justify.cpp b/src/Justify.cpp
new file mode 100644
index 0000000..e6790e2
--- /dev/null
+++ b/src/Justify.cpp
@@ -0,0 +1,262 @@
+#include "Justify.h"
+
+/**
+ * @brief Function to join the words with spaces spread evenly
+ * @param words vector with separated words
+ * @param start current line start
+ * @param end iterator
+ * @param num_spaces
+ * @param isOption check if its an options string
+ * @param curr_line current line string is in
+ * @param optionShift shift that needs to be added to aline lines
+ * @return justified text
+ */
+string Justify::JoinALineWithSpace(
+        vector<string>& words,
+        int start, int end,
+        int num_spaces,
+        bool isOption,
+        int curr_line,
+        int optionShift)
+{
+
+    // Number of words in current line
+    int num_words_curr_line
+            = end - start + 1;
+
+    // String to store the justified text
+    string line;
+
+    for (int i = start; i < end; i++) {
+
+        line += words[i];
+        --num_words_curr_line;
+
+        // Count number of current space needed
+        int num_curr_space
+                = ceil((double)(num_spaces)
+                       / num_words_curr_line);
+
+        // Insert spaces in string line
+        line.append(num_curr_space, ' ');
+
+        // Delete the spaces inserted in line
+        num_spaces -= num_curr_space;
+    }
+
+    // Insert word to string line
+    if (!isOption || curr_line == 1)
+    {
+        line += words[end];
+        line.append(num_spaces, ' ');
+    }
+    else if (curr_line > 1)
+    {
+        line += words[end];
+        line.insert(0, optionShift, ' ');
+    }
+
+
+    // Return justified text
+    return line;
+}
+
+/**
+ * @brief Function that justify the words of sentence of length of line L
+ * @param words vector with separated words
+ * @param L length of sign per line
+ * @param isOption check if its an options string
+ * @param optionShift shift that needs to be added to aline lines
+ * @return whole justified string
+ */
+vector<string> Justify::JustifyText(
+        vector<string>& words,
+        int L,
+        bool isOption,
+        int optionShift)
+{
+
+    int curr_line = 1;
+    int curr_line_start = 0;
+    int num_words_curr_line = 0;
+    int curr_line_length = 0;
+
+    // To store the justified text
+    vector<string> result;
+
+    // Traversing the words array
+    for (int i = 0; i < words.size(); i++) {
+
+        // curr_line_start is the first word
+        // in the current line, and i is
+        // used to identify the last word
+        ++num_words_curr_line;
+
+        int lookahead_line_length
+                = curr_line_length
+                  + (int)words[i].size()
+                  + (num_words_curr_line - 1);
+
+        // If by including the words length becomes L,
+        // then that set of words is justified
+        // and add the justified text to result
+        if (lookahead_line_length == L) {
+
+            // Justify the set of words
+            string ans
+                    = JoinALineWithSpace(
+                            words,
+                            curr_line_start,
+                            i,
+                            i - curr_line_start,
+                            isOption,
+                            curr_line,
+                            optionShift);
+
+            // Store the justified text in result
+            result.emplace_back(ans);
+
+            // Start the current line
+            // with next index
+            curr_line_start = i + 1;
+
+            // num of words in the current line
+            // and current line length set to 0
+            num_words_curr_line = 0;
+            curr_line_length = 0;
+            curr_line += 1;
+        }
+
+            // If by including the words such that
+            // length of words becomes greater than L,
+            // then hat set is justified with
+            // one less word and add the
+            // justified text to result
+        else if (lookahead_line_length > L) {
+
+            // Justify the set of words
+            string ans
+                    = JoinALineWithSpace(
+                            words,
+                            curr_line_start,
+                            i - 1,
+                            L - curr_line_length,
+                            isOption,
+                            curr_line,
+                            optionShift);
+
+            // Store the justified text in result
+            result.emplace_back(ans);
+
+            // Current line set to current word
+            curr_line_start = i;
+
+            // Number of words set to 1
+            num_words_curr_line = 1;
+
+            // Current line length set
+            // to current word length
+            curr_line_length = (int)words[i].size();
+            curr_line += 1;
+        }
+
+            // If length is less than L then,
+            // add the word to current line length
+        else {
+            curr_line_length
+                    += (int)words[i].size();
+        }
+    }
+
+    // Last line is to be left-aligned
+    if (num_words_curr_line > 0) {
+        string line
+                = JoinALineWithSpace(
+                        words,
+                        curr_line_start,
+                        (int)words.size() - 1,
+                        num_words_curr_line - 1,
+                        isOption,
+                        curr_line,
+                        optionShift);
+
+        line.append(
+                L - curr_line_length
+                - (num_words_curr_line - 1),
+                ' ');
+
+        // Insert the last line
+        // left-aligned to result
+        result.emplace_back(line);
+    }
+
+    // Return result
+    return result;
+}
+
+/**
+ * @brief separates a string in single words
+ * @param str string to parse
+ * @return vector with splitted words
+ */
+vector<string> Justify::splitWords(const string& str)
+{
+
+    vector<string> words;
+
+    // Tokenizer separates string to words
+    char_separator<char> sep(" ");
+    tokenizer<boost::char_separator<char> > tok(str, sep);
+    for (auto it=tok.begin(); it!=tok.end(); ++it)
+    {
+        // push words to vector
+        words.push_back(*it);
+    }
+
+    // Return the vector of
+    // words extracted from
+    // string
+    return words;
+}
+
+/**
+ * @brief Function to return justified text
+ * @param result vector with justified strings
+ * @return justified text in as a string
+ */
+string Justify::returnJustifiedText(vector<string>& result)
+{
+    stringstream buffer;
+
+    for (auto& it : result) {
+        buffer << it << "\\n";
+    }
+    return buffer.str();
+}
+
+/**
+ * @brief function to call the justification
+ * @param str string to justify
+ * @param L length of sign per line
+ * @param isOption check if its an options string
+ * @param optionShift shift that needs to be added to aline lines
+ * @return justified text as a string
+ */
+string Justify::justifyTheText(const string& str, int L, bool isOption, int optionShift)
+{
+
+    vector<string> words;
+
+    // Inserting words from
+    // given string
+    words = this->splitWords(str);
+
+    // Function call to
+    // justify the text
+    vector<string> result
+            = this->JustifyText(words, L, isOption, optionShift);
+
+    // Return the justified
+    // text
+    return returnJustifiedText(result);
+}
\ No newline at end of file
diff --git a/src/Justify.h b/src/Justify.h
new file mode 100644
index 0000000..e5facf5
--- /dev/null
+++ b/src/Justify.h
@@ -0,0 +1,37 @@
+#ifndef CODEGENERATOR_JUSTIFY_H
+#define CODEGENERATOR_JUSTIFY_H
+#include "bits/stdc++.h"
+#include <iostream>
+#include <boost/tokenizer.hpp>
+#include <string>
+
+using namespace std;
+using namespace boost;
+
+class Justify
+{
+private:
+    static string JoinALineWithSpace(
+            vector<string>& words,
+            int start, int end,
+            int num_spaces,
+            bool isOption,
+            int curr_line,
+            int optionShift);
+
+    static vector<string> JustifyText(
+            vector<string>& words,
+            int L,
+            bool isOption,
+            int optionShift);
+
+    static vector<string> splitWords(const string& str);
+
+    static string returnJustifiedText(vector<string>& result);
+
+public:
+    string justifyTheText(const string& str, int L, bool isOption, int optionShift);
+};
+
+
+#endif //CODEGENERATOR_JUSTIFY_H
diff --git a/src/SourceCodeWriter.cpp b/src/SourceCodeWriter.cpp
index 0466f93..514b4a7 100644
--- a/src/SourceCodeWriter.cpp
+++ b/src/SourceCodeWriter.cpp
@@ -3,6 +3,7 @@
  */
 
 #include "SourceCodeWriter.h"
+#include "HelpText.h"
 #include <boost/algorithm/string.hpp>
 
 // Constructor
@@ -151,6 +152,7 @@ void SourceCodeWriter::headerFileClass() {
     fprintf(getHeaderFile(), "\n");
     fprintf(getHeaderFile(), "protected:\n");
     //put all elements inside class -> protected here
+    createHeaderPrintHelp();
 
     fprintf(getHeaderFile(), "\n");
     fprintf(getHeaderFile(), "public:\n");
@@ -201,6 +203,7 @@ void SourceCodeWriter::sourceFileNamespace() {
     createSourceUnknownOption();
 
     //Hier kommt der Help-Text dazu
+    createSourcePrintHelp();
 
     //end of namespace
     if (!getGetOptSetup()->getNamespaceName().empty()) {
@@ -504,6 +507,16 @@ void SourceCodeWriter::createSourcePrintVersion() {
 
 }
 
+void SourceCodeWriter::createHeaderPrintHelp() {
+    fprintf(getHeaderFile(), "virtual void printHelp();\n");
+}
+
+void SourceCodeWriter::createSourcePrintHelp() {
+    HelpText *helpText = nullptr;
+    helpText = new HelpText(getGetOptSetup());
+    fprintf(getSourceFile(), "%s", helpText->parseHelpMessage().c_str());
+}
+
 void SourceCodeWriter::writeFile() {
 //    printf("Writing file...\n");
 
diff --git a/src/SourceCodeWriter.h b/src/SourceCodeWriter.h
index f315097..700cd3d 100644
--- a/src/SourceCodeWriter.h
+++ b/src/SourceCodeWriter.h
@@ -138,6 +138,18 @@ class SourceCodeWriter {
       */
      void createSourcePrintVersion();
 
+     /**
+      * @brief
+      * Generates the declaration of the printHelp function in the Header-File
+      */
+     void createHeaderPrintHelp();
+
+     /**
+      * @brief
+      * Generates the implementation of the printHelp function in the Source-File
+      */
+        void createSourcePrintHelp();
+
 };
 
 

From 65328e3d29f1ad2721aac6330bf7ab602b36399b Mon Sep 17 00:00:00 2001
From: NoelKempter <98758634+NoelKempter@users.noreply.github.com>
Date: Sun, 24 Jul 2022 11:30:42 +0200
Subject: [PATCH 04/11] Fixed wrong generation of setting optarg (#129)

* Fixed wrong generation of setting optarg

* Fixed Codacy complain

Co-authored-by: noel.kempter <noel.kempter@INPC-1093>
---
 src/SourceCodeWriter.cpp | 50 ++++++++++++++++++++++------------------
 1 file changed, 27 insertions(+), 23 deletions(-)

diff --git a/src/SourceCodeWriter.cpp b/src/SourceCodeWriter.cpp
index 514b4a7..e197d94 100644
--- a/src/SourceCodeWriter.cpp
+++ b/src/SourceCodeWriter.cpp
@@ -66,8 +66,7 @@ void SourceCodeWriter::setSourceFile(FILE *sourceFile) {
  * @param option a single option object
  * @return string with correct value type
  */
-string SourceCodeWriter::getValueTypeByOption(Option &option)
-{
+string SourceCodeWriter::getValueTypeByOption(Option &option) {
     switch (option.getConvertTo()) {
         case ConvertToOptions::STRING:
             return "std::string";
@@ -130,7 +129,8 @@ void SourceCodeWriter::headerFileClass() {
     // Values for the options
     for (Option option: getGetOptSetup()->getOptions()) {
         if (option.isHasArguments() != HasArguments::NONE) {
-            fprintf(getHeaderFile(), "%s %sValue", getValueTypeByOption(option).c_str(), determineArgsName(option).c_str());
+            fprintf(getHeaderFile(), "%s %sValue", getValueTypeByOption(option).c_str(),
+                    determineArgsName(option).c_str());
             if (option.isHasArguments() == HasArguments::OPTIONAL && !option.getDefaultValue().empty()) {
                 switch (option.getConvertTo()) {
                     case ConvertToOptions::STRING:
@@ -217,19 +217,20 @@ void SourceCodeWriter::createHeaderParsingFunction() {
 
 void SourceCodeWriter::sourceFileParse() {
     fprintf(getSourceFile(), "void %s::parse() {\n", getGetOptSetup()->getClassName().c_str());
-    for (auto &option : getGetOptSetup()->getOptions()) {
+    for (auto &option: getGetOptSetup()->getOptions()) {
         std::string optionName = determineArgsName(option);
         fprintf(getSourceFile(), "if (args.%s.isSet) {\n", optionName.c_str());
 
         // exclusions
         if (!option.getExclusions().empty()) {
-            for (auto &exclusion : option.getExclusions()) {
+            for (auto &exclusion: option.getExclusions()) {
                 // Iterate over options again and compare exclusion with ref
-                for (auto &option2 : getGetOptSetup()->getOptions()) {
+                for (auto &option2: getGetOptSetup()->getOptions()) {
                     std::string option2Name = determineArgsName(option2);
                     if (option2.getRef() == exclusion) {
                         fprintf(getSourceFile(), "if (args.%s.isSet) {\n", option2Name.c_str());
-                        fprintf(getSourceFile(), "perror(\"%s and %s cannot be used together.\");\n", optionName.c_str(), option2Name.c_str());
+                        fprintf(getSourceFile(), "perror(\"%s and %s cannot be used together.\");\n",
+                                optionName.c_str(), option2Name.c_str());
                         fprintf(getSourceFile(), "exit(1);\n");
                         fprintf(getSourceFile(), "}\n");
                     }
@@ -248,9 +249,11 @@ void SourceCodeWriter::sourceFileParse() {
             fprintf(getSourceFile(), "if (!args.%s.value.empty()) {\n", optionName.c_str());
             //TODO This might not work this way, check back later
             fprintf(getSourceFile(), "try {\n");
-            fprintf(getSourceFile(), "%sValue = boost::lexical_cast<typeof %sValue>(args.%s.value);\n", optionName.c_str(), optionName.c_str(), optionName.c_str());
+            fprintf(getSourceFile(), "%sValue = boost::lexical_cast<typeof %sValue>(args.%s.value);\n",
+                    optionName.c_str(), optionName.c_str(), optionName.c_str());
             fprintf(getSourceFile(), "} catch (boost::bad_lexical_cast &) {\n");
-            fprintf(getSourceFile(), "perror(\"%s is not convertible to %s.\");\n}\n", optionName.c_str(), getValueTypeByOption(option).c_str());
+            fprintf(getSourceFile(), "perror(\"%s is not convertible to %s.\");\n}\n", optionName.c_str(),
+                    getValueTypeByOption(option).c_str());
             fprintf(getSourceFile(), "}\n");
         }
 
@@ -348,12 +351,12 @@ void SourceCodeWriter::createSourceParsingFunction() {
                 fprintf(getSourceFile(), "if(optarg == nullptr){\n"
                                          "perror(\"There was no argument passed for the option \\\"%s\\\" "
                                          "which requires one.\");\n"
-                                         "exit(1);\n}\nargs.%s.value = optarg;\n",
+                                         "exit(1);\n}\n",
                         bothOpts.c_str(), determineArgsName(option).c_str());
                 if (option.getConvertTo() == ConvertToOptions::BOOLEAN) {
-                    fprintf(getSourceFile(), "if(strcmp(optarg, \"true\"))\nargs.%s.value = \"1\";\n"
-                                             "else if(strcmp(optarg, \"false\"))\nargs.%s.value = \"0\";\n"
-                                             "else\nargs.%s.value = optarg;\n",
+                    fprintf(getSourceFile(), "args.%s.value = optarg;\nif(strcmp(optarg, \"true\")"
+                                             ")\nargs.%s.value = \"1\";\n"
+                                             "else if(strcmp(optarg, \"false\"))\nargs.%s.value = \"0\";\n",
                             determineArgsName(option).c_str(), determineArgsName(option).c_str(),
                             determineArgsName(option).c_str());
                 } else
@@ -361,16 +364,15 @@ void SourceCodeWriter::createSourceParsingFunction() {
                             determineArgsName(option).c_str());
                 break;
             case HasArguments::OPTIONAL:
-                fprintf(getSourceFile(), "if(optarg != nullptr)\nargs.%s.value = optarg;",
-                        determineArgsName(option).c_str());
+                fprintf(getSourceFile(), "if(optarg != nullptr){\n");
                 if (option.getConvertTo() == ConvertToOptions::BOOLEAN) {
-                    fprintf(getSourceFile(), "if(strcmp(optarg, \"true\"))\nargs.%s.value = \"1\";\n"
-                                             "else if(strcmp(optarg, \"false\"))\nargs.%s.value = \"0\";\n"
-                                             "else\nargs.%s.value = optarg;\n",
+                    fprintf(getSourceFile(), "args.%s.value = optarg;\nif(strcmp(optarg, \"true\"))"
+                                             "\nargs.%s.value = \"1\";\n"
+                                             "else if(strcmp(optarg, \"false\"))\nargs.%s.value = \"0\";\n}\n",
                             determineArgsName(option).c_str(), determineArgsName(option).c_str(),
                             determineArgsName(option).c_str());
                 } else
-                    fprintf(getSourceFile(), "args.%s.value = optarg;\n",
+                    fprintf(getSourceFile(), "args.%s.value = optarg;\n}\n",
                             determineArgsName(option).c_str());
                 break;
             default:
@@ -469,7 +471,8 @@ void SourceCodeWriter::createSourceGetter() {
                     determineArgsName(option).c_str());
             if (option.isHasArguments() != HasArguments::NONE) {
                 fprintf(getSourceFile(), "%s %s::getValueOf%s() const{\nreturn %sValue;\n}\n",
-                        getValueTypeByOption(option).c_str(), getGetOptSetup()->getClassName().c_str(), capitalizedArgsName.c_str(),
+                        getValueTypeByOption(option).c_str(), getGetOptSetup()->getClassName().c_str(),
+                        capitalizedArgsName.c_str(),
                         determineArgsName(option).c_str());
             }
         } else if (option.getInterface().empty() && option.getConnectToInternalMethod().empty()
@@ -484,10 +487,11 @@ void SourceCodeWriter::createSourceGetter() {
 void SourceCodeWriter::createExternalFunctions() {
     vector<Option> options = getGetOptSetup()->getOptions();
 
-    for(auto &option : options){
-        if(!option.getConnectToExternalMethod().empty()){
+    for (auto &option: options) {
+        if (!option.getConnectToExternalMethod().empty()) {
             fprintf(getHeaderFile(), "virtual void %s(", option.getConnectToExternalMethod().c_str());
-            if(option.isHasArguments() == HasArguments::OPTIONAL || option.isHasArguments() == HasArguments::REQUIRED){
+            if (option.isHasArguments() == HasArguments::OPTIONAL ||
+                option.isHasArguments() == HasArguments::REQUIRED) {
                 std::string type = getValueTypeByOption(option);
                 fprintf(getHeaderFile(), "%s arg", type.c_str());
             }

From 9f40e39186e56b13b882587dedc4b362a22584bc Mon Sep 17 00:00:00 2001
From: philippkuest <100705472+philippkuest@users.noreply.github.com>
Date: Sun, 24 Jul 2022 10:57:12 +0000
Subject: [PATCH 05/11] Added authors (#134)

* Added authors

* Added authors

* Added authors

* Added authors

* Added doxygen

* Added doxygen

* Added doxygen

* Added doxygen

* Added more editors

* Added more comments

* Added more comments

* Added more comments

* Added more comments

* Added more comments

* Added more comments

* Added more comments

* Added more comments

Co-authored-by: Tobias Goetz <tobigoetz98@gmail.com>
---
 src/CodeGenerator.h            |  4 ++-
 src/HelpText.cpp               | 43 +++-----------------------
 src/HelpText.h                 | 55 ++++++++++++++++++++++++++++++++++
 src/Justify.cpp                | 41 +++----------------------
 src/Justify.h                  | 46 ++++++++++++++++++++++++++--
 src/SourceCodeWriter.h         | 39 ++++++++++++++++++++++--
 src/XMLParser.cpp              | 14 +--------
 src/XMLParser.h                | 18 +++++++++--
 src/models/Author.cpp          | 10 +++----
 src/models/Author.h            | 24 ++++++++++++---
 src/models/GetOptSetup.h       | 29 +++++++++++++++---
 src/models/Option.h            | 26 ++++++++++++++--
 src3/ExampleProgram.cpp        | 11 +++----
 src3/ExampleProgram.h          | 13 ++++++--
 src3/ExtendedGeneratedCode.cpp |  4 +++
 src3/ExtendedGeneratedCode.h   |  4 +++
 16 files changed, 258 insertions(+), 123 deletions(-)

diff --git a/src/CodeGenerator.h b/src/CodeGenerator.h
index 11f015b..6ad1fab 100644
--- a/src/CodeGenerator.h
+++ b/src/CodeGenerator.h
@@ -5,7 +5,9 @@
 #ifndef PROGRAMMING_C_CODEGENERATOR_H
 #define PROGRAMMING_C_CODEGENERATOR_H
 
-
+/**
+ * @brief Class for the CodeGenerator
+ */
 class CodeGenerator{
 };
 
diff --git a/src/HelpText.cpp b/src/HelpText.cpp
index 46c30ec..7ac8f18 100644
--- a/src/HelpText.cpp
+++ b/src/HelpText.cpp
@@ -1,3 +1,7 @@
+/*
+ * Editors: Sebastian Wolf, Tobias Goetz
+ */
+
 #include "HelpText.h"
 
 HelpText::HelpText(GetOptSetup *getOptSetup)
@@ -6,10 +10,6 @@ HelpText::HelpText(GetOptSetup *getOptSetup)
 }
 HelpText::~HelpText() = default;
 
-/**
- * @brief concatenate the description strings to one string
- * @brief and add to printHelpText
- */
 void HelpText::parseDescription()
 {
     string new_description;
@@ -42,13 +42,6 @@ bool compareOptions(const Option &a, const Option &b) {
     }
 }
 
-/**
- * @brief concatenate short opt and long opt to one string
- * different checks if shortOpt and LongOpt are empty
- * to concatenate the right signs to the string
- * @param i iteration counter to determine which option is parsed
- * @return concatenated opts as string
- */
 vector<string> HelpText::concatParams(const vector<Option>& options)
 {
     vector<string> opts;
@@ -85,21 +78,6 @@ vector<string> HelpText::concatParams(const vector<Option>& options)
     return opts;
 }
 
-/**
- * @brief concatenate the options to one string
- * @brief and add to printHelpText
- * call the getMaxParamLength() Method. Get concatenated params
- * by calling concatParams function with i as iterator.
- * write strings to buffer with a spacing using set()
- * calculate a new signPerLine to space out the
- * option description accordingly to the length
- * of param and the shift.
- * calculate a new shift for every line of the description
- * that is pushed to the next line because of signPerLine,
- * in order to shift the line to the right, matching the above.
- * Justify the description text. Write justified text to
- * class variable.
- */
 void HelpText::parseOption()
 {
     // sorting options
@@ -138,11 +116,6 @@ void HelpText::parseOption()
     printHelpText.append(buffer.str());
 }
 
-/**
- * @brief concatenate usage strings to one string
- * @brief and add to printHelpText
- * @return all usage strings as a string with line break.
- */
 void HelpText::parseUsage()
 {
     string new_usage;
@@ -152,19 +125,11 @@ void HelpText::parseUsage()
     printHelpText.append("Usage:\\n" + justify.justifyTheText(new_usage, getOptSetup->getSignPerLine(), false, 0));
 }
 
-/**
- * @brief concatenate the author information to one string
- * @brief and add to printHelpText
- */
 void HelpText::parseAuthor()
 {
     printHelpText.append("Author:\\n" + justify.justifyTheText(getOptSetup->getAuthor().getName() + ", " + getOptSetup->getAuthor().getMail(), getOptSetup->getSignPerLine(), false, 0));
 }
 
-/**
- * @brief add function wrapper and call parse methods
- * @return getHelp() Function with message as string
- */
 string HelpText::parseHelpMessage()
 {
     // add function beginning to string
diff --git a/src/HelpText.h b/src/HelpText.h
index a6bdb7c..6e1a50c 100644
--- a/src/HelpText.h
+++ b/src/HelpText.h
@@ -1,3 +1,7 @@
+/*
+ * Editors: Sebastian Wolf, Tobias Goetz
+ */
+
 #ifndef CODEGENERATOR_HELPTEXT_H
 #define CODEGENERATOR_HELPTEXT_H
 
@@ -9,20 +13,71 @@
 
 using namespace std;
 
+/**
+ * @brief Class for the HelpText parsing
+ */
 class HelpText
 {
 public:
+    /**
+     * @brief Constructor for the HelpText
+     */
     explicit HelpText(GetOptSetup *getOptSetup);
+    /**
+     * @brief Destructor for the HelpText
+     */
     ~HelpText();
 
+    /**
+    * @brief add function wrapper and call parse methods
+    * @return getHelp() Function with message as string
+    */
     string parseHelpMessage();
 
 private:
+    /**
+    * @brief concatenate the description strings to one string
+    * @brief and add to printHelpText
+    */
     void parseDescription();
+
+    /**
+    * @brief concatenate usage strings to one string
+    * @brief and add to printHelpText
+    * @return all usage strings as a string with line break.
+    */
     void parseUsage();
+
+    /**
+    * @brief concatenate the author information to one string
+    * @brief and add to printHelpText
+    */
     void parseAuthor();
+
+    /**
+    * @brief concatenate the options to one string
+    * @brief and add to printHelpText
+    * call the getMaxParamLength() Method. Get concatenated params
+    * by calling concatParams function with i as iterator.
+    * write strings to buffer with a spacing using set()
+    * calculate a new signPerLine to space out the
+    * option description accordingly to the length
+    * of param and the shift.
+    * calculate a new shift for every line of the description
+    * that is pushed to the next line because of signPerLine,
+    * in order to shift the line to the right, matching the above.
+    * Justify the description text. Write justified text to
+    * class variable.
+    */
     void parseOption();
 
+    /**
+    * @brief concatenate short opt and long opt to one string
+    * different checks if shortOpt and LongOpt are empty
+    * to concatenate the right signs to the string
+    * @param i iteration counter to determine which option is parsed
+    * @return concatenated opts as string
+    */
     vector<string> concatParams(const vector<Option>& sortedOpts);
     /**
      * @brief printHelp Text
diff --git a/src/Justify.cpp b/src/Justify.cpp
index e6790e2..e920364 100644
--- a/src/Justify.cpp
+++ b/src/Justify.cpp
@@ -1,16 +1,9 @@
+/*
+ * Editors: Sebastian Wolf
+ */
+
 #include "Justify.h"
 
-/**
- * @brief Function to join the words with spaces spread evenly
- * @param words vector with separated words
- * @param start current line start
- * @param end iterator
- * @param num_spaces
- * @param isOption check if its an options string
- * @param curr_line current line string is in
- * @param optionShift shift that needs to be added to aline lines
- * @return justified text
- */
 string Justify::JoinALineWithSpace(
         vector<string>& words,
         int start, int end,
@@ -61,14 +54,6 @@ string Justify::JoinALineWithSpace(
     return line;
 }
 
-/**
- * @brief Function that justify the words of sentence of length of line L
- * @param words vector with separated words
- * @param L length of sign per line
- * @param isOption check if its an options string
- * @param optionShift shift that needs to be added to aline lines
- * @return whole justified string
- */
 vector<string> Justify::JustifyText(
         vector<string>& words,
         int L,
@@ -194,11 +179,6 @@ vector<string> Justify::JustifyText(
     return result;
 }
 
-/**
- * @brief separates a string in single words
- * @param str string to parse
- * @return vector with splitted words
- */
 vector<string> Justify::splitWords(const string& str)
 {
 
@@ -219,11 +199,6 @@ vector<string> Justify::splitWords(const string& str)
     return words;
 }
 
-/**
- * @brief Function to return justified text
- * @param result vector with justified strings
- * @return justified text in as a string
- */
 string Justify::returnJustifiedText(vector<string>& result)
 {
     stringstream buffer;
@@ -234,14 +209,6 @@ string Justify::returnJustifiedText(vector<string>& result)
     return buffer.str();
 }
 
-/**
- * @brief function to call the justification
- * @param str string to justify
- * @param L length of sign per line
- * @param isOption check if its an options string
- * @param optionShift shift that needs to be added to aline lines
- * @return justified text as a string
- */
 string Justify::justifyTheText(const string& str, int L, bool isOption, int optionShift)
 {
 
diff --git a/src/Justify.h b/src/Justify.h
index e5facf5..fd22950 100644
--- a/src/Justify.h
+++ b/src/Justify.h
@@ -1,3 +1,7 @@
+/*
+ * Editors: Sebastian Wolf
+ */
+
 #ifndef CODEGENERATOR_JUSTIFY_H
 #define CODEGENERATOR_JUSTIFY_H
 #include "bits/stdc++.h"
@@ -8,9 +12,23 @@
 using namespace std;
 using namespace boost;
 
+/**
+ * @brief Class to justify a string
+ */
 class Justify
 {
 private:
+    /**
+    * @brief Function to join the words with spaces spread evenly
+    * @param words vector with separated words
+    * @param start current line start
+    * @param end iterator
+    * @param num_spaces
+    * @param isOption check if its an options string
+    * @param curr_line current line string is in
+    * @param optionShift shift that needs to be added to aline lines
+    * @return justified text
+    */
     static string JoinALineWithSpace(
             vector<string>& words,
             int start, int end,
@@ -18,18 +36,42 @@ class Justify
             bool isOption,
             int curr_line,
             int optionShift);
-
+    /**
+    * @brief Function that justify the words of sentence of length of line L
+    * @param words vector with separated words
+    * @param L length of sign per line
+    * @param isOption check if its an options string
+    * @param optionShift shift that needs to be added to aline lines
+    * @return whole justified string
+    */
     static vector<string> JustifyText(
             vector<string>& words,
             int L,
             bool isOption,
             int optionShift);
-
+    /**
+    * @brief separates a string in single words
+    * @param str string to parse
+    * @return vector with splitted words
+    */
     static vector<string> splitWords(const string& str);
 
+    /**
+    * @brief Function to return justified text
+    * @param result vector with justified strings
+    * @return justified text in as a string
+    */
     static string returnJustifiedText(vector<string>& result);
 
 public:
+    /**
+    * @brief function to call the justification
+    * @param str string to justify
+    * @param L length of sign per line
+    * @param isOption check if its an options string
+    * @param optionShift shift that needs to be added to aline lines
+    * @return justified text as a string
+    */
     string justifyTheText(const string& str, int L, bool isOption, int optionShift);
 };
 
diff --git a/src/SourceCodeWriter.h b/src/SourceCodeWriter.h
index 700cd3d..9d552bb 100644
--- a/src/SourceCodeWriter.h
+++ b/src/SourceCodeWriter.h
@@ -8,29 +8,64 @@
 #include <iostream>
 #include "models/GetOptSetup.h"
 
+/**
+ * @brief Class for the SourceCodeWriter
+ */
 class SourceCodeWriter {
 private:
+    /**
+     * @brief The GetOptSetup
+     */
     GetOptSetup *getOptSetup = nullptr;
+    /**
+     * @brief The header file
+     */
     FILE *headerFile = nullptr;
+    /**
+     * @brief The source file
+     */
     FILE *sourceFile = nullptr;
 
     // Helpers
+    /**
+     * @brief Get the type of the option depending on ConvertTo
+     * @param option The option
+     * @return The type of the option as string
+     */
     static string getValueTypeByOption(Option &option);
 public:
     // Constructor
+    /**
+     * @brief Constructor for the SourceCodeWriter
+     * @param getOptSetup The GetOptSetup
+     */
     explicit SourceCodeWriter(GetOptSetup *getOptSetup);
+    /**
+     * @brief Destructor for the SourceCodeWriter
+     */
     ~SourceCodeWriter();
 
-    // Getter
+    /** @name Getter
+    * @brief  Getter for the class
+    */
+    ///@{
     GetOptSetup *getGetOptSetup() const;
     FILE *getHeaderFile();
     FILE *getSourceFile();
+    ///@}
 
-    // Setter
+    /** @name Getter
+    * @brief  Getter for the class
+    */
+    ///@{
     void setHeaderFile(FILE *headerFile);
     void setSourceFile(FILE *sourceFile);
+    ///@}
 
     // Methods
+    /**
+     * @brief Write the .h and .cpp files
+     */
     void writeFile();
 
     // Write code functions
diff --git a/src/XMLParser.cpp b/src/XMLParser.cpp
index a3f2bf7..c309ef3 100644
--- a/src/XMLParser.cpp
+++ b/src/XMLParser.cpp
@@ -27,8 +27,7 @@ void XMLParser::parse() {
         XMLString::release(&message);
     }
 
-    SAXParser* parser = {nullptr};
-    parser = new SAXParser;
+    auto* parser = new SAXParser;
 
     int errorCount = {0};
 
@@ -47,12 +46,6 @@ void XMLParser::parse() {
     {
         char* message = XMLString::transcode(toCatch.getMessage());
 
-        //XMLString::release(message);
-        /*
-        XERCES_STD_QUALIFIER cerr << "\nAn error occurred\n  Error: "
-                                  << StrX(toCatch.getMessage())
-                                  << "\n" << XERCES_STD_QUALIFIER endl;
-                                  */
         cerr << "XMLException: " << message << endl;
     }
     catch(...) {
@@ -79,8 +72,6 @@ void XMLParser::endDocument() {
 }
 
 void XMLParser::startElement(const XMLCh *const name, AttributeList &attributes) {
-//    cout << "Start-Element: " << converter.to_bytes(name) << endl;
-
     if (!XMLString::compareString(name, u"GetOptSetup")) {
         sm->handleEvent(Event::GETOPTSETUPSTART);
         getOptSetup->parseAttributes(attributes);
@@ -116,8 +107,6 @@ void XMLParser::startElement(const XMLCh *const name, AttributeList &attributes)
 }
 
 void XMLParser::endElement(const XMLCh *const name) {
-//    cout << "End-Element: " << converter.to_bytes(name) << endl;
-
     if (!XMLString::compareString(name, u"GetOptSetup")) {
         sm->handleEvent(Event::GETOPTSETUPEND);
     } else if (!XMLString::compareString(name, u"Author")) {
@@ -146,7 +135,6 @@ void XMLParser::endElement(const XMLCh *const name) {
 }
 
 void XMLParser::characters(const XMLCh *const chars, const XMLSize_t length) {
-//    cout << "Characters (" << length << "):" << converter.to_bytes(chars, chars + length) << endl;
     switch (sm->getState()) {
         case State::START:
             break;
diff --git a/src/XMLParser.h b/src/XMLParser.h
index d38ac9b..44bb704 100644
--- a/src/XMLParser.h
+++ b/src/XMLParser.h
@@ -17,6 +17,9 @@ XERCES_CPP_NAMESPACE_USE
 
 using namespace std;
 
+/**
+ * @brief Class for the XMLParser
+ */
 class XMLParser : public HandlerBase {
 private:
     /**
@@ -25,11 +28,17 @@ class XMLParser : public HandlerBase {
      */
     std::string filename;
 
+    /**
+     * @brief stateMachine
+     * StateMachine to parse the file.
+     */
     StateMachine *sm = new StateMachine();
 
+    /**
+     * @brief getOptSetup
+     * GetOptSetup to parse the file.
+     */
     GetOptSetup *getOptSetup = new GetOptSetup();
-
-    wstring_convert<codecvt_utf8_utf16<char16_t>,char16_t> converter;
 public:
     /**
      * @brief XMLParser
@@ -38,6 +47,9 @@ class XMLParser : public HandlerBase {
      */
     explicit XMLParser(const string &filename);
 
+    /**
+     * @brief The main parser function.
+     */
     void parse();
 
     void startDocument() override;
@@ -48,7 +60,7 @@ class XMLParser : public HandlerBase {
 
     /**
      * @brief getGetOptSetup
-     * @return
+     * @return getOptSetup
      */
     GetOptSetup *getGetOptSetup() const;
 };
diff --git a/src/models/Author.cpp b/src/models/Author.cpp
index 81fd7f1..f71b0f1 100644
--- a/src/models/Author.cpp
+++ b/src/models/Author.cpp
@@ -5,11 +5,10 @@
 #include <xercesc/util/XMLString.hpp>
 #include "Author.h"
 
-// Constructors
+//Constructor
 Author::Author() = default;
 
-
-// Getters
+//Getters
 const string &Author::getName() const {
     return name;
 }
@@ -23,7 +22,7 @@ const string &Author::getMail() const {
 }
 
 
-// Setters
+//Setters
 void Author::setName(const string &_name) {
     Author::name = _name;
 }
@@ -36,8 +35,7 @@ void Author::setMail(const string &_mail) {
     Author::mail = _mail;
 }
 
-
-// Helpers
+//helper function to parse the Author-Tag
 void Author::parseAttributes(AttributeList &attributes) {
     for (unsigned int i = 0; i < attributes.getLength(); i++) {
         if (!XMLString::compareString(attributes.getName(i), u"Name")) {
diff --git a/src/models/Author.h b/src/models/Author.h
index 7a5794f..30d0153 100644
--- a/src/models/Author.h
+++ b/src/models/Author.h
@@ -12,22 +12,38 @@
 XERCES_CPP_NAMESPACE_USE
 using namespace std;
 
+/**
+ * @brief Class for the Author-Tag
+ */
 class Author {
 public:
-    // Constructors
+    /**
+     * @brief Constructor for the Author-Tag
+     */
     Author();
 
-    // Getters
+    /** @name Getter
+    * @brief  Getter for the class
+    */
+    ///@{
     const string &getName() const;
     const string &getPhone() const;
     const string &getMail() const;
+    ///@}
 
-    // Setters
+    /** @name Setter
+    * @brief  Setter for the class
+    */
+    ///@{
     void setName(const string &name);
     void setPhone(const string &phone);
     void setMail(const string &email);
+    ///@}
 
-    // Helpers
+    /**
+     * @brief Function to parse the Author-Tag
+     * @param attributes AttributeList of the Author-Tag
+     */
     void parseAttributes(AttributeList &attributes);
 
 private:
diff --git a/src/models/GetOptSetup.h b/src/models/GetOptSetup.h
index 2f2569a..86393d9 100644
--- a/src/models/GetOptSetup.h
+++ b/src/models/GetOptSetup.h
@@ -14,12 +14,20 @@
 
 XERCES_CPP_NAMESPACE_USE
 
+/**
+ * @brief Class for the GetOptSetup-Tag
+ */
 class GetOptSetup {
 public:
-    // Constructors
+    /**
+     * @brief Constructor for the GetOptSetup-Class
+     */
     GetOptSetup();
 
-    // Getters
+    /** @name Getter
+    * @brief  Getter for the class
+    */
+    ///@{
     const int &getSignPerLine() const;
     const Author &getAuthor() const;
     const string &getHeaderFileName() const;
@@ -29,8 +37,12 @@ class GetOptSetup {
     const vector<string> &getOverAllDescriptions() const;
     const vector<string> &getSampleUsages() const;
     const vector<Option> &getOptions() const;
+    ///@}
 
-    // Setters
+    /** @name Setter
+    * @brief  Setter for the class
+    */
+    ///@{
     void setSignPerLine(const string &signPerLine);
     void setAuthor(const Author &author);
     void setHeaderFileName(const string &headerFileName);
@@ -40,13 +52,22 @@ class GetOptSetup {
     void setOverAllDescriptions(const vector<string> &overAllDescriptions);
     void setSampleUsages(const vector<string> &sampleUsages);
     void setOptions(const vector<Option> &options);
+    ///@}
 
-    // Adders
+    /** @name Adder
+    * @brief  Adder for the class
+    */
+    ///@{
     void addOverAllDescription(const string &overAllDescription);
     void addSampleUsage(const string &sampleUsage);
     void addOption(const Option &option);
+    ///@}
 
     // Helpers
+    /**
+     * @brief Function to check if the class is valid
+     * @param attributes AttributeList of the GetOptSetup-Tag
+     */
     void parseAttributes(AttributeList &attributes);
 private:
     /**
diff --git a/src/models/Option.h b/src/models/Option.h
index 0f788ba..cd612df 100644
--- a/src/models/Option.h
+++ b/src/models/Option.h
@@ -12,24 +12,36 @@
 
 XERCES_CPP_NAMESPACE_USE
 
+/**
+ * @brief enum for the ConvertTo of the Option-Tag
+ */
 enum class ConvertToOptions {
     STRING,
     INTEGER,
     BOOLEAN
 };
 
+/**
+ * @brief enum for the HasArguments of the Option-Tag
+ */
 enum class HasArguments {
     NONE,
     OPTIONAL,
     REQUIRED
 };
 
+/**
+ * @brief Class for the Option-Tag
+ */
 class Option {
 public:
     // Constructor
     Option();
 
-    // Getters
+    /** @name Getter
+    * @brief  Getter for the class
+    */
+    ///@{
     int getRef() const;
     char getShortOpt() const;
     const std::string &getLongOpt() const;
@@ -41,8 +53,12 @@ class Option {
     ConvertToOptions getConvertTo() const;
     std::string getDefaultValue() const;
     std::string getInterface() const;
+    ///@}
 
-    // Setters
+    /** @name Setter
+    * @brief  Setter for the class
+    */
+    ///@{
     void setRef(const std::string &ref);
     void setShortOpt(const std::string &shortOpt);
     void setLongOpt(const std::string &longOpt);
@@ -54,8 +70,12 @@ class Option {
     void setConvertTo(const std::string &convertTo);
     void setDefaultValue(const std::string &defaultValue);
     void setInterface(const std::string &interface);
+    ///@}
 
-    // Helpers
+    /**
+     * @brief Function to parse the Option-Tag
+     * @param attributes AttributeList of the Option-Tag
+     */
     void parseAttributes(AttributeList &attributes);
 private:
     /**
diff --git a/src3/ExampleProgram.cpp b/src3/ExampleProgram.cpp
index eb43d46..49c1b76 100644
--- a/src3/ExampleProgram.cpp
+++ b/src3/ExampleProgram.cpp
@@ -1,17 +1,14 @@
+/*
+ * Editors: Philipp Kuest, Tobias Goetz
+ */
+
 #include "ExampleProgram.h"
 #include "generatedCode.h"
 
-/**
- * @brief Constructor, that generates a object of ExtendedGeneratedCode
- */
 ExampleProgram::ExampleProgram(GC::GeneratedClass *generatedClass) {
     this->generatedClass = generatedClass;
 }
 
-/**
- * @brief Getter for generatedClass
- * @return object of class ExtendedGeneratedCode
- */
 GC::GeneratedClass *ExampleProgram::getGeneratedClass() {
     return generatedClass;
 }
diff --git a/src3/ExampleProgram.h b/src3/ExampleProgram.h
index 8013976..36b2afe 100644
--- a/src3/ExampleProgram.h
+++ b/src3/ExampleProgram.h
@@ -1,3 +1,7 @@
+/*
+ * Editors: Philipp Kuest, Tobias Goetz
+ */
+
 #ifndef CODEGENERATOR_EXAMPLEPROGRAM_H
 #define CODEGENERATOR_EXAMPLEPROGRAM_H
 
@@ -9,10 +13,15 @@ class ExampleProgram {
     GC::GeneratedClass *generatedClass = nullptr;
 protected:
 public:
-    //Constructor
+    /**
+    * @brief Constructor, that generates a object of ExtendedGeneratedCode
+    */
     explicit ExampleProgram(GC::GeneratedClass *generatedClass);
 
-    //Getter
+    /**
+    * @brief Getter for generatedClass
+    * @return object of class ExtendedGeneratedCode
+    */
     GC::GeneratedClass *getGeneratedClass();
 };
 
diff --git a/src3/ExtendedGeneratedCode.cpp b/src3/ExtendedGeneratedCode.cpp
index b99f03d..4f96fb8 100644
--- a/src3/ExtendedGeneratedCode.cpp
+++ b/src3/ExtendedGeneratedCode.cpp
@@ -1,3 +1,7 @@
+/*
+ * Editors: Philipp Kuest, Tobias Goetz
+ */
+
 #include "ExtendedGeneratedCode.h"
 
 void ExtendedGeneratedCode::printVersion() {
diff --git a/src3/ExtendedGeneratedCode.h b/src3/ExtendedGeneratedCode.h
index ee3231d..2a81587 100644
--- a/src3/ExtendedGeneratedCode.h
+++ b/src3/ExtendedGeneratedCode.h
@@ -1,3 +1,7 @@
+/*
+ * Editors: Philipp Kuest, Tobias Goetz
+ */
+
 #ifndef CODEGENERATOR_EXTENDEDGENERATEDCODE_H
 #define CODEGENERATOR_EXTENDEDGENERATEDCODE_H
 

From 2077caaa367099140e5e4b389aaf0b89f9ebc7e8 Mon Sep 17 00:00:00 2001
From: Tobias Goetz <tobigoetz98@gmail.com>
Date: Sun, 24 Jul 2022 13:59:59 +0200
Subject: [PATCH 06/11] Feature/i135 make helper functions on sourcecodewriter
 private (#136)

* Changed scope of helper in sourcedodewriter

* Fixed empty statement

* Fixed initialization never used
---
 src/SourceCodeWriter.cpp | 15 +++---
 src/SourceCodeWriter.h   | 99 ++++++++++++++++++++--------------------
 2 files changed, 56 insertions(+), 58 deletions(-)

diff --git a/src/SourceCodeWriter.cpp b/src/SourceCodeWriter.cpp
index e197d94..458906c 100644
--- a/src/SourceCodeWriter.cpp
+++ b/src/SourceCodeWriter.cpp
@@ -49,12 +49,12 @@ GetOptSetup *SourceCodeWriter::getGetOptSetup() const {
 }
 
 // Setter
-void SourceCodeWriter::setHeaderFile(FILE *headerFile) {
-    this->headerFile = headerFile;
+void SourceCodeWriter::setHeaderFile(FILE *_headerFile) {
+    this->headerFile = _headerFile;
 }
 
-void SourceCodeWriter::setSourceFile(FILE *sourceFile) {
-    this->sourceFile = sourceFile;
+void SourceCodeWriter::setSourceFile(FILE *_sourceFile) {
+    this->sourceFile = _sourceFile;
 }
 
 /*
@@ -304,7 +304,7 @@ void SourceCodeWriter::createSourceParsingFunction() {
             else
                 fprintf(getSourceFile(), "0, '%c'},\n", option.getShortOpt());
         }
-    };
+    }
     longOptsWithoutShortOpt = 0;
 
     fprintf(getSourceFile(), "{0, 0, 0, 0}\n};\nint option_index = 0;\n\n");
@@ -386,7 +386,7 @@ void SourceCodeWriter::createSourceParsingFunction() {
 
         //Close case
         fprintf(getSourceFile(), "break;\n");
-    };
+    }
 
     //Close switch-case
     fprintf(getSourceFile(), "case '?':\ndefault:\nunknownOption(std::to_string(optopt));\nbreak;}\n");
@@ -516,8 +516,7 @@ void SourceCodeWriter::createHeaderPrintHelp() {
 }
 
 void SourceCodeWriter::createSourcePrintHelp() {
-    HelpText *helpText = nullptr;
-    helpText = new HelpText(getGetOptSetup());
+    auto *helpText = new HelpText(getGetOptSetup());
     fprintf(getSourceFile(), "%s", helpText->parseHelpMessage().c_str());
 }
 
diff --git a/src/SourceCodeWriter.h b/src/SourceCodeWriter.h
index 9d552bb..5432a20 100644
--- a/src/SourceCodeWriter.h
+++ b/src/SourceCodeWriter.h
@@ -33,40 +33,6 @@ class SourceCodeWriter {
      * @return The type of the option as string
      */
     static string getValueTypeByOption(Option &option);
-public:
-    // Constructor
-    /**
-     * @brief Constructor for the SourceCodeWriter
-     * @param getOptSetup The GetOptSetup
-     */
-    explicit SourceCodeWriter(GetOptSetup *getOptSetup);
-    /**
-     * @brief Destructor for the SourceCodeWriter
-     */
-    ~SourceCodeWriter();
-
-    /** @name Getter
-    * @brief  Getter for the class
-    */
-    ///@{
-    GetOptSetup *getGetOptSetup() const;
-    FILE *getHeaderFile();
-    FILE *getSourceFile();
-    ///@}
-
-    /** @name Getter
-    * @brief  Getter for the class
-    */
-    ///@{
-    void setHeaderFile(FILE *headerFile);
-    void setSourceFile(FILE *sourceFile);
-    ///@}
-
-    // Methods
-    /**
-     * @brief Write the .h and .cpp files
-     */
-    void writeFile();
 
     // Write code functions
     /**
@@ -165,26 +131,59 @@ class SourceCodeWriter {
      * @brief
      * Generates the declaration of the printVersion function in the Header-File
      */
-     void createHeaderPrintVersion();
+    void createHeaderPrintVersion();
+
+    /**
+     * @brief
+     * Generates the implementation of the printVersion function in the Source-File
+     */
+    void createSourcePrintVersion();
 
-     /**
-      * @brief
-      * Generates the implementation of the printVersion function in the Source-File
-      */
-     void createSourcePrintVersion();
+    /**
+     * @brief
+     * Generates the declaration of the printHelp function in the Header-File
+     */
+    void createHeaderPrintHelp();
 
-     /**
-      * @brief
-      * Generates the declaration of the printHelp function in the Header-File
-      */
-     void createHeaderPrintHelp();
+    /**
+     * @brief
+     * Generates the implementation of the printHelp function in the Source-File
+     */
+    void createSourcePrintHelp();
+public:
+    // Constructor
+    /**
+     * @brief Constructor for the SourceCodeWriter
+     * @param getOptSetup The GetOptSetup
+     */
+    explicit SourceCodeWriter(GetOptSetup *getOptSetup);
+    /**
+     * @brief Destructor for the SourceCodeWriter
+     */
+    ~SourceCodeWriter();
+
+    /** @name Getter
+    * @brief  Getter for the class
+    */
+    ///@{
+    GetOptSetup *getGetOptSetup() const;
+    FILE *getHeaderFile();
+    FILE *getSourceFile();
+    ///@}
 
-     /**
-      * @brief
-      * Generates the implementation of the printHelp function in the Source-File
-      */
-        void createSourcePrintHelp();
+    /** @name Getter
+    * @brief  Getter for the class
+    */
+    ///@{
+    void setHeaderFile(FILE *headerFile);
+    void setSourceFile(FILE *sourceFile);
+    ///@}
 
+    // Methods
+    /**
+     * @brief Write the .h and .cpp files
+     */
+    void writeFile();
 };
 
 

From 68394bef5ae144c0a5ff76b7500e4bd94eb632e5 Mon Sep 17 00:00:00 2001
From: NoelKempter <98758634+NoelKempter@users.noreply.github.com>
Date: Sun, 24 Jul 2022 14:00:25 +0200
Subject: [PATCH 07/11] Feature/i130 implement functionality for handing path
 to xml via command line (#138)

* Added getopt for CodeGenerator

* Merge-Conflict

* Fixed signature of setter of codegenerator

* Fixed wrong has-argument

* Fixed typos

Co-authored-by: noel.kempter <noel.kempter@INPC-1093>
Co-authored-by: Tobias Goetz <tobigoetz98@gmail.com>
---
 example/Example.xml   |  4 +--
 src/CodeGenerator.cpp | 58 +++++++++++++++++++++++++++++++++++++++----
 src/CodeGenerator.h   | 32 +++++++++++++++++++++++-
 3 files changed, 86 insertions(+), 8 deletions(-)

diff --git a/example/Example.xml b/example/Example.xml
index 9a20bdd..e8278cd 100644
--- a/example/Example.xml
+++ b/example/Example.xml
@@ -21,10 +21,10 @@
 		<!-- Option version greift auf die interne Klassenexterne (abstrakte) Methode printVersion zu. Ein gleichzeitiger Aufruf mit helpund toString-only  ist nicht erlaubt. -->
 		<Option Ref="2" ShortOpt="v" Interface="Version" Exclusion="1,3" ConnectToInternalMethod="printVersion" Description="Gibt die Version des Programms aus und beendet" /> 
 		<!-- Option out-path braucht ein zusätzliches Argument und schreibt auf einen Klassenintern generierten String das Argument. Die Option help, version und toString-only  darf nicht angegeben sein -->
-		<Option LongOpt="out-path" HasArguments="Required" Exclusion="1,2,3" Interface="OutputPath" Description="Der Pfad wo das Ergebnis hingenriert werden soll (sonst ins aktuelle Verzeichnis)" />
+		<Option LongOpt="out-path" HasArguments="Required" Exclusion="1,2,3" Interface="OutputPath" Description="Der Pfad wo das Ergebnis hingeneriert werden soll (sonst ins aktuelle Verzeichnis)" />
 		<Option LongOpt="astyle-path" HasArguments="Required" Interface="AstylePath" Exclusion="1,2,3" Description="Der Pfad wo die Astyle executable gefunden werden kann" />
 		<!-- Option sign-per-line kann ein zusätzliches Argument übergeben werden und schreibt auf einen Klassenintern generierten Integer SignPerLine. Wenn kein Parameter übergeben wird ist der Defaultwert 79. Die Option help, version und toString-only darf nicht angegeben sein -->
-		<Option LongOpt="sign-per-line" HasArguments="optional" Interface="SignPerLine" Exclusion="1,2,3" ConvertTo="Integer" DefaultValue="79" Description="Die Anzahl der Zeichen pro Linie für den Helptext. Ohne Argument wird der Standartwert genommen." />
+		<Option LongOpt="sign-per-line" HasArguments="optional" Interface="SignPerLine" Exclusion="1,2,3" ConvertTo="Integer" DefaultValue="79" Description="Die Anzahl der Zeichen pro Linie fuer den Helptext. Ohne Argument wird der Standartwert genommen." />
 		<Option ShortOpt="n" LongOpt="only-if-newer" Interface="OnlyIfNewer" Exclusion="1,2,3" Description="Generiert nur wenn die Eingangsdatei neuer ist wie die bereits generierte" />
 		<Option LongOpt="no-format" Interface="NoFormat" Exclusion="1,2,3" Description="Erzeugte Datei wird nicht formatiert" />
 		<!-- Option toString-only liesst ein zusätzliches Argument ein und ruft die interne Klassenexterne (abstrakte) Methode ParseXML auf. Die Option help, version darf nicht angegeben sein -->
diff --git a/src/CodeGenerator.cpp b/src/CodeGenerator.cpp
index d57370f..968e0ee 100644
--- a/src/CodeGenerator.cpp
+++ b/src/CodeGenerator.cpp
@@ -1,18 +1,66 @@
 /*
- * Editors: Tobias Goetz
+ * Editors: Tobias Goetz, Noel Kempter
  */
 
 #include "CodeGenerator.h"
 #include "XMLParser.h"
 #include "SourceCodeWriter.h"
-#include <iostream>
+#include <getopt.h>
 
-int main() {
+void CodeGenerator::setFilePath(const std::string &filename) {
+    CodeGenerator::filePath = filename;
+}
+
+std::string CodeGenerator::getFilePath() {
+    return CodeGenerator::filePath;
+}
+
+void CodeGenerator::run() {
     printf("Starting Codegenerator!\n");
-    XMLParser parser("example/Example.xml");
+    if(getFilePath().empty()){
+        perror("The path to the XML-File must be set.");
+        exit(EXIT_FAILURE);
+    }
+
+    XMLParser parser(getFilePath());
     parser.parse();
     SourceCodeWriter writer = SourceCodeWriter(parser.getGetOptSetup());
     writer.writeFile();
     printf("Codegenerator finished!\n");
+}
+
+
+int main(int argc, char **argv) {
+    CodeGenerator generator;
+    int c;
+    int option_index;
+    static struct option long_options[] = {
+            {"path", required_argument, 0, 'p'},
+            {0, 0, 0, 0}
+    };
+
+    while((c = getopt_long(argc, argv, "p:", long_options, &option_index)) != -1 ){
+        switch(c){
+            case 'p':
+                if (optarg == nullptr){
+                    perror("The path to the XML-File to be parsed was not set.");
+                    exit(EXIT_FAILURE);
+                }
+                generator.setFilePath(optarg);
+                break;
+            case '?':
+            default:
+                perror("GetOpt encountered an unknown option.");
+                exit(EXIT_FAILURE);
+        }
+    }
+    if (optind < argc) {
+        printf("non-option ARGV-elements: ");
+        while (optind < argc)
+            printf("%s ", argv[optind++]);
+        printf("\n");
+    }
+
+    generator.run();
     return 0;
-}
\ No newline at end of file
+}
diff --git a/src/CodeGenerator.h b/src/CodeGenerator.h
index 6ad1fab..9fa893c 100644
--- a/src/CodeGenerator.h
+++ b/src/CodeGenerator.h
@@ -5,10 +5,40 @@
 #ifndef PROGRAMMING_C_CODEGENERATOR_H
 #define PROGRAMMING_C_CODEGENERATOR_H
 
+#include <string>
+
 /**
  * @brief Class for the CodeGenerator
  */
-class CodeGenerator{
+class CodeGenerator {
+private:
+    /**
+     * @brief String containing path to the file
+     */
+    std::string filePath;
+
+public:
+    /**
+     * @brief Constructor
+     */
+    CodeGenerator() = default;
+
+    /**
+     * @brief Set the path to the file
+     * @param filename
+     */
+    void setFilePath(const std::string &filename);
+
+    /**
+     * @brief Get the path to the file
+     * @return
+     */
+    std::string getFilePath();
+
+    /**
+     * @brief Runs the CodeGenerator
+     */
+    void run();
 };
 
 

From 5d1062188a7b4f652e0f916e5b147197462681cb Mon Sep 17 00:00:00 2001
From: philippkuest <100705472+philippkuest@users.noreply.github.com>
Date: Sun, 24 Jul 2022 12:59:16 +0000
Subject: [PATCH 08/11] added sample usage (#141)

---
 src3/exampleProgram.xml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src3/exampleProgram.xml b/src3/exampleProgram.xml
index a628a2d..338df73 100644
--- a/src3/exampleProgram.xml
+++ b/src3/exampleProgram.xml
@@ -10,7 +10,9 @@
         <Block>Dies geschieht in der Kommandozeile.</Block>
     </OverAllDescription>
     <SampleUsage>
-        <Sample>getoptgen -h</Sample>
+        <Sample>ExampleProgram -h</Sample>
+        <Sample>ExampleProgram --optional=23</Sample>
+        <Sample>ExampleProgram --arguments=45</Sample>
     </SampleUsage>
     <Options>
         <!-- ReqFunc51 -->

From 6003062c5beca4d479d971595c8ad939aade3912 Mon Sep 17 00:00:00 2001
From: philippkuest <100705472+philippkuest@users.noreply.github.com>
Date: Sun, 24 Jul 2022 13:50:06 +0000
Subject: [PATCH 09/11] Changed directories (#144)

* Changed directories

* Changed directories
---
 CMakeLists.txt                             |   6 -
 example/Example.xml                        |  33 -----
 {src => include}/CodeGenerator.h           |   0
 {src => include}/HelpText.h                |   0
 {src => include}/Justify.h                 |   0
 {src => include}/SourceCodeWriter.h        |   0
 {src => include}/StateMachine.h            |   0
 {src => include}/XMLParser.h               |   0
 {src => include}/models/Author.h           |   0
 {src => include}/models/GetOptSetup.h      |   0
 {src => include}/models/Option.h           |   0
 {src3 => include2}/ExampleProgram.h        |   0
 {src3 => include2}/ExtendedGeneratedCode.h |   0
 src/models/Author.cpp                      |   2 +-
 src/models/GetOptSetup.cpp                 |   2 +-
 src/models/Option.cpp                      |   2 +-
 src2/COptionParser.cpp                     | 136 ---------------------
 src2/COptionParser.h                       |  52 --------
 {src3 => src2}/ExampleProgram.cpp          |   4 +-
 {src3 => src2}/ExtendedGeneratedCode.cpp   |   2 +-
 {src3 => src2}/exampleProgram.xml          |   0
 21 files changed, 6 insertions(+), 233 deletions(-)
 delete mode 100644 example/Example.xml
 rename {src => include}/CodeGenerator.h (100%)
 rename {src => include}/HelpText.h (100%)
 rename {src => include}/Justify.h (100%)
 rename {src => include}/SourceCodeWriter.h (100%)
 rename {src => include}/StateMachine.h (100%)
 rename {src => include}/XMLParser.h (100%)
 rename {src => include}/models/Author.h (100%)
 rename {src => include}/models/GetOptSetup.h (100%)
 rename {src => include}/models/Option.h (100%)
 rename {src3 => include2}/ExampleProgram.h (100%)
 rename {src3 => include2}/ExtendedGeneratedCode.h (100%)
 delete mode 100644 src2/COptionParser.cpp
 delete mode 100644 src2/COptionParser.h
 rename {src3 => src2}/ExampleProgram.cpp (97%)
 rename {src3 => src2}/ExtendedGeneratedCode.cpp (73%)
 rename {src3 => src2}/exampleProgram.xml (100%)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 4ca7f5c..5785da8 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -12,12 +12,6 @@ add_executable(
 )
 
 file(GLOB Source_Files2 src2/*.cpp)
-add_executable(
-        COptionParser
-        ${Source_Files2}
-)
-
-file(GLOB Source_Files2 src3/*.cpp)
 add_executable(
         ExampleProgram
         ${Source_Files2}
diff --git a/example/Example.xml b/example/Example.xml
deleted file mode 100644
index e8278cd..0000000
--- a/example/Example.xml
+++ /dev/null
@@ -1,33 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<GetOptSetup SignPerLine="79">
-	<Author Name="Thomas Staudacher, Andreas Maus" Phone="07541-77-961003" Mail="thomas.staudacher@zf.com, andreas.maus@zf.com" />
-	<HeaderFileName>options.h</HeaderFileName>
-	<SourceFileName>options.cpp</SourceFileName>
-	<NameSpace>DHBW</NameSpace>
-	<ClassName>COptionParser</ClassName>
-	<OverAllDescription>
-		<Block>Erstellt einen Rumpf zum einlesen von Argumente aus der Kommandozeile.</Block>
-		<Block>Es kann sowohl mit innenliegenden Container wie externer Klassenanbindung eine Datenhaltung erfolgen.</Block>
-		<Block>Sobald ein Methodenaufruf abstrakt ist, wird die Basisklasse abstrakt.</Block>
-		<Block>Fuer die Formatierung der generierten Dateien wird astyle verwendet.</Block>
-	</OverAllDescription>
-	<SampleUsage>
-		<Sample>getoptgen [options] ... QUELLE</Sample>
-		<Sample>getoptgen [--out-path] ... QUELLE</Sample>
-	</SampleUsage>
-	<Options>
-		<!-- Option help greift auf die interne Klasseninterne Methode printHelp zu. Ein gleichzeitiger Aufruf mit version und toString-only ist nicht erlaubt.  -->
-		<Option Ref="1" ShortOpt="h" LongOpt="help" Exclusion="2,3" ConnectToInternalMethod="printHelp" Description="Diese Hilfe ausgeben und beenden" /> 
-		<!-- Option version greift auf die interne Klassenexterne (abstrakte) Methode printVersion zu. Ein gleichzeitiger Aufruf mit helpund toString-only  ist nicht erlaubt. -->
-		<Option Ref="2" ShortOpt="v" Interface="Version" Exclusion="1,3" ConnectToInternalMethod="printVersion" Description="Gibt die Version des Programms aus und beendet" /> 
-		<!-- Option out-path braucht ein zusätzliches Argument und schreibt auf einen Klassenintern generierten String das Argument. Die Option help, version und toString-only  darf nicht angegeben sein -->
-		<Option LongOpt="out-path" HasArguments="Required" Exclusion="1,2,3" Interface="OutputPath" Description="Der Pfad wo das Ergebnis hingeneriert werden soll (sonst ins aktuelle Verzeichnis)" />
-		<Option LongOpt="astyle-path" HasArguments="Required" Interface="AstylePath" Exclusion="1,2,3" Description="Der Pfad wo die Astyle executable gefunden werden kann" />
-		<!-- Option sign-per-line kann ein zusätzliches Argument übergeben werden und schreibt auf einen Klassenintern generierten Integer SignPerLine. Wenn kein Parameter übergeben wird ist der Defaultwert 79. Die Option help, version und toString-only darf nicht angegeben sein -->
-		<Option LongOpt="sign-per-line" HasArguments="optional" Interface="SignPerLine" Exclusion="1,2,3" ConvertTo="Integer" DefaultValue="79" Description="Die Anzahl der Zeichen pro Linie fuer den Helptext. Ohne Argument wird der Standartwert genommen." />
-		<Option ShortOpt="n" LongOpt="only-if-newer" Interface="OnlyIfNewer" Exclusion="1,2,3" Description="Generiert nur wenn die Eingangsdatei neuer ist wie die bereits generierte" />
-		<Option LongOpt="no-format" Interface="NoFormat" Exclusion="1,2,3" Description="Erzeugte Datei wird nicht formatiert" />
-		<!-- Option toString-only liesst ein zusätzliches Argument ein und ruft die interne Klassenexterne (abstrakte) Methode ParseXML auf. Die Option help, version darf nicht angegeben sein -->
-		<Option Ref="3" LongOpt="toString-only" HasArguments="Required" ConnectToInternalMethod="ParseXML" Exclusion="1,2" Description="Parst die Datei einmal und beendet das Programm" />
-	</Options>
-</GetOptSetup>
diff --git a/src/CodeGenerator.h b/include/CodeGenerator.h
similarity index 100%
rename from src/CodeGenerator.h
rename to include/CodeGenerator.h
diff --git a/src/HelpText.h b/include/HelpText.h
similarity index 100%
rename from src/HelpText.h
rename to include/HelpText.h
diff --git a/src/Justify.h b/include/Justify.h
similarity index 100%
rename from src/Justify.h
rename to include/Justify.h
diff --git a/src/SourceCodeWriter.h b/include/SourceCodeWriter.h
similarity index 100%
rename from src/SourceCodeWriter.h
rename to include/SourceCodeWriter.h
diff --git a/src/StateMachine.h b/include/StateMachine.h
similarity index 100%
rename from src/StateMachine.h
rename to include/StateMachine.h
diff --git a/src/XMLParser.h b/include/XMLParser.h
similarity index 100%
rename from src/XMLParser.h
rename to include/XMLParser.h
diff --git a/src/models/Author.h b/include/models/Author.h
similarity index 100%
rename from src/models/Author.h
rename to include/models/Author.h
diff --git a/src/models/GetOptSetup.h b/include/models/GetOptSetup.h
similarity index 100%
rename from src/models/GetOptSetup.h
rename to include/models/GetOptSetup.h
diff --git a/src/models/Option.h b/include/models/Option.h
similarity index 100%
rename from src/models/Option.h
rename to include/models/Option.h
diff --git a/src3/ExampleProgram.h b/include2/ExampleProgram.h
similarity index 100%
rename from src3/ExampleProgram.h
rename to include2/ExampleProgram.h
diff --git a/src3/ExtendedGeneratedCode.h b/include2/ExtendedGeneratedCode.h
similarity index 100%
rename from src3/ExtendedGeneratedCode.h
rename to include2/ExtendedGeneratedCode.h
diff --git a/src/models/Author.cpp b/src/models/Author.cpp
index f71b0f1..8f638d8 100644
--- a/src/models/Author.cpp
+++ b/src/models/Author.cpp
@@ -3,7 +3,7 @@
  */
 
 #include <xercesc/util/XMLString.hpp>
-#include "Author.h"
+#include "models/Author.h"
 
 //Constructor
 Author::Author() = default;
diff --git a/src/models/GetOptSetup.cpp b/src/models/GetOptSetup.cpp
index 403b453..98a0deb 100644
--- a/src/models/GetOptSetup.cpp
+++ b/src/models/GetOptSetup.cpp
@@ -4,7 +4,7 @@
 
 #include <xercesc/util/XMLString.hpp>
 #include <boost/lexical_cast.hpp>
-#include "GetOptSetup.h"
+#include "models/GetOptSetup.h"
 
 // Constructors
 GetOptSetup::GetOptSetup() = default;
diff --git a/src/models/Option.cpp b/src/models/Option.cpp
index de3f27b..16a12f2 100644
--- a/src/models/Option.cpp
+++ b/src/models/Option.cpp
@@ -2,7 +2,7 @@
  * Editors: Tobias Goetz
  */
 
-#include "Option.h"
+#include "models/Option.h"
 #include <boost/lexical_cast.hpp>
 #include <vector>
 #include <boost/algorithm/string.hpp>
diff --git a/src2/COptionParser.cpp b/src2/COptionParser.cpp
deleted file mode 100644
index a401ecf..0000000
--- a/src2/COptionParser.cpp
+++ /dev/null
@@ -1,136 +0,0 @@
-/*
- * Editors: Tobias Goetz, Noel Kempter, Philipp Kuest, Sebastian Wolf
- */
-
-#include "COptionParser.h"
-#include <cstring>
-#include <boost/lexical_cast.hpp>
-
-namespace DHBW {
-    // Getter
-    std::string COptionParser::getValueOfOutputPath() const {
-        return outputPathValue;
-    }
-
-    bool COptionParser::isSetOutputPath() const {
-        return args.outputPath.isSet;
-    }
-
-    void COptionParser::parse() {
-        // Check if getopt was set and execute functions if no exclusion
-        if (args.help.isSet) {
-            if (args.version.isSet) {
-                perror ("--help and --version cannot be used together.");
-                exit(1);
-            }
-
-            // More exclusions here in other if statements
-        }
-
-        if (args.version.isSet) {
-            if (args.help.isSet) {
-                perror ("--version and --help cannot be used together.");
-                exit(1);
-            }
-
-            // More exclusions here in other if statements
-        }
-
-        if (args.outputPath.isSet) {
-            // More exclusions here in other if statements
-        }
-
-        // Run code here
-        if (args.help.isSet) {
-            printHelp();
-        }
-
-        if (args.version.isSet) {
-            printVersion();
-        }
-
-        if (args.outputPath.isSet) {
-            // Set values of argument optional or required and param not empty
-            outputPathValue = boost::lexical_cast<typeof outputPathValue>(args.outputPath.value);
-            // Interface doesn't need function call
-        }
-    }
-
-    void COptionParser::printHelp() {
-        printf("Executed printHelp()\n");
-    }
-
-    void COptionParser::printVersion() {
-        printf("Executed printVersion()\n");
-    }
-
-    void COptionParser::parseOptions(int argc, char **argv) {
-        args = Args();
-
-        int digit_optind = 0;
-
-        while (true) {
-            int c;
-
-            int this_option_optind = optind ? optind : 1;
-            int option_index = 0;
-            static struct option long_options[] = {
-                    {"help",     no_argument, 0,  0 },
-                    {"version",  no_argument, 0,  0 },
-                    {"out-path",  required_argument, 0, 0 },
-                    {0, 0, 0, 0}
-            };
-
-            c = getopt_long(argc, argv, "hv", long_options, &option_index);
-            if (c == -1) {
-                break;
-            }
-
-            switch (c) {
-                case 0:
-                    // LongOpts
-                    if (strcmp("help", long_options[option_index].name) == 0) {
-                        args.help.isSet = true;
-                    }
-                    if (strcmp("version", long_options[option_index].name) == 0) {
-                        args.version.isSet = true;
-                    }
-                    if (strcmp("out-path", long_options[option_index].name) == 0) {
-                        args.outputPath.isSet = true;
-                        // Only add value if Arguments is Required or Optional
-                        args.outputPath.value = optarg;
-                    }
-                    break;
-
-                    // ShortOpts
-                case 'h':
-                    args.help.isSet = true;
-                    break;
-
-                case 'v':
-                    args.version.isSet = true;
-                    break;
-
-                default:
-                    printf("?? getopt returned character code 0%o ??\n", c);
-            }
-        }
-
-        if (optind < argc) {
-            printf("non-option ARGV-elements: ");
-            while (optind < argc)
-                printf("%s ", argv[optind++]);
-            printf("\n");
-        }
-
-        // Parse the arguments
-        parse();
-
-        exit(EXIT_SUCCESS);
-    }
-}
-
-int main(int argc, char* argv[]) {
-    DHBW::COptionParser parser;
-    parser.parseOptions(argc, argv);
-}
\ No newline at end of file
diff --git a/src2/COptionParser.h b/src2/COptionParser.h
deleted file mode 100644
index eb46d8a..0000000
--- a/src2/COptionParser.h
+++ /dev/null
@@ -1,52 +0,0 @@
-/*
- * Editors: Tobias Goetz, Noel Kempter, Philipp Kuest, Sebastian Wolf
- */
-
-#ifndef CODEGENERATOR_COPTIONPARSER_H
-#define CODEGENERATOR_COPTIONPARSER_H
-
-#include <getopt.h>
-#include <string>
-#include <cstdio>     /* for printf */
-#include <cstdlib>    /* for exit */
-
-struct Args {
-    struct {
-        bool isSet = false;
-    } help;
-
-    struct {
-        bool isSet = false;
-    } version;
-
-    // Important: Name priority Interface > LongOpt > ShortOpt and remove the "-" from the name
-    struct {
-        bool isSet = false;
-        // Only add value if Arguments is Required or Optional
-        std::string value;
-    } outputPath;
-};
-
-namespace DHBW {
-
-    class COptionParser {
-    private:
-        Args args;
-
-        std::string outputPathValue;
-    protected:
-        virtual void printHelp();
-        virtual void printVersion();
-    public:
-        void parse();
-
-        // Getter
-        std::string getValueOfOutputPath() const;
-        bool isSetOutputPath() const;
-
-        // Helper
-        void parseOptions(int argc, char* argv[]);
-    };
-}
-
-#endif //CODEGENERATOR_COPTIONPARSER_H
diff --git a/src3/ExampleProgram.cpp b/src2/ExampleProgram.cpp
similarity index 97%
rename from src3/ExampleProgram.cpp
rename to src2/ExampleProgram.cpp
index 49c1b76..d989e51 100644
--- a/src3/ExampleProgram.cpp
+++ b/src2/ExampleProgram.cpp
@@ -2,8 +2,8 @@
  * Editors: Philipp Kuest, Tobias Goetz
  */
 
-#include "ExampleProgram.h"
-#include "generatedCode.h"
+#include "../include2/ExampleProgram.h"
+#include "../include2/generatedCode.h"
 
 ExampleProgram::ExampleProgram(GC::GeneratedClass *generatedClass) {
     this->generatedClass = generatedClass;
diff --git a/src3/ExtendedGeneratedCode.cpp b/src2/ExtendedGeneratedCode.cpp
similarity index 73%
rename from src3/ExtendedGeneratedCode.cpp
rename to src2/ExtendedGeneratedCode.cpp
index 4f96fb8..975ef17 100644
--- a/src3/ExtendedGeneratedCode.cpp
+++ b/src2/ExtendedGeneratedCode.cpp
@@ -2,7 +2,7 @@
  * Editors: Philipp Kuest, Tobias Goetz
  */
 
-#include "ExtendedGeneratedCode.h"
+#include "../include2/ExtendedGeneratedCode.h"
 
 void ExtendedGeneratedCode::printVersion() {
     printf("Version: 2.0.0\n");
diff --git a/src3/exampleProgram.xml b/src2/exampleProgram.xml
similarity index 100%
rename from src3/exampleProgram.xml
rename to src2/exampleProgram.xml

From 10653083e81302715be811a714d8a6117beedcbc Mon Sep 17 00:00:00 2001
From: NoelKempter <98758634+NoelKempter@users.noreply.github.com>
Date: Sun, 24 Jul 2022 16:56:50 +0200
Subject: [PATCH 10/11] Feature/i145 add possibility to modify output target
 directory (#146)

* Added logic for output dir to CodeGenerator.cpp

* Added ability to change target directory using getopt

* Fixed getopt error handling

Co-authored-by: Tobias Goetz <tobigoetz98@gmail.com>
Co-authored-by: noel.kempter <noel.kempter@INPC-1093>
---
 include/CodeGenerator.h    | 23 ++++++++++++++++++++---
 include/SourceCodeWriter.h | 11 +++++++++--
 src/CodeGenerator.cpp      | 24 +++++++++++++++++++++---
 src/SourceCodeWriter.cpp   | 12 ++++++++++--
 4 files changed, 60 insertions(+), 10 deletions(-)

diff --git a/include/CodeGenerator.h b/include/CodeGenerator.h
index 9fa893c..37f3a41 100644
--- a/include/CodeGenerator.h
+++ b/include/CodeGenerator.h
@@ -17,12 +17,29 @@ class CodeGenerator {
      */
     std::string filePath;
 
+    /**
+     * @brief Output directory
+     */
+    std::string outputDir;
+
 public:
     /**
      * @brief Constructor
      */
     CodeGenerator() = default;
 
+    /**
+     * @brief Get the path to the file
+     * @return
+     */
+    std::string getFilePath();
+
+    /**
+     * Get the output directory
+     * @return the out directory as string
+     */
+    std::string getOutputDir();
+
     /**
      * @brief Set the path to the file
      * @param filename
@@ -30,10 +47,10 @@ class CodeGenerator {
     void setFilePath(const std::string &filename);
 
     /**
-     * @brief Get the path to the file
-     * @return
+     * @brief Set the output directory
+     * @param dir
      */
-    std::string getFilePath();
+    void setOutputDir(const std::string &dir);
 
     /**
      * @brief Runs the CodeGenerator
diff --git a/include/SourceCodeWriter.h b/include/SourceCodeWriter.h
index 5432a20..5bba049 100644
--- a/include/SourceCodeWriter.h
+++ b/include/SourceCodeWriter.h
@@ -26,6 +26,11 @@ class SourceCodeWriter {
      */
     FILE *sourceFile = nullptr;
 
+    /**
+     * @brief Output directory
+     */
+    std::string outputDir;
+
     // Helpers
     /**
      * @brief Get the type of the option depending on ConvertTo
@@ -169,14 +174,16 @@ class SourceCodeWriter {
     GetOptSetup *getGetOptSetup() const;
     FILE *getHeaderFile();
     FILE *getSourceFile();
+    std::string getOutputDir();
     ///@}
 
-    /** @name Getter
-    * @brief  Getter for the class
+    /** @name Setter
+    * @brief  Setter for the class
     */
     ///@{
     void setHeaderFile(FILE *headerFile);
     void setSourceFile(FILE *sourceFile);
+    void setOutputDir(const std::string &dir);
     ///@}
 
     // Methods
diff --git a/src/CodeGenerator.cpp b/src/CodeGenerator.cpp
index 968e0ee..ae07ee4 100644
--- a/src/CodeGenerator.cpp
+++ b/src/CodeGenerator.cpp
@@ -7,12 +7,20 @@
 #include "SourceCodeWriter.h"
 #include <getopt.h>
 
+std::string CodeGenerator::getFilePath() {
+    return CodeGenerator::filePath;
+}
+
+std::string CodeGenerator::getOutputDir() {
+    return outputDir;
+}
+
 void CodeGenerator::setFilePath(const std::string &filename) {
     CodeGenerator::filePath = filename;
 }
 
-std::string CodeGenerator::getFilePath() {
-    return CodeGenerator::filePath;
+void CodeGenerator::setOutputDir(const std::string &dir) {
+    outputDir = dir;
 }
 
 void CodeGenerator::run() {
@@ -24,7 +32,9 @@ void CodeGenerator::run() {
 
     XMLParser parser(getFilePath());
     parser.parse();
+
     SourceCodeWriter writer = SourceCodeWriter(parser.getGetOptSetup());
+    writer.setOutputDir(getOutputDir());
     writer.writeFile();
     printf("Codegenerator finished!\n");
 }
@@ -36,10 +46,11 @@ int main(int argc, char **argv) {
     int option_index;
     static struct option long_options[] = {
             {"path", required_argument, 0, 'p'},
+            {"output", required_argument, 0, 'o'},
             {0, 0, 0, 0}
     };
 
-    while((c = getopt_long(argc, argv, "p:", long_options, &option_index)) != -1 ){
+    while((c = getopt_long(argc, argv, "p:o:", long_options, &option_index)) != -1 ){
         switch(c){
             case 'p':
                 if (optarg == nullptr){
@@ -48,6 +59,13 @@ int main(int argc, char **argv) {
                 }
                 generator.setFilePath(optarg);
                 break;
+            case 'o':
+                if(optarg == nullptr){
+                    perror("When using \"-o/--output\" the path to the target directory must be set.");
+                    exit(EXIT_FAILURE);
+                }
+                    generator.setOutputDir(optarg);
+                break;
             case '?':
             default:
                 perror("GetOpt encountered an unknown option.");
diff --git a/src/SourceCodeWriter.cpp b/src/SourceCodeWriter.cpp
index 458906c..e77d4d1 100644
--- a/src/SourceCodeWriter.cpp
+++ b/src/SourceCodeWriter.cpp
@@ -32,18 +32,22 @@ SourceCodeWriter::~SourceCodeWriter() {
 // Getter
 FILE *SourceCodeWriter::getHeaderFile() {
     if (headerFile == nullptr) {
-        setHeaderFile(fopen(getGetOptSetup()->getHeaderFileName().c_str(), "w"));
+        setHeaderFile(fopen((getOutputDir() + getGetOptSetup()->getHeaderFileName()).c_str(), "w"));
     }
     return headerFile;
 }
 
 FILE *SourceCodeWriter::getSourceFile() {
     if (sourceFile == nullptr) {
-        setSourceFile(fopen(getGetOptSetup()->getSourceFileName().c_str(), "w"));
+        setSourceFile(fopen((getOutputDir() + getGetOptSetup()->getSourceFileName()).c_str(), "w"));
     }
     return sourceFile;
 }
 
+std::string SourceCodeWriter::getOutputDir() {
+    return outputDir;
+}
+
 GetOptSetup *SourceCodeWriter::getGetOptSetup() const {
     return getOptSetup;
 }
@@ -57,6 +61,10 @@ void SourceCodeWriter::setSourceFile(FILE *_sourceFile) {
     this->sourceFile = _sourceFile;
 }
 
+void SourceCodeWriter::setOutputDir(const std::string &dir) {
+    outputDir = dir;
+}
+
 /*
  * ALL HELPER FUNCTIONS HERE!!!
  */

From ef212f6d1c14a3b1284fc5a75327504e1af5a002 Mon Sep 17 00:00:00 2001
From: Tobias Goetz <tobigoetz98@gmail.com>
Date: Sun, 24 Jul 2022 19:13:29 +0200
Subject: [PATCH 11/11] Feature/i90 add boost logging (#147)

* added log and log_setup to CMakeLists.txt
and basic logging example in CodeGenerator.cpp

* Example with line number and file name

* example with global logger

* test

* Reworked logger

* Added info logging

* Changed log location

* Added logging to StateMachine.cpp

* Added more logging

* Fixed doxygen folders

* Added logging to perror

* Added logging to perror

* Added Error logging in CodeGenerator.cpp and Option.cpp

* Added editors to logger

* added justify class source url

Co-authored-by: swolf2211 <sebastianwolf1996@gmx.de>
---
 CMakeLists.txt             |   2 +-
 config-file                |   2 +-
 include/Justify.h          |   1 +
 include/Logger.h           |  66 +++++++++++++++
 logconfig.ini              |  81 ++++++++++++++++++
 src/CodeGenerator.cpp      |  17 +++-
 src/HelpText.cpp           |  11 +++
 src/Justify.cpp            |   9 +-
 src/Logger.cpp             | 164 +++++++++++++++++++++++++++++++++++++
 src/SourceCodeWriter.cpp   |  51 +++++++++++-
 src/StateMachine.cpp       |  88 ++++++++++++++++++++
 src/XMLParser.cpp          |   7 ++
 src/models/Author.cpp      |   3 +
 src/models/GetOptSetup.cpp |   3 +
 src/models/Option.cpp      |   6 ++
 15 files changed, 503 insertions(+), 8 deletions(-)
 create mode 100644 include/Logger.h
 create mode 100644 logconfig.ini
 create mode 100644 src/Logger.cpp

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 5785da8..61d056e 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -19,7 +19,7 @@ add_executable(
 
 
 
-find_package (Boost REQUIRED)
+find_package (Boost COMPONENTS log log_setup REQUIRED)
 if(Boost_FOUND)
     include_directories(${Boost_INCLUDE_DIRS})
     target_link_libraries(CodeGenerator ${Boost_LIBRARIES})
diff --git a/config-file b/config-file
index 7723b87..d921596 100644
--- a/config-file
+++ b/config-file
@@ -815,7 +815,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ./src
+INPUT                  = ./src, ./include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
diff --git a/include/Justify.h b/include/Justify.h
index fd22950..a0f3608 100644
--- a/include/Justify.h
+++ b/include/Justify.h
@@ -14,6 +14,7 @@ using namespace boost;
 
 /**
  * @brief Class to justify a string
+ * Custom Justify class according to https://www.geeksforgeeks.org/justify-the-given-text-based-on-the-given-width-of-each-line/
  */
 class Justify
 {
diff --git a/include/Logger.h b/include/Logger.h
new file mode 100644
index 0000000..63f7dc9
--- /dev/null
+++ b/include/Logger.h
@@ -0,0 +1,66 @@
+/*
+ * Editors: Tobias Goetz, Sebastian Wolf
+ */
+
+#ifndef LOG_LOGGER_H
+#define LOG_LOGGER_H
+#pragma once
+
+#include <boost/log/trivial.hpp>
+#include <boost/log/sources/global_logger_storage.hpp>
+#include <boost/log/sources/severity_channel_logger.hpp>
+#include <boost/log/attributes/mutable_constant.hpp>
+#include <boost/log/utility/manipulators/add_value.hpp>
+#include <string>
+
+BOOST_LOG_GLOBAL_LOGGER(sysLogger,
+                        boost::log::sources::severity_channel_logger_mt<boost::log::trivial::severity_level>);
+BOOST_LOG_GLOBAL_LOGGER(dataLogger,
+                        boost::log::sources::severity_channel_logger_mt<boost::log::trivial::severity_level>);
+
+/**
+ * @brief Custom logger class.
+ * Custom logger according to https://objectcomputing.com/resources/publications/sett/may-2016-boostlog-library
+ */
+class Logger {
+public:
+    /// Init with default trivial logging
+    static void init();
+
+    /// @param configFileName config ini file that contains boost logging properties.
+    ///        If configFileName.empty() then default initialization.
+    static void initFromConfig(const std::string& configFileName);
+
+    /// Disable logging
+    static void disable();
+
+    /// Add a file sink for LOG_DATA_* for >= INFO.
+    /// This file sink will be used along with any configured via Config in init().
+    static void addDataFileLog(const std::string& logFileName);
+};
+
+#define LOG_LOG_LOCATION(LOGGER, LEVEL, ARG)            \
+  BOOST_LOG_SEV(LOGGER, boost::log::trivial::LEVEL)     \
+    << boost::log::add_value("Line", __LINE__)          \
+    << boost::log::add_value("File", __FILE__)          \
+    << boost::log::add_value("Function", __FUNCTION__) << ARG;
+
+/// System Log macros.
+/// TRACE < DEBUG < INFO < WARN < ERROR < FATAL
+#define LOG_TRACE(ARG) LOG_LOG_LOCATION(sysLogger::get(), trace, ARG);
+#define LOG_DEBUG(ARG) LOG_LOG_LOCATION(sysLogger::get(), debug, ARG);
+#define LOG_INFO(ARG)  LOG_LOG_LOCATION(sysLogger::get(), info, ARG);
+#define LOG_WARN(ARG)  LOG_LOG_LOCATION(sysLogger::get(), warning, ARG);
+#define LOG_ERROR(ARG) LOG_LOG_LOCATION(sysLogger::get(), error, ARG);
+#define LOG_FATAL(ARG) LOG_LOG_LOCATION(sysLogger::get(), fatal, ARG);
+
+/// Data Log macros. Does not include LINE, FILE, FUNCTION.
+/// TRACE < DEBUG < INFO < WARN < ERROR < FATAL
+#define LOG_DATA_TRACE(ARG) BOOST_LOG_SEV(dataLogger::get(), boost::log::trivial::trace) << ARG
+#define LOG_DATA_DEBUG(ARG) BOOST_LOG_SEV(dataLogger::get(), boost::log::trivial::debug) << ARG
+#define LOG_DATA_INFO(ARG)  BOOST_LOG_SEV(dataLogger::get(), boost::log::trivial::info) << ARG
+#define LOG_DATA_WARN(ARG)  BOOST_LOG_SEV(dataLogger::get(), boost::log::trivial::warning) << ARG
+#define LOG_DATA_ERROR(ARG) BOOST_LOG_SEV(dataLogger::get(), boost::log::trivial::error) << ARG
+#define LOG_DATA_FATAL(ARG) BOOST_LOG_SEV(dataLogger::get(), boost::log::trivial::fatal) << ARG
+
+#endif /* LOG_LOGGER_H */
\ No newline at end of file
diff --git a/logconfig.ini b/logconfig.ini
new file mode 100644
index 0000000..2a1c3ca
--- /dev/null
+++ b/logconfig.ini
@@ -0,0 +1,81 @@
+#
+# See http://www.boost.org/doc/libs/1_60_0/libs/log/doc/html/log/detailed/utilities.html#log.detailed.utilities.setup.filter_formatter
+#
+# Many of the property values have to be in quotes, best to just use quotes for all of them.
+#
+# SYSLF is the System Log File for logging standard 'debug' type info.
+# DATALF is the Data log File for logging modification to business data.
+#
+[Core]
+# Set DisableLogging to true to disable all logging.
+DisableLogging="false"
+
+# SYSLF - system log
+[Sinks.SYSLF]
+Destination="TextFile"
+# If Asynchronous true then thread dedicated to writing to log, otherwise blocks main thread to write.
+Asynchronous="true"
+# If AutoFlush is true then non-buffered output
+AutoFlush="true"
+# Line Formats available: TimeStamp, Uptime, Severity, LineID (counter), ProcessID, ThreadID, Line, File, Function
+# TimeStamp and Uptime support boost date time format:
+#    http://www.boost.org/doc/libs/1_60_0/doc/html/date_time/date_time_io.html#date_time.format_flags
+Format="[%TimeStamp(format=\"%Y-%m-%d %H:%M:%S.%f\")%][%Uptime(format=\"%O:%M:%S.%f\")%][%Severity%] %File%(%Line%) %Function%: %Message%"
+# Target directory in which rotated files will be stored.
+Target="./logs"
+# FileName pattern to use. %N is a counter for files.
+FileName="app_syslog_%N.log"
+# RotationSize in bytes, File size, in bytes, upon which file rotation will be performed.
+# Time based rotation also available via RotationInterval and RotationTimePoint see boost log docs.
+RotationSize="10485760"
+# Matching used so that only files matching FileName pattern are deleted.
+ScanForFiles="Matching"
+# MaxSize - Total size of files in the target directory in bytes upon which the oldest file will be deleted.
+#MaxSize=100485760
+# MinFreeSpace - Minimum free space in the Target directory in bytes. Above this value oldest file is deleted.
+#MinFreeSpace=1485760
+# Specify level of log, options are: trace, debug, info, warning, error, fatal
+# Since Channel not part of filter all log output will be included.
+# If only SYSLF logging desired, change to: Filter="%Severity% >= trace & %Channel% matches \"SYSLF\""
+Filter="%Severity% >= trace"
+
+# DATALF - data log
+[Sinks.DATALF]
+Destination="TextFile"
+# If Asynchronous true then thread dedicated to writing to log, otherwise blocks main thread to write.
+Asynchronous="false"
+# If AutoFlush is true then non-buffered output
+AutoFlush="true"
+# Line Formats available: TimeStamp, Uptime, Severity, LineID (counter), ProcessID, ThreadID
+# TimeStamp and Uptime support boost date time format:
+#    http://www.boost.org/doc/libs/1_60_0/doc/html/date_time/date_time_io.html#date_time.format_flags
+Format="[%TimeStamp(format=\"%Y-%m-%d %H:%M:%S.%f\")%][%Uptime(format=\"%O:%M:%S.%f\")%][%Severity%] %Message%"
+# Target directory in which rotated files will be stored.
+Target="./logs"
+# FileName pattern to use. %N is a counter for files.
+FileName="app_datalog_%N.log"
+# RotationSize in bytes, File size, in bytes, upon which file rotation will be performed.
+# Time based rotation also available via RotationInterval and RotationTimePoint see boost log docs.
+RotationSize="10485760"
+# Matching used so that only files matching FileName pattern are deleted.
+ScanForFiles="Matching"
+# MaxSize - Total size of files in the target directory in bytes upon which the oldest file will be deleted.
+#MaxSize=100485760
+# MinFreeSpace - Minimum free space in the Target directory in bytes. Above this value oldest file is deleted.
+#MinFreeSpace=1485760
+# Specify level of log, options are: trace, debug, info, warning, error, fatal
+# Specify Channel otherwise all log output will be included.
+Filter="%Severity% >= trace & %Channel% matches \"DATALF\""
+
+# Console log, logs both DATALF and SYSLF
+[Sinks.Console]
+# Remove the following lines to disable console logging
+Destination="Console"
+# If AutoFlush is true then non-buffered output
+AutoFlush="true"
+# Line Formats available: TimeStamp, Uptime, Severity, LineID (counter), ProcessID, ThreadID
+# TimeStamp and Uptime support boost date time format:
+#    http://www.boost.org/doc/libs/1_60_0/doc/html/date_time/date_time_io.html#date_time.format_flags
+Format="[%TimeStamp(format=\"%Y-%m-%d %H:%M:%S.%f\")%][%Uptime(format=\"%O:%M:%S.%f\")%][%Severity%] - %Message%"
+# Specify level of log, options are: trace, debug, info, warning, error, fatal
+Filter="%Severity% >= info"
\ No newline at end of file
diff --git a/src/CodeGenerator.cpp b/src/CodeGenerator.cpp
index ae07ee4..3c2119a 100644
--- a/src/CodeGenerator.cpp
+++ b/src/CodeGenerator.cpp
@@ -1,10 +1,10 @@
 /*
  * Editors: Tobias Goetz, Noel Kempter
  */
-
 #include "CodeGenerator.h"
 #include "XMLParser.h"
 #include "SourceCodeWriter.h"
+#include "Logger.h"
 #include <getopt.h>
 
 std::string CodeGenerator::getFilePath() {
@@ -24,23 +24,31 @@ void CodeGenerator::setOutputDir(const std::string &dir) {
 }
 
 void CodeGenerator::run() {
-    printf("Starting Codegenerator!\n");
+    LOG_INFO("Starting CodeGenerator");
     if(getFilePath().empty()){
         perror("The path to the XML-File must be set.");
+        LOG_ERROR("The path to the XML-File must be set.");
         exit(EXIT_FAILURE);
     }
 
+    LOG_INFO("Starting XMLParser");
     XMLParser parser(getFilePath());
     parser.parse();
+    LOG_INFO("Finished XMLParser");
 
+    LOG_INFO("Starting SourceCodeWriter");
     SourceCodeWriter writer = SourceCodeWriter(parser.getGetOptSetup());
     writer.setOutputDir(getOutputDir());
     writer.writeFile();
-    printf("Codegenerator finished!\n");
+    LOG_INFO("Finished SourceCodeWriter");
+
+    LOG_INFO("Codegenerator finished!");
 }
 
 
 int main(int argc, char **argv) {
+    Logger::initFromConfig("logconfig.ini");
+
     CodeGenerator generator;
     int c;
     int option_index;
@@ -55,6 +63,7 @@ int main(int argc, char **argv) {
             case 'p':
                 if (optarg == nullptr){
                     perror("The path to the XML-File to be parsed was not set.");
+                    LOG_ERROR("The path to the XML-File to be parsed was not set.");
                     exit(EXIT_FAILURE);
                 }
                 generator.setFilePath(optarg);
@@ -62,6 +71,7 @@ int main(int argc, char **argv) {
             case 'o':
                 if(optarg == nullptr){
                     perror("When using \"-o/--output\" the path to the target directory must be set.");
+                    LOG_ERROR("When using \"-o/--output\" the path to the target directory must be set.");
                     exit(EXIT_FAILURE);
                 }
                     generator.setOutputDir(optarg);
@@ -69,6 +79,7 @@ int main(int argc, char **argv) {
             case '?':
             default:
                 perror("GetOpt encountered an unknown option.");
+                LOG_ERROR("GetOpt encountered an unknown option.");
                 exit(EXIT_FAILURE);
         }
     }
diff --git a/src/HelpText.cpp b/src/HelpText.cpp
index 7ac8f18..7b15811 100644
--- a/src/HelpText.cpp
+++ b/src/HelpText.cpp
@@ -3,6 +3,7 @@
  */
 
 #include "HelpText.h"
+#include "Logger.h"
 
 HelpText::HelpText(GetOptSetup *getOptSetup)
 {
@@ -132,25 +133,35 @@ void HelpText::parseAuthor()
 
 string HelpText::parseHelpMessage()
 {
+    LOG_TRACE("Starting to parse help message");
     // add function beginning to string
     printHelpText.append("void ");
     printHelpText.append(getOptSetup->getClassName());
     printHelpText.append("::printHelp(){puts(\"");
 
     // parse the description and add text to string
+    LOG_TRACE("Starting to parse description");
     parseDescription();
+    LOG_TRACE("Finished parsing description");
 
     // parse the option and add text to string
+    LOG_TRACE("Starting to parse option");
     parseOption();
+    LOG_TRACE("Finished parsing option");
 
     // parse the usage and add text to string
+    LOG_TRACE("Starting to parse usage");
     parseUsage();
+    LOG_TRACE("Finished parsing usage");
 
     // parse the author and add text to string
+    LOG_TRACE("Starting to parse author");
     parseAuthor();
+    LOG_TRACE("Finished parsing author");
 
     // add function ending to string
     printHelpText.append(R"(");})");
+    LOG_TRACE("Finished parsing help message");
 
     return printHelpText;
 }
diff --git a/src/Justify.cpp b/src/Justify.cpp
index e920364..5f5dd89 100644
--- a/src/Justify.cpp
+++ b/src/Justify.cpp
@@ -3,6 +3,7 @@
  */
 
 #include "Justify.h"
+#include "Logger.h"
 
 string Justify::JoinALineWithSpace(
         vector<string>& words,
@@ -211,19 +212,25 @@ string Justify::returnJustifiedText(vector<string>& result)
 
 string Justify::justifyTheText(const string& str, int L, bool isOption, int optionShift)
 {
+    LOG_TRACE("Starting Justify::justifyTheText");
 
     vector<string> words;
 
     // Inserting words from
     // given string
+    LOG_TRACE("Inserting words from given string");
     words = this->splitWords(str);
+    LOG_TRACE("Inserting words from given string done");
 
     // Function call to
     // justify the text
+    LOG_TRACE("Function call to justify the text");
     vector<string> result
             = this->JustifyText(words, L, isOption, optionShift);
-
+    LOG_TRACE("Function call to justify the text done");
     // Return the justified
     // text
+
+    LOG_TRACE("Returning the justified text");
     return returnJustifiedText(result);
 }
\ No newline at end of file
diff --git a/src/Logger.cpp b/src/Logger.cpp
new file mode 100644
index 0000000..4488f07
--- /dev/null
+++ b/src/Logger.cpp
@@ -0,0 +1,164 @@
+/*
+ * Editors: Tobias Goetz, Sebastian Wolf
+ */
+
+#include "Logger.h"
+
+#include <boost/algorithm/string/predicate.hpp>
+#include <boost/date_time/posix_time/posix_time.hpp>
+#include <boost/log/core.hpp>
+#include <boost/log/common.hpp>
+#include <boost/log/sinks.hpp>
+#include <boost/log/expressions.hpp>
+#include <boost/log/expressions/keyword.hpp>
+#include <boost/log/attributes.hpp>
+#include <boost/log/utility/exception_handler.hpp>
+#include <boost/log/utility/setup/console.hpp>
+#include <boost/log/utility/setup/common_attributes.hpp>
+#include <boost/log/utility/setup/filter_parser.hpp>
+#include <boost/log/utility/setup/formatter_parser.hpp>
+#include <boost/log/utility/setup/from_stream.hpp>
+#include <boost/log/utility/setup/settings.hpp>
+#include <boost/log/sinks/sync_frontend.hpp>
+#include <boost/log/sinks/text_ostream_backend.hpp>
+#include <boost/log/support/date_time.hpp>
+#include <boost/shared_ptr.hpp>
+#include <boost/make_shared.hpp>
+
+#include <fstream>
+#include <string>
+
+BOOST_LOG_GLOBAL_LOGGER_CTOR_ARGS(sysLogger,
+                                  boost::log::sources::severity_channel_logger_mt<boost::log::trivial::severity_level>,
+                                  (boost::log::keywords::channel = "SYSLF"));
+
+BOOST_LOG_GLOBAL_LOGGER_CTOR_ARGS(dataLogger,
+                                  boost::log::sources::severity_channel_logger_mt<boost::log::trivial::severity_level>,
+                                  (boost::log::keywords::channel = "DATALF"));
+
+// Custom formatter factory to add TimeStamp format support in config ini file.
+// Allows %TimeStamp(format=\"%Y.%m.%d %H:%M:%S.%f\")% to be used in ini config file for property Format.
+class TimeStampFormatterFactory :
+        public boost::log::basic_formatter_factory<char, boost::posix_time::ptime>
+{
+public:
+    formatter_type create_formatter(const boost::log::attribute_name& name, const args_map& args) {
+        args_map::const_iterator it = args.find("format");
+        if (it != args.end()) {
+            return boost::log::expressions::stream
+                    << boost::log::expressions::format_date_time<boost::posix_time::ptime>(
+                            boost::log::expressions::attr<boost::posix_time::ptime>(name), it->second);
+        } else {
+            return boost::log::expressions::stream
+                    << boost::log::expressions::attr<boost::posix_time::ptime>(name);
+        }
+    }
+};
+
+// Custom formatter factory to add Uptime format support in config ini file.
+// Allows %Uptime(format=\"%O:%M:%S.%f\")% to be used in ini config file for property Format.
+// boost::log::attributes::timer value type is boost::posix_time::time_duration
+class UptimeFormatterFactory :
+        public boost::log::basic_formatter_factory<char, boost::posix_time::time_duration>
+{
+public:
+    formatter_type create_formatter(const boost::log::attribute_name& name, const args_map& args)
+    {
+        args_map::const_iterator it = args.find("format");
+        if (it != args.end()) {
+            return boost::log::expressions::stream
+                    << boost::log::expressions::format_date_time<boost::posix_time::time_duration>(
+                            boost::log::expressions::attr<boost::posix_time::time_duration>(name), it->second);
+        } else {
+            return boost::log::expressions::stream
+                    << boost::log::expressions::attr<boost::posix_time::time_duration>(name);
+        }
+    }
+};
+
+void
+Logger::init() {
+    initFromConfig("");
+}
+
+void
+Logger::initFromConfig(const std::string& configFileName) {
+    // Disable all exceptions
+    boost::log::core::get()->set_exception_handler(boost::log::make_exception_suppressor());
+
+    // Add common attributes: LineID, TimeStamp, ProcessID, ThreadID
+    boost::log::add_common_attributes();
+    // Add boost log timer as global attribute Uptime
+    boost::log::core::get()->add_global_attribute("Uptime", boost::log::attributes::timer());
+    // Allows %Severity% to be used in ini config file for property Filter.
+    boost::log::register_simple_filter_factory<boost::log::trivial::severity_level, char>("Severity");
+    // Allows %Severity% to be used in ini config file for property Format.
+    boost::log::register_simple_formatter_factory<boost::log::trivial::severity_level, char>("Severity");
+    // Allows %TimeStamp(format=\"%Y.%m.%d %H:%M:%S.%f\")% to be used in ini config file for property Format.
+    boost::log::register_formatter_factory("TimeStamp", boost::make_shared<TimeStampFormatterFactory>());
+    // Allows %Uptime(format=\"%O:%M:%S.%f\")% to be used in ini config file for property Format.
+    boost::log::register_formatter_factory("Uptime", boost::make_shared<UptimeFormatterFactory>());
+
+    if (configFileName.empty()) {
+        // Make sure we log to console if nothing specified.
+        // Severity logger logs to console by default.
+    } else {
+        std::ifstream ifs(configFileName);
+        if (!ifs.is_open()) {
+            // We can log this because console is setup by default
+            LOG_WARN("Unable to open logging config file: " << configFileName);
+        } else {
+            try {
+                // Still can throw even with the exception suppressor above.
+                boost::log::init_from_stream(ifs);
+            } catch (std::exception &e) {
+                std::string err = "Caught exception initializing boost logging: ";
+                err += e.what();
+                // Since we cannot be sure of boost log state, output to cerr and cout.
+                std::cerr << "ERROR: " << err << std::endl;
+                std::cout << "ERROR: " << err << std::endl;
+                LOG_ERROR(err);
+            }
+        }
+    }
+
+    // Indicate start of logging
+    LOG_INFO("Log Start");
+}
+
+void
+Logger::disable() {
+    boost::log::core::get()->set_logging_enabled(false);
+}
+
+
+void
+Logger::addDataFileLog(const std::string& logFileName) {
+    // Create a text file sink
+    boost::shared_ptr<boost::log::sinks::text_ostream_backend> backend(
+            new boost::log::sinks::text_ostream_backend());
+    backend->add_stream(boost::shared_ptr<std::ostream>(new std::ofstream(logFileName)));
+
+    // Flush after each log record
+    backend->auto_flush(true);
+
+    // Create a sink for the backend
+    typedef boost::log::sinks::synchronous_sink<boost::log::sinks::text_ostream_backend> sink_t;
+    boost::shared_ptr<sink_t> sink(new sink_t(backend));
+
+    // The log output formatter
+    sink->set_formatter(
+            boost::log::expressions::format("[%1%][%2%] %3%")
+            % boost::log::expressions::attr<boost::posix_time::ptime>("TimeStamp")
+            % boost::log::trivial::severity
+            % boost::log::expressions::smessage
+    );
+
+    // Filter by severity and by DATALF channel
+    sink->set_filter(
+            boost::log::trivial::severity >= boost::log::trivial::info &&
+            boost::log::expressions::attr<std::string>("Channel") == "DATALF");
+
+    // Add it to the core
+    boost::log::core::get()->add_sink(sink);
+}
\ No newline at end of file
diff --git a/src/SourceCodeWriter.cpp b/src/SourceCodeWriter.cpp
index e77d4d1..02bc8aa 100644
--- a/src/SourceCodeWriter.cpp
+++ b/src/SourceCodeWriter.cpp
@@ -3,17 +3,20 @@
  */
 
 #include "SourceCodeWriter.h"
+#include "Logger.h"
 #include "HelpText.h"
 #include <boost/algorithm/string.hpp>
 
 // Constructor
 SourceCodeWriter::SourceCodeWriter(GetOptSetup *getOptSetup) {
     if (getOptSetup->getSourceFileName().empty() || getOptSetup->getHeaderFileName().empty()) {
+        LOG_ERROR("No source or header file name given.");
         perror("Both the Header-Filename and the Sourcefilename must be set.");
         exit(1);
     }
 
     if (getOptSetup->getClassName().empty()) {
+        LOG_ERROR("No class name given.");
         perror("The Class-Name must be set. ");
         exit(1);
     }
@@ -31,16 +34,20 @@ SourceCodeWriter::~SourceCodeWriter() {
 
 // Getter
 FILE *SourceCodeWriter::getHeaderFile() {
+    LOG_DEBUG("Getting Header-File: " + (getOutputDir() + getGetOptSetup()->getHeaderFileName()));
     if (headerFile == nullptr) {
         setHeaderFile(fopen((getOutputDir() + getGetOptSetup()->getHeaderFileName()).c_str(), "w"));
     }
+    LOG_TRACE("Finished getting Header-File");
     return headerFile;
 }
 
 FILE *SourceCodeWriter::getSourceFile() {
+    LOG_DEBUG("Getting Source-File: " + (getOutputDir() + getGetOptSetup()->getSourceFileName()));
     if (sourceFile == nullptr) {
         setSourceFile(fopen((getOutputDir() + getGetOptSetup()->getSourceFileName()).c_str(), "w"));
     }
+    LOG_TRACE("Finished getting Source-File");
     return sourceFile;
 }
 
@@ -89,6 +96,7 @@ string SourceCodeWriter::getValueTypeByOption(Option &option) {
 
 //from here on are all the headerFiles
 void SourceCodeWriter::headerFileIncludes() {
+    LOG_TRACE("Writing includes to Header-File");
     // Define static and always used includes here
     string includes[] = {"getopt.h", "iostream", "boost/lexical_cast.hpp"};
 
@@ -108,9 +116,11 @@ void SourceCodeWriter::headerFileIncludes() {
 
     // Close header file
     fprintf(getHeaderFile(), "\n#endif //%s_H", defineString.c_str());
+    LOG_TRACE("Finished writing includes to Header-File");
 }
 
 void SourceCodeWriter::headerFileNamespace() {
+    LOG_TRACE("Writing namespace to Header-File");
     //start of namespace
     if (!getGetOptSetup()->getNamespaceName().empty()) {
         fprintf(getHeaderFile(), "namespace %s {\n\n", getGetOptSetup()->getNamespaceName().c_str());
@@ -124,9 +134,11 @@ void SourceCodeWriter::headerFileNamespace() {
     if (!getGetOptSetup()->getNamespaceName().empty()) {
         fprintf(getHeaderFile(), "}\n");
     }
+    LOG_TRACE("Finished writing namespace to Header-File");
 }
 
 void SourceCodeWriter::headerFileClass() {
+    LOG_TRACE("Writing class to Header-File");
     //start of class
     fprintf(getHeaderFile(), "class %s {\n", getGetOptSetup()->getClassName().c_str());
 
@@ -173,9 +185,11 @@ void SourceCodeWriter::headerFileClass() {
 
     //end of class
     fprintf(getHeaderFile(), "};\n");
+    LOG_TRACE("Finished writing class to Header-File");
 }
 
 void SourceCodeWriter::createHeaderStructArgs() {
+    LOG_TRACE("Writing struct Args to Header-File");
     fprintf(getHeaderFile(), "struct Args {\n");
     for (auto &option: getGetOptSetup()->getOptions()) {
         fprintf(getHeaderFile(), "struct {\n");
@@ -186,19 +200,23 @@ void SourceCodeWriter::createHeaderStructArgs() {
         fprintf(getHeaderFile(), "} %s;\n", determineArgsName(option).c_str());
     }
     fprintf(getHeaderFile(), "};\n\n");
+    LOG_TRACE("Finished writing struct Args to Header-File");
 }
 
 //from here on are all the sourceFiles
 void SourceCodeWriter::sourceFileIncludes() {
+    LOG_TRACE("Writing includes to Source-File");
     fprintf(getSourceFile(), "#include \"%s\"\n\n", getGetOptSetup()->getHeaderFileName().c_str());
 
     //Here further generation-Methods
 
     // Close source file includes
     fprintf(getSourceFile(), "\n");
+    LOG_TRACE("Finished writing includes to Source-File");
 }
 
 void SourceCodeWriter::sourceFileNamespace() {
+    LOG_TRACE("Writing namespace to Source-File");
     //start of namespace
     if (!getGetOptSetup()->getNamespaceName().empty()) {
         fprintf(getSourceFile(), "namespace %s {\n\n", getGetOptSetup()->getNamespaceName().c_str());
@@ -217,13 +235,17 @@ void SourceCodeWriter::sourceFileNamespace() {
     if (!getGetOptSetup()->getNamespaceName().empty()) {
         fprintf(getSourceFile(), "}\n");
     }
+    LOG_TRACE("Finished writing namespace to Source-File");
 }
 
 void SourceCodeWriter::createHeaderParsingFunction() {
+    LOG_TRACE("Writing parsing function to Header-File");
     fprintf(getHeaderFile(), "void parseOptions(int argc, char **argv);\n");
+    LOG_TRACE("Finished writing parsing function to Header-File");
 }
 
 void SourceCodeWriter::sourceFileParse() {
+    LOG_TRACE("Writing parsing function to Source-File");
     fprintf(getSourceFile(), "void %s::parse() {\n", getGetOptSetup()->getClassName().c_str());
     for (auto &option: getGetOptSetup()->getOptions()) {
         std::string optionName = determineArgsName(option);
@@ -283,9 +305,11 @@ void SourceCodeWriter::sourceFileParse() {
         fprintf(getSourceFile(), "}\n");
     }
     fprintf(getSourceFile(), "}\n");
+    LOG_TRACE("Finished writing parsing function to Source-File");
 }
 
 void SourceCodeWriter::createSourceParsingFunction() {
+    LOG_TRACE("Writing parsing function to Source-File");
     vector<Option> options = getGetOptSetup()->getOptions();
     fprintf(getSourceFile(), "void %s::parseOptions(int argc, char **argv){\nargs = Args();\n"
                              "opterr = 0;\nint opt;\nstatic struct option long_options[] = {\n",
@@ -410,20 +434,26 @@ void SourceCodeWriter::createSourceParsingFunction() {
 
     //Close function parseOptions
     fprintf(getSourceFile(), "}\n");
+    LOG_TRACE("Finished generating parseOptions()");
 }
 
 void SourceCodeWriter::createHeaderUnknownOption() {
+    LOG_TRACE("Generating unknownOption() header");
     fprintf(getHeaderFile(), "virtual void unknownOption(const std::string &unknownOption);\n\n");
+    LOG_TRACE("Finished generating unknownOption() header");
 }
 
 void SourceCodeWriter::createSourceUnknownOption() {
+    LOG_TRACE("Generating unknownOption() source");
     fprintf(getSourceFile(), "void %s::unknownOption(const std::string &unknownOption){\n"
                              "perror(\"GetOpt encountered an unknown option.\");\n"
                              "exit(1);\n}\n", getGetOptSetup()->getClassName().c_str());
+    LOG_TRACE("Finished generating unknownOption() source");
 }
 
 // Helper functions
 std::string SourceCodeWriter::determineArgsName(const Option &option) {
+    LOG_TRACE("Determining args name for " + option.getLongOpt() + " (" + option.getShortOpt() + ")");
     std::string argsName;
     if (!option.getInterface().empty()) {
         argsName = option.getInterface();
@@ -445,14 +475,17 @@ std::string SourceCodeWriter::determineArgsName(const Option &option) {
     }
 
     if (argsName.empty()) {
+        LOG_ERROR("Could not determine args name for " + option.getLongOpt() + " (" + option.getShortOpt() + ")");
         perror("Every option must at least have either an Interface, a LongOpt or a ShortOpt.");
         exit(1);
     }
 
+    LOG_TRACE("Determined args name for " + option.getLongOpt() + " (" + option.getShortOpt() + ") as " + argsName);
     return argsName;
 }
 
 void SourceCodeWriter::createHeaderGetter() {
+    LOG_TRACE("Generating getter() header");
     for (Option option: getGetOptSetup()->getOptions()) {
         string capitalizedArgsName = determineArgsName(option);
         capitalizedArgsName[0] = toupper(capitalizedArgsName[0], locale());
@@ -467,9 +500,11 @@ void SourceCodeWriter::createHeaderGetter() {
             fprintf(getHeaderFile(), "bool isSet%s() const;\n", capitalizedArgsName.c_str());
         }
     }
+    LOG_TRACE("Finished generating getter() header");
 }
 
 void SourceCodeWriter::createSourceGetter() {
+    LOG_TRACE("Generating getter() source");
     for (Option option: getGetOptSetup()->getOptions()) {
         string capitalizedArgsName = determineArgsName(option);
         capitalizedArgsName[0] = toupper(capitalizedArgsName[0], locale());
@@ -490,9 +525,11 @@ void SourceCodeWriter::createSourceGetter() {
                     determineArgsName(option).c_str());
         }
     }
+    LOG_TRACE("Finished generating getter() source");
 }
 
 void SourceCodeWriter::createExternalFunctions() {
+    LOG_TRACE("Generating external functions");
     vector<Option> options = getGetOptSetup()->getOptions();
 
     for (auto &option: options) {
@@ -506,29 +543,38 @@ void SourceCodeWriter::createExternalFunctions() {
             fprintf(getHeaderFile(), ") = 0;\n");
         }
     }
+    LOG_TRACE("Finished generating external functions");
 }
 
 void SourceCodeWriter::createHeaderPrintVersion() {
+    LOG_TRACE("Generating printVersion() header");
     fprintf(getHeaderFile(), "virtual void printVersion();\n");
+    LOG_TRACE("Finished generating printVersion() header");
 
 }
 
 void SourceCodeWriter::createSourcePrintVersion() {
+    LOG_TRACE("Generating printVersion() source");
     fprintf(getSourceFile(), "void %s::printVersion(){\nprintf(\"version: 1.0.0\\n\");\n}\n",
             getGetOptSetup()->getClassName().c_str());
+    LOG_TRACE("Finished generating printVersion() source");
 
 }
 
 void SourceCodeWriter::createHeaderPrintHelp() {
+    LOG_TRACE("Generating printHelp() header");
     fprintf(getHeaderFile(), "virtual void printHelp();\n");
+    LOG_TRACE("Finished generating printHelp() header");
 }
 
 void SourceCodeWriter::createSourcePrintHelp() {
-    auto *helpText = new HelpText(getGetOptSetup());
-    fprintf(getSourceFile(), "%s", helpText->parseHelpMessage().c_str());
+    LOG_TRACE("Generating printHelp() source");
+    fprintf(getSourceFile(), "%s", HelpText(getGetOptSetup()).parseHelpMessage().c_str());
+    LOG_TRACE("Finished generating printHelp() source");
 }
 
 void SourceCodeWriter::writeFile() {
+    LOG_INFO("Starting to write source code...");
 //    printf("Writing file...\n");
 
     //Write header files --> put methods here
@@ -537,5 +583,6 @@ void SourceCodeWriter::writeFile() {
     //Write source files --> put methods here
     sourceFileIncludes();
     sourceFileNamespace();
+    LOG_INFO("Finished writing source code.");
 }
 
diff --git a/src/StateMachine.cpp b/src/StateMachine.cpp
index 035f3af..c3ac7de 100644
--- a/src/StateMachine.cpp
+++ b/src/StateMachine.cpp
@@ -3,6 +3,93 @@
  */
 
 #include "StateMachine.h"
+#include "Logger.h"
+
+inline std::string eventToString(Event event) {
+    switch (event) {
+        case Event::GETOPTSETUPSTART:
+            return "GETOPTSETUPSTART";
+        case Event::GETOPTSETUPEND:
+            return "GETOPTSETUPEND";
+        case Event::AUTHORSTART:
+            return "AUTHORSTART";
+        case Event::AUTHOREND:
+            return "AUTHOREND";
+        case Event::HEADERFILENAMESTART:
+            return "HEADERFILENAMESTART";
+        case Event::HEADERFILENAMEEND:
+            return "HEADERFILENAMEEND";
+        case Event::SOURCEFILENAMESTART:
+            return "SOURCEFILENAMESTART";
+        case Event::SOURCEFILENAMEEND:
+            return "SOURCEFILENAMEEND";
+        case Event::NAMESPACESTART:
+            return "NAMESPACESTART";
+        case Event::NAMESPACEEND:
+            return "NAMESPACEEND";
+        case Event::CLASSNAMESTART:
+            return "CLASSNAMESTART";
+        case Event::CLASSNAMEEND:
+            return "CLASSNAMEEND";
+        case Event::OVERALLDESCRIPTIONSTART:
+            return "OVERALLDESCRIPTIONSTART";
+        case Event::OVERALLDESCRIPTIONEND:
+            return "OVERALLDESCRIPTIONEND";
+        case Event::BLOCKSTART:
+            return "BLOCKSTART";
+        case Event::BLOCKEND:
+            return "BLOCKEND";
+        case Event::SAMPLEUSAGESTART:
+            return "SAMPLEUSAGESTART";
+        case Event::SAMPLEUSAGEEND:
+            return "SAMPLEUSAGEEND";
+        case Event::SAMPLESTART:
+            return "SAMPLESTART";
+        case Event::SAMPLEEND:
+            return "SAMPLEEND";
+        case Event::OPTIONSSTART:
+            return "OPTIONSSTART";
+        case Event::OPTIONSEND:
+            return "OPTIONSEND";
+        case Event::OPTIONSTART:
+            return "OPTIONSTART";
+        case Event::OPTIONEND:
+            return "OPTIONEND";
+        default:
+            return "UNKNOWN";
+    }
+}
+
+inline std::string stateToString(State state) {
+    switch (state) {
+        case State::GETOPTSETUP:
+            return "GETOPTSETUP";
+        case State::AUTHOR:
+            return "AUTHOR";
+        case State::HEADERFILENAME:
+            return "HEADERFILENAME";
+        case State::SOURCEFILENAME:
+            return "SOURCEFILENAME";
+        case State::NAMESPACE:
+            return "NAMESPACE";
+        case State::CLASSNAME:
+            return "CLASSNAME";
+        case State::OVERALLDESCRIPTION:
+            return "OVERALLDESCRIPTION";
+        case State::BLOCK:
+            return "BLOCK";
+        case State::SAMPLEUSAGE:
+            return "SAMPLEUSAGE";
+        case State::SAMPLE:
+            return "SAMPLE";
+        case State::OPTIONS:
+            return "OPTIONS";
+        case State::OPTION:
+            return "OPTION";
+        default:
+            return "UNKNOWN";
+    }
+}
 
 // Constructor
 StateMachine::StateMachine() {
@@ -24,6 +111,7 @@ void StateMachine::setState(State state) {
 
 // Methods
 void StateMachine::handleEvent(Event event) {
+    LOG_TRACE("State: " + stateToString(currentState) + " Event: " + eventToString(event));
     switch (currentState) {
         case State::START:
             switch (event) {
diff --git a/src/XMLParser.cpp b/src/XMLParser.cpp
index c309ef3..c82bca7 100644
--- a/src/XMLParser.cpp
+++ b/src/XMLParser.cpp
@@ -6,6 +6,7 @@
 #include <xercesc/util/OutOfMemoryException.hpp>
 
 #include "XMLParser.h"
+#include "Logger.h"
 
 #include <iostream>
 
@@ -17,6 +18,7 @@ XMLParser::XMLParser(const std::string &filename) {
 }
 
 void XMLParser::parse() {
+    LOG_INFO("Starting parsing of file " + filename);
     try {
         XMLPlatformUtils::Initialize();
     }
@@ -53,6 +55,7 @@ void XMLParser::parse() {
     }
 
     if (errorCount > 0) {
+        LOG_ERROR("There were " + to_string(errorCount) + " errors during parsing of file " + filename);
         perror("There were errors during parsing.");
         exit(1);
     }
@@ -61,6 +64,7 @@ void XMLParser::parse() {
     delete parser;
     //Terminate muss immer am Schluss stehen
     XMLPlatformUtils::Terminate();
+    LOG_INFO("Finished parsing of file " + filename);
 }
 
 void XMLParser::startDocument() {
@@ -72,6 +76,7 @@ void XMLParser::endDocument() {
 }
 
 void XMLParser::startElement(const XMLCh *const name, AttributeList &attributes) {
+    LOG_TRACE("Start Element: " + string(XMLString::transcode(name)));
     if (!XMLString::compareString(name, u"GetOptSetup")) {
         sm->handleEvent(Event::GETOPTSETUPSTART);
         getOptSetup->parseAttributes(attributes);
@@ -107,6 +112,7 @@ void XMLParser::startElement(const XMLCh *const name, AttributeList &attributes)
 }
 
 void XMLParser::endElement(const XMLCh *const name) {
+    LOG_TRACE("End Element: " + string(XMLString::transcode(name)));
     if (!XMLString::compareString(name, u"GetOptSetup")) {
         sm->handleEvent(Event::GETOPTSETUPEND);
     } else if (!XMLString::compareString(name, u"Author")) {
@@ -135,6 +141,7 @@ void XMLParser::endElement(const XMLCh *const name) {
 }
 
 void XMLParser::characters(const XMLCh *const chars, const XMLSize_t length) {
+    LOG_TRACE("Characters: " + string(XMLString::transcode(chars)));
     switch (sm->getState()) {
         case State::START:
             break;
diff --git a/src/models/Author.cpp b/src/models/Author.cpp
index 8f638d8..8304298 100644
--- a/src/models/Author.cpp
+++ b/src/models/Author.cpp
@@ -4,6 +4,7 @@
 
 #include <xercesc/util/XMLString.hpp>
 #include "models/Author.h"
+#include "Logger.h"
 
 //Constructor
 Author::Author() = default;
@@ -37,6 +38,7 @@ void Author::setMail(const string &_mail) {
 
 //helper function to parse the Author-Tag
 void Author::parseAttributes(AttributeList &attributes) {
+    LOG_TRACE("Starting Author-Attributes parse");
     for (unsigned int i = 0; i < attributes.getLength(); i++) {
         if (!XMLString::compareString(attributes.getName(i), u"Name")) {
             setName(std::string(XMLString::transcode(attributes.getValue(i))));
@@ -46,4 +48,5 @@ void Author::parseAttributes(AttributeList &attributes) {
             setMail(std::string(XMLString::transcode(attributes.getValue(i))));
         }
     }
+    LOG_TRACE("Finished Author-Attributes parse");
 }
diff --git a/src/models/GetOptSetup.cpp b/src/models/GetOptSetup.cpp
index 98a0deb..1ba018a 100644
--- a/src/models/GetOptSetup.cpp
+++ b/src/models/GetOptSetup.cpp
@@ -5,6 +5,7 @@
 #include <xercesc/util/XMLString.hpp>
 #include <boost/lexical_cast.hpp>
 #include "models/GetOptSetup.h"
+#include "Logger.h"
 
 // Constructors
 GetOptSetup::GetOptSetup() = default;
@@ -100,9 +101,11 @@ void GetOptSetup::addOption(const Option &option) {
 
 // Helpers
 void GetOptSetup::parseAttributes(AttributeList &attributes) {
+    LOG_TRACE("Starting GetOptSetup-Attributes parse");
     for (unsigned int i = 0; i < attributes.getLength(); i++) {
         if (!XMLString::compareString(attributes.getName(i), u"SignPerLine")) {
             setSignPerLine(std::string(XMLString::transcode(attributes.getValue(i))));
         }
     }
+    LOG_TRACE("Finished GetOptSetup-Attributes parse");
 }
diff --git a/src/models/Option.cpp b/src/models/Option.cpp
index 16a12f2..cfd2e65 100644
--- a/src/models/Option.cpp
+++ b/src/models/Option.cpp
@@ -3,6 +3,7 @@
  */
 
 #include "models/Option.h"
+#include "Logger.h"
 #include <boost/lexical_cast.hpp>
 #include <vector>
 #include <boost/algorithm/string.hpp>
@@ -65,6 +66,7 @@ void Option::setRef(const std::string &ref) {
     int _ref = boost::lexical_cast<int>(ref);
     if (_ref < 1 || _ref > 63) {
         std::cerr << "Error: Invalid ref value: [" << _ref << "]. Must be between 1 and 63." << std::endl;
+        LOG_ERROR("Error: Invalid ref value: [" << _ref << "]. Must be between 1 and 63.");
         exit(EXIT_FAILURE);
     }
     Option::ref = _ref;
@@ -105,6 +107,7 @@ void Option::setHasArguments(const std::string &_hasArguments) {
         Option::hasArguments = HasArguments::REQUIRED;
     } else {
         throw std::runtime_error("Invalid value for hasArguments");
+        LOG_ERROR("Invalid value for hasArguments");
     }
 }
 
@@ -117,6 +120,7 @@ void Option::setConvertTo(const std::string &_convertTo) {
         Option::convertTo = ConvertToOptions::BOOLEAN;
     } else {
         throw std::runtime_error("Invalid value for convertTo");
+        LOG_ERROR("Invalid value for convertTo");
     }
 }
 
@@ -131,6 +135,7 @@ void Option::setInterface(const std::string &_interface) {
 // Helpers
 
 void Option::parseAttributes(AttributeList &attributes) {
+    LOG_TRACE("Starting Option-Attributes parse");
     for (unsigned int i = 0; i < attributes.getLength(); i++) {
         if (!XMLString::compareString(attributes.getName(i), u"Ref")) {
             setRef(std::string(XMLString::transcode(attributes.getValue(i))));
@@ -156,4 +161,5 @@ void Option::parseAttributes(AttributeList &attributes) {
             setInterface(std::string(XMLString::transcode(attributes.getValue(i))));
         }
     }
+    LOG_TRACE("Finished Option-Attributes parse");
 }