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