536 lines
18 KiB
C++
536 lines
18 KiB
C++
/*************************************************************************/
|
|
/* godotsharp_builds.cpp */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2018 Godot Engine contributors (cf. AUTHORS.md) */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/*************************************************************************/
|
|
|
|
#include "godotsharp_builds.h"
|
|
|
|
#include "main/main.h"
|
|
|
|
#include "../godotsharp_dirs.h"
|
|
#include "../mono_gd/gd_mono_class.h"
|
|
#include "../mono_gd/gd_mono_marshal.h"
|
|
#include "../utils/path_utils.h"
|
|
#include "bindings_generator.h"
|
|
#include "godotsharp_editor.h"
|
|
|
|
void godot_icall_BuildInstance_ExitCallback(MonoString *p_solution, MonoString *p_config, int p_exit_code) {
|
|
|
|
String solution = GDMonoMarshal::mono_string_to_godot(p_solution);
|
|
String config = GDMonoMarshal::mono_string_to_godot(p_config);
|
|
GodotSharpBuilds::get_singleton()->build_exit_callback(MonoBuildInfo(solution, config), p_exit_code);
|
|
}
|
|
|
|
#ifdef UNIX_ENABLED
|
|
String _find_build_engine_on_unix(const String &p_name) {
|
|
String ret = path_which(p_name);
|
|
|
|
if (ret.length())
|
|
return ret;
|
|
|
|
String ret_fallback = path_which(p_name + ".exe");
|
|
if (ret_fallback.length())
|
|
return ret_fallback;
|
|
|
|
const char *locations[] = {
|
|
#ifdef OSX_ENABLED
|
|
"/Library/Frameworks/Mono.framework/Versions/Current/bin/",
|
|
#endif
|
|
"/opt/novell/mono/bin/"
|
|
};
|
|
|
|
for (int i = 0; i < sizeof(locations) / sizeof(const char *); i++) {
|
|
String hint_path = locations[i] + p_name;
|
|
|
|
if (FileAccess::exists(hint_path)) {
|
|
return hint_path;
|
|
}
|
|
}
|
|
|
|
return String();
|
|
}
|
|
#endif
|
|
|
|
void godot_icall_BuildInstance_get_MSBuildInfo(MonoString **r_msbuild_path, MonoString **r_framework_path) {
|
|
|
|
GodotSharpBuilds::BuildTool build_tool = GodotSharpBuilds::BuildTool(int(EditorSettings::get_singleton()->get("mono/builds/build_tool")));
|
|
|
|
#if defined(WINDOWS_ENABLED)
|
|
switch (build_tool) {
|
|
case GodotSharpBuilds::MSBUILD: {
|
|
static String msbuild_tools_path = MonoRegUtils::find_msbuild_tools_path();
|
|
|
|
if (msbuild_tools_path.length()) {
|
|
if (!msbuild_tools_path.ends_with("\\"))
|
|
msbuild_tools_path += "\\";
|
|
|
|
// FrameworkPathOverride
|
|
const MonoRegInfo &mono_reg_info = GDMono::get_singleton()->get_mono_reg_info();
|
|
if (mono_reg_info.assembly_dir.length()) {
|
|
*r_msbuild_path = GDMonoMarshal::mono_string_from_godot(msbuild_tools_path + "MSBuild.exe");
|
|
|
|
String framework_path = path_join(mono_reg_info.assembly_dir, "mono", "4.5");
|
|
*r_framework_path = GDMonoMarshal::mono_string_from_godot(framework_path);
|
|
} else {
|
|
ERR_PRINT("Cannot find Mono's assemblies directory in the registry");
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
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");
|
|
|
|
if (!FileAccess::exists(msbuild_path)) {
|
|
WARN_PRINTS("Cannot find msbuild ('mono/builds/build_tool'). Tried with path: " + msbuild_path);
|
|
}
|
|
|
|
*r_msbuild_path = GDMonoMarshal::mono_string_from_godot(msbuild_path);
|
|
|
|
return;
|
|
} break;
|
|
default:
|
|
ERR_EXPLAIN("You don't deserve to live");
|
|
CRASH_NOW();
|
|
}
|
|
#elif defined(UNIX_ENABLED)
|
|
static String msbuild_path = _find_build_engine_on_unix("msbuild");
|
|
static String xbuild_path = _find_build_engine_on_unix("xbuild");
|
|
|
|
if (build_tool != GodotSharpBuilds::XBUILD) {
|
|
if (msbuild_path.empty()) {
|
|
WARN_PRINT("Cannot find msbuild ('mono/builds/build_tool').");
|
|
return;
|
|
}
|
|
} else {
|
|
if (xbuild_path.empty()) {
|
|
WARN_PRINT("Cannot find xbuild ('mono/builds/build_tool').");
|
|
return;
|
|
}
|
|
}
|
|
|
|
*r_msbuild_path = GDMonoMarshal::mono_string_from_godot(build_tool != GodotSharpBuilds::XBUILD ? msbuild_path : xbuild_path);
|
|
|
|
return;
|
|
#else
|
|
ERR_PRINT("Not implemented on this platform");
|
|
return;
|
|
#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_MSBuildInfo", (void *)godot_icall_BuildInstance_get_MSBuildInfo);
|
|
}
|
|
|
|
void GodotSharpBuilds::show_build_error_dialog(const String &p_message) {
|
|
|
|
GodotSharpEditor::get_singleton()->show_error_dialog(p_message, "Build error");
|
|
MonoBottomPanel::get_singleton()->show_build_tab();
|
|
}
|
|
|
|
bool GodotSharpBuilds::build_api_sln(const String &p_name, const String &p_api_sln_dir, const String &p_config) {
|
|
|
|
String api_sln_file = p_api_sln_dir.plus_file(p_name + ".sln");
|
|
String api_assembly_dir = p_api_sln_dir.plus_file("bin").plus_file(p_config);
|
|
String api_assembly_file = api_assembly_dir.plus_file(p_name + ".dll");
|
|
|
|
if (!FileAccess::exists(api_assembly_file)) {
|
|
MonoBuildInfo api_build_info(api_sln_file, p_config);
|
|
api_build_info.custom_props.push_back("NoWarn=1591"); // Ignore missing documentation warnings
|
|
|
|
if (!GodotSharpBuilds::get_singleton()->build(api_build_info)) {
|
|
show_build_error_dialog("Failed to build " + p_name + " solution.");
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool GodotSharpBuilds::copy_api_assembly(const String &p_src_dir, const String &p_dst_dir, const String &p_assembly_name, APIAssembly::Type p_api_type) {
|
|
|
|
String assembly_file = p_assembly_name + ".dll";
|
|
String assembly_src = p_src_dir.plus_file(assembly_file);
|
|
String assembly_dst = p_dst_dir.plus_file(assembly_file);
|
|
|
|
if (!FileAccess::exists(assembly_dst) ||
|
|
FileAccess::get_modified_time(assembly_src) > FileAccess::get_modified_time(assembly_dst) ||
|
|
GDMono::get_singleton()->metadata_is_api_assembly_invalidated(p_api_type)) {
|
|
DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
|
|
|
|
String xml_file = p_assembly_name + ".xml";
|
|
if (da->copy(p_src_dir.plus_file(xml_file), p_dst_dir.plus_file(xml_file)) != OK)
|
|
WARN_PRINTS("Failed to copy " + xml_file);
|
|
|
|
String pdb_file = p_assembly_name + ".pdb";
|
|
if (da->copy(p_src_dir.plus_file(pdb_file), p_dst_dir.plus_file(pdb_file)) != OK)
|
|
WARN_PRINTS("Failed to copy " + pdb_file);
|
|
|
|
Error err = da->copy(assembly_src, assembly_dst);
|
|
|
|
memdelete(da);
|
|
|
|
if (err != OK) {
|
|
show_build_error_dialog("Failed to copy " + assembly_file);
|
|
return false;
|
|
}
|
|
|
|
GDMono::get_singleton()->metadata_set_api_assembly_invalidated(p_api_type, false);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
String GodotSharpBuilds::_api_folder_name(APIAssembly::Type p_api_type) {
|
|
|
|
uint64_t api_hash = p_api_type == APIAssembly::API_CORE ?
|
|
GDMono::get_singleton()->get_api_core_hash() :
|
|
GDMono::get_singleton()->get_api_editor_hash();
|
|
return String::num_uint64(api_hash) +
|
|
"_" + String::num_uint64(BindingsGenerator::get_version()) +
|
|
"_" + String::num_uint64(BindingsGenerator::get_cs_glue_version());
|
|
}
|
|
|
|
bool GodotSharpBuilds::make_api_sln(APIAssembly::Type p_api_type) {
|
|
|
|
String api_name = p_api_type == APIAssembly::API_CORE ? API_ASSEMBLY_NAME : EDITOR_API_ASSEMBLY_NAME;
|
|
String api_build_config = "Release";
|
|
|
|
EditorProgress pr("mono_build_release_" + api_name, "Building " + api_name + " solution...", 4);
|
|
|
|
pr.step("Generating " + api_name + " solution");
|
|
|
|
String core_api_sln_dir = GodotSharpDirs::get_mono_solutions_dir()
|
|
.plus_file(_api_folder_name(APIAssembly::API_CORE))
|
|
.plus_file(API_ASSEMBLY_NAME);
|
|
String editor_api_sln_dir = GodotSharpDirs::get_mono_solutions_dir()
|
|
.plus_file(_api_folder_name(APIAssembly::API_EDITOR))
|
|
.plus_file(EDITOR_API_ASSEMBLY_NAME);
|
|
|
|
String api_sln_dir = p_api_type == APIAssembly::API_CORE ? core_api_sln_dir : editor_api_sln_dir;
|
|
String api_sln_file = api_sln_dir.plus_file(api_name + ".sln");
|
|
|
|
if (!DirAccess::exists(api_sln_dir) || !FileAccess::exists(api_sln_file)) {
|
|
String core_api_assembly;
|
|
|
|
if (p_api_type == APIAssembly::API_EDITOR) {
|
|
core_api_assembly = core_api_sln_dir.plus_file("bin")
|
|
.plus_file(api_build_config)
|
|
.plus_file(API_ASSEMBLY_NAME ".dll");
|
|
}
|
|
|
|
#ifndef DEBUG_METHODS_ENABLED
|
|
#error "How am I supposed to generate the bindings?"
|
|
#endif
|
|
|
|
BindingsGenerator *gen = BindingsGenerator::get_singleton();
|
|
bool gen_verbose = OS::get_singleton()->is_stdout_verbose();
|
|
|
|
Error err = p_api_type == APIAssembly::API_CORE ?
|
|
gen->generate_cs_core_project(api_sln_dir, gen_verbose) :
|
|
gen->generate_cs_editor_project(api_sln_dir, core_api_assembly, gen_verbose);
|
|
|
|
if (err != OK) {
|
|
show_build_error_dialog("Failed to generate " + api_name + " solution. Error: " + itos(err));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
pr.step("Building " + api_name + " solution");
|
|
|
|
if (!GodotSharpBuilds::build_api_sln(api_name, api_sln_dir, api_build_config))
|
|
return false;
|
|
|
|
pr.step("Copying " + api_name + " assembly");
|
|
|
|
String res_assemblies_dir = GodotSharpDirs::get_res_assemblies_dir();
|
|
|
|
// Create assemblies directory if needed
|
|
if (!DirAccess::exists(res_assemblies_dir)) {
|
|
DirAccess *da = DirAccess::create_for_path(res_assemblies_dir);
|
|
Error err = da->make_dir_recursive(res_assemblies_dir);
|
|
memdelete(da);
|
|
|
|
if (err != OK) {
|
|
show_build_error_dialog("Failed to create assemblies directory. Error: " + itos(err));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Copy the built assembly to the assemblies directory
|
|
String api_assembly_dir = api_sln_dir.plus_file("bin").plus_file(api_build_config);
|
|
if (!GodotSharpBuilds::copy_api_assembly(api_assembly_dir, res_assemblies_dir, api_name, p_api_type))
|
|
return false;
|
|
|
|
pr.step("Done");
|
|
|
|
return true;
|
|
}
|
|
|
|
bool GodotSharpBuilds::build_project_blocking(const String &p_config) {
|
|
|
|
if (!FileAccess::exists(GodotSharpDirs::get_project_sln_path()))
|
|
return true; // No solution to build
|
|
|
|
if (!GodotSharpBuilds::make_api_sln(APIAssembly::API_CORE))
|
|
return false;
|
|
|
|
if (!GodotSharpBuilds::make_api_sln(APIAssembly::API_EDITOR))
|
|
return false;
|
|
|
|
EditorProgress pr("mono_project_debug_build", "Building project solution...", 2);
|
|
|
|
pr.step("Building project solution");
|
|
|
|
MonoBuildInfo build_info(GodotSharpDirs::get_project_sln_path(), p_config);
|
|
if (!GodotSharpBuilds::get_singleton()->build(build_info)) {
|
|
GodotSharpBuilds::show_build_error_dialog("Failed to build project solution");
|
|
return false;
|
|
}
|
|
|
|
pr.step("Done");
|
|
|
|
return true;
|
|
}
|
|
|
|
bool GodotSharpBuilds::editor_build_callback() {
|
|
|
|
return build_project_blocking("Tools");
|
|
}
|
|
|
|
GodotSharpBuilds *GodotSharpBuilds::singleton = NULL;
|
|
|
|
void GodotSharpBuilds::build_exit_callback(const MonoBuildInfo &p_build_info, int p_exit_code) {
|
|
|
|
BuildProcess *match = builds.getptr(p_build_info);
|
|
ERR_FAIL_NULL(match);
|
|
|
|
BuildProcess &bp = *match;
|
|
bp.on_exit(p_exit_code);
|
|
}
|
|
|
|
void GodotSharpBuilds::restart_build(MonoBuildTab *p_build_tab) {
|
|
}
|
|
|
|
void GodotSharpBuilds::stop_build(MonoBuildTab *p_build_tab) {
|
|
}
|
|
|
|
bool GodotSharpBuilds::build(const MonoBuildInfo &p_build_info) {
|
|
|
|
BuildProcess *match = builds.getptr(p_build_info);
|
|
|
|
if (match) {
|
|
BuildProcess &bp = *match;
|
|
bp.start(true);
|
|
return bp.exit_code == 0;
|
|
} else {
|
|
BuildProcess bp = BuildProcess(p_build_info);
|
|
bp.start(true);
|
|
builds.set(p_build_info, bp);
|
|
return bp.exit_code == 0;
|
|
}
|
|
}
|
|
|
|
bool GodotSharpBuilds::build_async(const MonoBuildInfo &p_build_info, GodotSharpBuild_ExitCallback p_callback) {
|
|
|
|
BuildProcess *match = builds.getptr(p_build_info);
|
|
|
|
if (match) {
|
|
BuildProcess &bp = *match;
|
|
bp.start();
|
|
return !bp.exited; // failed to start
|
|
} else {
|
|
BuildProcess bp = BuildProcess(p_build_info, p_callback);
|
|
bp.start();
|
|
builds.set(p_build_info, bp);
|
|
return !bp.exited; // failed to start
|
|
}
|
|
}
|
|
|
|
GodotSharpBuilds::GodotSharpBuilds() {
|
|
|
|
singleton = this;
|
|
|
|
EditorNode::get_singleton()->add_build_callback(&GodotSharpBuilds::editor_build_callback);
|
|
|
|
// Build tool settings
|
|
EditorSettings *ed_settings = EditorSettings::get_singleton();
|
|
|
|
#ifdef WINDOWS_ENABLED
|
|
// TODO: Default to MSBUILD_MONO if its csc.exe issue is fixed in the installed mono version
|
|
EDITOR_DEF("mono/builds/build_tool", MSBUILD);
|
|
#else
|
|
EDITOR_DEF("mono/builds/build_tool", MSBUILD_MONO);
|
|
#endif
|
|
|
|
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() {
|
|
|
|
singleton = NULL;
|
|
}
|
|
|
|
void GodotSharpBuilds::BuildProcess::on_exit(int p_exit_code) {
|
|
|
|
exited = true;
|
|
exit_code = p_exit_code;
|
|
build_tab->on_build_exit(p_exit_code == 0 ? MonoBuildTab::RESULT_SUCCESS : MonoBuildTab::RESULT_ERROR);
|
|
build_instance.unref();
|
|
|
|
if (exit_callback)
|
|
exit_callback(exit_code);
|
|
}
|
|
|
|
void GodotSharpBuilds::BuildProcess::start(bool p_blocking) {
|
|
|
|
_GDMONO_SCOPE_DOMAIN_(TOOLS_DOMAIN)
|
|
|
|
exit_code = -1;
|
|
|
|
String logs_dir = GodotSharpDirs::get_build_logs_dir().plus_file(build_info.solution.md5_text() + "_" + build_info.configuration);
|
|
|
|
if (build_tab) {
|
|
build_tab->on_build_start();
|
|
} else {
|
|
build_tab = memnew(MonoBuildTab(build_info, logs_dir));
|
|
MonoBottomPanel::get_singleton()->add_build_tab(build_tab);
|
|
}
|
|
|
|
if (p_blocking) {
|
|
// Required in order to update the build tasks list
|
|
Main::iteration();
|
|
}
|
|
|
|
if (!exited) {
|
|
exited = true;
|
|
String message = "Tried to start build process, but it is already running";
|
|
build_tab->on_build_exec_failed(message);
|
|
ERR_EXPLAIN(message);
|
|
ERR_FAIL();
|
|
}
|
|
|
|
exited = false;
|
|
|
|
// Remove old issues file
|
|
|
|
String issues_file = "msbuild_issues.csv";
|
|
DirAccessRef d = DirAccess::create_for_path(logs_dir);
|
|
if (d->file_exists(issues_file)) {
|
|
Error err = d->remove(issues_file);
|
|
if (err != OK) {
|
|
exited = true;
|
|
String file_path = ProjectSettings::get_singleton()->localize_path(logs_dir).plus_file(issues_file);
|
|
String message = "Cannot remove issues file: " + file_path;
|
|
build_tab->on_build_exec_failed(message);
|
|
ERR_EXPLAIN(message);
|
|
ERR_FAIL();
|
|
}
|
|
}
|
|
|
|
GDMonoClass *klass = GDMono::get_singleton()->get_editor_tools_assembly()->get_class("GodotSharpTools.Build", "BuildInstance");
|
|
|
|
MonoObject *mono_object = mono_object_new(mono_domain_get(), klass->get_mono_ptr());
|
|
|
|
// Construct
|
|
|
|
Variant solution = build_info.solution;
|
|
Variant config = build_info.configuration;
|
|
|
|
const Variant *ctor_args[2] = { &solution, &config };
|
|
|
|
MonoObject *ex = NULL;
|
|
GDMonoMethod *ctor = klass->get_method(".ctor", 2);
|
|
ctor->invoke(mono_object, ctor_args, &ex);
|
|
|
|
if (ex) {
|
|
exited = true;
|
|
GDMonoUtils::print_unhandled_exception(ex);
|
|
String message = "The build constructor threw an exception.\n" + GDMonoUtils::get_exception_name_and_message(ex);
|
|
build_tab->on_build_exec_failed(message);
|
|
ERR_EXPLAIN(message);
|
|
ERR_FAIL();
|
|
}
|
|
|
|
// Call Build
|
|
|
|
Variant logger_assembly = OS::get_singleton()->get_executable_path().get_base_dir().plus_file(EDITOR_TOOLS_ASSEMBLY_NAME) + ".dll";
|
|
Variant logger_output_dir = logs_dir;
|
|
Variant custom_props = build_info.custom_props;
|
|
|
|
const Variant *args[3] = { &logger_assembly, &logger_output_dir, &custom_props };
|
|
|
|
ex = NULL;
|
|
GDMonoMethod *build_method = klass->get_method(p_blocking ? "Build" : "BuildAsync", 3);
|
|
build_method->invoke(mono_object, args, &ex);
|
|
|
|
if (ex) {
|
|
exited = true;
|
|
GDMonoUtils::print_unhandled_exception(ex);
|
|
String message = "The build method threw an exception.\n" + GDMonoUtils::get_exception_name_and_message(ex);
|
|
build_tab->on_build_exec_failed(message);
|
|
ERR_EXPLAIN(message);
|
|
ERR_FAIL();
|
|
}
|
|
|
|
// Build returned
|
|
|
|
if (p_blocking) {
|
|
exited = true;
|
|
exit_code = klass->get_field("exitCode")->get_int_value(mono_object);
|
|
|
|
if (exit_code != 0 && OS::get_singleton()->is_stdout_verbose())
|
|
OS::get_singleton()->print(String("MSBuild finished with exit code " + itos(exit_code) + "\n").utf8());
|
|
|
|
build_tab->on_build_exit(exit_code == 0 ? MonoBuildTab::RESULT_SUCCESS : MonoBuildTab::RESULT_ERROR);
|
|
} else {
|
|
build_instance = MonoGCHandle::create_strong(mono_object);
|
|
exited = false;
|
|
}
|
|
}
|
|
|
|
GodotSharpBuilds::BuildProcess::BuildProcess(const MonoBuildInfo &p_build_info, GodotSharpBuild_ExitCallback p_callback) {
|
|
|
|
build_info = p_build_info;
|
|
build_tab = NULL;
|
|
exit_callback = p_callback;
|
|
exited = true;
|
|
exit_code = -1;
|
|
}
|