Add WIP Metadata system

This is going to be used for automatic documentation systems. By
keeping the documentation in the code, Cakelisp can be somewhat
self-documenting.

Author: makuto

Bootstrap.cake

@@ -18,6 +18,7 @@
  "ModuleManager.cpp"
  "Logging.cpp"
  "Build.cpp"
+ "Metadata.cpp"
  "Main.cpp")
 
 (add-build-options "-DUNIX" "-Wall" "-Werror" "-std=c++11")

Bootstrap_MSVC.cake

@@ -18,6 +18,7 @@
  "ModuleManager.cpp"
  "Logging.cpp"
  "Build.cpp"
+ "Metadata.cpp"
  "Main.cpp")
 
 (add-build-options "/nologo" "/DWINDOWS" "/DCAKELISP_EXPORTING" "/EHsc"

Build.bat

@@ -39,6 +39,7 @@ CL.exe src/Tokenizer.cpp ^
  src/ModuleManager.cpp ^
  src/Logging.cpp ^
  src/Build.cpp ^
+ src/Metadata.cpp ^
  src/Main.cpp ^
  /EHsc /MP /DWINDOWS /DCAKELISP_EXPORTING ^
  /Fe"bin\cakelisp_bootstrap" /Zi /Fd"bin\cakelisp_bootstrap.pdb" /DEBUG:FASTLINK

Build.sh

@@ -29,6 +29,7 @@ else
 		src/ModuleManager.cpp \
 		src/Logging.cpp \
 		src/Build.cpp \
+		src/Metadata.cpp \
 		src/Main.cpp \
 		-DUNIX || exit $?
 	# Need -ldl for dynamic loading, --export-dynamic to let compile-time functions resolve to

BuildAndRunTests.sh

@@ -3,4 +3,6 @@
 # Make sure Cakelisp is up to date
 . ./Build.sh || exit $?
 
+./bin/cakelisp --list-built-ins-details || exit $?
+
 ./bin/cakelisp runtime/Config_Linux.cake test/RunTests.cake || exit $?

Build_RunTests.bat

@@ -39,6 +39,7 @@ CL.exe src/Tokenizer.cpp ^
  src/ModuleManager.cpp ^
  src/Logging.cpp ^
  src/Build.cpp ^
+ src/Metadata.cpp ^
  src/Main.cpp ^
  /EHsc /MP /DWINDOWS /DCAKELISP_EXPORTING ^
  /Fe"bin\cakelisp_bootstrap" /Zi /Fd"bin\cakelisp_bootstrap.pdb" /DEBUG:FASTLINK

Build_SimpleMacros.bat

@@ -39,6 +39,7 @@ CL.exe src/Tokenizer.cpp ^
  src/ModuleManager.cpp ^
  src/Logging.cpp ^
  src/Build.cpp ^
+ src/Metadata.cpp ^
  src/Main.cpp ^
  /EHsc /MP /DWINDOWS /DCAKELISP_EXPORTING ^
  /Fe"bin\cakelisp_bootstrap" /Zi /Fd"bin\cakelisp_bootstrap.pdb" /DEBUG:FASTLINK

CrossCompile_Windows.cake

@@ -18,6 +18,7 @@
  "ModuleManager.cpp"
  "Logging.cpp"
  "Build.cpp"
+ "Metadata.cpp"
  "Main.cpp")
 
 (add-build-options "-DWINDOWS" "-DMINGW" "-DCAKELISP_EXPORTING")

VisualStudio/Cakelisp/Cakelisp.vcxproj

@@ -157,6 +157,7 @@
     <ClCompile Include="..\..\src\Generators.cpp" />
     <ClCompile Include="..\..\src\Logging.cpp" />
     <ClCompile Include="..\..\src\Main.cpp" />
+	<ClCompile Include="..\..\src\Metadata.cpp" />
     <ClCompile Include="..\..\src\ModuleManager.cpp" />
     <ClCompile Include="..\..\src\OutputPreambles.cpp" />
     <ClCompile Include="..\..\src\RunProcess.cpp" />
@@ -170,4 +171,4 @@
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">
   </ImportGroup>
-</Project>
+</Project>

VisualStudio/Cakelisp/Cakelisp.vcxproj.filters

@@ -103,6 +103,9 @@
     </ClCompile>
     <ClCompile Include="..\..\src\Logging.cpp">
       <Filter>Source Files</Filter>
