dlls/jscript/engine.h

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