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