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