winex11: Always ignore alpha channel with XRender gradients.
[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(gt,         1, 0,0)                  \
54     X(gteq,         1, 0,0)                \
55     X(ident,      1, ARG_BSTR,   0)        \
56     X(in,         1, 0,0)                  \
57     X(int,        1, ARG_INT,    0)        \
58     X(jmp,        0, ARG_ADDR,   0)        \
59     X(jmp_nz,     0, ARG_ADDR,   0)        \
60     X(jmp_z,      0, ARG_ADDR,   0)        \
61     X(lt,         1, 0,0)                  \
62     X(lteq,       1, 0,0)                  \
63     X(minus,      1, 0,0)                  \
64     X(mod,        1, 0,0)                  \
65     X(mul,        1, 0,0)                  \
66     X(neg,        1, 0,0)                  \
67     X(neq,        1, 0,0)                  \
68     X(neq2,       1, 0,0)                  \
69     X(new,        1, ARG_INT,    0)        \
70     X(null,       1, 0,0)                  \
71     X(or,         1, 0,0)                  \
72     X(pop,        1, 0,0)                  \
73     X(regexp,     1, ARG_STR,    ARG_INT)  \
74     X(str,        1, ARG_STR,    0)        \
75     X(this,       1, 0,0)                  \
76     X(tonum,      1, 0,0)                  \
77     X(tree,       1, ARG_EXPR,   0)        \
78     X(ret,        0, 0,0)                  \
79     X(sub,        1, 0,0)                  \
80     X(void,       1, 0,0)                  \
81     X(xor,        1, 0,0)
82
83 typedef enum {
84 #define X(x,a,b,c) OP_##x,
85 OP_LIST
86 #undef X
87     OP_LAST
88 } jsop_t;
89
90 typedef union {
91     expression_t *expr;
92     BSTR bstr;
93     double *dbl;
94     LONG lng;
95     WCHAR *str;
96     unsigned uint;
97 } instr_arg_t;
98
99 typedef enum {
100     ARG_NONE = 0,
101     ARG_ADDR,
102     ARG_BSTR,
103     ARG_EXPR,
104     ARG_INT,
105     ARG_STR
106 } instr_arg_type_t;
107
108 typedef struct {
109     jsop_t op;
110     instr_arg_t arg1;
111     instr_arg_t arg2;
112 } instr_t;
113
114 typedef struct {
115     instr_t *instrs;
116     jsheap_t heap;
117
118     BSTR *bstr_pool;
119     unsigned bstr_pool_size;
120     unsigned bstr_cnt;
121 } bytecode_t;
122
123 void release_bytecode(bytecode_t*);
124
125 typedef struct _compiler_ctx_t compiler_ctx_t;
126
127 void release_compiler(compiler_ctx_t*);
128
129 typedef struct _parser_ctx_t {
130     LONG ref;
131
132     WCHAR *begin;
133     const WCHAR *end;
134     const WCHAR *ptr;
135
136     script_ctx_t *script;
137     source_elements_t *source;
138     BOOL nl;
139     BOOL is_html;
140     BOOL lexer_error;
141     HRESULT hres;
142
143     jsheap_t heap;
144
145     func_stack_t *func_stack;
146
147     bytecode_t *code;
148     compiler_ctx_t *compiler;
149
150     struct _parser_ctx_t *next;
151 } parser_ctx_t;
152
153 HRESULT script_parse(script_ctx_t*,const WCHAR*,const WCHAR*,parser_ctx_t**) DECLSPEC_HIDDEN;
154 void parser_release(parser_ctx_t*) DECLSPEC_HIDDEN;
155
156 int parser_lex(void*,parser_ctx_t*) DECLSPEC_HIDDEN;
157
158 static inline void parser_addref(parser_ctx_t *ctx)
159 {
160     ctx->ref++;
161 }
162
163 static inline void *parser_alloc(parser_ctx_t *ctx, DWORD size)
164 {
165     return jsheap_alloc(&ctx->heap, size);
166 }
167
168 static inline void *parser_alloc_tmp(parser_ctx_t *ctx, DWORD size)
169 {
170     return jsheap_alloc(&ctx->script->tmp_heap, size);
171 }
172
173 typedef struct _scope_chain_t {
174     LONG ref;
175     jsdisp_t *obj;
176     struct _scope_chain_t *next;
177 } scope_chain_t;
178
179 HRESULT scope_push(scope_chain_t*,jsdisp_t*,scope_chain_t**) DECLSPEC_HIDDEN;
180 void scope_release(scope_chain_t*) DECLSPEC_HIDDEN;
181
182 static inline void scope_addref(scope_chain_t *scope)
183 {
184     scope->ref++;
185 }
186
187 struct _exec_ctx_t {
188     LONG ref;
189
190     parser_ctx_t *parser;
191     scope_chain_t *scope_chain;
192     jsdisp_t *var_disp;
193     IDispatch *this_obj;
194     BOOL is_global;
195
196     VARIANT *stack;
197     unsigned stack_size;
198     unsigned top;
199
200     unsigned ip;
201     jsexcept_t ei;
202 };
203
204 static inline void exec_addref(exec_ctx_t *ctx)
205 {
206     ctx->ref++;
207 }
208
209 void exec_release(exec_ctx_t*) DECLSPEC_HIDDEN;
210 HRESULT create_exec_ctx(script_ctx_t*,IDispatch*,jsdisp_t*,scope_chain_t*,BOOL,exec_ctx_t**) DECLSPEC_HIDDEN;
211 HRESULT exec_source(exec_ctx_t*,parser_ctx_t*,source_elements_t*,BOOL,jsexcept_t*,VARIANT*) DECLSPEC_HIDDEN;
212
213 typedef struct _statement_t statement_t;
214 typedef struct _parameter_t parameter_t;
215
216 HRESULT create_source_function(parser_ctx_t*,parameter_t*,source_elements_t*,scope_chain_t*,
217         const WCHAR*,DWORD,jsdisp_t**) DECLSPEC_HIDDEN;
218
219 typedef enum {
220     LT_INT,
221     LT_DOUBLE,
222     LT_STRING,
223     LT_BOOL,
224     LT_NULL,
225     LT_REGEXP
226 }literal_type_t;
227
228 typedef struct {
229     literal_type_t type;
230     union {
231         LONG lval;
232         double dval;
233         const WCHAR *wstr;
234         VARIANT_BOOL bval;
235         struct {
236             const WCHAR *str;
237             DWORD str_len;
238             DWORD flags;
239         } regexp;
240     } u;
241 } literal_t;
242
243 literal_t *parse_regexp(parser_ctx_t*) DECLSPEC_HIDDEN;
244 literal_t *new_boolean_literal(parser_ctx_t*,VARIANT_BOOL) DECLSPEC_HIDDEN;
245
246 typedef struct _variable_declaration_t {
247     const WCHAR *identifier;
248     expression_t *expr;
249
250     struct _variable_declaration_t *next;
251 } variable_declaration_t;
252
253 typedef struct _return_type_t return_type_t;
254
255 typedef HRESULT (*statement_eval_t)(script_ctx_t*,statement_t*,return_type_t*,VARIANT*);
256
257 struct _statement_t {
258     statement_eval_t eval;
259     statement_t *next;
260 };
261
262 typedef struct {
263     statement_t stat;
264     statement_t *stat_list;
265 } block_statement_t;
266
267 typedef struct {
268     statement_t stat;
269     variable_declaration_t *variable_list;
270 } var_statement_t;
271
272 typedef struct {
273     statement_t stat;
274     expression_t *expr;
275 } expression_statement_t;
276
277 typedef struct {
278     statement_t stat;
279     expression_t *expr;
280     statement_t *if_stat;
281     statement_t *else_stat;
282 } if_statement_t;
283
284 typedef struct {
285     statement_t stat;
286     BOOL do_while;
287     expression_t *expr;
288     statement_t *statement;
289 } while_statement_t;
290
291 typedef struct {
292     statement_t stat;
293     variable_declaration_t *variable_list;
294     expression_t *begin_expr;
295     expression_t *expr;
296     expression_t *end_expr;
297     statement_t *statement;
298 } for_statement_t;
299
300 typedef struct {
301     statement_t stat;
302     variable_declaration_t *variable;
303     expression_t *expr;
304     expression_t *in_expr;
305     statement_t *statement;
306 } forin_statement_t;
307
308 typedef struct {
309     statement_t stat;
310     const WCHAR *identifier;
311 } branch_statement_t;
312
313 typedef struct {
314     statement_t stat;
315     expression_t *expr;
316     statement_t *statement;
317 } with_statement_t;
318
319 typedef struct {
320     statement_t stat;
321     const WCHAR *identifier;
322     statement_t *statement;
323 } labelled_statement_t;
324
325 typedef struct _case_clausule_t {
326     expression_t *expr;
327     statement_t *stat;
328
329     struct _case_clausule_t *next;
330 } case_clausule_t;
331
332 typedef struct {
333     statement_t stat;
334     expression_t *expr;
335     case_clausule_t *case_list;
336 } switch_statement_t;
337
338 typedef struct {
339     const WCHAR *identifier;
340     statement_t *statement;
341 } catch_block_t;
342
343 typedef struct {
344     statement_t stat;
345     statement_t *try_statement;
346     catch_block_t *catch_block;
347     statement_t *finally_statement;
348 } try_statement_t;
349
350 HRESULT block_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
351 HRESULT var_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
352 HRESULT empty_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
353 HRESULT expression_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
354 HRESULT if_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
355 HRESULT while_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
356 HRESULT for_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
357 HRESULT forin_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
358 HRESULT continue_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
359 HRESULT break_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
360 HRESULT return_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
361 HRESULT with_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
362 HRESULT labelled_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
363 HRESULT switch_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
364 HRESULT throw_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
365 HRESULT try_statement_eval(script_ctx_t*,statement_t*,return_type_t*,VARIANT*) DECLSPEC_HIDDEN;
366
367 typedef struct {
368     enum {
369         EXPRVAL_VARIANT,
370         EXPRVAL_IDREF,
371         EXPRVAL_INVALID
372     } type;
373     union {
374         VARIANT var;
375         struct {
376             IDispatch *disp;
377             DISPID id;
378         } idref;
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 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;