Breaking changes: Reworked structure of project.

Signed-off-by: Amlal El Mahrouss <amlal.elmahrouss@icloud.com>

55 files changed, 57 insertions, 66 deletions

diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json
index f3115f7..53d2c12 100644
--- a/.vscode/c_cpp_properties.json
+++ b/.vscode/c_cpp_properties.json
@@ -3,7 +3,7 @@
         {
             "name": "Mac",
             "includePath": [
-                "${workspaceFolder}/**"
+                "${workspaceFolder}/Private/**"
             ],
             "defines": [],
             "macFrameworkPath": [
diff --git a/Drivers/bin/Source/preprocessor.64x.pp b/Drivers/bin/Source/preprocessor.64x.pp
deleted file mode 100644
index 08940e9..0000000
--- a/Drivers/bin/Source/preprocessor.64x.pp
+++ /dev/null
@@ -1,8 +0,0 @@
-
-export .text foo
-  pha
-  lda r2, 0x1000
-  mv r20, r2
-  jrl
-  pla
-  jlr
diff --git a/PDF/64x0-Programmers-Manual.pdf b/PDF/64x0-Programmers-Manual.pdf
deleted file mode 100644
index b4e0632..0000000
--- a/PDF/64x0-Programmers-Manual.pdf
+++ /dev/null
diff --git a/PDF/X64000-Notes.pdf b/PDF/X64000-Notes.pdf
deleted file mode 100644
index 539dd43..0000000
--- a/PDF/X64000-Notes.pdf
+++ /dev/null
diff --git a/CompilerKit/AsmKit/Arch/32x0.hpp b/Private/CompilerKit/AsmKit/Arch/32x0.hpp
index 28bf754..28bf754 100644
--- a/CompilerKit/AsmKit/Arch/32x0.hpp
+++ b/Private/CompilerKit/AsmKit/Arch/32x0.hpp
diff --git a/CompilerKit/AsmKit/Arch/64x0.hpp b/Private/CompilerKit/AsmKit/Arch/64x0.hpp
index fde40fa..fde40fa 100644
--- a/CompilerKit/AsmKit/Arch/64x0.hpp
+++ b/Private/CompilerKit/AsmKit/Arch/64x0.hpp
diff --git a/CompilerKit/AsmKit/AsmKit.cc b/Private/CompilerKit/AsmKit/AsmKit.cc
index 1e8ec4a..1eea5cc 100644
--- a/CompilerKit/AsmKit/AsmKit.cc
+++ b/Private/CompilerKit/AsmKit/AsmKit.cc
@@ -10,6 +10,17 @@
 #include <AsmKit/AsmKit.hpp>
 #include <StdKit/ErrorID.hpp>
 
+/**
+ * @file AsmKit.cc
+ * @author Amlal El Mahrouss (amlal@mahrouss.com)
+ * @brief Assembler Kit
+ * @version 0.1
+ * @date 2024-01-27
+ * 
+ * @copyright Copyright (c) 2024, Mahrouss Logic
+ * 
+ */
+
 #include <iostream>
 
 //! @file AsmKit.cpp
diff --git a/CompilerKit/AsmKit/AsmKit.hpp b/Private/CompilerKit/AsmKit/AsmKit.hpp
index eeb1de0..a159c05 100644
--- a/CompilerKit/AsmKit/AsmKit.hpp
+++ b/Private/CompilerKit/AsmKit/AsmKit.hpp
@@ -121,10 +121,3 @@ namespace CompilerKit
     };
 }
 
-#ifdef __MODULE_NEED__
-#	define MPCC_MODULE(name) int name(int argc, char** argv)
-#else
-#	define MPCC_MODULE(name) int main(int argc, char** argv)
-#endif /* ifdef __MODULE_NEED__ */
-
-
diff --git a/CompilerKit/Compiler.hpp b/Private/CompilerKit/Compiler.hpp
index 810652f..810652f 100644
--- a/CompilerKit/Compiler.hpp
+++ b/Private/CompilerKit/Compiler.hpp
diff --git a/CompilerKit/Defines.hpp b/Private/CompilerKit/Defines.hpp
index d46508d..33fca43 100644
--- a/CompilerKit/Defines.hpp
+++ b/Private/CompilerKit/Defines.hpp
@@ -133,7 +133,14 @@ namespace CompilerKit
 
 typedef char char_type;
 
