gdscript.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619
  1. /**************************************************************************/
  2. /* gdscript.h */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #ifndef GDSCRIPT_H
  31. #define GDSCRIPT_H
  32. #include "gdscript_function.h"
  33. #include "core/debugger/engine_debugger.h"
  34. #include "core/debugger/script_debugger.h"
  35. #include "core/doc_data.h"
  36. #include "core/io/resource_loader.h"
  37. #include "core/io/resource_saver.h"
  38. #include "core/object/script_language.h"
  39. #include "core/templates/rb_set.h"
  40. class GDScriptNativeClass : public RefCounted {
  41. GDCLASS(GDScriptNativeClass, RefCounted);
  42. StringName name;
  43. protected:
  44. bool _get(const StringName &p_name, Variant &r_ret) const;
  45. static void _bind_methods();
  46. public:
  47. _FORCE_INLINE_ const StringName &get_name() const { return name; }
  48. Variant _new();
  49. Object *instantiate();
  50. virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override;
  51. GDScriptNativeClass(const StringName &p_name);
  52. };
  53. class GDScript : public Script {
  54. GDCLASS(GDScript, Script);
  55. bool tool = false;
  56. bool valid = false;
  57. bool reloading = false;
  58. struct MemberInfo {
  59. int index = 0;
  60. StringName setter;
  61. StringName getter;
  62. GDScriptDataType data_type;
  63. PropertyInfo property_info;
  64. };
  65. struct ClearData {
  66. RBSet<GDScriptFunction *> functions;
  67. RBSet<Ref<Script>> scripts;
  68. void clear() {
  69. functions.clear();
  70. scripts.clear();
  71. }
  72. };
  73. friend class GDScriptInstance;
  74. friend class GDScriptFunction;
  75. friend class GDScriptAnalyzer;
  76. friend class GDScriptCompiler;
  77. friend class GDScriptDocGen;
  78. friend class GDScriptLambdaCallable;
  79. friend class GDScriptLambdaSelfCallable;
  80. friend class GDScriptLanguage;
  81. friend struct GDScriptUtilityFunctionsDefinitions;
  82. Ref<GDScriptNativeClass> native;
  83. Ref<GDScript> base;
  84. GDScript *_base = nullptr; //fast pointer access
  85. GDScript *_owner = nullptr; //for subclasses
  86. // Members are just indices to the instantiated script.
  87. HashMap<StringName, MemberInfo> member_indices; // Includes member info of all base GDScript classes.
  88. HashSet<StringName> members; // Only members of the current class.
  89. // Only static variables of the current class.
  90. HashMap<StringName, MemberInfo> static_variables_indices;
  91. Vector<Variant> static_variables; // Static variable values.
  92. HashMap<StringName, Variant> constants;
  93. HashMap<StringName, GDScriptFunction *> member_functions;
  94. HashMap<StringName, Ref<GDScript>> subclasses;
  95. HashMap<StringName, MethodInfo> _signals;
  96. Dictionary rpc_config;
  97. struct LambdaInfo {
  98. int capture_count;
  99. bool use_self;
  100. };
  101. HashMap<GDScriptFunction *, LambdaInfo> lambda_info;
  102. // List is used here because a ptr to elements are stored, so the memory locations need to be stable
  103. struct UpdatableFuncPtr {
  104. List<GDScriptFunction **> ptrs;
  105. Mutex mutex;
  106. bool initialized = false;
  107. };
  108. struct UpdatableFuncPtrElement {
  109. List<GDScriptFunction **>::Element *element = nullptr;
  110. Mutex *mutex = nullptr;
  111. };
  112. static thread_local UpdatableFuncPtr func_ptrs_to_update_thread_local;
  113. List<UpdatableFuncPtr *> func_ptrs_to_update;
  114. Mutex func_ptrs_to_update_mutex;
  115. UpdatableFuncPtrElement _add_func_ptr_to_update(GDScriptFunction **p_func_ptr_ptr);
  116. static void _remove_func_ptr_to_update(const UpdatableFuncPtrElement p_func_ptr_element);
  117. #ifdef TOOLS_ENABLED
  118. // For static data storage during hot-reloading.
  119. HashMap<StringName, MemberInfo> old_static_variables_indices;
  120. Vector<Variant> old_static_variables;
  121. void _save_old_static_data();
  122. void _restore_old_static_data();
  123. HashMap<StringName, int> member_lines;
  124. HashMap<StringName, Variant> member_default_values;
  125. List<PropertyInfo> members_cache;
  126. HashMap<StringName, Variant> member_default_values_cache;
  127. Ref<GDScript> base_cache;
  128. HashSet<ObjectID> inheriters_cache;
  129. bool source_changed_cache = false;
  130. bool placeholder_fallback_enabled = false;
  131. void _update_exports_values(HashMap<StringName, Variant> &values, List<PropertyInfo> &propnames);
  132. DocData::ClassDoc doc;
  133. Vector<DocData::ClassDoc> docs;
  134. void _clear_doc();
  135. void _add_doc(const DocData::ClassDoc &p_inner_class);
  136. #endif
  137. GDScriptFunction *implicit_initializer = nullptr;
  138. GDScriptFunction *initializer = nullptr; //direct pointer to new , faster to locate
  139. GDScriptFunction *implicit_ready = nullptr;
  140. GDScriptFunction *static_initializer = nullptr;
  141. Error _static_init();
  142. int subclass_count = 0;
  143. RBSet<Object *> instances;
  144. bool destructing = false;
  145. bool clearing = false;
  146. //exported members
  147. String source;
  148. String path;
  149. bool path_valid = false; // False if using default path.
  150. StringName local_name; // Inner class identifier or `class_name`.
  151. StringName global_name; // `class_name`.
  152. String fully_qualified_name;
  153. String simplified_icon_path;
  154. SelfList<GDScript> script_list;
  155. SelfList<GDScriptFunctionState>::List pending_func_states;
  156. GDScriptFunction *_super_constructor(GDScript *p_script);
  157. void _super_implicit_constructor(GDScript *p_script, GDScriptInstance *p_instance, Callable::CallError &r_error);
  158. GDScriptInstance *_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_is_ref_counted, Callable::CallError &r_error);
  159. String _get_debug_path() const;
  160. #ifdef TOOLS_ENABLED
  161. HashSet<PlaceHolderScriptInstance *> placeholders;
  162. //void _update_placeholder(PlaceHolderScriptInstance *p_placeholder);
  163. virtual void _placeholder_erased(PlaceHolderScriptInstance *p_placeholder) override;
  164. void _update_exports_down(bool p_base_exports_changed);
  165. #endif
  166. #ifdef DEBUG_ENABLED
  167. HashMap<ObjectID, List<Pair<StringName, Variant>>> pending_reload_state;
  168. #endif
  169. bool _update_exports(bool *r_err = nullptr, bool p_recursive_call = false, PlaceHolderScriptInstance *p_instance_to_update = nullptr, bool p_base_exports_changed = false);
  170. void _save_orphaned_subclasses(GDScript::ClearData *p_clear_data);
  171. void _get_script_property_list(List<PropertyInfo> *r_list, bool p_include_base) const;
  172. void _get_script_method_list(List<MethodInfo> *r_list, bool p_include_base) const;
  173. void _get_script_signal_list(List<MethodInfo> *r_list, bool p_include_base) const;
  174. GDScript *_get_gdscript_from_variant(const Variant &p_variant);
  175. void _get_dependencies(RBSet<GDScript *> &p_dependencies, const GDScript *p_except);
  176. protected:
  177. bool _get(const StringName &p_name, Variant &r_ret) const;
  178. bool _set(const StringName &p_name, const Variant &p_value);
  179. void _get_property_list(List<PropertyInfo> *p_properties) const;
  180. Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override;
  181. static void _bind_methods();
  182. public:
  183. #ifdef DEBUG_ENABLED
  184. static String debug_get_script_name(const Ref<Script> &p_script);
  185. #endif
  186. _FORCE_INLINE_ StringName get_local_name() const { return local_name; }
  187. void clear(GDScript::ClearData *p_clear_data = nullptr);
  188. virtual bool is_valid() const override { return valid; }
  189. virtual bool is_abstract() const override { return false; } // GDScript does not support abstract classes.
  190. bool inherits_script(const Ref<Script> &p_script) const override;
  191. GDScript *find_class(const String &p_qualified_name);
  192. bool has_class(const GDScript *p_script);
  193. GDScript *get_root_script();
  194. bool is_root_script() const { return _owner == nullptr; }
  195. String get_fully_qualified_name() const { return fully_qualified_name; }
  196. const HashMap<StringName, Ref<GDScript>> &get_subclasses() const { return subclasses; }
  197. const HashMap<StringName, Variant> &get_constants() const { return constants; }
  198. const HashSet<StringName> &get_members() const { return members; }
  199. const GDScriptDataType &get_member_type(const StringName &p_member) const {
  200. CRASH_COND(!member_indices.has(p_member));
  201. return member_indices[p_member].data_type;
  202. }
  203. const HashMap<StringName, GDScriptFunction *> &get_member_functions() const { return member_functions; }
  204. const Ref<GDScriptNativeClass> &get_native() const { return native; }
  205. RBSet<GDScript *> get_dependencies();
  206. RBSet<GDScript *> get_inverted_dependencies();
  207. RBSet<GDScript *> get_must_clear_dependencies();
  208. virtual bool has_script_signal(const StringName &p_signal) const override;
  209. virtual void get_script_signal_list(List<MethodInfo> *r_signals) const override;
  210. bool is_tool() const override { return tool; }
  211. Ref<GDScript> get_base() const;
  212. const HashMap<StringName, MemberInfo> &debug_get_member_indices() const { return member_indices; }
  213. const HashMap<StringName, GDScriptFunction *> &debug_get_member_functions() const; //this is debug only
  214. StringName debug_get_member_by_index(int p_idx) const;
  215. StringName debug_get_static_var_by_index(int p_idx) const;
  216. Variant _new(const Variant **p_args, int p_argcount, Callable::CallError &r_error);
  217. virtual bool can_instantiate() const override;
  218. virtual Ref<Script> get_base_script() const override;
  219. virtual StringName get_global_name() const override;
  220. virtual StringName get_instance_base_type() const override; // this may not work in all scripts, will return empty if so
  221. virtual ScriptInstance *instance_create(Object *p_this) override;
  222. virtual PlaceHolderScriptInstance *placeholder_instance_create(Object *p_this) override;
  223. virtual bool instance_has(const Object *p_this) const override;
  224. virtual bool has_source_code() const override;
  225. virtual String get_source_code() const override;
  226. virtual void set_source_code(const String &p_code) override;
  227. virtual void update_exports() override;
  228. #ifdef TOOLS_ENABLED
  229. virtual Vector<DocData::ClassDoc> get_documentation() const override {
  230. return docs;
  231. }
  232. virtual String get_class_icon_path() const override;
  233. #endif // TOOLS_ENABLED
  234. virtual Error reload(bool p_keep_state = false) override;
  235. virtual void set_path(const String &p_path, bool p_take_over = false) override;
  236. String get_script_path() const;
  237. Error load_source_code(const String &p_path);
  238. bool get_property_default_value(const StringName &p_property, Variant &r_value) const override;
  239. virtual void get_script_method_list(List<MethodInfo> *p_list) const override;
  240. virtual bool has_method(const StringName &p_method) const override;
  241. virtual bool has_static_method(const StringName &p_method) const override;
  242. virtual MethodInfo get_method_info(const StringName &p_method) const override;
  243. virtual void get_script_property_list(List<PropertyInfo> *p_list) const override;
  244. virtual ScriptLanguage *get_language() const override;
  245. virtual int get_member_line(const StringName &p_member) const override {
  246. #ifdef TOOLS_ENABLED
  247. if (member_lines.has(p_member)) {
  248. return member_lines[p_member];
  249. }
  250. #endif
  251. return -1;
  252. }
  253. virtual void get_constants(HashMap<StringName, Variant> *p_constants) override;
  254. virtual void get_members(HashSet<StringName> *p_members) override;
  255. virtual const Variant get_rpc_config() const override;
  256. void unload_static() const;
  257. #ifdef TOOLS_ENABLED
  258. virtual bool is_placeholder_fallback_enabled() const override { return placeholder_fallback_enabled; }
  259. #endif
  260. GDScript();
  261. ~GDScript();
  262. };
  263. class GDScriptInstance : public ScriptInstance {
  264. friend class GDScript;
  265. friend class GDScriptFunction;
  266. friend class GDScriptLambdaCallable;
  267. friend class GDScriptLambdaSelfCallable;
  268. friend class GDScriptCompiler;
  269. friend class GDScriptCache;
  270. friend struct GDScriptUtilityFunctionsDefinitions;
  271. ObjectID owner_id;
  272. Object *owner = nullptr;
  273. Ref<GDScript> script;
  274. #ifdef DEBUG_ENABLED
  275. HashMap<StringName, int> member_indices_cache; //used only for hot script reloading
  276. #endif
  277. Vector<Variant> members;
  278. bool base_ref_counted;
  279. SelfList<GDScriptFunctionState>::List pending_func_states;
  280. public:
  281. virtual Object *get_owner() { return owner; }
  282. virtual bool set(const StringName &p_name, const Variant &p_value);
  283. virtual bool get(const StringName &p_name, Variant &r_ret) const;
  284. virtual void get_property_list(List<PropertyInfo> *p_properties) const;
  285. virtual Variant::Type get_property_type(const StringName &p_name, bool *r_is_valid = nullptr) const;
  286. virtual void validate_property(PropertyInfo &p_property) const;
  287. virtual bool property_can_revert(const StringName &p_name) const;
  288. virtual bool property_get_revert(const StringName &p_name, Variant &r_ret) const;
  289. virtual void get_method_list(List<MethodInfo> *p_list) const;
  290. virtual bool has_method(const StringName &p_method) const;
  291. virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error);
  292. Variant debug_get_member_by_index(int p_idx) const { return members[p_idx]; }
  293. virtual void notification(int p_notification, bool p_reversed = false);
  294. String to_string(bool *r_valid);
  295. virtual Ref<Script> get_script() const;
  296. virtual ScriptLanguage *get_language();
  297. void set_path(const String &p_path);
  298. void reload_members();
  299. virtual const Variant get_rpc_config() const;
  300. GDScriptInstance();
  301. ~GDScriptInstance();
  302. };
  303. class GDScriptLanguage : public ScriptLanguage {
  304. friend class GDScriptFunctionState;
  305. static GDScriptLanguage *singleton;
  306. Variant *_global_array = nullptr;
  307. Vector<Variant> global_array;
  308. HashMap<StringName, int> globals;
  309. HashMap<StringName, Variant> named_globals;
  310. struct CallLevel {
  311. Variant *stack = nullptr;
  312. GDScriptFunction *function = nullptr;
  313. GDScriptInstance *instance = nullptr;
  314. int *ip = nullptr;
  315. int *line = nullptr;
  316. };
  317. static thread_local int _debug_parse_err_line;
  318. static thread_local String _debug_parse_err_file;
  319. static thread_local String _debug_error;
  320. struct CallStack {
  321. CallLevel *levels = nullptr;
  322. int stack_pos = 0;
  323. void free() {
  324. if (levels) {
  325. memdelete(levels);
  326. levels = nullptr;
  327. }
  328. }
  329. ~CallStack() {
  330. free();
  331. }
  332. };
  333. static thread_local CallStack _call_stack;
  334. int _debug_max_call_stack = 0;
  335. void _add_global(const StringName &p_name, const Variant &p_value);
  336. friend class GDScriptInstance;
  337. Mutex mutex;
  338. friend class GDScript;
  339. SelfList<GDScript>::List script_list;
  340. friend class GDScriptFunction;
  341. SelfList<GDScriptFunction>::List function_list;
  342. bool profiling;
  343. uint64_t script_frame_time;
  344. HashMap<String, ObjectID> orphan_subclasses;
  345. public:
  346. int calls;
  347. bool debug_break(const String &p_error, bool p_allow_continue = true);
  348. bool debug_break_parse(const String &p_file, int p_line, const String &p_error);
  349. _FORCE_INLINE_ void enter_function(GDScriptInstance *p_instance, GDScriptFunction *p_function, Variant *p_stack, int *p_ip, int *p_line) {
  350. if (unlikely(_call_stack.levels == nullptr)) {
  351. _call_stack.levels = memnew_arr(CallLevel, _debug_max_call_stack + 1);
  352. }
  353. if (EngineDebugger::get_script_debugger()->get_lines_left() > 0 && EngineDebugger::get_script_debugger()->get_depth() >= 0) {
  354. EngineDebugger::get_script_debugger()->set_depth(EngineDebugger::get_script_debugger()->get_depth() + 1);
  355. }
  356. if (_call_stack.stack_pos >= _debug_max_call_stack) {
  357. //stack overflow
  358. _debug_error = vformat("Stack overflow (stack size: %s). Check for infinite recursion in your script.", _debug_max_call_stack);
  359. EngineDebugger::get_script_debugger()->debug(this);
  360. return;
  361. }
  362. _call_stack.levels[_call_stack.stack_pos].stack = p_stack;
  363. _call_stack.levels[_call_stack.stack_pos].instance = p_instance;
  364. _call_stack.levels[_call_stack.stack_pos].function = p_function;
  365. _call_stack.levels[_call_stack.stack_pos].ip = p_ip;
  366. _call_stack.levels[_call_stack.stack_pos].line = p_line;
  367. _call_stack.stack_pos++;
  368. }
  369. _FORCE_INLINE_ void exit_function() {
  370. if (EngineDebugger::get_script_debugger()->get_lines_left() > 0 && EngineDebugger::get_script_debugger()->get_depth() >= 0) {
  371. EngineDebugger::get_script_debugger()->set_depth(EngineDebugger::get_script_debugger()->get_depth() - 1);
  372. }
  373. if (_call_stack.stack_pos == 0) {
  374. _debug_error = "Stack Underflow (Engine Bug)";
  375. EngineDebugger::get_script_debugger()->debug(this);
  376. return;
  377. }
  378. _call_stack.stack_pos--;
  379. }
  380. virtual Vector<StackInfo> debug_get_current_stack_info() override {
  381. Vector<StackInfo> csi;
  382. csi.resize(_call_stack.stack_pos);
  383. for (int i = 0; i < _call_stack.stack_pos; i++) {
  384. csi.write[_call_stack.stack_pos - i - 1].line = _call_stack.levels[i].line ? *_call_stack.levels[i].line : 0;
  385. if (_call_stack.levels[i].function) {
  386. csi.write[_call_stack.stack_pos - i - 1].func = _call_stack.levels[i].function->get_name();
  387. csi.write[_call_stack.stack_pos - i - 1].file = _call_stack.levels[i].function->get_script()->get_script_path();
  388. }
  389. }
  390. return csi;
  391. }
  392. struct {
  393. StringName _init;
  394. StringName _static_init;
  395. StringName _notification;
  396. StringName _set;
  397. StringName _get;
  398. StringName _get_property_list;
  399. StringName _validate_property;
  400. StringName _property_can_revert;
  401. StringName _property_get_revert;
  402. StringName _script_source;
  403. } strings;
  404. _FORCE_INLINE_ int get_global_array_size() const { return global_array.size(); }
  405. _FORCE_INLINE_ Variant *get_global_array() { return _global_array; }
  406. _FORCE_INLINE_ const HashMap<StringName, int> &get_global_map() const { return globals; }
  407. _FORCE_INLINE_ const HashMap<StringName, Variant> &get_named_globals_map() const { return named_globals; }
  408. // These two functions should be used when behavior needs to be consistent between in-editor and running the scene
  409. bool has_any_global_constant(const StringName &p_name) { return named_globals.has(p_name) || globals.has(p_name); }
  410. Variant get_any_global_constant(const StringName &p_name);
  411. _FORCE_INLINE_ static GDScriptLanguage *get_singleton() { return singleton; }
  412. virtual String get_name() const override;
  413. /* LANGUAGE FUNCTIONS */
  414. virtual void init() override;
  415. virtual String get_type() const override;
  416. virtual String get_extension() const override;
  417. virtual void finish() override;
  418. /* EDITOR FUNCTIONS */
  419. virtual void get_reserved_words(List<String> *p_words) const override;
  420. virtual bool is_control_flow_keyword(String p_keywords) const override;
  421. virtual void get_comment_delimiters(List<String> *p_delimiters) const override;
  422. virtual void get_doc_comment_delimiters(List<String> *p_delimiters) const override;
  423. virtual void get_string_delimiters(List<String> *p_delimiters) const override;
  424. virtual bool is_using_templates() override;
  425. virtual Ref<Script> make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const override;
  426. virtual Vector<ScriptTemplate> get_built_in_templates(StringName p_object) override;
  427. 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;
  428. virtual Script *create_script() const override;
  429. #ifndef DISABLE_DEPRECATED
  430. virtual bool has_named_classes() const override { return false; }
  431. #endif
  432. virtual bool supports_builtin_mode() const override;
  433. virtual bool supports_documentation() const override;
  434. virtual bool can_inherit_from_file() const override { return true; }
  435. virtual int find_function(const String &p_function, const String &p_code) const override;
  436. virtual String make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const override;
  437. 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;
  438. #ifdef TOOLS_ENABLED
  439. virtual Error lookup_code(const String &p_code, const String &p_symbol, const String &p_path, Object *p_owner, LookupResult &r_result) override;
  440. #endif
  441. virtual String _get_indentation() const;
  442. virtual void auto_indent_code(String &p_code, int p_from_line, int p_to_line) const override;
  443. virtual void add_global_constant(const StringName &p_variable, const Variant &p_value) override;
  444. virtual void add_named_global_constant(const StringName &p_name, const Variant &p_value) override;
  445. virtual void remove_named_global_constant(const StringName &p_name) override;
  446. /* DEBUGGER FUNCTIONS */
  447. virtual String debug_get_error() const override;
  448. virtual int debug_get_stack_level_count() const override;
  449. virtual int debug_get_stack_level_line(int p_level) const override;
  450. virtual String debug_get_stack_level_function(int p_level) const override;
  451. virtual String debug_get_stack_level_source(int p_level) const override;
  452. 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;
  453. 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;
  454. virtual ScriptInstance *debug_get_stack_level_instance(int p_level) override;
  455. virtual void debug_get_globals(List<String> *p_globals, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1) override;
  456. 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;
  457. virtual void reload_all_scripts() override;
  458. virtual void reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) override;
  459. virtual void frame() override;
  460. virtual void get_public_functions(List<MethodInfo> *p_functions) const override;
  461. virtual void get_public_constants(List<Pair<String, Variant>> *p_constants) const override;
  462. virtual void get_public_annotations(List<MethodInfo> *p_annotations) const override;
  463. virtual void profiling_start() override;
  464. virtual void profiling_stop() override;
  465. virtual int profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) override;
  466. virtual int profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) override;
  467. /* LOADER FUNCTIONS */
  468. virtual void get_recognized_extensions(List<String> *p_extensions) const override;
  469. /* GLOBAL CLASSES */
  470. virtual bool handles_global_class_type(const String &p_type) const override;
  471. virtual String get_global_class_name(const String &p_path, String *r_base_type = nullptr, String *r_icon_path = nullptr) const override;
  472. void add_orphan_subclass(const String &p_qualified_name, const ObjectID &p_subclass);
  473. Ref<GDScript> get_orphan_subclass(const String &p_qualified_name);
  474. Ref<GDScript> get_script_by_fully_qualified_name(const String &p_name);
  475. GDScriptLanguage();
  476. ~GDScriptLanguage();
  477. };
  478. class ResourceFormatLoaderGDScript : public ResourceFormatLoader {
  479. public:
  480. 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);
  481. virtual void get_recognized_extensions(List<String> *p_extensions) const;
  482. virtual bool handles_type(const String &p_type) const;
  483. virtual String get_resource_type(const String &p_path) const;
  484. virtual void get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types = false);
  485. };
  486. class ResourceFormatSaverGDScript : public ResourceFormatSaver {
  487. public:
  488. virtual Error save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags = 0);
  489. virtual void get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const;
  490. virtual bool recognize(const Ref<Resource> &p_resource) const;
  491. };
  492. #endif // GDSCRIPT_H