gdscript.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662
  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. public:
  103. class UpdatableFuncPtr {
  104. friend class GDScript;
  105. GDScriptFunction *ptr = nullptr;
  106. GDScript *script = nullptr;
  107. List<UpdatableFuncPtr *>::Element *list_element = nullptr;
  108. public:
  109. GDScriptFunction *operator->() const { return ptr; }
  110. operator GDScriptFunction *() const { return ptr; }
  111. UpdatableFuncPtr(GDScriptFunction *p_function);
  112. ~UpdatableFuncPtr();
  113. };
  114. private:
  115. // List is used here because a ptr to elements are stored, so the memory locations need to be stable
  116. List<UpdatableFuncPtr *> func_ptrs_to_update;
  117. Mutex func_ptrs_to_update_mutex;
  118. void _recurse_replace_function_ptrs(const HashMap<GDScriptFunction *, GDScriptFunction *> &p_replacements) const;
  119. #ifdef TOOLS_ENABLED
  120. // For static data storage during hot-reloading.
  121. HashMap<StringName, MemberInfo> old_static_variables_indices;
  122. Vector<Variant> old_static_variables;
  123. void _save_old_static_data();
  124. void _restore_old_static_data();
  125. HashMap<StringName, int> member_lines;
  126. HashMap<StringName, Variant> member_default_values;
  127. List<PropertyInfo> members_cache;
  128. HashMap<StringName, Variant> member_default_values_cache;
  129. Ref<GDScript> base_cache;
  130. HashSet<ObjectID> inheriters_cache;
  131. bool source_changed_cache = false;
  132. bool placeholder_fallback_enabled = false;
  133. void _update_exports_values(HashMap<StringName, Variant> &values, List<PropertyInfo> &propnames);
  134. DocData::ClassDoc doc;
  135. Vector<DocData::ClassDoc> docs;
  136. void _clear_doc();
  137. void _add_doc(const DocData::ClassDoc &p_inner_class);
  138. #endif
  139. GDScriptFunction *implicit_initializer = nullptr;
  140. GDScriptFunction *initializer = nullptr; //direct pointer to new , faster to locate
  141. GDScriptFunction *implicit_ready = nullptr;
  142. GDScriptFunction *static_initializer = nullptr;
  143. Error _static_init();
  144. void _static_default_init(); // Initialize static variables with default values based on their types.
  145. int subclass_count = 0;
  146. RBSet<Object *> instances;
  147. bool destructing = false;
  148. bool clearing = false;
  149. //exported members
  150. String source;
  151. Vector<uint8_t> binary_tokens;
  152. String path;
  153. bool path_valid = false; // False if using default path.
  154. StringName local_name; // Inner class identifier or `class_name`.
  155. StringName global_name; // `class_name`.
  156. String fully_qualified_name;
  157. String simplified_icon_path;
  158. SelfList<GDScript> script_list;
  159. SelfList<GDScriptFunctionState>::List pending_func_states;
  160. GDScriptFunction *_super_constructor(GDScript *p_script);
  161. void _super_implicit_constructor(GDScript *p_script, GDScriptInstance *p_instance, Callable::CallError &r_error);
  162. GDScriptInstance *_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_is_ref_counted, Callable::CallError &r_error);
  163. String _get_debug_path() const;
  164. #ifdef TOOLS_ENABLED
  165. HashSet<PlaceHolderScriptInstance *> placeholders;
  166. //void _update_placeholder(PlaceHolderScriptInstance *p_placeholder);
  167. virtual void _placeholder_erased(PlaceHolderScriptInstance *p_placeholder) override;
  168. void _update_exports_down(bool p_base_exports_changed);
  169. #endif
  170. #ifdef DEBUG_ENABLED
  171. HashMap<ObjectID, List<Pair<StringName, Variant>>> pending_reload_state;
  172. #endif
  173. bool _update_exports(bool *r_err = nullptr, bool p_recursive_call = false, PlaceHolderScriptInstance *p_instance_to_update = nullptr, bool p_base_exports_changed = false);
  174. void _save_orphaned_subclasses(GDScript::ClearData *p_clear_data);
  175. void _get_script_property_list(List<PropertyInfo> *r_list, bool p_include_base) const;
  176. void _get_script_method_list(List<MethodInfo> *r_list, bool p_include_base) const;
  177. void _get_script_signal_list(List<MethodInfo> *r_list, bool p_include_base) const;
  178. GDScript *_get_gdscript_from_variant(const Variant &p_variant);
  179. void _collect_function_dependencies(GDScriptFunction *p_func, RBSet<GDScript *> &p_dependencies, const GDScript *p_except);
  180. void _collect_dependencies(RBSet<GDScript *> &p_dependencies, const GDScript *p_except);
  181. protected:
  182. bool _get(const StringName &p_name, Variant &r_ret) const;
  183. bool _set(const StringName &p_name, const Variant &p_value);
  184. void _get_property_list(List<PropertyInfo> *p_properties) const;
  185. Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override;
  186. static void _bind_methods();
  187. public:
  188. #ifdef DEBUG_ENABLED
  189. static String debug_get_script_name(const Ref<Script> &p_script);
  190. #endif
  191. static String canonicalize_path(const String &p_path);
  192. _FORCE_INLINE_ static bool is_canonically_equal_paths(const String &p_path_a, const String &p_path_b) {
  193. return canonicalize_path(p_path_a) == canonicalize_path(p_path_b);
  194. }
  195. _FORCE_INLINE_ StringName get_local_name() const { return local_name; }
  196. void clear(GDScript::ClearData *p_clear_data = nullptr);
  197. virtual bool is_valid() const override { return valid; }
  198. virtual bool is_abstract() const override { return false; } // GDScript does not support abstract classes.
  199. bool inherits_script(const Ref<Script> &p_script) const override;
  200. GDScript *find_class(const String &p_qualified_name);
  201. bool has_class(const GDScript *p_script);
  202. GDScript *get_root_script();
  203. bool is_root_script() const { return _owner == nullptr; }
  204. String get_fully_qualified_name() const { return fully_qualified_name; }
  205. const HashMap<StringName, Ref<GDScript>> &get_subclasses() const { return subclasses; }
  206. const HashMap<StringName, Variant> &get_constants() const { return constants; }
  207. const HashSet<StringName> &get_members() const { return members; }
  208. const GDScriptDataType &get_member_type(const StringName &p_member) const {
  209. CRASH_COND(!member_indices.has(p_member));
  210. return member_indices[p_member].data_type;
  211. }
  212. const HashMap<StringName, GDScriptFunction *> &get_member_functions() const { return member_functions; }
  213. const Ref<GDScriptNativeClass> &get_native() const { return native; }
  214. RBSet<GDScript *> get_dependencies();
  215. HashMap<GDScript *, RBSet<GDScript *>> get_all_dependencies();
  216. RBSet<GDScript *> get_must_clear_dependencies();
  217. virtual bool has_script_signal(const StringName &p_signal) const override;
  218. virtual void get_script_signal_list(List<MethodInfo> *r_signals) const override;
  219. bool is_tool() const override { return tool; }
  220. Ref<GDScript> get_base() const;
  221. const HashMap<StringName, MemberInfo> &debug_get_member_indices() const { return member_indices; }
  222. const HashMap<StringName, GDScriptFunction *> &debug_get_member_functions() const; //this is debug only
  223. StringName debug_get_member_by_index(int p_idx) const;
  224. StringName debug_get_static_var_by_index(int p_idx) const;
  225. Variant _new(const Variant **p_args, int p_argcount, Callable::CallError &r_error);
  226. virtual bool can_instantiate() const override;
  227. virtual Ref<Script> get_base_script() const override;
  228. virtual StringName get_global_name() const override;
  229. virtual StringName get_instance_base_type() const override; // this may not work in all scripts, will return empty if so
  230. virtual ScriptInstance *instance_create(Object *p_this) override;
  231. virtual PlaceHolderScriptInstance *placeholder_instance_create(Object *p_this) override;
  232. virtual bool instance_has(const Object *p_this) const override;
  233. virtual bool has_source_code() const override;
  234. virtual String get_source_code() const override;
  235. virtual void set_source_code(const String &p_code) override;
  236. virtual void update_exports() override;
  237. #ifdef TOOLS_ENABLED
  238. virtual Vector<DocData::ClassDoc> get_documentation() const override {
  239. return docs;
  240. }
  241. virtual String get_class_icon_path() const override;
  242. #endif // TOOLS_ENABLED
  243. virtual Error reload(bool p_keep_state = false) override;
  244. virtual void set_path_cache(const String &p_path) override;
  245. virtual void set_path(const String &p_path, bool p_take_over = false) override;
  246. String get_script_path() const;
  247. Error load_source_code(const String &p_path);
  248. void set_binary_tokens_source(const Vector<uint8_t> &p_binary_tokens);
  249. const Vector<uint8_t> &get_binary_tokens_source() const;
  250. Vector<uint8_t> get_as_binary_tokens() const;
  251. bool get_property_default_value(const StringName &p_property, Variant &r_value) const override;
  252. virtual void get_script_method_list(List<MethodInfo> *p_list) const override;
  253. virtual bool has_method(const StringName &p_method) const override;
  254. virtual bool has_static_method(const StringName &p_method) const override;
  255. virtual int get_script_method_argument_count(const StringName &p_method, bool *r_is_valid = nullptr) const override;
  256. virtual MethodInfo get_method_info(const StringName &p_method) const override;
  257. virtual void get_script_property_list(List<PropertyInfo> *p_list) const override;
  258. virtual ScriptLanguage *get_language() const override;
  259. virtual int get_member_line(const StringName &p_member) const override {
  260. #ifdef TOOLS_ENABLED
  261. if (member_lines.has(p_member)) {
  262. return member_lines[p_member];
  263. }
  264. #endif
  265. return -1;
  266. }
  267. virtual void get_constants(HashMap<StringName, Variant> *p_constants) override;
  268. virtual void get_members(HashSet<StringName> *p_members) override;
  269. virtual Variant get_rpc_config() const override;
  270. void unload_static() const;
  271. #ifdef TOOLS_ENABLED
  272. virtual bool is_placeholder_fallback_enabled() const override { return placeholder_fallback_enabled; }
  273. #endif
  274. GDScript();
  275. ~GDScript();
  276. };
  277. class GDScriptInstance : public ScriptInstance {
  278. friend class GDScript;
  279. friend class GDScriptFunction;
  280. friend class GDScriptLambdaCallable;
  281. friend class GDScriptLambdaSelfCallable;
  282. friend class GDScriptCompiler;
  283. friend class GDScriptCache;
  284. friend struct GDScriptUtilityFunctionsDefinitions;
  285. ObjectID owner_id;
  286. Object *owner = nullptr;
  287. Ref<GDScript> script;
  288. #ifdef DEBUG_ENABLED
  289. HashMap<StringName, int> member_indices_cache; //used only for hot script reloading
  290. #endif
  291. Vector<Variant> members;
  292. bool base_ref_counted;
  293. SelfList<GDScriptFunctionState>::List pending_func_states;
  294. void _call_implicit_ready_recursively(GDScript *p_script);
  295. public:
  296. virtual Object *get_owner() { return owner; }
  297. virtual bool set(const StringName &p_name, const Variant &p_value);
  298. virtual bool get(const StringName &p_name, Variant &r_ret) const;
  299. virtual void get_property_list(List<PropertyInfo> *p_properties) const;
  300. virtual Variant::Type get_property_type(const StringName &p_name, bool *r_is_valid = nullptr) const;
  301. virtual void validate_property(PropertyInfo &p_property) const;
  302. virtual bool property_can_revert(const StringName &p_name) const;
  303. virtual bool property_get_revert(const StringName &p_name, Variant &r_ret) const;
  304. virtual void get_method_list(List<MethodInfo> *p_list) const;
  305. virtual bool has_method(const StringName &p_method) const;
  306. virtual int get_method_argument_count(const StringName &p_method, bool *r_is_valid = nullptr) const;
  307. virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error);
  308. Variant debug_get_member_by_index(int p_idx) const { return members[p_idx]; }
  309. virtual void notification(int p_notification, bool p_reversed = false);
  310. String to_string(bool *r_valid);
  311. virtual Ref<Script> get_script() const;
  312. virtual ScriptLanguage *get_language();
  313. void set_path(const String &p_path);
  314. void reload_members();
  315. virtual const Variant get_rpc_config() const;
  316. GDScriptInstance();
  317. ~GDScriptInstance();
  318. };
  319. class GDScriptLanguage : public ScriptLanguage {
  320. friend class GDScriptFunctionState;
  321. static GDScriptLanguage *singleton;
  322. bool finishing = false;
  323. Variant *_global_array = nullptr;
  324. Vector<Variant> global_array;
  325. HashMap<StringName, int> globals;
  326. HashMap<StringName, Variant> named_globals;
  327. Vector<int> global_array_empty_indexes;
  328. struct CallLevel {
  329. Variant *stack = nullptr;
  330. GDScriptFunction *function = nullptr;
  331. GDScriptInstance *instance = nullptr;
  332. int *ip = nullptr;
  333. int *line = nullptr;
  334. };
  335. static thread_local int _debug_parse_err_line;
  336. static thread_local String _debug_parse_err_file;
  337. static thread_local String _debug_error;
  338. struct CallStack {
  339. CallLevel *levels = nullptr;
  340. int stack_pos = 0;
  341. void free() {
  342. if (levels) {
  343. memdelete(levels);
  344. levels = nullptr;
  345. }
  346. }
  347. ~CallStack() {
  348. free();
  349. }
  350. };
  351. static thread_local CallStack _call_stack;
  352. int _debug_max_call_stack = 0;
  353. void _add_global(const StringName &p_name, const Variant &p_value);
  354. void _remove_global(const StringName &p_name);
  355. friend class GDScriptInstance;
  356. Mutex mutex;
  357. friend class GDScript;
  358. SelfList<GDScript>::List script_list;
  359. friend class GDScriptFunction;
  360. SelfList<GDScriptFunction>::List function_list;
  361. #ifdef DEBUG_ENABLED
  362. bool profiling;
  363. bool profile_native_calls;
  364. uint64_t script_frame_time;
  365. #endif
  366. HashMap<String, ObjectID> orphan_subclasses;
  367. #ifdef TOOLS_ENABLED
  368. void _extension_loaded(const Ref<GDExtension> &p_extension);
  369. void _extension_unloading(const Ref<GDExtension> &p_extension);
  370. #endif
  371. public:
  372. int calls;
  373. bool debug_break(const String &p_error, bool p_allow_continue = true);
  374. bool debug_break_parse(const String &p_file, int p_line, const String &p_error);
  375. _FORCE_INLINE_ void enter_function(GDScriptInstance *p_instance, GDScriptFunction *p_function, Variant *p_stack, int *p_ip, int *p_line) {
  376. if (unlikely(_call_stack.levels == nullptr)) {
  377. _call_stack.levels = memnew_arr(CallLevel, _debug_max_call_stack + 1);
  378. }
  379. if (EngineDebugger::get_script_debugger()->get_lines_left() > 0 && EngineDebugger::get_script_debugger()->get_depth() >= 0) {
  380. EngineDebugger::get_script_debugger()->set_depth(EngineDebugger::get_script_debugger()->get_depth() + 1);
  381. }
  382. if (_call_stack.stack_pos >= _debug_max_call_stack) {
  383. //stack overflow
  384. _debug_error = vformat("Stack overflow (stack size: %s). Check for infinite recursion in your script.", _debug_max_call_stack);
  385. EngineDebugger::get_script_debugger()->debug(this);
  386. return;
  387. }
  388. _call_stack.levels[_call_stack.stack_pos].stack = p_stack;
  389. _call_stack.levels[_call_stack.stack_pos].instance = p_instance;
  390. _call_stack.levels[_call_stack.stack_pos].function = p_function;
  391. _call_stack.levels[_call_stack.stack_pos].ip = p_ip;
  392. _call_stack.levels[_call_stack.stack_pos].line = p_line;
  393. _call_stack.stack_pos++;
  394. }
  395. _FORCE_INLINE_ void exit_function() {
  396. if (EngineDebugger::get_script_debugger()->get_lines_left() > 0 && EngineDebugger::get_script_debugger()->get_depth() >= 0) {
  397. EngineDebugger::get_script_debugger()->set_depth(EngineDebugger::get_script_debugger()->get_depth() - 1);
  398. }
  399. if (_call_stack.stack_pos == 0) {
  400. _debug_error = "Stack Underflow (Engine Bug)";
  401. EngineDebugger::get_script_debugger()->debug(this);
  402. return;
  403. }
  404. _call_stack.stack_pos--;
  405. }
  406. virtual Vector<StackInfo> debug_get_current_stack_info() override {
  407. Vector<StackInfo> csi;
  408. csi.resize(_call_stack.stack_pos);
  409. for (int i = 0; i < _call_stack.stack_pos; i++) {
  410. csi.write[_call_stack.stack_pos - i - 1].line = _call_stack.levels[i].line ? *_call_stack.levels[i].line : 0;
  411. if (_call_stack.levels[i].function) {
  412. csi.write[_call_stack.stack_pos - i - 1].func = _call_stack.levels[i].function->get_name();
  413. csi.write[_call_stack.stack_pos - i - 1].file = _call_stack.levels[i].function->get_script()->get_script_path();
  414. }
  415. }
  416. return csi;
  417. }
  418. struct {
  419. StringName _init;
  420. StringName _static_init;
  421. StringName _notification;
  422. StringName _set;
  423. StringName _get;
  424. StringName _get_property_list;
  425. StringName _validate_property;
  426. StringName _property_can_revert;
  427. StringName _property_get_revert;
  428. StringName _script_source;
  429. } strings;
  430. _FORCE_INLINE_ int get_global_array_size() const { return global_array.size(); }
  431. _FORCE_INLINE_ Variant *get_global_array() { return _global_array; }
  432. _FORCE_INLINE_ const HashMap<StringName, int> &get_global_map() const { return globals; }
  433. _FORCE_INLINE_ const HashMap<StringName, Variant> &get_named_globals_map() const { return named_globals; }
  434. // These two functions should be used when behavior needs to be consistent between in-editor and running the scene
  435. bool has_any_global_constant(const StringName &p_name) { return named_globals.has(p_name) || globals.has(p_name); }
  436. Variant get_any_global_constant(const StringName &p_name);
  437. _FORCE_INLINE_ static GDScriptLanguage *get_singleton() { return singleton; }
  438. virtual String get_name() const override;
  439. /* LANGUAGE FUNCTIONS */
  440. virtual void init() override;
  441. virtual String get_type() const override;
  442. virtual String get_extension() const override;
  443. virtual void finish() override;
  444. /* EDITOR FUNCTIONS */
  445. virtual void get_reserved_words(List<String> *p_words) const override;
  446. virtual bool is_control_flow_keyword(const String &p_keywords) const override;
  447. virtual void get_comment_delimiters(List<String> *p_delimiters) const override;
  448. virtual void get_doc_comment_delimiters(List<String> *p_delimiters) const override;
  449. virtual void get_string_delimiters(List<String> *p_delimiters) const override;
  450. virtual bool is_using_templates() override;
  451. virtual Ref<Script> make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const override;
  452. virtual Vector<ScriptTemplate> get_built_in_templates(const StringName &p_object) override;
  453. 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;
  454. virtual Script *create_script() const override;
  455. #ifndef DISABLE_DEPRECATED
  456. virtual bool has_named_classes() const override { return false; }
  457. #endif
  458. virtual bool supports_builtin_mode() const override;
  459. virtual bool supports_documentation() const override;
  460. virtual bool can_inherit_from_file() const override { return true; }
  461. virtual int find_function(const String &p_function, const String &p_code) const override;
  462. virtual String make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const override;
  463. 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;
  464. #ifdef TOOLS_ENABLED
  465. virtual Error lookup_code(const String &p_code, const String &p_symbol, const String &p_path, Object *p_owner, LookupResult &r_result) override;
  466. #endif
  467. virtual String _get_indentation() const;
  468. virtual void auto_indent_code(String &p_code, int p_from_line, int p_to_line) const override;
  469. virtual void add_global_constant(const StringName &p_variable, const Variant &p_value) override;
  470. virtual void add_named_global_constant(const StringName &p_name, const Variant &p_value) override;
  471. virtual void remove_named_global_constant(const StringName &p_name) override;
  472. /* DEBUGGER FUNCTIONS */
  473. virtual String debug_get_error() const override;
  474. virtual int debug_get_stack_level_count() const override;
  475. virtual int debug_get_stack_level_line(int p_level) const override;
  476. virtual String debug_get_stack_level_function(int p_level) const override;
  477. virtual String debug_get_stack_level_source(int p_level) const override;
  478. 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;
  479. 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;
  480. virtual ScriptInstance *debug_get_stack_level_instance(int p_level) override;
  481. virtual void debug_get_globals(List<String> *p_globals, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1) override;
  482. 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;
  483. virtual void reload_all_scripts() override;
  484. virtual void reload_scripts(const Array &p_scripts, bool p_soft_reload) override;
  485. virtual void reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) override;
  486. virtual void frame() override;
  487. virtual void get_public_functions(List<MethodInfo> *p_functions) const override;
  488. virtual void get_public_constants(List<Pair<String, Variant>> *p_constants) const override;
  489. virtual void get_public_annotations(List<MethodInfo> *p_annotations) const override;
  490. virtual void profiling_start() override;
  491. virtual void profiling_stop() override;
  492. virtual void profiling_set_save_native_calls(bool p_enable) override;
  493. void profiling_collate_native_call_data(bool p_accumulated);
  494. virtual int profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) override;
  495. virtual int profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) override;
  496. /* LOADER FUNCTIONS */
  497. virtual void get_recognized_extensions(List<String> *p_extensions) const override;
  498. /* GLOBAL CLASSES */
  499. virtual bool handles_global_class_type(const String &p_type) const override;
  500. virtual String get_global_class_name(const String &p_path, String *r_base_type = nullptr, String *r_icon_path = nullptr) const override;
  501. void add_orphan_subclass(const String &p_qualified_name, const ObjectID &p_subclass);
  502. Ref<GDScript> get_orphan_subclass(const String &p_qualified_name);
  503. Ref<GDScript> get_script_by_fully_qualified_name(const String &p_name);
  504. GDScriptLanguage();
  505. ~GDScriptLanguage();
  506. };
  507. class ResourceFormatLoaderGDScript : public ResourceFormatLoader {
  508. public:
  509. 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) override;
  510. virtual void get_recognized_extensions(List<String> *p_extensions) const override;
  511. virtual bool handles_type(const String &p_type) const override;
  512. virtual String get_resource_type(const String &p_path) const override;
  513. virtual void get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types = false) override;
  514. };
  515. class ResourceFormatSaverGDScript : public ResourceFormatSaver {
  516. public:
  517. virtual Error save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags = 0) override;
  518. virtual void get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const override;
  519. virtual bool recognize(const Ref<Resource> &p_resource) const override;
  520. };
  521. #endif // GDSCRIPT_H