jscript: Use prototype for builtin String properties.
[wine] / dlls / jscript / object.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
21 #include "wine/debug.h"
22
23 WINE_DEFAULT_DEBUG_CHANNEL(jscript);
24
25 static const WCHAR toStringW[] = {'t','o','S','t','r','i','n','g',0};
26 static const WCHAR toLocaleStringW[] = {'t','o','L','o','c','a','l','e','S','t','r','i','n','g',0};
27 static const WCHAR valueOfW[] = {'v','a','l','u','e','O','f',0};
28 static const WCHAR hasOwnPropertyW[] = {'h','a','s','O','w','n','P','r','o','p','e','r','t','y',0};
29 static const WCHAR propertyIsEnumerableW[] =
30     {'p','r','o','p','e','r','t','y','I','s','E','n','u','m','e','r','a','b','l','e',0};
31 static const WCHAR isPrototypeOfW[] = {'i','s','P','r','o','t','o','t','y','p','e','O','f',0};
32
33 static const WCHAR default_valueW[] = {'[','o','b','j','e','c','t',' ','O','b','j','e','c','t',']',0};
34
35 static HRESULT Object_toString(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, VARIANT *argv,
36         VARIANT *retv, jsexcept_t *ei)
37 {
38     jsdisp_t *jsdisp;
39     const WCHAR *str;
40
41     static const WCHAR formatW[] = {'[','o','b','j','e','c','t',' ','%','s',']',0};
42
43     static const WCHAR arrayW[] = {'A','r','r','a','y',0};
44     static const WCHAR booleanW[] = {'B','o','o','l','e','a','n',0};
45     static const WCHAR dateW[] = {'D','a','t','e',0};
46     static const WCHAR errorW[] = {'E','r','r','o','r',0};
47     static const WCHAR functionW[] = {'F','u','n','c','t','i','o','n',0};
48     static const WCHAR mathW[] = {'M','a','t','h',0};
49     static const WCHAR numberW[] = {'N','u','m','b','e','r',0};
50     static const WCHAR objectW[] = {'O','b','j','e','c','t',0};
51     static const WCHAR regexpW[] = {'R','e','g','E','x','p',0};
52     static const WCHAR stringW[] = {'S','t','r','i','n','g',0};
53     /* Keep in sync with jsclass_t enum */
54     static const WCHAR *names[] = {objectW, arrayW, booleanW, dateW, errorW,
55         functionW, NULL, mathW, numberW, objectW, regexpW, stringW, objectW, objectW};
56
57     TRACE("\n");
58
59     jsdisp = get_jsdisp(jsthis);
60     if(!jsdisp) {
61         str = objectW;
62     }else if(names[jsdisp->builtin_info->class]) {
63         str = names[jsdisp->builtin_info->class];
64     }else {
65         FIXME("jdisp->builtin_info->class = %d\n", jsdisp->builtin_info->class);
66         return E_FAIL;
67     }
68
69     if(retv) {
70         V_VT(retv) = VT_BSTR;
71         V_BSTR(retv) = SysAllocStringLen(NULL, 9+strlenW(str));
72         if(!V_BSTR(retv))
73             return E_OUTOFMEMORY;
74
75         sprintfW(V_BSTR(retv), formatW, str);
76     }
77
78     return S_OK;
79 }
80
81 static HRESULT Object_toLocaleString(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, VARIANT *argv,
82         VARIANT *retv, jsexcept_t *ei)
83 {
84     TRACE("\n");
85
86     if(!is_jsdisp(jsthis)) {
87         FIXME("Host object this\n");
88         return E_FAIL;
89     }
90
91     return jsdisp_call_name(jsthis->u.jsdisp, toStringW, DISPATCH_METHOD, 0, NULL, retv, ei);
92 }
93
94 static HRESULT Object_valueOf(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, VARIANT *argv,
95         VARIANT *retv, jsexcept_t *ei)
96 {
97     TRACE("\n");
98
99     if(retv) {
100         IDispatch_AddRef(jsthis->u.disp);
101
102         V_VT(retv) = VT_DISPATCH;
103         V_DISPATCH(retv) = jsthis->u.disp;
104     }
105
106     return S_OK;
107 }
108
109 static HRESULT Object_hasOwnProperty(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, VARIANT *argv,
110         VARIANT *retv, jsexcept_t *ei)
111 {
112     BSTR name;
113     DISPID id;
114     HRESULT hres;
115
116     TRACE("\n");
117
118     if(!argc) {
119         if(retv) {
120             V_VT(retv) = VT_BOOL;
121             V_BOOL(retv) = VARIANT_FALSE;
122         }
123
124         return S_OK;
125     }
126
127     hres = to_string(ctx, argv, ei, &name);
128     if(FAILED(hres))
129         return hres;
130
131     if(is_jsdisp(jsthis)) {
132         VARIANT_BOOL result;
133
134         hres = jsdisp_is_own_prop(jsthis->u.jsdisp, name, &result);
135         if(FAILED(hres))
136             return hres;
137
138         if(retv) {
139             V_VT(retv) = VT_BOOL;
140             V_BOOL(retv) = result;
141         }
142
143         return S_OK;
144     }
145
146     if(is_dispex(jsthis)) {
147         hres = IDispatchEx_GetDispID(jsthis->u.dispex, name,
148                 make_grfdex(ctx, fdexNameCaseSensitive), &id);
149     } else {
150         hres = IDispatch_GetIDsOfNames(jsthis->u.disp, &IID_NULL,
151                 &name, 1, ctx->lcid, &id);
152     }
153
154     if(retv) {
155         V_VT(retv) = VT_BOOL;
156         V_BOOL(retv) = SUCCEEDED(hres) ? VARIANT_TRUE : VARIANT_FALSE;
157     }
158     return S_OK;
159 }
160
161 static HRESULT Object_propertyIsEnumerable(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, VARIANT *argv,
162         VARIANT *retv, jsexcept_t *ei)
163 {
164     FIXME("\n");
165     return E_NOTIMPL;
166 }
167
168 static HRESULT Object_isPrototypeOf(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, VARIANT *argv,
169         VARIANT *retv, jsexcept_t *ei)
170 {
171     FIXME("\n");
172     return E_NOTIMPL;
173 }
174
175 static HRESULT Object_value(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, VARIANT *argv,
176         VARIANT *retv, jsexcept_t *ei)
177 {
178     TRACE("\n");
179
180     switch(flags) {
181     case INVOKE_FUNC:
182         return throw_type_error(ctx, ei, JS_E_FUNCTION_EXPECTED, NULL);
183     case DISPATCH_PROPERTYGET:
184         V_VT(retv) = VT_BSTR;
185         V_BSTR(retv) = SysAllocString(default_valueW);
186         if(!V_BSTR(retv))
187             return E_OUTOFMEMORY;
188         break;
189     default:
190         FIXME("unimplemented flags %x\n", flags);
191         return E_NOTIMPL;
192     }
193
194     return S_OK;
195 }
196
197 static void Object_destructor(jsdisp_t *dispex)
198 {
199     heap_free(dispex);
200 }
201
202 static const builtin_prop_t Object_props[] = {
203     {hasOwnPropertyW,        Object_hasOwnProperty,        PROPF_METHOD|1},
204     {isPrototypeOfW,         Object_isPrototypeOf,         PROPF_METHOD|1},
205     {propertyIsEnumerableW,  Object_propertyIsEnumerable,  PROPF_METHOD|1},
206     {toLocaleStringW,        Object_toLocaleString,        PROPF_METHOD},
207     {toStringW,              Object_toString,              PROPF_METHOD},
208     {valueOfW,               Object_valueOf,               PROPF_METHOD}
209 };
210
211 static const builtin_info_t Object_info = {
212     JSCLASS_OBJECT,
213     {NULL, Object_value, 0},
214     sizeof(Object_props)/sizeof(*Object_props),
215     Object_props,
216     Object_destructor,
217     NULL
218 };
219
220 static const builtin_info_t ObjectInst_info = {
221     JSCLASS_OBJECT,
222     {NULL, Object_value, 0},
223     0, NULL,
224     Object_destructor,
225     NULL
226 };
227
228 static HRESULT ObjectConstr_value(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, VARIANT *argv,
229         VARIANT *retv, jsexcept_t *ei)
230 {
231     HRESULT hres;
232
233     TRACE("\n");
234
235     switch(flags) {
236     case DISPATCH_METHOD:
237         if(argc) {
238             if(V_VT(argv) != VT_EMPTY && V_VT(argv) != VT_NULL && (V_VT(argv) != VT_DISPATCH || V_DISPATCH(argv))) {
239                 IDispatch *disp;
240
241                 hres = to_object(ctx, argv, &disp);
242                 if(FAILED(hres))
243                     return hres;
244
245                 if(retv) {
246                     V_VT(retv) = VT_DISPATCH;
247                     V_DISPATCH(retv) = disp;
248                 }else {
249                     IDispatch_Release(disp);
250                 }
251                 return S_OK;
252             }
253         }
254         /* fall through */
255     case DISPATCH_CONSTRUCT: {
256         jsdisp_t *obj;
257
258         hres = create_object(ctx, NULL, &obj);
259         if(FAILED(hres))
260             return hres;
261
262         if(retv)
263             var_set_jsdisp(retv, obj);
264         else
265             jsdisp_release(obj);
266         break;
267     }
268
269     default:
270         FIXME("unimplemented flags: %x\n", flags);
271         return E_NOTIMPL;
272     }
273
274     return S_OK;
275 }
276
277 HRESULT create_object_constr(script_ctx_t *ctx, jsdisp_t *object_prototype, jsdisp_t **ret)
278 {
279     static const WCHAR ObjectW[] = {'O','b','j','e','c','t',0};
280
281     return create_builtin_constructor(ctx, ObjectConstr_value, ObjectW, NULL, PROPF_CONSTR,
282             object_prototype, ret);
283 }
284
285 HRESULT create_object_prototype(script_ctx_t *ctx, jsdisp_t **ret)
286 {
287     return create_dispex(ctx, &Object_info, NULL, ret);
288 }
289
290 HRESULT create_object(script_ctx_t *ctx, jsdisp_t *constr, jsdisp_t **ret)
291 {
292     jsdisp_t *object;
293     HRESULT hres;
294
295     object = heap_alloc_zero(sizeof(jsdisp_t));
296     if(!object)
297         return E_OUTOFMEMORY;
298
299     hres = init_dispex_from_constr(object, ctx, &ObjectInst_info, constr ? constr : ctx->object_constr);
300     if(FAILED(hres)) {
301         heap_free(object);
302         return hres;
303     }
304
305     *ret = object;
306     return S_OK;
307 }