Re-write mono module editor code in C#
Make the build system automatically build the C# Api assemblies to be shipped with the editor. Make the editor, editor player and debug export templates use Api assemblies built with debug symbols. Always run MSBuild to build the editor tools and Api assemblies when building Godot. Several bugs fixed related to assembly hot reloading and restoring state. Fix StringExtensions internal calls not being registered correctly, resulting in MissingMethodException.
This commit is contained in:
Ignacio Etcheverry
66
modules/mono/build_scripts/api_solution_build.py
Normal file
66
modules/mono/build_scripts/api_solution_build.py
Normal file
@@ -0,0 +1,66 @@
|
||||
# Build the Godot API solution
|
||||
|
||||
import os
|
||||
|
||||
from SCons.Script import Dir
|
||||
|
||||
|
||||
def build_api_solution(source, target, env):
|
||||
# source and target elements are of type SCons.Node.FS.File, hence why we convert them to str
|
||||
|
||||
module_dir = env['module_dir']
|
||||
|
||||
solution_path = os.path.join(module_dir, 'glue/Managed/Generated/GodotSharp.sln')
|
||||
|
||||
if not os.path.isfile(solution_path):
|
||||
raise RuntimeError("Godot API solution not found. Did you forget to run '--generate-mono-glue'?")
|
||||
|
||||
build_config = env['solution_build_config']
|
||||
|
||||
extra_msbuild_args = ['/p:NoWarn=1591'] # Ignore missing documentation warnings
|
||||
|
||||
from .solution_builder import build_solution
|
||||
build_solution(env, solution_path, build_config, extra_msbuild_args=extra_msbuild_args)
|
||||
|
||||
# Copy targets
|
||||
|
||||
core_src_dir = os.path.abspath(os.path.join(solution_path, os.pardir, 'GodotSharp', 'bin', build_config))
|
||||
editor_src_dir = os.path.abspath(os.path.join(solution_path, os.pardir, 'GodotSharpEditor', 'bin', build_config))
|
||||
|
||||
dst_dir = os.path.abspath(os.path.join(str(target[0]), os.pardir))
|
||||
|
||||
if not os.path.isdir(dst_dir):
|
||||
assert not os.path.isfile(dst_dir)
|
||||
os.makedirs(dst_dir)
|
||||
|
||||
def copy_target(target_path):
|
||||
from shutil import copy
|
||||
filename = os.path.basename(target_path)
|
||||
|
||||
src_path = os.path.join(core_src_dir, filename)
|
||||
if not os.path.isfile(src_path):
|
||||
src_path = os.path.join(editor_src_dir, filename)
|
||||
|
||||
copy(src_path, target_path)
|
||||
|
||||
for scons_target in target:
|
||||
copy_target(str(scons_target))
|
||||
|
||||
|
||||
def build(env_mono):
|
||||
assert env_mono['tools']
|
||||
|
||||
target_filenames = [
|
||||
'GodotSharp.dll', 'GodotSharp.pdb', 'GodotSharp.xml',
|
||||
'GodotSharpEditor.dll', 'GodotSharpEditor.pdb', 'GodotSharpEditor.xml'
|
||||
]
|
||||
|
||||
for build_config in ['Debug', 'Release']:
|
||||
output_dir = Dir('#bin').abspath
|
||||
editor_api_dir = os.path.join(output_dir, 'GodotSharp', 'Api', build_config)
|
||||
|
||||
targets = [os.path.join(editor_api_dir, filename) for filename in target_filenames]
|
||||
|
||||
cmd = env_mono.CommandNoCache(targets, [], build_api_solution,
|
||||
module_dir=os.getcwd(), solution_build_config=build_config)
|
||||
env_mono.AlwaysBuild(cmd)
|
||||
108
modules/mono/build_scripts/godot_tools_build.py
Normal file
108
modules/mono/build_scripts/godot_tools_build.py
Normal file
@@ -0,0 +1,108 @@
|
||||
# Build GodotTools solution
|
||||
|
||||
import os
|
||||
|
||||
from SCons.Script import Dir
|
||||
|
||||
|
||||
def build_godot_tools(source, target, env):
|
||||
# source and target elements are of type SCons.Node.FS.File, hence why we convert them to str
|
||||
|
||||
module_dir = env['module_dir']
|
||||
|
||||
solution_path = os.path.join(module_dir, 'editor/GodotTools/GodotTools.sln')
|
||||
build_config = 'Debug' if env['target'] == 'debug' else 'Release'
|
||||
|
||||
from . solution_builder import build_solution, nuget_restore
|
||||
nuget_restore(env, solution_path)
|
||||
build_solution(env, solution_path, build_config)
|
||||
|
||||
# Copy targets
|
||||
|
||||
solution_dir = os.path.abspath(os.path.join(solution_path, os.pardir))
|
||||
|
||||
src_dir = os.path.join(solution_dir, 'GodotTools', 'bin', build_config)
|
||||
dst_dir = os.path.abspath(os.path.join(str(target[0]), os.pardir))
|
||||
|
||||
if not os.path.isdir(dst_dir):
|
||||
assert not os.path.isfile(dst_dir)
|
||||
os.makedirs(dst_dir)
|
||||
|
||||
def copy_target(target_path):
|
||||
from shutil import copy
|
||||
filename = os.path.basename(target_path)
|
||||
copy(os.path.join(src_dir, filename), target_path)
|
||||
|
||||
for scons_target in target:
|
||||
copy_target(str(scons_target))
|
||||
|
||||
|
||||
def build_godot_tools_project_editor(source, target, env):
|
||||
# source and target elements are of type SCons.Node.FS.File, hence why we convert them to str
|
||||
|
||||
module_dir = env['module_dir']
|
||||
|
||||
project_name = 'GodotTools.ProjectEditor'
|
||||
|
||||
csproj_dir = os.path.join(module_dir, 'editor/GodotTools', project_name)
|
||||
csproj_path = os.path.join(csproj_dir, project_name + '.csproj')
|
||||
build_config = 'Debug' if env['target'] == 'debug' else 'Release'
|
||||
|
||||
from . solution_builder import build_solution, nuget_restore
|
||||
|
||||
# Make sure to restore NuGet packages in the project directory for the project to find it
|
||||
nuget_restore(env, os.path.join(csproj_dir, 'packages.config'), '-PackagesDirectory',
|
||||
os.path.join(csproj_dir, 'packages'))
|
||||
|
||||
build_solution(env, csproj_path, build_config)
|
||||
|
||||
# Copy targets
|
||||
|
||||
src_dir = os.path.join(csproj_dir, 'bin', build_config)
|
||||
dst_dir = os.path.abspath(os.path.join(str(target[0]), os.pardir))
|
||||
|
||||
if not os.path.isdir(dst_dir):
|
||||
assert not os.path.isfile(dst_dir)
|
||||
os.makedirs(dst_dir)
|
||||
|
||||
def copy_target(target_path):
|
||||
from shutil import copy
|
||||
filename = os.path.basename(target_path)
|
||||
copy(os.path.join(src_dir, filename), target_path)
|
||||
|
||||
for scons_target in target:
|
||||
copy_target(str(scons_target))
|
||||
|
||||
|
||||
def build(env_mono):
|
||||
assert env_mono['tools']
|
||||
|
||||
output_dir = Dir('#bin').abspath
|
||||
editor_tools_dir = os.path.join(output_dir, 'GodotSharp', 'Tools')
|
||||
editor_api_dir = os.path.join(output_dir, 'GodotSharp', 'Api', 'Debug')
|
||||
|
||||
source_filenames = ['GodotSharp.dll', 'GodotSharpEditor.dll']
|
||||
sources = [os.path.join(editor_api_dir, filename) for filename in source_filenames]
|
||||
|
||||
target_filenames = ['GodotTools.dll', 'GodotTools.BuildLogger.dll', 'GodotTools.ProjectEditor.dll', 'DotNet.Glob.dll', 'GodotTools.Core.dll']
|
||||
|
||||
if env_mono['target'] == 'debug':
|
||||
target_filenames += ['GodotTools.pdb', 'GodotTools.BuildLogger.dll', 'GodotTools.ProjectEditor.dll', 'GodotTools.Core.dll']
|
||||
|
||||
targets = [os.path.join(editor_tools_dir, filename) for filename in target_filenames]
|
||||
|
||||
cmd = env_mono.CommandNoCache(targets, sources, build_godot_tools, module_dir=os.getcwd())
|
||||
env_mono.AlwaysBuild(cmd)
|
||||
|
||||
|
||||
def build_project_editor_only(env_mono):
|
||||
assert env_mono['tools']
|
||||
|
||||
output_dir = Dir('#bin').abspath
|
||||
editor_tools_dir = os.path.join(output_dir, 'GodotSharp', 'Tools')
|
||||
|
||||
target_filenames = ['GodotTools.ProjectEditor.dll', 'DotNet.Glob.dll', 'GodotTools.Core.dll']
|
||||
targets = [os.path.join(editor_tools_dir, filename) for filename in target_filenames]
|
||||
|
||||
cmd = env_mono.CommandNoCache(targets, [], build_godot_tools_project_editor, module_dir=os.getcwd())
|
||||
env_mono.AlwaysBuild(cmd)
|
||||
@@ -1,10 +1,8 @@
|
||||
import imp
|
||||
import os
|
||||
import os.path
|
||||
import sys
|
||||
import subprocess
|
||||
|
||||
from distutils.version import LooseVersion
|
||||
from SCons.Script import Dir, Environment
|
||||
|
||||
if os.name == 'nt':
|
||||
@@ -58,6 +56,12 @@ def configure(env, env_mono):
|
||||
|
||||
mono_lib_names = ['mono-2.0-sgen', 'monosgen-2.0']
|
||||
|
||||
is_travis = os.environ.get('TRAVIS') == 'true'
|
||||
|
||||
if is_travis:
|
||||
# Travis CI may have a Mono version lower than 5.12
|
||||
env_mono.Append(CPPDEFINES=['NO_PENDING_EXCEPTIONS'])
|
||||
|
||||
if is_android and not env['android_arch'] in android_arch_dirs:
|
||||
raise RuntimeError('This module does not support for the specified \'android_arch\': ' + env['android_arch'])
|
||||
|
||||
@@ -83,9 +87,6 @@ def configure(env, env_mono):
|
||||
|
||||
print('Found Mono root directory: ' + mono_root)
|
||||
|
||||
mono_version = mono_root_try_find_mono_version(mono_root)
|
||||
configure_for_mono_version(env_mono, mono_version)
|
||||
|
||||
mono_lib_path = os.path.join(mono_root, 'lib')
|
||||
|
||||
env.Append(LIBPATH=mono_lib_path)
|
||||
@@ -164,9 +165,6 @@ def configure(env, env_mono):
|
||||
if mono_root:
|
||||
print('Found Mono root directory: ' + mono_root)
|
||||
|
||||
mono_version = mono_root_try_find_mono_version(mono_root)
|
||||
configure_for_mono_version(env_mono, mono_version)
|
||||
|
||||
mono_lib_path = os.path.join(mono_root, 'lib')
|
||||
|
||||
env.Append(LIBPATH=mono_lib_path)
|
||||
@@ -209,9 +207,6 @@ def configure(env, env_mono):
|
||||
# TODO: Add option to force using pkg-config
|
||||
print('Mono root directory not found. Using pkg-config instead')
|
||||
|
||||
mono_version = pkgconfig_try_find_mono_version()
|
||||
configure_for_mono_version(env_mono, mono_version)
|
||||
|
||||
env.ParseConfig('pkg-config monosgen-2 --libs')
|
||||
env_mono.ParseConfig('pkg-config monosgen-2 --cflags')
|
||||
|
||||
@@ -401,17 +396,6 @@ def copy_mono_shared_libs(env, mono_root, target_mono_root_dir):
|
||||
copy_if_exists(os.path.join(mono_root, 'lib', lib_file_name), target_mono_lib_dir)
|
||||
|
||||
|
||||
def configure_for_mono_version(env, mono_version):
|
||||
if mono_version is None:
|
||||
if os.getenv('MONO_VERSION'):
|
||||
mono_version = os.getenv('MONO_VERSION')
|
||||
else:
|
||||
raise RuntimeError("Mono JIT compiler version not found; specify one manually with the 'MONO_VERSION' environment variable")
|
||||
print('Found Mono JIT compiler version: ' + str(mono_version))
|
||||
if mono_version >= LooseVersion('5.12.0'):
|
||||
env.Append(CPPDEFINES=['HAS_PENDING_EXCEPTIONS'])
|
||||
|
||||
|
||||
def pkgconfig_try_find_mono_root(mono_lib_names, sharedlib_ext):
|
||||
tmpenv = Environment()
|
||||
tmpenv.AppendENVPath('PKG_CONFIG_PATH', os.getenv('PKG_CONFIG_PATH'))
|
||||
@@ -421,36 +405,3 @@ def pkgconfig_try_find_mono_root(mono_lib_names, sharedlib_ext):
|
||||
if name_found and os.path.isdir(os.path.join(hint_dir, '..', 'include', 'mono-2.0')):
|
||||
return os.path.join(hint_dir, '..')
|
||||
return ''
|
||||
|
||||
|
||||
def pkgconfig_try_find_mono_version():
|
||||
from compat import decode_utf8
|
||||
|
||||
lines = subprocess.check_output(['pkg-config', 'monosgen-2', '--modversion']).splitlines()
|
||||
greater_version = None
|
||||
for line in lines:
|
||||
try:
|
||||
version = LooseVersion(decode_utf8(line))
|
||||
if greater_version is None or version > greater_version:
|
||||
greater_version = version
|
||||
except ValueError:
|
||||
pass
|
||||
return greater_version
|
||||
|
||||
|
||||
def mono_root_try_find_mono_version(mono_root):
|
||||
from compat import decode_utf8
|
||||
|
||||
mono_bin = os.path.join(mono_root, 'bin')
|
||||
if os.path.isfile(os.path.join(mono_bin, 'mono')):
|
||||
mono_binary = os.path.join(mono_bin, 'mono')
|
||||
elif os.path.isfile(os.path.join(mono_bin, 'mono.exe')):
|
||||
mono_binary = os.path.join(mono_bin, 'mono.exe')
|
||||
else:
|
||||
return None
|
||||
output = subprocess.check_output([mono_binary, '--version'])
|
||||
first_line = decode_utf8(output.splitlines()[0])
|
||||
try:
|
||||
return LooseVersion(first_line.split()[len('Mono JIT compiler version'.split())])
|
||||
except (ValueError, IndexError):
|
||||
return None
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# Build GodotSharpTools solution
|
||||
|
||||
import os
|
||||
|
||||
from SCons.Script import Builder, Dir
|
||||
|
||||
verbose = False
|
||||
|
||||
|
||||
def find_nuget_unix():
|
||||
@@ -131,12 +131,46 @@ def find_msbuild_windows(env):
|
||||
return None
|
||||
|
||||
|
||||
def mono_build_solution(source, target, env):
|
||||
import subprocess
|
||||
from shutil import copyfile
|
||||
def run_command(command, args, env_override=None, name=None):
|
||||
def cmd_args_to_str(cmd_args):
|
||||
return ' '.join([arg if not ' ' in arg else '"%s"' % arg for arg in cmd_args])
|
||||
|
||||
sln_path = os.path.abspath(str(source[0]))
|
||||
target_path = os.path.abspath(str(target[0]))
|
||||
args = [command] + args
|
||||
|
||||
if name is None:
|
||||
name = os.path.basename(command)
|
||||
|
||||
if verbose:
|
||||
print("Running '%s': %s" % (name, cmd_args_to_str(args)))
|
||||
|
||||
import subprocess
|
||||
try:
|
||||
if env_override is None:
|
||||
subprocess.check_call(args)
|
||||
else:
|
||||
subprocess.check_call(args, env=env_override)
|
||||
except subprocess.CalledProcessError as e:
|
||||
raise RuntimeError("'%s' exited with error code: %s" % (name, e.returncode))
|
||||
|
||||
|
||||
def nuget_restore(env, *args):
|
||||
global verbose
|
||||
verbose = env['verbose']
|
||||
|
||||
# Find NuGet
|
||||
nuget_path = find_nuget_windows(env) if os.name == 'nt' else find_nuget_unix()
|
||||
if nuget_path is None:
|
||||
raise RuntimeError('Cannot find NuGet executable')
|
||||
|
||||
print('NuGet path: ' + nuget_path)
|
||||
|
||||
# Do NuGet restore
|
||||
run_command(nuget_path, ['restore'] + list(args), name='nuget restore')
|
||||
|
||||
|
||||
def build_solution(env, solution_path, build_config, extra_msbuild_args=[]):
|
||||
global verbose
|
||||
verbose = env['verbose']
|
||||
|
||||
framework_path = ''
|
||||
msbuild_env = os.environ.copy()
|
||||
@@ -175,64 +209,10 @@ def mono_build_solution(source, target, env):
|
||||
|
||||
print('MSBuild path: ' + msbuild_path)
|
||||
|
||||
# Find NuGet
|
||||
nuget_path = find_nuget_windows(env) if os.name == 'nt' else find_nuget_unix()
|
||||
if nuget_path is None:
|
||||
raise RuntimeError('Cannot find NuGet executable')
|
||||
|
||||
print('NuGet path: ' + nuget_path)
|
||||
|
||||
# Do NuGet restore
|
||||
|
||||
try:
|
||||
subprocess.check_call([nuget_path, 'restore', sln_path])
|
||||
except subprocess.CalledProcessError:
|
||||
raise RuntimeError('GodotSharpTools: NuGet restore failed')
|
||||
|
||||
# Build solution
|
||||
|
||||
build_config = 'Release'
|
||||
msbuild_args = [solution_path, '/p:Configuration=' + build_config]
|
||||
msbuild_args += ['/p:FrameworkPathOverride=' + framework_path] if framework_path else []
|
||||
msbuild_args += extra_msbuild_args
|
||||
|
||||
msbuild_args = [
|
||||
msbuild_path,
|
||||
sln_path,
|
||||
'/p:Configuration=' + build_config,
|
||||
]
|
||||
|
||||
if framework_path:
|
||||
msbuild_args += ['/p:FrameworkPathOverride=' + framework_path]
|
||||
|
||||
try:
|
||||
subprocess.check_call(msbuild_args, env=msbuild_env)
|
||||
except subprocess.CalledProcessError:
|
||||
raise RuntimeError('GodotSharpTools: Build failed')
|
||||
|
||||
# Copy files
|
||||
|
||||
src_dir = os.path.abspath(os.path.join(sln_path, os.pardir, 'bin', build_config))
|
||||
dst_dir = os.path.abspath(os.path.join(target_path, os.pardir))
|
||||
asm_file = 'GodotSharpTools.dll'
|
||||
|
||||
if not os.path.isdir(dst_dir):
|
||||
if os.path.exists(dst_dir):
|
||||
raise RuntimeError('Target directory is a file')
|
||||
os.makedirs(dst_dir)
|
||||
|
||||
copyfile(os.path.join(src_dir, asm_file), os.path.join(dst_dir, asm_file))
|
||||
|
||||
# Dependencies
|
||||
copyfile(os.path.join(src_dir, "DotNet.Glob.dll"), os.path.join(dst_dir, "DotNet.Glob.dll"))
|
||||
|
||||
def build(env_mono):
|
||||
if not env_mono['tools']:
|
||||
return
|
||||
|
||||
output_dir = Dir('#bin').abspath
|
||||
editor_tools_dir = os.path.join(output_dir, 'GodotSharp', 'Tools')
|
||||
|
||||
mono_sln_builder = Builder(action=mono_build_solution)
|
||||
env_mono.Append(BUILDERS={'MonoBuildSolution': mono_sln_builder})
|
||||
env_mono.MonoBuildSolution(
|
||||
os.path.join(editor_tools_dir, 'GodotSharpTools.dll'),
|
||||
'editor/GodotSharpTools/GodotSharpTools.sln'
|
||||
)
|
||||
run_command(msbuild_path, msbuild_args, env_override=msbuild_env, name='msbuild')
|
||||
Reference in New Issue
Block a user