Reset cache on script info change

Neko-Box-Coder · Neko-Box-Coder · commit c5545fb553b2 · 2024-09-23T22:15:28.000+01:00
diff --git a/DefaultYAMLs/DefaultScriptInfo.yaml b/DefaultYAMLs/DefaultScriptInfo.yaml
@@ -81,16 +81,18 @@
 #         # Properties for searching the library binary for the profile
 #         # You can also use "All" if all compilers use the same values
 #         "g++":
-#             # The library names to be searched for when linking against the script
+#             # The library names to be searched for when linking against the script. 
+#             # Binaries with linkable extension that contains one of the names will be linked
 #             SearchLibraryNames: ["MyLibrary"]
 #             
-#             # (Optional) The library names to be excluded from being searched
+#             # (Optional) The library names to be excluded from being searched.
+#             # Works the same as SearchLibraryNames but will NOT be linked instead
 #             ExcludeLibraryNames: []
 #             
 #             # The path (relative to the dependency folder) to be searched for the dependency binaries
 #             SearchDirectories: ["./build"]
 #             
-#             # (Optional) Additional link options for this dependency for each platform
+#             # (Optional) Additional link flags for this dependency for each platform
 #             AdditionalLinkOptions: 
 #                 All: []
 #     
diff --git a/Include/runcpp2/runcpp2.hpp b/Include/runcpp2/runcpp2.hpp
@@ -58,6 +58,8 @@ namespace runcpp2
                                     const std::string& configPreferredProfile,
                                     const std::unordered_map<CmdOptions, std::string> currentOptions,
                                     const std::vector<std::string>& runArgs,
+                                    const Data::ScriptInfo* lastScriptInfo,
+                                    Data::ScriptInfo& outScriptInfo,
                                     int& returnStatus);
 }
 
diff --git a/Src/runcpp2/main.cpp b/Src/runcpp2/main.cpp
@@ -321,6 +321,8 @@ int main(int argc, char* argv[])
         }
     }
     
+    runcpp2::Data::ScriptInfo parsedScriptInfo;
+    
     if(currentOptions.count(runcpp2::CmdOptions::WATCH))
     {
         std::error_code e;
@@ -331,19 +333,24 @@ int main(int argc, char* argv[])
         }
         
         ghc::filesystem::file_time_type lastScriptWriteTime {};
-        
         while(true)
         {
+            runcpp2::Data::ScriptInfo* lastParsedScriptInfo = nullptr;
+            
             if(ghc::filesystem::last_write_time(script, e) > lastScriptWriteTime)
             {
                 int result = 0;
     
+                
+    
                 runcpp2::PipelineResult pipelineResult = 
                     runcpp2::StartPipeline( script, 
                                             profiles, 
                                             preferredProfile, 
                                             currentOptions, 
                                             scriptArgs,
+                                            lastParsedScriptInfo,
+                                            parsedScriptInfo,
                                             result);
             
                 static_assert(static_cast<int>(runcpp2::PipelineResult::COUNT) == 12, "Update this");
@@ -366,10 +373,11 @@ int main(int argc, char* argv[])
                     case runcpp2::PipelineResult::RUN_SCRIPT_FAILED:
                         break;
                 }
-                ssLOG_BASE("Watching...");
+                ssLOG_BASE("No error. Watching...");
             }
             
             lastScriptWriteTime = ghc::filesystem::last_write_time(script, e);
+            lastParsedScriptInfo = &parsedScriptInfo;
             std::this_thread::sleep_for(std::chrono::seconds(5));
         }
     }
@@ -381,6 +389,8 @@ int main(int argc, char* argv[])
                                 preferredProfile, 
                                 currentOptions, 
                                 scriptArgs,
