Release 3.8.
[wine.git] / dlls / jscript / engine.h
blob31f6b1cfba6a47b8d5c8c2ecaa03ca923ea847fd
1 /*
2 * Copyright 2008,2011 Jacek Caban for CodeWeavers
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 #define OP_LIST \
20 X(add, 1, 0,0) \
21 X(and, 1, 0,0) \
22 X(array, 1, 0,0) \
23 X(assign, 1, 0,0) \
24 X(assign_call,1, ARG_UINT, 0) \
25 X(bool, 1, ARG_INT, 0) \
26 X(bneg, 1, 0,0) \
27 X(call, 1, ARG_UINT, ARG_UINT) \
28 X(call_member,1, ARG_UINT, ARG_UINT) \
29 X(carray, 1, ARG_UINT, 0) \
30 X(carray_set, 1, ARG_UINT, 0) \
31 X(case, 0, ARG_ADDR, 0) \
32 X(cnd_nz, 0, ARG_ADDR, 0) \
33 X(cnd_z, 0, ARG_ADDR, 0) \
34 X(delete, 1, 0,0) \
35 X(delete_ident,1,ARG_BSTR, 0) \
36 X(div, 1, 0,0) \
37 X(double, 1, ARG_DBL, 0) \
38 X(end_finally,0, 0,0) \
39 X(enter_catch,1, ARG_BSTR, 0) \
40 X(eq, 1, 0,0) \
41 X(eq2, 1, 0,0) \
42 X(forin, 0, ARG_ADDR, 0) \
43 X(func, 1, ARG_UINT, 0) \
44 X(gt, 1, 0,0) \
45 X(gteq, 1, 0,0) \
46 X(ident, 1, ARG_BSTR, 0) \
47 X(identid, 1, ARG_BSTR, ARG_INT) \
48 X(in, 1, 0,0) \
49 X(instanceof, 1, 0,0) \
50 X(int, 1, ARG_INT, 0) \
51 X(jmp, 0, ARG_ADDR, 0) \
52 X(jmp_z, 0, ARG_ADDR, 0) \
53 X(local, 1, ARG_INT, 0) \
54 X(local_ref, 1, ARG_INT, ARG_UINT) \
55 X(lshift, 1, 0,0) \
56 X(lt, 1, 0,0) \
57 X(lteq, 1, 0,0) \
58 X(member, 1, ARG_BSTR, 0) \
59 X(memberid, 1, ARG_UINT, 0) \
60 X(minus, 1, 0,0) \
61 X(mod, 1, 0,0) \
62 X(mul, 1, 0,0) \
63 X(neg, 1, 0,0) \
64 X(neq, 1, 0,0) \
65 X(neq2, 1, 0,0) \
66 X(new, 1, ARG_UINT, 0) \
67 X(new_obj, 1, 0,0) \
68 X(null, 1, 0,0) \
69 X(obj_prop, 1, ARG_BSTR, 0) \
70 X(or, 1, 0,0) \
71 X(pop, 1, ARG_UINT, 0) \
72 X(pop_except, 0, ARG_ADDR, 0) \
73 X(pop_scope, 1, 0,0) \
74 X(postinc, 1, ARG_INT, 0) \
75 X(preinc, 1, ARG_INT, 0) \
76 X(push_except,1, ARG_ADDR, ARG_UINT) \
77 X(push_ret, 1, 0,0) \
78 X(push_scope, 1, 0,0) \
79 X(regexp, 1, ARG_STR, ARG_UINT) \
80 X(rshift, 1, 0,0) \
81 X(rshift2, 1, 0,0) \
82 X(str, 1, ARG_STR, 0) \
83 X(this, 1, 0,0) \
84 X(throw, 0, 0,0) \
85 X(throw_ref, 0, ARG_UINT, 0) \
86 X(throw_type, 0, ARG_UINT, ARG_STR) \
87 X(tonum, 1, 0,0) \
88 X(typeof, 1, 0,0) \
89 X(typeofid, 1, 0,0) \
90 X(typeofident,1, 0,0) \
91 X(refval, 1, 0,0) \
92 X(ret, 0, ARG_UINT, 0) \
93 X(setret, 1, 0,0) \
94 X(sub, 1, 0,0) \
95 X(undefined, 1, 0,0) \
96 X(void, 1, 0,0) \
97 X(xor, 1, 0,0)
99 typedef enum {
100 #define X(x,a,b,c) OP_##x,
101 OP_LIST
102 #undef X
103 OP_LAST
104 } jsop_t;
106 typedef union {
107 BSTR bstr;
108 LONG lng;
109 jsstr_t *str;
110 unsigned uint;
111 } instr_arg_t;
113 typedef enum {
114 ARG_NONE = 0,
115 ARG_ADDR,
116 ARG_BSTR,
117 ARG_DBL,
118 ARG_FUNC,
119 ARG_INT,
120 ARG_STR,
121 ARG_UINT
122 } instr_arg_type_t;
124 typedef struct {
125 jsop_t op;
126 union {
127 instr_arg_t arg[2];
128 double dbl;
129 } u;
130 } instr_t;
132 typedef struct {
133 BSTR name;
134 int ref;
135 } local_ref_t;
137 typedef struct _function_code_t {
138 BSTR name;
139 int local_ref;
140 BSTR event_target;
141 unsigned instr_off;
143 const WCHAR *source;
144 unsigned source_len;
146 unsigned func_cnt;
147 struct _function_code_t *funcs;
149 unsigned var_cnt;
150 struct {
151 BSTR name;
152 int func_id; /* -1 if not a function */
153 } *variables;
155 unsigned param_cnt;
156 BSTR *params;
158 unsigned locals_cnt;
159 local_ref_t *locals;
160 } function_code_t;
162 local_ref_t *lookup_local(const function_code_t*,const WCHAR*) DECLSPEC_HIDDEN;
164 typedef struct _bytecode_t {
165 LONG ref;
167 instr_t *instrs;
168 heap_pool_t heap;
170 function_code_t global_code;
172 WCHAR *source;
174 BSTR *bstr_pool;
175 unsigned bstr_pool_size;
176 unsigned bstr_cnt;
178 jsstr_t **str_pool;
179 unsigned str_pool_size;
180 unsigned str_cnt;
182 struct _bytecode_t *next;
183 } bytecode_t;
185 HRESULT compile_script(script_ctx_t*,const WCHAR*,const WCHAR*,const WCHAR*,BOOL,BOOL,bytecode_t**) DECLSPEC_HIDDEN;
186 void release_bytecode(bytecode_t*) DECLSPEC_HIDDEN;
188 static inline bytecode_t *bytecode_addref(bytecode_t *code)
190 code->ref++;
191 return code;
194 typedef struct _scope_chain_t {
195 LONG ref;
196 jsdisp_t *jsobj;
197 IDispatch *obj;
198 struct _call_frame_t *frame;
199 struct _scope_chain_t *next;
200 } scope_chain_t;
202 void scope_release(scope_chain_t*) DECLSPEC_HIDDEN;
204 static inline scope_chain_t *scope_addref(scope_chain_t *scope)
206 scope->ref++;
207 return scope;
210 typedef struct _except_frame_t except_frame_t;
211 struct _parser_ctx_t;
213 typedef struct _call_frame_t {
214 unsigned ip;
215 except_frame_t *except_frame;
216 unsigned stack_base;
217 scope_chain_t *scope;
218 scope_chain_t *base_scope;
220 jsval_t ret;
222 IDispatch *this_obj;
223 jsdisp_t *function_instance;
224 jsdisp_t *variable_obj;
225 jsdisp_t *arguments_obj;
226 DWORD flags;
228 unsigned argc;
229 unsigned pop_locals;
230 unsigned arguments_off;
231 unsigned variables_off;
232 unsigned pop_variables;
234 bytecode_t *bytecode;
235 function_code_t *function;
237 struct _call_frame_t *prev_frame;
238 } call_frame_t;
240 #define EXEC_GLOBAL 0x0001
241 #define EXEC_CONSTRUCTOR 0x0002
242 #define EXEC_RETURN_TO_INTERP 0x0004
243 #define EXEC_EVAL 0x0008
245 HRESULT exec_source(script_ctx_t*,DWORD,bytecode_t*,function_code_t*,scope_chain_t*,IDispatch*,
246 jsdisp_t*,jsdisp_t*,unsigned,jsval_t*,jsval_t*) DECLSPEC_HIDDEN;
248 HRESULT create_source_function(script_ctx_t*,bytecode_t*,function_code_t*,scope_chain_t*,jsdisp_t**) DECLSPEC_HIDDEN;
249 HRESULT setup_arguments_object(script_ctx_t*,call_frame_t*) DECLSPEC_HIDDEN;
250 void detach_arguments_object(jsdisp_t*) DECLSPEC_HIDDEN;