3DSoftwareRenderer-DFSPR/Source/tools/builder/code/main.cpp


// Because it would be slow to check if the build system needs to be recompiled every time something uses it,
//   you must manually delete the build system's binary and try to build a project using it after making changes to the builder's source code.
//   Otherwise buildProject.sh will just see that an old version exists and use it.

// TODO:
//  * Give a warning when the given compiler path is not actually a path to a file and script generation is disabled.
//    Also make the compiler's path absolute from the current directory when called, or the specified folder to call from.
//  * Run multiple instances of the compiler at the same time on different CPU cores.
//  * Implement more features for the machine, such as:
//    * else and elseif cases.
//    * Temporarily letting the theoretical path go into another folder within a scope, similar to if statements but only affecting the path.
//      Like writing (cd path; stmt;) in Bash but with fast parsed Basic-like syntax.
//      The same stack used to store theoretical paths might be useful for else if cases to remember when the scope has already passed a case when not jumping with gotos.
//  * Create portable scripted events for pre-build and post-build, translated into both Batch and Bash.
//    Pre-build can be used to generate and transpile code before compiling.
//    Post-build should be used to execute the resulting program.
//      Optionally with variables from the build script as input arguments.

/*
Project files:
	Syntax:
		* Assign "10" to variable x:
			x = 10
		* Assign "1" to variable myVariable:
			myVariable
		* Assign b plus c to a:
			a = b + c
		* Assign b minus c to a:
			a = b - c
		* Assign b times c to a:
			a = b * c
		* Assign b divided by c to a:
			a = b / c
		* Concatenate "hello" and " world" into "hello world" in message:
			message = "hello" & " world"
		* If a is less than b or c equals 3 then assign y to z:
			if (a < b) or (c == 3)
				z = y
			end if
		* x is assigned a boolean value telling if the content of a matches "abc". (case sensitive comparison)
			x = a matches "abc"
	Commands:
		Finding source code for the current project:
			* Add file.cpp and other implementations found through includes into the list of source code to compile and link.
				Crawl "folder/file.cpp"
		Settings for compiling:
			* Add a compiler flag as is
				CompilerFlag -DMACRO
		Settings for linking:
			* Add a linker flag as is for direct control
				LinkerFlag -lLibrary
			* Add a linker flag with automatic prefix for future proofing
				Link Library
		Building other projects at the same time:
			* Build all projects in myFolder with the SkipIfBinaryExists flag in arbitrary order before continuing with compilation
				Build "../myFolder" SkipIfBinaryExists
		Building a project crawling from each file matching a pattern:
			All variables are inherited, so no variables are given to the command.
			* Build a project for each file ending with 'Test.cpp' in a folder named 'tests'.
				Projects from "*Test.cpp" in "tests"
			* Build a project for each file starting with 'main_' and ending with '.cpp' in a folder named "code/projects".
				Projects from "main_*.cpp" in "code/projects"
			* Build a project for each file named 'main.cpp' in a folder named "examples".
				Projects from "main_*.cpp" in "examples"
			* You can also swap argument order like this, because it is designed to be easily extended with more keywords if needed.
				Projects in "tests" from "*Test.cpp"
	Systems:
		* Linux
			Set to non-zero on Linux or similar operating systems.
		* Windows
			Set to non-zero on MS-Windows.
		* MacOS
			Set to non-zero on MacOS.
	Variables:
		* SkipIfBinaryExists, skips building if the binary already exists.
		* Supressed, prevents a compiled program from running after building, which is usually given as an extra argument to Build to avoid launching all programs in a row.
		* ProgramPath, a path to the application to create.
		* Compiler, a path or global alias to the compiler.
		* CompileFrom, from which path should the compiler be executed? Leave empty to use the current directory.
		* Debug, 0 for release, anything else (usually 1) for debug.
		* StaticRuntime, 0 for dynamic runtime linking, anything else (usually 1) for static runtime.
		* Optimization, a natural integer specifying the amount of optimization to apply.
*/

#include "../../../DFPSR/api/fileAPI.h"
#include "Machine.h"
#include "expression.h"
#include "analyzer.h"
#include "generator.h"

using namespace dsr;

ScriptLanguage identifyLanguage(const ReadableString &filename) {
	String scriptExtension = string_upperCase(file_getExtension(filename));
	if (string_match(scriptExtension, U"BAT")) {
		return ScriptLanguage::Batch;
	} else if (string_match(scriptExtension, U"SH")) {
		return ScriptLanguage::Bash;
	} else {
		return ScriptLanguage::Unknown;
	}
}

