Merge pull request #58 from Neko-Box-Coder/SourceFilesRename

Renaming OtherFilesToBeCompiled to SourceFiles for yaml & misc changes

Author: Neko-Box-Coder

DefaultYAMLs/DefaultScriptInfo.yaml

@@ -64,7 +64,7 @@ OverrideLinkFlags:
             Append: ""
 
 # (Optional) Other source files (relative to script file path) to be compiled.
-OtherFilesToBeCompiled:
+SourceFiles:
     # Target Platform
     DefaultPlatform:
         # Target Profile

Examples/InteractiveTutorial.cpp

@@ -565,7 +565,8 @@ bool Chapter2_BuildConfig()
 
     DELAYED_OUTPUT("");
     DELAYED_OUTPUT("A common build config is to specify other source files.");
-    DELAYED_OUTPUT("This can be done by adding the paths to the `OtherFilesToBeCompiled` field.");
+    DELAYED_OUTPUT("This can be done by adding the paths to the `SourceFiles` field.");
+    DELAYED_OUTPUT("The script file is implicitly added to this field so you don't need to specify it.");
     DELAYED_OUTPUT("Let me add a second C++ file (\"tutorial/Hello.cpp\").");
     DELAYED_OUTPUT("Press enter to continue...");
     GetInput(true);
@@ -596,33 +597,7 @@ void CallHello();
         WriteFile("tutorial/Hello.hpp", fileContent);
     }
 
-    DELAYED_OUTPUT("Turns out I still need to edit tutorial/main.cpp to call the function.");
-    DELAYED_OUTPUT("Let me do that now.");
-    DELAYED_OUTPUT("Press enter to continue...");
-    GetInput(true);
-    
-    {
-        std::string fileContent = ReadFile("tutorial/main.cpp");
-        if(fileContent.empty())
-        {
-            ssLOG_ERROR("Failed to read tutorial/main.cpp");
-            return false;
-        }
-
-        size_t returnPos = fileContent.find("return 0;");
-        if(returnPos == std::string::npos)
-        {
-            ssLOG_ERROR("Failed to find return 0; in tutorial/main.cpp");
-            return false;
-        }
-        fileContent.replace(returnPos, 
-                            std::string("return 0;").size(),
-                            "CallHello();\n    return 0;");
-
-        WriteFile("tutorial/main.cpp", std::string("#include \"Hello.hpp\"\n") + fileContent);
-    }
-
-    DELAYED_OUTPUT("Now let me add the second C++ file to `OtherFilesToBeCompiled` in the YAML file.");
+    DELAYED_OUTPUT("Now let me add the second C++ file to `SourceFiles` in the tutorial/main.yaml file.");
     DELAYED_OUTPUT("Press enter to continue...");
     GetInput(true);
 
@@ -631,15 +606,15 @@ void CallHello();
     DefaultPlatform:
         DefaultProfile: ["WORLD=42"]
 
-OtherFilesToBeCompiled:
+SourceFiles:
     DefaultPlatform:
         DefaultProfile: ["./Hello.cpp"]
 )";
 
         WriteFile("tutorial/main.yaml", yamlContent);
     }
 
-    DELAYED_OUTPUT("The path to the other file is always **relative to the script file**.");
+    DELAYED_OUTPUT("The paths to the files are always __relative to the script file__.");
     DELAYED_OUTPUT("You can also add include paths for the script to the `IncludePaths` field");
     DELAYED_OUTPUT("Although unnecessary in this case, let me add \"./\" to the include paths.");
     DELAYED_OUTPUT("Press enter to continue...");
@@ -650,7 +625,7 @@ void CallHello();
     DefaultPlatform:
         DefaultProfile: ["WORLD=42"]
 
-OtherFilesToBeCompiled:
+SourceFiles:
     DefaultPlatform:
         DefaultProfile: ["./Hello.cpp"]
 
@@ -662,23 +637,49 @@ void CallHello();
         WriteFile("tutorial/main.yaml", yamlContent);
     }
 
+    DELAYED_OUTPUT("Turns out, I still need to edit tutorial/main.cpp to call the function.");
+    DELAYED_OUTPUT("Let me do that now.");
+    DELAYED_OUTPUT("Press enter to continue...");
+    GetInput(true);
+    
+    {
+        std::string fileContent = ReadFile("tutorial/main.cpp");
+        if(fileContent.empty())
+        {
+            ssLOG_ERROR("Failed to read tutorial/main.cpp");
+            return false;
+        }
+
+        size_t returnPos = fileContent.find("return 0;");
+        if(returnPos == std::string::npos)
+        {
+            ssLOG_ERROR("Failed to find return 0; in tutorial/main.cpp");
+            return false;
+        }
+        fileContent.replace(returnPos, 
+                            std::string("return 0;").size(),
+                            "CallHello();\n    return 0;");
+
+        WriteFile("tutorial/main.cpp", std::string("#include \"Hello.hpp\"\n") + fileContent);
+    }
+
     DELAYED_OUTPUT("Let's run the script again.");
     if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " main.cpp"))
         return false;
 
     DELAYED_OUTPUT("You should see the output `Hello from another C++ file`.");
     DELAYED_OUTPUT("");
 