-#define kObjectFileExt     ".o"
+#define kObjectFileExt  ".o"
 #define kAsmFileExts    { ".64x", ".32x", ".masm", ".s", ".S" }
 
+#ifdef __MODULE_NEED__
+#	define MPCC_MODULE(name) int name(int argc, char** argv)
+#else
+#	define MPCC_MODULE(name) int main(int argc, char** argv)
+#endif /* ifdef __MODULE_NEED__ */
+
 #endif /* ifndef __CXXKIT_DEFINES_HPP__ */
+
diff --git a/CompilerKit/ParserKit.hpp b/Private/CompilerKit/ParserKit.hpp
index 49907e5..49907e5 100644
--- a/CompilerKit/ParserKit.hpp
+++ b/Private/CompilerKit/ParserKit.hpp
diff --git a/CompilerKit/StdKit/AE.hpp b/Private/CompilerKit/StdKit/AE.hpp
index 8843404..8843404 100644
--- a/CompilerKit/StdKit/AE.hpp
+++ b/Private/CompilerKit/StdKit/AE.hpp
diff --git a/CompilerKit/StdKit/ErrorID.hpp b/Private/CompilerKit/StdKit/ErrorID.hpp
index e7bc7de..e7bc7de 100644
--- a/CompilerKit/StdKit/ErrorID.hpp
+++ b/Private/CompilerKit/StdKit/ErrorID.hpp
diff --git a/CompilerKit/StdKit/ErrorOr.hpp b/Private/CompilerKit/StdKit/ErrorOr.hpp
index 97aeaa2..97aeaa2 100644
--- a/CompilerKit/StdKit/ErrorOr.hpp
+++ b/Private/CompilerKit/StdKit/ErrorOr.hpp
diff --git a/CompilerKit/StdKit/PEF.hpp b/Private/CompilerKit/StdKit/PEF.hpp
index 163e46f..163e46f 100644
--- a/CompilerKit/StdKit/PEF.hpp
+++ b/Private/CompilerKit/StdKit/PEF.hpp
diff --git a/CompilerKit/StdKit/Ref.hpp b/Private/CompilerKit/StdKit/Ref.hpp
index 9b79ca9..9b79ca9 100644
--- a/CompilerKit/StdKit/Ref.hpp
+++ b/Private/CompilerKit/StdKit/Ref.hpp
diff --git a/CompilerKit/StdKit/String.cc b/Private/CompilerKit/StdKit/String.cc
index 45662ef..45662ef 100644
--- a/CompilerKit/StdKit/String.cc
+++ b/Private/CompilerKit/StdKit/String.cc
diff --git a/CompilerKit/StdKit/String.hpp b/Private/CompilerKit/StdKit/String.hpp
index a3d528f..a3d528f 100644
--- a/CompilerKit/StdKit/String.hpp
+++ b/Private/CompilerKit/StdKit/String.hpp
diff --git a/Doxyfile b/Private/Doxyfile
index ebbad25..ebbad25 100644
--- a/Doxyfile
+++ b/Private/Doxyfile
diff --git a/External/Elf.h b/Private/External/Elf.h
index 32b9ada..32b9ada 100644
--- a/External/Elf.h
+++ b/Private/External/Elf.h
diff --git a/External/ObjFormat.h b/Private/External/ObjFormat.h
index 6781ba9..6781ba9 120000
--- a/External/ObjFormat.h
+++ b/Private/External/ObjFormat.h
diff --git a/External/Pef.h b/Private/External/Pef.h
index fcf640c..fcf640c 120000
--- a/External/Pef.h
+++ b/Private/External/Pef.h
diff --git a/Drivers/bin/.gitkeep b/Private/Frontend/.gitkeep
index e69de29..e69de29 100644
--- a/Drivers/bin/.gitkeep
+++ b/Private/Frontend/.gitkeep
diff --git a/Frontend/Compiler/.gitignore b/Private/Frontend/Compiler/.gitignore
index b8f5db3..b8f5db3 100644
--- a/Frontend/Compiler/.gitignore
+++ b/Private/Frontend/Compiler/.gitignore
diff --git a/Frontend/.gitkeep b/Private/Frontend/Compiler/.gitkeep
index e69de29..e69de29 100644
--- a/Frontend/.gitkeep
+++ b/Private/Frontend/Compiler/.gitkeep
diff --git a/Frontend/Compiler/.gitkeep b/Private/Frontend/Compiler/bin/.gitkeep
index e69de29..e69de29 100644
--- a/Frontend/Compiler/.gitkeep
+++ b/Private/Frontend/Compiler/bin/.gitkeep
diff --git a/Frontend/Compiler/compiler_command.d b/Private/Frontend/Compiler/compiler_command.d
index 80d8673..80d8673 100644
--- a/Frontend/Compiler/compiler_command.d
+++ b/Private/Frontend/Compiler/compiler_command.d
diff --git a/Frontend/Compiler/compiler_macro_helpers.d b/Private/Frontend/Compiler/compiler_macro_helpers.d
index 4dfe65e..4dfe65e 100644
--- a/Frontend/Compiler/compiler_macro_helpers.d
+++ b/Private/Frontend/Compiler/compiler_macro_helpers.d
diff --git a/Frontend/Compiler/compiler_start.d b/Private/Frontend/Compiler/compiler_start.d
index 44e17da..44e17da 100644
--- a/Frontend/Compiler/compiler_start.d
+++ b/Private/Frontend/Compiler/compiler_start.d
diff --git a/Frontend/Compiler/makefile b/Private/Frontend/Compiler/makefile
index 96902a0..96902a0 100644
--- a/Frontend/Compiler/makefile
+++ b/Private/Frontend/Compiler/makefile
diff --git a/Frontend/Compiler/man/mpcc.8 b/Private/Frontend/Compiler/man/mpcc.8
index afbeac4..afbeac4 100644
--- a/Frontend/Compiler/man/mpcc.8
+++ b/Private/Frontend/Compiler/man/mpcc.8
diff --git a/Frontend/Compiler/bin/.gitkeep b/Private/Frontend/Compiler/test/.gitkeep
index e69de29..e69de29 100644
--- a/Frontend/Compiler/bin/.gitkeep
+++ b/Private/Frontend/Compiler/test/.gitkeep
diff --git a/Drivers/.gitignore b/Private/Toolchain/.gitignore
index 323cdad..323cdad 100644
--- a/Drivers/.gitignore
+++ b/Private/Toolchain/.gitignore
diff --git a/Drivers/32asm.cc b/Private/Toolchain/32asm.cc
index 6c28868..6c28868 100644
--- a/Drivers/32asm.cc
+++ b/Private/Toolchain/32asm.cc
diff --git a/Drivers/64asm.cc b/Private/Toolchain/64asm.cc
index e33306b..4b9e25f 100644
--- a/Drivers/64asm.cc
+++ b/Private/Toolchain/64asm.cc
@@ -302,7 +302,7 @@ MPCC_MODULE(MPUXAssembler64000)
         {
             if (kVerbose)
             {
-                kStdOut << "64asm: Skip object write...\n";
+                kStdOut << "64asm: Write raw binary...\n";
             }
         }
 
