vbscript: Use separated IDispatchEx implementation for script dispatch.
[wine] / 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     function_t *value_func;
104
105     struct _class_desc_t *next;
106 } class_desc_t;
107
108 struct _vbdisp_t {
109     IDispatchEx IDispatchEx_iface;
110
111     LONG ref;
112     BOOL terminator_ran;
113     struct list entry;
114
115     const class_desc_t *desc;
116     VARIANT props[1];
117 };
118
119 typedef struct {
120     IDispatchEx IDispatchEx_iface;
121     LONG ref;
122     script_ctx_t *ctx;
123 } ScriptDisp;
124
125 HRESULT create_vbdisp(const class_desc_t*,vbdisp_t**) DECLSPEC_HIDDEN;
126 HRESULT disp_get_id(IDispatch*,BSTR,vbdisp_invoke_type_t,BOOL,DISPID*) DECLSPEC_HIDDEN;
127 HRESULT vbdisp_get_id(vbdisp_t*,BSTR,vbdisp_invoke_type_t,BOOL,DISPID*) DECLSPEC_HIDDEN;
128 HRESULT disp_call(script_ctx_t*,IDispatch*,DISPID,DISPPARAMS*,VARIANT*) DECLSPEC_HIDDEN;
129 HRESULT disp_propput(script_ctx_t*,IDispatch*,DISPID,DISPPARAMS*) DECLSPEC_HIDDEN;
130 void collect_objects(script_ctx_t*) DECLSPEC_HIDDEN;
131 HRESULT create_procedure_disp(script_ctx_t*,vbscode_t*,IDispatch**) DECLSPEC_HIDDEN;
132 HRESULT create_script_disp(script_ctx_t*,ScriptDisp**) DECLSPEC_HIDDEN;
133
134 static inline unsigned arg_cnt(const DISPPARAMS *dp)
135 {
136     return dp->cArgs - dp->cNamedArgs;
137 }
138
139 static inline VARIANT *get_arg(DISPPARAMS *dp, DWORD i)
140 {
141     return dp->rgvarg + dp->cArgs-i-1;
142 }
143
144 typedef struct _dynamic_var_t {
145     struct _dynamic_var_t *next;
146     VARIANT v;
147     const WCHAR *name;
148     BOOL is_const;
149 } dynamic_var_t;
150
151 struct _script_ctx_t {
152     IActiveScriptSite *site;
153     LCID lcid;
154
155     IInternetHostSecurityManager *secmgr;
156     DWORD safeopt;
157
158     IDispatch *host_global;
159
160     ScriptDisp *script_obj;
161
162     class_desc_t global_desc;
163     vbdisp_t *global_obj;
164
165     class_desc_t err_desc;
166     vbdisp_t *err_obj;
167
168     dynamic_var_t *global_vars;
169     function_t *global_funcs;
170     class_desc_t *classes;
171     class_desc_t *procs;
172
173     vbsheap_t heap;
174
175     struct list objects;
176     struct list code_list;
177     struct list named_items;
178 };
179
180 HRESULT init_global(script_ctx_t*) DECLSPEC_HIDDEN;
181 HRESULT init_err(script_ctx_t*) DECLSPEC_HIDDEN;
182
183 IUnknown *create_ax_site(script_ctx_t*) DECLSPEC_HIDDEN;
184
185 typedef enum {
186     ARG_NONE = 0,
187     ARG_STR,
188     ARG_BSTR,
189     ARG_INT,
190     ARG_UINT,
191     ARG_ADDR,
192     ARG_DOUBLE
193 } instr_arg_type_t;
194
195 #define OP_LIST                                   \
196     X(add,            1, 0,           0)          \
197     X(and,            1, 0,           0)          \
198     X(assign_ident,   1, ARG_BSTR,    ARG_UINT)   \
199     X(assign_member,  1, ARG_BSTR,    ARG_UINT)   \
200     X(bool,           1, ARG_INT,     0)          \
201     X(case,           0, ARG_ADDR,    0)          \
202     X(concat,         1, 0,           0)          \
203     X(const,          1, ARG_BSTR,    0)          \
204     X(div,            1, 0,           0)          \
205     X(double,         1, ARG_DOUBLE,  0)          \
206     X(empty,          1, 0,           0)          \
207     X(enumnext,       0, ARG_ADDR,    ARG_BSTR)   \
208     X(equal,          1, 0,           0)          \
209     X(errmode,        1, ARG_INT,     0)          \
210     X(eqv,            1, 0,           0)          \
211     X(exp,            1, 0,           0)          \
212     X(gt,             1, 0,           0)          \
213     X(gteq,           1, 0,           0)          \
214     X(icall,          1, ARG_BSTR,    ARG_UINT)   \
215     X(icallv,         1, ARG_BSTR,    ARG_UINT)   \
216     X(idiv,           1, 0,           0)          \
217     X(imp,            1, 0,           0)          \
218     X(incc,           1, ARG_BSTR,    0)          \
219     X(is,             1, 0,           0)          \
220     X(jmp,            0, ARG_ADDR,    0)          \
221     X(jmp_false,      0, ARG_ADDR,    0)          \
222     X(jmp_true,       0, ARG_ADDR,    0)          \
223     X(long,           1, ARG_INT,     0)          \
224     X(lt,             1, 0,           0)          \
225     X(lteq,           1, 0,           0)          \
226     X(mcall,          1, ARG_BSTR,    ARG_UINT)   \
227     X(mcallv,         1, ARG_BSTR,    ARG_UINT)   \
228     X(me,             1, 0,           0)          \
229     X(mod,            1, 0,           0)          \
230     X(mul,            1, 0,           0)          \
231     X(neg,            1, 0,           0)          \
232     X(nequal,         1, 0,           0)          \
233     X(new,            1, ARG_STR,     0)          \
234     X(newenum,        1, 0,           0)          \
235     X(not,            1, 0,           0)          \
236     X(nothing,        1, 0,           0)          \
237     X(null,           1, 0,           0)          \
238     X(or,             1, 0,           0)          \
239     X(pop,            1, ARG_UINT,    0)          \
240     X(ret,            0, 0,           0)          \
241     X(set_ident,      1, ARG_BSTR,    ARG_UINT)   \
242     X(set_member,     1, ARG_BSTR,    ARG_UINT)   \
243     X(short,          1, ARG_INT,     0)          \
244     X(step,           0, ARG_ADDR,    ARG_BSTR)   \
245     X(stop,           1, 0,           0)          \
246     X(string,         1, ARG_STR,     0)          \
247     X(sub,            1, 0,           0)          \
248     X(val,            1, 0,           0)          \
249     X(xor,            1, 0,           0)
250
251 typedef enum {
252 #define X(x,n,a,b) OP_##x,
253 OP_LIST
254 #undef X
255     OP_LAST
256 } vbsop_t;
257
258 typedef union {
259     const WCHAR *str;
260     BSTR bstr;
261     unsigned uint;
262     LONG lng;
263     double *dbl;
264 } instr_arg_t;
265
266 typedef struct {
267     vbsop_t op;
268     instr_arg_t arg1;
269     instr_arg_t arg2;
270 } instr_t;
271
272 typedef struct {
273     const WCHAR *name;
274     BOOL by_ref;
275 } arg_desc_t;
276
277 typedef enum {
278     FUNC_GLOBAL,
279     FUNC_FUNCTION,
280     FUNC_SUB,
281     FUNC_PROPGET,
282     FUNC_PROPLET,
283     FUNC_PROPSET,
284     FUNC_DEFGET
285 } function_type_t;
286
287 typedef struct {
288     const WCHAR *name;
289 } var_desc_t;
290
291 struct _function_t {
292     function_type_t type;
293     const WCHAR *name;
294     BOOL is_public;
295     arg_desc_t *args;
296     unsigned arg_cnt;
297     var_desc_t *vars;
298     unsigned var_cnt;
299     unsigned code_off;
300     vbscode_t *code_ctx;
301     function_t *next;
302 };
303
304 struct _vbscode_t {
305     instr_t *instrs;
306     WCHAR *source;
307
308     BOOL option_explicit;
309
310     BOOL pending_exec;
311     function_t main_code;
312
313     BSTR *bstr_pool;
314     unsigned bstr_pool_size;
315     unsigned bstr_cnt;
316     vbsheap_t heap;
317
318     struct list entry;
319 };
320
321 void release_vbscode(vbscode_t*) DECLSPEC_HIDDEN;
322 HRESULT compile_script(script_ctx_t*,const WCHAR*,vbscode_t**) DECLSPEC_HIDDEN;
323 HRESULT exec_script(script_ctx_t*,function_t*,IDispatch*,DISPPARAMS*,VARIANT*) DECLSPEC_HIDDEN;
324 void release_dynamic_vars(dynamic_var_t*) DECLSPEC_HIDDEN;
325
326 #define TID_LIST \
327     XDIID(ErrObj) \
328     XDIID(GlobalObj)
329
330 typedef enum {
331 #define XDIID(iface) iface ## _tid,
332 TID_LIST
333 #undef XDIID
334     LAST_tid
335 } tid_t;
336
337 HRESULT get_typeinfo(tid_t,ITypeInfo**) DECLSPEC_HIDDEN;
338
339 HRESULT WINAPI VBScriptFactory_CreateInstance(IClassFactory*,IUnknown*,REFIID,void**) DECLSPEC_HIDDEN;
340
341 const char *debugstr_variant(const VARIANT*) DECLSPEC_HIDDEN;
342
343 static inline void *heap_alloc(size_t len)
344 {
345     return HeapAlloc(GetProcessHeap(), 0, len);
346 }
347
348 static inline void *heap_alloc_zero(size_t len)
349 {
350     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
351 }
352
353 static inline void *heap_realloc(void *mem, size_t len)
354 {
355     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
356 }
357
358 static inline BOOL heap_free(void *mem)
359 {
360     return HeapFree(GetProcessHeap(), 0, mem);
361 }
362
363 static inline LPWSTR heap_strdupW(LPCWSTR str)
364 {
365     LPWSTR ret = NULL;
366
367     if(str) {
368         DWORD size;
369
370         size = (strlenW(str)+1)*sizeof(WCHAR);
371         ret = heap_alloc(size);
372         if(ret)
373             memcpy(ret, str, size);
374     }
375
376     return ret;
377 }