-    DELAYED_OUTPUT( "If you **only** have a setting that applies to all platforms and profiles like "
+    DELAYED_OUTPUT( "If you **ONLY** have a setting that applies to all platforms and profiles like "
                     "what we have,");
     DELAYED_OUTPUT("you can specify the settings directly.");
-    DELAYED_OUTPUT("Let me update the YAML file and show you what I mean.");
+    DELAYED_OUTPUT("Let me update the tutorial/main.yaml file and show you what I mean.");
     DELAYED_OUTPUT("Press enter to continue...");
     GetInput(true);
 
     {
         const std::string yamlContent = R"(Defines: ["WORLD=42"]
-OtherFilesToBeCompiled: ["./Hello.cpp"]
+SourceFiles: ["./Hello.cpp"]
 IncludePaths: ["./"]
 )";
         WriteFile("tutorial/main.yaml", yamlContent);
@@ -700,7 +701,7 @@ IncludePaths: ["./"]
 
     {
         const std::string yamlContent = R"(Defines: ["WORLD=42"]
-OtherFilesToBeCompiled: ["./Hello.cpp"]
+SourceFiles: ["./Hello.cpp"]
 IncludePaths: ["./"]
 
 OverrideCompileFlags:
@@ -735,7 +736,7 @@ IncludePaths: ["./"]
 
     {
         const std::string yamlContent = R"(Defines: ["WORLD=42"]
-OtherFilesToBeCompiled: ["./Hello.cpp"]
+SourceFiles: ["./Hello.cpp"]
 IncludePaths: ["./"]
 )";
         WriteFile("tutorial/main.yaml", yamlContent);
@@ -798,7 +799,7 @@ bool Chapter3_ExternalDependencies()
     DELAYED_OUTPUT("Press enter to continue...");
     GetInput(true);
 
-    DELAYED_OUTPUT("A dependency must contain a \"Source\" to determine where it is.");
+    DELAYED_OUTPUT("A dependency must contain a \"Source\" to determine where it is from.");
     DELAYED_OUTPUT("In this case, it is coming from a \"Git\" repository.");
     DELAYED_OUTPUT( "If you have a git submodule, you can point it to a local directory with "
                     "\"Local\" instead of \"Git\"");
@@ -807,7 +808,7 @@ bool Chapter3_ExternalDependencies()
 
     DELAYED_OUTPUT( "Next, you have \"LibraryType\" which tells runcpp2 what type of dependency "
                     "this is. Other options include \"Static\", \"Object\" and \"Shared\"");
-    DELAYED_OUTPUT("That's pretty much it for a header only library. Let's run it shell we?");
+    DELAYED_OUTPUT("That's pretty much it for a header only library. Let's run it shall we?");
     if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " Logging.cpp"))
         return false;
 
@@ -997,7 +998,7 @@ bool Chapter3_ExternalDependencies()
             return false;
         }
 
-        DELAYED_OUTPUT("I have extracted the SDL2 dependency block to a standalone YAML file.");
+        DELAYED_OUTPUT("I have extracted the SDL2 dependency block to tutorial/SDL2.yaml file.");
         DELAYED_OUTPUT("Press enter to continue...");
         GetInput(true);
 

Src/Tests/Data/ScriptInfoTest.cpp

@@ -9,6 +9,8 @@ int main(int argc, char** argv)
 
     ssTEST_INIT_TEST_GROUP();
 
+    ssTEST_PARSE_ARGS(argc, argv);
+    
     ssTEST("ScriptInfo Should Parse Valid YAML")
     {
         ssTEST_OUTPUT_SETUP
@@ -274,6 +276,41 @@ int main(int argc, char** argv)
                                 scriptInfo.Equals(parsedOutput));
     };
 
