1/*
2 * Copyright (C) 2012-2019 Apple Inc. All rights reserved.
3 * Copyright (C) 2015-2016 Yusuke Suzuki <[email protected]>.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24 * THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include "JSString.h"
30#include "PrivateName.h"
31
32namespace JSC {
33
34class Symbol final : public JSCell {
35public:
36 typedef JSCell Base;
37 static constexpr unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal | OverridesToThis;
38
39 DECLARE_EXPORT_INFO;
40
41 static constexpr bool needsDestruction = true;
42
43 template<typename CellType, SubspaceAccess mode>
44 static IsoSubspace* subspaceFor(VM& vm)
45 {
46 return vm.symbolSpace<mode>();
47 }
48
49 static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
50 {
51 return Structure::create(vm, globalObject, prototype, TypeInfo(SymbolType, StructureFlags), info());
52 }
53
54 static Symbol* create(VM&);
55 static Symbol* createWithDescription(VM&, const String&);
56 JS_EXPORT_PRIVATE static Symbol* create(VM&, SymbolImpl& uid);
57
58 PrivateName privateName() const { return m_privateName; }
59 String descriptiveString() const;
60 String description() const;
61
62 JSValue toPrimitive(JSGlobalObject*, PreferredPrimitiveType) const;
63 bool getPrimitiveNumber(JSGlobalObject*, double& number, JSValue&) const;
64 JSObject* toObject(JSGlobalObject*) const;
65 double toNumber(JSGlobalObject*) const;
66
67 static ptrdiff_t offsetOfSymbolImpl()
68 {
69 // PrivateName is just a Ref<SymbolImpl> which can just be used as a SymbolImpl*.
70 return OBJECT_OFFSETOF(Symbol, m_privateName);
71 }
72
73protected:
74 static void destroy(JSCell*);
75
76 Symbol(VM&);
77 Symbol(VM&, const String&);
78 Symbol(VM&, SymbolImpl& uid);
79
80 void finishCreation(VM&);
81
82 PrivateName m_privateName;
83};
84
85Symbol* asSymbol(JSValue);
86
87inline Symbol* asSymbol(JSValue value)
88{
89 ASSERT(value.asCell()->isSymbol());
90 return jsCast<Symbol*>(value.asCell());
91}
92
93} // namespace JSC
94