jscript: Check the correct variable for the error condition (Smatch).
[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 applyW[] = {'a','p','p','l','y',0};
44 static const WCHAR callW[] = {'c','a','l','l',0};
45
46 static IDispatch *get_this(DISPPARAMS *dp)
47 {
48     DWORD i;
49
50     for(i=0; i < dp->cNamedArgs; i++) {
51         if(dp->rgdispidNamedArgs[i] == DISPID_THIS) {
52             if(V_VT(dp->rgvarg+i) == VT_DISPATCH)
53                 return V_DISPATCH(dp->rgvarg+i);
54
55             WARN("This is not VT_DISPATCH\n");
56             return NULL;
57         }
58     }
59
60     TRACE("no this passed\n");
61     return NULL;
62 }
63
64 static HRESULT init_parameters(DispatchEx *var_disp, FunctionInstance *function, LCID lcid, DISPPARAMS *dp,
65         jsexcept_t *ei, IServiceProvider *caller)
66 {
67     parameter_t *param;
68     VARIANT var_empty;
69     DWORD cargs, i=0;
70     HRESULT hres;
71
72     V_VT(&var_empty) = VT_EMPTY;
73     cargs = dp->cArgs - dp->cNamedArgs;
74
75     for(param = function->parameters; param; param = param->next) {
76         hres = jsdisp_propput_name(var_disp, param->identifier, lcid,
77                 i < cargs ? dp->rgvarg + dp->cArgs-1 - i : &var_empty,
78                 ei, caller);
79         if(FAILED(hres))
80             return hres;
81
82         i++;
83     }
84
85     return S_OK;
86 }
87
88 static HRESULT Arguments_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
89         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
90 {
91     FIXME("\n");
92     return E_NOTIMPL;
93 }
94
95 static const builtin_info_t Arguments_info = {
96     JSCLASS_ARGUMENTS,
97     {NULL, Arguments_value, 0},
98     0, NULL,
99     NULL,
100     NULL
101 };
102
103 static HRESULT create_arguments(script_ctx_t *ctx, LCID lcid, DISPPARAMS *dp,
104         jsexcept_t *ei, IServiceProvider *caller, DispatchEx **ret)
105 {
106     DispatchEx *args;
107     VARIANT var;
108     DWORD i;
109     HRESULT hres;
110
111     args = heap_alloc_zero(sizeof(DispatchEx));
112     if(!args)
113         return E_OUTOFMEMORY;
114
115     hres = init_dispex_from_constr(args, ctx, &Arguments_info, ctx->object_constr);
116     if(FAILED(hres)) {
117         heap_free(args);
118         return hres;
119     }
120
121     for(i=0; i < arg_cnt(dp); i++) {
122         hres = jsdisp_propput_idx(args, i, lcid, get_arg(dp,i), ei, caller);
123         if(FAILED(hres))
124             break;
125     }
126
127     if(SUCCEEDED(hres)) {
128         V_VT(&var) = VT_I4;
129         V_I4(&var) = arg_cnt(dp);
130         hres = jsdisp_propput_name(args, lengthW, lcid, &var, ei, caller);
131     }
132
133     if(FAILED(hres)) {
134         jsdisp_release(args);
135         return hres;
136     }
137
138     *ret = args;
139     return S_OK;
140 }
141
142 static HRESULT create_var_disp(FunctionInstance *function, LCID lcid, DISPPARAMS *dp, jsexcept_t *ei,
143                                IServiceProvider *caller, DispatchEx **ret)
144 {
145     DispatchEx *var_disp, *arg_disp;
146     HRESULT hres;
147
148     static const WCHAR argumentsW[] = {'a','r','g','u','m','e','n','t','s',0};
149
150     hres = create_dispex(function->dispex.ctx, NULL, NULL, &var_disp);
151     if(FAILED(hres))
152         return hres;
153
154     hres = create_arguments(function->dispex.ctx, lcid, dp, ei, caller, &arg_disp);
155     if(SUCCEEDED(hres)) {
156         VARIANT var;
157
158         V_VT(&var) = VT_DISPATCH;
159         V_DISPATCH(&var) = (IDispatch*)_IDispatchEx_(arg_disp);
160         hres = jsdisp_propput_name(var_disp, argumentsW, lcid, &var, ei, caller);
161         jsdisp_release(arg_disp);
162     }
163
164     if(SUCCEEDED(hres))
165         hres = init_parameters(var_disp, function, lcid, dp, ei, caller);
166     if(FAILED(hres)) {
167         jsdisp_release(var_disp);
168         return hres;
169     }
170
171     *ret = var_disp;
172     return S_OK;
173 }
174
175 static HRESULT invoke_source(FunctionInstance *function, IDispatch *this_obj, LCID lcid, DISPPARAMS *dp,
176         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
177 {
178     DispatchEx *var_disp;
179     exec_ctx_t *exec_ctx;
180     scope_chain_t *scope;
181     HRESULT hres;
182
183     if(!function->source) {
184         FIXME("no source\n");
185         return E_FAIL;
186     }
187
188     hres = create_var_disp(function, lcid, dp, ei, caller, &var_disp);
189     if(FAILED(hres))
190         return hres;
191
192     hres = scope_push(function->scope_chain, var_disp, &scope);
193     if(SUCCEEDED(hres)) {
194         hres = create_exec_ctx(this_obj, var_disp, scope, &exec_ctx);
195         scope_release(scope);
196     }
197     if(FAILED(hres))
198         return hres;
199
200     hres = exec_source(exec_ctx, function->parser, function->source, ei, retv);
201     exec_release(exec_ctx);
202
203     return hres;
204 }
205
206 static HRESULT invoke_function(FunctionInstance *function, LCID lcid, DISPPARAMS *dp,
207         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
208 {
209     IDispatch *this_obj;
210
211     if(!(this_obj = get_this(dp)))
212         this_obj = (IDispatch*)_IDispatchEx_(function->dispex.ctx->script_disp);
213
214     return invoke_source(function, this_obj, lcid, dp, retv, ei, caller);
215 }
216
217 static HRESULT invoke_constructor(FunctionInstance *function, LCID lcid, DISPPARAMS *dp,
218         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
219 {
220     DispatchEx *this_obj;
221     HRESULT hres;
222
223     hres = create_object(function->dispex.ctx, &function->dispex, &this_obj);
224     if(FAILED(hres))
225         return hres;
226
227     hres = invoke_source(function, (IDispatch*)_IDispatchEx_(this_obj), lcid, dp, retv, ei, caller);
228     if(FAILED(hres)) {
229         jsdisp_release(this_obj);
230         return hres;
231     }
232
233     V_VT(retv) = VT_DISPATCH;
234     V_DISPATCH(retv) = (IDispatch*)_IDispatchEx_(this_obj);
235     return S_OK;
236 }
237
238 static HRESULT invoke_value_proc(FunctionInstance *function, LCID lcid, WORD flags, DISPPARAMS *dp,
239         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
240 {
241     DispatchEx *this_obj = NULL;
242     IDispatch *this_disp;
243     HRESULT hres;
244
245     this_disp = get_this(dp);
246     if(this_disp)
247         this_obj = iface_to_jsdisp((IUnknown*)this_disp);
248
249     hres = function->value_proc(this_obj ? this_obj : function->dispex.ctx->script_disp, lcid,
250                                 flags, dp, retv, ei, caller);
251
252     if(this_obj)
253         jsdisp_release(this_obj);
254     return hres;
255 }
256
257 static HRESULT call_function(FunctionInstance *function, IDispatch *this_obj, LCID lcid, DISPPARAMS *args,
258         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
259 {
260     HRESULT hres;
261
262     if(function->value_proc) {
263         DispatchEx *jsthis = NULL;
264
265         if(this_obj) {
266             jsthis = iface_to_jsdisp((IUnknown*)this_obj);
267             if(!jsthis)
268                 FIXME("this_obj is not DispatchEx\n");
269         }
270
271         hres = function->value_proc(jsthis ? jsthis : function->dispex.ctx->script_disp, lcid,
272                 DISPATCH_METHOD, args, retv, ei, caller);
273
274         if(jsthis)
275             jsdisp_release(jsthis);
276     }else {
277         hres = invoke_source(function,
278                 this_obj ? this_obj : (IDispatch*)_IDispatchEx_(function->dispex.ctx->script_disp),
279                 lcid, args, retv, ei, caller);
280     }
281
282     return hres;
283 }
284
285 static HRESULT function_to_string(FunctionInstance *function, BSTR *ret)
286 {
287     BSTR str;
288
289     if(function->value_proc) {
290         FIXME("Builtin functions not implemented\n");
291         return E_NOTIMPL;
292     }
293
294     str = SysAllocStringLen(function->src_str, function->src_len);
295     if(!str)
296         return E_OUTOFMEMORY;
297
298     *ret = str;
299     return S_OK;
300 }
301
302 static HRESULT Function_length(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
303         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
304 {
305     FunctionInstance *This = (FunctionInstance*)dispex;
306
307     TRACE("%p %d\n", This, This->length);
308
309     switch(flags) {
310     case DISPATCH_PROPERTYGET:
311         V_VT(retv) = VT_I4;
312         V_I4(retv) = This->length;
313         break;
314     default:
315         FIXME("unimplemented flags %x\n", flags);
316         return E_NOTIMPL;
317     }
318
319     return S_OK;
320 }
321
322 static HRESULT Function_toString(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
323         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
324 {
325     FunctionInstance *function;
326     BSTR str;
327     HRESULT hres;
328
329     TRACE("\n");
330
331     if(!is_class(dispex, JSCLASS_FUNCTION))
332         return throw_type_error(dispex->ctx, ei, IDS_NOT_FUNC, NULL);
333
334     function = (FunctionInstance*)dispex;
335
336     hres = function_to_string(function, &str);
337     if(FAILED(hres))
338         return hres;
339
340     if(retv) {
341         V_VT(retv) = VT_BSTR;
342         V_BSTR(retv) = str;
343     }else {
344         SysFreeString(str);
345     }
346     return S_OK;
347 }
348
349 static HRESULT array_to_args(DispatchEx *arg_array, LCID lcid, jsexcept_t *ei, IServiceProvider *caller,
350         DISPPARAMS *args)
351 {
352     VARIANT var, *argv;
353     DWORD length, i;
354     HRESULT hres;
355
356     hres = jsdisp_propget_name(arg_array, lengthW, lcid, &var, ei, NULL/*FIXME*/);
357     if(FAILED(hres))
358         return hres;
359
360     hres = to_uint32(arg_array->ctx, &var, ei, &length);
361     VariantClear(&var);
362     if(FAILED(hres))
363         return hres;
364
365     argv = heap_alloc(length * sizeof(VARIANT));
366     if(!argv)
367         return E_OUTOFMEMORY;
368
369     for(i=0; i<length; i++) {
370         hres = jsdisp_propget_idx(arg_array, i, lcid, argv+i, ei, caller);
371         if(FAILED(hres)) {
372             while(i--)
373                 VariantClear(argv+i);
374             heap_free(argv);
375             return hres;
376         }
377     }
378
379     args->cArgs = length;
380     args->rgvarg = argv;
381     return S_OK;
382 }
383
384 static HRESULT Function_apply(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
385         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
386 {
387     FunctionInstance *function;
388     DISPPARAMS args = {NULL,NULL,0,0};
389     DWORD argc, i;
390     IDispatch *this_obj;
391     HRESULT hres = S_OK;
392
393     TRACE("\n");
394
395     if(!is_class(dispex, JSCLASS_FUNCTION)) {
396         FIXME("dispex is not a function\n");
397         return E_FAIL;
398     }
399
400     function = (FunctionInstance*)dispex;
401     argc = arg_cnt(dp);
402
403     if(argc) {
404         hres = to_object(dispex->ctx, get_arg(dp,0), &this_obj);
405         if(FAILED(hres))
406             return hres;
407     }
408
409     if(argc >= 2) {
410         DispatchEx *arg_array = NULL;
411
412         if(V_VT(get_arg(dp,1)) == VT_DISPATCH) {
413             arg_array = iface_to_jsdisp((IUnknown*)V_DISPATCH(get_arg(dp,1)));
414             if(!is_class(arg_array, JSCLASS_ARRAY) && !is_class(arg_array, JSCLASS_ARGUMENTS)) {
415                 jsdisp_release(arg_array);
416                 arg_array = NULL;
417             }
418         }
419
420         if(arg_array) {
421             hres = array_to_args(arg_array, lcid, ei, caller, &args);
422             jsdisp_release(arg_array);
423         }else {
424             FIXME("throw TypeError\n");
425             hres = E_FAIL;
426         }
427     }
428
429     hres = call_function(function, this_obj, lcid, &args, retv, ei, caller);
430
431     if(this_obj)
432         IDispatch_Release(this_obj);
433     for(i=0; i<args.cArgs; i++)
434         VariantClear(args.rgvarg+i);
435     heap_free(args.rgvarg);
436     return hres;
437 }
438
439 static HRESULT Function_call(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
440         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
441 {
442     FunctionInstance *function;
443     DISPPARAMS args = {NULL,NULL,0,0};
444     IDispatch *this_obj = NULL;
445     DWORD argc;
446     HRESULT hres;
447
448     TRACE("\n");
449
450     if(!is_class(dispex, JSCLASS_FUNCTION)) {
451         FIXME("dispex is not a function\n");
452         return E_FAIL;
453     }
454
455     function = (FunctionInstance*)dispex;
456     argc = arg_cnt(dp);
457
458     if(argc) {
459         hres = to_object(dispex->ctx, get_arg(dp,0), &this_obj);
460         if(FAILED(hres))
461             return hres;
462         args.cArgs = argc-1;
463     }
464
465     if(args.cArgs)
466         args.rgvarg = dp->rgvarg + dp->cArgs - args.cArgs-1;
467
468     hres = call_function(function, this_obj, lcid, &args, retv, ei, caller);
469
470     if(this_obj)
471         IDispatch_Release(this_obj);
472     return hres;
473 }
474
475 HRESULT Function_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
476         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
477 {
478     FunctionInstance *function;
479
480     TRACE("\n");
481
482     if(dispex->builtin_info->class != JSCLASS_FUNCTION) {
483         ERR("dispex is not a function\n");
484         return E_FAIL;
485     }
486
487     function = (FunctionInstance*)dispex;
488
489     switch(flags) {
490     case DISPATCH_METHOD:
491         if(function->value_proc)
492             return invoke_value_proc(function, lcid, flags, dp, retv, ei, caller);
493
494         return invoke_function(function, lcid, dp, retv, ei, caller);
495
496     case DISPATCH_PROPERTYGET: {
497         HRESULT hres;
498         BSTR str;
499
500         hres = function_to_string(function, &str);
501         if(FAILED(hres))
502             return hres;
503
504         V_VT(retv) = VT_BSTR;
505         V_BSTR(retv) = str;
506         break;
507     }
508
509     case DISPATCH_CONSTRUCT:
510         if(function->value_proc)
511             return invoke_value_proc(function, lcid, flags, dp, retv, ei, caller);
512
513         return invoke_constructor(function, lcid, dp, retv, ei, caller);
514
515     default:
516         FIXME("not implemented flags %x\n", flags);
517         return E_NOTIMPL;
518     }
519
520     return S_OK;
521 }
522
523 static void Function_destructor(DispatchEx *dispex)
524 {
525     FunctionInstance *This = (FunctionInstance*)dispex;
526
527     if(This->parser)
528         parser_release(This->parser);
529     if(This->scope_chain)
530         scope_release(This->scope_chain);
531     heap_free(This);
532 }
533
534 static const builtin_prop_t Function_props[] = {
535     {applyW,                 Function_apply,                 PROPF_METHOD|2},
536     {callW,                  Function_call,                  PROPF_METHOD|1},
537     {lengthW,                Function_length,                0},
538     {toStringW,              Function_toString,              PROPF_METHOD}
539 };
540
541 static const builtin_info_t Function_info = {
542     JSCLASS_FUNCTION,
543     {NULL, Function_value, 0},
544     sizeof(Function_props)/sizeof(*Function_props),
545     Function_props,
546     Function_destructor,
547     NULL
548 };
549
550 static HRESULT FunctionConstr_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
551         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
552 {
553     FIXME("\n");
554     return E_NOTIMPL;
555 }
556
557 static HRESULT FunctionProt_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
558         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
559 {
560     FIXME("\n");
561     return E_NOTIMPL;
562 }
563
564 static HRESULT create_function(script_ctx_t *ctx, const builtin_info_t *builtin_info, DWORD flags,
565         BOOL funcprot, DispatchEx *prototype, FunctionInstance **ret)
566 {
567     FunctionInstance *function;
568     HRESULT hres;
569
570     function = heap_alloc_zero(sizeof(FunctionInstance));
571     if(!function)
572         return E_OUTOFMEMORY;
573
574     if(funcprot)
575         hres = init_dispex(&function->dispex, ctx, &Function_info, prototype);
576     else if(builtin_info)
577         hres = init_dispex_from_constr(&function->dispex, ctx, builtin_info, ctx->function_constr);
578     else
579         hres = init_dispex_from_constr(&function->dispex, ctx, &Function_info, ctx->function_constr);
580     if(FAILED(hres))
581         return hres;
582
583     function->flags = flags;
584     function->length = flags & PROPF_ARGMASK;
585
586     *ret = function;
587     return S_OK;
588 }
589
590 static HRESULT set_prototype(script_ctx_t *ctx, DispatchEx *dispex, DispatchEx *prototype)
591 {
592     jsexcept_t jsexcept;
593     VARIANT var;
594
595     V_VT(&var) = VT_DISPATCH;
596     V_DISPATCH(&var) = (IDispatch*)_IDispatchEx_(prototype);
597     memset(&jsexcept, 0, sizeof(jsexcept));
598
599     return jsdisp_propput_name(dispex, prototypeW, ctx->lcid, &var, &jsexcept, NULL/*FIXME*/);
600 }
601
602 HRESULT create_builtin_function(script_ctx_t *ctx, builtin_invoke_t value_proc,
603         const builtin_info_t *builtin_info, DWORD flags, DispatchEx *prototype, DispatchEx **ret)
604 {
605     FunctionInstance *function;
606     HRESULT hres;
607
608     hres = create_function(ctx, builtin_info, flags, FALSE, NULL, &function);
609     if(FAILED(hres))
610         return hres;
611
612     hres = set_prototype(ctx, &function->dispex, prototype);
613     if(FAILED(hres)) {
614         jsdisp_release(&function->dispex);
615         return hres;
616     }
617
618     function->value_proc = value_proc;
619
620     *ret = &function->dispex;
621     return S_OK;
622 }
623
624 HRESULT create_source_function(parser_ctx_t *ctx, parameter_t *parameters, source_elements_t *source,
625         scope_chain_t *scope_chain, const WCHAR *src_str, DWORD src_len, DispatchEx **ret)
626 {
627     FunctionInstance *function;
628     DispatchEx *prototype;
629     parameter_t *iter;
630     DWORD length = 0;
631     HRESULT hres;
632
633     hres = create_object(ctx->script, NULL, &prototype);
634     if(FAILED(hres))
635         return hres;
636
637     hres = create_function(ctx->script, NULL, PROPF_CONSTR, FALSE, NULL, &function);
638     if(SUCCEEDED(hres)) {
639         hres = set_prototype(ctx->script, &function->dispex, prototype);
640         if(FAILED(hres))
641             jsdisp_release(&function->dispex);
642     }
643     jsdisp_release(prototype);
644     if(FAILED(hres))
645         return hres;
646
647     function->source = source;
648     function->parameters = parameters;
649
650     if(scope_chain) {
651         scope_addref(scope_chain);
652         function->scope_chain = scope_chain;
653     }
654
655     parser_addref(ctx);
656     function->parser = ctx;
657
658     for(iter = parameters; iter; iter = iter->next)
659         length++;
660     function->length = length;
661
662     function->src_str = src_str;
663     function->src_len = src_len;
664
665     *ret = &function->dispex;
666     return S_OK;
667 }
668
669 HRESULT init_function_constr(script_ctx_t *ctx, DispatchEx *object_prototype)
670 {
671     FunctionInstance *prot, *constr;
672     HRESULT hres;
673
674     hres = create_function(ctx, NULL, PROPF_CONSTR, TRUE, object_prototype, &prot);
675     if(FAILED(hres))
676         return hres;
677
678     prot->value_proc = FunctionProt_value;
679
680     hres = create_function(ctx, NULL, PROPF_CONSTR, TRUE, &prot->dispex, &constr);
681     if(SUCCEEDED(hres)) {
682         constr->value_proc = FunctionConstr_value;
683         hres = set_prototype(ctx, &constr->dispex, &prot->dispex);
684         if(FAILED(hres))
685             jsdisp_release(&constr->dispex);
686     }
687     jsdisp_release(&prot->dispex);
688     if(FAILED(hres))
689         return hres;
690
691     ctx->function_constr = &constr->dispex;
692     return S_OK;
693 }