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