dlls/jscript/engine.h

   1 /*
   2  * Copyright 2008,2011 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 #define OP_LIST                            \
  20     X(add,        1, 0,0)                  \
  21     X(and,        1, 0,0)                  \
  22     X(array,      1, 0,0)                  \
  23     X(assign,     1, 0,0)                  \
  24     X(assign_call,1, ARG_UINT,   0)        \
  25     X(bool,       1, ARG_INT,    0)        \
  26     X(bneg,       1, 0,0)                  \
  27     X(call,       1, ARG_UINT,   ARG_UINT) \
  28     X(call_member,1, ARG_UINT,   ARG_UINT) \
  29     X(carray,     1, ARG_UINT,   0)        \
  30     X(carray_set, 1, ARG_UINT,   0)        \
  31     X(case,       0, ARG_ADDR,   0)        \
  32     X(cnd_nz,     0, ARG_ADDR,   0)        \
  33     X(cnd_z,      0, ARG_ADDR,   0)        \
  34     X(delete,     1, 0,0)                  \
  35     X(delete_ident,1,ARG_BSTR,   0)        \
  36     X(div,        1, 0,0)                  \
  37     X(double,     1, ARG_DBL,    0)        \
  38     X(end_finally,0, 0,0)                  \
  39     X(enter_catch,1, ARG_BSTR,   0)        \
  40     X(eq,         1, 0,0)                  \
  41     X(eq2,        1, 0,0)                  \
  42     X(forin,      0, ARG_ADDR,   0)        \
  43     X(func,       1, ARG_UINT,   0)        \
  44     X(gt,         1, 0,0)                  \
  45     X(gteq,       1, 0,0)                  \
  46     X(ident,      1, ARG_BSTR,   0)        \
  47     X(identid,    1, ARG_BSTR,   ARG_INT)  \
  48     X(in,         1, 0,0)                  \
  49     X(instanceof, 1, 0,0)                  \
  50     X(int,        1, ARG_INT,    0)        \
  51     X(jmp,        0, ARG_ADDR,   0)        \
  52     X(jmp_z,      0, ARG_ADDR,   0)        \
  53     X(local,      1, ARG_INT,    0)        \
  54     X(local_ref,  1, ARG_INT,    ARG_UINT) \
  55     X(lshift,     1, 0,0)                  \
  56     X(lt,         1, 0,0)                  \
  57     X(lteq,       1, 0,0)                  \
  58     X(member,     1, ARG_BSTR,   0)        \
  59     X(memberid,   1, ARG_UINT,   0)        \
  60     X(minus,      1, 0,0)                  \
  61     X(mod,        1, 0,0)                  \
  62     X(mul,        1, 0,0)                  \
  63     X(neg,        1, 0,0)                  \
  64     X(neq,        1, 0,0)                  \
  65     X(neq2,       1, 0,0)                  \
  66     X(new,        1, ARG_UINT,   0)        \
  67     X(new_obj,    1, 0,0)                  \
  68     X(null,       1, 0,0)                  \
  69     X(obj_prop,   1, ARG_STR,    ARG_UINT) \
  70     X(or,         1, 0,0)                  \
  71     X(pop,        1, ARG_UINT,   0)        \
  72     X(pop_except, 0, ARG_ADDR,   0)        \
  73     X(pop_scope,  1, 0,0)                  \
  74     X(postinc,    1, ARG_INT,    0)        \
  75     X(preinc,     1, ARG_INT,    0)        \
  76     X(push_acc,   1, 0,0)                  \
  77     X(push_except,1, ARG_ADDR,   ARG_UINT) \
  78     X(push_scope, 1, 0,0)                  \
  79     X(regexp,     1, ARG_STR,    ARG_UINT) \
  80     X(rshift,     1, 0,0)                  \
  81     X(rshift2,    1, 0,0)                  \
  82     X(str,        1, ARG_STR,    0)        \
  83     X(this,       1, 0,0)                  \
  84     X(throw,      0, 0,0)                  \
  85     X(throw_ref,  0, ARG_UINT,   0)        \
  86     X(throw_type, 0, ARG_UINT,   ARG_STR)  \
  87     X(tonum,      1, 0,0)                  \
  88     X(typeof,     1, 0,0)                  \
  89     X(typeofid,   1, 0,0)                  \
  90     X(typeofident,1, 0,0)                  \
  91     X(refval,     1, 0,0)                  \
  92     X(ret,        0, ARG_UINT,   0)        \
  93     X(set_member, 1, 0,0)                  \
  94     X(setret,     1, 0,0)                  \
  95     X(sub,        1, 0,0)                  \
  96     X(to_string,  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 struct _bytecode_t bytecode_t;
 109
 110 typedef union {
 111     BSTR bstr;
 112     LONG lng;
 113     jsstr_t *str;
 114     unsigned uint;
 115 } instr_arg_t;
 116
 117 typedef enum {
 118     ARG_NONE = 0,
 119     ARG_ADDR,
 120     ARG_BSTR,
 121     ARG_DBL,
 122     ARG_FUNC,
 123     ARG_INT,
 124     ARG_STR,
 125     ARG_UINT
 126 } instr_arg_type_t;
 127
 128 typedef struct {
 129     jsop_t op;
 130     unsigned loc;
 131     union {
 132         instr_arg_t arg[2];
 133         double dbl;
 134     } u;
 135 } instr_t;
 136
 137 typedef enum {
 138     PROPERTY_DEFINITION_VALUE,
 139     PROPERTY_DEFINITION_GETTER,
 140     PROPERTY_DEFINITION_SETTER
 141 } property_definition_type_t;
 142
 143 typedef struct {
 144     BSTR name;
 145     int ref;
 146 } local_ref_t;
 147
 148 typedef struct _function_code_t {
 149     BSTR name;
 150     int local_ref;
 151     BSTR event_target;
 152     unsigned instr_off;
 153
 154     const WCHAR *source;
 155     unsigned source_len;
 156
 157     unsigned func_cnt;
 158     struct _function_code_t *funcs;
 159
 160     unsigned var_cnt;
 161     struct {
 162         BSTR name;
 163         int func_id; /* -1 if not a function */
 164     } *variables;
 165
 166     unsigned param_cnt;
 167     BSTR *params;
 168
 169     unsigned locals_cnt;
 170     local_ref_t *locals;
 171
 172     bytecode_t *bytecode;
 173 } function_code_t;
 174
 175 IDispatch *lookup_global_host(script_ctx_t*) DECLSPEC_HIDDEN;
 176 local_ref_t *lookup_local(const function_code_t*,const WCHAR*) DECLSPEC_HIDDEN;
 177
 178 struct _bytecode_t {
 179     LONG ref;
 180     BOOL is_persistent;
 181
 182     instr_t *instrs;
 183     heap_pool_t heap;
 184
 185     function_code_t global_code;
 186     named_item_t *named_item;
 187
 188     WCHAR *source;
 189     UINT64 source_context;
 190     unsigned start_line;
 191
 192     BSTR *bstr_pool;
 193     unsigned bstr_pool_size;
 194     unsigned bstr_cnt;
 195
 196     jsstr_t **str_pool;
 197     unsigned str_pool_size;
 198     unsigned str_cnt;
 199
 200     struct list entry;
 201 };
 202
 203 HRESULT compile_script(script_ctx_t*,const WCHAR*,UINT64,unsigned,const WCHAR*,const WCHAR*,BOOL,BOOL,named_item_t*,bytecode_t**) DECLSPEC_HIDDEN;
 204 void release_bytecode(bytecode_t*) DECLSPEC_HIDDEN;
 205
 206 unsigned get_location_line(bytecode_t *code, unsigned loc, unsigned *char_pos) DECLSPEC_HIDDEN;
 207
 208 static inline bytecode_t *bytecode_addref(bytecode_t *code)
 209 {
 210     code->ref++;
 211     return code;
 212 }
 213
 214 typedef struct _scope_chain_t {
 215     LONG ref;
 216     jsdisp_t *jsobj;
 217     IDispatch *obj;
 218     struct _call_frame_t *frame;
 219     struct _scope_chain_t *next;
 220 } scope_chain_t;
 221
 222 void scope_release(scope_chain_t*) DECLSPEC_HIDDEN;
 223
 224 static inline scope_chain_t *scope_addref(scope_chain_t *scope)
 225 {
 226     scope->ref++;
 227     return scope;
 228 }
 229
 230 struct _jsexcept_t {
 231     HRESULT error;
 232
 233     BOOL valid_value;
 234     jsval_t value;
 235
 236     jsstr_t *source;
 237     jsstr_t *message;
 238     jsstr_t *line;
 239
 240     bytecode_t *code;
 241     unsigned loc;
 242
 243     BOOL enter_notified;
 244     jsexcept_t *prev;
 245 };
 246
 247 void enter_script(script_ctx_t*,jsexcept_t*) DECLSPEC_HIDDEN;
 248 HRESULT leave_script(script_ctx_t*,HRESULT) DECLSPEC_HIDDEN;
 249 void reset_ei(jsexcept_t*) DECLSPEC_HIDDEN;
 250 void set_error_location(jsexcept_t*,bytecode_t*,unsigned,unsigned,jsstr_t*) DECLSPEC_HIDDEN;
 251
 252 typedef struct _except_frame_t except_frame_t;
 253 struct _parser_ctx_t;
 254
 255 typedef struct _call_frame_t {
 256     unsigned ip;
 257     except_frame_t *except_frame;
 258     unsigned stack_base;
 259     scope_chain_t *scope;
 260     scope_chain_t *base_scope;
 261
 262     jsval_t ret;
 263
 264     IDispatch *this_obj;
 265     jsdisp_t *function_instance;
 266     jsdisp_t *variable_obj;
 267     jsdisp_t *arguments_obj;
 268     DWORD flags;
 269
 270     unsigned argc;
 271     unsigned pop_locals;
 272     unsigned arguments_off;
 273     unsigned variables_off;
 274     unsigned pop_variables;
 275
 276     bytecode_t *bytecode;
 277     function_code_t *function;
 278
 279     struct _call_frame_t *prev_frame;
 280 } call_frame_t;
 281
 282 #define EXEC_GLOBAL            0x0001
 283 #define EXEC_CONSTRUCTOR       0x0002
 284 #define EXEC_RETURN_TO_INTERP  0x0004
 285 #define EXEC_EVAL              0x0008
 286
 287 HRESULT exec_source(script_ctx_t*,DWORD,bytecode_t*,function_code_t*,scope_chain_t*,IDispatch*,
 288         jsdisp_t*,unsigned,jsval_t*,jsval_t*) DECLSPEC_HIDDEN;
 289
 290 HRESULT create_source_function(script_ctx_t*,bytecode_t*,function_code_t*,scope_chain_t*,jsdisp_t**) DECLSPEC_HIDDEN;
 291 HRESULT setup_arguments_object(script_ctx_t*,call_frame_t*) DECLSPEC_HIDDEN;
 292 void detach_arguments_object(jsdisp_t*) DECLSPEC_HIDDEN;