visual_script.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649
  1. /*************************************************************************/
  2. /* visual_script.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  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 VISUAL_SCRIPT_H
  31. #define VISUAL_SCRIPT_H
  32. #include "core/debugger/engine_debugger.h"
  33. #include "core/debugger/script_debugger.h"
  34. #include "core/doc_data.h"
  35. #include "core/object/script_language.h"
  36. #include "core/os/thread.h"
  37. class VisualScriptInstance;
  38. class VisualScriptNodeInstance;
  39. class VisualScript;
  40. class VisualScriptNode : public Resource {
  41. GDCLASS(VisualScriptNode, Resource);
  42. friend class VisualScript;
  43. Ref<VisualScript> script_used;
  44. Array default_input_values;
  45. bool breakpoint;
  46. void _set_default_input_values(Array p_values);
  47. Array _get_default_input_values() const;
  48. void validate_input_default_values();
  49. protected:
  50. void ports_changed_notify();
  51. static void _bind_methods();
  52. public:
  53. Ref<VisualScript> get_visual_script() const;
  54. virtual int get_output_sequence_port_count() const = 0;
  55. virtual bool has_input_sequence_port() const = 0;
  56. virtual String get_output_sequence_port_text(int p_port) const = 0;
  57. virtual bool has_mixed_input_and_sequence_ports() const { return false; }
  58. virtual int get_input_value_port_count() const = 0;
  59. virtual int get_output_value_port_count() const = 0;
  60. virtual PropertyInfo get_input_value_port_info(int p_idx) const = 0;
  61. virtual PropertyInfo get_output_value_port_info(int p_idx) const = 0;
  62. void set_default_input_value(int p_port, const Variant &p_value);
  63. Variant get_default_input_value(int p_port) const;
  64. virtual String get_caption() const = 0;
  65. virtual String get_text() const;
  66. virtual String get_category() const = 0;
  67. // Used by editor, this is not really saved.
  68. void set_breakpoint(bool p_breakpoint);
  69. bool is_breakpoint() const;
  70. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance) = 0;
  71. struct TypeGuess {
  72. Variant::Type type;
  73. StringName gdclass;
  74. Ref<Script> script;
  75. TypeGuess() {
  76. type = Variant::NIL;
  77. }
  78. };
  79. virtual TypeGuess guess_output_type(TypeGuess *p_inputs, int p_output) const;
  80. VisualScriptNode();
  81. };
  82. class VisualScriptNodeInstance {
  83. friend class VisualScriptInstance;
  84. friend class VisualScriptLanguage; // For debugger.
  85. enum { // Input argument addressing.
  86. INPUT_SHIFT = 1 << 24,
  87. INPUT_MASK = INPUT_SHIFT - 1,
  88. INPUT_DEFAULT_VALUE_BIT = INPUT_SHIFT, // from unassigned input port, using default value (edited by user)
  89. };
  90. int id;
  91. int sequence_index;
  92. VisualScriptNodeInstance **sequence_outputs;
  93. int sequence_output_count;
  94. Vector<VisualScriptNodeInstance *> dependencies;
  95. int *input_ports;
  96. int input_port_count;
  97. int *output_ports;
  98. int output_port_count;
  99. int working_mem_idx;
  100. int pass_idx;
  101. VisualScriptNode *base;
  102. public:
  103. enum StartMode {
  104. START_MODE_BEGIN_SEQUENCE,
  105. START_MODE_CONTINUE_SEQUENCE,
  106. START_MODE_RESUME_YIELD
  107. };
  108. enum {
  109. STEP_SHIFT = 1 << 24,
  110. STEP_MASK = STEP_SHIFT - 1,
  111. STEP_FLAG_PUSH_STACK_BIT = STEP_SHIFT, // push bit to stack
  112. STEP_FLAG_GO_BACK_BIT = STEP_SHIFT << 1, // go back to previous node
  113. STEP_NO_ADVANCE_BIT = STEP_SHIFT << 2, // do not advance past this node
  114. STEP_EXIT_FUNCTION_BIT = STEP_SHIFT << 3, // return from function
  115. STEP_YIELD_BIT = STEP_SHIFT << 4, // yield (will find VisualScriptFunctionState state in first working memory)
  116. FLOW_STACK_PUSHED_BIT = 1 << 30, // in flow stack, means bit was pushed (must go back here if end of sequence)
  117. FLOW_STACK_MASK = FLOW_STACK_PUSHED_BIT - 1
  118. };
  119. _FORCE_INLINE_ int get_input_port_count() const { return input_port_count; }
  120. _FORCE_INLINE_ int get_output_port_count() const { return output_port_count; }
  121. _FORCE_INLINE_ int get_sequence_output_count() const { return sequence_output_count; }
  122. _FORCE_INLINE_ int get_id() const { return id; }
  123. virtual int get_working_memory_size() const { return 0; }
  124. virtual int step(const Variant **p_inputs, Variant **p_outputs, StartMode p_start_mode, Variant *p_working_mem, Callable::CallError &r_error, String &r_error_str) = 0; // Do a step, return which sequence port to go out.
  125. Ref<VisualScriptNode> get_base_node() { return Ref<VisualScriptNode>(base); }
  126. VisualScriptNodeInstance();
  127. virtual ~VisualScriptNodeInstance();
  128. };
  129. class VisualScript : public Script {
  130. GDCLASS(VisualScript, Script);
  131. RES_BASE_EXTENSION("vs");
  132. public:
  133. struct SequenceConnection {
  134. union {
  135. struct {
  136. uint64_t from_node : 24;
  137. uint64_t from_output : 16;
  138. uint64_t to_node : 24;
  139. };
  140. uint64_t id;
  141. };
  142. bool operator<(const SequenceConnection &p_connection) const {
  143. return id < p_connection.id;
  144. }
  145. };
  146. struct DataConnection {
  147. union {
  148. struct {
  149. uint64_t from_node : 24;
  150. uint64_t from_port : 8;
  151. uint64_t to_node : 24;
  152. uint64_t to_port : 8;
  153. };
  154. uint64_t id;
  155. };
  156. bool operator<(const DataConnection &p_connection) const {
  157. return id < p_connection.id;
  158. }
  159. };
  160. private:
  161. friend class VisualScriptInstance;
  162. StringName base_type;
  163. struct Argument {
  164. String name;
  165. Variant::Type type;
  166. };
  167. struct NodeData {
  168. Point2 pos;
  169. Ref<VisualScriptNode> node;
  170. };
  171. HashMap<int, NodeData> nodes; // Can be a sparse map.
  172. Set<SequenceConnection> sequence_connections;
  173. Set<DataConnection> data_connections;
  174. Vector2 scroll;
  175. struct Function {
  176. int func_id;
  177. Function() { func_id = -1; }
  178. };
  179. struct Variable {
  180. PropertyInfo info;
  181. Variant default_value;
  182. bool _export;
  183. // Add getter & setter options here.
  184. };
  185. HashMap<StringName, Function> functions;
  186. HashMap<StringName, Variable> variables;
  187. Map<StringName, Vector<Argument>> custom_signals;
  188. Vector<ScriptNetData> rpc_functions;
  189. Vector<ScriptNetData> rpc_variables;
  190. Map<Object *, VisualScriptInstance *> instances;
  191. bool is_tool_script;
  192. #ifdef TOOLS_ENABLED
  193. Set<PlaceHolderScriptInstance *> placeholders;
  194. // void _update_placeholder(PlaceHolderScriptInstance *p_placeholder);
  195. virtual void _placeholder_erased(PlaceHolderScriptInstance *p_placeholder) override;
  196. void _update_placeholders();
  197. #endif
  198. void _set_variable_info(const StringName &p_name, const Dictionary &p_info);
  199. Dictionary _get_variable_info(const StringName &p_name) const;
  200. void _set_data(const Dictionary &p_data);
  201. Dictionary _get_data() const;
  202. protected:
  203. void _node_ports_changed(int p_id);
  204. static void _bind_methods();
  205. public:
  206. bool inherits_script(const Ref<Script> &p_script) const override;
  207. void set_scroll(const Vector2 &p_scroll);
  208. Vector2 get_scroll() const;
  209. void add_function(const StringName &p_name, int p_func_node_id);
  210. bool has_function(const StringName &p_name) const;
  211. void remove_function(const StringName &p_name);
  212. void rename_function(const StringName &p_name, const StringName &p_new_name);
  213. void get_function_list(List<StringName> *r_functions) const;
  214. int get_function_node_id(const StringName &p_name) const;
  215. void set_tool_enabled(bool p_enabled);
  216. void add_node(int p_id, const Ref<VisualScriptNode> &p_node, const Point2 &p_pos = Point2());
  217. void remove_node(int p_id);
  218. bool has_node(int p_id) const;
  219. Ref<VisualScriptNode> get_node(int p_id) const;
  220. void set_node_position(int p_id, const Point2 &p_pos);
  221. Point2 get_node_position(int p_id) const;
  222. void get_node_list(List<int> *r_nodes) const;
  223. void sequence_connect(int p_from_node, int p_from_output, int p_to_node);
  224. void sequence_disconnect(int p_from_node, int p_from_output, int p_to_node);
  225. bool has_sequence_connection(int p_from_node, int p_from_output, int p_to_node) const;
  226. void get_sequence_connection_list(List<SequenceConnection> *r_connection) const;
  227. Set<int> get_output_sequence_ports_connected(int from_node);
  228. void data_connect(int p_from_node, int p_from_port, int p_to_node, int p_to_port);
  229. void data_disconnect(int p_from_node, int p_from_port, int p_to_node, int p_to_port);
  230. bool has_data_connection(int p_from_node, int p_from_port, int p_to_node, int p_to_port) const;
  231. void get_data_connection_list(List<DataConnection> *r_connection) const;
  232. bool is_input_value_port_connected(int p_node, int p_port) const;
  233. bool get_input_value_port_connection_source(int p_node, int p_port, int *r_node, int *r_port) const;
  234. void add_variable(const StringName &p_name, const Variant &p_default_value = Variant(), bool p_export = false);
  235. bool has_variable(const StringName &p_name) const;
  236. void remove_variable(const StringName &p_name);
  237. void set_variable_default_value(const StringName &p_name, const Variant &p_value);
  238. Variant get_variable_default_value(const StringName &p_name) const;
  239. void set_variable_info(const StringName &p_name, const PropertyInfo &p_info);
  240. PropertyInfo get_variable_info(const StringName &p_name) const;
  241. void set_variable_export(const StringName &p_name, bool p_export);
  242. bool get_variable_export(const StringName &p_name) const;
  243. void get_variable_list(List<StringName> *r_variables) const;
  244. void rename_variable(const StringName &p_name, const StringName &p_new_name);
  245. void add_custom_signal(const StringName &p_name);
  246. bool has_custom_signal(const StringName &p_name) const;
  247. void custom_signal_add_argument(const StringName &p_func, Variant::Type p_type, const String &p_name, int p_index = -1);
  248. void custom_signal_set_argument_type(const StringName &p_func, int p_argidx, Variant::Type p_type);
  249. Variant::Type custom_signal_get_argument_type(const StringName &p_func, int p_argidx) const;
  250. void custom_signal_set_argument_name(const StringName &p_func, int p_argidx, const String &p_name);
  251. String custom_signal_get_argument_name(const StringName &p_func, int p_argidx) const;
  252. void custom_signal_remove_argument(const StringName &p_func, int p_argidx);
  253. int custom_signal_get_argument_count(const StringName &p_func) const;
  254. void custom_signal_swap_argument(const StringName &p_func, int p_argidx, int p_with_argidx);
  255. void remove_custom_signal(const StringName &p_name);
  256. void rename_custom_signal(const StringName &p_name, const StringName &p_new_name);
  257. Set<int> get_output_sequence_ports_connected(const String &edited_func, int from_node);
  258. void get_custom_signal_list(List<StringName> *r_custom_signals) const;
  259. int get_available_id() const;
  260. void set_instance_base_type(const StringName &p_type);
  261. virtual bool can_instance() const override;
  262. virtual Ref<Script> get_base_script() const override;
  263. virtual StringName get_instance_base_type() const override;
  264. virtual ScriptInstance *instance_create(Object *p_this) override;
  265. virtual bool instance_has(const Object *p_this) const override;
  266. virtual bool has_source_code() const override;
  267. virtual String get_source_code() const override;
  268. virtual void set_source_code(const String &p_code) override;
  269. virtual Error reload(bool p_keep_state = false) override;
  270. #ifdef TOOLS_ENABLED
  271. virtual const Vector<DocData::ClassDoc> &get_documentation() const override {
  272. static Vector<DocData::ClassDoc> docs;
  273. return docs;
  274. }
  275. #endif // TOOLS_ENABLED
  276. virtual bool is_tool() const override;
  277. virtual bool is_valid() const override;
  278. virtual ScriptLanguage *get_language() const override;
  279. virtual bool has_script_signal(const StringName &p_signal) const override;
  280. virtual void get_script_signal_list(List<MethodInfo> *r_signals) const override;
  281. virtual bool get_property_default_value(const StringName &p_property, Variant &r_value) const override;
  282. virtual void get_script_method_list(List<MethodInfo> *p_list) const override;
  283. virtual bool has_method(const StringName &p_method) const override;
  284. virtual MethodInfo get_method_info(const StringName &p_method) const override;
  285. virtual void get_script_property_list(List<PropertyInfo> *p_list) const override;
  286. virtual int get_member_line(const StringName &p_member) const override;
  287. virtual Vector<ScriptNetData> get_rpc_methods() const override;
  288. virtual uint16_t get_rpc_method_id(const StringName &p_method) const override;
  289. virtual StringName get_rpc_method(const uint16_t p_rpc_method_id) const override;
  290. virtual MultiplayerAPI::RPCMode get_rpc_mode_by_id(const uint16_t p_rpc_method_id) const override;
  291. virtual MultiplayerAPI::RPCMode get_rpc_mode(const StringName &p_method) const override;
  292. virtual Vector<ScriptNetData> get_rset_properties() const override;
  293. virtual uint16_t get_rset_property_id(const StringName &p_property) const override;
  294. virtual StringName get_rset_property(const uint16_t p_rset_property_id) const override;
  295. virtual MultiplayerAPI::RPCMode get_rset_mode_by_id(const uint16_t p_rpc_method_id) const override;
  296. virtual MultiplayerAPI::RPCMode get_rset_mode(const StringName &p_variable) const override;
  297. #ifdef TOOLS_ENABLED
  298. virtual bool are_subnodes_edited() const;
  299. #endif
  300. VisualScript();
  301. ~VisualScript();
  302. };
  303. class VisualScriptInstance : public ScriptInstance {
  304. Object *owner;
  305. Ref<VisualScript> script;
  306. Map<StringName, Variant> variables; // Using variable path, not script.
  307. Map<int, VisualScriptNodeInstance *> instances;
  308. struct Function {
  309. int node;
  310. int max_stack;
  311. int trash_pos;
  312. int flow_stack_size;
  313. int pass_stack_size;
  314. int node_count;
  315. int argument_count;
  316. };
  317. Map<StringName, Function> functions;
  318. Vector<Variant> default_values;
  319. int max_input_args, max_output_args;
  320. StringName source;
  321. void _dependency_step(VisualScriptNodeInstance *node, int p_pass, int *pass_stack, const Variant **input_args, Variant **output_args, Variant *variant_stack, Callable::CallError &r_error, String &error_str, VisualScriptNodeInstance **r_error_node);
  322. Variant _call_internal(const StringName &p_method, void *p_stack, int p_stack_size, VisualScriptNodeInstance *p_node, int p_flow_stack_pos, int p_pass, bool p_resuming_yield, Callable::CallError &r_error);
  323. friend class VisualScriptFunctionState; // For yield.
  324. friend class VisualScriptLanguage; // For debugger.
  325. public:
  326. virtual bool set(const StringName &p_name, const Variant &p_value);
  327. virtual bool get(const StringName &p_name, Variant &r_ret) const;
  328. virtual void get_property_list(List<PropertyInfo> *p_properties) const;
  329. virtual Variant::Type get_property_type(const StringName &p_name, bool *r_is_valid = nullptr) const;
  330. virtual void get_method_list(List<MethodInfo> *p_list) const;
  331. virtual bool has_method(const StringName &p_method) const;
  332. virtual Variant call(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error);
  333. virtual void notification(int p_notification);
  334. String to_string(bool *r_valid);
  335. bool set_variable(const StringName &p_variable, const Variant &p_value) {
  336. Map<StringName, Variant>::Element *E = variables.find(p_variable);
  337. if (!E) {
  338. return false;
  339. }
  340. E->get() = p_value;
  341. return true;
  342. }
  343. bool get_variable(const StringName &p_variable, Variant *r_variable) const {
  344. const Map<StringName, Variant>::Element *E = variables.find(p_variable);
  345. if (!E) {
  346. return false;
  347. }
  348. *r_variable = E->get();
  349. return true;
  350. }
  351. virtual Ref<Script> get_script() const;
  352. _FORCE_INLINE_ VisualScript *get_script_ptr() { return script.ptr(); }
  353. _FORCE_INLINE_ Object *get_owner_ptr() { return owner; }
  354. void create(const Ref<VisualScript> &p_script, Object *p_owner);
  355. virtual ScriptLanguage *get_language();
  356. virtual Vector<ScriptNetData> get_rpc_methods() const;
  357. virtual uint16_t get_rpc_method_id(const StringName &p_method) const;
  358. virtual StringName get_rpc_method(const uint16_t p_rpc_method_id) const;
  359. virtual MultiplayerAPI::RPCMode get_rpc_mode_by_id(const uint16_t p_rpc_method_id) const;
  360. virtual MultiplayerAPI::RPCMode get_rpc_mode(const StringName &p_method) const;
  361. virtual Vector<ScriptNetData> get_rset_properties() const;
  362. virtual uint16_t get_rset_property_id(const StringName &p_property) const;
  363. virtual StringName get_rset_property(const uint16_t p_rset_property_id) const;
  364. virtual MultiplayerAPI::RPCMode get_rset_mode_by_id(const uint16_t p_rpc_method_id) const;
  365. virtual MultiplayerAPI::RPCMode get_rset_mode(const StringName &p_variable) const;
  366. VisualScriptInstance();
  367. ~VisualScriptInstance();
  368. };
  369. class VisualScriptFunctionState : public Reference {
  370. GDCLASS(VisualScriptFunctionState, Reference);
  371. friend class VisualScriptInstance;
  372. ObjectID instance_id;
  373. ObjectID script_id;
  374. VisualScriptInstance *instance;
  375. StringName function;
  376. Vector<uint8_t> stack;
  377. int working_mem_index;
  378. int variant_stack_size;
  379. VisualScriptNodeInstance *node;
  380. int flow_stack_pos;
  381. int pass;
  382. Variant _signal_callback(const Variant **p_args, int p_argcount, Callable::CallError &r_error);
  383. protected:
  384. static void _bind_methods();
  385. public:
  386. void connect_to_signal(Object *p_obj, const String &p_signal, Array p_binds);
  387. bool is_valid() const;
  388. Variant resume(Array p_args);
  389. VisualScriptFunctionState();
  390. ~VisualScriptFunctionState();
  391. };
  392. typedef Ref<VisualScriptNode> (*VisualScriptNodeRegisterFunc)(const String &p_type);
  393. class VisualScriptLanguage : public ScriptLanguage {
  394. Map<String, VisualScriptNodeRegisterFunc> register_funcs;
  395. struct CallLevel {
  396. Variant *stack;
  397. Variant **work_mem;
  398. const StringName *function;
  399. VisualScriptInstance *instance;
  400. int *current_id;
  401. };
  402. int _debug_parse_err_node;
  403. String _debug_parse_err_file;
  404. String _debug_error;
  405. int _debug_call_stack_pos;
  406. int _debug_max_call_stack;
  407. CallLevel *_call_stack;
  408. public:
  409. StringName notification;
  410. StringName _get_output_port_unsequenced;
  411. StringName _step;
  412. StringName _subcall;
  413. static VisualScriptLanguage *singleton;
  414. Mutex lock;
  415. bool debug_break(const String &p_error, bool p_allow_continue = true);
  416. bool debug_break_parse(const String &p_file, int p_node, const String &p_error);
  417. _FORCE_INLINE_ void enter_function(VisualScriptInstance *p_instance, const StringName *p_function, Variant *p_stack, Variant **p_work_mem, int *current_id) {
  418. if (Thread::get_main_id() != Thread::get_caller_id()) {
  419. return; // No support for other threads than main for now.
  420. }
  421. if (EngineDebugger::get_script_debugger()->get_lines_left() > 0 && EngineDebugger::get_script_debugger()->get_depth() >= 0) {
  422. EngineDebugger::get_script_debugger()->set_depth(EngineDebugger::get_script_debugger()->get_depth() + 1);
  423. }
  424. if (_debug_call_stack_pos >= _debug_max_call_stack) {
  425. // Stack overflow.
  426. _debug_error = "Stack Overflow (Stack Size: " + itos(_debug_max_call_stack) + ")";
  427. EngineDebugger::get_script_debugger()->debug(this);
  428. return;
  429. }
  430. _call_stack[_debug_call_stack_pos].stack = p_stack;
  431. _call_stack[_debug_call_stack_pos].instance = p_instance;
  432. _call_stack[_debug_call_stack_pos].function = p_function;
  433. _call_stack[_debug_call_stack_pos].work_mem = p_work_mem;
  434. _call_stack[_debug_call_stack_pos].current_id = current_id;
  435. _debug_call_stack_pos++;
  436. }
  437. _FORCE_INLINE_ void exit_function() {
  438. if (Thread::get_main_id() != Thread::get_caller_id()) {
  439. return; // No support for other threads than main for now.
  440. }
  441. if (EngineDebugger::get_script_debugger()->get_lines_left() > 0 && EngineDebugger::get_script_debugger()->get_depth() >= 0) {
  442. EngineDebugger::get_script_debugger()->set_depth(EngineDebugger::get_script_debugger()->get_depth() - 1);
  443. }
  444. if (_debug_call_stack_pos == 0) {
  445. _debug_error = "Stack Underflow (Engine Bug)";
  446. EngineDebugger::get_script_debugger()->debug(this);
  447. return;
  448. }
  449. _debug_call_stack_pos--;
  450. }
  451. //////////////////////////////////////
  452. virtual String get_name() const;
  453. /* LANGUAGE FUNCTIONS */
  454. virtual void init();
  455. virtual String get_type() const;
  456. virtual String get_extension() const;
  457. virtual Error execute_file(const String &p_path);
  458. virtual void finish();
  459. /* EDITOR FUNCTIONS */
  460. virtual void get_reserved_words(List<String> *p_words) const;
  461. virtual void get_comment_delimiters(List<String> *p_delimiters) const;
  462. virtual void get_string_delimiters(List<String> *p_delimiters) const;
  463. virtual Ref<Script> get_template(const String &p_class_name, const String &p_base_class_name) const;
  464. virtual bool is_using_templates();
  465. virtual void make_template(const String &p_class_name, const String &p_base_class_name, Ref<Script> &p_script);
  466. 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 = nullptr, List<ScriptLanguage::Warning> *r_warnings = nullptr, Set<int> *r_safe_lines = nullptr) const;
  467. virtual Script *create_script() const;
  468. virtual bool has_named_classes() const;
  469. virtual bool supports_builtin_mode() const;
  470. virtual int find_function(const String &p_function, const String &p_code) const;
  471. virtual String make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const;
  472. virtual void auto_indent_code(String &p_code, int p_from_line, int p_to_line) const;
  473. virtual void add_global_constant(const StringName &p_variable, const Variant &p_value);
  474. /* DEBUGGER FUNCTIONS */
  475. virtual String debug_get_error() const;
  476. virtual int debug_get_stack_level_count() const;
  477. virtual int debug_get_stack_level_line(int p_level) const;
  478. virtual String debug_get_stack_level_function(int p_level) const;
  479. virtual String debug_get_stack_level_source(int p_level) const;
  480. 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);
  481. 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);
  482. virtual void debug_get_globals(List<String> *p_locals, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1);
  483. virtual String debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems = -1, int p_max_depth = -1);
  484. virtual void reload_all_scripts();
  485. virtual void reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload);
  486. /* LOADER FUNCTIONS */
  487. virtual void get_recognized_extensions(List<String> *p_extensions) const;
  488. virtual void get_public_functions(List<MethodInfo> *p_functions) const;
  489. virtual void get_public_constants(List<Pair<String, Variant>> *p_constants) const;
  490. virtual void profiling_start();
  491. virtual void profiling_stop();
  492. virtual int profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max);
  493. virtual int profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max);
  494. void add_register_func(const String &p_name, VisualScriptNodeRegisterFunc p_func);
  495. void remove_register_func(const String &p_name);
  496. Ref<VisualScriptNode> create_node_from_name(const String &p_name);
  497. void get_registered_node_names(List<String> *r_names);
  498. VisualScriptLanguage();
  499. ~VisualScriptLanguage();
  500. };
  501. // Aid for registering.
  502. template <class T>
  503. static Ref<VisualScriptNode> create_node_generic(const String &p_name) {
  504. Ref<T> node;
  505. node.instance();
  506. return node;
  507. }
  508. #endif // VISUAL_SCRIPT_H