Unreviewed, rolling out r231845.
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSCJSValue.cpp
1 /*
2  *  Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2003-2017 Apple Inc. All rights reserved.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Library General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Library General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Library General Public License
17  *  along with this library; see the file COPYING.LIB.  If not, write to
18  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  *  Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #include "config.h"
24 #include "JSCJSValue.h"
25
26 #include "BooleanConstructor.h"
27 #include "BooleanPrototype.h"
28 #include "CustomGetterSetter.h"
29 #include "Error.h"
30 #include "ExceptionHelpers.h"
31 #include "GetterSetter.h"
32 #include "JSBigInt.h"
33 #include "JSCInlines.h"
34 #include "JSFunction.h"
35 #include "JSGlobalObject.h"
36 #include "NumberObject.h"
37 #include <wtf/MathExtras.h>
38
39 namespace JSC {
40
41 // ECMA 9.4
42 double JSValue::toInteger(ExecState* exec) const
43 {
44     if (isInt32())
45         return asInt32();
46     double d = toNumber(exec);
47     return std::isnan(d) ? 0.0 : trunc(d);
48 }
49
50 double JSValue::toIntegerPreserveNaN(ExecState* exec) const
51 {
52     if (isInt32())
53         return asInt32();
54     return trunc(toNumber(exec));
55 }
56
57 double JSValue::toLength(ExecState* exec) const
58 {
59     // ECMA 7.1.15
60     // http://www.ecma-international.org/ecma-262/6.0/#sec-tolength
61     double d = toInteger(exec);
62     if (d <= 0)
63         return 0.0;
64     if (std::isinf(d))
65         return maxSafeInteger();
66     return std::min(d, maxSafeInteger());
67 }
68
69 double JSValue::toNumberSlowCase(ExecState* exec) const
70 {
71     ASSERT(!isInt32() && !isDouble());
72     if (isCell())
73         return asCell()->toNumber(exec);
74     if (isTrue())
75         return 1.0;
76     return isUndefined() ? PNaN : 0; // null and false both convert to 0.
77 }
78
79 std::optional<double> JSValue::toNumberFromPrimitive() const
80 {
81     if (isEmpty())
82         return std::nullopt;
83     if (isNumber())
84         return asNumber();
85     if (isBoolean())
86         return asBoolean();
87     if (isUndefined())
88         return PNaN;
89     if (isNull())
90         return 0;
91     return std::nullopt;
92 }
93
94 JSObject* JSValue::toObjectSlowCase(ExecState* exec, JSGlobalObject* globalObject) const
95 {
96     VM& vm = exec->vm();
97     auto scope = DECLARE_THROW_SCOPE(vm);
98     ASSERT(!isCell());
99
100     if (isInt32() || isDouble())
101         return constructNumber(exec, globalObject, asValue());
102     if (isTrue() || isFalse())
103         return constructBooleanFromImmediateBoolean(exec, globalObject, asValue());
104
105     ASSERT(isUndefinedOrNull());
106     throwException(exec, scope, createNotAnObjectError(exec, *this));
107     return nullptr;
108 }
109
110 JSValue JSValue::toThisSlowCase(ExecState* exec, ECMAMode ecmaMode) const
111 {
112     ASSERT(!isCell());
113
114     if (ecmaMode == StrictMode)
115         return *this;
116
117     if (isInt32() || isDouble())
118         return constructNumber(exec, exec->lexicalGlobalObject(), asValue());
119     if (isTrue() || isFalse())
120         return constructBooleanFromImmediateBoolean(exec, exec->lexicalGlobalObject(), asValue());
121     ASSERT(isUndefinedOrNull());
122     return exec->globalThisValue();
123 }
124
125 JSObject* JSValue::synthesizePrototype(ExecState* exec) const
126 {
127     VM& vm = exec->vm();
128     auto scope = DECLARE_THROW_SCOPE(vm);
129
130     if (isCell()) {
131         if (isString())
132             return exec->lexicalGlobalObject()->stringPrototype();
133         if (isBigInt())
134             return exec->lexicalGlobalObject()->bigIntPrototype();
135         ASSERT(isSymbol());
136         return exec->lexicalGlobalObject()->symbolPrototype();
137     }
138
139     if (isNumber())
140         return exec->lexicalGlobalObject()->numberPrototype();
141     if (isBoolean())
142         return exec->lexicalGlobalObject()->booleanPrototype();
143
144     ASSERT(isUndefinedOrNull());
145     throwException(exec, scope, createNotAnObjectError(exec, *this));
146     return nullptr;
147 }
148
149 // ECMA 8.7.2
150 bool JSValue::putToPrimitive(ExecState* exec, PropertyName propertyName, JSValue value, PutPropertySlot& slot)
151 {
152     VM& vm = exec->vm();
153     auto scope = DECLARE_THROW_SCOPE(vm);
154
155     if (std::optional<uint32_t> index = parseIndex(propertyName)) {
156         scope.release();
157         return putToPrimitiveByIndex(exec, index.value(), value, slot.isStrictMode());
158     }
159
160     // Check if there are any setters or getters in the prototype chain
161     JSObject* obj = synthesizePrototype(exec);
162     EXCEPTION_ASSERT(!!scope.exception() == !obj);
163     if (UNLIKELY(!obj))
164         return false;
165     JSValue prototype;
166     if (propertyName != vm.propertyNames->underscoreProto) {
167         for (; !obj->structure()->hasReadOnlyOrGetterSetterPropertiesExcludingProto(); obj = asObject(prototype)) {
168             prototype = obj->getPrototype(vm, exec);
169             RETURN_IF_EXCEPTION(scope, false);
170
171             if (prototype.isNull())
172                 return typeError(exec, scope, slot.isStrictMode(), ASCIILiteral(ReadonlyPropertyWriteError));
173         }
174     }
175
176     for (; ; obj = asObject(prototype)) {
177         unsigned attributes;
178         PropertyOffset offset = obj->structure()->get(vm, propertyName, attributes);
179         if (offset != invalidOffset) {
180             if (attributes & PropertyAttribute::ReadOnly)
181                 return typeError(exec, scope, slot.isStrictMode(), ASCIILiteral(ReadonlyPropertyWriteError));
182
183             JSValue gs = obj->getDirect(offset);
184             if (gs.isGetterSetter()) {
185                 scope.release();
186                 return callSetter(exec, *this, gs, value, slot.isStrictMode() ? StrictMode : NotStrictMode);
187             }
188
189             if (gs.isCustomGetterSetter())
190                 return callCustomSetter(exec, gs, attributes & PropertyAttribute::CustomAccessor, obj, slot.thisValue(), value);
191
192             // If there's an existing property on the object or one of its 
193             // prototypes it should be replaced, so break here.
194             break;
195         }
196
197         prototype = obj->getPrototype(vm, exec);
198         RETURN_IF_EXCEPTION(scope, false);
199         if (prototype.isNull())
200             break;
201     }
202     
203     return typeError(exec, scope, slot.isStrictMode(), ASCIILiteral(ReadonlyPropertyWriteError));
204 }
205
206 bool JSValue::putToPrimitiveByIndex(ExecState* exec, unsigned propertyName, JSValue value, bool shouldThrow)
207 {
208     VM& vm = exec->vm();
209     auto scope = DECLARE_THROW_SCOPE(vm);
210
211     if (propertyName > MAX_ARRAY_INDEX) {
212         PutPropertySlot slot(*this, shouldThrow);
213         return putToPrimitive(exec, Identifier::from(exec, propertyName), value, slot);
214     }
215     
216     JSObject* prototype = synthesizePrototype(exec);
217     EXCEPTION_ASSERT(!!scope.exception() == !prototype);
218     if (UNLIKELY(!prototype))
219         return false;
220     bool putResult = false;
221     bool success = prototype->attemptToInterceptPutByIndexOnHoleForPrototype(exec, *this, propertyName, value, shouldThrow, putResult);
222     RETURN_IF_EXCEPTION(scope, false);
223     if (success)
224         return putResult;
225     
226     return typeError(exec, scope, shouldThrow, ASCIILiteral(ReadonlyPropertyWriteError));
227 }
228
229 void JSValue::dump(PrintStream& out) const
230 {
231     dumpInContext(out, 0);
232 }
233
234 void JSValue::dumpInContext(PrintStream& out, DumpContext* context) const
235 {
236     dumpInContextAssumingStructure(
237         out, context, (!!*this && isCell()) ? asCell()->structure() : nullptr);
238 }
239
240 void JSValue::dumpInContextAssumingStructure(
241     PrintStream& out, DumpContext* context, Structure* structure) const
242 {
243     if (!*this)
244         out.print("<JSValue()>");
245     else if (isInt32())
246         out.printf("Int32: %d", asInt32());
247     else if (isDouble()) {
248 #if USE(JSVALUE64)
249         out.printf("Double: %lld, %lf", (long long)reinterpretDoubleToInt64(asDouble()), asDouble());
250 #else
251         union {
252             double asDouble;
253             uint32_t asTwoInt32s[2];
254         } u;
255         u.asDouble = asDouble();
256         out.printf("Double: %08x:%08x, %lf", u.asTwoInt32s[1], u.asTwoInt32s[0], asDouble());
257 #endif
258     } else if (isCell()) {
259         if (structure->classInfo()->isSubClassOf(JSString::info())) {
260             JSString* string = asString(asCell());
261             out.print("String");
262             if (string->isRope())
263                 out.print(" (rope)");
264             const StringImpl* impl = string->tryGetValueImpl();
265             if (impl) {
266                 if (impl->isAtomic())
267                     out.print(" (atomic)");
268                 if (impl->isAtomic())
269                     out.print(" (identifier)");
270                 if (impl->isSymbol())
271                     out.print(" (symbol)");
272             } else
273                 out.print(" (unresolved)");
274             out.print(": ", impl);
275         } else if (structure->classInfo()->isSubClassOf(Symbol::info()))
276             out.print("Symbol: ", RawPointer(asCell()));
277         else if (structure->classInfo()->isSubClassOf(Structure::info()))
278             out.print("Structure: ", inContext(*jsCast<Structure*>(asCell()), context));
279         else if (structure->classInfo()->isSubClassOf(JSObject::info())) {
280             out.print("Object: ", RawPointer(asCell()));
281             out.print(" with butterfly ", RawPointer(asObject(asCell())->butterfly()));
282             out.print(" (Structure ", inContext(*structure, context), ")");
283         } else {
284             out.print("Cell: ", RawPointer(asCell()));
285             out.print(" (", inContext(*structure, context), ")");
286         }
287 #if USE(JSVALUE64)
288         out.print(", StructureID: ", asCell()->structureID());
289 #endif
290     } else if (isTrue())
291         out.print("True");
292     else if (isFalse())
293         out.print("False");
294     else if (isNull())
295         out.print("Null");
296     else if (isUndefined())
297         out.print("Undefined");
298     else
299         out.print("INVALID");
300 }
301
302 void JSValue::dumpForBacktrace(PrintStream& out) const
303 {
304     if (!*this)
305         out.print("<JSValue()>");
306     else if (isInt32())
307         out.printf("%d", asInt32());
308     else if (isDouble())
309         out.printf("%lf", asDouble());
310     else if (isCell()) {
311         VM& vm = *asCell()->vm();
312         if (asCell()->inherits<JSString>(vm)) {
313             JSString* string = asString(asCell());
314             const StringImpl* impl = string->tryGetValueImpl();
315             if (impl)
316                 out.print("\"", impl, "\"");
317             else
318                 out.print("(unresolved string)");
319         } else if (asCell()->inherits<Structure>(vm)) {
320             out.print("Structure[ ", asCell()->structure()->classInfo()->className);
321 #if USE(JSVALUE64)
322             out.print(" ID: ", asCell()->structureID());
323 #endif
324             out.print("]: ", RawPointer(asCell()));
325         } else {
326             out.print("Cell[", asCell()->structure()->classInfo()->className);
327 #if USE(JSVALUE64)
328             out.print(" ID: ", asCell()->structureID());
329 #endif
330             out.print("]: ", RawPointer(asCell()));
331         }
332     } else if (isTrue())
333         out.print("True");
334     else if (isFalse())
335         out.print("False");
336     else if (isNull())
337         out.print("Null");
338     else if (isUndefined())
339         out.print("Undefined");
340     else
341         out.print("INVALID");
342 }
343
344 bool JSValue::isValidCallee()
345 {
346     return asObject(asCell())->globalObject();
347 }
348
349 JSString* JSValue::toStringSlowCase(ExecState* exec, bool returnEmptyStringOnError) const
350 {
351     VM& vm = exec->vm();
352     auto scope = DECLARE_THROW_SCOPE(vm);
353
354     auto errorValue = [&] () -> JSString* {
355         if (returnEmptyStringOnError)
356             return jsEmptyString(exec);
357         return nullptr;
358     };
359     
360     ASSERT(!isString());
361     if (isInt32()) {
362         auto integer = asInt32();
363         if (static_cast<unsigned>(integer) <= 9)
364             return vm.smallStrings.singleCharacterString(integer + '0');
365         return jsNontrivialString(&vm, vm.numericStrings.add(integer));
366     }
367     if (isDouble())
368         return jsString(&vm, vm.numericStrings.add(asDouble()));
369     if (isTrue())
370         return vm.smallStrings.trueString();
371     if (isFalse())
372         return vm.smallStrings.falseString();
373     if (isNull())
374         return vm.smallStrings.nullString();
375     if (isUndefined())
376         return vm.smallStrings.undefinedString();
377     if (isSymbol()) {
378         throwTypeError(exec, scope, ASCIILiteral("Cannot convert a symbol to a string"));
379         return errorValue();
380     }
381     if (isBigInt()) {
382         JSBigInt* bigInt = asBigInt(*this);
383         if (auto digit = bigInt->singleDigitValueForString())
384             return vm.smallStrings.singleCharacterString(*digit + '0');
385         JSString* returnString = jsNontrivialString(&vm, bigInt->toString(*exec, 10));
386         RETURN_IF_EXCEPTION(scope, errorValue());
387         return returnString;
388     }
389
390     ASSERT(isCell());
391     JSValue value = asCell()->toPrimitive(exec, PreferString);
392     RETURN_IF_EXCEPTION(scope, errorValue());
393     ASSERT(!value.isObject());
394     JSString* result = value.toString(exec);
395     RETURN_IF_EXCEPTION(scope, errorValue());
396     return result;
397 }
398
399 String JSValue::toWTFStringSlowCase(ExecState* exec) const
400 {
401     VM& vm = exec->vm();
402     if (isInt32())
403         return vm.numericStrings.add(asInt32());
404     if (isDouble())
405         return vm.numericStrings.add(asDouble());
406     if (isTrue())
407         return vm.propertyNames->trueKeyword.string();
408     if (isFalse())
409         return vm.propertyNames->falseKeyword.string();
410     if (isNull())
411         return vm.propertyNames->nullKeyword.string();
412     if (isUndefined())
413         return vm.propertyNames->undefinedKeyword.string();
414     return toString(exec)->value(exec);
415 }
416
417 } // namespace JSC