[ES6] Add support for toStringTag
[WebKit-https.git] / Source / JavaScriptCore / runtime / ObjectPrototype.cpp
1 /*
2  *  Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2008, 2011 Apple Inc. All rights reserved.
4  *
5  *  This library is free software; you can redistribute it and/or
6  *  modify it under the terms of the GNU Lesser General Public
7  *  License as published by the Free Software Foundation; either
8  *  version 2 of the License, or (at your option) any later version.
9  *
10  *  This library is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  *  Lesser General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Lesser General Public
16  *  License along with this library; if not, write to the Free Software
17  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18  *
19  */
20
21 #include "config.h"
22 #include "ObjectPrototype.h"
23
24 #include "Error.h"
25 #include "GetterSetter.h"
26 #include "JSFunction.h"
27 #include "JSString.h"
28 #include "JSCInlines.h"
29 #include "PropertySlot.h"
30 #include "StructureRareDataInlines.h"
31
32 namespace JSC {
33
34 static EncodedJSValue JSC_HOST_CALL objectProtoFuncValueOf(ExecState*);
35 static EncodedJSValue JSC_HOST_CALL objectProtoFuncHasOwnProperty(ExecState*);
36 static EncodedJSValue JSC_HOST_CALL objectProtoFuncIsPrototypeOf(ExecState*);
37 static EncodedJSValue JSC_HOST_CALL objectProtoFuncDefineGetter(ExecState*);
38 static EncodedJSValue JSC_HOST_CALL objectProtoFuncDefineSetter(ExecState*);
39 static EncodedJSValue JSC_HOST_CALL objectProtoFuncLookupGetter(ExecState*);
40 static EncodedJSValue JSC_HOST_CALL objectProtoFuncLookupSetter(ExecState*);
41 static EncodedJSValue JSC_HOST_CALL objectProtoFuncPropertyIsEnumerable(ExecState*);
42 static EncodedJSValue JSC_HOST_CALL objectProtoFuncToLocaleString(ExecState*);
43
44 STATIC_ASSERT_IS_TRIVIALLY_DESTRUCTIBLE(ObjectPrototype);
45
46 const ClassInfo ObjectPrototype::s_info = { "Object", &JSNonFinalObject::s_info, 0, CREATE_METHOD_TABLE(ObjectPrototype) };
47
48 ObjectPrototype::ObjectPrototype(VM& vm, Structure* stucture)
49     : JSNonFinalObject(vm, stucture)
50 {
51 }
52
53 void ObjectPrototype::finishCreation(VM& vm, JSGlobalObject* globalObject)
54 {
55     Base::finishCreation(vm);
56     ASSERT(inherits(info()));
57     vm.prototypeMap.addPrototype(this);
58     
59     JSC_NATIVE_FUNCTION(vm.propertyNames->toString, objectProtoFuncToString, DontEnum, 0);
60     JSC_NATIVE_FUNCTION(vm.propertyNames->toLocaleString, objectProtoFuncToLocaleString, DontEnum, 0);
61     JSC_NATIVE_FUNCTION(vm.propertyNames->valueOf, objectProtoFuncValueOf, DontEnum, 0);
62     JSC_NATIVE_FUNCTION(vm.propertyNames->hasOwnProperty, objectProtoFuncHasOwnProperty, DontEnum, 1);
63     JSC_NATIVE_FUNCTION(vm.propertyNames->propertyIsEnumerable, objectProtoFuncPropertyIsEnumerable, DontEnum, 1);
64     JSC_NATIVE_FUNCTION(vm.propertyNames->isPrototypeOf, objectProtoFuncIsPrototypeOf, DontEnum, 1);
65     JSC_NATIVE_FUNCTION(vm.propertyNames->__defineGetter__, objectProtoFuncDefineGetter, DontEnum, 2);
66     JSC_NATIVE_FUNCTION(vm.propertyNames->__defineSetter__, objectProtoFuncDefineSetter, DontEnum, 2);
67     JSC_NATIVE_FUNCTION(vm.propertyNames->__lookupGetter__, objectProtoFuncLookupGetter, DontEnum, 1);
68     JSC_NATIVE_FUNCTION(vm.propertyNames->__lookupSetter__, objectProtoFuncLookupSetter, DontEnum, 1);
69 }
70
71 ObjectPrototype* ObjectPrototype::create(VM& vm, JSGlobalObject* globalObject, Structure* structure)
72 {
73     ObjectPrototype* prototype = new (NotNull, allocateCell<ObjectPrototype>(vm.heap)) ObjectPrototype(vm, structure);
74     prototype->finishCreation(vm, globalObject);
75     return prototype;
76 }
77
78 // ------------------------------ Functions --------------------------------
79
80 EncodedJSValue JSC_HOST_CALL objectProtoFuncValueOf(ExecState* exec)
81 {
82     JSValue thisValue = exec->thisValue().toThis(exec, StrictMode);
83     return JSValue::encode(thisValue.toObject(exec));
84 }
85
86 EncodedJSValue JSC_HOST_CALL objectProtoFuncHasOwnProperty(ExecState* exec)
87 {
88     JSValue thisValue = exec->thisValue().toThis(exec, StrictMode);
89     auto propertyName = exec->argument(0).toPropertyKey(exec);
90     if (exec->hadException())
91         return JSValue::encode(jsUndefined());
92     return JSValue::encode(jsBoolean(thisValue.toObject(exec)->hasOwnProperty(exec, propertyName)));
93 }
94
95 EncodedJSValue JSC_HOST_CALL objectProtoFuncIsPrototypeOf(ExecState* exec)
96 {
97     JSValue thisValue = exec->thisValue().toThis(exec, StrictMode);
98     JSObject* thisObj = thisValue.toObject(exec);
99
100     if (!exec->argument(0).isObject())
101         return JSValue::encode(jsBoolean(false));
102
103     JSValue v = asObject(exec->argument(0))->prototype();
104
105     while (true) {
106         if (!v.isObject())
107             return JSValue::encode(jsBoolean(false));
108         if (v == thisObj)
109             return JSValue::encode(jsBoolean(true));
110         v = asObject(v)->prototype();
111     }
112 }
113
114 EncodedJSValue JSC_HOST_CALL objectProtoFuncDefineGetter(ExecState* exec)
115 {
116     JSObject* thisObject = exec->thisValue().toThis(exec, StrictMode).toObject(exec);
117     if (exec->hadException())
118         return JSValue::encode(jsUndefined());
119
120     JSValue get = exec->argument(1);
121     CallData callData;
122     if (getCallData(get, callData) == CallTypeNone)
123         return throwVMError(exec, createTypeError(exec, ASCIILiteral("invalid getter usage")));
124
125     auto propertyName = exec->argument(0).toPropertyKey(exec);
126     if (exec->hadException())
127         return JSValue::encode(jsUndefined());
128
129     PropertyDescriptor descriptor;
130     descriptor.setGetter(get);
131     descriptor.setEnumerable(true);
132     descriptor.setConfigurable(true);
133
134     bool shouldThrow = false;
135     thisObject->methodTable(exec->vm())->defineOwnProperty(thisObject, exec, propertyName, descriptor, shouldThrow);
136
137     return JSValue::encode(jsUndefined());
138 }
139
140 EncodedJSValue JSC_HOST_CALL objectProtoFuncDefineSetter(ExecState* exec)
141 {
142     JSObject* thisObject = exec->thisValue().toThis(exec, StrictMode).toObject(exec);
143     if (exec->hadException())
144         return JSValue::encode(jsUndefined());
145
146     JSValue set = exec->argument(1);
147     CallData callData;
148     if (getCallData(set, callData) == CallTypeNone)
149         return throwVMError(exec, createTypeError(exec, ASCIILiteral("invalid setter usage")));
150
151     auto propertyName = exec->argument(0).toPropertyKey(exec);
152     if (exec->hadException())
153         return JSValue::encode(jsUndefined());
154
155     PropertyDescriptor descriptor;
156     descriptor.setSetter(set);
157     descriptor.setEnumerable(true);
158     descriptor.setConfigurable(true);
159
160     bool shouldThrow = false;
161     thisObject->methodTable(exec->vm())->defineOwnProperty(thisObject, exec, propertyName, descriptor, shouldThrow);
162
163     return JSValue::encode(jsUndefined());
164 }
165
166 EncodedJSValue JSC_HOST_CALL objectProtoFuncLookupGetter(ExecState* exec)
167 {
168     JSObject* thisObject = exec->thisValue().toThis(exec, StrictMode).toObject(exec);
169     if (exec->hadException())
170         return JSValue::encode(jsUndefined());
171
172     auto propertyName = exec->argument(0).toPropertyKey(exec);
173     if (exec->hadException())
174         return JSValue::encode(jsUndefined());
175
176     PropertySlot slot(thisObject);
177     if (thisObject->getPropertySlot(exec, propertyName, slot) && slot.isAccessor()) {
178         GetterSetter* getterSetter = slot.getterSetter();
179         return getterSetter->isGetterNull() ? JSValue::encode(jsUndefined()) : JSValue::encode(getterSetter->getter());
180     }
181
182     return JSValue::encode(jsUndefined());
183 }
184
185 EncodedJSValue JSC_HOST_CALL objectProtoFuncLookupSetter(ExecState* exec)
186 {
187     JSObject* thisObject = exec->thisValue().toThis(exec, StrictMode).toObject(exec);
188     if (exec->hadException())
189         return JSValue::encode(jsUndefined());
190
191     auto propertyName = exec->argument(0).toPropertyKey(exec);
192     if (exec->hadException())
193         return JSValue::encode(jsUndefined());
194
195     PropertySlot slot(thisObject);
196     if (thisObject->getPropertySlot(exec, propertyName, slot) && slot.isAccessor()) {
197         GetterSetter* getterSetter = slot.getterSetter();
198         return getterSetter->isSetterNull() ? JSValue::encode(jsUndefined()) : JSValue::encode(getterSetter->setter());
199     }
200
201     return JSValue::encode(jsUndefined());
202 }
203
204 EncodedJSValue JSC_HOST_CALL objectProtoFuncPropertyIsEnumerable(ExecState* exec)
205 {
206     auto propertyName = exec->argument(0).toPropertyKey(exec);
207     if (exec->hadException())
208         return JSValue::encode(jsUndefined());
209
210     JSObject* thisObject = exec->thisValue().toThis(exec, StrictMode).toObject(exec);
211     if (exec->hadException())
212         return JSValue::encode(jsUndefined());
213     PropertyDescriptor descriptor;
214     bool enumerable = thisObject->getOwnPropertyDescriptor(exec, propertyName, descriptor) && descriptor.enumerable();
215     return JSValue::encode(jsBoolean(enumerable));
216 }
217
218 // 15.2.4.3 Object.prototype.toLocaleString()
219 EncodedJSValue JSC_HOST_CALL objectProtoFuncToLocaleString(ExecState* exec)
220 {
221     // 1. Let O be the result of calling ToObject passing the this value as the argument.
222     JSObject* object = exec->thisValue().toThis(exec, StrictMode).toObject(exec);
223     if (exec->hadException())
224         return JSValue::encode(jsUndefined());
225
226     // 2. Let toString be the result of calling the [[Get]] internal method of O passing "toString" as the argument.
227     JSValue toString = object->get(exec, exec->propertyNames().toString);
228
229     // 3. If IsCallable(toString) is false, throw a TypeError exception.
230     CallData callData;
231     CallType callType = getCallData(toString, callData);
232     if (callType == CallTypeNone)
233         return JSValue::encode(jsUndefined());
234
235     // 4. Return the result of calling the [[Call]] internal method of toString passing O as the this value and no arguments.
236     return JSValue::encode(call(exec, toString, callType, callData, object, exec->emptyList()));
237 }
238
239 EncodedJSValue JSC_HOST_CALL objectProtoFuncToString(ExecState* exec)
240 {
241     VM& vm = exec->vm();
242     JSValue thisValue = exec->thisValue().toThis(exec, StrictMode);
243     if (thisValue.isUndefinedOrNull())
244         return JSValue::encode(thisValue.isUndefined() ? vm.smallStrings.undefinedObjectString() : vm.smallStrings.nullObjectString());
245     JSObject* thisObject = thisValue.toObject(exec);
246
247     JSValue stringTag = thisObject->get(exec, exec->propertyNames().toStringTagSymbol);
248     if (stringTag.isString()) {
249         JSRopeString::RopeBuilder ropeBuilder(vm);
250         ropeBuilder.append(vm.smallStrings.objectStringStart());
251         ropeBuilder.append(jsCast<JSString*>(stringTag));
252         ropeBuilder.append(vm.smallStrings.singleCharacterString(']'));
253         return JSValue::encode(ropeBuilder.release());
254     }
255
256     JSString* result = thisObject->structure(vm)->objectToStringValue();
257     if (!result) {
258         String newString = WTF::tryMakeString("[object ", thisObject->methodTable(exec->vm())->className(thisObject), "]");
259         if (!newString)
260             return JSValue::encode(throwOutOfMemoryError(exec));
261
262         result = jsNontrivialString(&vm, newString);
263         thisObject->structure(vm)->setObjectToStringValue(vm, result);
264     }
265     return JSValue::encode(result);
266 }
267
268 } // namespace JSC