// Approximate syntax:
//   outputPath <- tempFolder | tempFolder/scriptName.sh | tempFolder\scriptName.bat
//   key <- SkipIfBinaryExists | Supressed | ProgramPath | Compiler | CompileFrom | Debug | StaticRuntime | Optimization | (a..z|A..Z)(0..9|a..z|A..Z)*
//   flag <- key | key=value
//   buildCall <- builderPath outputPath projectPath flag*
// Example uses:
//   Build Wizard.DsrProj for Linux using the g++ compiler by generating dfpsr_compile.sh and *.o objects in the /tmp folder.
//     ../builder/builder /tmp/dfpsr_compile.sh ./Wizard.DsrProj Compiler=g++ Linux
//   One can also just give the temporary folder to have the compiler called directly.
//     ../builder/builder /tmp ./Wizard.DsrProj Compiler=g++ Linux

DSR_MAIN_CALLER(dsrMain)
void dsrMain(List<String> args) {
	if (args.length() <= 1) {
		printText(U"No arguments given to Builder. Starting regression test.\n");
		expression_runRegressionTests();
	} else if (args.length() == 2) {
		printText(U"To use the DFPSR build system, pass a path to a script to generate, a project file or folder containing multiple projects, and the flags you want assigned before building.\n");
		printText(U"To run regression tests, don't pass any argument to the program.\n");
	} else {
		// Print the full command to show the caller if the arguments got messed up.
		printText(U"Build command:");
		for (int i = 0; i < args.length(); i++) {
			printText(U" ", args[i]);
		}
		printText(U"\n");
		// Get the script's destination path, or the temporary folder for all projects built during the session as the first argument.
		String outputPath = args[1];
		String scriptPath, tempFolder;
		ScriptLanguage language = ScriptLanguage::Unknown;
		if (file_getEntryType(outputPath) == EntryType::Folder) {
			printText(U"The output path is a folder.\n");
			// Not creating a script is useful if the operating system does not support any of the generated script languages.
			tempFolder = outputPath;
		} else {
			// Creating a script is useful for understanding what went wrong when building fails.
			language = identifyLanguage(outputPath);
			if (language == ScriptLanguage::Unknown) {
				printText(U"Could not identify the scripting language of \"", outputPath, U"\". Use *.bat, *.sh or just a temporary folder path to call the compiler directly.\n");
				return;
			}
			printText(U"The output path is a script file.\n");
			scriptPath = outputPath;
			tempFolder = file_getAbsoluteParentFolder(outputPath);
		}
		printText(U"Using ", tempFolder, U" as the temporary folder for compiled objects.\n");
		if (string_length(scriptPath) > 0) {
			printText(U"Using ", scriptPath, U" as the temporary script for calling the compiler.\n");
		} else {
			printText(U"No script path was given. The compiler will be called directly instead.\n");
		}
		// Get the project file's path, or a folder path containing all projects to build.
		String projectPath = args[2];
		String projectExtension = string_upperCase(file_getExtension(projectPath));
		if (string_match(projectExtension, U"DSRHEAD")) {
			printText(U"The path ", projectPath, U" does not refer to a project file. *.DsrHead is imported into projects to automate build configurations for users of a specific library.\n");
			return;
		} else if (!string_match(projectExtension, U"DSRPROJ")) {
			printText(U"The path ", projectPath, U" does not refer to a project file, because it does not have the *.DsrProj extension.\n");
			return;
		}
		// Read the reas after the project's path, as named integers assigned to ones.
		// Calling builder with the extra arguments will interpret them as variables and mark them as inherited, so that they are passed on to any other projects build from the project file.
		// Other values can be assigned using an equality sign.
		//   Avoid spaces around the equality sign, because quotes are already used for string arguments in assignments.
		Machine settings(file_getPathlessName(projectPath));
		argumentsToSettings(settings, args, 3, args.length() - 1);
		validateSettings(settings, U"in settings after getting application arguments (in main)");
		// Generate build instructions.
		String executableExtension;
		if (getFlagAsInteger(settings, U"Windows")) {
			executableExtension = U".exe";
		}
		SessionContext buildContext = SessionContext(tempFolder, executableExtension);
		buildFromFolder(buildContext, projectPath, settings);
		validateSettings(settings, U"in settings after executing the root build script (in main)");
		if (language == ScriptLanguage::Unknown) {
			// Call the compiler directly.
			executeBuildInstructions(buildContext);
		} else {
			// Generate a script to execute.
			generateCompilationScript(buildContext, scriptPath, language);
		}
	}
}