jscript: Inherit some Number functions 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 toLocaleStringW[] = {'t','o','L','o','c','a','l','e','S','t','r','i','n','g',0};
44 static const WCHAR applyW[] = {'a','p','p','l','y',0};
45 static const WCHAR callW[] = {'c','a','l','l',0};
46 static const WCHAR hasOwnPropertyW[] = {'h','a','s','O','w','n','P','r','o','p','e','r','t','y',0};
47 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};
48 static const WCHAR isPrototypeOfW[] = {'i','s','P','r','o','t','o','t','y','p','e','O','f',0};
49
50 static IDispatch *get_this(DISPPARAMS *dp)
51 {
52     DWORD i;
53
54     for(i=0; i < dp->cNamedArgs; i++) {
55         if(dp->rgdispidNamedArgs[i] == DISPID_THIS) {
56             if(V_VT(dp->rgvarg+i) == VT_DISPATCH)
57                 return V_DISPATCH(dp->rgvarg+i);
58
59             WARN("This is not VT_DISPATCH\n");
60             return NULL;
61         }
62     }
63
64     TRACE("no this passed\n");
65     return NULL;
66 }
67
68 static HRESULT init_parameters(DispatchEx *var_disp, FunctionInstance *function, LCID lcid, DISPPARAMS *dp,
69         jsexcept_t *ei, IServiceProvider *caller)
70 {
71     parameter_t *param;
72     VARIANT var_empty;
73     DWORD cargs, i=0;
74     HRESULT hres;
75
76     V_VT(&var_empty) = VT_EMPTY;
77     cargs = dp->cArgs - dp->cNamedArgs;
78
79     for(param = function->parameters; param; param = param->next) {
80         hres = jsdisp_propput_name(var_disp, param->identifier, lcid,
81                 i < cargs ? dp->rgvarg + dp->cArgs-1 - i : &var_empty,
82                 ei, caller);
83         if(FAILED(hres))
84             return hres;
85
86         i++;
87     }
88
89     return S_OK;
90 }
91
92 static HRESULT init_arguments(DispatchEx *arg_disp, FunctionInstance *function, LCID lcid, DISPPARAMS *dp,
93         jsexcept_t *ei, IServiceProvider *caller)
94 {
95     VARIANT var;
96     DWORD i;
97     HRESULT hres;
98
99     for(i=0; i < dp->cArgs-dp->cNamedArgs; i++) {
100         hres = jsdisp_propput_idx(arg_disp, i, lcid, dp->rgvarg+dp->cArgs-1-i, ei, caller);
101         if(FAILED(hres))
102             return hres;
103     }
104
105     V_VT(&var) = VT_I4;
106     V_I4(&var) = dp->cArgs - dp->cNamedArgs;
107     return jsdisp_propput_name(arg_disp, lengthW, lcid, &var, ei, caller);
108 }
109
110 static HRESULT create_var_disp(FunctionInstance *function, LCID lcid, DISPPARAMS *dp, jsexcept_t *ei,
111                                IServiceProvider *caller, DispatchEx **ret)
112 {
113     DispatchEx *var_disp, *arg_disp;
114     HRESULT hres;
115
116     static const WCHAR argumentsW[] = {'a','r','g','u','m','e','n','t','s',0};
117
118     hres = create_dispex(function->dispex.ctx, NULL, NULL, &var_disp);
119     if(FAILED(hres))
120         return hres;
121
122     hres = create_dispex(function->dispex.ctx, NULL, NULL, &arg_disp);
123     if(SUCCEEDED(hres)) {
124         hres = init_arguments(arg_disp, function, lcid, dp, ei, caller);
125         if(SUCCEEDED(hres)) {
126             VARIANT var;
127
128             V_VT(&var) = VT_DISPATCH;
129             V_DISPATCH(&var) = (IDispatch*)_IDispatchEx_(arg_disp);
130             hres = jsdisp_propput_name(var_disp, argumentsW, lcid, &var, ei, caller);
131         }
132
133         jsdisp_release(arg_disp);
134     }
135
136     if(SUCCEEDED(hres))
137         hres = init_parameters(var_disp, function, lcid, dp, ei, caller);
138     if(FAILED(hres)) {
139         jsdisp_release(var_disp);
140         return hres;
141     }
142
143     *ret = var_disp;
144     return S_OK;
145 }
146
147 static HRESULT invoke_source(FunctionInstance *function, IDispatch *this_obj, LCID lcid, DISPPARAMS *dp,
148         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
149 {
150     DispatchEx *var_disp;
151     exec_ctx_t *exec_ctx;
152     scope_chain_t *scope;
153     HRESULT hres;
154
155     if(!function->source) {
156         FIXME("no source\n");
157         return E_FAIL;
158     }
159
160     hres = create_var_disp(function, lcid, dp, ei, caller, &var_disp);
161     if(FAILED(hres))
162         return hres;
163
164     hres = scope_push(function->scope_chain, var_disp, &scope);
165     if(SUCCEEDED(hres)) {
166         hres = create_exec_ctx(this_obj, var_disp, scope, &exec_ctx);
167         scope_release(scope);
168     }
169     if(FAILED(hres))
170         return hres;
171
172     hres = exec_source(exec_ctx, function->parser, function->source, ei, retv);
173     exec_release(exec_ctx);
174
175     return hres;
176 }
177
178 static HRESULT invoke_function(FunctionInstance *function, LCID lcid, DISPPARAMS *dp,
179         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
180 {
181     IDispatch *this_obj;
182
183     if(!(this_obj = get_this(dp)))
184         this_obj = (IDispatch*)_IDispatchEx_(function->dispex.ctx->script_disp);
185
186     return invoke_source(function, this_obj, lcid, dp, retv, ei, caller);
187 }
188
189 static HRESULT invoke_constructor(FunctionInstance *function, LCID lcid, DISPPARAMS *dp,
190         VARIANT *retv, jsexcept_t *ei, IServiceProvider *caller)
191 {
192     DispatchEx *this_obj;
193     HRESULT hres;
194
195     hres = create_object(function->dispex.ctx, &function->dispex, &this_obj);
196     if(FAILED(hres))
197         return hres;
198
199     hres = invoke_source(function, (IDispatch*)_IDispatchEx_(this_obj), lcid, dp, retv, ei, caller);
200     if(FAILED(hres)) {
201         jsdisp_release(this_obj);
202         return hres;
203     }
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         return throw_type_error(dispex->ctx, ei, IDS_NOT_FUNC, NULL);
277
278     function = (FunctionInstance*)dispex;
279
280     hres = function_to_string(function, &str);
281     if(FAILED(hres))
282         return hres;
283
284     if(retv) {
285         V_VT(retv) = VT_BSTR;
286         V_BSTR(retv) = str;
287     }else {
288         SysFreeString(str);
289     }
290     return S_OK;
291 }
292
293 static HRESULT Function_toLocaleString(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
294         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
295 {
296     FIXME("\n");
297     return E_NOTIMPL;
298 }
299
300 static HRESULT Function_apply(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
301         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
302 {
303     FIXME("\n");
304     return E_NOTIMPL;
305 }
306
307 static HRESULT Function_call(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
308         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
309 {
310     FIXME("\n");
311     return E_NOTIMPL;
312 }
313
314 static HRESULT Function_hasOwnProperty(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
315         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
316 {
317     FIXME("\n");
318     return E_NOTIMPL;
319 }
320
321 static HRESULT Function_propertyIsEnumerable(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_isPrototypeOf(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},
396     {callW,                  Function_call,                  PROPF_METHOD},
397     {hasOwnPropertyW,        Function_hasOwnProperty,        PROPF_METHOD},
398     {isPrototypeOfW,         Function_isPrototypeOf,         PROPF_METHOD},
399     {lengthW,                Function_length,                0},
400     {propertyIsEnumerableW,  Function_propertyIsEnumerable,  PROPF_METHOD},
401     {toLocaleStringW,        Function_toLocaleString,        PROPF_METHOD},
402     {toStringW,              Function_toString,              PROPF_METHOD}
403 };
404
405 static const builtin_info_t Function_info = {
406     JSCLASS_FUNCTION,
407     {NULL, Function_value, 0},
408     sizeof(Function_props)/sizeof(*Function_props),
409     Function_props,
410     Function_destructor,
411     NULL
412 };
413
414 static HRESULT FunctionConstr_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
415         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
416 {
417     FIXME("\n");
418     return E_NOTIMPL;
419 }
420
421 static HRESULT FunctionProt_value(DispatchEx *dispex, LCID lcid, WORD flags, DISPPARAMS *dp,
422         VARIANT *retv, jsexcept_t *ei, IServiceProvider *sp)
423 {
424     FIXME("\n");
425     return E_NOTIMPL;
426 }
427
428 static HRESULT create_function(script_ctx_t *ctx, const builtin_info_t *builtin_info, DWORD flags,
429         BOOL funcprot, DispatchEx *prototype, FunctionInstance **ret)
430 {
431     FunctionInstance *function;
432     HRESULT hres;
433
434     function = heap_alloc_zero(sizeof(FunctionInstance));
435     if(!function)
436         return E_OUTOFMEMORY;
437
438     if(funcprot)
439         hres = init_dispex(&function->dispex, ctx, &Function_info, prototype);
440     else if(builtin_info)
441         hres = init_dispex_from_constr(&function->dispex, ctx, builtin_info, ctx->function_constr);
442     else
443         hres = init_dispex_from_constr(&function->dispex, ctx, &Function_info, ctx->function_constr);
444     if(FAILED(hres))
445         return hres;
446
447     function->flags = flags;
448     function->length = flags & PROPF_ARGMASK;
449
450     *ret = function;
451     return S_OK;
452 }
453
454 static HRESULT set_prototype(script_ctx_t *ctx, DispatchEx *dispex, DispatchEx *prototype)
455 {
456     jsexcept_t jsexcept;
457     VARIANT var;
458
459     V_VT(&var) = VT_DISPATCH;
460     V_DISPATCH(&var) = (IDispatch*)_IDispatchEx_(prototype);
461     memset(&jsexcept, 0, sizeof(jsexcept));
462
463     return jsdisp_propput_name(dispex, prototypeW, ctx->lcid, &var, &jsexcept, NULL/*FIXME*/);
464 }
465
466 HRESULT create_builtin_function(script_ctx_t *ctx, builtin_invoke_t value_proc,
467         const builtin_info_t *builtin_info, DWORD flags, DispatchEx *prototype, DispatchEx **ret)
468 {
469     FunctionInstance *function;
470     HRESULT hres;
471
472     hres = create_function(ctx, builtin_info, flags, FALSE, NULL, &function);
473     if(FAILED(hres))
474         return hres;
475
476     hres = set_prototype(ctx, &function->dispex, prototype);
477     if(FAILED(hres)) {
478         jsdisp_release(&function->dispex);
479         return hres;
480     }
481
482     function->value_proc = value_proc;
483
484     *ret = &function->dispex;
485     return S_OK;
486 }
487
488 HRESULT create_source_function(parser_ctx_t *ctx, parameter_t *parameters, source_elements_t *source,
489         scope_chain_t *scope_chain, const WCHAR *src_str, DWORD src_len, DispatchEx **ret)
490 {
491     FunctionInstance *function;
492     DispatchEx *prototype;
493     parameter_t *iter;
494     DWORD length = 0;
495     HRESULT hres;
496
497     hres = create_object(ctx->script, NULL, &prototype);
498     if(FAILED(hres))
499         return hres;
500
501     hres = create_function(ctx->script, NULL, PROPF_CONSTR, FALSE, NULL, &function);
502     if(SUCCEEDED(hres)) {
503         hres = set_prototype(ctx->script, &function->dispex, prototype);
504         if(FAILED(hres))
505             jsdisp_release(&function->dispex);
506     }
507     jsdisp_release(prototype);
508     if(FAILED(hres))
509         return hres;
510
511     function->source = source;
512     function->parameters = parameters;
513
514     if(scope_chain) {
515         scope_addref(scope_chain);
516         function->scope_chain = scope_chain;
517     }
518
519     parser_addref(ctx);
520     function->parser = ctx;
521
522     for(iter = parameters; iter; iter = iter->next)
523         length++;
524     function->length = length;
525
526     function->src_str = src_str;
527     function->src_len = src_len;
528
529     *ret = &function->dispex;
530     return S_OK;
531 }
532
533 HRESULT init_function_constr(script_ctx_t *ctx, DispatchEx *object_prototype)
534 {
535     FunctionInstance *prot, *constr;
536     HRESULT hres;
537
538     hres = create_function(ctx, NULL, PROPF_CONSTR, TRUE, object_prototype, &prot);
539     if(FAILED(hres))
540         return hres;
541
542     prot->value_proc = FunctionProt_value;
543
544     hres = create_function(ctx, NULL, PROPF_CONSTR, TRUE, &prot->dispex, &constr);
545     if(SUCCEEDED(hres)) {
546         constr->value_proc = FunctionConstr_value;
547         hres = set_prototype(ctx, &constr->dispex, &prot->dispex);
548         if(FAILED(hres))
549             jsdisp_release(&constr->dispex);
550     }
551     jsdisp_release(&prot->dispex);
552     if(FAILED(hres))
553         return hres;
554
555     ctx->function_constr = &constr->dispex;
556     return S_OK;
557 }