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