Introduce UniquedStringImpl and SymbolImpl to separate symbolic strings from AtomicSt...
[WebKit-https.git] / Source / JavaScriptCore / runtime / PropertyName.h
1 /*
2  * Copyright (C) 2012 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef PropertyName_h
27 #define PropertyName_h
28
29 #include "Identifier.h"
30 #include "PrivateName.h"
31 #include <wtf/Optional.h>
32
33 namespace JSC {
34
35 class PropertyName {
36 public:
37     PropertyName(UniquedStringImpl* propertyName)
38         : m_impl(propertyName)
39     {
40     }
41
42     PropertyName(const Identifier& propertyName)
43         : PropertyName(propertyName.impl())
44     {
45     }
46
47     PropertyName(const PrivateName& propertyName)
48         : m_impl(propertyName.uid())
49     {
50         ASSERT(m_impl);
51         ASSERT(m_impl->isSymbol());
52     }
53
54     bool isSymbol()
55     {
56         return m_impl && m_impl->isSymbol();
57     }
58
59     UniquedStringImpl* uid() const
60     {
61         return m_impl;
62     }
63
64     AtomicStringImpl* publicName() const
65     {
66         return (!m_impl || m_impl->isSymbol()) ? nullptr : static_cast<AtomicStringImpl*>(m_impl);
67     }
68
69     void dump(PrintStream& out) const
70     {
71         if (m_impl)
72             out.print(m_impl);
73         else
74             out.print("<null property name>");
75     }
76
77 private:
78     UniquedStringImpl* m_impl;
79 };
80
81 inline bool operator==(PropertyName a, const Identifier& b)
82 {
83     return a.uid() == b.impl();
84 }
85
86 inline bool operator==(const Identifier& a, PropertyName b)
87 {
88     return a.impl() == b.uid();
89 }
90
91 inline bool operator==(PropertyName a, PropertyName b)
92 {
93     return a.uid() == b.uid();
94 }
95
96 inline bool operator==(PropertyName a, const char* b)
97 {
98     return equal(a.uid(), b);
99 }
100
101 inline bool operator!=(PropertyName a, const Identifier& b)
102 {
103     return a.uid() != b.impl();
104 }
105
106 inline bool operator!=(const Identifier& a, PropertyName b)
107 {
108     return a.impl() != b.uid();
109 }
110
111 inline bool operator!=(PropertyName a, PropertyName b)
112 {
113     return a.uid() != b.uid();
114 }
115
116 ALWAYS_INLINE Optional<uint32_t> parseIndex(PropertyName propertyName)
117 {
118     auto uid = propertyName.uid();
119     if (!uid)
120         return Nullopt;
121     if (uid->isSymbol())
122         return Nullopt;
123     return parseIndex(*uid);
124 }
125
126 }
127
128 #endif