godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/mono/csharp_script.h

373 lines
14 KiB
C++
Raw Normal View History

Added mono module
2017-10-02 21:24:00 +00:00
/*************************************************************************/
/* csharp_script.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
Update copyright statements to 2019 Happy new year to the wonderful Godot community!
2019-01-03 10:41:35 +00:00
/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
Added mono module
2017-10-02 21:24:00 +00: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-04 23:50:27 +00:00
Added mono module
2017-10-02 21:24:00 +00:00
#ifndef CSHARP_SCRIPT_H
#define CSHARP_SCRIPT_H
#include "io/resource_loader.h"
#include "io/resource_saver.h"
#include "script_language.h"
#include "self_list.h"
#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"
class CSharpScript;
class CSharpInstance;
class CSharpLanguage;
#ifdef NO_SAFE_CAST
template <typename TScriptInstance, typename TScriptLanguage>
TScriptInstance *cast_script_instance(ScriptInstance *p_inst) {
return p_inst->get_language() == TScriptLanguage::get_singleton() ? static_cast<TScriptInstance *>(p_inst) : NULL;
}
#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 {
GDCLASS(CSharpScript, Script)
friend class CSharpInstance;
friend class CSharpLanguage;
friend class CSharpScriptDepSort;
bool tool;
bool valid;
bool builtin;
GDMonoClass *base;
GDMonoClass *native;
GDMonoClass *script_class;
Ref<CSharpScript> base_cache; // TODO what's this for?
Set<Object *> instances;
String source;
StringName name;
SelfList<CSharpScript> script_list;
implement signal related methods in csharp_script so signals can be used with emit (cherry picked from commit cfbd7fd21e6630cc513ac3a36849c0f796d142c3)
2018-01-18 22:27:43 +00:00
struct Argument {
String name;
Variant::Type type;
};
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. (cherry picked from commit 3c7d9001bc9591368d743e9bd6cc29a74c7bddd5)
2018-02-18 21:47:43 +00:00
Map<StringName, Vector<Argument> > _signals;
bool signals_invalidated;
Added mono module
2017-10-02 21:24:00 +00: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;
bool source_changed_cache;
bool exports_invalidated;
void _update_exports_values(Map<StringName, Variant> &values, List<PropertyInfo> &propnames);
virtual void _placeholder_erased(PlaceHolderScriptInstance *p_placeholder);
#endif
#ifdef DEBUG_ENABLED
Map<ObjectID, List<Pair<StringName, Variant> > > pending_reload_state;
#endif
Map<StringName, PropertyInfo> member_info;
void _clear();
Mono: Fixes annotated signal loading in exported binaries (cherry picked from commit 489c9adf03b369daf35132b40b7641592d9d0d15)
2018-07-01 01:14:40 +00:00
void load_script_signals(GDMonoClass *p_class, GDMonoClass *p_native_class);
implement signal related methods in csharp_script so signals can be used with emit (cherry picked from commit cfbd7fd21e6630cc513ac3a36849c0f796d142c3)
2018-01-18 22:27:43 +00:00
bool _get_signal(GDMonoClass *p_class, GDMonoClass *p_delegate, Vector<Argument> &params);
add a [Signal] attribute to CSharpScripts (cherry picked from commit efd52cd1725145dc9c8038477dbe133b23868e99)
2018-01-18 17:17:29 +00:00
Added mono module
2017-10-02 21:24:00 +00:00
bool _update_exports();
Mono: Fix build errors with tools=no and target=release
2018-01-27 17:44:04 +00:00
#ifdef TOOLS_ENABLED
Mono: Add properties support in scripts
2018-01-04 20:05:46 +00:00
bool _get_member_export(GDMonoClass *p_class, GDMonoClassMember *p_member, PropertyInfo &r_prop_info, bool &r_exported);
Mono: Fix build errors with tools=no and target=release
2018-01-27 17:44:04 +00:00
#endif
Mono: Add properties support in scripts
2018-01-04 20:05:46 +00:00
Added mono module
2017-10-02 21:24:00 +00:00
CSharpInstance *_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_isref, Variant::CallError &r_error);
Variant _new(const Variant **p_args, int p_argcount, Variant::CallError &r_error);
// Do not use unless you know what you are doing
friend void GDMonoInternals::tie_managed_to_unmanaged(MonoObject *, Object *);
static Ref<CSharpScript> create_for_managed_type(GDMonoClass *p_class);
protected:
static void _bind_methods();
Variant call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error);
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-30 21:17:20 +00: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-02 21:24:00 +00:00
public:
virtual bool can_instance() const;
virtual StringName get_instance_base_type() const;
virtual ScriptInstance *instance_create(Object *p_this);
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 (cherry picked from commit cfbd7fd21e6630cc513ac3a36849c0f796d142c3)
2018-01-18 22:27:43 +00: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-02 21:24:00 +00:00
/* TODO */ virtual bool get_property_default_value(const StringName &p_property, Variant &r_value) const;
virtual void get_script_property_list(List<PropertyInfo> *p_list) const;
virtual void update_exports();
virtual bool is_tool() const { return tool; }
virtual Ref<Script> get_base_script() const;
virtual ScriptLanguage *get_language() const;
/* TODO */ virtual void get_script_method_list(List<MethodInfo> *p_list) const {}
bool has_method(const StringName &p_method) const;
/* TODO */ MethodInfo get_method_info(const StringName &p_method) const { return MethodInfo(); }
virtual int get_member_line(const StringName &p_member) const;
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;
Object *owner;
Ref<CSharpScript> script;
Ref<MonoGCHandle> gchandle;
bool base_ref;
bool ref_dying;
void _reference_owner_unsafe();
void _unreference_owner_unsafe();
// Do not use unless you know what you are doing
friend void GDMonoInternals::tie_managed_to_unmanaged(MonoObject *, Object *);
static CSharpInstance *create_for_managed_type(Object *p_owner, CSharpScript *p_script, const Ref<MonoGCHandle> &p_gchandle);
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.
2017-12-31 21:37:57 +00:00
void _call_multilevel(MonoObject *p_mono_object, const StringName &p_method, const Variant **p_args, int p_argcount);
Mono: Add properties support in scripts
2018-01-04 20:05:46 +00:00
RPCMode _member_get_rpc_mode(GDMonoClassMember *p_member) const;
Added mono module
2017-10-02 21:24:00 +00:00
public:
MonoObject *get_mono_object() const;
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;
virtual Variant call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error);
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);
void mono_object_disposed();
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.
2017-12-31 21:37:57 +00:00
virtual void refcount_incremented();
virtual bool refcount_decremented();
Added mono module
2017-10-02 21:24:00 +00: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.
2017-12-31 21:37:57 +00:00
virtual RPCMode get_rpc_mode(const StringName &p_method) const;
virtual RPCMode get_rset_mode(const StringName &p_variable) const;
Added mono module
2017-10-02 21:24:00 +00:00
virtual void notification(int p_notification);
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.
2017-12-31 21:37:57 +00:00
void call_notification_no_check(MonoObject *p_mono_object, int p_notification);
Added mono module
2017-10-02 21:24:00 +00:00
virtual Ref<Script> get_script() const;
virtual ScriptLanguage *get_language();
CSharpInstance();
~CSharpInstance();
};
class CSharpLanguage : public ScriptLanguage {
friend class CSharpScript;
friend class CSharpInstance;
static CSharpLanguage *singleton;
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.
2017-12-31 21:37:57 +00:00
bool finalizing;
Added mono module
2017-10-02 21:24:00 +00:00
GDMono *gdmono;
SelfList<CSharpScript>::List script_list;
Mutex *lock;
Mutex *script_bind_lock;
Map<Ref<CSharpScript>, Map<ObjectID, List<Pair<StringName, Variant> > > > to_reload;
Map<Object *, Ref<MonoGCHandle> > gchandle_bindings;
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 01:54:23 +00:00
StringName _signal_callback;
Added mono module
2017-10-02 21:24:00 +00:00
StringName _set;
StringName _get;
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-30 21:17:20 +00:00
StringName _script_source;
Added mono module
2017-10-02 21:24:00 +00:00
StringName dotctor; // .ctor
StringNameCache();
};
int lang_idx;
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-30 21:17:20 +00:00
StringNameCache string_names;
Added mono module
2017-10-02 21:24:00 +00: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 01:54:23 +00:00
_FORCE_INLINE_ const StringNameCache &get_string_names() { return string_names; }
Added mono module
2017-10-02 21:24:00 +00:00
_FORCE_INLINE_ static CSharpLanguage *get_singleton() { return singleton; }
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);
#ifdef TOOLS_ENABLED
void reload_assemblies_if_needed(bool p_soft_reload);
#endif
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-30 21:17:20 +00: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);
Added mono module
2017-10-02 21:24:00 +00: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) 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 (cherry picked from commit 700d07cf7cae4e28de107e0c274b27c857d98450)
2018-03-09 22:34:32 +00:00
virtual String validate_path(const String &p_path) const;
Added mono module
2017-10-02 21:24:00 +00: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-23 23:54:47 +00:00
virtual bool supports_builtin_mode() const;
Added mono module
2017-10-02 21:24:00 +00:00
/* TODO? */ virtual int find_function(const String &p_function, const String &p_code) const { return -1; }
virtual String make_function(const String &p_class, const String &p_name, const PoolStringArray &p_args) const;
/* TODO? */ Error complete_code(const String &p_code, const String &p_base_path, Object *p_owner, List<String> *r_options, String &r_call_hint) { return ERR_UNAVAILABLE; }
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-30 21:17:20 +00:00
virtual String _get_indentation() const;
Added mono module
2017-10-02 21:24:00 +00: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 */
/* TODO */ virtual String debug_get_error() const { return ""; }
/* TODO */ virtual int debug_get_stack_level_count() const { return 1; }
/* TODO */ virtual int debug_get_stack_level_line(int p_level) const { return 1; }
/* TODO */ virtual String debug_get_stack_level_function(int p_level) const { return ""; }
/* TODO */ virtual String debug_get_stack_level_source(int p_level) const { return ""; }
/* 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-09 16:19:03 +00:00
virtual Vector<StackInfo> debug_get_current_stack_info();
Added mono module
2017-10-02 21:24:00 +00: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 {}
/* TODO? */ virtual void get_public_constants(List<Pair<String, Variant> > *p_constants) const {}
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);
Mono: Fix build errors with tools=no and target=release
2018-01-27 17:44:04 +00:00
#ifdef DEBUG_ENABLED
Mono: Implement stack info for errors and exceptions
2018-01-09 16:19:03 +00:00
Vector<StackInfo> stack_trace_get_info(MonoObject *p_stack_trace);
Mono: Fix build errors with tools=no and target=release
2018-01-27 17:44:04 +00:00
#endif
Mono: Implement stack info for errors and exceptions
2018-01-09 16:19:03 +00:00
Added mono module
2017-10-02 21:24:00 +00:00
CSharpLanguage();
~CSharpLanguage();
};
class ResourceFormatLoaderCSharpScript : public ResourceFormatLoader {
public:
virtual RES load(const String &p_path, const String &p_original_path = "", Error *r_error = NULL);
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