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