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