@@ -313,13 +313,13 @@ MPCC_MODULE(MPUXAssembler64000)
         }
 
         if (kVerbose)
-            kStdOut << "64asm: Wrote program bytes to file...\n";
+            kStdOut << "64asm: Wrote file with program in it.";
 
         file_ptr_out.flush();
         file_ptr_out.close();
 
         if (kVerbose)
-            kStdOut << "64asm: Exit succeeded with code 0.\n";
+            kStdOut << "64asm: Exit succeeded.\n";
 
         return 0;
     }
@@ -327,7 +327,7 @@ MPCC_MODULE(MPUXAssembler64000)
 asm_fail_exit:
 
     if (kVerbose)
-        kStdOut << "64asm: Exit failed with code -1.\n";
+        kStdOut << "64asm: Exit failed.\n";
 
     return -1;
 }
diff --git a/Drivers/bccl.cc b/Private/Toolchain/bccl.cc
index 048424b..048424b 100644
--- a/Drivers/bccl.cc
+++ b/Private/Toolchain/bccl.cc
diff --git a/Frontend/Compiler/test/.gitkeep b/Private/Toolchain/bin/.gitkeep
index e69de29..e69de29 100644
--- a/Frontend/Compiler/test/.gitkeep
+++ b/Private/Toolchain/bin/.gitkeep
diff --git a/Drivers/bin/README.txt b/Private/Toolchain/bin/README.txt
index 7530e5e..7530e5e 100644
--- a/Drivers/bin/README.txt
+++ b/Private/Toolchain/bin/README.txt
diff --git a/Drivers/bin/Source/hello_world.32x b/Private/Toolchain/bin/Source/hello_world.32x
index e8c7d31..e8c7d31 100644
--- a/Drivers/bin/Source/hello_world.32x
+++ b/Private/Toolchain/bin/Source/hello_world.32x
diff --git a/Drivers/bin/Source/hello_world.64x b/Private/Toolchain/bin/Source/hello_world.64x
index f342396..f342396 100644
--- a/Drivers/bin/Source/hello_world.64x
+++ b/Private/Toolchain/bin/Source/hello_world.64x
diff --git a/Drivers/bin/Source/preprocessor.64x b/Private/Toolchain/bin/Source/preprocessor.64x
index 66e12a6..66e12a6 100644
--- a/Drivers/bin/Source/preprocessor.64x
+++ b/Private/Toolchain/bin/Source/preprocessor.64x
diff --git a/Drivers/bpp.cc b/Private/Toolchain/bpp.cc
index 4618eec..cd1bc47 100644
--- a/Drivers/bpp.cc
+++ b/Private/Toolchain/bpp.cc
@@ -21,7 +21,7 @@
 // @file bpp.cc
 // @brief BCCL preprocessor.
 