+    </ClCompile>
+	<ClCompile Include="..\..\src\Metadata.cpp">
+      <Filter>Source Files</Filter>
     </ClCompile>
     <ClCompile Include="..\..\src\Main.cpp">
       <Filter>Source Files</Filter>
@@ -132,4 +135,4 @@
   <ItemGroup>
     <None Include="..\..\src\Jamfile" />
   </ItemGroup>
-</Project>
+</Project>

doc/Cakelisp.org

@@ -432,6 +432,7 @@ If ~global~ is specified instead, all modules and build dependencies would inclu
  "ModuleManager.cpp"
  "Logging.cpp"
  "Build.cpp"
+ "Metadata.cpp"
  "Main.cpp")
 #+END_SRC
 

src/Generators.cpp

@@ -2910,8 +2910,8 @@ bool CStatementGenerator(EvaluatorEnvironment& environment, const EvaluatorConte
 	    {"bit->>", bitwiseRightShift, ArraySize(bitwiseRightShift)},
 	    {"=", relationalEquality, ArraySize(relationalEquality)},
 	    {"!=", relationalNotEqual, ArraySize(relationalNotEqual)},
-	    {"eq", relationalEquality, ArraySize(relationalEquality)},
-	    {"neq", relationalNotEqual, ArraySize(relationalNotEqual)},
+	    // {"eq", relationalEquality, ArraySize(relationalEquality)},
+	    // {"neq", relationalNotEqual, ArraySize(relationalNotEqual)},
 	    {"<=", relationalLessThanEqual, ArraySize(relationalLessThanEqual)},
 	    {">=", relationalGreaterThanEqual, ArraySize(relationalGreaterThanEqual)},
 	    {"<", relationalLessThan, ArraySize(relationalLessThan)},
@@ -3085,7 +3085,7 @@ void importFundamentalGenerators(EvaluatorEnvironment& environment)
 	    // Bitwise
 	    "bit-or", "bit-and", "bit-xor", "bit-ones-complement", "bit-<<", "bit->>",
 	    // Relational
-	    "=", "!=", "eq", "neq", "<=", ">=", "<", ">",
+	    "=", "!=", /*"eq", "neq",*/ "<=", ">=", "<", ">",
 	    // Arithmetic
 	    "+", "-", "*", "/", "%", "mod", "++", "--", "incr", "decr"};
 	for (size_t i = 0; i < ArraySize(cStatementKeywords); ++i)

src/Main.cpp

@@ -4,7 +4,9 @@
 #include <vector>
 
 #include "FileUtilities.hpp"
+#include "Generators.hpp"
 #include "Logging.hpp"
+#include "Metadata.hpp"
 #include "ModuleManager.hpp"
 #include "RunProcess.hpp"
 #include "Utilities.hpp"
@@ -55,6 +57,7 @@ int main(int numArguments, char* arguments[])
 	bool executeOutput = false;
 	bool skipBuild = false;
 	bool listBuiltInGeneratorsThenQuit = false;
+	bool listBuiltInGeneratorMetadataThenQuit = false;
 	bool waitForDebugger = false;
 
 	const CommandLineOption options[] = {
@@ -70,6 +73,8 @@ int main(int numArguments, char* arguments[])
 	    {"--list-built-ins", &listBuiltInGeneratorsThenQuit,
 	     "List all built-in compile-time procedures, then exit. This list contains every procedure "
 	     "you can possibly call, until you import more or define your own"},
+	    {"--list-built-ins-details", &listBuiltInGeneratorMetadataThenQuit,
+	     "List all built-in compile-time procedures and a brief explanation of each, then exit."},
 	    {"--wait-for-debugger", &waitForDebugger,
 	     "Wait for a debugger to be attached before starting loading and evaluation"},
 	    // Logging
@@ -181,6 +186,15 @@ int main(int numArguments, char* arguments[])
 		Log("attached\n");
 	}
 
+	if (listBuiltInGeneratorMetadataThenQuit)
+	{
+		EvaluatorEnvironment environment;
+		importFundamentalGenerators(environment);
+		printBuiltInGeneratorMetadata(&environment);
+
+		return 0;
+	}
+
 	if (listBuiltInGeneratorsThenQuit)
 	{
 		listBuiltInGenerators();