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