summaryrefslogtreecommitdiff
path: root/modules/gdscript/gd_function.h
blob: e09c6509dd5462fa0df1a3ec0c31ed8d237f3d9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
#ifndef GD_FUNCTION_H
#define GD_FUNCTION_H

#include "self_list.h"
#include "os/thread.h"
#include "pair.h"
#include "variant.h"
#include "string_db.h"
#include "reference.h"

class GDInstance;
class GDScript;


class GDFunction {
public:

	enum Opcode {
		OPCODE_OPERATOR,
		OPCODE_EXTENDS_TEST,
		OPCODE_SET,
		OPCODE_GET,
		OPCODE_SET_NAMED,
		OPCODE_GET_NAMED,
		OPCODE_ASSIGN,
		OPCODE_ASSIGN_TRUE,
		OPCODE_ASSIGN_FALSE,
		OPCODE_CONSTRUCT, //only for basic types!!
		OPCODE_CONSTRUCT_ARRAY,
		OPCODE_CONSTRUCT_DICTIONARY,
		OPCODE_CALL,
		OPCODE_CALL_RETURN,
		OPCODE_CALL_BUILT_IN,
		OPCODE_CALL_SELF,
		OPCODE_CALL_SELF_BASE,
		OPCODE_YIELD,
		OPCODE_YIELD_SIGNAL,
		OPCODE_YIELD_RESUME,
		OPCODE_JUMP,
		OPCODE_JUMP_IF,
		OPCODE_JUMP_IF_NOT,
		OPCODE_JUMP_TO_DEF_ARGUMENT,
		OPCODE_RETURN,
		OPCODE_ITERATE_BEGIN,
		OPCODE_ITERATE,
		OPCODE_ASSERT,
		OPCODE_BREAKPOINT,
		OPCODE_LINE,
		OPCODE_END
	};

	enum Address {
		ADDR_BITS=24,
		ADDR_MASK=((1<<ADDR_BITS)-1),
		ADDR_TYPE_MASK=~ADDR_MASK,
		ADDR_TYPE_SELF=0,
		ADDR_TYPE_CLASS=1,
		ADDR_TYPE_MEMBER=2,
		ADDR_TYPE_CLASS_CONSTANT=3,
		ADDR_TYPE_LOCAL_CONSTANT=4,
		ADDR_TYPE_STACK=5,
		ADDR_TYPE_STACK_VARIABLE=6,
		ADDR_TYPE_GLOBAL=7,
		ADDR_TYPE_NIL=8
	};

    struct StackDebug {

	int line;
	int pos;
	bool added;
	StringName identifier;
    };

private:
friend class GDCompiler;

	StringName source;

	mutable Variant nil;
	mutable Variant *_constants_ptr;
	int _constant_count;
	const StringName *_global_names_ptr;
	int _global_names_count;
	const int *_default_arg_ptr;
	int _default_arg_count;
	const int *_code_ptr;
	int _code_size;
	int _argument_count;
	int _stack_size;
	int _call_size;
	int _initial_line;
	bool _static;
	GDScript *_script;

	StringName name;
	Vector<Variant> constants;
	Vector<StringName> global_names;
	Vector<int> default_arguments;
	Vector<int> code;

#ifdef TOOLS_ENABLED
	Vector<StringName> arg_names;
#endif

	List<StackDebug> stack_debug;

	_FORCE_INLINE_ Variant *_get_variant(int p_address,GDInstance *p_instance,GDScript *p_script,Variant &self,Variant *p_stack,String& r_error) const;
	_FORCE_INLINE_ String _get_call_error(const Variant::CallError& p_err, const String& p_where,const Variant**argptrs) const;

friend class GDScriptLanguage;

	SelfList<GDFunction> function_list;
#ifdef DEBUG_ENABLED
	CharString func_cname;
	const char*_func_cname;

	struct Profile {
		StringName signature;
		uint64_t call_count;
		uint64_t self_time;
		uint64_t total_time;
		uint64_t frame_call_count;
		uint64_t frame_self_time;
		uint64_t frame_total_time;
		uint64_t last_frame_call_count;
		uint64_t last_frame_self_time;
		uint64_t last_frame_total_time;
	} profile;

#endif

public:



	struct CallState {

		ObjectID instance_id; //by debug only
		ObjectID script_id;

		GDInstance *instance;
		Vector<uint8_t> stack;
		int stack_size;
		Variant self;
		uint32_t alloca_size;
		GDScript *_class;
		int ip;
		int line;
		int defarg;
		Variant result;

	};

	_FORCE_INLINE_ bool is_static() const { return _static; }

	const int* get_code() const; //used for debug
	int get_code_size() const;
	Variant get_constant(int p_idx) const;
	StringName get_global_name(int p_idx) const;
	StringName get_name() const;
	int get_max_stack_size() const;
	int get_default_argument_count() const;
	int get_default_argument_addr(int p_idx) const;
	GDScript *get_script() const { return _script; }
	StringName get_source() const { return source; }

	void debug_get_stack_member_state(int p_line,List<Pair<StringName,int> > *r_stackvars) const;

	_FORCE_INLINE_ bool is_empty() const { return _code_size==0; }

	int get_argument_count() const { return _argument_count; }
	StringName get_argument_name(int p_idx) const {
#ifdef TOOLS_ENABLED
		ERR_FAIL_INDEX_V(p_idx,arg_names.size(),StringName());
		return arg_names[p_idx];
#endif
		return StringName();

	}
	Variant get_default_argument(int p_idx) const {
		ERR_FAIL_INDEX_V(p_idx,default_arguments.size(),Variant());
		return default_arguments[p_idx];
	}

	Variant call(GDInstance *p_instance,const Variant **p_args, int p_argcount,Variant::CallError& r_err,CallState *p_state=NULL);

	GDFunction();
	~GDFunction();
};


class GDFunctionState : public Reference {

	OBJ_TYPE(GDFunctionState,Reference);
friend class GDFunction;
	GDFunction *function;
	GDFunction::CallState state;
	Variant _signal_callback(const Variant** p_args, int p_argcount, Variant::CallError& r_error);
protected:
	static void _bind_methods();
public:

	bool is_valid() const;
	Variant resume(const Variant& p_arg=Variant());
	GDFunctionState();
	~GDFunctionState();
};


#endif // GD_FUNCTION_H