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