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