-typedef Int32 (*cpp_parser_fn_t)(std::string &line, std::ifstream &hdr_file, std::ofstream &pp_out);
+typedef Int32 (*bpp_parser_fn_t)(std::string &line, std::ifstream &hdr_file, std::ofstream &pp_out);
 
 /////////////////////////////////////////////////////////////////////////////////////////
 
@@ -41,34 +41,34 @@ namespace details
 		kNotEqual,
 	};
 
-	struct cpp_macro_condition final
+	struct bpp_macro_condition final
 	{
 		int32_t fType;
 		std::string fTypeName;
 	};
 
-	struct cpp_macro final
+	struct bpp_macro final
 	{
 		std::vector<std::string> fArgs;
 		std::string fName;
 		std::string fValue;
 	};
 
-	class cpp_pragma final
+	class bpp_pragma final
 	{
 	public:
-		explicit cpp_pragma() = default;
-		~cpp_pragma() = default;
+		explicit bpp_pragma() = default;
+		~bpp_pragma() = default;
 
-		CXXKIT_COPY_DEFAULT(cpp_pragma);
+		CXXKIT_COPY_DEFAULT(bpp_pragma);
 
 		std::string fMacroName;
-		cpp_parser_fn_t fParse;
+		bpp_parser_fn_t fParse;
 	};
 }
 
 static std::vector<std::string> kFiles;
-static std::vector<details::cpp_macro> kMacros;
+static std::vector<details::bpp_macro> kMacros;
 static std::vector<std::string> kIncludes;
 
 static std::string kWorkingDir;
