Correct backslashes to forward slashes when reading and setting file paths

Author: MaximDude

Activities/GAScripted.cpp

@@ -107,9 +107,10 @@ int GAScripted::Create(const GAScripted &reference)
 
 int GAScripted::ReadProperty(std::string propName, Reader &reader)
 {
-    if (propName == "ScriptFile")
-        reader >> m_ScriptPath;
-    else if (propName == "LuaClassName")
+	if (propName == "ScriptFile") {
+		reader >> m_ScriptPath;
+		CorrectBackslashesInPaths(m_ScriptPath);
+	} else if (propName == "LuaClassName")
         reader >> m_LuaClassName;
 	else if (propName == "AddPieSlice")
 	{

Entities/GlobalScript.cpp

@@ -61,9 +61,10 @@ int GlobalScript::Create(const GlobalScript &reference)
 
 int GlobalScript::ReadProperty(std::string propName, Reader &reader)
 {
-    if (propName == "ScriptPath")
-        reader >> m_ScriptPath;
-    else if (propName == "LuaClassName")
+	if (propName == "ScriptPath") {
+		reader >> m_ScriptPath;
+		CorrectBackslashesInPaths(m_ScriptPath);
+	} else if (propName == "LuaClassName")
         reader >> m_LuaClassName;
 	else if (propName == "LateUpdate")
 		reader >> m_LateUpdate;

Entities/MovableObject.cpp

@@ -331,13 +331,11 @@ int MovableObject::ReadProperty(std::string propName, Reader &reader)
 		reader >> newSlice;
 		PieMenuGUI::AddAvailableSlice(newSlice);
 	}
-	else if (propName == "ScriptPath")
-    {
-        std::string scriptPath = reader.ReadPropValue();
-        if (LoadScript(scriptPath) == -2) { reader.ReportError("Duplicate script path " + scriptPath); }
-    }
-    else if (propName == "ScreenEffect")
-    {
+	else if (propName == "ScriptPath") {
+		std::string scriptPath = reader.ReadPropValue();
+		CorrectBackslashesInPaths(scriptPath);
+		if (LoadScript(scriptPath) == -2) { reader.ReportError("Duplicate script path " + scriptPath); }
+	} else if (propName == "ScreenEffect") {
         reader >> m_ScreenEffectFile;
         m_pScreenEffect = m_ScreenEffectFile.GetAsBitmap();
 		m_ScreenEffectHash = m_ScreenEffectFile.GetHash();

Menus/PieMenuGUI.cpp

@@ -191,9 +191,10 @@ int PieMenuGUI::Slice::ReadProperty(std::string propName, Reader &reader)
         reader >> m_Icon;
     else if (propName == "Direction")
         reader >> m_Direction;
-    else if (propName == "ScriptPath")
-        reader >> m_ScriptPath;
-    else if (propName == "FunctionName")
+	else if (propName == "ScriptPath") {
+		reader >> m_ScriptPath;
+		CorrectBackslashesInPaths(m_ScriptPath);
+	} else if (propName == "FunctionName")
         reader >> m_FunctionName;
     else
         return Serializable::ReadProperty(propName, reader);

System/ContentFile.cpp

@@ -83,7 +83,9 @@ namespace RTE {
 
 	void ContentFile::SetDataPath(const std::string &newDataPath) {
 		m_DataPath = newDataPath;
-		m_DataPathExtension = std::filesystem::path(newDataPath).extension().string();
+		CorrectBackslashesInPaths(m_DataPath);
+
+		m_DataPathExtension = std::filesystem::path(m_DataPath).extension().string();
 
 		RTEAssert(!m_DataPathExtension.empty(), "Failed to find file extension when trying to find file with path and name:\n\n" + m_DataPath + "\n" + GetFormattedReaderPosition());
 

System/Serializable.h

@@ -94,6 +94,17 @@ namespace RTE {
 		/// <param name="writer">A Writer that the Serializable will save itself to.</param>
 		/// <returns>An error return value signaling success or any particular failure. Anything below 0 is an error signal.</returns>
 		virtual int Save(Writer &writer) const { writer.ObjectStart(GetClassName()); return 0; }
+
+		/// <summary>
+		/// Replaces backslashes with forward slashes in file paths to eliminate issues with cross-platform compatibility or invalid escape sequences.
+		/// </summary>
+		/// <param name="pathToCorrect">Reference to the file path string to correct slashes in.</param>
+		void CorrectBackslashesInPaths(std::string &pathToCorrect) const {
+			// TODO: Add a warning log entry if backslashes are found in a data path. Perhaps overwrite them in the ini file itself.
+			while (std::find(pathToCorrect.begin(), pathToCorrect.end(), '\\') != pathToCorrect.end()) {
+				pathToCorrect.replace(pathToCorrect.find("\\"), 1, "/");
+			}
+		}
 #pragma endregion
 
 #pragma region Logging