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     BOOL mark;
  40     struct list custom_blocks;
  41 } heap_pool_t;
  42
  43 void heap_pool_init(heap_pool_t*) DECLSPEC_HIDDEN;
  44 void *heap_pool_alloc(heap_pool_t*,size_t) __WINE_ALLOC_SIZE(2) DECLSPEC_HIDDEN;
  45 void *heap_pool_grow(heap_pool_t*,void*,DWORD,DWORD) DECLSPEC_HIDDEN;
  46 void heap_pool_clear(heap_pool_t*) DECLSPEC_HIDDEN;
  47 void heap_pool_free(heap_pool_t*) DECLSPEC_HIDDEN;
  48 heap_pool_t *heap_pool_mark(heap_pool_t*) DECLSPEC_HIDDEN;
  49
  50 typedef struct _function_t function_t;
  51 typedef struct _vbscode_t vbscode_t;
  52 typedef struct _script_ctx_t script_ctx_t;
  53 typedef struct _vbdisp_t vbdisp_t;
  54
  55 typedef struct named_item_t {
  56     IDispatch *disp;
  57     DWORD flags;
  58     LPWSTR name;
  59
  60     struct list entry;
  61 } named_item_t;
  62
  63 typedef enum {
  64     VBDISP_CALLGET,
  65     VBDISP_LET,
  66     VBDISP_SET,
  67     VBDISP_ANY
  68 } vbdisp_invoke_type_t;
  69
  70 typedef struct {
  71     unsigned dim_cnt;
  72     SAFEARRAYBOUND *bounds;
  73 } array_desc_t;
  74
  75 typedef struct {
  76     BOOL is_public;
  77     BOOL is_array;
  78     const WCHAR *name;
  79 } vbdisp_prop_desc_t;
  80
  81 typedef struct {
  82     const WCHAR *name;
  83     BOOL is_public;
  84     BOOL is_array;
  85     function_t *entries[VBDISP_ANY];
  86 } vbdisp_funcprop_desc_t;
  87
  88 #define BP_GET      1
  89 #define BP_GETPUT   2
  90
  91 typedef struct {
  92     DISPID id;
  93     HRESULT (*proc)(vbdisp_t*,VARIANT*,unsigned,VARIANT*);
  94     DWORD flags;
  95     unsigned min_args;
  96     UINT_PTR max_args;
  97 } builtin_prop_t;
  98
  99 typedef struct _class_desc_t {
 100     const WCHAR *name;
 101     script_ctx_t *ctx;
 102
 103     unsigned class_initialize_id;
 104     unsigned class_terminate_id;
 105     unsigned func_cnt;
 106     vbdisp_funcprop_desc_t *funcs;
 107
 108     unsigned prop_cnt;
 109     vbdisp_prop_desc_t *props;
 110
 111     unsigned array_cnt;
 112     array_desc_t *array_descs;
 113
 114     unsigned builtin_prop_cnt;
 115     const builtin_prop_t *builtin_props;
 116     ITypeInfo *typeinfo;
 117     function_t *value_func;
 118
 119     struct _class_desc_t *next;
 120 } class_desc_t;
 121
 122 struct _vbdisp_t {
 123     IDispatchEx IDispatchEx_iface;
 124
 125     LONG ref;
 126     BOOL terminator_ran;
 127     struct list entry;
 128
 129     const class_desc_t *desc;
 130     SAFEARRAY **arrays;
 131     VARIANT props[1];
 132 };
 133
 134 typedef struct _ident_map_t ident_map_t;
 135
 136 typedef struct {
 137     IDispatchEx IDispatchEx_iface;
 138     LONG ref;
 139
 140     ident_map_t *ident_map;
 141     unsigned ident_map_cnt;
 142     unsigned ident_map_size;
 143
 144     script_ctx_t *ctx;
 145 } ScriptDisp;
 146
 147 HRESULT create_vbdisp(const class_desc_t*,vbdisp_t**) DECLSPEC_HIDDEN;
 148 HRESULT disp_get_id(IDispatch*,BSTR,vbdisp_invoke_type_t,BOOL,DISPID*) DECLSPEC_HIDDEN;
 149 HRESULT vbdisp_get_id(vbdisp_t*,BSTR,vbdisp_invoke_type_t,BOOL,DISPID*) DECLSPEC_HIDDEN;
 150 HRESULT disp_call(script_ctx_t*,IDispatch*,DISPID,DISPPARAMS*,VARIANT*) DECLSPEC_HIDDEN;
 151 HRESULT disp_propput(script_ctx_t*,IDispatch*,DISPID,DISPPARAMS*) DECLSPEC_HIDDEN;
 152 void collect_objects(script_ctx_t*) DECLSPEC_HIDDEN;
 153 HRESULT create_procedure_disp(script_ctx_t*,vbscode_t*,IDispatch**) DECLSPEC_HIDDEN;
 154 HRESULT create_script_disp(script_ctx_t*,ScriptDisp**) DECLSPEC_HIDDEN;
 155
 156 HRESULT to_int(VARIANT*,int*) DECLSPEC_HIDDEN;
 157
 158 static inline unsigned arg_cnt(const DISPPARAMS *dp)
 159 {
 160     return dp->cArgs - dp->cNamedArgs;
 161 }
 162
 163 static inline VARIANT *get_arg(DISPPARAMS *dp, DWORD i)
 164 {
 165     return dp->rgvarg + dp->cArgs-i-1;
 166 }
 167
 168 typedef struct _dynamic_var_t {
 169     struct _dynamic_var_t *next;
 170     VARIANT v;
 171     const WCHAR *name;
 172     BOOL is_const;
 173 } dynamic_var_t;
 174
 175 struct _script_ctx_t {
 176     IActiveScriptSite *site;
 177     LCID lcid;
 178
 179     IInternetHostSecurityManager *secmgr;
 180     DWORD safeopt;
 181
 182     IDispatch *host_global;
 183
 184     ScriptDisp *script_obj;
 185
 186     class_desc_t global_desc;
 187     vbdisp_t *global_obj;
 188
 189     class_desc_t err_desc;
 190     vbdisp_t *err_obj;
 191
 192     HRESULT err_number;
 193
 194     dynamic_var_t *global_vars;
 195     function_t *global_funcs;
 196     class_desc_t *classes;
 197     class_desc_t *procs;
 198
 199     heap_pool_t heap;
 200
 201     struct list objects;
 202     struct list code_list;
 203     struct list named_items;
 204 };
 205
 206 HRESULT init_global(script_ctx_t*) DECLSPEC_HIDDEN;
 207 HRESULT init_err(script_ctx_t*) DECLSPEC_HIDDEN;
 208
 209 IUnknown *create_ax_site(script_ctx_t*) DECLSPEC_HIDDEN;
 210
 211 typedef enum {
 212     ARG_NONE = 0,
 213     ARG_STR,
 214     ARG_BSTR,
 215     ARG_INT,
 216     ARG_UINT,
 217     ARG_ADDR,
 218     ARG_DOUBLE
 219 } instr_arg_type_t;
 220
 221 #define OP_LIST                                   \
 222     X(add,            1, 0,           0)          \
 223     X(and,            1, 0,           0)          \
 224     X(assign_ident,   1, ARG_BSTR,    ARG_UINT)   \
 225     X(assign_member,  1, ARG_BSTR,    ARG_UINT)   \
 226     X(bool,           1, ARG_INT,     0)          \
 227     X(catch,          1, ARG_ADDR,    ARG_UINT)    \
 228     X(case,           0, ARG_ADDR,    0)          \
 229     X(concat,         1, 0,           0)          \
 230     X(const,          1, ARG_BSTR,    0)          \
 231     X(dim,            1, ARG_BSTR,    ARG_UINT)   \
 232     X(div,            1, 0,           0)          \
 233     X(double,         1, ARG_DOUBLE,  0)          \
 234     X(empty,          1, 0,           0)          \
 235     X(enumnext,       0, ARG_ADDR,    ARG_BSTR)   \
 236     X(equal,          1, 0,           0)          \
 237     X(errmode,        1, ARG_INT,     0)          \
 238     X(eqv,            1, 0,           0)          \
 239     X(exp,            1, 0,           0)          \
 240     X(gt,             1, 0,           0)          \
 241     X(gteq,           1, 0,           0)          \
 242     X(icall,          1, ARG_BSTR,    ARG_UINT)   \
 243     X(icallv,         1, ARG_BSTR,    ARG_UINT)   \
 244     X(idiv,           1, 0,           0)          \
 245     X(imp,            1, 0,           0)          \
 246     X(incc,           1, ARG_BSTR,    0)          \
 247     X(is,             1, 0,           0)          \
 248     X(jmp,            0, ARG_ADDR,    0)          \
 249     X(jmp_false,      0, ARG_ADDR,    0)          \
 250     X(jmp_true,       0, ARG_ADDR,    0)          \
 251     X(long,           1, ARG_INT,     0)          \
 252     X(lt,             1, 0,           0)          \
 253     X(lteq,           1, 0,           0)          \
 254     X(mcall,          1, ARG_BSTR,    ARG_UINT)   \
 255     X(mcallv,         1, ARG_BSTR,    ARG_UINT)   \
 256     X(me,             1, 0,           0)          \
 257     X(mod,            1, 0,           0)          \
 258     X(mul,            1, 0,           0)          \
 259     X(neg,            1, 0,           0)          \
 260     X(nequal,         1, 0,           0)          \
 261     X(new,            1, ARG_STR,     0)          \
 262     X(newenum,        1, 0,           0)          \
 263     X(not,            1, 0,           0)          \
 264     X(nothing,        1, 0,           0)          \
 265     X(null,           1, 0,           0)          \
 266     X(or,             1, 0,           0)          \
 267     X(pop,            1, ARG_UINT,    0)          \
 268     X(ret,            0, 0,           0)          \
 269     X(set_ident,      1, ARG_BSTR,    ARG_UINT)   \
 270     X(set_member,     1, ARG_BSTR,    ARG_UINT)   \
 271     X(short,          1, ARG_INT,     0)          \
 272     X(step,           0, ARG_ADDR,    ARG_BSTR)   \
 273     X(stop,           1, 0,           0)          \
 274     X(string,         1, ARG_STR,     0)          \
 275     X(sub,            1, 0,           0)          \
 276     X(val,            1, 0,           0)          \
 277     X(xor,            1, 0,           0)
 278
 279 typedef enum {
 280 #define X(x,n,a,b) OP_##x,
 281 OP_LIST
 282 #undef X
 283     OP_LAST
 284 } vbsop_t;
 285
 286 typedef union {
 287     const WCHAR *str;
 288     BSTR bstr;
 289     unsigned uint;
 290     LONG lng;
 291     double *dbl;
 292 } instr_arg_t;
 293
 294 typedef struct {
 295     vbsop_t op;
 296     instr_arg_t arg1;
 297     instr_arg_t arg2;
 298 } instr_t;
 299
 300 typedef struct {
 301     const WCHAR *name;
 302     BOOL by_ref;
 303 } arg_desc_t;
 304
 305 typedef enum {
 306     FUNC_GLOBAL,
 307     FUNC_FUNCTION,
 308     FUNC_SUB,
 309     FUNC_PROPGET,
 310     FUNC_PROPLET,
 311     FUNC_PROPSET,
 312     FUNC_DEFGET
 313 } function_type_t;
 314
 315 typedef struct {
 316     const WCHAR *name;
 317 } var_desc_t;
 318
 319 struct _function_t {
 320     function_type_t type;
 321     const WCHAR *name;
 322     BOOL is_public;
 323     arg_desc_t *args;
 324     unsigned arg_cnt;
 325     var_desc_t *vars;
 326     unsigned var_cnt;
 327     array_desc_t *array_descs;
 328     unsigned array_cnt;
 329     unsigned code_off;
 330     vbscode_t *code_ctx;
 331     function_t *next;
 332 };
 333
 334 struct _vbscode_t {
 335     instr_t *instrs;
 336     WCHAR *source;
 337
 338     BOOL option_explicit;
 339
 340     BOOL pending_exec;
 341     function_t main_code;
 342
 343     BSTR *bstr_pool;
 344     unsigned bstr_pool_size;
 345     unsigned bstr_cnt;
 346     heap_pool_t heap;
 347
 348     struct list entry;
 349 };
 350
 351 void release_vbscode(vbscode_t*) DECLSPEC_HIDDEN;
 352 HRESULT compile_script(script_ctx_t*,const WCHAR*,const WCHAR*,vbscode_t**) DECLSPEC_HIDDEN;
 353 HRESULT exec_script(script_ctx_t*,function_t*,vbdisp_t*,DISPPARAMS*,VARIANT*) DECLSPEC_HIDDEN;
 354 void release_dynamic_vars(dynamic_var_t*) DECLSPEC_HIDDEN;
 355
 356 typedef struct {
 357     UINT16 len;
 358     WCHAR buf[7];
 359 } string_constant_t;
 360
 361 #define TID_LIST \
 362     XDIID(ErrObj) \
 363     XDIID(GlobalObj)
 364
 365 typedef enum {
 366 #define XDIID(iface) iface ## _tid,
 367 TID_LIST
 368 #undef XDIID
 369     LAST_tid
 370 } tid_t;
 371
 372 HRESULT get_typeinfo(tid_t,ITypeInfo**) DECLSPEC_HIDDEN;
 373 void release_regexp_typelib(void) DECLSPEC_HIDDEN;
 374
 375 #ifndef INT32_MIN
 376 #define INT32_MIN (-2147483647-1)
 377 #endif
 378
 379 #ifndef INT32_MAX
 380 #define INT32_MAX (2147483647)
 381 #endif
 382
 383 static inline BOOL is_int32(double d)
 384 {
 385     return INT32_MIN <= d && d <= INT32_MAX && (double)(int)d == d;
 386 }
 387
 388 HRESULT create_regexp(IDispatch**) DECLSPEC_HIDDEN;
 389
 390 HRESULT map_hres(HRESULT) DECLSPEC_HIDDEN;
 391
 392 #define FACILITY_VBS 0xa
 393 #define MAKE_VBSERROR(code) MAKE_HRESULT(SEVERITY_ERROR, FACILITY_VBS, code)
 394
 395 #define VBSE_ILLEGAL_FUNC_CALL              5
 396 #define VBSE_OVERFLOW                       6
 397 #define VBSE_OUT_OF_MEMORY                  7
 398 #define VBSE_OUT_OF_BOUNDS                  9
 399 #define VBSE_ARRAY_LOCKED                  10
 400 #define VBSE_TYPE_MISMATCH                 13
 401 #define VBSE_FILE_NOT_FOUND                53
 402 #define VBSE_IO_ERROR                      57
 403 #define VBSE_FILE_ALREADY_EXISTS           58
 404 #define VBSE_DISK_FULL                     61
 405 #define VBSE_TOO_MANY_FILES                67
 406 #define VBSE_PERMISSION_DENIED             70
 407 #define VBSE_PATH_FILE_ACCESS              75
 408 #define VBSE_PATH_NOT_FOUND                76
 409 #define VBSE_ILLEGAL_NULL_USE              94
 410 #define VBSE_OLE_NOT_SUPPORTED            430
 411 #define VBSE_OLE_NO_PROP_OR_METHOD        438
 412 #define VBSE_ACTION_NOT_SUPPORTED         445
 413 #define VBSE_NAMED_ARGS_NOT_SUPPORTED     446
 414 #define VBSE_LOCALE_SETTING_NOT_SUPPORTED 447
 415 #define VBSE_NAMED_PARAM_NOT_FOUND        448
 416 #define VBSE_INVALID_TYPELIB_VARIABLE     458
 417 #define VBSE_FUNC_ARITY_MISMATCH          450
 418 #define VBSE_PARAMETER_NOT_OPTIONAL       449
 419 #define VBSE_NOT_ENUM                     451
 420 #define VBSE_INVALID_DLL_FUNCTION_NAME    453
 421 #define VBSE_CANT_CREATE_TMP_FILE         322
 422 #define VBSE_OLE_FILE_NOT_FOUND           432
 423 #define VBSE_CANT_CREATE_OBJECT           429
 424 #define VBSE_SERVER_NOT_FOUND             462
 425
 426 HRESULT WINAPI VBScriptFactory_CreateInstance(IClassFactory*,IUnknown*,REFIID,void**) DECLSPEC_HIDDEN;
 427 HRESULT WINAPI VBScriptRegExpFactory_CreateInstance(IClassFactory*,IUnknown*,REFIID,void**) DECLSPEC_HIDDEN;
 428
 429 const char *debugstr_variant(const VARIANT*) DECLSPEC_HIDDEN;
 430
 431 static inline void *heap_alloc(size_t len)
 432 {
 433     return HeapAlloc(GetProcessHeap(), 0, len);
 434 }
 435
 436 static inline void *heap_alloc_zero(size_t len)
 437 {
 438     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
 439 }
 440
 441 static inline void *heap_realloc(void *mem, size_t len)
 442 {
 443     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
 444 }
 445
 446 static inline BOOL heap_free(void *mem)
 447 {
 448     return HeapFree(GetProcessHeap(), 0, mem);
 449 }
 450
 451 static inline LPWSTR heap_strdupW(LPCWSTR str)
 452 {
 453     LPWSTR ret = NULL;
 454
 455     if(str) {
 456         DWORD size;
 457
 458         size = (strlenW(str)+1)*sizeof(WCHAR);
 459         ret = heap_alloc(size);
 460         if(ret)
 461             memcpy(ret, str, size);
 462     }
 463
 464     return ret;
 465 }