+                                nullptr,
+                                parsedScriptInfo,
                                 result) != runcpp2::PipelineResult::SUCCESS)
     {
         return -1;
diff --git a/Src/runcpp2/runcpp2.cpp b/Src/runcpp2/runcpp2.cpp
@@ -461,6 +461,8 @@ runcpp2::StartPipeline( const std::string& scriptPath,
                         const std::string& configPreferredProfile,
                         const std::unordered_map<CmdOptions, std::string> currentOptions,
                         const std::vector<std::string>& runArgs,
+                        const Data::ScriptInfo* lastScriptInfo,
+                        Data::ScriptInfo& outScriptInfo,
                         int& returnStatus)
 {
     INTERNAL_RUNCPP2_SAFE_START();
@@ -619,6 +621,42 @@ runcpp2::StartPipeline( const std::string& scriptPath,
                 return PipelineResult::INVALID_BUILD_DIR;
             }
         }
+        
+        //Check if script info has changed if provided
+        bool scriptInfoChanged = true;
+        {
+            ghc::filesystem::path lastScriptInfoFilePath = buildDir / "LastScriptInfo.yaml";
+            
+            //Compare script info in memory
+            if(lastScriptInfo != nullptr)
+                scriptInfoChanged = lastScriptInfo->ToString("") != scriptInfo.ToString("");
+            //Compare script info in disk
+            else
+            {
+                if(ghc::filesystem::exists(lastScriptInfoFilePath, e))
+                {
+                    ssLOG_DEBUG("Last script info file exists: " << lastScriptInfoFilePath);
+                    std::ifstream lastScriptInfoFile;
+                    lastScriptInfoFile.open(lastScriptInfoFilePath);
+                    std::stringstream lastScriptInfoBuffer;
+                    lastScriptInfoBuffer << lastScriptInfoFile.rdbuf();
+                    scriptInfoChanged = lastScriptInfoBuffer.str() != scriptInfo.ToString("");
+                }
+            }
+            
+            std::ofstream writeOutputFile(lastScriptInfoFilePath);
+            if(!writeOutputFile)
+            {
+                ssLOG_ERROR("Failed to open file: " << lastScriptInfoFilePath);
+                //TODO: Maybee add a pipeline result for this?
+                return PipelineResult::INVALID_BUILD_DIR;
+            }
+
+            writeOutputFile << scriptInfo.ToString("");
+            
+            //Pass the current script info out
+            outScriptInfo = scriptInfo;
+        }
 
         profileIndex = GetPreferredProfileIndex(absoluteScriptPath, 
                                                 scriptInfo, 
@@ -656,7 +694,8 @@ runcpp2::StartPipeline( const std::string& scriptPath,
             }
             
             if( currentOptions.count(CmdOptions::RESET_CACHE) > 0 ||
-                currentOptions.count(CmdOptions::REMOVE_DEPENDENCIES) > 0)
+                currentOptions.count(CmdOptions::REMOVE_DEPENDENCIES) > 0 ||
+                scriptInfoChanged)
             {
                 if(!CleanupDependencies(profiles.at(profileIndex),
                                         scriptInfo,
@@ -726,7 +765,7 @@ runcpp2::StartPipeline( const std::string& scriptPath,
         std::vector<ghc::filesystem::path> cachedObjectsFiles;
         ghc::filesystem::file_time_type finalObjectWriteTime;
         
-        if(currentOptions.count(runcpp2::CmdOptions::RESET_CACHE) > 0)
+        if(currentOptions.count(runcpp2::CmdOptions::RESET_CACHE) > 0 || scriptInfoChanged)
             sourceHasCache = std::vector<bool>(sourceFiles.size(), false);
         else if(!HasCompiledCache(  sourceFiles, 
                                     buildDir, 
@@ -782,8 +821,6 @@ runcpp2::StartPipeline( const std::string& scriptPath,
                 return PipelineResult::COMPILE_LINK_FAILED;
             }
         }
-        
-        //TODO: Write last compiled configuration to build directory for cache
     }
 
     //We are only compiling when watching changes
diff --git a/TODO.md b/TODO.md
@@ -1,8 +1,6 @@
 TODO:
-- Ability to add multiple cpp files
 - Group object files in folders to avoid name collision
 
-
 - Add ability to add defines for cross-compiler
 - Ability to compile runcpp2 as single cpp
 

Original file line number	Diff line number	Diff line change
`@@ -81,16 +81,18 @@`
`81`	`81`	`# # Properties for searching the library binary for the profile`
`82`	`82`	`# # You can also use "All" if all compilers use the same values`
`83`	`83`	`# "g++":`
`84`		`-# # The library names to be searched for when linking against the script`
	`84`	`+# # The library names to be searched for when linking against the script.`
	`85`	`+# # Binaries with linkable extension that contains one of the names will be linked`
`85`	`86`	`# SearchLibraryNames: ["MyLibrary"]`
`86`	`87`	`#`
`87`		`-# # (Optional) The library names to be excluded from being searched`
	`88`	`+# # (Optional) The library names to be excluded from being searched.`
	`89`	`+# # Works the same as SearchLibraryNames but will NOT be linked instead`
`88`	`90`	`# ExcludeLibraryNames: []`
`89`	`91`	`#`
`90`	`92`	`# # The path (relative to the dependency folder) to be searched for the dependency binaries`
`91`	`93`	`# SearchDirectories: ["./build"]`
`92`	`94`	`#`
`93`		`-# # (Optional) Additional link options for this dependency for each platform`
	`95`	`+# # (Optional) Additional link flags for this dependency for each platform`
`94`	`96`	`# AdditionalLinkOptions:`
`95`	`97`	`# All: []`
`96`	`98`	`#`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,8 @@ namespace runcpp2`
`58`	`58`	`const std::string& configPreferredProfile,`
`59`	`59`	`const std::unordered_map<CmdOptions, std::string> currentOptions,`
`60`	`60`	`const std::vector<std::string>& runArgs,`
	`61`	`+ const Data::ScriptInfo* lastScriptInfo,`
	`62`	`+ Data::ScriptInfo& outScriptInfo,`
`61`	`63`	`int& returnStatus);`
`62`	`64`	`}`
`63`	`65`
Original file line number	Diff line number	Diff line change
`@@ -321,6 +321,8 @@ int main(int argc, char* argv[])`
`321`	`321`	`}`
`322`	`322`	`}`
`323`	`323`
	`324`	`+ runcpp2::Data::ScriptInfo parsedScriptInfo;`
	`325`	`+`
`324`	`326`	`if(currentOptions.count(runcpp2::CmdOptions::WATCH))`
`325`	`327`	`{`
`326`	`328`	`std::error_code e;`
`@@ -331,19 +333,24 @@ int main(int argc, char* argv[])`
`331`	`333`	`}`
`332`	`334`
`333`	`335`	`ghc::filesystem::file_time_type lastScriptWriteTime {};`
`334`		`-`
`335`	`336`	`while(true)`
`336`	`337`	`{`
	`338`	`+ runcpp2::Data::ScriptInfo* lastParsedScriptInfo = nullptr;`
	`339`	`+`
`337`	`340`	`if(ghc::filesystem::last_write_time(script, e) > lastScriptWriteTime)`
`338`	`341`	`{`
`339`	`342`	`int result = 0;`
`340`	`343`
	`344`	`+`
	`345`	`+`
`341`	`346`	`runcpp2::PipelineResult pipelineResult =`
`342`	`347`	`runcpp2::StartPipeline( script,`
`343`	`348`	`profiles,`
`344`	`349`	`preferredProfile,`
`345`	`350`	`currentOptions,`
`346`	`351`	`scriptArgs,`
	`352`	`+ lastParsedScriptInfo,`
	`353`	`+ parsedScriptInfo,`
`347`	`354`	`result);`
`348`	`355`
`349`	`356`	`static_assert(static_cast<int>(runcpp2::PipelineResult::COUNT) == 12, "Update this");`
`@@ -366,10 +373,11 @@ int main(int argc, char* argv[])`
`366`	`373`	`case runcpp2::PipelineResult::RUN_SCRIPT_FAILED:`
`367`	`374`	`break;`
`368`	`375`	`}`
`369`		`- ssLOG_BASE("Watching...");`
	`376`	`+ ssLOG_BASE("No error. Watching...");`
`370`	`377`	`}`
`371`	`378`
`372`	`379`	`lastScriptWriteTime = ghc::filesystem::last_write_time(script, e);`
	`380`	`+ lastParsedScriptInfo = &parsedScriptInfo;`
`373`	`381`	`std::this_thread::sleep_for(std::chrono::seconds(5));`
`374`	`382`	`}`
`375`	`383`	`}`
`@@ -381,6 +389,8 @@ int main(int argc, char* argv[])`
`381`	`389`	`preferredProfile,`
`382`	`390`	`currentOptions,`
`383`	`391`	`scriptArgs,`
	`392`	`+ nullptr,`
	`393`	`+ parsedScriptInfo,`
`384`	`394`	`result) != runcpp2::PipelineResult::SUCCESS)`
`385`	`395`	`{`
`386`	`396`	`return -1;`