joy.cpl: Remove uneeded FIXME message.
[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
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,DISPPARAMS*) 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(case,           0, ARG_ADDR,    0)          \
193     X(concat,         1, 0,           0)          \
194     X(const,          1, ARG_BSTR,    0)          \
195     X(div,            1, 0,           0)          \
196     X(double,         1, ARG_DOUBLE,  0)          \
197     X(empty,          1, 0,           0)          \
198     X(enumnext,       0, ARG_ADDR,    ARG_BSTR)   \
199     X(equal,          1, 0,           0)          \
200     X(errmode,        1, ARG_INT,     0)          \
201     X(eqv,            1, 0,           0)          \
202     X(exp,            1, 0,           0)          \
203     X(gt,             1, 0,           0)          \
204     X(gteq,           1, 0,           0)          \
205     X(icall,          1, ARG_BSTR,    ARG_UINT)   \
206     X(icallv,         1, ARG_BSTR,    ARG_UINT)   \
207     X(idiv,           1, 0,           0)          \
208     X(imp,            1, 0,           0)          \
209     X(incc,           1, ARG_BSTR,    0)          \
210     X(is,             1, 0,           0)          \
211     X(jmp,            0, ARG_ADDR,    0)          \
212     X(jmp_false,      0, ARG_ADDR,    0)          \
213     X(jmp_true,       0, ARG_ADDR,    0)          \
214     X(long,           1, ARG_INT,     0)          \
215     X(lt,             1, 0,           0)          \
216     X(lteq,           1, 0,           0)          \
217     X(mcall,          1, ARG_BSTR,    ARG_UINT)   \
218     X(mcallv,         1, ARG_BSTR,    ARG_UINT)   \
219     X(me,             1, 0,           0)          \
220     X(mod,            1, 0,           0)          \
221     X(mul,            1, 0,           0)          \
222     X(neg,            1, 0,           0)          \
223     X(nequal,         1, 0,           0)          \
224     X(new,            1, ARG_STR,     0)          \
225     X(newenum,        1, 0,           0)          \
226     X(not,            1, 0,           0)          \
227     X(nothing,        1, 0,           0)          \
228     X(null,           1, 0,           0)          \
229     X(or,             1, 0,           0)          \
230     X(pop,            1, ARG_UINT,    0)          \
231     X(ret,            0, 0,           0)          \
232     X(set_ident,      1, ARG_BSTR,    ARG_UINT)   \
233     X(set_member,     1, ARG_BSTR,    ARG_UINT)   \
234     X(short,          1, ARG_INT,     0)          \
235     X(step,           0, ARG_ADDR,    ARG_BSTR)   \
236     X(stop,           1, 0,           0)          \
237     X(string,         1, ARG_STR,     0)          \
238     X(sub,            1, 0,           0)          \
239     X(val,            1, 0,           0)          \
240     X(xor,            1, 0,           0)
241
242 typedef enum {
243 #define X(x,n,a,b) OP_##x,
244 OP_LIST
245 #undef X
246     OP_LAST
247 } vbsop_t;
248
249 typedef union {
250     const WCHAR *str;
251     BSTR bstr;
252     unsigned uint;
253     LONG lng;
254     double *dbl;
255 } instr_arg_t;
256
257 typedef struct {
258     vbsop_t op;
259     instr_arg_t arg1;
260     instr_arg_t arg2;
261 } instr_t;
262
263 typedef struct {
264     const WCHAR *name;
265     BOOL by_ref;
266 } arg_desc_t;
267
268 typedef enum {
269     FUNC_GLOBAL,
270     FUNC_FUNCTION,
271     FUNC_SUB,
272     FUNC_PROPGET,
273     FUNC_PROPLET,
274     FUNC_PROPSET,
275     FUNC_DEFGET
276 } function_type_t;
277
278 typedef struct {
279     const WCHAR *name;
280 } var_desc_t;
281
282 struct _function_t {
283     function_type_t type;
284     const WCHAR *name;
285     BOOL is_public;
286     arg_desc_t *args;
287     unsigned arg_cnt;
288     var_desc_t *vars;
289     unsigned var_cnt;
290     unsigned code_off;
291     vbscode_t *code_ctx;
292     function_t *next;
293 };
294
295 struct _vbscode_t {
296     instr_t *instrs;
297     WCHAR *source;
298
299     BOOL option_explicit;
300
301     BOOL global_executed;
302     function_t global_code;
303
304     BSTR *bstr_pool;
305     unsigned bstr_pool_size;
306     unsigned bstr_cnt;
307     vbsheap_t heap;
308
309     struct list entry;
310 };
311
312 void release_vbscode(vbscode_t*) DECLSPEC_HIDDEN;
313 HRESULT compile_script(script_ctx_t*,const WCHAR*,vbscode_t**) DECLSPEC_HIDDEN;
314 HRESULT exec_script(script_ctx_t*,function_t*,IDispatch*,DISPPARAMS*,VARIANT*) DECLSPEC_HIDDEN;
315 void release_dynamic_vars(dynamic_var_t*) DECLSPEC_HIDDEN;
316
317 #define TID_LIST \
318     XDIID(ErrObj) \
319     XDIID(GlobalObj)
320
321 typedef enum {
322 #define XDIID(iface) iface ## _tid,
323 TID_LIST
324 #undef XDIID
325     LAST_tid
326 } tid_t;
327
328 HRESULT get_typeinfo(tid_t,ITypeInfo**) DECLSPEC_HIDDEN;
329
330 HRESULT WINAPI VBScriptFactory_CreateInstance(IClassFactory*,IUnknown*,REFIID,void**) DECLSPEC_HIDDEN;
331
332 const char *debugstr_variant(const VARIANT*) DECLSPEC_HIDDEN;
333
334 static inline void *heap_alloc(size_t len)
335 {
336     return HeapAlloc(GetProcessHeap(), 0, len);
337 }
338
339 static inline void *heap_alloc_zero(size_t len)
340 {
341     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
342 }
343
344 static inline void *heap_realloc(void *mem, size_t len)
345 {
346     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
347 }
348
349 static inline BOOL heap_free(void *mem)
350 {
351     return HeapFree(GetProcessHeap(), 0, mem);
352 }
353
354 static inline LPWSTR heap_strdupW(LPCWSTR str)
355 {
356     LPWSTR ret = NULL;
357
358     if(str) {
359         DWORD size;
360
361         size = (strlenW(str)+1)*sizeof(WCHAR);
362         ret = heap_alloc(size);
363         if(ret)
364             memcpy(ret, str, size);
365     }
366
367     return ret;
368 }