some more file cleanup, mostly file headers and renaming

Author: robertDurst

CMakeLists.txt

@@ -7,7 +7,7 @@ set(CMAKE_CXX_STANDARD 17)
 ADD_LIBRARY(SailfishcLibs 
     ./src/lexar/Lexar.cpp
     ./src/lexar/Token.cpp
-    ./src/parser/Parser.cpp
+    ./src/sailfish/sailfishc.cpp
     ./src/errorhandler/ParserErrorHandler.cpp
     ./src/errorhandler/SemanticAnalyzerErrorHandler.cpp 
     ./src/main/CommandLine.cpp

src/common/display.h

@@ -4,6 +4,8 @@
  *
  * Base structure and credit:
  * https://stackoverflow.com/questions/2616906/how-do-i-output-coloured-text-to-a-linux-terminal
+ *
+ * Simple utility class for displaying formatted messages.
  */
 #pragma once
 #include <ostream>

src/errorhandler/Error.h

@@ -1,6 +1,8 @@
 /*
  * Robert Durst 2019
  * Sailfish Programming Language
+ *
+ * Simple utility class for formatting and displaying various types of errors.
  */
 #pragma once
 #include "../common/display.h"

src/errorhandler/ParserErrorHandler.h

@@ -1,6 +1,8 @@
 /*
  * Robert Durst 2019
  * Sailfish Programming Language
+ *
+ * Parser handles errors related to lexing and parsing.
  */
 #pragma once
 #include "Error.h"

src/errorhandler/SemanticAnalyzerErrorHandler.h

@@ -1,6 +1,8 @@
 /*
  * Robert Durst 2019
  * Sailfish Programming Language
+ *
+ * Semantic Analyzer Error Handler handles errors related to Semantic Analysis.
  */
 #pragma once
 #include "Error.h"

src/lexar/Lexar.h

@@ -1,6 +1,9 @@
 /*
  * Robert Durst 2019
  * Sailfish Programming Language
+ *
+ * Lexar encapsulates the logic for retreiving tokens one by one from a given
+ * source code text file.
  */
 #pragma once
 #include "Token.h"

src/lexar/Token.h

@@ -1,6 +1,8 @@
 /*
  * Robert Durst 2019
  * Sailfish Programming Language
+ *
+ * Tokens are objects with a kind and a value.
  */
 #pragma once
 #include <iostream>

src/main/CommandLine.cpp

@@ -53,14 +53,14 @@ fullCompilation(const std::string& filename)
 
         std::cout << "Compiling " << blue << filename << normal << ".\n";
 
-        Parser* p = new Parser(filename);
-        p->parse();
+        sailfishc* sfc = new sailfishc(filename);
+        sfc->parse();
 
         std::cout << green << "Successfully compiled: " << normal << blue
                   << filename << "\n"
                   << normal;
 
-        p->transpile();
+        sfc->transpile();
 
         std::cout << green << "Successfully wrote compiled code to: " << normal
                   << blue << " out.c\n"

src/main/CommandLine.h

@@ -1,11 +1,13 @@
 /*
  * Robert Durst 2019
  * Sailfish Programming Language
+ *
+ * CommandLine handles the basic command line utilities for the compiler.
  */
 #pragma once
 #include "../common/display.h"
 #include "../lexar/Lexar.h"
-#include "../parser/Parser.h"
+#include "../sailfish/sailfishc.h"
 #include <iostream>
 #include <stdlib.h>
 #include <string>