dlls/vbscript/vbscript.h

   1 /*
   2  * Copyright 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 #include <stdarg.h>
  20
  21 #define COBJMACROS
  22
  23 #include "windef.h"
  24 #include "winbase.h"
  25 #include "ole2.h"
  26 #include "dispex.h"
  27 #include "activscp.h"
  28
  29 #include "vbscript_classes.h"
  30
  31 #include "wine/list.h"
  32 #include "wine/unicode.h"
  33
  34 typedef struct {
  35     void **blocks;
  36     DWORD block_cnt;
  37     DWORD last_block;
  38     DWORD offset;
  39     struct list custom_blocks;
  40 } vbsheap_t;
  41
  42 void vbsheap_init(vbsheap_t*) DECLSPEC_HIDDEN;
  43 void *vbsheap_alloc(vbsheap_t*,size_t) __WINE_ALLOC_SIZE(2) DECLSPEC_HIDDEN;
  44 void vbsheap_free(vbsheap_t*) DECLSPEC_HIDDEN;
  45
  46 typedef struct _function_t function_t;
  47 typedef struct _vbscode_t vbscode_t;
  48 typedef struct _script_ctx_t script_ctx_t;
  49 typedef struct _vbdisp_t vbdisp_t;
  50
  51 typedef struct named_item_t {
  52     IDispatch *disp;
  53     DWORD flags;
  54     LPWSTR name;
  55
  56     struct list entry;
  57 } named_item_t;
  58
  59 typedef enum {
  60     VBDISP_CALLGET,
  61     VBDISP_LET,
  62     VBDISP_SET,
  63     VBDISP_ANY
  64 } vbdisp_invoke_type_t;
  65
  66 typedef struct {
  67     BOOL is_public;
  68     const WCHAR *name;
  69 } vbdisp_prop_desc_t;
  70
  71 typedef struct {
  72     const WCHAR *name;
  73     BOOL is_public;
  74     function_t *entries[VBDISP_ANY];
  75 } vbdisp_funcprop_desc_t;
  76
  77 #define BP_GET      1
  78 #define BP_GETPUT   2
  79
  80 typedef struct {
  81     DISPID id;
  82     HRESULT (*proc)(vbdisp_t*,VARIANT*,unsigned,VARIANT*);
  83     DWORD flags;
  84     unsigned min_args;
  85     unsigned max_args;
  86 } builtin_prop_t;
  87
  88 typedef struct _class_desc_t {
  89     const WCHAR *name;
  90     script_ctx_t *ctx;
  91
  92     unsigned class_initialize_id;
  93     unsigned class_terminate_id;
  94     unsigned func_cnt;
  95     vbdisp_funcprop_desc_t *funcs;
  96
  97     unsigned prop_cnt;
  98     vbdisp_prop_desc_t *props;
  99
 100     unsigned builtin_prop_cnt;
 101     const builtin_prop_t *builtin_props;
 102     ITypeInfo *typeinfo;
 103
 104     struct _class_desc_t *next;
 105 } class_desc_t;
 106
 107 struct _vbdisp_t {
 108     IDispatchEx IDispatchEx_iface;
 109
 110     LONG ref;
 111     BOOL terminator_ran;
 112     struct list entry;
 113
 114     const class_desc_t *desc;
 115     VARIANT props[1];
 116 };
 117
 118 HRESULT create_vbdisp(const class_desc_t*,vbdisp_t**) DECLSPEC_HIDDEN;
 119 HRESULT disp_get_id(IDispatch*,BSTR,vbdisp_invoke_type_t,BOOL,DISPID*) DECLSPEC_HIDDEN;
 120 HRESULT vbdisp_get_id(vbdisp_t*,BSTR,vbdisp_invoke_type_t,BOOL,DISPID*) DECLSPEC_HIDDEN;
 121 HRESULT disp_call(script_ctx_t*,IDispatch*,DISPID,DISPPARAMS*,VARIANT*) DECLSPEC_HIDDEN;
 122 HRESULT disp_propput(script_ctx_t*,IDispatch*,DISPID,VARIANT*) DECLSPEC_HIDDEN;
 123 void collect_objects(script_ctx_t*) DECLSPEC_HIDDEN;
 124
 125 static inline unsigned arg_cnt(const DISPPARAMS *dp)
 126 {
 127     return dp->cArgs - dp->cNamedArgs;
 128 }
 129
 130 static inline VARIANT *get_arg(DISPPARAMS *dp, DWORD i)
 131 {
 132     return dp->rgvarg + dp->cArgs-i-1;
 133 }
 134
 135 typedef struct _dynamic_var_t {
 136     struct _dynamic_var_t *next;
 137     VARIANT v;
 138     const WCHAR *name;
 139     BOOL is_const;
 140 } dynamic_var_t;
 141
 142 struct _script_ctx_t {
 143     IActiveScriptSite *site;
 144     LCID lcid;
 145
 146     IInternetHostSecurityManager *secmgr;
 147     DWORD safeopt;
 148
 149     IDispatch *host_global;
 150
 151     class_desc_t script_desc;
 152     vbdisp_t *script_obj;
 153
 154     class_desc_t global_desc;
 155     vbdisp_t *global_obj;
 156
 157     class_desc_t err_desc;
 158     vbdisp_t *err_obj;
 159
 160     dynamic_var_t *global_vars;
 161     function_t *global_funcs;
 162     class_desc_t *classes;
 163
 164     vbsheap_t heap;
 165
 166     struct list objects;
 167     struct list code_list;
 168     struct list named_items;
 169 };
 170
 171 HRESULT init_global(script_ctx_t*) DECLSPEC_HIDDEN;
 172 HRESULT init_err(script_ctx_t*) DECLSPEC_HIDDEN;
 173
 174 IUnknown *create_ax_site(script_ctx_t*) DECLSPEC_HIDDEN;
 175
 176 typedef enum {
 177     ARG_NONE = 0,
 178     ARG_STR,
 179     ARG_BSTR,
 180     ARG_INT,
 181     ARG_UINT,
 182     ARG_ADDR,
 183     ARG_DOUBLE
 184 } instr_arg_type_t;
 185
 186 #define OP_LIST                                   \
 187     X(add,            1, 0,           0)          \
 188     X(and,            1, 0,           0)          \
 189     X(assign_ident,   1, ARG_BSTR,    ARG_UINT)   \
 190     X(assign_member,  1, ARG_BSTR,    ARG_UINT)   \
 191     X(bool,           1, ARG_INT,     0)          \
 192     X(concat,         1, 0,           0)          \
 193     X(const,          1, ARG_BSTR,    0)          \
 194     X(div,            1, 0,           0)          \
 195     X(double,         1, ARG_DOUBLE,  0)          \
 196     X(empty,          1, 0,           0)          \
 197     X(equal,          1, 0,           0)          \
 198     X(errmode,        1, ARG_INT,     0)          \
 199     X(eqv,            1, 0,           0)          \
 200     X(exp,            1, 0,           0)          \
 201     X(gt,             1, 0,           0)          \
 202     X(gteq,           1, 0,           0)          \
 203     X(icall,          1, ARG_BSTR,    ARG_UINT)   \
 204     X(icallv,         1, ARG_BSTR,    ARG_UINT)   \
 205     X(idiv,           1, 0,           0)          \
 206     X(imp,            1, 0,           0)          \
 207     X(incc,           1, ARG_BSTR,    0)          \
 208     X(is,             1, 0,           0)          \
 209     X(jmp,            0, ARG_ADDR,    0)          \
 210     X(jmp_false,      0, ARG_ADDR,    0)          \
 211     X(jmp_true,       0, ARG_ADDR,    0)          \
 212     X(long,           1, ARG_INT,     0)          \
 213     X(lt,             1, 0,           0)          \
 214     X(lteq,           1, 0,           0)          \
 215     X(mcall,          1, ARG_BSTR,    ARG_UINT)   \
 216     X(mcallv,         1, ARG_BSTR,    ARG_UINT)   \
 217     X(me,             1, 0,           0)          \
 218     X(mod,            1, 0,           0)          \
 219     X(mul,            1, 0,           0)          \
 220     X(neg,            1, 0,           0)          \
 221     X(nequal,         1, 0,           0)          \
 222     X(new,            1, ARG_STR,     0)          \
 223     X(not,            1, 0,           0)          \
 224     X(nothing,        1, 0,           0)          \
 225     X(null,           1, 0,           0)          \
 226     X(or,             1, 0,           0)          \
 227     X(pop,            1, ARG_UINT,    0)          \
 228     X(ret,            0, 0,           0)          \
 229     X(set_ident,      1, ARG_BSTR,    ARG_UINT)   \
 230     X(set_member,     1, ARG_BSTR,    ARG_UINT)   \
 231     X(short,          1, ARG_INT,     0)          \
 232     X(step,           0, ARG_ADDR,    ARG_BSTR)   \
 233     X(stop,           1, 0,           0)          \
 234     X(string,         1, ARG_STR,     0)          \
 235     X(sub,            1, 0,           0)          \
 236     X(val,            1, 0,           0)          \
 237     X(xor,            1, 0,           0)
 238
 239 typedef enum {
 240 #define X(x,n,a,b) OP_##x,
 241 OP_LIST
 242 #undef X
 243     OP_LAST
 244 } vbsop_t;
 245
 246 typedef union {
 247     const WCHAR *str;
 248     BSTR bstr;
 249     unsigned uint;
 250     LONG lng;
 251     double *dbl;
 252 } instr_arg_t;
 253
 254 typedef struct {
 255     vbsop_t op;
 256     instr_arg_t arg1;
 257     instr_arg_t arg2;
 258 } instr_t;
 259
 260 typedef struct {
 261     const WCHAR *name;
 262     BOOL by_ref;
 263 } arg_desc_t;
 264
 265 typedef enum {
 266     FUNC_GLOBAL,
 267     FUNC_FUNCTION,
 268     FUNC_SUB,
 269     FUNC_PROPGET,
 270     FUNC_PROPLET,
 271     FUNC_PROPSET,
 272     FUNC_DEFGET
 273 } function_type_t;
 274
 275 typedef struct {
 276     const WCHAR *name;
 277 } var_desc_t;
 278
 279 struct _function_t {
 280     function_type_t type;
 281     const WCHAR *name;
 282     BOOL is_public;
 283     arg_desc_t *args;
 284     unsigned arg_cnt;
 285     var_desc_t *vars;
 286     unsigned var_cnt;
 287     unsigned code_off;
 288     vbscode_t *code_ctx;
 289     function_t *next;
 290 };
 291
 292 struct _vbscode_t {
 293     instr_t *instrs;
 294     WCHAR *source;
 295
 296     BOOL option_explicit;
 297
 298     BOOL global_executed;
 299     function_t global_code;
 300
 301     BSTR *bstr_pool;
 302     unsigned bstr_pool_size;
 303     unsigned bstr_cnt;
 304     vbsheap_t heap;
 305
 306     struct list entry;
 307 };
 308
 309 void release_vbscode(vbscode_t*) DECLSPEC_HIDDEN;
 310 HRESULT compile_script(script_ctx_t*,const WCHAR*,vbscode_t**) DECLSPEC_HIDDEN;
 311 HRESULT exec_script(script_ctx_t*,function_t*,IDispatch*,DISPPARAMS*,VARIANT*) DECLSPEC_HIDDEN;
 312 void release_dynamic_vars(dynamic_var_t*) DECLSPEC_HIDDEN;
 313
 314 #define TID_LIST \
 315     XDIID(ErrObj) \
 316     XDIID(GlobalObj)
 317
 318 typedef enum {
 319 #define XDIID(iface) iface ## _tid,
 320 TID_LIST
 321 #undef XDIID
 322     LAST_tid
 323 } tid_t;
 324
 325 HRESULT get_typeinfo(tid_t,ITypeInfo**) DECLSPEC_HIDDEN;
 326
 327 HRESULT WINAPI VBScriptFactory_CreateInstance(IClassFactory*,IUnknown*,REFIID,void**) DECLSPEC_HIDDEN;
 328
 329 const char *debugstr_variant(const VARIANT*) DECLSPEC_HIDDEN;
 330
 331 static inline void *heap_alloc(size_t len)
 332 {
 333     return HeapAlloc(GetProcessHeap(), 0, len);
 334 }
 335
 336 static inline void *heap_alloc_zero(size_t len)
 337 {
 338     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
 339 }
 340
 341 static inline void *heap_realloc(void *mem, size_t len)
 342 {
 343     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
 344 }
 345
 346 static inline BOOL heap_free(void *mem)
 347 {
 348     return HeapFree(GetProcessHeap(), 0, mem);
 349 }
 350
 351 static inline LPWSTR heap_strdupW(LPCWSTR str)
 352 {
 353     LPWSTR ret = NULL;
 354
 355     if(str) {
 356         DWORD size;
 357
 358         size = (strlenW(str)+1)*sizeof(WCHAR);
 359         ret = heap_alloc(size);
 360         if(ret)
 361             memcpy(ret, str, size);
 362     }
 363
 364     return ret;
 365 }