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