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