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