@@ -89,13 +89,13 @@ static std::vector<std::string> kKeywords = {
 
 /////////////////////////////////////////////////////////////////////////////////////////
 
-// @name cpp_parse_if_condition
+// @name bpp_parse_if_condition
 // @brief parse #if condition
 
 /////////////////////////////////////////////////////////////////////////////////////////
 
-int32_t cpp_parse_if_condition(details::cpp_macro_condition &cond,
-							   details::cpp_macro &macro,
+int32_t bpp_parse_if_condition(details::bpp_macro_condition &cond,
+							   details::bpp_macro &macro,
 							   bool &inactive_code, bool &defined,
 							   std::string &macro_str)
 {
@@ -278,12 +278,12 @@ std::vector<std::string> kAllIncludes;
 
 /////////////////////////////////////////////////////////////////////////////////////////
 
-// @name cpp_parse_file
+// @name bpp_parse_file
 // @brief parse file to preprocess it.
 
 /////////////////////////////////////////////////////////////////////////////////////////
 
-void cpp_parse_file(std::ifstream &hdr_file, std::ofstream &pp_out)
+void bpp_parse_file(std::ifstream &hdr_file, std::ofstream &pp_out)
 {
 	std::string hdr_line;
 	std::string line_after_include;
@@ -497,7 +497,7 @@ void cpp_parse_file(std::ifstream &hdr_file, std::ofstream &pp_out)
 					}
 				}
 
-				details::cpp_macro macro;
+				details::bpp_macro macro;
 
 				macro.fArgs = args;
 				macro.fName = macro_key;
@@ -744,7 +744,7 @@ void cpp_parse_file(std::ifstream &hdr_file, std::ofstream &pp_out)
 			{
 				inactive_code = true;
 
-				std::vector<details::cpp_macro_condition> cpp_macro_condition_list = {
+				std::vector<details::bpp_macro_condition> bpp_macro_condition_list = {
 					{
 						.fType = details::kEqual,
 						.fTypeName = "==",
@@ -773,7 +773,7 @@ void cpp_parse_file(std::ifstream &hdr_file, std::ofstream &pp_out)
 
 				int32_t good_to_go = 0;
 
-				for (auto &macro_condition : cpp_macro_condition_list)
+				for (auto &macro_condition : bpp_macro_condition_list)
 				{
 					if (hdr_line.find(macro_condition.fTypeName) != std::string::npos)
 					{
@@ -781,7 +781,7 @@ void cpp_parse_file(std::ifstream &hdr_file, std::ofstream &pp_out)
 						{
 							if (hdr_line.find(found_macro.fName) != std::string::npos)
 							{
-								good_to_go = cpp_parse_if_condition(macro_condition, found_macro,
+								good_to_go = bpp_parse_if_condition(macro_condition, found_macro,
 																	inactive_code, defined,
 																	hdr_line);
 
@@ -949,7 +949,7 @@ void cpp_parse_file(std::ifstream &hdr_file, std::ofstream &pp_out)
 
 						open = true;
 
-						cpp_parse_file(header, pp_out);
+						bpp_parse_file(header, pp_out);
 
 						break;
 					}
@@ -966,7 +966,7 @@ void cpp_parse_file(std::ifstream &hdr_file, std::ofstream &pp_out)
 					if (!header.is_open())
 						throw std::runtime_error("bpp: no such include file: " + path);
 
-					cpp_parse_file(header, pp_out);
+					bpp_parse_file(header, pp_out);
 				}
 			}
 			else
@@ -995,13 +995,13 @@ MPCC_MODULE(MPUXPreprocessor)
 		bool skip = false;
 		bool double_skip = false;
 
-		details::cpp_macro macro_1;
+		details::bpp_macro macro_1;
 		macro_1.fName = "__true";
 		macro_1.fValue = "1";
 
 		kMacros.push_back(macro_1);
 
-		details::cpp_macro macro_0;
+		details::bpp_macro macro_0;
 		macro_0.fName = "__false";
 		macro_0.fValue = "0";
 
@@ -1085,7 +1085,7 @@ MPCC_MODULE(MPUXPreprocessor)
 					if (is_string)
 						macro_value += "\"";
 
-					details::cpp_macro macro;
+					details::bpp_macro macro;
 					macro.fName = macro_key;
 					macro.fValue = macro_value;
 
@@ -1111,7 +1111,7 @@ MPCC_MODULE(MPUXPreprocessor)
 			std::ifstream file_descriptor(file);
 			std::ofstream file_descriptor_pp(file + ".pp");
 
-			cpp_parse_file(file_descriptor, file_descriptor_pp);
+			bpp_parse_file(file_descriptor, file_descriptor_pp);
 		}
 
 		return 0;
diff --git a/Drivers/ccplus.cc b/Private/Toolchain/ccplus.cc
index fd9b5de..fd9b5de 100644
--- a/Drivers/ccplus.cc
+++ b/Private/Toolchain/ccplus.cc
diff --git a/Drivers/ld.cc b/Private/Toolchain/ld.cc
index 90ea19f..90ea19f 100644
--- a/Drivers/ld.cc
+++ b/Private/Toolchain/ld.cc
diff --git a/Drivers/makefile b/Private/Toolchain/makefile
index e04a40b..e04a40b 100644
--- a/Drivers/makefile
+++ b/Private/Toolchain/makefile
diff --git a/Tools/.gitignore b/Private/Tools/.gitignore
index 3ad4db2..3ad4db2 100644
--- a/Tools/.gitignore
+++ b/Private/Tools/.gitignore
diff --git a/Tools/install.d b/Private/Tools/install.d
index ebd2355..ebd2355 100644
--- a/Tools/install.d
+++ b/Private/Tools/install.d
diff --git a/Tools/makefile b/Private/Tools/makefile
index 420e332..420e332 100644
--- a/Tools/makefile
+++ b/Private/Tools/makefile
diff --git a/Tools/test/.gitkeep b/Private/Tools/test/.gitkeep
index e69de29..e69de29 100644
--- a/Tools/test/.gitkeep
+++ b/Private/Tools/test/.gitkeep
diff --git a/Public/.gitkeep b/Public/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/Public/.gitkeep
diff --git a/PDF/HAVP b/Public/PDF/HAVP.TXT
index 12fcec5..12fcec5 100644
--- a/PDF/HAVP
+++ b/Public/PDF/HAVP.TXT
diff --git a/Public/PDF/Inside 64x0.pdf b/Public/PDF/Inside 64x0.pdf
new file mode 100644
index 0000000..bcd6782
--- /dev/null
+++ b/Public/PDF/Inside 64x0.pdf
diff --git a/PDF/README.txt b/Public/PDF/NOTICE.TXT
index 23691da..23691da 100644
--- a/PDF/README.txt
+++ b/Public/PDF/NOTICE.TXT
diff --git a/PDF/VNRP b/Public/PDF/VNRP.TXT
index e17b494..e17b494 100644
--- a/PDF/VNRP
+++ b/Public/PDF/VNRP.TXT
diff --git a/ReadMe.md b/ReadMe.md
index ccae53c..7f81e4c 100644
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -1,30 +1,18 @@
-# MPCC
+# MP-CC
 ## MP-UX Compiler Collection.
 
-### What is this?
+Start by cloning the repo:
 
-It is a suite of compilers, assembler, linker, preprocessor
-In order to help the programmer achieve its task.
+```
+git clone git@github.com:Mahrouss-Logic/mp-cc.git
+```
 
-### Supported languages
+Then go to `Private/Toolchain/` And execute:
 
-- Optimized C++
-- Optimized D
-- BCCL (Binary Compatible Computer Language, common target for mp based compilers.)
-- MP-UX Assembly (64x0 and 32x0 syntax)
+```
+make all
+```
 
-### Actually contains:
-
-bpp: BCCL/MASM preprocessor
-<br>
-ccplus: 64x0/32x0 Optimized C++ compiler
-<br>
-bccl: 64x0/32x0 BCCL compiler
-<br>
-ld: mp-ux linker
-<br>
-masm: 64x0 mp-ux assembler
-<br>
 Author: Amlal El Mahrouss
 
 ##### Copyright 2024, Mahrouss Logic, all rights reserved.