jscript: Avoid size_t in printf width specifier.
[wine] / dlls / jscript / function.c
1 /*
2  * Copyright 2008 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 "jscript.h"
20 #include "engine.h"
21
22 #include "wine/debug.h"
23
24 WINE_DEFAULT_DEBUG_CHANNEL(jscript);
25
26 typedef struct {
27     DispatchEx dispex;
28     builtin_invoke_t value_proc;
29     DWORD flags;
30     source_elements_t *source;
31     parameter_t *parameters;
32     scope_chain_t *scope_chain;
33     parser_ctx_t *parser;
34     const WCHAR *src_str;
35     DWORD src_len;
36     DWORD length;
37 } FunctionInstance;
38
39 static const WCHAR prototypeW[] = {'p','r','o','t','o','t', 'y', 'p','e',0};
40
41 static const WCHAR lengthW[] = {'l','e','n','g','t','h',0};
42 static const WCHAR toStringW[] = {'t','o','S','t','r','i','n','g',0};
43 static const WCHAR toLocaleStringW[] = {'t','o','L','o','c','a','l','e','S','t','r','i','n','g',0};
44 static const WCHAR valueOfW[] = {'v','a','l','u','e','O','f',0};
45 static const WCHAR applyW[] = {'a','p','p','l','y',0};
46 static const WCHAR callW[] = {'c','a','l','l',0};
47 static const WCHAR hasOwnPropertyW[] = {'h','a','s','O','w','n','P','r','o','p','e','r','t','y',0};
48 static const WCHAR propertyIsEnumerableW[] = {'p','r','o','p','e','r','t','y','I','s','E','n','u','m','e','r','a','b','l','e',0};
49 static const WCHAR isPrototypeOfW[] = {'i','s','P','r','o','t','o','t','y','p','e','O','f',0};
50
51 static IDispatch *get_this(DISPPARAMS *dp)
52 {
53     DWORD i;
54
55     for(i=0; i < dp->cNamedArgs; i++) {
56         if(dp->rgdispidNamedArgs[i] == DISPID_THIS) {
57             if(V_VT(dp->rgvarg+i) == VT_DISPATCH)
58                 return V_DISPATCH(dp->rgvarg+i);
59
60             WARN("This is not VT_DISPATCH\n");
61             return NULL;
62         }
63     }
64
65     TRACE("no this passed\n");
66     return NULL;
67 }
68
69 static HRESULT init_parameters(DispatchEx *var_disp, FunctionInstance *function, LCID lcid, DISPPARAMS *dp,
70         jsexcept_t *ei, IServiceProvider *caller)
71 {
72     parameter_t *param;
73     VARIANT var_empty;
74     DWORD cargs, i=0;
75     HRESULT hres;
76
77     V_VT(&var_empty) = VT_EMPTY;
78     cargs = dp->cArgs - dp->cNamedArgs;
79
80     for(param = function->parameters; param; param = param->next) {
81         hres = jsdisp_propput_name(var_disp, param->identifier, lcid,
82                 i < cargs ? dp->rgvarg + dp->cArgs-1 - i : &var_empty,
83                 ei, caller);
84         if(FAILED(hres))
85             return hres;
86
87         i++;
88     }
89
90     return S_OK;
91 }
92
93 static HRESULT init_arguments(DispatchEx *arg_disp, FunctionInstance *function, LCID lcid, DISPPARAMS *dp,
94         jsexcept_t *ei, IServiceProvider *caller)
95 {
96     VARIANT var;
97     DWORD i;
98     HRESULT hres;
99
100     for(i=0; i < dp->cArgs-dp->cNamedArgs; i++) {
101         hres = jsdisp_propput_idx(arg_disp, i, lcid, dp->rgvarg+dp->cArgs-1-i, ei, caller);
102         if(FAILED(hres))
103             return hres;
104     }
105
106     V_VT(&var) = VT_I4;
107     V_I4(&var) = dp->cArgs - dp->cNamedArgs;
108     return jsdisp_propput_name(arg_disp, lengthW, lcid, &var, ei, caller);
109 }
110
111 static HRESULT create_var_disp(FunctionInstance *function, LCID lcid, DISPPARAMS *dp, jsexcept_t *ei,
112                                IServiceProvider *caller, DispatchEx **ret)
113 {
114     DispatchEx *var_disp, *arg_disp;
115     HRESULT hres;
116
117     static const WCHAR argumentsW[] = {'a','r','g','u','m','e','n','t','s',0};
118
119     hres = create_dispex(function->dispex.ctx, NULL, NULL, &var_disp);
120     if(FAILED(hres))
121         return hres;
122
123     hres = create_dispex(function->dispex.ctx, NULL, NULL, &arg_disp);
124     if(SUCCEEDED(hres)) {
125         hres = init_arguments(arg_disp, function, lcid, dp, ei, caller);
126         if(SUCCEEDED(hres)) {
127             VARIANT var;
128
129             V_VT(&var) = VT_DISPATCH;
130             V_DISPATCH(&var) = (IDispatch*)_IDispatchEx_(arg_disp);
131             hres = jsdisp_propput_name(var_disp, argumentsW, lcid, &var, ei, caller);
132         }
133
134         jsdisp_release(arg_disp);
135     }
136
137     if(SUCCEEDED(hres))
138         hres = init_parameters(var_disp, function, lcid, dp, ei, caller);
139     if(FAILED(hres)) {
140         jsdisp_release(var_disp);
141         return hres;
142     }
143
144     *ret = var_disp;
145     return S_OK;
146 }
147
148 static HRESULT invoke_source(FunctionInstance *function, IDispatch *this_obj, LCID lcid, DISPPARAMS *dp,
149         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
150 {
151     DispatchEx *var_disp;
152     exec_ctx_t *exec_ctx;
153     scope_chain_t *scope;
154     HRESULT hres;
155
156     if(!function->source) {
157         FIXME("no source\n");
158         return E_FAIL;
159     }
160
161     hres = create_var_disp(function, lcid, dp, ei, caller, &var_disp);
162     if(FAILED(hres))
163         return hres;
164
165     hres = scope_push(function->scope_chain, var_disp, &scope);
166     if(SUCCEEDED(hres)) {
167         hres = create_exec_ctx(this_obj, var_disp, scope, &exec_ctx);
168         scope_release(scope);
169     }
170     if(FAILED(hres))
171         return hres;
172
173     hres = exec_source(exec_ctx, function->parser, function->source, ei, retv);
174     exec_release(exec_ctx);
175
176     return hres;
177 }
178
179 static HRESULT invoke_function(FunctionInstance *function, LCID lcid, DISPPARAMS *dp,
180         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
181 {
182     IDispatch *this_obj;
183
184     if(!(this_obj = get_this(dp)))
185         this_obj = (IDispatch*)_IDispatchEx_(function->dispex.ctx->script_disp);
186
187     return invoke_source(function, this_obj, lcid, dp, retv, ei, caller);
188 }
189
190 static HRESULT invoke_constructor(FunctionInstance *function, LCID lcid, DISPPARAMS *dp,
191         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
192 {
193     DispatchEx *this_obj;
194     HRESULT hres;
195
196     hres = create_object(function->dispex.ctx, &function->dispex, &this_obj);
197     if(FAILED(hres))
198         return hres;
199
200     hres = invoke_source(function, (IDispatch*)_IDispatchEx_(this_obj), lcid, dp, retv, ei, caller);
201     jsdisp_release(this_obj);
202     if(FAILED(hres))
203         return hres;
204
205     V_VT(retv) = VT_DISPATCH;
206     V_DISPATCH(retv) = (IDispatch*)_IDispatchEx_(this_obj);
207     return S_OK;
208 }
209
210 static HRESULT invoke_value_proc(FunctionInstance *function, LCID lcid, WORD flags, DISPPARAMS *dp,
211         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
212 {
213     DispatchEx *this_obj = NULL;
214     IDispatch *this_disp;
215     HRESULT hres;
216
217     this_disp = get_this(dp);
218     if(this_disp)
219         this_obj = iface_to_jsdisp((IUnknown*)this_disp);
220
221     hres = function->value_proc(this_obj ? this_obj : function->dispex.ctx->script_disp, lcid,
222                                 flags, dp, retv, ei, caller);
223
224     if(this_obj)
225         jsdisp_release(this_obj);
226     return hres;
227 }
228
229 static HRESULT function_to_string(FunctionInstance *function, BSTR *ret)
230 {
231     BSTR str;
232
233     if(function->value_proc) {
234         FIXME("Builtin functions not implemented\n");
235         return E_NOTIMPL;
236     }
237
238     str = SysAllocStringLen(function->src_str, function->src_len);
239     if(!str)
240         return E_OUTOFMEMORY;
241
242     *ret = str;
243     return S_OK;
244 }
245
246 static HRESULT Function_length(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
247         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
248 {
249     FunctionInstance *This = (FunctionInstance*)dispex;
250
251     TRACE("%p %d\n", This, This->length);
252
253     switch(flags) {
254     case DISPATCH_PROPERTYGET:
255         V_VT(retv) = VT_I4;
256         V_I4(retv) = This->length;
257         break;
258     default:
259         FIXME("unimplemented flags %x\n", flags);
260         return E_NOTIMPL;
261     }
262
263     return S_OK;
264 }
265
266 static HRESULT Function_toString(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
267         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
268 {
269     FunctionInstance *function;
270     BSTR str;
271     HRESULT hres;
272
273     TRACE("\n");
274
275     if(!is_class(dispex, JSCLASS_FUNCTION)) {
276         FIXME("throw TypeError\n");
277         return E_FAIL;
278     }
279
280     function = (FunctionInstance*)dispex;
281
282     hres = function_to_string(function, &str);
283     if(FAILED(hres))
284         return hres;
285
286     if(retv) {
287         V_VT(retv) = VT_BSTR;
288         V_BSTR(retv) = str;
289     }else {
290         SysFreeString(str);
291     }
292     return S_OK;
293 }
294
295 static HRESULT Function_toLocaleString(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
296         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
297 {
298     FIXME("\n");
299     return E_NOTIMPL;
300 }
301
302 static HRESULT Function_valueOf(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
303         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
304 {
305     FIXME("\n");
306     return E_NOTIMPL;
307 }
308
309 static HRESULT Function_apply(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
310         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
311 {
312     FIXME("\n");
313     return E_NOTIMPL;
314 }
315
316 static HRESULT Function_call(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
317         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
318 {
319     FIXME("\n");
320     return E_NOTIMPL;
321 }
322
323 static HRESULT Function_hasOwnProperty(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
324         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
325 {
326     FIXME("\n");
327     return E_NOTIMPL;
328 }
329
330 static HRESULT Function_propertyIsEnumerable(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
331         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
332 {
333     FIXME("\n");
334     return E_NOTIMPL;
335 }
336
337 static HRESULT Function_isPrototypeOf(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
338         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
339 {
340     FIXME("\n");
341     return E_NOTIMPL;
342 }
343
344 static HRESULT Function_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
345         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
346 {
347     FunctionInstance *function;
348
349     TRACE("\n");
350
351     if(dispex->builtin_info->class != JSCLASS_FUNCTION) {
352         ERR("dispex is not a function\n");
353         return E_FAIL;
354     }
355
356     function = (FunctionInstance*)dispex;
357
358     switch(flags) {
359     case DISPATCH_METHOD:
360         if(function->value_proc)
361             return invoke_value_proc(function, lcid, flags, dp, retv, ei, caller);
362
363         return invoke_function(function, lcid, dp, retv, ei, caller);
364
365     case DISPATCH_PROPERTYGET: {
366         HRESULT hres;
367         BSTR str;
368
369         hres = function_to_string(function, &str);
370         if(FAILED(hres))
371             return hres;
372
373         V_VT(retv) = VT_BSTR;
374         V_BSTR(retv) = str;
375         break;
376     }
377
378     case DISPATCH_CONSTRUCT:
379         if(function->value_proc)
380             return invoke_value_proc(function, lcid, flags, dp, retv, ei, caller);
381
382         return invoke_constructor(function, lcid, dp, retv, ei, caller);
383
384     default:
385         FIXME("not implemented flags %x\n", flags);
386         return E_NOTIMPL;
387     }
388
389     return S_OK;
390 }
391
392 static void Function_destructor(DispatchEx *dispex)
393 {
394     FunctionInstance *This = (FunctionInstance*)dispex;
395
396     if(This->parser)
397         parser_release(This->parser);
398     if(This->scope_chain)
399         scope_release(This->scope_chain);
400     heap_free(This);
401 }
402
403 static const builtin_prop_t Function_props[] = {
404     {applyW,                 Function_apply,                 PROPF_METHOD},
405     {callW,                  Function_call,                  PROPF_METHOD},
406     {hasOwnPropertyW,        Function_hasOwnProperty,        PROPF_METHOD},
407     {isPrototypeOfW,         Function_isPrototypeOf,         PROPF_METHOD},
408     {lengthW,                Function_length,                0},
409     {propertyIsEnumerableW,  Function_propertyIsEnumerable,  PROPF_METHOD},
410     {toLocaleStringW,        Function_toLocaleString,        PROPF_METHOD},
411     {toStringW,              Function_toString,              PROPF_METHOD},
412     {valueOfW,               Function_valueOf,               PROPF_METHOD}
413 };
414
415 static const builtin_info_t Function_info = {
416     JSCLASS_FUNCTION,
417     {NULL, Function_value, 0},
418     sizeof(Function_props)/sizeof(*Function_props),
419     Function_props,
420     Function_destructor,
421     NULL
422 };
423
424 static HRESULT FunctionConstr_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
425         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
426 {
427     FIXME("\n");
428     return E_NOTIMPL;
429 }
430
431 static HRESULT FunctionProt_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
432         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
433 {
434     FIXME("\n");
435     return E_NOTIMPL;
436 }
437
438 static HRESULT create_function(script_ctx_t *ctx, DWORD flags, BOOL funcprot, DispatchEx *prototype, FunctionInstance **ret)
439 {
440     FunctionInstance *function;
441     HRESULT hres;
442
443     function = heap_alloc_zero(sizeof(FunctionInstance));
444     if(!function)
445         return E_OUTOFMEMORY;
446
447     if(funcprot)
448         hres = init_dispex(&function->dispex, ctx, &Function_info, prototype);
449     else
450         hres = init_dispex_from_constr(&function->dispex, ctx, &Function_info, ctx->function_constr);
451     if(FAILED(hres))
452         return hres;
453
454     function->flags = flags;
455     function->length = flags & PROPF_ARGMASK;
456
457     if(prototype) {
458         jsexcept_t jsexcept;
459         VARIANT var;
460
461         V_VT(&var) = VT_DISPATCH;
462         V_DISPATCH(&var) = (IDispatch*)_IDispatchEx_(prototype);
463         memset(&jsexcept, 0, sizeof(jsexcept));
464
465         hres = jsdisp_propput_name(&function->dispex, prototypeW, ctx->lcid, &var, &jsexcept, NULL/*FIXME*/);
466         if(FAILED(hres)) {
467             IDispatchEx_Release(_IDispatchEx_(&function->dispex));
468             return hres;
469         }
470     }
471
472     *ret = function;
473     return S_OK;
474 }
475
476 HRESULT create_builtin_function(script_ctx_t *ctx, builtin_invoke_t value_proc, DWORD flags,
477         DispatchEx *prototype, DispatchEx **ret)
478 {
479     FunctionInstance *function;
480     HRESULT hres;
481
482     hres = create_function(ctx, flags, FALSE, prototype, &function);
483     if(FAILED(hres))
484         return hres;
485
486     function->value_proc = value_proc;
487
488     *ret = &function->dispex;
489     return S_OK;
490 }
491
492 HRESULT create_source_function(parser_ctx_t *ctx, parameter_t *parameters, source_elements_t *source,
493         scope_chain_t *scope_chain, const WCHAR *src_str, DWORD src_len, DispatchEx **ret)
494 {
495     FunctionInstance *function;
496     DispatchEx *prototype;
497     parameter_t *iter;
498     DWORD length = 0;
499     HRESULT hres;
500
501     hres = create_object(ctx->script, NULL, &prototype);
502     if(FAILED(hres))
503         return hres;
504
505     hres = create_function(ctx->script, PROPF_CONSTR, FALSE, prototype, &function);
506     jsdisp_release(prototype);
507     if(FAILED(hres))
508         return hres;
509
510     function->source = source;
511     function->parameters = parameters;
512
513     if(scope_chain) {
514         scope_addref(scope_chain);
515         function->scope_chain = scope_chain;
516     }
517
518     parser_addref(ctx);
519     function->parser = ctx;
520
521     for(iter = parameters; iter; iter = iter->next)
522         length++;
523     function->length = length;
524
525     function->src_str = src_str;
526     function->src_len = src_len;
527
528     *ret = &function->dispex;
529     return S_OK;
530 }
531
532 HRESULT init_function_constr(script_ctx_t *ctx)
533 {
534     FunctionInstance *prot, *constr;
535     HRESULT hres;
536
537     hres = create_function(ctx, PROPF_CONSTR, TRUE, NULL, &prot);
538     if(FAILED(hres))
539         return hres;
540
541     prot->value_proc = FunctionProt_value;
542
543     hres = create_function(ctx, PROPF_CONSTR, TRUE, &prot->dispex, &constr);
544     jsdisp_release(&prot->dispex);
545     if(FAILED(hres))
546         return hres;
547
548     constr->value_proc = FunctionConstr_value;
549     ctx->function_constr = &constr->dispex;
550     return hres;
551 }