b4d0a09f15
This adds back a function available in 3.x: exporting the GDScript files in a binary form by converting the tokens recognized by the tokenizer into a data format. It is enabled by default on export but can be manually disabled. The format helps with loading times since, the tokens are easily reconstructed, and with hiding the source code, since recovering it would require a specialized tool. Code comments are not stored in this format. The `--test` command can also include a `--use-binary-tokens` flag which will run the GDScript tests with the binary format instead of the regular source code by converting them in-memory before the test runs.
635 lines
25 KiB
C++
635 lines
25 KiB
C++
/**************************************************************************/
|
|
/* gdscript.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef GDSCRIPT_H
|
|
#define GDSCRIPT_H
|
|
|
|
#include "gdscript_function.h"
|
|
|
|
#include "core/debugger/engine_debugger.h"
|
|
#include "core/debugger/script_debugger.h"
|
|
#include "core/doc_data.h"
|
|
#include "core/io/resource_loader.h"
|
|
#include "core/io/resource_saver.h"
|
|
#include "core/object/script_language.h"
|
|
#include "core/templates/rb_set.h"
|
|
|
|
class GDScriptNativeClass : public RefCounted {
|
|
GDCLASS(GDScriptNativeClass, RefCounted);
|
|
|
|
StringName name;
|
|
|
|
protected:
|
|
bool _get(const StringName &p_name, Variant &r_ret) const;
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
_FORCE_INLINE_ const StringName &get_name() const { return name; }
|
|
Variant _new();
|
|
Object *instantiate();
|
|
virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override;
|
|
GDScriptNativeClass(const StringName &p_name);
|
|
};
|
|
|
|
class GDScript : public Script {
|
|
GDCLASS(GDScript, Script);
|
|
bool tool = false;
|
|
bool valid = false;
|
|
bool reloading = false;
|
|
|
|
struct MemberInfo {
|
|
int index = 0;
|
|
StringName setter;
|
|
StringName getter;
|
|
GDScriptDataType data_type;
|
|
PropertyInfo property_info;
|
|
};
|
|
|
|
struct ClearData {
|
|
RBSet<GDScriptFunction *> functions;
|
|
RBSet<Ref<Script>> scripts;
|
|
void clear() {
|
|
functions.clear();
|
|
scripts.clear();
|
|
}
|
|
};
|
|
|
|
friend class GDScriptInstance;
|
|
friend class GDScriptFunction;
|
|
friend class GDScriptAnalyzer;
|
|
friend class GDScriptCompiler;
|
|
friend class GDScriptDocGen;
|
|
friend class GDScriptLambdaCallable;
|
|
friend class GDScriptLambdaSelfCallable;
|
|
friend class GDScriptLanguage;
|
|
friend struct GDScriptUtilityFunctionsDefinitions;
|
|
|
|
Ref<GDScriptNativeClass> native;
|
|
Ref<GDScript> base;
|
|
GDScript *_base = nullptr; //fast pointer access
|
|
GDScript *_owner = nullptr; //for subclasses
|
|
|
|
// Members are just indices to the instantiated script.
|
|
HashMap<StringName, MemberInfo> member_indices; // Includes member info of all base GDScript classes.
|
|
HashSet<StringName> members; // Only members of the current class.
|
|
|
|
// Only static variables of the current class.
|
|
HashMap<StringName, MemberInfo> static_variables_indices;
|
|
Vector<Variant> static_variables; // Static variable values.
|
|
|
|
HashMap<StringName, Variant> constants;
|
|
HashMap<StringName, GDScriptFunction *> member_functions;
|
|
HashMap<StringName, Ref<GDScript>> subclasses;
|
|
HashMap<StringName, MethodInfo> _signals;
|
|
Dictionary rpc_config;
|
|
|
|
struct LambdaInfo {
|
|
int capture_count;
|
|
bool use_self;
|
|
};
|
|
|
|
HashMap<GDScriptFunction *, LambdaInfo> lambda_info;
|
|
|
|
public:
|
|
class UpdatableFuncPtr {
|
|
friend class GDScript;
|
|
|
|
GDScriptFunction *ptr = nullptr;
|
|
GDScript *script = nullptr;
|
|
List<UpdatableFuncPtr *>::Element *list_element = nullptr;
|
|
|
|
public:
|
|
GDScriptFunction *operator->() const { return ptr; }
|
|
operator GDScriptFunction *() const { return ptr; }
|
|
|
|
UpdatableFuncPtr(GDScriptFunction *p_function);
|
|
~UpdatableFuncPtr();
|
|
};
|
|
|
|
private:
|
|
// List is used here because a ptr to elements are stored, so the memory locations need to be stable
|
|
List<UpdatableFuncPtr *> func_ptrs_to_update;
|
|
Mutex func_ptrs_to_update_mutex;
|
|
|
|
void _recurse_replace_function_ptrs(const HashMap<GDScriptFunction *, GDScriptFunction *> &p_replacements) const;
|
|
|
|
#ifdef TOOLS_ENABLED
|
|
// For static data storage during hot-reloading.
|
|
HashMap<StringName, MemberInfo> old_static_variables_indices;
|
|
Vector<Variant> old_static_variables;
|
|
void _save_old_static_data();
|
|
void _restore_old_static_data();
|
|
|
|
HashMap<StringName, int> member_lines;
|
|
HashMap<StringName, Variant> member_default_values;
|
|
List<PropertyInfo> members_cache;
|
|
HashMap<StringName, Variant> member_default_values_cache;
|
|
Ref<GDScript> base_cache;
|
|
HashSet<ObjectID> inheriters_cache;
|
|
bool source_changed_cache = false;
|
|
bool placeholder_fallback_enabled = false;
|
|
void _update_exports_values(HashMap<StringName, Variant> &values, List<PropertyInfo> &propnames);
|
|
|
|
DocData::ClassDoc doc;
|
|
Vector<DocData::ClassDoc> docs;
|
|
void _clear_doc();
|
|
void _add_doc(const DocData::ClassDoc &p_inner_class);
|
|
#endif
|
|
|
|
GDScriptFunction *implicit_initializer = nullptr;
|
|
GDScriptFunction *initializer = nullptr; //direct pointer to new , faster to locate
|
|
GDScriptFunction *implicit_ready = nullptr;
|
|
GDScriptFunction *static_initializer = nullptr;
|
|
|
|
Error _static_init();
|
|
|
|
int subclass_count = 0;
|
|
RBSet<Object *> instances;
|
|
bool destructing = false;
|
|
bool clearing = false;
|
|
//exported members
|
|
String source;
|
|
Vector<uint8_t> binary_tokens;
|
|
String path;
|
|
bool path_valid = false; // False if using default path.
|
|
StringName local_name; // Inner class identifier or `class_name`.
|
|
StringName global_name; // `class_name`.
|
|
String fully_qualified_name;
|
|
String simplified_icon_path;
|
|
SelfList<GDScript> script_list;
|
|
|
|
SelfList<GDScriptFunctionState>::List pending_func_states;
|
|
|
|
GDScriptFunction *_super_constructor(GDScript *p_script);
|
|
void _super_implicit_constructor(GDScript *p_script, GDScriptInstance *p_instance, Callable::CallError &r_error);
|
|
GDScriptInstance *_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_is_ref_counted, Callable::CallError &r_error);
|
|
|
|
String _get_debug_path() const;
|
|
|
|
#ifdef TOOLS_ENABLED
|
|
HashSet<PlaceHolderScriptInstance *> placeholders;
|
|
//void _update_placeholder(PlaceHolderScriptInstance *p_placeholder);
|
|
virtual void _placeholder_erased(PlaceHolderScriptInstance *p_placeholder) override;
|
|
void _update_exports_down(bool p_base_exports_changed);
|
|
#endif
|
|
|
|
#ifdef DEBUG_ENABLED
|
|
HashMap<ObjectID, List<Pair<StringName, Variant>>> pending_reload_state;
|
|
#endif
|
|
|
|
bool _update_exports(bool *r_err = nullptr, bool p_recursive_call = false, PlaceHolderScriptInstance *p_instance_to_update = nullptr, bool p_base_exports_changed = false);
|
|
|
|
void _save_orphaned_subclasses(GDScript::ClearData *p_clear_data);
|
|
|
|
void _get_script_property_list(List<PropertyInfo> *r_list, bool p_include_base) const;
|
|
void _get_script_method_list(List<MethodInfo> *r_list, bool p_include_base) const;
|
|
void _get_script_signal_list(List<MethodInfo> *r_list, bool p_include_base) const;
|
|
|
|
GDScript *_get_gdscript_from_variant(const Variant &p_variant);
|
|
void _get_dependencies(RBSet<GDScript *> &p_dependencies, const GDScript *p_except);
|
|
|
|
protected:
|
|
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;
|
|
|
|
Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override;
|
|
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
#ifdef DEBUG_ENABLED
|
|
static String debug_get_script_name(const Ref<Script> &p_script);
|
|
#endif
|
|
|
|
_FORCE_INLINE_ StringName get_local_name() const { return local_name; }
|
|
|
|
void clear(GDScript::ClearData *p_clear_data = nullptr);
|
|
|
|
virtual bool is_valid() const override { return valid; }
|
|
virtual bool is_abstract() const override { return false; } // GDScript does not support abstract classes.
|
|
|
|
bool inherits_script(const Ref<Script> &p_script) const override;
|
|
|
|
GDScript *find_class(const String &p_qualified_name);
|
|
bool has_class(const GDScript *p_script);
|
|
GDScript *get_root_script();
|
|
bool is_root_script() const { return _owner == nullptr; }
|
|
String get_fully_qualified_name() const { return fully_qualified_name; }
|
|
const HashMap<StringName, Ref<GDScript>> &get_subclasses() const { return subclasses; }
|
|
const HashMap<StringName, Variant> &get_constants() const { return constants; }
|
|
const HashSet<StringName> &get_members() const { return members; }
|
|
const GDScriptDataType &get_member_type(const StringName &p_member) const {
|
|
CRASH_COND(!member_indices.has(p_member));
|
|
return member_indices[p_member].data_type;
|
|
}
|
|
const HashMap<StringName, GDScriptFunction *> &get_member_functions() const { return member_functions; }
|
|
const Ref<GDScriptNativeClass> &get_native() const { return native; }
|
|
|
|
RBSet<GDScript *> get_dependencies();
|
|
HashMap<GDScript *, RBSet<GDScript *>> get_all_dependencies();
|
|
RBSet<GDScript *> get_must_clear_dependencies();
|
|
|
|
virtual bool has_script_signal(const StringName &p_signal) const override;
|
|
virtual void get_script_signal_list(List<MethodInfo> *r_signals) const override;
|
|
|
|
bool is_tool() const override { return tool; }
|
|
Ref<GDScript> get_base() const;
|
|
|
|
const HashMap<StringName, MemberInfo> &debug_get_member_indices() const { return member_indices; }
|
|
const HashMap<StringName, GDScriptFunction *> &debug_get_member_functions() const; //this is debug only
|
|
StringName debug_get_member_by_index(int p_idx) const;
|
|
StringName debug_get_static_var_by_index(int p_idx) const;
|
|
|
|
Variant _new(const Variant **p_args, int p_argcount, Callable::CallError &r_error);
|
|
virtual bool can_instantiate() const override;
|
|
|
|
virtual Ref<Script> get_base_script() const override;
|
|
virtual StringName get_global_name() const override;
|
|
|
|
virtual StringName get_instance_base_type() const override; // this may not work in all scripts, will return empty if so
|
|
virtual ScriptInstance *instance_create(Object *p_this) override;
|
|
virtual PlaceHolderScriptInstance *placeholder_instance_create(Object *p_this) override;
|
|
virtual bool instance_has(const Object *p_this) const override;
|
|
|
|
virtual bool has_source_code() const override;
|
|
virtual String get_source_code() const override;
|
|
virtual void set_source_code(const String &p_code) override;
|
|
virtual void update_exports() override;
|
|
|
|
#ifdef TOOLS_ENABLED
|
|
virtual Vector<DocData::ClassDoc> get_documentation() const override {
|
|
return docs;
|
|
}
|
|
virtual String get_class_icon_path() const override;
|
|
#endif // TOOLS_ENABLED
|
|
|
|
virtual Error reload(bool p_keep_state = false) override;
|
|
|
|
virtual void set_path(const String &p_path, bool p_take_over = false) override;
|
|
String get_script_path() const;
|
|
Error load_source_code(const String &p_path);
|
|
|
|
void set_binary_tokens_source(const Vector<uint8_t> &p_binary_tokens);
|
|
const Vector<uint8_t> &get_binary_tokens_source() const;
|
|
Vector<uint8_t> get_as_binary_tokens() const;
|
|
|
|
bool get_property_default_value(const StringName &p_property, Variant &r_value) const override;
|
|
|
|
virtual void get_script_method_list(List<MethodInfo> *p_list) const override;
|
|
virtual bool has_method(const StringName &p_method) const override;
|
|
virtual bool has_static_method(const StringName &p_method) const override;
|
|
virtual MethodInfo get_method_info(const StringName &p_method) const override;
|
|
|
|
virtual void get_script_property_list(List<PropertyInfo> *p_list) const override;
|
|
|
|
virtual ScriptLanguage *get_language() const override;
|
|
|
|
virtual int get_member_line(const StringName &p_member) const override {
|
|
#ifdef TOOLS_ENABLED
|
|
if (member_lines.has(p_member)) {
|
|
return member_lines[p_member];
|
|
}
|
|
#endif
|
|
return -1;
|
|
}
|
|
|
|
virtual void get_constants(HashMap<StringName, Variant> *p_constants) override;
|
|
virtual void get_members(HashSet<StringName> *p_members) override;
|
|
|
|
virtual const Variant get_rpc_config() const override;
|
|
|
|
void unload_static() const;
|
|
|
|
#ifdef TOOLS_ENABLED
|
|
virtual bool is_placeholder_fallback_enabled() const override { return placeholder_fallback_enabled; }
|
|
#endif
|
|
|
|
GDScript();
|
|
~GDScript();
|
|
};
|
|
|
|
class GDScriptInstance : public ScriptInstance {
|
|
friend class GDScript;
|
|
friend class GDScriptFunction;
|
|
friend class GDScriptLambdaCallable;
|
|
friend class GDScriptLambdaSelfCallable;
|
|
friend class GDScriptCompiler;
|
|
friend class GDScriptCache;
|
|
friend struct GDScriptUtilityFunctionsDefinitions;
|
|
|
|
ObjectID owner_id;
|
|
Object *owner = nullptr;
|
|
Ref<GDScript> script;
|
|
#ifdef DEBUG_ENABLED
|
|
HashMap<StringName, int> member_indices_cache; //used only for hot script reloading
|
|
#endif
|
|
Vector<Variant> members;
|
|
bool base_ref_counted;
|
|
|
|
SelfList<GDScriptFunctionState>::List pending_func_states;
|
|
|
|
public:
|
|
virtual Object *get_owner() { return owner; }
|
|
|
|
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 = nullptr) const;
|
|
virtual void validate_property(PropertyInfo &p_property) const;
|
|
|
|
virtual bool property_can_revert(const StringName &p_name) const;
|
|
virtual bool property_get_revert(const StringName &p_name, Variant &r_ret) const;
|
|
|
|
virtual void get_method_list(List<MethodInfo> *p_list) const;
|
|
virtual bool has_method(const StringName &p_method) const;
|
|
virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error);
|
|
|
|
Variant debug_get_member_by_index(int p_idx) const { return members[p_idx]; }
|
|
|
|
virtual void notification(int p_notification, bool p_reversed = false);
|
|
String to_string(bool *r_valid);
|
|
|
|
virtual Ref<Script> get_script() const;
|
|
|
|
virtual ScriptLanguage *get_language();
|
|
|
|
void set_path(const String &p_path);
|
|
|
|
void reload_members();
|
|
|
|
virtual const Variant get_rpc_config() const;
|
|
|
|
GDScriptInstance();
|
|
~GDScriptInstance();
|
|
};
|
|
|
|
class GDScriptLanguage : public ScriptLanguage {
|
|
friend class GDScriptFunctionState;
|
|
|
|
static GDScriptLanguage *singleton;
|
|
|
|
Variant *_global_array = nullptr;
|
|
Vector<Variant> global_array;
|
|
HashMap<StringName, int> globals;
|
|
HashMap<StringName, Variant> named_globals;
|
|
|
|
struct CallLevel {
|
|
Variant *stack = nullptr;
|
|
GDScriptFunction *function = nullptr;
|
|
GDScriptInstance *instance = nullptr;
|
|
int *ip = nullptr;
|
|
int *line = nullptr;
|
|
};
|
|
|
|
static thread_local int _debug_parse_err_line;
|
|
static thread_local String _debug_parse_err_file;
|
|
static thread_local String _debug_error;
|
|
struct CallStack {
|
|
CallLevel *levels = nullptr;
|
|
int stack_pos = 0;
|
|
|
|
void free() {
|
|
if (levels) {
|
|
memdelete(levels);
|
|
levels = nullptr;
|
|
}
|
|
}
|
|
~CallStack() {
|
|
free();
|
|
}
|
|
};
|
|
|
|
static thread_local CallStack _call_stack;
|
|
int _debug_max_call_stack = 0;
|
|
|
|
void _add_global(const StringName &p_name, const Variant &p_value);
|
|
|
|
friend class GDScriptInstance;
|
|
|
|
Mutex mutex;
|
|
|
|
friend class GDScript;
|
|
|
|
SelfList<GDScript>::List script_list;
|
|
friend class GDScriptFunction;
|
|
|
|
SelfList<GDScriptFunction>::List function_list;
|
|
bool profiling;
|
|
bool profile_native_calls;
|
|
uint64_t script_frame_time;
|
|
|
|
HashMap<String, ObjectID> orphan_subclasses;
|
|
|
|
public:
|
|
int calls;
|
|
|
|
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);
|
|
|
|
_FORCE_INLINE_ void enter_function(GDScriptInstance *p_instance, GDScriptFunction *p_function, Variant *p_stack, int *p_ip, int *p_line) {
|
|
if (unlikely(_call_stack.levels == nullptr)) {
|
|
_call_stack.levels = memnew_arr(CallLevel, _debug_max_call_stack + 1);
|
|
}
|
|
|
|
if (EngineDebugger::get_script_debugger()->get_lines_left() > 0 && EngineDebugger::get_script_debugger()->get_depth() >= 0) {
|
|
EngineDebugger::get_script_debugger()->set_depth(EngineDebugger::get_script_debugger()->get_depth() + 1);
|
|
}
|
|
|
|
if (_call_stack.stack_pos >= _debug_max_call_stack) {
|
|
//stack overflow
|
|
_debug_error = vformat("Stack overflow (stack size: %s). Check for infinite recursion in your script.", _debug_max_call_stack);
|
|
EngineDebugger::get_script_debugger()->debug(this);
|
|
return;
|
|
}
|
|
|
|
_call_stack.levels[_call_stack.stack_pos].stack = p_stack;
|
|
_call_stack.levels[_call_stack.stack_pos].instance = p_instance;
|
|
_call_stack.levels[_call_stack.stack_pos].function = p_function;
|
|
_call_stack.levels[_call_stack.stack_pos].ip = p_ip;
|
|
_call_stack.levels[_call_stack.stack_pos].line = p_line;
|
|
_call_stack.stack_pos++;
|
|
}
|
|
|
|
_FORCE_INLINE_ void exit_function() {
|
|
if (EngineDebugger::get_script_debugger()->get_lines_left() > 0 && EngineDebugger::get_script_debugger()->get_depth() >= 0) {
|
|
EngineDebugger::get_script_debugger()->set_depth(EngineDebugger::get_script_debugger()->get_depth() - 1);
|
|
}
|
|
|
|
if (_call_stack.stack_pos == 0) {
|
|
_debug_error = "Stack Underflow (Engine Bug)";
|
|
EngineDebugger::get_script_debugger()->debug(this);
|
|
return;
|
|
}
|
|
|
|
_call_stack.stack_pos--;
|
|
}
|
|
|
|
virtual Vector<StackInfo> debug_get_current_stack_info() override {
|
|
Vector<StackInfo> csi;
|
|
csi.resize(_call_stack.stack_pos);
|
|
for (int i = 0; i < _call_stack.stack_pos; i++) {
|
|
csi.write[_call_stack.stack_pos - i - 1].line = _call_stack.levels[i].line ? *_call_stack.levels[i].line : 0;
|
|
if (_call_stack.levels[i].function) {
|
|
csi.write[_call_stack.stack_pos - i - 1].func = _call_stack.levels[i].function->get_name();
|
|
csi.write[_call_stack.stack_pos - i - 1].file = _call_stack.levels[i].function->get_script()->get_script_path();
|
|
}
|
|
}
|
|
return csi;
|
|
}
|
|
|
|
struct {
|
|
StringName _init;
|
|
StringName _static_init;
|
|
StringName _notification;
|
|
StringName _set;
|
|
StringName _get;
|
|
StringName _get_property_list;
|
|
StringName _validate_property;
|
|
StringName _property_can_revert;
|
|
StringName _property_get_revert;
|
|
StringName _script_source;
|
|
|
|
} strings;
|
|
|
|
_FORCE_INLINE_ int get_global_array_size() const { return global_array.size(); }
|
|
_FORCE_INLINE_ Variant *get_global_array() { return _global_array; }
|
|
_FORCE_INLINE_ const HashMap<StringName, int> &get_global_map() const { return globals; }
|
|
_FORCE_INLINE_ const HashMap<StringName, Variant> &get_named_globals_map() const { return named_globals; }
|
|
// These two functions should be used when behavior needs to be consistent between in-editor and running the scene
|
|
bool has_any_global_constant(const StringName &p_name) { return named_globals.has(p_name) || globals.has(p_name); }
|
|
Variant get_any_global_constant(const StringName &p_name);
|
|
|
|
_FORCE_INLINE_ static GDScriptLanguage *get_singleton() { return singleton; }
|
|
|
|
virtual String get_name() const override;
|
|
|
|
/* LANGUAGE FUNCTIONS */
|
|
virtual void init() override;
|
|
virtual String get_type() const override;
|
|
virtual String get_extension() const override;
|
|
virtual void finish() override;
|
|
|
|
/* EDITOR FUNCTIONS */
|
|
virtual void get_reserved_words(List<String> *p_words) const override;
|
|
virtual bool is_control_flow_keyword(String p_keywords) const override;
|
|
virtual void get_comment_delimiters(List<String> *p_delimiters) const override;
|
|
virtual void get_doc_comment_delimiters(List<String> *p_delimiters) const override;
|
|
virtual void get_string_delimiters(List<String> *p_delimiters) const override;
|
|
virtual bool is_using_templates() override;
|
|
virtual Ref<Script> make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const override;
|
|
virtual Vector<ScriptTemplate> get_built_in_templates(const StringName &p_object) override;
|
|
virtual bool validate(const String &p_script, const String &p_path = "", List<String> *r_functions = nullptr, List<ScriptLanguage::ScriptError> *r_errors = nullptr, List<ScriptLanguage::Warning> *r_warnings = nullptr, HashSet<int> *r_safe_lines = nullptr) const override;
|
|
virtual Script *create_script() const override;
|
|
#ifndef DISABLE_DEPRECATED
|
|
virtual bool has_named_classes() const override { return false; }
|
|
#endif
|
|
virtual bool supports_builtin_mode() const override;
|
|
virtual bool supports_documentation() const override;
|
|
virtual bool can_inherit_from_file() const override { return true; }
|
|
virtual int find_function(const String &p_function, const String &p_code) const override;
|
|
virtual String make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const override;
|
|
virtual Error complete_code(const String &p_code, const String &p_path, Object *p_owner, List<ScriptLanguage::CodeCompletionOption> *r_options, bool &r_forced, String &r_call_hint) override;
|
|
#ifdef TOOLS_ENABLED
|
|
virtual Error lookup_code(const String &p_code, const String &p_symbol, const String &p_path, Object *p_owner, LookupResult &r_result) override;
|
|
#endif
|
|
virtual String _get_indentation() const;
|
|
virtual void auto_indent_code(String &p_code, int p_from_line, int p_to_line) const override;
|
|
virtual void add_global_constant(const StringName &p_variable, const Variant &p_value) override;
|
|
virtual void add_named_global_constant(const StringName &p_name, const Variant &p_value) override;
|
|
virtual void remove_named_global_constant(const StringName &p_name) override;
|
|
|
|
/* DEBUGGER FUNCTIONS */
|
|
|
|
virtual String debug_get_error() const override;
|
|
virtual int debug_get_stack_level_count() const override;
|
|
virtual int debug_get_stack_level_line(int p_level) const override;
|
|
virtual String debug_get_stack_level_function(int p_level) const override;
|
|
virtual String debug_get_stack_level_source(int p_level) const override;
|
|
virtual void debug_get_stack_level_locals(int p_level, List<String> *p_locals, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1) override;
|
|
virtual void debug_get_stack_level_members(int p_level, List<String> *p_members, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1) override;
|
|
virtual ScriptInstance *debug_get_stack_level_instance(int p_level) override;
|
|
virtual void debug_get_globals(List<String> *p_globals, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1) override;
|
|
virtual String debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems = -1, int p_max_depth = -1) override;
|
|
|
|
virtual void reload_all_scripts() override;
|
|
virtual void reload_scripts(const Array &p_scripts, bool p_soft_reload) override;
|
|
virtual void reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) override;
|
|
|
|
virtual void frame() override;
|
|
|
|
virtual void get_public_functions(List<MethodInfo> *p_functions) const override;
|
|
virtual void get_public_constants(List<Pair<String, Variant>> *p_constants) const override;
|
|
virtual void get_public_annotations(List<MethodInfo> *p_annotations) const override;
|
|
|
|
virtual void profiling_start() override;
|
|
virtual void profiling_stop() override;
|
|
virtual void profiling_set_save_native_calls(bool p_enable) override;
|
|
void profiling_collate_native_call_data(bool p_accumulated);
|
|
|
|
virtual int profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) override;
|
|
virtual int profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) override;
|
|
|
|
/* LOADER FUNCTIONS */
|
|
|
|
virtual void get_recognized_extensions(List<String> *p_extensions) const override;
|
|
|
|
/* GLOBAL CLASSES */
|
|
|
|
virtual bool handles_global_class_type(const String &p_type) const override;
|
|
virtual String get_global_class_name(const String &p_path, String *r_base_type = nullptr, String *r_icon_path = nullptr) const override;
|
|
|
|
void add_orphan_subclass(const String &p_qualified_name, const ObjectID &p_subclass);
|
|
Ref<GDScript> get_orphan_subclass(const String &p_qualified_name);
|
|
|
|
Ref<GDScript> get_script_by_fully_qualified_name(const String &p_name);
|
|
|
|
GDScriptLanguage();
|
|
~GDScriptLanguage();
|
|
};
|
|
|
|
class ResourceFormatLoaderGDScript : public ResourceFormatLoader {
|
|
public:
|
|
virtual Ref<Resource> load(const String &p_path, const String &p_original_path = "", Error *r_error = nullptr, bool p_use_sub_threads = false, float *r_progress = nullptr, CacheMode p_cache_mode = CACHE_MODE_REUSE);
|
|
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;
|
|
virtual void get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types = false);
|
|
};
|
|
|
|
class ResourceFormatSaverGDScript : public ResourceFormatSaver {
|
|
public:
|
|
virtual Error save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags = 0);
|
|
virtual void get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const;
|
|
virtual bool recognize(const Ref<Resource> &p_resource) const;
|
|
};
|
|
|
|
#endif // GDSCRIPT_H
|