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