Buildsystem improvements for the Mono module

- Make sure to search the mono installation directory for the right architecture in the windows registry.
- Do not build GodotSharpTools directly to #bin dir. Instead build to the default output path and copy it. This way we avoid MSBuild adding files we don't want to #bin.
- Add hint path for MSBuild in OSX.
- Copy shared library on Unix if not statically linking.
- Use vswhere to search MSBuild and search for 14.0 tools version in the registry instead of 4.0.
- SCons will only fallback xbuild when msbuild is not found if 'xbuild_fallback=yes' is passed to the command.
- Use mono's assembly path as FrameworkPathOverride if using with system's MSBuild (not mono's fork).
- Cleanup.

1 files changed, 110 insertions, 29 deletions

diff --git a/modules/mono/SCsub b/modules/mono/SCsub
index caf4fdb3ca..13212636e3 100644
--- a/modules/mono/SCsub
+++ b/modules/mono/SCsub
@@ -53,68 +53,149 @@ if env['tools']:
 
 vars = Variables()
 vars.Add(BoolVariable('mono_glue', 'Build with the mono glue sources', True))
+vars.Add(BoolVariable('xbuild_fallback', 'If MSBuild is not found, fallback to xbuild', False))
 vars.Update(env)
 
 # Glue sources
 if env['mono_glue']:
     env.add_source_files(env.modules_sources, 'glue/*.cpp')
 else:
-    env.Append(CPPDEFINES = [ 'MONO_GLUE_DISABLED' ])
+    env.Append(CPPDEFINES=['MONO_GLUE_DISABLED'])
 
 if ARGUMENTS.get('yolo_copy', False):
-    env.Append(CPPDEFINES = [ 'YOLO_COPY' ])
+    env.Append(CPPDEFINES=['YOLO_COPY'])
+
 
 # Build GodotSharpTools solution
 
+
 import os
-import subprocess
-import mono_reg_utils as monoreg
+
+
+def find_msbuild_unix(filename):
+    import os.path
+    import sys
+
+    hint_dirs = ['/opt/novell/mono/bin']
+    if sys.platform == "darwin":
+        hint_dirs = ['/Library/Frameworks/Mono.framework/Versions/Current/bin'] + hint_dirs
+
+    for hint_dir in hint_dirs:
+        hint_path = os.path.join(hint_dir, filename)
+        if os.path.isfile(hint_path):
+            return hint_path
+
+    for hint_dir in os.environ["PATH"].split(os.pathsep):
+        hint_dir = hint_dir.strip('"')
+        hint_path = os.path.join(hint_dir, filename)
+        if os.path.isfile(hint_path) and os.access(hint_path, os.X_OK):
+            return hint_path
+
+    return None
+
+
+def find_msbuild_windows():
+    import mono_reg_utils as monoreg
+
+    msbuild_tools_path = monoreg.find_msbuild_tools_path_reg()
+
+    if msbuild_tools_path:
+        return (os.path.join(msbuild_tools_path, 'MSBuild.exe'), '')
+    else:
+        bits = env['bits']
+
+        if bits == '32':
+            if os.getenv('MONO32_PREFIX'):
+                mono_root = os.getenv('MONO32_PREFIX')
+            else:
+                mono_root = monoreg.find_mono_root_dir(bits)
+        else:
+            if os.getenv('MONO64_PREFIX'):
+                mono_root = os.getenv('MONO64_PREFIX')
+            else:
+                mono_root = monoreg.find_mono_root_dir(bits)
+
+        if mono_root:
+            msbuild_mono = os.path.join(mono_root, 'bin', 'msbuild.bat')
+
+            if os.path.isfile(msbuild_mono):
+                return (msbuild_mono, os.path.join(mono_root, 'lib', 'mono', '4.5'))
+
+    return None
 
 
 def mono_build_solution(source, target, env):
+    import subprocess
+    import mono_reg_utils as monoreg
+    from shutil import copyfile
+
+    framework_path_override = ''
+
     if os.name == 'nt':
-        msbuild_tools_path = monoreg.find_msbuild_tools_path_reg()
-        if not msbuild_tools_path:
-            raise RuntimeError('Cannot find MSBuild Tools Path in the registry')
-        msbuild_path = os.path.join(msbuild_tools_path, 'MSBuild.exe')
+        msbuild_info = find_msbuild_windows()
+        if msbuild_info is None:
+            raise RuntimeError('Cannot find MSBuild executable')
+        msbuild_path = msbuild_windows[0]
+        framework_path_override = msbuild_windows[1]
     else:
-        msbuild_path = 'msbuild'
+        msbuild_path = find_msbuild_unix('msbuild')
+        if msbuild_path is None:
+            xbuild_fallback = env['xbuild_fallback']
+
+            if xbuild_fallback and os.name == 'nt':
+                print("Option 'xbuild_fallback' not supported on Windows")
+                xbuild_fallback = False
+
+            if xbuild_fallback:
+                print('Cannot find MSBuild executable, trying with xbuild')
+                print('Warning: xbuild is deprecated')
+
+                msbuild_path = find_msbuild_unix('xbuild')
+
+                if msbuild_path is None:
+                    raise RuntimeError('Cannot find xbuild executable')
+            else:
+                raise RuntimeError('Cannot find MSBuild executable')
+
+    print('MSBuild path: ' + msbuild_path)
 
-    output_path = os.path.abspath(os.path.join(str(target[0]), os.pardir))
+    build_config = 'Release'
 
     msbuild_args = [
         msbuild_path,
         os.path.abspath(str(source[0])),
-        '/p:Configuration=Release',
-        '/p:OutputPath=' + output_path
+        '/p:Configuration=' + build_config,
     ]
 
+    if framework_path_override:
+        msbuild_args += ['/p:FrameworkPathOverride=' + framework_path_override]
+
     msbuild_env = os.environ.copy()
 
     # Needed when running from Developer Command Prompt for VS
     if 'PLATFORM' in msbuild_env:
         del msbuild_env['PLATFORM']
 
-    msbuild_alt_paths = [ 'xbuild' ]
-
-    while True:
-        try:
-            subprocess.check_call(msbuild_args, env = msbuild_env)
-            break
-        except subprocess.CalledProcessError:
-            raise RuntimeError('GodotSharpTools build failed')
-        except OSError:
-            if os.name != 'nt':
-                if not msbuild_alt_paths:
-                    raise RuntimeError('Could not find commands msbuild or xbuild')
-                # Try xbuild
-                msbuild_args[0] = msbuild_alt_paths.pop(0)
-            else:
-                raise RuntimeError('Could not find command MSBuild.exe')
+    try:
+        subprocess.check_call(msbuild_args, env=msbuild_env)
+    except subprocess.CalledProcessError:
+        raise RuntimeError('GodotSharpTools build failed')
+
+    src_dir = os.path.abspath(os.path.join(str(source[0]), os.pardir, 'bin', build_config))
+    dst_dir = os.path.abspath(os.path.join(str(target[0]), os.pardir))
+
+    if not os.path.isdir(dst_dir):
+        if os.path.exists(dst_dir):
+            raise RuntimeError('Target directory is a file')
+        os.makedirs(dst_dir)
+
+    asm_file = 'GodotSharpTools.dll'
+
+    copyfile(os.path.join(src_dir, asm_file), os.path.join(dst_dir, asm_file))
 
 
 mono_sln_builder = Builder(action = mono_build_solution)
-env.Append(BUILDERS = { 'MonoBuildSolution' : mono_sln_builder })
+env.Append(BUILDERS={'MonoBuildSolution': mono_sln_builder})
 env.MonoBuildSolution(
     os.path.join(Dir('#bin').abspath, 'GodotSharpTools.dll'),
     'editor/GodotSharpTools/GodotSharpTools.sln'