mirror of
https://github.com/godotengine/godot.git
synced 2024-12-15 10:12:40 +08:00
b5334d14f7
Happy new year to the wonderful Godot community!
2020 has been a tough year for most of us personally, but a good year for
Godot development nonetheless with a huge amount of work done towards Godot
4.0 and great improvements backported to the long-lived 3.2 branch.
We've had close to 400 contributors to engine code this year, authoring near
7,000 commit! (And that's only for the `master` branch and for the engine code,
there's a lot more when counting docs, demos and other first-party repos.)
Here's to a great year 2021 for all Godot users 🎆
331 lines
10 KiB
C++
331 lines
10 KiB
C++
/*************************************************************************/
|
|
/* gd_mono.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2021 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. */
|
|
/*************************************************************************/
|
|
|
|
#ifndef GD_MONO_H
|
|
#define GD_MONO_H
|
|
|
|
#include "core/io/config_file.h"
|
|
|
|
#include "../godotsharp_defs.h"
|
|
#include "gd_mono_assembly.h"
|
|
#include "gd_mono_log.h"
|
|
|
|
#ifdef WINDOWS_ENABLED
|
|
#include "../utils/mono_reg_utils.h"
|
|
#endif
|
|
|
|
namespace ApiAssemblyInfo {
|
|
enum Type {
|
|
API_CORE,
|
|
API_EDITOR
|
|
};
|
|
|
|
struct Version {
|
|
uint64_t godot_api_hash = 0;
|
|
uint32_t bindings_version = 0;
|
|
uint32_t cs_glue_version = 0;
|
|
|
|
bool operator==(const Version &p_other) const {
|
|
return godot_api_hash == p_other.godot_api_hash &&
|
|
bindings_version == p_other.bindings_version &&
|
|
cs_glue_version == p_other.cs_glue_version;
|
|
}
|
|
|
|
Version() {}
|
|
|
|
Version(uint64_t p_godot_api_hash,
|
|
uint32_t p_bindings_version,
|
|
uint32_t p_cs_glue_version) :
|
|
godot_api_hash(p_godot_api_hash),
|
|
bindings_version(p_bindings_version),
|
|
cs_glue_version(p_cs_glue_version) {
|
|
}
|
|
|
|
static Version get_from_loaded_assembly(GDMonoAssembly *p_api_assembly, Type p_api_type);
|
|
};
|
|
|
|
String to_string(Type p_type);
|
|
} // namespace ApiAssemblyInfo
|
|
|
|
class GDMono {
|
|
public:
|
|
enum UnhandledExceptionPolicy {
|
|
POLICY_TERMINATE_APP,
|
|
POLICY_LOG_ERROR
|
|
};
|
|
|
|
struct LoadedApiAssembly {
|
|
GDMonoAssembly *assembly = nullptr;
|
|
bool out_of_sync = false;
|
|
|
|
LoadedApiAssembly() {}
|
|
};
|
|
|
|
private:
|
|
bool runtime_initialized;
|
|
bool finalizing_scripts_domain;
|
|
|
|
UnhandledExceptionPolicy unhandled_exception_policy;
|
|
|
|
MonoDomain *root_domain;
|
|
MonoDomain *scripts_domain;
|
|
|
|
HashMap<int32_t, HashMap<String, GDMonoAssembly *>> assemblies;
|
|
|
|
GDMonoAssembly *corlib_assembly;
|
|
GDMonoAssembly *project_assembly;
|
|
#ifdef TOOLS_ENABLED
|
|
GDMonoAssembly *tools_assembly;
|
|
GDMonoAssembly *tools_project_editor_assembly;
|
|
#endif
|
|
|
|
LoadedApiAssembly core_api_assembly;
|
|
LoadedApiAssembly editor_api_assembly;
|
|
|
|
typedef bool (*CoreApiAssemblyLoadedCallback)();
|
|
|
|
bool _are_api_assemblies_out_of_sync();
|
|
bool _temp_domain_load_are_assemblies_out_of_sync(const String &p_config);
|
|
|
|
bool _load_core_api_assembly(LoadedApiAssembly &r_loaded_api_assembly, const String &p_config, bool p_refonly);
|
|
#ifdef TOOLS_ENABLED
|
|
bool _load_editor_api_assembly(LoadedApiAssembly &r_loaded_api_assembly, const String &p_config, bool p_refonly);
|
|
#endif
|
|
|
|
static bool _on_core_api_assembly_loaded();
|
|
|
|
bool _load_corlib_assembly();
|
|
#ifdef TOOLS_ENABLED
|
|
bool _load_tools_assemblies();
|
|
#endif
|
|
bool _load_project_assembly();
|
|
|
|
bool _try_load_api_assemblies(LoadedApiAssembly &r_core_api_assembly, LoadedApiAssembly &r_editor_api_assembly,
|
|
const String &p_config, bool p_refonly, CoreApiAssemblyLoadedCallback p_callback);
|
|
bool _try_load_api_assemblies_preset();
|
|
void _load_api_assemblies();
|
|
|
|
void _install_trace_listener();
|
|
|
|
void _register_internal_calls();
|
|
|
|
#ifndef GD_MONO_SINGLE_APPDOMAIN
|
|
Error _load_scripts_domain();
|
|
Error _unload_scripts_domain();
|
|
#endif
|
|
|
|
void _domain_assemblies_cleanup(int32_t p_domain_id);
|
|
|
|
uint64_t api_core_hash;
|
|
#ifdef TOOLS_ENABLED
|
|
uint64_t api_editor_hash;
|
|
#endif
|
|
void _init_godot_api_hashes();
|
|
void _init_exception_policy();
|
|
|
|
GDMonoLog *gdmono_log;
|
|
|
|
#if defined(WINDOWS_ENABLED) && defined(TOOLS_ENABLED)
|
|
MonoRegInfo mono_reg_info;
|
|
#endif
|
|
|
|
void add_mono_shared_libs_dir_to_path();
|
|
void determine_mono_dirs(String &r_assembly_rootdir, String &r_config_dir);
|
|
|
|
protected:
|
|
static GDMono *singleton;
|
|
|
|
public:
|
|
#ifdef DEBUG_METHODS_ENABLED
|
|
uint64_t get_api_core_hash() {
|
|
if (api_core_hash == 0) {
|
|
api_core_hash = ClassDB::get_api_hash(ClassDB::API_CORE);
|
|
}
|
|
return api_core_hash;
|
|
}
|
|
#ifdef TOOLS_ENABLED
|
|
uint64_t get_api_editor_hash() {
|
|
if (api_editor_hash == 0) {
|
|
api_editor_hash = ClassDB::get_api_hash(ClassDB::API_EDITOR);
|
|
}
|
|
return api_editor_hash;
|
|
}
|
|
#endif // TOOLS_ENABLED
|
|
#endif // DEBUG_METHODS_ENABLED
|
|
|
|
_FORCE_INLINE_ static String get_expected_api_build_config() {
|
|
#ifdef TOOLS_ENABLED
|
|
return "Debug";
|
|
#else
|
|
#ifdef DEBUG_ENABLED
|
|
return "Debug";
|
|
#else
|
|
return "Release";
|
|
#endif
|
|
#endif
|
|
}
|
|
|
|
#ifdef TOOLS_ENABLED
|
|
bool copy_prebuilt_api_assembly(ApiAssemblyInfo::Type p_api_type, const String &p_config);
|
|
String update_api_assemblies_from_prebuilt(const String &p_config, const bool *p_core_api_out_of_sync = nullptr, const bool *p_editor_api_out_of_sync = nullptr);
|
|
#endif
|
|
|
|
static GDMono *get_singleton() { return singleton; }
|
|
|
|
[[noreturn]] static void unhandled_exception_hook(MonoObject *p_exc, void *p_user_data);
|
|
|
|
UnhandledExceptionPolicy get_unhandled_exception_policy() const { return unhandled_exception_policy; }
|
|
|
|
// Do not use these, unless you know what you're doing
|
|
void add_assembly(int32_t p_domain_id, GDMonoAssembly *p_assembly);
|
|
GDMonoAssembly *get_loaded_assembly(const String &p_name);
|
|
|
|
_FORCE_INLINE_ bool is_runtime_initialized() const { return runtime_initialized && !mono_runtime_is_shutting_down() /* stays true after shutdown finished */; }
|
|
|
|
_FORCE_INLINE_ bool is_finalizing_scripts_domain() { return finalizing_scripts_domain; }
|
|
|
|
_FORCE_INLINE_ MonoDomain *get_scripts_domain() { return scripts_domain; }
|
|
|
|
_FORCE_INLINE_ GDMonoAssembly *get_corlib_assembly() const { return corlib_assembly; }
|
|
_FORCE_INLINE_ GDMonoAssembly *get_core_api_assembly() const { return core_api_assembly.assembly; }
|
|
_FORCE_INLINE_ GDMonoAssembly *get_project_assembly() const { return project_assembly; }
|
|
#ifdef TOOLS_ENABLED
|
|
_FORCE_INLINE_ GDMonoAssembly *get_editor_api_assembly() const { return editor_api_assembly.assembly; }
|
|
_FORCE_INLINE_ GDMonoAssembly *get_tools_assembly() const { return tools_assembly; }
|
|
_FORCE_INLINE_ GDMonoAssembly *get_tools_project_editor_assembly() const { return tools_project_editor_assembly; }
|
|
#endif
|
|
|
|
#if defined(WINDOWS_ENABLED) && defined(TOOLS_ENABLED)
|
|
const MonoRegInfo &get_mono_reg_info() { return mono_reg_info; }
|
|
#endif
|
|
|
|
GDMonoClass *get_class(MonoClass *p_raw_class);
|
|
GDMonoClass *get_class(const StringName &p_namespace, const StringName &p_name);
|
|
|
|
#ifdef GD_MONO_HOT_RELOAD
|
|
Error reload_scripts_domain();
|
|
#endif
|
|
|
|
bool load_assembly(const String &p_name, GDMonoAssembly **r_assembly, bool p_refonly = false);
|
|
bool load_assembly(const String &p_name, MonoAssemblyName *p_aname, GDMonoAssembly **r_assembly, bool p_refonly = false);
|
|
bool load_assembly(const String &p_name, MonoAssemblyName *p_aname, GDMonoAssembly **r_assembly, bool p_refonly, const Vector<String> &p_search_dirs);
|
|
bool load_assembly_from(const String &p_name, const String &p_path, GDMonoAssembly **r_assembly, bool p_refonly = false);
|
|
|
|
Error finalize_and_unload_domain(MonoDomain *p_domain);
|
|
|
|
void initialize();
|
|
void initialize_load_assemblies();
|
|
|
|
GDMono();
|
|
~GDMono();
|
|
};
|
|
|
|
namespace gdmono {
|
|
|
|
class ScopeDomain {
|
|
MonoDomain *prev_domain;
|
|
|
|
public:
|
|
ScopeDomain(MonoDomain *p_domain) {
|
|
prev_domain = mono_domain_get();
|
|
if (prev_domain != p_domain) {
|
|
mono_domain_set(p_domain, false);
|
|
} else {
|
|
prev_domain = nullptr;
|
|
}
|
|
}
|
|
|
|
~ScopeDomain() {
|
|
if (prev_domain) {
|
|
mono_domain_set(prev_domain, false);
|
|
}
|
|
}
|
|
};
|
|
|
|
class ScopeExitDomainUnload {
|
|
MonoDomain *domain;
|
|
|
|
public:
|
|
ScopeExitDomainUnload(MonoDomain *p_domain) :
|
|
domain(p_domain) {
|
|
}
|
|
|
|
~ScopeExitDomainUnload() {
|
|
if (domain) {
|
|
GDMono::get_singleton()->finalize_and_unload_domain(domain);
|
|
}
|
|
}
|
|
};
|
|
} // namespace gdmono
|
|
|
|
#define _GDMONO_SCOPE_DOMAIN_(m_mono_domain) \
|
|
gdmono::ScopeDomain __gdmono__scope__domain__(m_mono_domain); \
|
|
(void)__gdmono__scope__domain__;
|
|
|
|
#define _GDMONO_SCOPE_EXIT_DOMAIN_UNLOAD_(m_mono_domain) \
|
|
gdmono::ScopeExitDomainUnload __gdmono__scope__exit__domain__unload__(m_mono_domain); \
|
|
(void)__gdmono__scope__exit__domain__unload__;
|
|
|
|
class _GodotSharp : public Object {
|
|
GDCLASS(_GodotSharp, Object);
|
|
|
|
friend class GDMono;
|
|
|
|
bool _is_domain_finalizing_for_unload(int32_t p_domain_id);
|
|
|
|
void _reload_assemblies(bool p_soft_reload);
|
|
|
|
protected:
|
|
static _GodotSharp *singleton;
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
static _GodotSharp *get_singleton() { return singleton; }
|
|
|
|
void attach_thread();
|
|
void detach_thread();
|
|
|
|
int32_t get_domain_id();
|
|
int32_t get_scripts_domain_id();
|
|
|
|
bool is_scripts_domain_loaded();
|
|
|
|
bool is_domain_finalizing_for_unload(int32_t p_domain_id);
|
|
bool is_domain_finalizing_for_unload(MonoDomain *p_domain);
|
|
|
|
bool is_runtime_shutting_down();
|
|
bool is_runtime_initialized();
|
|
|
|
_GodotSharp();
|
|
~_GodotSharp();
|
|
};
|
|
|
|
#endif // GD_MONO_H
|