84c5eb8361de899abc7a4ccc411eb995ba46acb4
[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, 2007-2008, 2012, 2016 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 "JSCInlines.h"
33 #include "JSFunction.h"
34 #include "JSGlobalObject.h"
35 #include "NumberObject.h"
36 #include <wtf/MathExtras.h>
37 #include <wtf/StringExtras.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 9007199254740991.0; // 2 ** 53 - 1
66     return std::min(d, 9007199254740991.0);
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 Optional<double> JSValue::toNumberFromPrimitive() const
80 {
81     if (isEmpty())
82         return 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 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         ASSERT(isSymbol());
134         return exec->lexicalGlobalObject()->symbolPrototype();
135     }
136
137     if (isNumber())
138         return exec->lexicalGlobalObject()->numberPrototype();
139     if (isBoolean())
140         return exec->lexicalGlobalObject()->booleanPrototype();
141
142     ASSERT(isUndefinedOrNull());
143     throwException(exec, scope, createNotAnObjectError(exec, *this));
144     return nullptr;
145 }
146
147 // ECMA 8.7.2
148 bool JSValue::putToPrimitive(ExecState* exec, PropertyName propertyName, JSValue value, PutPropertySlot& slot)
149 {
150     VM& vm = exec->vm();
151     auto scope = DECLARE_THROW_SCOPE(vm);
152
153     if (Optional<uint32_t> index = parseIndex(propertyName))
154         return putToPrimitiveByIndex(exec, index.value(), value, slot.isStrictMode());
155
156     // Check if there are any setters or getters in the prototype chain
157     JSObject* obj = synthesizePrototype(exec);
158     if (UNLIKELY(!obj))
159         return false;
160     JSValue prototype;
161     if (propertyName != exec->propertyNames().underscoreProto) {
162         for (; !obj->structure()->hasReadOnlyOrGetterSetterPropertiesExcludingProto(); obj = asObject(prototype)) {
163             prototype = obj->getPrototypeDirect();
164             if (prototype.isNull()) {
165                 if (slot.isStrictMode())
166                     throwTypeError(exec, scope, ReadonlyPropertyWriteError);
167                 return false;
168             }
169         }
170     }
171
172     for (; ; obj = asObject(prototype)) {
173         unsigned attributes;
174         PropertyOffset offset = obj->structure()->get(vm, propertyName, attributes);
175         if (offset != invalidOffset) {
176             if (attributes & ReadOnly) {
177                 if (slot.isStrictMode())
178                     throwTypeError(exec, scope, ReadonlyPropertyWriteError);
179                 return false;
180             }
181
182             JSValue gs = obj->getDirect(offset);
183             if (gs.isGetterSetter())
184                 return callSetter(exec, *this, gs, value, slot.isStrictMode() ? StrictMode : NotStrictMode);
185
186             if (gs.isCustomGetterSetter())
187                 return callCustomSetter(exec, gs, attributes & CustomAccessor, obj, slot.thisValue(), value);
188
189             // If there's an existing property on the object or one of its 
190             // prototypes it should be replaced, so break here.
191             break;
192         }
193
194         prototype = obj->getPrototype(vm, exec);
195         RETURN_IF_EXCEPTION(scope, false);
196         if (prototype.isNull())
197             break;
198     }
199     
200     if (slot.isStrictMode())
201         throwTypeError(exec, scope, ReadonlyPropertyWriteError);
202     return false;
203 }
204
205 bool JSValue::putToPrimitiveByIndex(ExecState* exec, unsigned propertyName, JSValue value, bool shouldThrow)
206 {
207     VM& vm = exec->vm();
208     auto scope = DECLARE_THROW_SCOPE(vm);
209
210     if (propertyName > MAX_ARRAY_INDEX) {
211         PutPropertySlot slot(*this, shouldThrow);
212         return putToPrimitive(exec, Identifier::from(exec, propertyName), value, slot);
213     }
214     
215     JSObject* prototype = synthesizePrototype(exec);
216     if (UNLIKELY(!prototype)) {
217         ASSERT(scope.exception());
218         return false;
219     }
220     bool putResult = false;
221     if (prototype->attemptToInterceptPutByIndexOnHoleForPrototype(exec, *this, propertyName, value, shouldThrow, putResult))
222         return putResult;
223     
224     if (shouldThrow)
225         throwTypeError(exec, scope, ReadonlyPropertyWriteError);
226     return false;
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 = jsCast<JSString*>(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(" (", 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(", ID: ", 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         if (asCell()->inherits(JSString::info())) {
312             JSString* string = jsCast<JSString*>(asCell());
313             const StringImpl* impl = string->tryGetValueImpl();
314             if (impl)
315                 out.print("\"", impl, "\"");
316             else
317                 out.print("(unresolved string)");
318         } else if (asCell()->inherits(Structure::info())) {
319             out.print("Structure[ ", asCell()->structure()->classInfo()->className);
320 #if USE(JSVALUE64)
321             out.print(" ID: ", asCell()->structureID());
322 #endif
323             out.print("]: ", RawPointer(asCell()));
324         } else {
325             out.print("Cell[", asCell()->structure()->classInfo()->className);
326 #if USE(JSVALUE64)
327             out.print(" ID: ", asCell()->structureID());
328 #endif
329             out.print("]: ", RawPointer(asCell()));
330         }
331     } else if (isTrue())
332         out.print("True");
333     else if (isFalse())
334         out.print("False");
335     else if (isNull())
336         out.print("Null");
337     else if (isUndefined())
338         out.print("Undefined");
339     else
340         out.print("INVALID");
341 }
342
343 bool JSValue::isValidCallee()
344 {
345     return asObject(asCell())->globalObject();
346 }
347
348 JSString* JSValue::toStringSlowCase(ExecState* exec, bool returnEmptyStringOnError) const
349 {
350     VM& vm = exec->vm();
351     auto scope = DECLARE_THROW_SCOPE(vm);
352
353     auto errorValue = [&] () -> JSString* {
354         if (returnEmptyStringOnError)
355             return jsEmptyString(exec);
356         return nullptr;
357     };
358     
359     ASSERT(!isString());
360     if (isInt32()) {
361         auto integer = asInt32();
362         if (static_cast<unsigned>(integer) <= 9)
363             return vm.smallStrings.singleCharacterString(integer + '0');
364         return jsNontrivialString(&vm, vm.numericStrings.add(integer));
365     }
366     if (isDouble())
367         return jsString(&vm, vm.numericStrings.add(asDouble()));
368     if (isTrue())
369         return vm.smallStrings.trueString();
370     if (isFalse())
371         return vm.smallStrings.falseString();
372     if (isNull())
373         return vm.smallStrings.nullString();
374     if (isUndefined())
375         return vm.smallStrings.undefinedString();
376     if (isSymbol()) {
377         throwTypeError(exec, scope, ASCIILiteral("Cannot convert a symbol to a string"));
378         return errorValue();
379     }
380
381     ASSERT(isCell());
382     JSValue value = asCell()->toPrimitive(exec, PreferString);
383     RETURN_IF_EXCEPTION(scope, errorValue());
384     ASSERT(!value.isObject());
385     JSString* result = value.toString(exec);
386     RETURN_IF_EXCEPTION(scope, errorValue());
387     return result;
388 }
389
390 String JSValue::toWTFStringSlowCase(ExecState* exec) const
391 {
392     VM& vm = exec->vm();
393     if (isInt32())
394         return vm.numericStrings.add(asInt32());
395     if (isDouble())
396         return vm.numericStrings.add(asDouble());
397     if (isTrue())
398         return vm.propertyNames->trueKeyword.string();
399     if (isFalse())
400         return vm.propertyNames->falseKeyword.string();
401     if (isNull())
402         return vm.propertyNames->nullKeyword.string();
403     if (isUndefined())
404         return vm.propertyNames->undefinedKeyword.string();
405     return toString(exec)->value(exec);
406 }
407
408 } // namespace JSC