jscript: Use bytecode for '+=' expression implementation.
[wine] / dlls / jscript / engine.h
1 /*
2  * Copyright 2008 Jacek Caban for CodeWeavers
3  *
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.
8  *
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.
13  *
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
17  */
18
19 typedef struct _source_elements_t source_elements_t;
20 typedef struct _function_expression_t function_expression_t;
21 typedef struct _expression_t expression_t;
22
23 typedef struct _function_declaration_t {
24     function_expression_t *expr;
25
26     struct _function_declaration_t *next;
27 } function_declaration_t;
28
29 typedef struct _var_list_t {
30     const WCHAR *identifier;
31
32     struct _var_list_t *next;
33 } var_list_t;
34
35 typedef struct _func_stack {
36     function_declaration_t *func_head;
37     function_declaration_t *func_tail;
38     var_list_t *var_head;
39     var_list_t *var_tail;
40
41     struct _func_stack *next;
42 } func_stack_t;
43
44 #define OP_LIST                            \
45     X(add,        1, 0,0)                  \
46     X(assign,     1, 0,0)                  \
47     X(bool,       1, ARG_INT,    0)        \
48     X(bneg,       1, 0,0)                  \
49     X(delete,     1, 0,0)                  \
50     X(div,        1, 0,0)                  \
51     X(double,     1, ARG_SBL,    0)        \
52     X(eq,         1, 0,0)                  \
53     X(eq2,        1, 0,0)                  \
54     X(gt,         1, 0,0)                  \
55     X(gteq,       1, 0,0)                  \
56     X(ident,      1, ARG_BSTR,   0)        \
57     X(identid,    1, ARG_BSTR,   0)        \
58     X(in,         1, 0,0)                  \
59     X(int,        1, ARG_INT,    0)        \
60     X(jmp,        0, ARG_ADDR,   0)        \
61     X(jmp_nz,     0, ARG_ADDR,   0)        \
62     X(jmp_z,      0, ARG_ADDR,   0)        \
63     X(lt,         1, 0,0)                  \
64     X(lteq,       1, 0,0)                  \
65     X(memberid,   1, 0,0)                  \
66     X(minus,      1, 0,0)                  \
67     X(mod,        1, 0,0)                  \
68     X(mul,        1, 0,0)                  \
69     X(neg,        1, 0,0)                  \
70     X(neq,        1, 0,0)                  \
71     X(neq2,       1, 0,0)                  \
72     X(new,        1, ARG_INT,    0)        \
73     X(null,       1, 0,0)                  \
74     X(or,         1, 0,0)                  \
75     X(pop,        1, 0,0)                  \
76     X(regexp,     1, ARG_STR,    ARG_INT)  \
77     X(str,        1, ARG_STR,    0)        \
78     X(this,       1, 0,0)                  \
79     X(throw,      0, ARG_UINT,   0)        \
80     X(tonum,      1, 0,0)                  \
81     X(tree,       1, ARG_EXPR,   0)        \
82     X(refval,     1, 0,0)                  \
83     X(ret,        0, 0,0)                  \
84     X(sub,        1, 0,0)                  \
85     X(void,       1, 0,0)                  \
86     X(xor,        1, 0,0)
87
88 typedef enum {
89 #define X(x,a,b,c) OP_##x,
90 OP_LIST
91 #undef X
92     OP_LAST
93 } jsop_t;
94
95 typedef union {
96     expression_t *expr;
97     BSTR bstr;
98     double *dbl;
99     LONG lng;
100     WCHAR *str;
101     unsigned uint;
102 } instr_arg_t;
103
104 typedef enum {
105     ARG_NONE = 0,
106     ARG_ADDR,
107     ARG_BSTR,
108     ARG_EXPR,
109     ARG_INT,
110     ARG_STR
111 } instr_arg_type_t;
112
113 typedef struct {
114     jsop_t op;
115     instr_arg_t arg1;
116     instr_arg_t arg2;
117 } instr_t;
118
119 typedef struct {
120     instr_t *instrs;
121     jsheap_t heap;
122
123     BSTR *bstr_pool;
124     unsigned bstr_pool_size;
125     unsigned bstr_cnt;
126 } bytecode_t;
127
128 void release_bytecode(bytecode_t*);
129
130 typedef struct _compiler_ctx_t compiler_ctx_t;
131
132 void release_compiler(compiler_ctx_t*);
133
134 typedef struct _parser_ctx_t {
135     LONG ref;
136
137     WCHAR *begin;
138     const WCHAR *end;
139     const WCHAR *ptr;
140
141     script_ctx_t *script;
142     source_elements_t *source;
143     BOOL nl;
144     BOOL is_html;
145     BOOL lexer_error;
146     HRESULT hres;
147
148     jsheap_t heap;
149
150     func_stack_t *func_stack;
151
152     bytecode_t *code;
153     compiler_ctx_t *compiler;
154
155     struct _parser_ctx_t *next;
156 } parser_ctx_t;
157
158 HRESULT script_parse(script_ctx_t*,const WCHAR*,const WCHAR*,parser_ctx_t**) DECLSPEC_HIDDEN;
159 void parser_release(parser_ctx_t*) DECLSPEC_HIDDEN;
160
161 int parser_lex(void*,parser_ctx_t*) DECLSPEC_HIDDEN;
162
163 static inline void parser_addref(parser_ctx_t *ctx)
164 {
165     ctx->ref++;
166 }
167
168 static inline void *parser_alloc(parser_ctx_t *ctx, DWORD size)
169 {
170     return jsheap_alloc(&ctx->heap, size);
171 }
172
173 static inline void *parser_alloc_tmp(parser_ctx_t *ctx, DWORD size)
174 {
175     return jsheap_alloc(&ctx->script->tmp_heap, size);
176 }
177
178 typedef struct _scope_chain_t {
179     LONG ref;
180     jsdisp_t *obj;
181     struct _scope_chain_t *next;
182 } scope_chain_t;
183
184 HRESULT scope_push(scope_chain_t*,jsdisp_t*,scope_chain_t**) DECLSPEC_HIDDEN;
185 void scope_release(scope_chain_t*) DECLSPEC_HIDDEN;
186
187 static inline void scope_addref(scope_chain_t *scope)
188 {
189     scope->ref++;
190 }
191
192 struct _exec_ctx_t {
193     LONG ref;
194
195     parser_ctx_t *parser;
196     scope_chain_t *scope_chain;
197     jsdisp_t *var_disp;
198     IDispatch *this_obj;
199     BOOL is_global;
200
201     VARIANT *stack;
202     unsigned stack_size;
203     unsigned top;
204
205     unsigned ip;
206     jsexcept_t ei;
207 };
208
209 static inline void exec_addref(exec_ctx_t *ctx)
210 {
211     ctx->ref++;
212 }
213
214 void exec_release(exec_ctx_t*) DECLSPEC_HIDDEN;
215 HRESULT create_exec_ctx(script_ctx_t*,IDispatch*,jsdisp_t*,scope_chain_t*,BOOL,exec_ctx_t**) DECLSPEC_HIDDEN;
216 HRESULT exec_source(exec_ctx_t*,parser_ctx_t*,source_elements_t*,BOOL,jsexcept_t*,VARIANT*) DECLSPEC_HIDDEN;
217
218 typedef struct _statement_t statement_t;
219 typedef struct _parameter_t parameter_t;
220
221 HRESULT create_source_function(parser_ctx_t*,parameter_t*,source_elements_t*,scope_chain_t*,
222         const WCHAR*,DWORD,jsdisp_t**) DECLSPEC_HIDDEN;
223
224 typedef enum {
225     LT_INT,
226     LT_DOUBLE,
227     LT_STRING,
228     LT_BOOL,
229     LT_NULL,
230     LT_REGEXP
231 }literal_type_t;
232
233 typedef struct {
234     literal_type_t type;
235     union {
236         LONG lval;
237         double dval;
238         const WCHAR *wstr;
239         VARIANT_BOOL bval;
240         struct {
241             const WCHAR *str;
242             DWORD str_len;
243             DWORD flags;
244         } regexp;
245     } u;
246 } literal_t;
247
248 literal_t *parse_regexp(parser_ctx_t*) DECLSPEC_HIDDEN;
249 literal_t *new_boolean_literal(parser_ctx_t*,VARIANT_BOOL) DECLSPEC_HIDDEN;
250
251 typedef struct _variable_declaration_t {
252     const WCHAR *identifier;
253     expression_t *expr;
254
255     struct _variable_declaration_t *next;
256 } variable_declaration_t;
257
258 typedef struct _return_type_t return_type_t;
259
260 typedef HRESULT (*statement_eval_t)(script_ctx_t*,statement_t*,return_type_t*,VARIANT*);
261
262 struct _statement_t {
263     statement_eval_t eval;
264     statement_t *next;
265 };
266
267 typedef struct {
268     statement_t stat;
269     statement_t *stat_list;
270 } block_statement_t;
271
272 typedef struct {
273     statement_t stat;
274     variable_declaration_t *variable_list;
275 } var_statement_t;
276
277 typedef struct {
278     statement_t stat;
279     expression_t *expr;
280 } expression_statement_t;
281
282 typedef struct {
283     statement_t stat;
284     expression_t *expr;
285     statement_t *if_stat;
286     statement_t *else_stat;
287 } if_statement_t;
288
289 typedef struct {
290     statement_t stat;
291     BOOL do_while;
292     expression_t *expr;
293     statement_t *statement;
294 } while_statement_t;
295
296 typedef struct {
297     statement_t stat;
298     variable_declaration_t *variable_list;
299     expression_t *begin_expr;
300     expression_t *expr;
301     expression_t *end_expr;
302     statement_t *statement;
303 } for_statement_t;
304
305 typedef struct {
306     statement_t stat;
307     variable_declaration_t *variable;
308     expression_t *expr;
309     expression_t *in_expr;
310     statement_t *statement;
311 } forin_statement_t;
312
313 typedef struct {
314     statement_t stat;
315     const WCHAR *identifier;
316 } branch_statement_t;
317
318 typedef struct {
319     statement_t stat;
320     expression_t *expr;
321     statement_t *statement;
322 } with_statement_t;
323
324 typedef struct {
325     statement_t stat;
326     const WCHAR *identifier;
327     statement_t *statement;
328 } labelled_statement_t;
329
330 typedef struct _case_clausule_t {
331     expression_t *expr;
332     statement_t *stat;
333
334     struct _case_clausule_t *next;
335 } case_clausule_t;
336
337 typedef struct {
338     statement_t stat;
339     expression_t *expr;
340     case_clausule_t *case_list;
341 } switch_statement_t;
342
343 typedef struct {
344     const WCHAR *identifier;
345     statement_t *statement;
346 } catch_block_t;
347
348 typedef struct {
349     statement_t stat;
350     statement_t *try_statement;
351     catch_block_t *catch_block;
352     statement_t *finally_statement;
353 } try_statement_t;
354
355 HRESULT block_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
356 HRESULT var_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
357 HRESULT empty_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
358 HRESULT expression_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
359 HRESULT if_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
360 HRESULT while_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
361 HRESULT for_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
362 HRESULT forin_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
363 HRESULT continue_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
364 HRESULT break_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
365 HRESULT return_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
366 HRESULT with_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
367 HRESULT labelled_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
368 HRESULT switch_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
369 HRESULT throw_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
370 HRESULT try_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
371
372 typedef struct {
373     enum {
374         EXPRVAL_VARIANT,
375         EXPRVAL_IDREF,
376         EXPRVAL_INVALID
377     } type;
378     union {
379         VARIANT var;
380         struct {
381             IDispatch *disp;
382             DISPID id;
383         } idref;
384         BSTR identifier;
385     } u;
386 } exprval_t;
387
388 typedef enum {
389      EXPR_COMMA,
390      EXPR_OR,
391      EXPR_AND,
392      EXPR_BOR,
393      EXPR_BXOR,
394      EXPR_BAND,
395      EXPR_INSTANCEOF,
396      EXPR_IN,
397      EXPR_ADD,
398      EXPR_SUB,
399      EXPR_MUL,
400      EXPR_DIV,
401      EXPR_MOD,
402      EXPR_DELETE,
403      EXPR_VOID,
404      EXPR_TYPEOF,
405      EXPR_MINUS,
406      EXPR_PLUS,
407      EXPR_POSTINC,
408      EXPR_POSTDEC,
409      EXPR_PREINC,
410      EXPR_PREDEC,
411      EXPR_EQ,
412      EXPR_EQEQ,
413      EXPR_NOTEQ,
414      EXPR_NOTEQEQ,
415      EXPR_LESS,
416      EXPR_LESSEQ,
417      EXPR_GREATER,
418      EXPR_GREATEREQ,
419      EXPR_BITNEG,
420      EXPR_LOGNEG,
421      EXPR_LSHIFT,
422      EXPR_RSHIFT,
423      EXPR_RRSHIFT,
424      EXPR_ASSIGN,
425      EXPR_ASSIGNLSHIFT,
426      EXPR_ASSIGNRSHIFT,
427      EXPR_ASSIGNRRSHIFT,
428      EXPR_ASSIGNADD,
429      EXPR_ASSIGNSUB,
430      EXPR_ASSIGNMUL,
431      EXPR_ASSIGNDIV,
432      EXPR_ASSIGNMOD,
433      EXPR_ASSIGNAND,
434      EXPR_ASSIGNOR,
435      EXPR_ASSIGNXOR,
436      EXPR_COND,
437      EXPR_ARRAY,
438      EXPR_MEMBER,
439      EXPR_NEW,
440      EXPR_CALL,
441      EXPR_THIS,
442      EXPR_FUNC,
443      EXPR_IDENT,
444      EXPR_ARRAYLIT,
445      EXPR_PROPVAL,
446      EXPR_LITERAL
447 } expression_type_t;
448
449 typedef HRESULT (*expression_eval_t)(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*);
450
451 struct _expression_t {
452     expression_type_t type;
453     expression_eval_t eval;
454     unsigned instr_off;
455 };
456
457 struct _parameter_t {
458     const WCHAR *identifier;
459
460     struct _parameter_t *next;
461 };
462
463 struct _source_elements_t {
464     statement_t *statement;
465     statement_t *statement_tail;
466     function_declaration_t *functions;
467     var_list_t *variables;
468 };
469
470 struct _function_expression_t {
471     expression_t expr;
472     const WCHAR *identifier;
473     parameter_t *parameter_list;
474     source_elements_t *source_elements;
475     const WCHAR *src_str;
476     DWORD src_len;
477 };
478
479 typedef struct {
480     expression_t expr;
481     expression_t *expression1;
482     expression_t *expression2;
483 } binary_expression_t;
484
485 typedef struct {
486     expression_t expr;
487     expression_t *expression;
488 } unary_expression_t;
489
490 typedef struct {
491     expression_t expr;
492     expression_t *expression;
493     expression_t *true_expression;
494     expression_t *false_expression;
495 } conditional_expression_t;
496
497 typedef struct {
498     expression_t expr;
499     expression_t *member_expr;
500     expression_t *expression;
501 } array_expression_t;
502
503 typedef struct {
504     expression_t expr;
505     expression_t *expression;
506     const WCHAR *identifier;
507 } member_expression_t;
508
509 typedef struct _argument_t {
510     expression_t *expr;
511
512     struct _argument_t *next;
513 } argument_t;
514
515 typedef struct {
516     expression_t expr;
517     expression_t *expression;
518     argument_t *argument_list;
519 } call_expression_t;
520
521 typedef struct {
522     expression_t expr;
523     const WCHAR *identifier;
524 } identifier_expression_t;
525
526 typedef struct {
527     expression_t expr;
528     literal_t *literal;
529 } literal_expression_t;
530
531 typedef struct _array_element_t {
532     int elision;
533     expression_t *expr;
534
535     struct _array_element_t *next;
536 } array_element_t;
537
538 typedef struct {
539     expression_t expr;
540     array_element_t *element_list;
541     int length;
542 } array_literal_expression_t;
543
544 typedef struct _prop_val_t {
545     literal_t *name;
546     expression_t *value;
547
548     struct _prop_val_t *next;
549 } prop_val_t;
550
551 typedef struct {
552     expression_t expr;
553     prop_val_t *property_list;
554 } property_value_expression_t;
555
556 HRESULT function_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
557 HRESULT array_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
558 HRESULT member_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
559 HRESULT call_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
560 HRESULT identifier_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
561 HRESULT array_literal_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
562 HRESULT property_value_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
563
564 HRESULT binary_and_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
565 HRESULT instanceof_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
566 HRESULT delete_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
567 HRESULT typeof_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
568 HRESULT post_increment_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
569 HRESULT post_decrement_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
570 HRESULT pre_increment_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
571 HRESULT pre_decrement_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
572 HRESULT left_shift_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
573 HRESULT right_shift_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
574 HRESULT right2_shift_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
575 HRESULT assign_lshift_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
576 HRESULT assign_rshift_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
577 HRESULT assign_rrshift_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
578 HRESULT assign_sub_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
579 HRESULT assign_mul_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
580 HRESULT assign_div_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
581 HRESULT assign_mod_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
582 HRESULT assign_and_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
583 HRESULT assign_or_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
584 HRESULT assign_xor_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
585
586 HRESULT compiled_expression_eval(script_ctx_t*,expression_t*,DWORD,jsexcept_t*,exprval_t*) DECLSPEC_HIDDEN;
587
588 HRESULT compile_subscript(parser_ctx_t*,expression_t*,unsigned*) DECLSPEC_HIDDEN;