mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-15 10:12:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
5f11e15571
godot/modules/mono/csharp_script.h

547 lines
21 KiB
C++
Raw Normal View History

Added mono module
2017-10-03 05:24:00 +08:00
/*************************************************************************/
/* csharp_script.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
Update copyright statements to 2020 Happy new year to the wonderful Godot community! We're starting a new decade with a well-established, non-profit, free and open source game engine, and tons of further improvements in the pipeline from hundreds of contributors. Godot will keep getting better, and we're looking forward to all the games that the community will keep developing and releasing with it.
2020-01-01 18:16:22 +08:00
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
Added mono module
2017-10-03 05:24:00 +08:00
/* */
/* 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. */
/*************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-05 07:50:27 +08:00
Added mono module
2017-10-03 05:24:00 +08:00
#ifndef CSHARP_SCRIPT_H
#define CSHARP_SCRIPT_H
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-12 00:13:45 +08:00
#include "core/io/resource_loader.h"
#include "core/io/resource_saver.h"
#include "core/script_language.h"
#include "core/self_list.h"
Added mono module
2017-10-03 05:24:00 +08:00
#include "mono_gc_handle.h"
#include "mono_gd/gd_mono.h"
#include "mono_gd/gd_mono_header.h"
#include "mono_gd/gd_mono_internals.h"
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.
2019-07-03 15:44:53 +08:00
#ifdef TOOLS_ENABLED
#include "editor/editor_plugin.h"
#endif
Added mono module
2017-10-03 05:24:00 +08:00
class CSharpScript;
class CSharpInstance;
class CSharpLanguage;
#ifdef NO_SAFE_CAST
template <typename TScriptInstance, typename TScriptLanguage>
TScriptInstance *cast_script_instance(ScriptInstance *p_inst) {
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
if (!p_inst)
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
return nullptr;
return p_inst->get_language() == TScriptLanguage::get_singleton() ? static_cast<TScriptInstance *>(p_inst) : nullptr;
Added mono module
2017-10-03 05:24:00 +08:00
}
#else
template <typename TScriptInstance, typename TScriptLanguage>
TScriptInstance *cast_script_instance(ScriptInstance *p_inst) {
return dynamic_cast<TScriptInstance *>(p_inst);
}
#endif
#define CAST_CSHARP_INSTANCE(m_inst) (cast_script_instance<CSharpInstance, CSharpLanguage>(m_inst))
class CSharpScript : public Script {
Made use of semicolons more consitent, fixed formatting
2019-03-20 02:35:57 +08:00
GDCLASS(CSharpScript, Script);
Added mono module
2017-10-03 05:24:00 +08:00
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
public:
struct SignalParameter {
String name;
Variant::Type type;
bool nil_is_variant = false;
};
struct EventSignal {
GDMonoField *field = NULL;
GDMonoMethod *invoke_method = NULL;
Vector<SignalParameter> parameters;
};
private:
Added mono module
2017-10-03 05:24:00 +08:00
friend class CSharpInstance;
friend class CSharpLanguage;
Fix msvc warnings in mono module - `modules\mono\csharp_script.cpp(576): warning C4099: 'CSharpScriptDepSort': type name first seen using 'class' now seen using 'struct'` - `modules\mono\signal_awaiter_utils.cpp(144): warning C4003: not enough actual parameters for macro 'ERR_FAIL_V'` - `modules\mono\editor\net_solution.cpp(101): warning C4129: '%': unrecognized character escape sequence` - (several) `modules\mono\glue\cs_compressed.gen.h(222): warning C4129: 'E': unrecognized character escape sequence`
2018-10-23 01:27:41 +08:00
friend struct CSharpScriptDepSort;
Added mono module
2017-10-03 05:24:00 +08:00
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
bool tool = false;
bool valid = false;
Added mono module
2017-10-03 05:24:00 +08:00
bool builtin;
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
GDMonoClass *base = nullptr;
GDMonoClass *native = nullptr;
GDMonoClass *script_class = nullptr;
Added mono module
2017-10-03 05:24:00 +08:00
Ref<CSharpScript> base_cache; // TODO what's this for?
Set<Object *> instances;
Mono: Fix hot reload build errors and cleanup
2019-01-23 01:33:36 +08:00
#ifdef GD_MONO_HOT_RELOAD
C#: Improve tool script support and fix reloading issues
2018-12-01 03:43:06 +08:00
struct StateBackup {
// TODO
// Replace with buffer containing the serialized state of managed scripts.
// Keep variant state backup to use only with script instance placeholders.
Style: Set clang-format Standard to Cpp11 For us, it practically only changes the fact that `A<A<int>>` is now used instead of the C++03 compatible `A<A<int> >`. Note: clang-format 10+ changed the `Standard` arguments to fully specified `c++11`, `c++14`, etc. versions, but we can't use `c++17` now if we want to preserve compatibility with clang-format 8 and 9. `Cpp11` is still supported as deprecated alias for `Latest`.
2020-03-17 14:33:00 +08:00
List<Pair<StringName, Variant>> properties;
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
List<Pair<StringName, Array>> event_signals;
C#: Improve tool script support and fix reloading issues
2018-12-01 03:43:06 +08:00
};
Mono: Fix hot reload build errors and cleanup
2019-01-23 01:33:36 +08:00
Set<ObjectID> pending_reload_instances;
Map<ObjectID, StateBackup> pending_reload_state;
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.
2019-07-03 15:44:53 +08:00
StringName tied_class_name_for_reload;
StringName tied_class_namespace_for_reload;
C#: Improve tool script support and fix reloading issues
2018-12-01 03:43:06 +08:00
#endif
Added mono module
2017-10-03 05:24:00 +08:00
String source;
StringName name;
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
SelfList<CSharpScript> script_list = this;
implement signal related methods in csharp_script so signals can be used with emit
2018-01-19 06:27:43 +08:00
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
Map<StringName, Vector<SignalParameter>> _signals;
Map<StringName, EventSignal> event_signals;
bool signals_invalidated = true;
fix release builds with mono "_signals" and "signals_invalidated" were moved out of the "TOOLS_ENABLED" directive. Updated also the two "update_signals" and "_update_signals" methods so it makes sense.
2018-02-19 05:47:43 +08:00
Optmized data sent during RPC and RSet calls. - Now is sent the method ID rather the full function name. - The passed IDs (Node and Method) are compressed so to use less possible space. - The variant (INT and BOOL) is now encoded and compressed so to use much less data. - Optimized RPCMode retrieval for GDScript functions. - Added checksum to assert the methods are the same across peers. This work has been kindly sponsored by IMVU.
2020-02-12 18:51:50 +08:00
Vector<ScriptNetData> rpc_functions;
Vector<ScriptNetData> rpc_variables;
Added mono module
2017-10-03 05:24:00 +08:00
#ifdef TOOLS_ENABLED
List<PropertyInfo> exported_members_cache; // members_cache
Map<StringName, Variant> exported_members_defval_cache; // member_default_values_cache
Set<PlaceHolderScriptInstance *> placeholders;
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
bool source_changed_cache = false;
bool placeholder_fallback_enabled = false;
bool exports_invalidated = true;
Added mono module
2017-10-03 05:24:00 +08:00
void _update_exports_values(Map<StringName, Variant> &values, List<PropertyInfo> &propnames);
Mono: Fix build errors with tools=no
2019-07-08 21:22:51 +08:00
void _update_member_info_no_exports();
Added mono module
2017-10-03 05:24:00 +08:00
virtual void _placeholder_erased(PlaceHolderScriptInstance *p_placeholder);
#endif
Map<StringName, PropertyInfo> member_info;
void _clear();
Mono: Fixes annotated signal loading in exported binaries
2018-07-01 09:14:40 +08:00
void load_script_signals(GDMonoClass *p_class, GDMonoClass *p_native_class);
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
bool _get_signal(GDMonoClass *p_class, GDMonoMethod *p_delegate_invoke, Vector<SignalParameter> &params);
add a [Signal] attribute to CSharpScripts
2018-01-19 01:17:29 +08:00
Added mono module
2017-10-03 05:24:00 +08:00
bool _update_exports();
Mono: Fix build errors with tools=no and target=release
2018-01-28 01:44:04 +08:00
#ifdef TOOLS_ENABLED
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.
2019-07-03 15:44:53 +08:00
bool _get_member_export(IMonoClassMember *p_member, bool p_inspect_export, PropertyInfo &r_prop_info, bool &r_exported);
C#: Marshalling support for IEnumerable<> and IDictionary<,> Also fixed the hint string of exported members.
2019-05-18 10:14:21 +08:00
static int _try_get_member_export_hint(IMonoClassMember *p_member, ManagedType p_type, Variant::Type p_variant_type, bool p_allow_generics, PropertyHint &r_hint, String &r_hint_string);
Mono: Fix build errors with tools=no and target=release
2018-01-28 01:44:04 +08:00
#endif
Mono: Add properties support in scripts
2018-01-05 04:05:46 +08:00
Reworked signal connection system, added support for Callable and Signal objects and made them default.
2020-02-20 03:27:19 +08:00
CSharpInstance *_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_isref, Callable::CallError &r_error);
Variant _new(const Variant **p_args, int p_argcount, Callable::CallError &r_error);
Added mono module
2017-10-03 05:24:00 +08:00
// Do not use unless you know what you are doing
friend void GDMonoInternals::tie_managed_to_unmanaged(MonoObject *, Object *);
Use script instance binding for objects constructed from C# Only possible if the object class is a "native type". If the object class is a user class (that derives a "native type") then a script is needed. Since CSharpLanguage does cleanup of script instance bindings when finished, cases like #25621 will no longer cause problems. Fixed ~Object() trying to free script instance bindings after the language has already been removed, which would result in a NULL dereference.
2019-02-05 03:39:02 +08:00
static Ref<CSharpScript> create_for_managed_type(GDMonoClass *p_class, GDMonoClass *p_native);
C#: Fix some crashes during assemblies reloading
2019-07-08 21:18:38 +08:00
static void initialize_for_managed_type(Ref<CSharpScript> p_script, GDMonoClass *p_class, GDMonoClass *p_native);
Added mono module
2017-10-03 05:24:00 +08:00
Optmized data sent during RPC and RSet calls. - Now is sent the method ID rather the full function name. - The passed IDs (Node and Method) are compressed so to use less possible space. - The variant (INT and BOOL) is now encoded and compressed so to use much less data. - Optimized RPCMode retrieval for GDScript functions. - Added checksum to assert the methods are the same across peers. This work has been kindly sponsored by IMVU.
2020-02-12 18:51:50 +08:00
MultiplayerAPI::RPCMode _member_get_rpc_mode(IMonoClassMember *p_member) const;
Added mono module
2017-10-03 05:24:00 +08:00
protected:
static void _bind_methods();
Reworked signal connection system, added support for Callable and Signal objects and made them default.
2020-02-20 03:27:19 +08:00
Variant call(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error);
Added mono module
2017-10-03 05:24:00 +08:00
virtual void _resource_path_changed();
Mono: support custom script templates. Also fixes a bug that prevented methods like `duplicate()` from copying the source code. (Copied from GDScript implementation)
2017-10-31 05:17:20 +08:00
bool _get(const StringName &p_name, Variant &r_ret) const;
bool _set(const StringName &p_name, const Variant &p_value);
void _get_property_list(List<PropertyInfo> *p_properties) const;
Added mono module
2017-10-03 05:24:00 +08:00
public:
virtual bool can_instance() const;
virtual StringName get_instance_base_type() const;
virtual ScriptInstance *instance_create(Object *p_this);
Fix case where exported properties value is lost Fixes exported property modified values lost when creating a placeholder script instance with a failed script compilation - Object set/get will call PlaceHolderScriptInstance's new fallback set/get methods as a last resort. This way, placeholder script instances can keep the values for storage or until the script is compiled successfuly. - Script::can_instance() will only return true if a real script instance can be created. Otherwise, in the case of placeholder script instances, it will return false. - Object::set_script(script) is now in charge of requesting the creation of placeholder script instances. It's no longer Script::instance_create(owner)'s duty. - PlaceHolderScriptInstance has a new method set_build_failed(bool) to determine whether it should call into its script methods or not. - Fixed a few problems during reloading of C# scripts.
2018-07-30 04:40:09 +08:00
virtual PlaceHolderScriptInstance *placeholder_instance_create(Object *p_this);
Added mono module
2017-10-03 05:24:00 +08:00
virtual bool instance_has(const Object *p_this) const;
virtual bool has_source_code() const;
virtual String get_source_code() const;
virtual void set_source_code(const String &p_code);
virtual Error reload(bool p_keep_state = false);
implement signal related methods in csharp_script so signals can be used with emit
2018-01-19 06:27:43 +08:00
virtual bool has_script_signal(const StringName &p_signal) const;
virtual void get_script_signal_list(List<MethodInfo> *r_signals) const;
Added mono module
2017-10-03 05:24:00 +08:00
Mono: Partially implement some Godot debug api functions Debug breaks sent with debug_break and debug_break_parse should display correctly in the Godot debugger now.
2019-03-08 03:47:13 +08:00
virtual bool get_property_default_value(const StringName &p_property, Variant &r_value) const;
Added mono module
2017-10-03 05:24:00 +08:00
virtual void get_script_property_list(List<PropertyInfo> *p_list) const;
virtual void update_exports();
virtual bool is_tool() const { return tool; }
Implement CSharpScript::is_valid()
2018-12-01 04:45:44 +08:00
virtual bool is_valid() const { return valid; }
Allow signal connecting even if script is invalid (only when compiled with tools), fixes #17070
2018-11-28 06:55:37 +08:00
Added mono module
2017-10-03 05:24:00 +08:00
virtual Ref<Script> get_base_script() const;
virtual ScriptLanguage *get_language() const;
Implement CSharpScript::get_script_method_list and related functionality.
2018-11-01 23:35:16 +08:00
virtual void get_script_method_list(List<MethodInfo> *p_list) const;
Added mono module
2017-10-03 05:24:00 +08:00
bool has_method(const StringName &p_method) const;
Implement CSharpScript::get_script_method_list and related functionality.
2018-11-01 23:35:16 +08:00
MethodInfo get_method_info(const StringName &p_method) const;
Added mono module
2017-10-03 05:24:00 +08:00
virtual int get_member_line(const StringName &p_member) const;
Optmized data sent during RPC and RSet calls. - Now is sent the method ID rather the full function name. - The passed IDs (Node and Method) are compressed so to use less possible space. - The variant (INT and BOOL) is now encoded and compressed so to use much less data. - Optimized RPCMode retrieval for GDScript functions. - Added checksum to assert the methods are the same across peers. This work has been kindly sponsored by IMVU.
2020-02-12 18:51:50 +08:00
virtual Vector<ScriptNetData> get_rpc_methods() const;
virtual uint16_t get_rpc_method_id(const StringName &p_method) const;
virtual StringName get_rpc_method(const uint16_t p_rpc_method_id) const;
virtual MultiplayerAPI::RPCMode get_rpc_mode_by_id(const uint16_t p_rpc_method_id) const;
virtual MultiplayerAPI::RPCMode get_rpc_mode(const StringName &p_method) const;
virtual Vector<ScriptNetData> get_rset_properties() const;
virtual uint16_t get_rset_property_id(const StringName &p_variable) const;
virtual StringName get_rset_property(const uint16_t p_variable_id) const;
virtual MultiplayerAPI::RPCMode get_rset_mode_by_id(const uint16_t p_variable_id) const;
virtual MultiplayerAPI::RPCMode get_rset_mode(const StringName &p_variable) const;
Fix properties being lost when reloading placeholder GDScript instance During reloading in `GDScriptLanguage::reload_all_scripts` a placeholder instance that must remain so is replaced with a new placeholder instance. The state is then restored by calling `ScriptInstance::set` for each property. This does not work if the script is missing the properties due to build/parse failing. The fix for such cases is to call `placeholder_set_fallback` instead of `set` on the script instance. I took this chance to move the `build_failed` flag from `PlaceHolderScriptInstance` to `Script`. That improves the code a lot. I also renamed it to `placeholder_fallback_enabled` which is a much better name (`build_failed` could lead to misunderstandings).
2019-01-10 07:26:00 +08:00
#ifdef TOOLS_ENABLED
virtual bool is_placeholder_fallback_enabled() const { return placeholder_fallback_enabled; }
#endif
Added mono module
2017-10-03 05:24:00 +08:00
Error load_source_code(const String &p_path);
StringName get_script_name() const;
CSharpScript();
~CSharpScript();
};
class CSharpInstance : public ScriptInstance {
friend class CSharpScript;
friend class CSharpLanguage;
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
Object *owner = nullptr;
bool base_ref = false;
bool ref_dying = false;
bool unsafe_referenced = false;
bool predelete_notified = false;
bool destructing_script_instance = false;
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
Ref<CSharpScript> script;
Mono/C#: Optimize the way we store GC handles for scripts Don't store GC handles for C# script instances and instance bindings as 'Ref<MonoGCHandle>'; store the raw data instead. Initially this was not possible as we needed to store a Variant, but this had not been the case for a looong time yet the stored type was never updated.
2019-12-12 00:08:40 +08:00
MonoGCHandleData gchandle;
Added mono module
2017-10-03 05:24:00 +08:00
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
Vector<Callable> event_signal_callables;
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
bool _reference_owner_unsafe();
Mono: Lifetime fixes for CSharpInstance and instance binding data Avoid CSharpInstance from accessing its state after self destructing (by deleting the Reference owner). It's now safe to replace the script instance without leaking or crashing. Also fixed godot_icall_Object_weakref return reference being freed before returning.
2019-02-03 13:35:22 +08:00
/*
* If true is returned, the caller must memdelete the script instance's owner.
*/
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
bool _unreference_owner_unsafe();
Mono: Lifetime fixes for CSharpInstance and instance binding data Avoid CSharpInstance from accessing its state after self destructing (by deleting the Reference owner). It's now safe to replace the script instance without leaking or crashing. Also fixed godot_icall_Object_weakref return reference being freed before returning.
2019-02-03 13:35:22 +08:00
/*
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
* If nullptr is returned, the caller must destroy the script instance by removing it from its owner.
Mono: Lifetime fixes for CSharpInstance and instance binding data Avoid CSharpInstance from accessing its state after self destructing (by deleting the Reference owner). It's now safe to replace the script instance without leaking or crashing. Also fixed godot_icall_Object_weakref return reference being freed before returning.
2019-02-03 13:35:22 +08:00
*/
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
MonoObject *_internal_new_managed();
Added mono module
2017-10-03 05:24:00 +08:00
// Do not use unless you know what you are doing
friend void GDMonoInternals::tie_managed_to_unmanaged(MonoObject *, Object *);
Mono/C#: Optimize the way we store GC handles for scripts Don't store GC handles for C# script instances and instance bindings as 'Ref<MonoGCHandle>'; store the raw data instead. Initially this was not possible as we needed to store a Variant, but this had not been the case for a looong time yet the stored type was never updated.
2019-12-12 00:08:40 +08:00
static CSharpInstance *create_for_managed_type(Object *p_owner, CSharpScript *p_script, const MonoGCHandleData &p_gchandle);
Added mono module
2017-10-03 05:24:00 +08:00
Mono: Script lifetime fixes - alloc_language_binding: Use strong GC handle as well for references. Fixes #15138 - Set the native instance field of Godot.Object to IntPtr.Zero when it's freed. - Create weak handles without tracking resurrection (that was causing trouble). This means we have to call notification predelete before queueing a native Object for deletion, and use the MonoObject* passed by the finalizer because the weak GC handle target will return NULL at this point.
2018-01-01 05:37:57 +08:00
void _call_multilevel(MonoObject *p_mono_object, const StringName &p_method, const Variant **p_args, int p_argcount);
Style: Set clang-format Standard to Cpp11 For us, it practically only changes the fact that `A<A<int>>` is now used instead of the C++03 compatible `A<A<int> >`. Note: clang-format 10+ changed the `Standard` arguments to fully specified `c++11`, `c++14`, etc. versions, but we can't use `c++17` now if we want to preserve compatibility with clang-format 8 and 9. `Cpp11` is still supported as deprecated alias for `Latest`.
2020-03-17 14:33:00 +08:00
void get_properties_state_for_reloading(List<Pair<StringName, Variant>> &r_state);
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
void get_event_signals_state_for_reloading(List<Pair<StringName, Array>> &r_state);
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.
2019-07-03 15:44:53 +08:00
Added mono module
2017-10-03 05:24:00 +08:00
public:
MonoObject *get_mono_object() const;
Fix crash due to ~CSharpInstance() being called on freed instance This would be the case when calling SetScript on an object with a C# script.
2018-12-01 09:23:55 +08:00
_FORCE_INLINE_ bool is_destructing_script_instance() { return destructing_script_instance; }
Mono: Lifetime fixes for CSharpInstance and instance binding data Avoid CSharpInstance from accessing its state after self destructing (by deleting the Reference owner). It's now safe to replace the script instance without leaking or crashing. Also fixed godot_icall_Object_weakref return reference being freed before returning.
2019-02-03 13:35:22 +08:00
virtual Object *get_owner();
Added mono module
2017-10-03 05:24:00 +08:00
virtual bool set(const StringName &p_name, const Variant &p_value);
virtual bool get(const StringName &p_name, Variant &r_ret) const;
virtual void get_property_list(List<PropertyInfo> *p_properties) const;
virtual Variant::Type get_property_type(const StringName &p_name, bool *r_is_valid) const;
/* TODO */ virtual void get_method_list(List<MethodInfo> *p_list) const {}
virtual bool has_method(const StringName &p_method) const;
Reworked signal connection system, added support for Callable and Signal objects and made them default.
2020-02-20 03:27:19 +08:00
virtual Variant call(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error);
Added mono module
2017-10-03 05:24:00 +08:00
virtual void call_multilevel(const StringName &p_method, const Variant **p_args, int p_argcount);
virtual void call_multilevel_reversed(const StringName &p_method, const Variant **p_args, int p_argcount);
Mono: Fix build regression due to wrong return type
2018-09-13 03:08:18 +08:00
void mono_object_disposed(MonoObject *p_obj);
Mono: Lifetime fixes for CSharpInstance and instance binding data Avoid CSharpInstance from accessing its state after self destructing (by deleting the Reference owner). It's now safe to replace the script instance without leaking or crashing. Also fixed godot_icall_Object_weakref return reference being freed before returning.
2019-02-03 13:35:22 +08:00
/*
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
* If 'r_delete_owner' is set to true, the caller must memdelete the script instance's owner. Otherwise, ifevent_signal
Mono: Lifetime fixes for CSharpInstance and instance binding data Avoid CSharpInstance from accessing its state after self destructing (by deleting the Reference owner). It's now safe to replace the script instance without leaking or crashing. Also fixed godot_icall_Object_weakref return reference being freed before returning.
2019-02-03 13:35:22 +08:00
* 'r_remove_script_instance' is set to true, the caller must destroy the script instance by removing it from its owner.
*/
void mono_object_disposed_baseref(MonoObject *p_obj, bool p_is_finalizer, bool &r_delete_owner, bool &r_remove_script_instance);
Added mono module
2017-10-03 05:24:00 +08:00
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
void connect_event_signals();
void disconnect_event_signals();
Mono: Script lifetime fixes - alloc_language_binding: Use strong GC handle as well for references. Fixes #15138 - Set the native instance field of Godot.Object to IntPtr.Zero when it's freed. - Create weak handles without tracking resurrection (that was causing trouble). This means we have to call notification predelete before queueing a native Object for deletion, and use the MonoObject* passed by the finalizer because the weak GC handle target will return NULL at this point.
2018-01-01 05:37:57 +08:00
virtual void refcount_incremented();
virtual bool refcount_decremented();
Added mono module
2017-10-03 05:24:00 +08:00
Optmized data sent during RPC and RSet calls. - Now is sent the method ID rather the full function name. - The passed IDs (Node and Method) are compressed so to use less possible space. - The variant (INT and BOOL) is now encoded and compressed so to use much less data. - Optimized RPCMode retrieval for GDScript functions. - Added checksum to assert the methods are the same across peers. This work has been kindly sponsored by IMVU.
2020-02-12 18:51:50 +08:00
virtual Vector<ScriptNetData> get_rpc_methods() const;
virtual uint16_t get_rpc_method_id(const StringName &p_method) const;
virtual StringName get_rpc_method(const uint16_t p_rpc_method_id) const;
virtual MultiplayerAPI::RPCMode get_rpc_mode_by_id(const uint16_t p_rpc_method_id) const;
Refactor RPCMode enum and checks
2018-05-13 13:07:56 +08:00
virtual MultiplayerAPI::RPCMode get_rpc_mode(const StringName &p_method) const;
Optmized data sent during RPC and RSet calls. - Now is sent the method ID rather the full function name. - The passed IDs (Node and Method) are compressed so to use less possible space. - The variant (INT and BOOL) is now encoded and compressed so to use much less data. - Optimized RPCMode retrieval for GDScript functions. - Added checksum to assert the methods are the same across peers. This work has been kindly sponsored by IMVU.
2020-02-12 18:51:50 +08:00
virtual Vector<ScriptNetData> get_rset_properties() const;
virtual uint16_t get_rset_property_id(const StringName &p_variable) const;
virtual StringName get_rset_property(const uint16_t p_variable_id) const;
virtual MultiplayerAPI::RPCMode get_rset_mode_by_id(const uint16_t p_variable_id) const;
Refactor RPCMode enum and checks
2018-05-13 13:07:56 +08:00
virtual MultiplayerAPI::RPCMode get_rset_mode(const StringName &p_variable) const;
Added mono module
2017-10-03 05:24:00 +08:00
virtual void notification(int p_notification);
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
void _call_notification(int p_notification);
Added mono module
2017-10-03 05:24:00 +08:00
C#: Implement ScriptInstance::to_string Create a blacklist of methods that must not be generated. Includes: "to_string", "_to_string" and "_init".
2019-05-24 06:40:16 +08:00
virtual String to_string(bool *r_valid);
Added mono module
2017-10-03 05:24:00 +08:00
virtual Ref<Script> get_script() const;
virtual ScriptLanguage *get_language();
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
CSharpInstance(const Ref<CSharpScript> &p_script);
Added mono module
2017-10-03 05:24:00 +08:00
~CSharpInstance();
};
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
struct CSharpScriptBinding {
Mono: Lifetime fixes for CSharpInstance and instance binding data Avoid CSharpInstance from accessing its state after self destructing (by deleting the Reference owner). It's now safe to replace the script instance without leaking or crashing. Also fixed godot_icall_Object_weakref return reference being freed before returning.
2019-02-03 13:35:22 +08:00
bool inited;
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
StringName type_name;
GDMonoClass *wrapper_class;
Mono/C#: Optimize the way we store GC handles for scripts Don't store GC handles for C# script instances and instance bindings as 'Ref<MonoGCHandle>'; store the raw data instead. Initially this was not possible as we needed to store a Variant, but this had not been the case for a looong time yet the stored type was never updated.
2019-12-12 00:08:40 +08:00
MonoGCHandleData gchandle;
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.
2019-07-03 15:44:53 +08:00
Object *owner;
Mono/C#: Optimize the way we store GC handles for scripts Don't store GC handles for C# script instances and instance bindings as 'Ref<MonoGCHandle>'; store the raw data instead. Initially this was not possible as we needed to store a Variant, but this had not been the case for a looong time yet the stored type was never updated.
2019-12-12 00:08:40 +08:00
CSharpScriptBinding() :
inited(false),
wrapper_class(NULL),
owner(NULL) {
}
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
};
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
class ManagedCallableMiddleman : public Object {
GDCLASS(ManagedCallableMiddleman, Object);
};
Added mono module
2017-10-03 05:24:00 +08:00
class CSharpLanguage : public ScriptLanguage {
friend class CSharpScript;
friend class CSharpInstance;
static CSharpLanguage *singleton;
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
bool finalizing = false;
bool finalized = false;
Mono: Script lifetime fixes - alloc_language_binding: Use strong GC handle as well for references. Fixes #15138 - Set the native instance field of Godot.Object to IntPtr.Zero when it's freed. - Create weak handles without tracking resurrection (that was causing trouble). This means we have to call notification predelete before queueing a native Object for deletion, and use the MonoObject* passed by the finalizer because the weak GC handle target will return NULL at this point.
2018-01-01 05:37:57 +08:00
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
GDMono *gdmono = nullptr;
Added mono module
2017-10-03 05:24:00 +08:00
SelfList<CSharpScript>::List script_list;
Reimplement Mutex with C++'s <mutex> Main: - It's now implemented thanks to `<mutex>`. No more platform-specific implementations. - `BinaryMutex` (non-recursive) is added, as an alternative for special cases. - Doesn't need allocation/deallocation anymore. It can live in the stack and be part of other classes. - Because of that, it's methods are now `const` and the inner mutex is `mutable` so it can be easily used in `const` contexts. - A no-op implementation is provided if `NO_THREADS` is defined. No more need to add `#ifdef NO_THREADS` just for this. - `MutexLock` now takes a reference. At this point the cases of null `Mutex`es are rare. If you ever need that, just don't use `MutexLock`. - Thread-safe utilities are therefore simpler now. Misc.: - `ScopedMutexLock` is dropped and replaced by `MutexLock`, because they were pretty much the same. - Every case of lock, do-something, unlock is replaced by `MutexLock` (complex cases where it's not straightfoward are kept as as explicit lock and unlock). - `ShaderRD` contained an `std::mutex`, which has been replaced by `Mutex`.
2020-02-26 18:28:13 +08:00
Mutex script_instances_mutex;
Mutex script_gchandle_release_mutex;
Mutex language_bind_mutex;
Added mono module
2017-10-03 05:24:00 +08:00
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
Map<Object *, CSharpScriptBinding> script_bindings;
Added mono module
2017-10-03 05:24:00 +08:00
Mono/C#: Add error checks to detect possible Reference leaks
2020-01-14 04:00:07 +08:00
#ifdef DEBUG_ENABLED
Mono/C#: Lighten up unsafe reference checks Because of the weird case with multi-threading and ResourceLoader, it can be the case that a resource is GCed while being referenced again in the main thread. In such cases, a new unsafe reference is created before the finalizer thread removes the previous one.
2020-01-24 04:23:32 +08:00
// List of unsafe object references
Map<ObjectID, int> unsafe_object_references;
Reimplement Mutex with C++'s <mutex> Main: - It's now implemented thanks to `<mutex>`. No more platform-specific implementations. - `BinaryMutex` (non-recursive) is added, as an alternative for special cases. - Doesn't need allocation/deallocation anymore. It can live in the stack and be part of other classes. - Because of that, it's methods are now `const` and the inner mutex is `mutable` so it can be easily used in `const` contexts. - A no-op implementation is provided if `NO_THREADS` is defined. No more need to add `#ifdef NO_THREADS` just for this. - `MutexLock` now takes a reference. At this point the cases of null `Mutex`es are rare. If you ever need that, just don't use `MutexLock`. - Thread-safe utilities are therefore simpler now. Misc.: - `ScopedMutexLock` is dropped and replaced by `MutexLock`, because they were pretty much the same. - Every case of lock, do-something, unlock is replaced by `MutexLock` (complex cases where it's not straightfoward are kept as as explicit lock and unlock). - `ShaderRD` contained an `std::mutex`, which has been replaced by `Mutex`.
2020-02-26 18:28:13 +08:00
Mutex unsafe_object_references_lock;
Mono/C#: Add error checks to detect possible Reference leaks
2020-01-14 04:00:07 +08:00
#endif
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
ManagedCallableMiddleman *managed_callable_middleman = memnew(ManagedCallableMiddleman);
Added mono module
2017-10-03 05:24:00 +08:00
struct StringNameCache {
Re-write SignalAwaiter implementation Old implementation had issues where you could only await on the same signal of the same source once.
2017-10-16 09:54:23 +08:00
StringName _signal_callback;
Added mono module
2017-10-03 05:24:00 +08:00
StringName _set;
StringName _get;
Fixes #17233 allowing C# to override _GetPropertyList
2019-03-28 19:01:43 +08:00
StringName _get_property_list;
Added mono module
2017-10-03 05:24:00 +08:00
StringName _notification;
Mono: support custom script templates. Also fixes a bug that prevented methods like `duplicate()` from copying the source code. (Copied from GDScript implementation)
2017-10-31 05:17:20 +08:00
StringName _script_source;
Added mono module
2017-10-03 05:24:00 +08:00
StringName dotctor; // .ctor
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.
2019-07-03 15:44:53 +08:00
StringName on_before_serialize; // OnBeforeSerialize
StringName on_after_deserialize; // OnAfterDeserialize
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
StringName delegate_invoke_method_name;
Added mono module
2017-10-03 05:24:00 +08:00
StringNameCache();
};
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
int lang_idx = -1;
Added mono module
2017-10-03 05:24:00 +08:00
Parse C# script namespace and class - Added a very simple parser that can extract the namespace and class name of a C# script.
2018-10-23 01:43:19 +08:00
Dictionary scripts_metadata;
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
bool scripts_metadata_invalidated = true;
Parse C# script namespace and class - Added a very simple parser that can extract the namespace and class name of a C# script.
2018-10-23 01:43:19 +08:00
Mono: Partially implement some Godot debug api functions Debug breaks sent with debug_break and debug_break_parse should display correctly in the Godot debugger now.
2019-03-08 03:47:13 +08:00
// For debug_break and debug_break_parse
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
int _debug_parse_err_line = -1;
Mono: Partially implement some Godot debug api functions Debug breaks sent with debug_break and debug_break_parse should display correctly in the Godot debugger now.
2019-03-08 03:47:13 +08:00
String _debug_parse_err_file;
String _debug_error;
Mono: Lazily load scripts metadata file - Only load the scripts metadata file when it's really needed. This way we avoid false errors, when there is no C# project, about missing scripts metadata file.
2019-04-26 07:19:54 +08:00
void _load_scripts_metadata();
Mono: Fix crash when re-using script binding after domain reloading
2019-03-08 02:55:40 +08:00
friend class GDMono;
Mono: Lazily load scripts metadata file - Only load the scripts metadata file when it's really needed. This way we avoid false errors, when there is no C# project, about missing scripts metadata file.
2019-04-26 07:19:54 +08:00
void _on_scripts_domain_unloaded();
Mono: Fix crash when re-using script binding after domain reloading
2019-03-08 02:55:40 +08:00
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.
2019-07-03 15:44:53 +08:00
#ifdef TOOLS_ENABLED
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
EditorPlugin *godotsharp_editor = nullptr;
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.
2019-07-03 15:44:53 +08:00
static void _editor_init_callback();
#endif
Added mono module
2017-10-03 05:24:00 +08:00
public:
Mono: support custom script templates. Also fixes a bug that prevented methods like `duplicate()` from copying the source code. (Copied from GDScript implementation)
2017-10-31 05:17:20 +08:00
StringNameCache string_names;
Reimplement Mutex with C++'s <mutex> Main: - It's now implemented thanks to `<mutex>`. No more platform-specific implementations. - `BinaryMutex` (non-recursive) is added, as an alternative for special cases. - Doesn't need allocation/deallocation anymore. It can live in the stack and be part of other classes. - Because of that, it's methods are now `const` and the inner mutex is `mutable` so it can be easily used in `const` contexts. - A no-op implementation is provided if `NO_THREADS` is defined. No more need to add `#ifdef NO_THREADS` just for this. - `MutexLock` now takes a reference. At this point the cases of null `Mutex`es are rare. If you ever need that, just don't use `MutexLock`. - Thread-safe utilities are therefore simpler now. Misc.: - `ScopedMutexLock` is dropped and replaced by `MutexLock`, because they were pretty much the same. - Every case of lock, do-something, unlock is replaced by `MutexLock` (complex cases where it's not straightfoward are kept as as explicit lock and unlock). - `ShaderRD` contained an `std::mutex`, which has been replaced by `Mutex`.
2020-02-26 18:28:13 +08:00
const Mutex &get_language_bind_mutex() { return language_bind_mutex; }
Use script instance binding for objects constructed from C# Only possible if the object class is a "native type". If the object class is a user class (that derives a "native type") then a script is needed. Since CSharpLanguage does cleanup of script instance bindings when finished, cases like #25621 will no longer cause problems. Fixed ~Object() trying to free script instance bindings after the language has already been removed, which would result in a NULL dereference.
2019-02-05 03:39:02 +08:00
Added mono module
2017-10-03 05:24:00 +08:00
_FORCE_INLINE_ int get_language_index() { return lang_idx; }
void set_language_index(int p_idx);
Re-write SignalAwaiter implementation Old implementation had issues where you could only await on the same signal of the same source once.
2017-10-16 09:54:23 +08:00
_FORCE_INLINE_ const StringNameCache &get_string_names() { return string_names; }
Added mono module
2017-10-03 05:24:00 +08:00
_FORCE_INLINE_ static CSharpLanguage *get_singleton() { return singleton; }
Mono: Fix build errors with tools=no
2019-07-08 21:22:51 +08:00
#ifdef TOOLS_ENABLED
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.
2019-07-03 15:44:53 +08:00
_FORCE_INLINE_ EditorPlugin *get_godotsharp_editor() const { return godotsharp_editor; }
Mono: Fix build errors with tools=no
2019-07-08 21:22:51 +08:00
#endif
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.
2019-07-03 15:44:53 +08:00
Mono/C#: Optimize the way we store GC handles for scripts Don't store GC handles for C# script instances and instance bindings as 'Ref<MonoGCHandle>'; store the raw data instead. Initially this was not possible as we needed to store a Variant, but this had not been the case for a looong time yet the stored type was never updated.
2019-12-12 00:08:40 +08:00
static void release_script_gchandle(MonoGCHandleData &p_gchandle);
static void release_script_gchandle(MonoObject *p_expected_obj, MonoGCHandleData &p_gchandle);
Fix/workaround for issue #21667 When a Reference managed instance is garbage collected and its finalizer is called, it could happen that the native instance is referenced once again before the finalizer can unreference and memdelete it. The workaround is to create a new managed instance when this happens (at least for now).
2018-09-12 08:41:54 +08:00
Added mono module
2017-10-03 05:24:00 +08:00
bool debug_break(const String &p_error, bool p_allow_continue = true);
bool debug_break_parse(const String &p_file, int p_line, const String &p_error);
Mono: Fix hot reload build errors and cleanup
2019-01-23 01:33:36 +08:00
#ifdef GD_MONO_HOT_RELOAD
C#: Improve tool script support and fix reloading issues
2018-12-01 03:43:06 +08:00
bool is_assembly_reloading_needed();
void reload_assemblies(bool p_soft_reload);
Added mono module
2017-10-03 05:24:00 +08:00
#endif
Mono: Lazily load scripts metadata file - Only load the scripts metadata file when it's really needed. This way we avoid false errors, when there is no C# project, about missing scripts metadata file.
2019-04-26 07:19:54 +08:00
_FORCE_INLINE_ Dictionary get_scripts_metadata_or_nothing() {
return scripts_metadata_invalidated ? Dictionary() : scripts_metadata;
}
Parse C# script namespace and class - Added a very simple parser that can extract the namespace and class name of a C# script.
2018-10-23 01:43:19 +08:00
Mono: Lazily load scripts metadata file - Only load the scripts metadata file when it's really needed. This way we avoid false errors, when there is no C# project, about missing scripts metadata file.
2019-04-26 07:19:54 +08:00
_FORCE_INLINE_ const Dictionary &get_scripts_metadata() {
if (scripts_metadata_invalidated)
_load_scripts_metadata();
return scripts_metadata;
}
Parse C# script namespace and class - Added a very simple parser that can extract the namespace and class name of a C# script.
2018-10-23 01:43:19 +08:00
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
_FORCE_INLINE_ ManagedCallableMiddleman *get_managed_callable_middleman() const { return managed_callable_middleman; }
Added mono module
2017-10-03 05:24:00 +08:00
virtual String get_name() const;
/* LANGUAGE FUNCTIONS */
virtual String get_type() const;
virtual String get_extension() const;
virtual Error execute_file(const String &p_path);
virtual void init();
virtual void finish();
/* EDITOR FUNCTIONS */
virtual void get_reserved_words(List<String> *p_words) const;
virtual void get_comment_delimiters(List<String> *p_delimiters) const;
virtual void get_string_delimiters(List<String> *p_delimiters) const;
virtual Ref<Script> get_template(const String &p_class_name, const String &p_base_class_name) const;
Mono: support custom script templates. Also fixes a bug that prevented methods like `duplicate()` from copying the source code. (Copied from GDScript implementation)
2017-10-31 05:17:20 +08:00
virtual bool is_using_templates();
virtual void make_template(const String &p_class_name, const String &p_base_class_name, Ref<Script> &p_script);
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
/* TODO */ virtual bool validate(const String &p_script, int &r_line_error, int &r_col_error, String &r_test_error, const String &p_path, List<String> *r_functions, List<ScriptLanguage::Warning> *r_warnings = nullptr, Set<int> *r_safe_lines = nullptr) const { return true; }
Mono: Avoid invalid class names. Disallow reserved keywords as class names and prefix base class with the Godot namespace if it's the same as the class name. Fixes #12483
2018-03-10 06:34:32 +08:00
virtual String validate_path(const String &p_path) const;
Added mono module
2017-10-03 05:24:00 +08:00
virtual Script *create_script() const;
virtual bool has_named_classes() const;
Add ScriptLanguage::supports_builtin_mode and improve ScriptCreateDialog - Make ScriptCreateDialog disable the built-in script checked button if the language does not support it. - ScriptLanguage's get_template and make_template now receive the script path as class name if the the script language does not have named classes.
2017-10-24 07:54:47 +08:00
virtual bool supports_builtin_mode() const;
Added mono module
2017-10-03 05:24:00 +08:00
/* TODO? */ virtual int find_function(const String &p_function, const String &p_code) const { return -1; }
PoolVector is gone, replaced by Vector Typed `PoolTypeArray` types are now renamed `PackedTypeArray` and are sugar for `Vector<Type>`.
2020-02-18 05:06:54 +08:00
virtual String make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const;
Mono: support custom script templates. Also fixes a bug that prevented methods like `duplicate()` from copying the source code. (Copied from GDScript implementation)
2017-10-31 05:17:20 +08:00
virtual String _get_indentation() const;
Added mono module
2017-10-03 05:24:00 +08:00
/* TODO? */ virtual void auto_indent_code(String &p_code, int p_from_line, int p_to_line) const {}
/* TODO */ virtual void add_global_constant(const StringName &p_variable, const Variant &p_value) {}
/* DEBUGGER FUNCTIONS */
Mono: Partially implement some Godot debug api functions Debug breaks sent with debug_break and debug_break_parse should display correctly in the Godot debugger now.
2019-03-08 03:47:13 +08:00
virtual String debug_get_error() const;
virtual int debug_get_stack_level_count() const;
virtual int debug_get_stack_level_line(int p_level) const;
virtual String debug_get_stack_level_function(int p_level) const;
virtual String debug_get_stack_level_source(int p_level) const;
Added mono module
2017-10-03 05:24:00 +08:00
/* TODO */ virtual void debug_get_stack_level_locals(int p_level, List<String> *p_locals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {}
/* TODO */ virtual void debug_get_stack_level_members(int p_level, List<String> *p_members, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {}
/* TODO */ virtual void debug_get_globals(List<String> *p_locals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {}
/* TODO */ virtual String debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems, int p_max_depth) { return ""; }
Mono: Implement stack info for errors and exceptions
2018-01-10 00:19:03 +08:00
virtual Vector<StackInfo> debug_get_current_stack_info();
Added mono module
2017-10-03 05:24:00 +08:00
/* PROFILING FUNCTIONS */
/* TODO */ virtual void profiling_start() {}
/* TODO */ virtual void profiling_stop() {}
/* TODO */ virtual int profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) { return 0; }
/* TODO */ virtual int profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) { return 0; }
virtual void frame();
/* TODO? */ virtual void get_public_functions(List<MethodInfo> *p_functions) const {}
Style: Set clang-format Standard to Cpp11 For us, it practically only changes the fact that `A<A<int>>` is now used instead of the C++03 compatible `A<A<int> >`. Note: clang-format 10+ changed the `Standard` arguments to fully specified `c++11`, `c++14`, etc. versions, but we can't use `c++17` now if we want to preserve compatibility with clang-format 8 and 9. `Cpp11` is still supported as deprecated alias for `Latest`.
2020-03-17 14:33:00 +08:00
/* TODO? */ virtual void get_public_constants(List<Pair<String, Variant>> *p_constants) const {}
Added mono module
2017-10-03 05:24:00 +08:00
virtual void reload_all_scripts();
virtual void reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload);
/* LOADER FUNCTIONS */
virtual void get_recognized_extensions(List<String> *p_extensions) const;
#ifdef TOOLS_ENABLED
virtual Error open_in_external_editor(const Ref<Script> &p_script, int p_line, int p_col);
virtual bool overrides_external_editor();
#endif
/* THREAD ATTACHING */
virtual void thread_enter();
virtual void thread_exit();
// Don't use these. I'm watching you
virtual void *alloc_instance_binding_data(Object *p_object);
virtual void free_instance_binding_data(void *p_data);
Notify instance binding data api of refcount increment/decrement
2018-02-22 22:34:08 +08:00
virtual void refcount_incremented_instance_binding(Object *p_object);
virtual bool refcount_decremented_instance_binding(Object *p_object);
Added mono module
2017-10-03 05:24:00 +08:00
Use script instance binding for objects constructed from C# Only possible if the object class is a "native type". If the object class is a user class (that derives a "native type") then a script is needed. Since CSharpLanguage does cleanup of script instance bindings when finished, cases like #25621 will no longer cause problems. Fixed ~Object() trying to free script instance bindings after the language has already been removed, which would result in a NULL dereference.
2019-02-05 03:39:02 +08:00
Map<Object *, CSharpScriptBinding>::Element *insert_script_binding(Object *p_object, const CSharpScriptBinding &p_script_binding);
Mono: Lifetime fixes for CSharpInstance and instance binding data Avoid CSharpInstance from accessing its state after self destructing (by deleting the Reference owner). It's now safe to replace the script instance without leaking or crashing. Also fixed godot_icall_Object_weakref return reference being freed before returning.
2019-02-03 13:35:22 +08:00
bool setup_csharp_script_binding(CSharpScriptBinding &r_script_binding, Object *p_object);
Mono: Fix build errors with tools=no and target=release
2018-01-28 01:44:04 +08:00
#ifdef DEBUG_ENABLED
Mono: Implement stack info for errors and exceptions
2018-01-10 00:19:03 +08:00
Vector<StackInfo> stack_trace_get_info(MonoObject *p_stack_trace);
Mono: Fix build errors with tools=no and target=release
2018-01-28 01:44:04 +08:00
#endif
Mono: Implement stack info for errors and exceptions
2018-01-10 00:19:03 +08:00
Mono/C#: Add error checks to detect possible Reference leaks
2020-01-14 04:00:07 +08:00
void post_unsafe_reference(Object *p_obj);
void pre_unsafe_unreference(Object *p_obj);
Added mono module
2017-10-03 05:24:00 +08:00
CSharpLanguage();
~CSharpLanguage();
};
class ResourceFormatLoaderCSharpScript : public ResourceFormatLoader {
public:
Fix C# bindings after recent breaking changes Implementation for new Variant types Callable, Signal, StringName. Added support for PackedInt64Array and PackedFloat64Array. Add generation of signal members as events, as well as support for user created signals as events. NOTE: As of now, raising such events will not emit the signal. As such, one must use `EmitSignal` instead of raising the event directly. Removed old ThreadLocal fallback class. It's safe to use thread_local now since it's supported on all minimum versions of compilers we support.
2020-03-15 02:20:17 +08:00
virtual RES load(const String &p_path, const String &p_original_path = "", Error *r_error = nullptr, bool p_use_sub_threads = false, float *r_progress = nullptr);
Added mono module
2017-10-03 05:24:00 +08:00
virtual void get_recognized_extensions(List<String> *p_extensions) const;
virtual bool handles_type(const String &p_type) const;
virtual String get_resource_type(const String &p_path) const;
};
class ResourceFormatSaverCSharpScript : public ResourceFormatSaver {
public:
virtual Error save(const String &p_path, const RES &p_resource, uint32_t p_flags = 0);
virtual void get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const;
virtual bool recognize(const RES &p_resource) const;
};
#endif // CSHARP_SCRIPT_H
Reference in New Issue Copy Permalink