+    ssTEST("ScriptInfo Should Parse SourceFiles as OtherFilesToBeCompiled")
+    {
+        ssTEST_OUTPUT_SETUP
+        (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
+            const char* yamlStr = R"(
+                SourceFiles:
+                    Windows:
+                        MSVC:
+                        -   src/extra.cpp
+                        -   src/debug.cpp
+            )";
+            
+            ryml::Tree tree = ryml::parse_in_arena(c4::to_csubstr(yamlStr));
+            ryml::ConstNodeRef root = tree.rootref();
+            runcpp2::Data::ScriptInfo scriptInfo;
+        );
+        
+        ssTEST_OUTPUT_EXECUTION
+        (
+            bool parseResult = scriptInfo.ParseYAML_Node(root);
+        );
+        
+        ssTEST_OUTPUT_ASSERT("ParseYAML_Node should succeed", parseResult);
+        
+        //Verify SourceFiles
+        ssTEST_OUTPUT_SETUP
+        (
+            const std::vector<ghc::filesystem::path>& msvcCompileFiles = 
+                scriptInfo.OtherFilesToBeCompiled.at("Windows").Paths.at("MSVC");
+        );
+        ssTEST_OUTPUT_ASSERT("MSVC files count", msvcCompileFiles.size() == 2);
+        ssTEST_OUTPUT_ASSERT("MSVC first file", msvcCompileFiles.at(0) == "src/extra.cpp");
+    };
+    
     ssTEST("ScriptInfo Should Parse Fields Without Platform And Profile As Default")
     {
         ssTEST_OUTPUT_SETUP

Src/runcpp2/Data/ScriptInfo.cpp

@@ -118,6 +118,14 @@ bool runcpp2::Data::ScriptInfo::ParseYAML_Node(ryml::ConstNodeRef node)
         return false;
     }
 
+    if(!ParsePlatformProfileMap<ProfilesProcessPaths>(  node, 
+                                                        "SourceFiles", 
+                                                        OtherFilesToBeCompiled, 
+                                                        "SourceFiles"))
+    {
+        return false;
+    }
+    
     if(!ParsePlatformProfileMap<ProfilesProcessPaths>(  node, 
                                                         "IncludePaths", 
                                                         IncludePaths, 
@@ -213,7 +221,7 @@ std::string runcpp2::Data::ScriptInfo::ToString(std::string indentation) const
 
     if(!OtherFilesToBeCompiled.empty())
     {
-        out += indentation + "OtherFilesToBeCompiled:\n";
+        out += indentation + "SourceFiles:\n";
         for(auto it = OtherFilesToBeCompiled.begin(); it != OtherFilesToBeCompiled.end(); ++it)
         {
             out += indentation + "    " + it->first + ":\n";

mkdocs/docs/TODO.md

@@ -5,6 +5,7 @@
 
 ### Nightly
 - Add version for default user config and prompt for update
+- Rename "OtherFilesToBeCompiled" to "SourceFiles"
 
 ### v0.3.1
 - Check last run is shared lib or executable. Reset cache when necessary if different type
@@ -35,7 +36,6 @@
 
 ## High Priority
 
-- Rename "OtherFilesToBeCompiled" to "SourceFiles"
 - Expose/rename "InternalExecutableShared" and change BuildType to be platform map
     - This ties to the warning in `CompilingLinking.cpp:619`
 - Update `FileProperties.hpp` to use list of string for prefix and extension

mkdocs/docs/build_settings.md

@@ -121,14 +121,14 @@
                 Remove: "-flagA -flagB"
                 Append: "-flagC -flagD"
     ```
-### `OtherFilesToBeCompiled`
+### `SourceFiles`
 - Type: `Platform Profile Map` with `list` of `string`
 - Optional: `true`
 - Default: None
-- Description: The source files to be compiled for each platform and profile.
+- Description: The source files to be compiled for each platform and profile. The script file is added implicitly
 ??? example
     ```yaml
-    OtherFilesToBeCompiled:
+    SourceFiles:
         DefaultPlatform:
             DefaultProfile:
             -   "./AnotherSourceFile.cpp"
@@ -532,7 +532,7 @@ OverrideLinkFlags:
             Append: ""
 
 # (Optional) Other source files (relative to script file path) to be compiled.
-OtherFilesToBeCompiled:
+SourceFiles:
     # Target Platform
     DefaultPlatform:
         # Target Profile

mkdocs/docs/guides/building_project_sources.md

@@ -72,7 +72,7 @@ Each setting supports two operations:
 
 ## Adding Source Files And Include Paths
 
-You can add additional source files and include paths using `OtherFilesToBeCompiled` and `IncludePaths`.
+You can add additional source files and include paths using `SourceFiles` and `IncludePaths`.
 All paths are relative to the script file's location.
 
 ???+ example
@@ -88,7 +88,7 @@ All paths are relative to the script file's location.
     ```
 
     ```yaml title="Build Settings"
-    OtherFilesToBeCompiled:
+    SourceFiles:
     -   "./src/utils.cpp"
     -   "./src/helper.cpp"
     IncludePaths:
@@ -98,7 +98,7 @@ All paths are relative to the script file's location.
 !!! note
     You can specify different source files for different platforms/profiles, same for IncludePaths:
     ```yaml
-    OtherFilesToBeCompiled:
+    SourceFiles:
         Windows:
             "msvc":
             -   "./src/windows_impl.cpp"
@@ -148,7 +148,7 @@ When building a project with a mixture of c and c++ files, the same profile will
         Language: "c"
         RequiredProfiles:
             DefaultPlatform: ["gcc"]
-        OtherFilesToBeCompiled:
+        SourceFiles:
         -   "./math.c"
         IncludePaths:
         -   "../include"