jscript: Use HRESULTs instead of IDSs in parser.
[wine] / dlls / jscript / jscript.h
1 /*
2  * Copyright 2008-2009 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 #include <stdio.h>
21
22 #define COBJMACROS
23
24 #include "windef.h"
25 #include "winbase.h"
26 #include "winuser.h"
27 #include "ole2.h"
28 #include "dispex.h"
29 #include "activscp.h"
30
31 #include "resource.h"
32
33 #include "wine/unicode.h"
34 #include "wine/list.h"
35
36 typedef struct _script_ctx_t script_ctx_t;
37 typedef struct _exec_ctx_t exec_ctx_t;
38 typedef struct _dispex_prop_t dispex_prop_t;
39
40 typedef struct {
41     EXCEPINFO ei;
42     VARIANT var;
43 } jsexcept_t;
44
45 typedef struct {
46     void **blocks;
47     DWORD block_cnt;
48     DWORD last_block;
49     DWORD offset;
50     BOOL mark;
51     struct list custom_blocks;
52 } jsheap_t;
53
54 void jsheap_init(jsheap_t*);
55 void *jsheap_alloc(jsheap_t*,DWORD);
56 void *jsheap_grow(jsheap_t*,void*,DWORD,DWORD);
57 void jsheap_clear(jsheap_t*);
58 void jsheap_free(jsheap_t*);
59 jsheap_t *jsheap_mark(jsheap_t*);
60
61 typedef struct jsdisp_t jsdisp_t;
62
63 extern HINSTANCE jscript_hinstance;
64
65 #define PROPF_ARGMASK 0x00ff
66 #define PROPF_METHOD  0x0100
67 #define PROPF_ENUM    0x0200
68 #define PROPF_CONSTR  0x0400
69 #define PROPF_CONST   0x0800
70
71 /* NOTE: Keep in sync with names in Object.toString implementation */
72 typedef enum {
73     JSCLASS_NONE,
74     JSCLASS_ARRAY,
75     JSCLASS_BOOLEAN,
76     JSCLASS_DATE,
77     JSCLASS_ERROR,
78     JSCLASS_FUNCTION,
79     JSCLASS_GLOBAL,
80     JSCLASS_MATH,
81     JSCLASS_NUMBER,
82     JSCLASS_OBJECT,
83     JSCLASS_REGEXP,
84     JSCLASS_STRING,
85     JSCLASS_ARGUMENTS,
86     JSCLASS_VBARRAY
87 } jsclass_t;
88
89 jsdisp_t *iface_to_jsdisp(IUnknown*);
90
91 typedef struct {
92     union {
93         IDispatch *disp;
94         IDispatchEx *dispex;
95         jsdisp_t *jsdisp;
96     } u;
97     DWORD flags;
98 } vdisp_t;
99
100 #define VDISP_DISPEX  0x0001
101 #define VDISP_JSDISP  0x0002
102
103 static inline void vdisp_release(vdisp_t *vdisp)
104 {
105     IDispatch_Release(vdisp->u.disp);
106 }
107
108 static inline BOOL is_jsdisp(vdisp_t *vdisp)
109 {
110     return (vdisp->flags & VDISP_JSDISP) != 0;
111 }
112
113 static inline BOOL is_dispex(vdisp_t *vdisp)
114 {
115     return (vdisp->flags & VDISP_DISPEX) != 0;
116 }
117
118 static inline void set_jsdisp(vdisp_t *vdisp, jsdisp_t *jsdisp)
119 {
120     vdisp->u.jsdisp = jsdisp;
121     vdisp->flags = VDISP_JSDISP | VDISP_DISPEX;
122     IDispatch_AddRef(vdisp->u.disp);
123 }
124
125 static inline void set_disp(vdisp_t *vdisp, IDispatch *disp)
126 {
127     IDispatchEx *dispex;
128     jsdisp_t *jsdisp;
129     HRESULT hres;
130
131     jsdisp = iface_to_jsdisp((IUnknown*)disp);
132     if(jsdisp) {
133         vdisp->u.jsdisp = jsdisp;
134         vdisp->flags = VDISP_JSDISP | VDISP_DISPEX;
135         return;
136     }
137
138     hres = IDispatch_QueryInterface(disp, &IID_IDispatchEx, (void**)&dispex);
139     if(SUCCEEDED(hres)) {
140         vdisp->u.dispex = dispex;
141         vdisp->flags = VDISP_DISPEX;
142         return;
143     }
144
145     IDispatch_AddRef(disp);
146     vdisp->u.disp = disp;
147     vdisp->flags = 0;
148 }
149
150 static inline jsdisp_t *get_jsdisp(vdisp_t *vdisp)
151 {
152     return is_jsdisp(vdisp) ? vdisp->u.jsdisp : NULL;
153 }
154
155 typedef HRESULT (*builtin_invoke_t)(script_ctx_t*,vdisp_t*,WORD,DISPPARAMS*,VARIANT*,jsexcept_t*,IServiceProvider*);
156
157 typedef struct {
158     const WCHAR *name;
159     builtin_invoke_t invoke;
160     DWORD flags;
161 } builtin_prop_t;
162
163 typedef struct {
164     jsclass_t class;
165     builtin_prop_t value_prop;
166     DWORD props_cnt;
167     const builtin_prop_t *props;
168     void (*destructor)(jsdisp_t*);
169     void (*on_put)(jsdisp_t*,const WCHAR*);
170 } builtin_info_t;
171
172 struct jsdisp_t {
173     const IDispatchExVtbl  *lpIDispatchExVtbl;
174
175     LONG ref;
176
177     DWORD buf_size;
178     DWORD prop_cnt;
179     dispex_prop_t *props;
180     script_ctx_t *ctx;
181
182     jsdisp_t *prototype;
183
184     const builtin_info_t *builtin_info;
185 };
186
187 #define _IDispatchEx_(x) ((IDispatchEx*) &(x)->lpIDispatchExVtbl)
188
189 static inline IDispatch *to_disp(jsdisp_t *jsdisp)
190 {
191     return (IDispatch*)&jsdisp->lpIDispatchExVtbl;
192 }
193
194 static inline void jsdisp_addref(jsdisp_t *jsdisp)
195 {
196     IDispatchEx_AddRef(_IDispatchEx_(jsdisp));
197 }
198
199 static inline void jsdisp_release(jsdisp_t *jsdisp)
200 {
201     IDispatchEx_Release(_IDispatchEx_(jsdisp));
202 }
203
204 HRESULT create_dispex(script_ctx_t*,const builtin_info_t*,jsdisp_t*,jsdisp_t**);
205 HRESULT init_dispex(jsdisp_t*,script_ctx_t*,const builtin_info_t*,jsdisp_t*);
206 HRESULT init_dispex_from_constr(jsdisp_t*,script_ctx_t*,const builtin_info_t*,jsdisp_t*);
207
208 HRESULT disp_call(script_ctx_t*,IDispatch*,DISPID,WORD,DISPPARAMS*,VARIANT*,jsexcept_t*,IServiceProvider*);
209 HRESULT jsdisp_call_value(jsdisp_t*,WORD,DISPPARAMS*,VARIANT*,jsexcept_t*,IServiceProvider*);
210 HRESULT jsdisp_call(jsdisp_t*,DISPID,WORD,DISPPARAMS*,VARIANT*,jsexcept_t*,IServiceProvider*);
211 HRESULT jsdisp_call_name(jsdisp_t*,const WCHAR*,WORD,DISPPARAMS*,VARIANT*,jsexcept_t*,IServiceProvider*);
212 HRESULT disp_propget(script_ctx_t*,IDispatch*,DISPID,VARIANT*,jsexcept_t*,IServiceProvider*);
213 HRESULT disp_propput(script_ctx_t*,IDispatch*,DISPID,VARIANT*,jsexcept_t*,IServiceProvider*);
214 HRESULT jsdisp_propget(jsdisp_t*,DISPID,VARIANT*,jsexcept_t*,IServiceProvider*);
215 HRESULT jsdisp_propput_name(jsdisp_t*,const WCHAR*,VARIANT*,jsexcept_t*,IServiceProvider*);
216 HRESULT jsdisp_propput_const(jsdisp_t*,const WCHAR*,VARIANT*);
217 HRESULT jsdisp_propput_idx(jsdisp_t*,DWORD,VARIANT*,jsexcept_t*,IServiceProvider*);
218 HRESULT jsdisp_propget_name(jsdisp_t*,LPCWSTR,VARIANT*,jsexcept_t*,IServiceProvider*);
219 HRESULT jsdisp_get_idx(jsdisp_t*,DWORD,VARIANT*,jsexcept_t*,IServiceProvider*);
220 HRESULT jsdisp_get_id(jsdisp_t*,const WCHAR*,DWORD,DISPID*);
221 HRESULT jsdisp_delete_idx(jsdisp_t*,DWORD);
222
223 HRESULT create_builtin_function(script_ctx_t*,builtin_invoke_t,const WCHAR*,const builtin_info_t*,DWORD,
224         jsdisp_t*,jsdisp_t**);
225 HRESULT Function_value(script_ctx_t*,vdisp_t*,WORD,DISPPARAMS*,VARIANT*,jsexcept_t*,IServiceProvider*);
226
227 HRESULT throw_eval_error(script_ctx_t*,jsexcept_t*,HRESULT,const WCHAR*);
228 HRESULT throw_generic_error(script_ctx_t*,jsexcept_t*,HRESULT,const WCHAR*);
229 HRESULT throw_range_error(script_ctx_t*,jsexcept_t*,HRESULT,const WCHAR*);
230 HRESULT throw_reference_error(script_ctx_t*,jsexcept_t*,HRESULT,const WCHAR*);
231 HRESULT throw_regexp_error(script_ctx_t*,jsexcept_t*,HRESULT,const WCHAR*);
232 HRESULT throw_syntax_error(script_ctx_t*,jsexcept_t*,HRESULT,const WCHAR*);
233 HRESULT throw_type_error(script_ctx_t*,jsexcept_t*,HRESULT,const WCHAR*);
234 HRESULT throw_uri_error(script_ctx_t*,jsexcept_t*,HRESULT,const WCHAR*);
235
236 HRESULT create_object(script_ctx_t*,jsdisp_t*,jsdisp_t**);
237 HRESULT create_math(script_ctx_t*,jsdisp_t**);
238 HRESULT create_array(script_ctx_t*,DWORD,jsdisp_t**);
239 HRESULT create_regexp(script_ctx_t*,const WCHAR *,int,DWORD,jsdisp_t**);
240 HRESULT create_regexp_var(script_ctx_t*,VARIANT*,VARIANT*,jsdisp_t**);
241 HRESULT create_string(script_ctx_t*,const WCHAR*,DWORD,jsdisp_t**);
242 HRESULT create_bool(script_ctx_t*,VARIANT_BOOL,jsdisp_t**);
243 HRESULT create_number(script_ctx_t*,VARIANT*,jsdisp_t**);
244 HRESULT create_vbarray(script_ctx_t*,SAFEARRAY*,jsdisp_t**);
245
246 typedef enum {
247     NO_HINT,
248     HINT_STRING,
249     HINT_NUMBER
250 } hint_t;
251
252 HRESULT to_primitive(script_ctx_t*,VARIANT*,jsexcept_t*,VARIANT*, hint_t);
253 HRESULT to_boolean(VARIANT*,VARIANT_BOOL*);
254 HRESULT to_number(script_ctx_t*,VARIANT*,jsexcept_t*,VARIANT*);
255 HRESULT to_integer(script_ctx_t*,VARIANT*,jsexcept_t*,VARIANT*);
256 HRESULT to_int32(script_ctx_t*,VARIANT*,jsexcept_t*,INT*);
257 HRESULT to_uint32(script_ctx_t*,VARIANT*,jsexcept_t*,DWORD*);
258 HRESULT to_string(script_ctx_t*,VARIANT*,jsexcept_t*,BSTR*);
259 HRESULT to_object(script_ctx_t*,VARIANT*,IDispatch**);
260
261 typedef struct named_item_t {
262     IDispatch *disp;
263     DWORD flags;
264     LPWSTR name;
265
266     struct named_item_t *next;
267 } named_item_t;
268
269 struct _script_ctx_t {
270     LONG ref;
271
272     SCRIPTSTATE state;
273     exec_ctx_t *exec_ctx;
274     named_item_t *named_items;
275     IActiveScriptSite *site;
276     IInternetHostSecurityManager *secmgr;
277     DWORD safeopt;
278     DWORD version;
279     LCID lcid;
280
281     jsheap_t tmp_heap;
282
283     IDispatch *host_global;
284
285     BSTR last_match;
286     DWORD last_match_index;
287     DWORD last_match_length;
288
289     jsdisp_t *global;
290     jsdisp_t *function_constr;
291     jsdisp_t *activex_constr;
292     jsdisp_t *array_constr;
293     jsdisp_t *bool_constr;
294     jsdisp_t *date_constr;
295     jsdisp_t *error_constr;
296     jsdisp_t *eval_error_constr;
297     jsdisp_t *range_error_constr;
298     jsdisp_t *reference_error_constr;
299     jsdisp_t *regexp_error_constr;
300     jsdisp_t *syntax_error_constr;
301     jsdisp_t *type_error_constr;
302     jsdisp_t *uri_error_constr;
303     jsdisp_t *number_constr;
304     jsdisp_t *object_constr;
305     jsdisp_t *regexp_constr;
306     jsdisp_t *string_constr;
307     jsdisp_t *vbarray_constr;
308 };
309
310 void script_release(script_ctx_t*);
311
312 static inline void script_addref(script_ctx_t *ctx)
313 {
314     ctx->ref++;
315 }
316
317 HRESULT init_global(script_ctx_t*);
318 HRESULT init_function_constr(script_ctx_t*,jsdisp_t*);
319 HRESULT create_object_prototype(script_ctx_t*,jsdisp_t**);
320
321 HRESULT create_activex_constr(script_ctx_t*,jsdisp_t**);
322 HRESULT create_array_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**);
323 HRESULT create_bool_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**);
324 HRESULT create_date_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**);
325 HRESULT init_error_constr(script_ctx_t*,jsdisp_t*);
326 HRESULT create_number_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**);
327 HRESULT create_object_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**);
328 HRESULT create_regexp_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**);
329 HRESULT create_string_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**);
330 HRESULT create_vbarray_constr(script_ctx_t*,jsdisp_t*,jsdisp_t**);
331
332 IUnknown *create_ax_site(script_ctx_t*);
333
334 typedef struct {
335     const WCHAR *str;
336     DWORD len;
337 } match_result_t;
338
339 #define REM_CHECK_GLOBAL   0x0001
340 #define REM_RESET_INDEX    0x0002
341 #define REM_NO_CTX_UPDATE  0x0004
342 HRESULT regexp_match_next(script_ctx_t*,jsdisp_t*,DWORD,const WCHAR*,DWORD,const WCHAR**,match_result_t**,
343         DWORD*,DWORD*,match_result_t*);
344 HRESULT regexp_match(script_ctx_t*,jsdisp_t*,const WCHAR*,DWORD,BOOL,match_result_t**,DWORD*);
345 HRESULT parse_regexp_flags(const WCHAR*,DWORD,DWORD*);
346 HRESULT regexp_string_match(script_ctx_t*,jsdisp_t*,BSTR,VARIANT*,jsexcept_t*);
347
348 static inline VARIANT *get_arg(DISPPARAMS *dp, DWORD i)
349 {
350     return dp->rgvarg + dp->cArgs-i-1;
351 }
352
353 static inline DWORD arg_cnt(const DISPPARAMS *dp)
354 {
355     return dp->cArgs - dp->cNamedArgs;
356 }
357
358 static inline BOOL is_class(jsdisp_t *jsdisp, jsclass_t class)
359 {
360     return jsdisp->builtin_info->class == class;
361 }
362
363 static inline BOOL is_vclass(vdisp_t *vdisp, jsclass_t class)
364 {
365     return is_jsdisp(vdisp) && is_class(vdisp->u.jsdisp, class);
366 }
367
368 static inline BOOL is_num_vt(enum VARENUM vt)
369 {
370     return vt == VT_I4 || vt == VT_R8;
371 }
372
373 static inline DOUBLE num_val(const VARIANT *v)
374 {
375     return V_VT(v) == VT_I4 ? V_I4(v) : V_R8(v);
376 }
377
378 static inline void num_set_int(VARIANT *v, INT i)
379 {
380     V_VT(v) = VT_I4;
381     V_I4(v) = i;
382 }
383
384 static inline void num_set_val(VARIANT *v, DOUBLE d)
385 {
386     if(d == (DOUBLE)(INT)d) {
387         V_VT(v) = VT_I4;
388         V_I4(v) = d;
389     }else {
390         V_VT(v) = VT_R8;
391         V_R8(v) = d;
392     }
393 }
394
395 static inline void num_set_nan(VARIANT *v)
396 {
397     V_VT(v) = VT_R8;
398 #ifdef NAN
399     V_R8(v) = NAN;
400 #else
401     V_UI8(v) = (ULONGLONG)0x7ff80000<<32;
402 #endif
403 }
404
405 static inline DOUBLE ret_nan(void)
406 {
407     VARIANT v;
408     num_set_nan(&v);
409     return V_R8(&v);
410 }
411
412 static inline void num_set_inf(VARIANT *v, BOOL positive)
413 {
414     V_VT(v) = VT_R8;
415 #ifdef INFINITY
416     V_R8(v) = positive ? INFINITY : -INFINITY;
417 #else
418     V_UI8(v) = (ULONGLONG)0x7ff00000<<32;
419     if(!positive)
420         V_R8(v) = -V_R8(v);
421 #endif
422 }
423
424 static inline void var_set_jsdisp(VARIANT *v, jsdisp_t *jsdisp)
425 {
426     V_VT(v) = VT_DISPATCH;
427     V_DISPATCH(v) = to_disp(jsdisp);
428 }
429
430 static inline DWORD make_grfdex(script_ctx_t *ctx, DWORD flags)
431 {
432     return (ctx->version << 28) | flags;
433 }
434
435 #define FACILITY_JSCRIPT 10
436
437 #define MAKE_JSERROR(code) MAKE_HRESULT(SEVERITY_ERROR, FACILITY_JSCRIPT, code)
438
439 #define JS_E_TO_PRIMITIVE            MAKE_JSERROR(IDS_TO_PRIMITIVE)
440 #define JS_E_INVALIDARG              MAKE_JSERROR(IDS_INVALID_CALL_ARG)
441 #define JS_E_SUBSCRIPT_OUT_OF_RANGE  MAKE_JSERROR(IDS_SUBSCRIPT_OUT_OF_RANGE)
442 #define JS_E_CANNOT_CREATE_OBJ       MAKE_JSERROR(IDS_CREATE_OBJ_ERROR)
443 #define JS_E_INVALID_PROPERTY        MAKE_JSERROR(IDS_NO_PROPERTY)
444 #define JS_E_INVALID_ACTION          MAKE_JSERROR(IDS_UNSUPPORTED_ACTION)
445 #define JS_E_MISSING_ARG             MAKE_JSERROR(IDS_ARG_NOT_OPT)
446 #define JS_E_SYNTAX                  MAKE_JSERROR(IDS_SYNTAX_ERROR)
447 #define JS_E_MISSING_SEMICOLON       MAKE_JSERROR(IDS_SEMICOLON)
448 #define JS_E_MISSING_LBRACKET        MAKE_JSERROR(IDS_LBRACKET)
449 #define JS_E_MISSING_RBRACKET        MAKE_JSERROR(IDS_RBRACKET)
450 #define JS_E_UNTERMINATED_STRING     MAKE_JSERROR(IDS_UNTERMINATED_STR)
451 #define JS_E_FUNCTION_EXPECTED       MAKE_JSERROR(IDS_NOT_FUNC)
452 #define JS_E_DATE_EXPECTED           MAKE_JSERROR(IDS_NOT_DATE)
453 #define JS_E_NUMBER_EXPECTED         MAKE_JSERROR(IDS_NOT_NUM)
454 #define JS_E_OBJECT_EXPECTED         MAKE_JSERROR(IDS_OBJECT_EXPECTED)
455 #define JS_E_ILLEGAL_ASSIGN          MAKE_JSERROR(IDS_ILLEGAL_ASSIGN)
456 #define JS_E_UNDEFINED_VARIABLE      MAKE_JSERROR(IDS_UNDEFINED)
457 #define JS_E_BOOLEAN_EXPECTED        MAKE_JSERROR(IDS_NOT_BOOL)
458 #define JS_E_VBARRAY_EXPECTED        MAKE_JSERROR(IDS_NOT_VBARRAY)
459 #define JS_E_JSCRIPT_EXPECTED        MAKE_JSERROR(IDS_JSCRIPT_EXPECTED)
460 #define JS_E_REGEXP_SYNTAX           MAKE_JSERROR(IDS_REGEXP_SYNTAX_ERROR)
461 #define JS_E_INVALID_URI_CHAR        MAKE_JSERROR(IDS_URI_INVALID_CHAR)
462 #define JS_E_INVALID_LENGTH          MAKE_JSERROR(IDS_INVALID_LENGTH)
463 #define JS_E_ARRAY_EXPECTED          MAKE_JSERROR(IDS_ARRAY_EXPECTED)
464
465 static inline BOOL is_jscript_error(HRESULT hres)
466 {
467     return HRESULT_FACILITY(hres) == FACILITY_JSCRIPT;
468 }
469
470 const char *debugstr_variant(const VARIANT*);
471
472 HRESULT WINAPI JScriptFactory_CreateInstance(IClassFactory*,IUnknown*,REFIID,void**);
473
474 extern LONG module_ref;
475
476 static inline void lock_module(void)
477 {
478     InterlockedIncrement(&module_ref);
479 }
480
481 static inline void unlock_module(void)
482 {
483     InterlockedDecrement(&module_ref);
484 }
485
486 static inline void *heap_alloc(size_t len)
487 {
488     return HeapAlloc(GetProcessHeap(), 0, len);
489 }
490
491 static inline void *heap_alloc_zero(size_t len)
492 {
493     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
494 }
495
496 static inline void *heap_realloc(void *mem, size_t len)
497 {
498     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
499 }
500
501 static inline BOOL heap_free(void *mem)
502 {
503     return HeapFree(GetProcessHeap(), 0, mem);
504 }
505
506 static inline LPWSTR heap_strdupW(LPCWSTR str)
507 {
508     LPWSTR ret = NULL;
509
510     if(str) {
511         DWORD size;
512
513         size = (strlenW(str)+1)*sizeof(WCHAR);
514         ret = heap_alloc(size);
515         memcpy(ret, str, size);
516     }
517
518     return ret;
519 }
520
521 #define DEFINE_THIS(cls,ifc,iface) ((cls*)((BYTE*)(iface)-offsetof(cls,lp ## ifc ## Vtbl)))