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