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