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, 73 insertions, 19 deletions

diff --git a/modules/mono/mono_reg_utils.py b/modules/mono/mono_reg_utils.py
index e9988625f5..22c4aeaf4c 100644
--- a/modules/mono/mono_reg_utils.py
+++ b/modules/mono/mono_reg_utils.py
@@ -1,4 +1,5 @@
 import os
+import platform
 
 if os.name == 'nt':
     import sys
@@ -11,8 +12,7 @@ if os.name == 'nt':
 def _reg_open_key(key, subkey):
     try:
         return winreg.OpenKey(key, subkey)
-    except (WindowsError, EnvironmentError) as e:
-        import platform
+    except WindowsError, OSError:
         if platform.architecture()[0] == '32bit':
             bitness_sam = winreg.KEY_WOW64_64KEY
         else:
@@ -20,39 +20,93 @@ def _reg_open_key(key, subkey):
         return winreg.OpenKey(key, subkey, 0, winreg.KEY_READ | bitness_sam)
 
 
-def _find_mono_in_reg(subkey):
+def _reg_open_key_bits(key, subkey, bits):
+    sam = winreg.KEY_READ
+
+    if platform.architecture()[0] == '32bit':
+        if bits == '64':
+            # Force 32bit process to search in 64bit registry
+            sam |= winreg.KEY_WOW64_64KEY
+    else:
+        if bits == '32':
+            # Force 64bit process to search in 32bit registry
+            sam |= winreg.KEY_WOW64_32KEY
+
+    return winreg.OpenKey(key, subkey, 0, sam)
+
+
+def _find_mono_in_reg(subkey, bits):
     try:
-        with _reg_open_key(winreg.HKEY_LOCAL_MACHINE, subkey) as hKey:
+        with _reg_open_key_bits(winreg.HKEY_LOCAL_MACHINE, subkey, bits) as hKey:
             value, regtype = winreg.QueryValueEx(hKey, 'SdkInstallRoot')
             return value
-    except (WindowsError, EnvironmentError) as e:
+    except WindowsError, OSError:
         return None
 
-def _find_mono_in_reg_old(subkey):
+
+def _find_mono_in_reg_old(subkey, bits):
     try:
-        with _reg_open_key(winreg.HKEY_LOCAL_MACHINE, subkey) as hKey:
+        with _reg_open_key_bits(winreg.HKEY_LOCAL_MACHINE, subkey, bits) as hKey:
             default_clr, regtype = winreg.QueryValueEx(hKey, 'DefaultCLR')
             if default_clr:
-                return _find_mono_in_reg(subkey + '\\' + default_clr)
+                return _find_mono_in_reg(subkey + '\\' + default_clr, bits)
             return None
     except (WindowsError, EnvironmentError):
         return None
 
 
-def find_mono_root_dir():
-    dir = _find_mono_in_reg(r'SOFTWARE\Mono')
-    if dir:
-        return dir
-    dir = _find_mono_in_reg_old(r'SOFTWARE\Novell\Mono')
-    if dir:
-        return dir
-    return None
+def find_mono_root_dir(bits):
+    root_dir = _find_mono_in_reg(r'SOFTWARE\Mono', bits)
+    if root_dir is not None:
+        return root_dir
+    root_dir = _find_mono_in_reg_old(r'SOFTWARE\Novell\Mono', bits)
+    if root_dir is not None:
+        return root_dir
+    return ''
 
 
 def find_msbuild_tools_path_reg():
+    import subprocess
+
+    vswhere = os.getenv('PROGRAMFILES(X86)')
+    if not vswhere:
+        vswhere = os.getenv('PROGRAMFILES')
+    vswhere += r'\Microsoft Visual Studio\Installer\vswhere.exe'
+
+    vswhere_args = ['-latest', '-requires', 'Microsoft.Component.MSBuild']
+
     try:
-        with _reg_open_key(winreg.HKEY_LOCAL_MACHINE, r'SOFTWARE\Microsoft\MSBuild\ToolsVersions\4.0') as hKey:
+        lines = subprocess.check_output([vswhere] + vswhere_args).splitlines()
+
+        for line in lines:
+            parts = line.split(':', 1)
+
+            if len(parts) < 2 or parts[0] != 'installationPath':
+                continue
+
+            val = parts[1].strip()
+
+            if not val:
+                raise ValueError('Value of `installationPath` entry is empty')
+
+            return os.path.join(val, "MSBuild\\15.0\\Bin")
+
+        raise ValueError('Cannot find `installationPath` entry')
+    except ValueError as e:
+        print('Error reading output from vswhere: ' + e.message)
+    except WindowsError:
+        pass # Fine, vswhere not found
+    except subprocess.CalledProcessError, OSError:
+        pass
+
+    # Try to find 14.0 in the Registry
+
+    try:
+        subkey = r'SOFTWARE\Microsoft\MSBuild\ToolsVersions\14.0'
+        with _reg_open_key(winreg.HKEY_LOCAL_MACHINE, subkey) as hKey:
             value, regtype = winreg.QueryValueEx(hKey, 'MSBuildToolsPath')
             return value
-    except (WindowsError, EnvironmentError) as e:
-        return None
+    except WindowsError, OSError:
+        return ''
+
+    return ''