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(case,       0, ARG_ADDR,   0)        \
  31     X(cnd_nz,     0, ARG_ADDR,   0)        \
  32     X(cnd_z,      0, ARG_ADDR,   0)        \
  33     X(delete,     1, 0,0)                  \
  34     X(delete_ident,1,ARG_BSTR,   0)        \
  35     X(div,        1, 0,0)                  \
  36     X(double,     1, ARG_DBL,    0)        \
  37     X(end_finally,0, 0,0)                  \
  38     X(enter_catch,1, ARG_BSTR,   0)        \
  39     X(eq,         1, 0,0)                  \
  40     X(eq2,        1, 0,0)                  \
  41     X(forin,      0, ARG_ADDR,   0)        \
  42     X(func,       1, ARG_UINT,   0)        \
  43     X(gt,         1, 0,0)                  \
  44     X(gteq,       1, 0,0)                  \
  45     X(ident,      1, ARG_BSTR,   0)        \
  46     X(identid,    1, ARG_BSTR,   ARG_INT)  \
  47     X(in,         1, 0,0)                  \
  48     X(instanceof, 1, 0,0)                  \
  49     X(int,        1, ARG_INT,    0)        \
  50     X(jmp,        0, ARG_ADDR,   0)        \
  51     X(jmp_z,      0, ARG_ADDR,   0)        \
  52     X(local,      1, ARG_INT,    0)        \
  53     X(local_ref,  1, ARG_INT,    ARG_UINT) \
  54     X(lshift,     1, 0,0)                  \
  55     X(lt,         1, 0,0)                  \
  56     X(lteq,       1, 0,0)                  \
  57     X(member,     1, ARG_BSTR,   0)        \
  58     X(memberid,   1, ARG_UINT,   0)        \
  59     X(minus,      1, 0,0)                  \
  60     X(mod,        1, 0,0)                  \
  61     X(mul,        1, 0,0)                  \
  62     X(neg,        1, 0,0)                  \
  63     X(neq,        1, 0,0)                  \
  64     X(neq2,       1, 0,0)                  \
  65     X(new,        1, ARG_UINT,   0)        \
  66     X(new_obj,    1, 0,0)                  \
  67     X(null,       1, 0,0)                  \
  68     X(obj_prop,   1, ARG_BSTR,   0)        \
  69     X(or,         1, 0,0)                  \
  70     X(pop,        1, ARG_UINT,   0)        \
  71     X(pop_except, 0, ARG_ADDR,   0)        \
  72     X(pop_scope,  1, 0,0)                  \
  73     X(postinc,    1, ARG_INT,    0)        \
  74     X(preinc,     1, ARG_INT,    0)        \
  75     X(push_except,1, ARG_ADDR,   ARG_UINT) \
  76     X(push_ret,   1, 0,0)                  \
  77     X(push_scope, 1, 0,0)                  \
  78     X(regexp,     1, ARG_STR,    ARG_UINT) \
  79     X(rshift,     1, 0,0)                  \
  80     X(rshift2,    1, 0,0)                  \
  81     X(str,        1, ARG_STR,    0)        \
  82     X(this,       1, 0,0)                  \
  83     X(throw,      0, 0,0)                  \
  84     X(throw_ref,  0, ARG_UINT,   0)        \
  85     X(throw_type, 0, ARG_UINT,   ARG_STR)  \
  86     X(tonum,      1, 0,0)                  \
  87     X(typeof,     1, 0,0)                  \
  88     X(typeofid,   1, 0,0)                  \
  89     X(typeofident,1, 0,0)                  \
  90     X(refval,     1, 0,0)                  \
  91     X(ret,        0, ARG_UINT,   0)        \
  92     X(setret,     1, 0,0)                  \
  93     X(sub,        1, 0,0)                  \
  94     X(undefined,  1, 0,0)                  \
  95     X(void,       1, 0,0)                  \
  96     X(xor,        1, 0,0)
  97
  98 typedef enum {
  99 #define X(x,a,b,c) OP_##x,
 100 OP_LIST
 101 #undef X
 102     OP_LAST
 103 } jsop_t;
 104
 105 typedef union {
 106     BSTR bstr;
 107     LONG lng;
 108     jsstr_t *str;
 109     unsigned uint;
 110 } instr_arg_t;
 111
 112 typedef enum {
 113     ARG_NONE = 0,
 114     ARG_ADDR,
 115     ARG_BSTR,
 116     ARG_DBL,
 117     ARG_FUNC,
 118     ARG_INT,
 119     ARG_STR,
 120     ARG_UINT
 121 } instr_arg_type_t;
 122
 123 typedef struct {
 124     jsop_t op;
 125     union {
 126         instr_arg_t arg[2];
 127         double dbl;
 128     } u;
 129 } instr_t;
 130
 131 typedef struct {
 132     BSTR name;
 133     int ref;
 134 } local_ref_t;
 135
 136 typedef struct _function_code_t {
 137     BSTR name;
 138     int local_ref;
 139     BSTR event_target;
 140     unsigned instr_off;
 141
 142     const WCHAR *source;
 143     unsigned source_len;
 144
 145     unsigned func_cnt;
 146     struct _function_code_t *funcs;
 147
 148     unsigned var_cnt;
 149     struct {
 150         BSTR name;
 151         int func_id; /* -1 if not a function */
 152     } *variables;
 153
 154     unsigned param_cnt;
 155     BSTR *params;
 156
 157     unsigned locals_cnt;
 158     local_ref_t *locals;
 159 } function_code_t;
 160
 161 local_ref_t *lookup_local(const function_code_t*,const WCHAR*) DECLSPEC_HIDDEN;
 162
 163 typedef struct _bytecode_t {
 164     LONG ref;
 165
 166     instr_t *instrs;
 167     heap_pool_t heap;
 168
 169     function_code_t global_code;
 170
 171     WCHAR *source;
 172
 173     BSTR *bstr_pool;
 174     unsigned bstr_pool_size;
 175     unsigned bstr_cnt;
 176
 177     jsstr_t **str_pool;
 178     unsigned str_pool_size;
 179     unsigned str_cnt;
 180
 181     struct _bytecode_t *next;
 182 } bytecode_t;
 183
 184 HRESULT compile_script(script_ctx_t*,const WCHAR*,const WCHAR*,const WCHAR*,BOOL,BOOL,bytecode_t**) DECLSPEC_HIDDEN;
 185 void release_bytecode(bytecode_t*) DECLSPEC_HIDDEN;
 186
 187 static inline bytecode_t *bytecode_addref(bytecode_t *code)
 188 {
 189     code->ref++;
 190     return code;
 191 }
 192
 193 typedef struct _scope_chain_t {
 194     LONG ref;
 195     jsdisp_t *jsobj;
 196     IDispatch *obj;
 197     struct _call_frame_t *frame;
 198     struct _scope_chain_t *next;
 199 } scope_chain_t;
 200
 201 void scope_release(scope_chain_t*) DECLSPEC_HIDDEN;
 202
 203 static inline scope_chain_t *scope_addref(scope_chain_t *scope)
 204 {
 205     scope->ref++;
 206     return scope;
 207 }
 208
 209 typedef struct _except_frame_t except_frame_t;
 210 struct _parser_ctx_t;
 211
 212 typedef struct _call_frame_t {
 213     unsigned ip;
 214     except_frame_t *except_frame;
 215     unsigned stack_base;
 216     scope_chain_t *scope;
 217     scope_chain_t *base_scope;
 218
 219     jsval_t ret;
 220
 221     IDispatch *this_obj;
 222     jsdisp_t *function_instance;
 223     jsdisp_t *variable_obj;
 224     jsdisp_t *arguments_obj;
 225     DWORD flags;
 226
 227     unsigned argc;
 228     unsigned pop_locals;
 229     unsigned arguments_off;
 230     unsigned variables_off;
 231     unsigned pop_variables;
 232
 233     bytecode_t *bytecode;
 234     function_code_t *function;
 235
 236     struct _call_frame_t *prev_frame;
 237 } call_frame_t;
 238
 239 #define EXEC_GLOBAL            0x0001
 240 #define EXEC_CONSTRUCTOR       0x0002
 241 #define EXEC_RETURN_TO_INTERP  0x0004
 242 #define EXEC_EVAL              0x0008
 243
 244 HRESULT exec_source(script_ctx_t*,DWORD,bytecode_t*,function_code_t*,scope_chain_t*,IDispatch*,
 245         jsdisp_t*,jsdisp_t*,unsigned,jsval_t*,jsval_t*) DECLSPEC_HIDDEN;
 246
 247 HRESULT create_source_function(script_ctx_t*,bytecode_t*,function_code_t*,scope_chain_t*,jsdisp_t**) DECLSPEC_HIDDEN;
 248 HRESULT setup_arguments_object(script_ctx_t*,call_frame_t*) DECLSPEC_HIDDEN;
 249 void detach_arguments_object(jsdisp_t*) DECLSPEC_HIDDEN;