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