Rename PresetMan::FullModulePath to GetFullModulePath

MaximDude · MaximDude · commit 62bad41e0187 · 2023-06-03T13:02:23.000+03:00
Remove no longer necessary backslash correction
diff --git a/Activities/GAScripted.cpp b/Activities/GAScripted.cpp
@@ -114,7 +114,7 @@ int GAScripted::Create(const GAScripted &reference) {
 
 int GAScripted::ReadProperty(const std::string_view &propName, Reader &reader) {
 	if (propName == "ScriptPath") {
-		m_ScriptPath = CorrectBackslashesInPath(g_PresetMan.FullModulePath(CorrectBackslashesInPath(reader.ReadPropValue())));
+		m_ScriptPath = CorrectBackslashesInPath(reader.ReadPropValue());
 	} else if (propName == "LuaClassName") {
 		reader >> m_LuaClassName;
 	} else if (propName == "AddPieSlice") {
@@ -136,7 +136,7 @@ int GAScripted::ReadProperty(const std::string_view &propName, Reader &reader) {
 int GAScripted::Save(Writer &writer) const {
     // Call the script OnSave() function, if it exists
     g_LuaMan.RunScriptString("if " + m_LuaClassName + " and " + m_LuaClassName + ".OnSave then " + m_LuaClassName + ":OnSave(); end");
-    
+
     GameActivity::Save(writer);
 
 	writer.NewPropertyWithValue("ScriptPath", m_ScriptPath);
@@ -510,7 +510,7 @@ void GAScripted::Draw(BITMAP *pTargetBitmap, const Vector &targetPos) {
 
 void GAScripted::CollectRequiredAreas() {
     // Open the script file so we can check it out
-    std::ifstream *pScriptFile = new std::ifstream(g_PresetMan.FullModulePath(m_ScriptPath.c_str()));
+    std::ifstream *pScriptFile = new std::ifstream(g_PresetMan.GetFullModulePath(m_ScriptPath.c_str()));
     if (!pScriptFile->good()) {
         return;
     }
diff --git a/Entities/MovableObject.cpp b/Entities/MovableObject.cpp
@@ -334,8 +334,8 @@ int MovableObject::ReadProperty(const std::string_view &propName, Reader &reader
 	else if (propName == "HUDVisible")
 		reader >> m_HUDVisible;
 	else if (propName == "ScriptPath") {
-		std::string scriptPath = g_PresetMan.FullModulePath(CorrectBackslashesInPath(reader.ReadPropValue()));
-        switch (LoadScript(CorrectBackslashesInPath(scriptPath))) {
+		std::string scriptPath = g_PresetMan.GetFullModulePath(reader.ReadPropValue());
+        switch (LoadScript(scriptPath)) {
             case 0:
                 break;
             case -1:
@@ -490,7 +490,7 @@ int MovableObject::Save(Writer &writer) const
     writer << m_IgnoreTerrain;
     writer.NewProperty("SimUpdatesBetweenScriptedUpdates");
     writer << m_SimUpdatesBetweenScriptedUpdates;
-    
+
     return 0;
 }
 
@@ -687,7 +687,7 @@ MovableObject::MovableObject(const MovableObject &reference):
     m_AgeTimer(reference.GetAge()),
     m_Lifetime(reference.GetLifetime())
 {
-    
+
 }
 */
 
@@ -866,7 +866,7 @@ void MovableObject::PreTravel()
 
 void MovableObject::Travel()
 {
-    
+
 }
 
 
@@ -946,7 +946,7 @@ void MovableObject::Draw(BITMAP* targetBitmap, const Vector& targetPos, DrawMode
     if (mode == g_DrawMOID && m_MOID == g_NoMOID) {
         return;
     }
-    
+
     g_SceneMan.RegisterDrawing(targetBitmap, mode == g_DrawNoMOID ? g_NoMOID : m_MOID, m_Pos - targetPos, 1.0F);
 }
 
diff --git a/Entities/Scene.cpp b/Entities/Scene.cpp
@@ -1029,7 +1029,7 @@ int Scene::ExpandAIPlanAssemblySchemes()
 
 int Scene::SaveData(std::string pathBase)
 {
-    const std::string fullPathBase = g_PresetMan.FullModulePath(pathBase);
+    const std::string fullPathBase = g_PresetMan.GetFullModulePath(pathBase);
     if (fullPathBase.empty())
         return -1;
 
diff --git a/GUI/GUIControlManager.cpp b/GUI/GUIControlManager.cpp
@@ -405,7 +405,7 @@ bool GUIControlManager::Save(GUIWriter *W) {
 
 bool GUIControlManager::Load(const std::string &Filename, bool keepOld) {
 	GUIReader reader;
-	const std::string pathFile = g_PresetMan.FullModulePath(Filename);
+	const std::string pathFile = g_PresetMan.GetFullModulePath(Filename);
 	if (reader.Create(pathFile.c_str()) != 0) {
 		return false;
 	}
diff --git a/GUI/GUISkin.cpp b/GUI/GUISkin.cpp
@@ -39,10 +39,10 @@ bool GUISkin::Load(const std::string &directory, const std::string &fileName) {
 	Destroy();
 
 	if (!directory.empty()) {
-		m_Directory = g_PresetMan.FullModulePath(directory) + "/";
+		m_Directory = g_PresetMan.GetFullModulePath(directory) + "/";
 	} else {
 		// Empty directory means file can be loaded from anywhere in the working directory so need to figure out in what data directory the file actually is from fileName.
-		std::string fileFullPath = g_PresetMan.FullModulePath(fileName);
+		std::string fileFullPath = g_PresetMan.GetFullModulePath(fileName);
 		m_Directory = fileFullPath.substr(0, fileFullPath.find_first_of("/\\") + 1);
 	}
 
diff --git a/Lua/LuaBindingsManagers.cpp b/Lua/LuaBindingsManagers.cpp
@@ -204,7 +204,7 @@ namespace RTE {
 		.def("ReloadAllScripts", &PresetMan::ReloadAllScripts)
 		.def("IsModuleOfficial", &PresetMan::IsModuleOfficial)
 		.def("IsModuleUserdata", &PresetMan::IsModuleUserdata)
-		.def("FullModulePath", &PresetMan::FullModulePath);
+		.def("GetFullModulePath", &PresetMan::GetFullModulePath);
 	}
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
diff --git a/Managers/ActivityMan.cpp b/Managers/ActivityMan.cpp
@@ -103,7 +103,7 @@ namespace RTE {
 		modifiableScene->GetTerrain()->MigrateToModule(g_PresetMan.GetModuleID(c_UserScriptedSavesModuleName));
 
 		// Block the main thread for a bit to let the Writer access the relevant data.
-		std::unique_ptr<Writer> writer(std::make_unique<Writer>(g_PresetMan.FullModulePath(c_UserScriptedSavesModuleName) + "/" + fileName + ".ini"));
+		std::unique_ptr<Writer> writer(std::make_unique<Writer>(g_PresetMan.GetFullModulePath(c_UserScriptedSavesModuleName) + "/" + fileName + ".ini"));
 		writer->NewPropertyWithValue("Activity", activity);
 
 		// Pull all stuff from MovableMan into the Scene for saving, so existing Actors/ADoors are saved, without transferring ownership, so the game can continue.
@@ -144,7 +144,7 @@ namespace RTE {
 		std::unique_ptr<Scene> scene(std::make_unique<Scene>());
 		std::unique_ptr<GAScripted> activity(std::make_unique<GAScripted>());
 
-		Reader reader(g_PresetMan.FullModulePath(c_UserScriptedSavesModuleName) + "/" + fileName + ".ini", true, nullptr, false);
+		Reader reader(g_PresetMan.GetFullModulePath(c_UserScriptedSavesModuleName) + "/" + fileName + ".ini", true, nullptr, false);
 		if (!reader.ReaderOK()) {
 			g_ConsoleMan.PrintString("ERROR: Game loading failed! Make sure you have a saved game called \"" + fileName + "\"");
 			return false;
diff --git a/Managers/AudioMan.cpp b/Managers/AudioMan.cpp
@@ -286,7 +286,7 @@ namespace RTE {
 
     void AudioMan::PlayMusic(const char *filePath, int loops, float volumeOverrideIfNotMuted) {
 		if (m_AudioEnabled) {
-			const std::string fullFilePath = g_PresetMan.FullModulePath(filePath);
+			const std::string fullFilePath = g_PresetMan.GetFullModulePath(filePath);
 			if (m_IsInMultiplayerMode) {
 				RegisterMusicEvent(-1, NetworkMusicState::MUSIC_PLAY, fullFilePath.c_str(), loops);
 			}
diff --git a/Managers/FrameMan.cpp b/Managers/FrameMan.cpp
@@ -473,7 +473,7 @@ namespace RTE {
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	bool FrameMan::LoadPalette(const std::string &palettePath) {
-		const std::string fullPalettePath = g_PresetMan.FullModulePath(palettePath);
+		const std::string fullPalettePath = g_PresetMan.GetFullModulePath(palettePath);
 		BITMAP *tempBitmap = load_bitmap(fullPalettePath.c_str(), m_Palette);
 		RTEAssert(tempBitmap, ("Failed to load palette from bitmap with following path:\n\n" + fullPalettePath).c_str());
 
diff --git a/Managers/LuaMan.cpp b/Managers/LuaMan.cpp
@@ -214,7 +214,7 @@ namespace RTE {
 			"math.random = function(lower, upper) if lower ~= nil and upper ~= nil then return SelectRand(lower, upper); elseif lower ~= nil then return SelectRand(1, lower); else return PosRand(); end end"
 			"\n"
 			// Override "dofile" to be able to account for Data/ or Mods/ directory.
-			"OriginalDoFile = dofile; dofile = function(filePath) filePath = PresetMan:FullModulePath(filePath); if filePath ~= '' then return OriginalDoFile(filePath); end end;"
+			"OriginalDoFile = dofile; dofile = function(filePath) filePath = PresetMan:GetFullModulePath(filePath); if filePath ~= '' then return OriginalDoFile(filePath); end end;"
 		);
 	}
 
@@ -360,7 +360,7 @@ namespace RTE {
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 	int LuaMan::RunScriptFile(const std::string &filePath, bool consoleErrors) {
-		const std::string fullScriptPath = g_PresetMan.FullModulePath(filePath);
+		const std::string fullScriptPath = g_PresetMan.GetFullModulePath(filePath);
 		if (fullScriptPath.empty()) {
 			m_LastError = "Can't run a script file with an empty filepath!";
 			return -1;
diff --git a/Managers/PresetMan.cpp b/Managers/PresetMan.cpp
@@ -351,7 +351,7 @@ bool PresetMan::IsModuleUserdata(std::string moduleName) const {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-std::string PresetMan::FullModulePath(const std::string &modulePath) {
+std::string PresetMan::GetFullModulePath(const std::string &modulePath) {
 	const std::string modulePathGeneric = std::filesystem::path(modulePath).generic_string();
 	const std::string pathTopDir = modulePathGeneric.substr(0, modulePathGeneric.find_first_of("/\\") + 1);
 	const std::string moduleName = GetModuleNameFromPath(modulePathGeneric);
diff --git a/Managers/PresetMan.h b/Managers/PresetMan.h
@@ -190,7 +190,7 @@ class PresetMan : public Singleton<PresetMan> {
     /// </summary>
     /// <param name="modulePath">The Path to be completed.</param>
     /// <returns>The complete path to the file, including Data/, Userdata/ or Mods/ based on whether or not it's part of an official module or userdata.</returns>
-    std::string FullModulePath(const std::string &modulePath);
+    std::string GetFullModulePath(const std::string &modulePath);
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Method:          GetTotalModuleCount
diff --git a/Menus/MetagameGUI.cpp b/Menus/MetagameGUI.cpp
@@ -1249,7 +1249,7 @@ bool MetagameGUI::LoadGame()
 
 bool MetagameGUI::SaveGame(std::string saveName, std::string savePath, bool resaveSceneData)
 {
-    const std::string fullSavePath = g_PresetMan.FullModulePath(savePath);
+    const std::string fullSavePath = g_PresetMan.GetFullModulePath(savePath);
     // If specified, first load all bitmap data of all Scenes in the current Metagame that have once saved em, so we can re-save them to the new files
     if (resaveSceneData)
         g_MetaMan.LoadSceneData();
diff --git a/System/ContentFile.cpp b/System/ContentFile.cpp
@@ -126,7 +126,7 @@ namespace RTE {
 			}
 		}
 		if (fetchFileInfo) {
-			std::string altDataPath = g_PresetMan.FullModulePath(m_DataPath);
+			std::string altDataPath = g_PresetMan.GetFullModulePath(m_DataPath);
 			FILE *imageFile = fopen(altDataPath.c_str(), "rb");
 			RTEAssert(imageFile, "Failed to open file prior to reading info of image file with following path and name:\n\n" + m_DataPath + "\n\nThe file may not exist or be corrupt.");
 
@@ -223,7 +223,7 @@ namespace RTE {
 		BITMAP *returnBitmap = nullptr;
 		const int bitDepth = conversionMode == COLORCONV_8_TO_32 ? BitDepths::ThirtyTwo : BitDepths::Eight;
 		std::string dataPathToLoad = dataPathToSpecificFrame.empty() ? m_DataPath : dataPathToSpecificFrame;
-		dataPathToLoad = g_PresetMan.FullModulePath(dataPathToLoad);
+		dataPathToLoad = g_PresetMan.GetFullModulePath(dataPathToLoad);
 
 		if (g_PresetMan.GetReloadEntityPresetCalledThisUpdate()) {
 			ReloadBitmap(dataPathToLoad, conversionMode);
@@ -260,8 +260,8 @@ namespace RTE {
 		if (m_DataPath.empty() || frameCount < 1) {
 			return;
 		}
-		const std::string dataPathToLoad = g_PresetMan.FullModulePath(m_DataPath);
-		const std::string dataPathWithoutExtensionToLoad = g_PresetMan.FullModulePath(m_DataPathWithoutExtension);
+		const std::string dataPathToLoad = g_PresetMan.GetFullModulePath(m_DataPath);
+		const std::string dataPathWithoutExtensionToLoad = g_PresetMan.GetFullModulePath(m_DataPathWithoutExtension);
 		vectorToFill.reserve(frameCount);
 
 		if (frameCount == 1) {
@@ -312,7 +312,7 @@ namespace RTE {
 		if (m_DataPath.empty() || !g_AudioMan.IsAudioEnabled()) {
 			return nullptr;
 		}
-		const std::string dataPathToLoad = g_PresetMan.FullModulePath(m_DataPath);
+		const std::string dataPathToLoad = g_PresetMan.GetFullModulePath(m_DataPath);
 
 		FMOD::Sound *returnSample = nullptr;
 
@@ -334,11 +334,11 @@ namespace RTE {
 		if (m_DataPath.empty() || !g_AudioMan.IsAudioEnabled()) {
 			return nullptr;
 		}
-		const std::string dataPathToLoad = g_PresetMan.FullModulePath(m_DataPath);
+		const std::string dataPathToLoad = g_PresetMan.GetFullModulePath(m_DataPath);
 		if (!System::PathExistsCaseSensitive(dataPathToLoad)) {
 			bool foundAltExtension = false;
 			for (const std::string &altFileExtension : c_SupportedAudioFormats) {
-				const std::string altDataPathToLoad = g_PresetMan.FullModulePath(m_DataPathWithoutExtension + altFileExtension);
+				const std::string altDataPathToLoad = g_PresetMan.GetFullModulePath(m_DataPathWithoutExtension + altFileExtension);
 				if (System::PathExistsCaseSensitive(altDataPathToLoad)) {
 					g_ConsoleMan.AddLoadWarningLogExtensionMismatchEntry(m_DataPath, m_FormattedReaderPosition, altFileExtension);
 					SetDataPath(altDataPathToLoad);
diff --git a/System/DataModule.cpp b/System/DataModule.cpp
@@ -43,8 +43,8 @@ namespace RTE {
 		if (progressCallback) { progressCallback(m_FileName + " " + static_cast<char>(-43) + " loading:", true); }
 
 		Reader reader;
-		std::string indexPath = g_PresetMan.FullModulePath(m_FileName + "/Index.ini");
-		std::string mergedIndexPath = g_PresetMan.FullModulePath(m_FileName + "/MergedIndex.ini");
+		std::string indexPath = g_PresetMan.GetFullModulePath(m_FileName + "/Index.ini");
+		std::string mergedIndexPath = g_PresetMan.GetFullModulePath(m_FileName + "/MergedIndex.ini");
 
 		// NOTE: This looks for the MergedIndex.ini generated by the index merger tool. The tool is mostly superseded by disabling loading visuals, but still provides some benefit.
 		if (std::filesystem::exists(mergedIndexPath)) { indexPath = mergedIndexPath; }
@@ -423,7 +423,7 @@ namespace RTE {
 
 	int DataModule::FindAndRead(const ProgressCallback &progressCallback) {
 		int result = 0;
-		const std::string directoryToScan = g_PresetMan.FullModulePath(m_FileName);
+		const std::string directoryToScan = g_PresetMan.GetFullModulePath(m_FileName);
 		for (const std::filesystem::directory_entry &directoryEntry : std::filesystem::directory_iterator(System::GetWorkingDirectory() + directoryToScan)) {
 			if (directoryEntry.path().extension() == ".ini" && directoryEntry.path().filename() != "Index.ini") {
 				Reader iniReader;
diff --git a/System/Reader.cpp b/System/Reader.cpp
@@ -35,10 +35,11 @@ namespace RTE {
 
 		if (m_NonModulePath) {
 			m_FilePath = std::filesystem::path(fileName).generic_string();
+			// Associate non-module paths with Base to prevent implosions when dealing with creating Entities.
 			m_DataModuleName = "Base.rte";
 			m_DataModuleID = 0;
 		} else {
-			m_FilePath = g_PresetMan.FullModulePath(std::filesystem::path(fileName).generic_string());
+			m_FilePath = g_PresetMan.GetFullModulePath(fileName);
 
 			// Extract the file name and module name from the path
 			m_FileName = m_FilePath.substr(m_FilePath.find_last_of("/\\") + 1);
@@ -300,7 +301,7 @@ namespace RTE {
 		if (m_ReportProgress) { m_ReportProgress(m_ReportTabs + m_FileName + " on line " + std::to_string(m_CurrentLine) + " includes:", false); }
 
 		// Get the file path from the current stream before pushing it into the StreamStack, otherwise we can't open a new stream after releasing it because we can't read.
-		std::string includeFilePath = g_PresetMan.FullModulePath(std::filesystem::path(ReadPropValue()).generic_string());
+		std::string includeFilePath = g_PresetMan.GetFullModulePath(ReadPropValue());
 
 		// Push the current stream onto the StreamStack for future retrieval when the new include file has run out of data.
 		m_StreamStack.push(StreamInfo(m_Stream.release(), m_FilePath, m_CurrentLine, m_PreviousIndent));

Original file line number	Diff line number	Diff line change
`@@ -334,8 +334,8 @@ int MovableObject::ReadProperty(const std::string_view &propName, Reader &reader`
`334`	`334`	`else if (propName == "HUDVisible")`
`335`	`335`	`reader >> m_HUDVisible;`
`336`	`336`	`else if (propName == "ScriptPath") {`
`337`		`- std::string scriptPath = g_PresetMan.FullModulePath(CorrectBackslashesInPath(reader.ReadPropValue()));`
`338`		`- switch (LoadScript(CorrectBackslashesInPath(scriptPath))) {`
	`337`	`+ std::string scriptPath = g_PresetMan.GetFullModulePath(reader.ReadPropValue());`
	`338`	`+ switch (LoadScript(scriptPath)) {`
`339`	`339`	`case 0:`
`340`	`340`	`break;`
`341`	`341`	`case -1:`
`@@ -490,7 +490,7 @@ int MovableObject::Save(Writer &writer) const`
`490`	`490`	`writer << m_IgnoreTerrain;`
`491`	`491`	`writer.NewProperty("SimUpdatesBetweenScriptedUpdates");`
`492`	`492`	`writer << m_SimUpdatesBetweenScriptedUpdates;`
`493`		`-`
	`493`	`+`
`494`	`494`	`return 0;`
`495`	`495`	`}`
`496`	`496`
`@@ -687,7 +687,7 @@ MovableObject::MovableObject(const MovableObject &reference):`
`687`	`687`	`m_AgeTimer(reference.GetAge()),`
`688`	`688`	`m_Lifetime(reference.GetLifetime())`
`689`	`689`	`{`
`690`		`-`
	`690`	`+`
`691`	`691`	`}`
`692`	`692`	`*/`
`693`	`693`
`@@ -866,7 +866,7 @@ void MovableObject::PreTravel()`
`866`	`866`
`867`	`867`	`void MovableObject::Travel()`
`868`	`868`	`{`
`869`		`-`
	`869`	`+`
`870`	`870`	`}`
`871`	`871`
`872`	`872`
`@@ -946,7 +946,7 @@ void MovableObject::Draw(BITMAP* targetBitmap, const Vector& targetPos, DrawMode`
`946`	`946`	`if (mode == g_DrawMOID && m_MOID == g_NoMOID) {`
`947`	`947`	`return;`
`948`	`948`	`}`
`949`		`-`
	`949`	`+`
`950`	`950`	`g_SceneMan.RegisterDrawing(targetBitmap, mode == g_DrawNoMOID ? g_NoMOID : m_MOID, m_Pos - targetPos, 1.0F);`
`951`	`951`	`}`
`952`	`952`
Original file line number	Diff line number	Diff line change
`@@ -1029,7 +1029,7 @@ int Scene::ExpandAIPlanAssemblySchemes()`
`1029`	`1029`
`1030`	`1030`	`int Scene::SaveData(std::string pathBase)`
`1031`	`1031`	`{`
`1032`		`- const std::string fullPathBase = g_PresetMan.FullModulePath(pathBase);`
	`1032`	`+ const std::string fullPathBase = g_PresetMan.GetFullModulePath(pathBase);`
`1033`	`1033`	`if (fullPathBase.empty())`
`1034`	`1034`	`return -1;`
`1035`	`1035`
Original file line number	Diff line number	Diff line change
`@@ -405,7 +405,7 @@ bool GUIControlManager::Save(GUIWriter *W) {`
`405`	`405`
`406`	`406`	`bool GUIControlManager::Load(const std::string &Filename, bool keepOld) {`
`407`	`407`	`GUIReader reader;`
`408`		`- const std::string pathFile = g_PresetMan.FullModulePath(Filename);`
	`408`	`+ const std::string pathFile = g_PresetMan.GetFullModulePath(Filename);`
`409`	`409`	`if (reader.Create(pathFile.c_str()) != 0) {`
`410`	`410`	`return false;`
`411`	`411`	`}`
Original file line number	Diff line number	Diff line change
`@@ -204,7 +204,7 @@ namespace RTE {`
`204`	`204`	`.def("ReloadAllScripts", &PresetMan::ReloadAllScripts)`
`205`	`205`	`.def("IsModuleOfficial", &PresetMan::IsModuleOfficial)`
`206`	`206`	`.def("IsModuleUserdata", &PresetMan::IsModuleUserdata)`
`207`		`- .def("FullModulePath", &PresetMan::FullModulePath);`
	`207`	`+ .def("GetFullModulePath", &PresetMan::GetFullModulePath);`
`208`	`208`	`}`
`209`	`209`
`210`	`210`	`/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////`
Original file line number	Diff line number	Diff line change
`@@ -286,7 +286,7 @@ namespace RTE {`
`286`	`286`
`287`	`287`	`void AudioMan::PlayMusic(const char *filePath, int loops, float volumeOverrideIfNotMuted) {`
`288`	`288`	`if (m_AudioEnabled) {`
`289`		`- const std::string fullFilePath = g_PresetMan.FullModulePath(filePath);`
	`289`	`+ const std::string fullFilePath = g_PresetMan.GetFullModulePath(filePath);`
`290`	`290`	`if (m_IsInMultiplayerMode) {`
`291`	`291`	`RegisterMusicEvent(-1, NetworkMusicState::MUSIC_PLAY, fullFilePath.c_str(), loops);`
`292`	`292`	`}`