vbscript: Added stop statement semi-stub 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
50 typedef struct named_item_t {
51     IDispatch *disp;
52     DWORD flags;
53     LPWSTR name;
54
55     struct list entry;
56 } named_item_t;
57
58 typedef enum {
59     VBDISP_CALLGET,
60     VBDISP_LET,
61     VBDISP_SET,
62     VBDISP_ANY
63 } vbdisp_invoke_type_t;
64
65 typedef struct {
66     const WCHAR *name;
67     BOOL is_public;
68     function_t *entries[VBDISP_ANY];
69 } vbdisp_funcprop_desc_t;
70
71 typedef struct _class_desc_t {
72     const WCHAR *name;
73     script_ctx_t *ctx;
74     unsigned func_cnt;
75     vbdisp_funcprop_desc_t *funcs;
76     struct _class_desc_t *next;
77 } class_desc_t;
78
79 typedef struct {
80     IDispatchEx IDispatchEx_iface;
81
82     LONG ref;
83
84     const class_desc_t *desc;
85 } vbdisp_t;
86
87 HRESULT create_vbdisp(const class_desc_t*,vbdisp_t**);
88 HRESULT disp_get_id(IDispatch*,BSTR,BOOL,DISPID*);
89 HRESULT disp_call(script_ctx_t*,IDispatch*,DISPID,DISPPARAMS*,VARIANT*);
90 HRESULT disp_propput(script_ctx_t*,IDispatch*,DISPID,VARIANT*);
91
92 static inline unsigned arg_cnt(const DISPPARAMS *dp)
93 {
94     return dp->cArgs - dp->cNamedArgs;
95 }
96
97 static inline VARIANT *get_arg(DISPPARAMS *dp, DWORD i)
98 {
99     return dp->rgvarg + dp->cArgs-i-1;
100 }
101
102 typedef struct _dynamic_var_t {
103     struct _dynamic_var_t *next;
104     VARIANT v;
105     const WCHAR *name;
106 } dynamic_var_t;
107
108 struct _script_ctx_t {
109     IActiveScriptSite *site;
110     LCID lcid;
111
112     IDispatch *host_global;
113
114     class_desc_t script_desc;
115     vbdisp_t *script_obj;
116
117     dynamic_var_t *global_vars;
118     function_t *global_funcs;
119     class_desc_t *classes;
120
121     struct list code_list;
122     struct list named_items;
123 };
124
125 HRESULT init_global(script_ctx_t*);
126
127 typedef enum {
128     ARG_NONE = 0,
129     ARG_STR,
130     ARG_BSTR,
131     ARG_INT,
132     ARG_UINT,
133     ARG_ADDR,
134     ARG_DOUBLE
135 } instr_arg_type_t;
136
137 #define OP_LIST                                   \
138     X(add,            1, 0,           0)          \
139     X(and,            1, 0,           0)          \
140     X(assign_ident,   1, ARG_BSTR,    0)          \
141     X(assign_member,  1, ARG_BSTR,    0)          \
142     X(bool,           1, ARG_INT,     0)          \
143     X(concat,         1, 0,           0)          \
144     X(div,            1, 0,           0)          \
145     X(double,         1, ARG_DOUBLE,  0)          \
146     X(empty,          1, 0,           0)          \
147     X(equal,          1, 0,           0)          \
148     X(eqv,            1, 0,           0)          \
149     X(exp,            1, 0,           0)          \
150     X(icall,          1, ARG_BSTR,    ARG_UINT)   \
151     X(icallv,         1, ARG_BSTR,    ARG_UINT)   \
152     X(idiv,           1, 0,           0)          \
153     X(imp,            1, 0,           0)          \
154     X(jmp,            0, ARG_ADDR,    0)          \
155     X(jmp_false,      0, ARG_ADDR,    0)          \
156     X(long,           1, ARG_INT,     0)          \
157     X(mcall,          1, ARG_BSTR,    ARG_UINT)   \
158     X(mcallv,         1, ARG_BSTR,    ARG_UINT)   \
159     X(mod,            1, 0,           0)          \
160     X(mul,            1, 0,           0)          \
161     X(neg,            1, 0,           0)          \
162     X(nequal,         1, 0,           0)          \
163     X(new,            1, ARG_STR,     0)          \
164     X(not,            1, 0,           0)          \
165     X(nothing,        1, 0,           0)          \
166     X(null,           1, 0,           0)          \
167     X(or,             1, 0,           0)          \
168     X(ret,            0, 0,           0)          \
169     X(set_ident,      1, ARG_BSTR,    0)          \
170     X(set_member,     1, ARG_BSTR,    0)          \
171     X(short,          1, ARG_INT,     0)          \
172     X(stop,           1, 0,           0)          \
173     X(string,         1, ARG_STR,     0)          \
174     X(sub,            1, 0,           0)          \
175     X(xor,            1, 0,           0)
176
177 typedef enum {
178 #define X(x,n,a,b) OP_##x,
179 OP_LIST
180 #undef X
181     OP_LAST
182 } vbsop_t;
183
184 typedef union {
185     const WCHAR *str;
186     BSTR bstr;
187     unsigned uint;
188     LONG lng;
189     double *dbl;
190 } instr_arg_t;
191
192 typedef struct {
193     vbsop_t op;
194     instr_arg_t arg1;
195     instr_arg_t arg2;
196 } instr_t;
197
198 typedef struct {
199     const WCHAR *name;
200     BOOL by_ref;
201 } arg_desc_t;
202
203 typedef enum {
204     FUNC_GLOBAL,
205     FUNC_FUNCTION,
206     FUNC_SUB
207 } function_type_t;
208
209 typedef struct {
210     const WCHAR *name;
211 } var_desc_t;
212
213 struct _function_t {
214     function_type_t type;
215     const WCHAR *name;
216     BOOL is_public;
217     arg_desc_t *args;
218     unsigned arg_cnt;
219     var_desc_t *vars;
220     unsigned var_cnt;
221     unsigned code_off;
222     vbscode_t *code_ctx;
223     function_t *next;
224 };
225
226 struct _vbscode_t {
227     instr_t *instrs;
228     WCHAR *source;
229
230     BOOL option_explicit;
231
232     BOOL global_executed;
233     function_t global_code;
234
235     BSTR *bstr_pool;
236     unsigned bstr_pool_size;
237     unsigned bstr_cnt;
238     vbsheap_t heap;
239
240     struct list entry;
241 };
242
243 void release_vbscode(vbscode_t*) DECLSPEC_HIDDEN;
244 HRESULT compile_script(script_ctx_t*,const WCHAR*,vbscode_t**) DECLSPEC_HIDDEN;
245 HRESULT exec_script(script_ctx_t*,function_t*,IDispatch*,DISPPARAMS*,VARIANT*) DECLSPEC_HIDDEN;
246
247 HRESULT WINAPI VBScriptFactory_CreateInstance(IClassFactory*,IUnknown*,REFIID,void**);
248
249 const char *debugstr_variant(const VARIANT*) DECLSPEC_HIDDEN;
250
251 static inline void *heap_alloc(size_t len)
252 {
253     return HeapAlloc(GetProcessHeap(), 0, len);
254 }
255
256 static inline void *heap_alloc_zero(size_t len)
257 {
258     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
259 }
260
261 static inline void *heap_realloc(void *mem, size_t len)
262 {
263     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
264 }
265
266 static inline BOOL heap_free(void *mem)
267 {
268     return HeapFree(GetProcessHeap(), 0, mem);
269 }
270
271 static inline LPWSTR heap_strdupW(LPCWSTR str)
272 {
273     LPWSTR ret = NULL;
274
275     if(str) {
276         DWORD size;
277
278         size = (strlenW(str)+1)*sizeof(WCHAR);
279         ret = heap_alloc(size);
280         if(ret)
281             memcpy(ret, str, size);
282     }
283
284     return ret;
285 }