Merge pull request #12388 from neikeq/r

Buildsystem improvements for the Mono module

3 files changed, 98 insertions, 43 deletions

diff --git a/modules/mono/editor/GodotSharpTools/Build/BuildSystem.cs b/modules/mono/editor/GodotSharpTools/Build/BuildSystem.cs
index 5544233eb7..bdbef82aad 100644
--- a/modules/mono/editor/GodotSharpTools/Build/BuildSystem.cs
+++ b/modules/mono/editor/GodotSharpTools/Build/BuildSystem.cs
@@ -4,6 +4,7 @@ using System.Collections.Specialized;
 using System.Diagnostics;
 using System.IO;
 using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
 using System.Security;
 using Microsoft.Build.Framework;
 
@@ -12,24 +13,38 @@ namespace GodotSharpTools.Build
     public class BuildInstance : IDisposable
     {
         [MethodImpl(MethodImplOptions.InternalCall)]
-        internal extern static void godot_icall_BuildInstance_ExitCallback(string solution, string config, int exitCode);
+        private extern static void godot_icall_BuildInstance_ExitCallback(string solution, string config, int exitCode);
 
         [MethodImpl(MethodImplOptions.InternalCall)]
-        internal extern static string godot_icall_BuildInstance_get_MSBuildPath();
+        private extern static MSBuildInfo godot_icall_BuildInstance_get_MSBuildInfo();
 
-        private static string MSBuildPath
+        [StructLayout(LayoutKind.Sequential)]
+        private struct MSBuildInfo
         {
-            get
-            {
-                string ret = godot_icall_BuildInstance_get_MSBuildPath();
+            string path;
+            string frameworkPathOverride;
 
-                if (ret == null)
-                    throw new FileNotFoundException("Cannot find the MSBuild executable.");
+            public string MSBuildPath
+            {
+                get { return path; }
+            }
 
-                return ret;
+            public string FrameworkPathOverride
+            {
+                get { return frameworkPathOverride; }
             }
         }
 
+        private static MSBuildInfo GetMSBuildInfo()
+        {
+            MSBuildInfo ret = godot_icall_BuildInstance_get_MSBuildInfo();
+
+            if (ret.MSBuildPath == null)
+                throw new FileNotFoundException("Cannot find the MSBuild executable.");
+
+            return ret;
+        }
+
         private string solution;
         private string config;
 
@@ -48,9 +63,19 @@ namespace GodotSharpTools.Build
 
         public bool Build(string loggerAssemblyPath, string loggerOutputDir, string[] customProperties = null)
         {
-            string compilerArgs = BuildArguments(loggerAssemblyPath, loggerOutputDir, customProperties);
+            MSBuildInfo msbuildInfo = GetMSBuildInfo();
+
+            List<string> customPropertiesList = new List<string>();
+
+            if (customProperties != null)
+                customPropertiesList.AddRange(customProperties);
 
-            ProcessStartInfo startInfo = new ProcessStartInfo(MSBuildPath, compilerArgs);
+            if (msbuildInfo.FrameworkPathOverride.Length > 0)
+                customPropertiesList.Add("FrameworkPathOverride=" + msbuildInfo.FrameworkPathOverride);
+
+            string compilerArgs = BuildArguments(loggerAssemblyPath, loggerOutputDir, customPropertiesList);
+
+            ProcessStartInfo startInfo = new ProcessStartInfo(msbuildInfo.MSBuildPath, compilerArgs);
 
             // No console output, thanks
             startInfo.RedirectStandardOutput = true;
@@ -82,9 +107,19 @@ namespace GodotSharpTools.Build
             if (process != null)
                 throw new InvalidOperationException("Already in use");
 
-            string compilerArgs = BuildArguments(loggerAssemblyPath, loggerOutputDir, customProperties);
+            MSBuildInfo msbuildInfo = GetMSBuildInfo();
+
+            List<string> customPropertiesList = new List<string>();
+
+            if (customProperties != null)
+                customPropertiesList.AddRange(customProperties);
+
+            if (msbuildInfo.FrameworkPathOverride.Length > 0)
+                customPropertiesList.Add("FrameworkPathOverride=" + msbuildInfo.FrameworkPathOverride);
 
-            ProcessStartInfo startInfo = new ProcessStartInfo("msbuild", compilerArgs);
+            string compilerArgs = BuildArguments(loggerAssemblyPath, loggerOutputDir, customPropertiesList);
+
+            ProcessStartInfo startInfo = new ProcessStartInfo(msbuildInfo.MSBuildPath, compilerArgs);
 
             // No console output, thanks
             startInfo.RedirectStandardOutput = true;
@@ -101,10 +136,13 @@ namespace GodotSharpTools.Build
 
             process.Start();
 
+            process.BeginOutputReadLine();
+            process.BeginErrorReadLine();
+
             return true;
         }
 
-        private string BuildArguments(string loggerAssemblyPath, string loggerOutputDir, string[] customProperties)
+        private string BuildArguments(string loggerAssemblyPath, string loggerOutputDir, List<string> customProperties)
         {
             string arguments = string.Format(@"""{0}"" /v:normal /t:Build ""/p:{1}"" ""/l:{2},{3};{4}""",
                 solution,
@@ -114,12 +152,9 @@ namespace GodotSharpTools.Build
                 loggerOutputDir
             );
 
-            if (customProperties != null)
+            foreach (string customProperty in customProperties)
             {
-                foreach (string customProperty in customProperties)
-                {
-                    arguments += " /p:" + customProperty;
-                }
+                arguments += " \"/p:" + customProperty + "\"";
             }
 
             return arguments;
diff --git a/modules/mono/editor/godotsharp_builds.cpp b/modules/mono/editor/godotsharp_builds.cpp
index d3808769fb..c3b9c140e4 100644
--- a/modules/mono/editor/godotsharp_builds.cpp
+++ b/modules/mono/editor/godotsharp_builds.cpp
@@ -71,10 +71,15 @@ String _find_build_engine_on_unix(const String &p_name) {
 }
 #endif
 
-MonoString *godot_icall_BuildInstance_get_MSBuildPath() {
+MonoString **godot_icall_BuildInstance_get_MSBuildInfo() {
 
 	GodotSharpBuilds::BuildTool build_tool = GodotSharpBuilds::BuildTool(int(EditorSettings::get_singleton()->get("mono/builds/build_tool")));
 
+	MonoString *res[2] = {
+		NULL, // MSBuildPath
+		NULL // FrameworkPathOverride
+	};
+
 #if defined(WINDOWS_ENABLED)
 	switch (build_tool) {
 		case GodotSharpBuilds::MSBUILD: {
@@ -84,11 +89,17 @@ MonoString *godot_icall_BuildInstance_get_MSBuildPath() {
 				if (!msbuild_tools_path.ends_with("\\"))
 					msbuild_tools_path += "\\";
 
-				return GDMonoMarshal::mono_string_from_godot(msbuild_tools_path + "MSBuild.exe");
+				res[0] = GDMonoMarshal::mono_string_from_godot(msbuild_tools_path + "MSBuild.exe");
+
+				// FrameworkPathOverride
+				res[1] = GDMonoMarshal::mono_string_from_godot(GDMono::get_singleton()->get_mono_reg_info().assembly_dir);
+
+				return res;
 			}
 
-			OS::get_singleton()->print("Cannot find System's MSBuild. Trying with Mono's...\n");
-		}
+			if (OS::get_singleton()->is_stdout_verbose())
+				OS::get_singleton()->print("Cannot find System's MSBuild. Trying with Mono's...\n");
+		} // fall through
 		case GodotSharpBuilds::MSBUILD_MONO: {
 			String msbuild_path = GDMono::get_singleton()->get_mono_reg_info().bin_dir.plus_file("msbuild.bat");
 
@@ -96,17 +107,9 @@ MonoString *godot_icall_BuildInstance_get_MSBuildPath() {
 				WARN_PRINTS("Cannot find msbuild ('mono/builds/build_tool'). Tried with path: " + msbuild_path);
 			}
 
-			return GDMonoMarshal::mono_string_from_godot(msbuild_path);
-		}
-		case GodotSharpBuilds::XBUILD: {
-			String xbuild_path = GDMono::get_singleton()->get_mono_reg_info().bin_dir.plus_file("xbuild.bat");
-
-			if (!FileAccess::exists(xbuild_path)) {
-				WARN_PRINTS("Cannot find xbuild ('mono/builds/build_tool'). Tried with path: " + xbuild_path);
-			}
-
-			return GDMonoMarshal::mono_string_from_godot(xbuild_path);
-		}
+			res[0] = GDMonoMarshal::mono_string_from_godot(msbuild_path);
+			return res;
+		} break;
 		default:
 			ERR_EXPLAIN("You don't deserve to live");
 			CRASH_NOW();
@@ -118,25 +121,26 @@ MonoString *godot_icall_BuildInstance_get_MSBuildPath() {
 	if (build_tool != GodotSharpBuilds::XBUILD) {
 		if (msbuild_path.empty()) {
 			WARN_PRINT("Cannot find msbuild ('mono/builds/build_tool').");
-			return NULL;
+			return res;
 		}
 	} else {
 		if (xbuild_path.empty()) {
 			WARN_PRINT("Cannot find xbuild ('mono/builds/build_tool').");
-			return NULL;
+			return res;
 		}
 	}
 
-	return GDMonoMarshal::mono_string_from_godot(build_tool != GodotSharpBuilds::XBUILD ? msbuild_path : xbuild_path);
+	res[0] = GDMonoMarshal::mono_string_from_godot(build_tool != GodotSharpBuilds::XBUILD ? msbuild_path : xbuild_path);
+	return res;
 #else
-	return NULL;
+	return res;
 #endif
 }
 
 void GodotSharpBuilds::_register_internal_calls() {
 
 	mono_add_internal_call("GodotSharpTools.Build.BuildSystem::godot_icall_BuildInstance_ExitCallback", (void *)godot_icall_BuildInstance_ExitCallback);
-	mono_add_internal_call("GodotSharpTools.Build.BuildInstance::godot_icall_BuildInstance_get_MSBuildPath", (void *)godot_icall_BuildInstance_get_MSBuildPath);
+	mono_add_internal_call("GodotSharpTools.Build.BuildInstance::godot_icall_BuildInstance_get_MSBuildInfo", (void *)godot_icall_BuildInstance_get_MSBuildInfo);
 }
 
 void GodotSharpBuilds::show_build_error_dialog(const String &p_message) {
@@ -353,9 +357,22 @@ GodotSharpBuilds::GodotSharpBuilds() {
 	// Build tool settings
 	EditorSettings *ed_settings = EditorSettings::get_singleton();
 	if (!ed_settings->has_setting("mono/builds/build_tool")) {
-		ed_settings->set_setting("mono/builds/build_tool", MSBUILD);
+		ed_settings->set_setting("mono/builds/build_tool",
+#ifdef WINDOWS_ENABLED
+				// TODO: Default to MSBUILD_MONO if its csc.exe issue is fixed in the installed mono version
+				MSBUILD
+#else
+				MSBUILD_MONO
+#endif
+				);
 	}
-	ed_settings->add_property_hint(PropertyInfo(Variant::INT, "mono/builds/build_tool", PROPERTY_HINT_ENUM, "MSBuild (System),MSBuild (Mono),xbuild"));
+	ed_settings->add_property_hint(PropertyInfo(Variant::INT, "mono/builds/build_tool", PROPERTY_HINT_ENUM,
+#ifdef WINDOWS_ENABLED
+			"MSBuild (Mono),MSBuild (System)"
+#else
+			"MSBuild (Mono),xbuild (Deprecated)"
+#endif
+			));
 }
 
 GodotSharpBuilds::~GodotSharpBuilds() {
diff --git a/modules/mono/editor/godotsharp_builds.h b/modules/mono/editor/godotsharp_builds.h
index 6d5fa3b44a..3486f9f3e9 100644
--- a/modules/mono/editor/godotsharp_builds.h
+++ b/modules/mono/editor/godotsharp_builds.h
@@ -67,9 +67,12 @@ public:
 	};
 
 	enum BuildTool {
-		MSBUILD,
 		MSBUILD_MONO,
-		XBUILD
+#ifdef WINDOWS_ENABLED
+		MSBUILD
+#else
+		XBUILD // Deprecated
+#endif
 	};
 
 	_FORCE_INLINE_ static GodotSharpBuilds *get_singleton() { return singleton; }