jscript: Create arguments object as a seaprated class inheriting from Object.
[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 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 function_to_string(FunctionInstance *function, BSTR *ret)
258 {
259     BSTR str;
260
261     if(function->value_proc) {
262         FIXME("Builtin functions not implemented\n");
263         return E_NOTIMPL;
264     }
265
266     str = SysAllocStringLen(function->src_str, function->src_len);
267     if(!str)
268         return E_OUTOFMEMORY;
269
270     *ret = str;
271     return S_OK;
272 }
273
274 static HRESULT Function_length(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
275         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
276 {
277     FunctionInstance *This = (FunctionInstance*)dispex;
278
279     TRACE("%p %d\n", This, This->length);
280
281     switch(flags) {
282     case DISPATCH_PROPERTYGET:
283         V_VT(retv) = VT_I4;
284         V_I4(retv) = This->length;
285         break;
286     default:
287         FIXME("unimplemented flags %x\n", flags);
288         return E_NOTIMPL;
289     }
290
291     return S_OK;
292 }
293
294 static HRESULT Function_toString(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
295         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
296 {
297     FunctionInstance *function;
298     BSTR str;
299     HRESULT hres;
300
301     TRACE("\n");
302
303     if(!is_class(dispex, JSCLASS_FUNCTION))
304         return throw_type_error(dispex->ctx, ei, IDS_NOT_FUNC, NULL);
305
306     function = (FunctionInstance*)dispex;
307
308     hres = function_to_string(function, &str);
309     if(FAILED(hres))
310         return hres;
311
312     if(retv) {
313         V_VT(retv) = VT_BSTR;
314         V_BSTR(retv) = str;
315     }else {
316         SysFreeString(str);
317     }
318     return S_OK;
319 }
320
321 static HRESULT Function_apply(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
322         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
323 {
324     FIXME("\n");
325     return E_NOTIMPL;
326 }
327
328 static HRESULT Function_call(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
329         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
330 {
331     FIXME("\n");
332     return E_NOTIMPL;
333 }
334
335 HRESULT Function_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
336         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
337 {
338     FunctionInstance *function;
339
340     TRACE("\n");
341
342     if(dispex->builtin_info->class != JSCLASS_FUNCTION) {
343         ERR("dispex is not a function\n");
344         return E_FAIL;
345     }
346
347     function = (FunctionInstance*)dispex;
348
349     switch(flags) {
350     case DISPATCH_METHOD:
351         if(function->value_proc)
352             return invoke_value_proc(function, lcid, flags, dp, retv, ei, caller);
353
354         return invoke_function(function, lcid, dp, retv, ei, caller);
355
356     case DISPATCH_PROPERTYGET: {
357         HRESULT hres;
358         BSTR str;
359
360         hres = function_to_string(function, &str);
361         if(FAILED(hres))
362             return hres;
363
364         V_VT(retv) = VT_BSTR;
365         V_BSTR(retv) = str;
366         break;
367     }
368
369     case DISPATCH_CONSTRUCT:
370         if(function->value_proc)
371             return invoke_value_proc(function, lcid, flags, dp, retv, ei, caller);
372
373         return invoke_constructor(function, lcid, dp, retv, ei, caller);
374
375     default:
376         FIXME("not implemented flags %x\n", flags);
377         return E_NOTIMPL;
378     }
379
380     return S_OK;
381 }
382
383 static void Function_destructor(DispatchEx *dispex)
384 {
385     FunctionInstance *This = (FunctionInstance*)dispex;
386
387     if(This->parser)
388         parser_release(This->parser);
389     if(This->scope_chain)
390         scope_release(This->scope_chain);
391     heap_free(This);
392 }
393
394 static const builtin_prop_t Function_props[] = {
395     {applyW,                 Function_apply,                 PROPF_METHOD|2},
396     {callW,                  Function_call,                  PROPF_METHOD|1},
397     {lengthW,                Function_length,                0},
398     {toStringW,              Function_toString,              PROPF_METHOD}
399 };
400
401 static const builtin_info_t Function_info = {
402     JSCLASS_FUNCTION,
403     {NULL, Function_value, 0},
404     sizeof(Function_props)/sizeof(*Function_props),
405     Function_props,
406     Function_destructor,
407     NULL
408 };
409
410 static HRESULT FunctionConstr_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
411         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
412 {
413     FIXME("\n");
414     return E_NOTIMPL;
415 }
416
417 static HRESULT FunctionProt_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
418         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
419 {
420     FIXME("\n");
421     return E_NOTIMPL;
422 }
423
424 static HRESULT create_function(script_ctx_t *ctx, const builtin_info_t *builtin_info, DWORD flags,
425         BOOL funcprot, DispatchEx *prototype, FunctionInstance **ret)
426 {
427     FunctionInstance *function;
428     HRESULT hres;
429
430     function = heap_alloc_zero(sizeof(FunctionInstance));
431     if(!function)
432         return E_OUTOFMEMORY;
433
434     if(funcprot)
435         hres = init_dispex(&function->dispex, ctx, &Function_info, prototype);
436     else if(builtin_info)
437         hres = init_dispex_from_constr(&function->dispex, ctx, builtin_info, ctx->function_constr);
438     else
439         hres = init_dispex_from_constr(&function->dispex, ctx, &Function_info, ctx->function_constr);
440     if(FAILED(hres))
441         return hres;
442
443     function->flags = flags;
444     function->length = flags & PROPF_ARGMASK;
445
446     *ret = function;
447     return S_OK;
448 }
449
450 static HRESULT set_prototype(script_ctx_t *ctx, DispatchEx *dispex, DispatchEx *prototype)
451 {
452     jsexcept_t jsexcept;
453     VARIANT var;
454
455     V_VT(&var) = VT_DISPATCH;
456     V_DISPATCH(&var) = (IDispatch*)_IDispatchEx_(prototype);
457     memset(&jsexcept, 0, sizeof(jsexcept));
458
459     return jsdisp_propput_name(dispex, prototypeW, ctx->lcid, &var, &jsexcept, NULL/*FIXME*/);
460 }
461
462 HRESULT create_builtin_function(script_ctx_t *ctx, builtin_invoke_t value_proc,
463         const builtin_info_t *builtin_info, DWORD flags, DispatchEx *prototype, DispatchEx **ret)
464 {
465     FunctionInstance *function;
466     HRESULT hres;
467
468     hres = create_function(ctx, builtin_info, flags, FALSE, NULL, &function);
469     if(FAILED(hres))
470         return hres;
471
472     hres = set_prototype(ctx, &function->dispex, prototype);
473     if(FAILED(hres)) {
474         jsdisp_release(&function->dispex);
475         return hres;
476     }
477
478     function->value_proc = value_proc;
479
480     *ret = &function->dispex;
481     return S_OK;
482 }
483
484 HRESULT create_source_function(parser_ctx_t *ctx, parameter_t *parameters, source_elements_t *source,
485         scope_chain_t *scope_chain, const WCHAR *src_str, DWORD src_len, DispatchEx **ret)
486 {
487     FunctionInstance *function;
488     DispatchEx *prototype;
489     parameter_t *iter;
490     DWORD length = 0;
491     HRESULT hres;
492
493     hres = create_object(ctx->script, NULL, &prototype);
494     if(FAILED(hres))
495         return hres;
496
497     hres = create_function(ctx->script, NULL, PROPF_CONSTR, FALSE, NULL, &function);
498     if(SUCCEEDED(hres)) {
499         hres = set_prototype(ctx->script, &function->dispex, prototype);
500         if(FAILED(hres))
501             jsdisp_release(&function->dispex);
502     }
503     jsdisp_release(prototype);
504     if(FAILED(hres))
505         return hres;
506
507     function->source = source;
508     function->parameters = parameters;
509
510     if(scope_chain) {
511         scope_addref(scope_chain);
512         function->scope_chain = scope_chain;
513     }
514
515     parser_addref(ctx);
516     function->parser = ctx;
517
518     for(iter = parameters; iter; iter = iter->next)
519         length++;
520     function->length = length;
521
522     function->src_str = src_str;
523     function->src_len = src_len;
524
525     *ret = &function->dispex;
526     return S_OK;
527 }
528
529 HRESULT init_function_constr(script_ctx_t *ctx, DispatchEx *object_prototype)
530 {
531     FunctionInstance *prot, *constr;
532     HRESULT hres;
533
534     hres = create_function(ctx, NULL, PROPF_CONSTR, TRUE, object_prototype, &prot);
535     if(FAILED(hres))
536         return hres;
537
538     prot->value_proc = FunctionProt_value;
539
540     hres = create_function(ctx, NULL, PROPF_CONSTR, TRUE, &prot->dispex, &constr);
541     if(SUCCEEDED(hres)) {
542         constr->value_proc = FunctionConstr_value;
543         hres = set_prototype(ctx, &constr->dispex, &prot->dispex);
544         if(FAILED(hres))
545             jsdisp_release(&constr->dispex);
546     }
547     jsdisp_release(&prot->dispex);
548     if(FAILED(hres))
549         return hres;
550
551     ctx->function_constr = &constr->dispex;
552     return S_OK;
553 }