d9fe20db5593ebe0e2d78a0cb482e363e6ceb7c7
[WebKit-https.git] / Source / JavaScriptCore / runtime / Identifier.h
1 /*
2  *  Copyright (C) 2003, 2006, 2007, 2008, 2009, 2012 Apple Inc. All rights reserved.
3  *
4  *  This library is free software; you can redistribute it and/or
5  *  modify it under the terms of the GNU Library General Public
6  *  License as published by the Free Software Foundation; either
7  *  version 2 of the License, or (at your option) any later version.
8  *
9  *  This library is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  *  Library General Public License for more details.
13  *
14  *  You should have received a copy of the GNU Library General Public License
15  *  along with this library; see the file COPYING.LIB.  If not, write to
16  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  *  Boston, MA 02110-1301, USA.
18  *
19  */
20
21 #ifndef Identifier_h
22 #define Identifier_h
23
24 #include "VM.h"
25 #include <wtf/ThreadSpecific.h>
26 #include <wtf/WTFThreadData.h>
27 #include <wtf/text/CString.h>
28 #include <wtf/text/WTFString.h>
29
30 namespace JSC {
31
32 class ExecState;
33
34 class Identifier {
35     friend class Structure;
36 public:
37     Identifier() { }
38     enum EmptyIdentifierFlag { EmptyIdentifier };
39     Identifier(EmptyIdentifierFlag) : m_string(StringImpl::empty()) { ASSERT(m_string.impl()->isAtomic()); }
40
41     // Only to be used with string literals.
42     template<unsigned charactersCount>
43     Identifier(ExecState* exec, const char (&characters)[charactersCount]) : m_string(add(exec, characters)) { ASSERT(m_string.impl()->isAtomic()); }
44     template<unsigned charactersCount>
45     Identifier(VM* vm, const char (&characters)[charactersCount]) : m_string(add(vm, characters)) { ASSERT(m_string.impl()->isAtomic()); }
46
47     Identifier(ExecState*, AtomicStringImpl*);
48     Identifier(ExecState*, const AtomicString&);
49     Identifier(ExecState* exec, StringImpl* rep) : m_string(add(exec, rep)) { ASSERT(m_string.impl()->isAtomic()); }
50     Identifier(ExecState* exec, const String& s) : m_string(add(exec, s.impl())) { ASSERT(m_string.impl()->isAtomic()); }
51     Identifier(ExecState* exec, const char* s) : Identifier(exec, AtomicString(s)) { }
52
53     Identifier(VM* vm, const LChar* s, int length) : m_string(add(vm, s, length)) { ASSERT(m_string.impl()->isAtomic()); }
54     Identifier(VM* vm, const UChar* s, int length) : m_string(add(vm, s, length)) { ASSERT(m_string.impl()->isAtomic()); }
55     Identifier(VM* vm, StringImpl* rep) : m_string(add(vm, rep)) { ASSERT(m_string.impl()->isAtomic()); }
56     Identifier(VM* vm, const String& s) : m_string(add(vm, s.impl())) { ASSERT(m_string.impl()->isAtomic()); }
57
58     const String& string() const { return m_string; }
59     AtomicStringImpl* impl() const { return static_cast<AtomicStringImpl*>(m_string.impl()); }
60
61     int length() const { return m_string.length(); }
62
63     CString ascii() const { return m_string.ascii(); }
64     CString utf8() const { return m_string.utf8(); }
65
66     static Identifier from(const PrivateName& name)
67     {
68         Identifier result;
69         result.m_string = name.uid();
70         return result;
71     }
72
73     static Identifier createLCharFromUChar(VM* vm, const UChar* s, int length) { return Identifier(vm, add8(vm, s, length)); }
74
75     JS_EXPORT_PRIVATE static Identifier from(ExecState*, unsigned y);
76     JS_EXPORT_PRIVATE static Identifier from(ExecState*, int y);
77     static Identifier from(ExecState*, double y);
78     static Identifier from(VM*, unsigned y);
79     static Identifier from(VM*, int y);
80     static Identifier from(VM*, double y);
81
82     bool isNull() const { return m_string.isNull(); }
83     bool isEmpty() const { return m_string.isEmpty(); }
84
85     friend bool operator==(const Identifier&, const Identifier&);
86     friend bool operator!=(const Identifier&, const Identifier&);
87
88     friend bool operator==(const Identifier&, const LChar*);
89     friend bool operator==(const Identifier&, const char*);
90     friend bool operator!=(const Identifier&, const LChar*);
91     friend bool operator!=(const Identifier&, const char*);
92
93     static bool equal(const StringImpl*, const LChar*);
94     static inline bool equal(const StringImpl*a, const char*b) { return Identifier::equal(a, reinterpret_cast<const LChar*>(b)); };
95     static bool equal(const StringImpl*, const LChar*, unsigned length);
96     static bool equal(const StringImpl*, const UChar*, unsigned length);
97     static bool equal(const StringImpl* a, const StringImpl* b) { return ::equal(a, b); }
98
99     // Only to be used with string literals.
100     JS_EXPORT_PRIVATE static PassRef<StringImpl> add(VM*, const char*);
101     JS_EXPORT_PRIVATE static PassRef<StringImpl> add(ExecState*, const char*);
102
103     void dump(PrintStream&) const;
104
105 private:
106     String m_string;
107
108     template <typename CharType>
109     ALWAYS_INLINE static uint32_t toUInt32FromCharacters(const CharType* characters, unsigned length, bool& ok);
110
111     static bool equal(const Identifier& a, const Identifier& b) { return a.m_string.impl() == b.m_string.impl(); }
112     static bool equal(const Identifier& a, const LChar* b) { return equal(a.m_string.impl(), b); }
113
114     template <typename T> static PassRef<StringImpl> add(VM*, const T*, int length);
115     static PassRef<StringImpl> add8(VM*, const UChar*, int length);
116     template <typename T> ALWAYS_INLINE static bool canUseSingleCharacterString(T);
117
118     static PassRef<StringImpl> add(ExecState*, StringImpl*);
119     static PassRef<StringImpl> add(VM*, StringImpl*);
120
121 #ifndef NDEBUG
122     JS_EXPORT_PRIVATE static void checkCurrentAtomicStringTable(ExecState*);
123     JS_EXPORT_PRIVATE static void checkCurrentAtomicStringTable(VM*);
124 #else
125     JS_EXPORT_PRIVATE NO_RETURN_DUE_TO_CRASH static void checkCurrentAtomicStringTable(ExecState*);
126     JS_EXPORT_PRIVATE NO_RETURN_DUE_TO_CRASH static void checkCurrentAtomicStringTable(VM*);
127 #endif
128 };
129
130 template <> ALWAYS_INLINE bool Identifier::canUseSingleCharacterString(LChar)
131 {
132     ASSERT(maxSingleCharacterString == 0xff);
133     return true;
134 }
135
136 template <> ALWAYS_INLINE bool Identifier::canUseSingleCharacterString(UChar c)
137 {
138     return (c <= maxSingleCharacterString);
139 }
140
141 template <typename T>
142 PassRef<StringImpl> Identifier::add(VM* vm, const T* s, int length)
143 {
144     if (length == 1) {
145         T c = s[0];
146         if (canUseSingleCharacterString(c))
147             return *vm->smallStrings.singleCharacterStringRep(c);
148     }
149     if (!length)
150         return *StringImpl::empty();
151
152     return *AtomicString::add(s, length);
153 }
154
155 inline bool operator==(const Identifier& a, const Identifier& b)
156 {
157     return Identifier::equal(a, b);
158 }
159
160 inline bool operator!=(const Identifier& a, const Identifier& b)
161 {
162     return !Identifier::equal(a, b);
163 }
164
165 inline bool operator==(const Identifier& a, const LChar* b)
166 {
167     return Identifier::equal(a, b);
168 }
169
170 inline bool operator==(const Identifier& a, const char* b)
171 {
172     return Identifier::equal(a, reinterpret_cast<const LChar*>(b));
173 }
174
175 inline bool operator!=(const Identifier& a, const LChar* b)
176 {
177     return !Identifier::equal(a, b);
178 }
179
180 inline bool operator!=(const Identifier& a, const char* b)
181 {
182     return !Identifier::equal(a, reinterpret_cast<const LChar*>(b));
183 }
184
185 inline bool Identifier::equal(const StringImpl* r, const LChar* s)
186 {
187     return WTF::equal(r, s);
188 }
189
190 inline bool Identifier::equal(const StringImpl* r, const LChar* s, unsigned length)
191 {
192     return WTF::equal(r, s, length);
193 }
194
195 inline bool Identifier::equal(const StringImpl* r, const UChar* s, unsigned length)
196 {
197     return WTF::equal(r, s, length);
198 }
199
200 struct IdentifierRepHash : PtrHash<RefPtr<StringImpl>> {
201     static unsigned hash(const RefPtr<StringImpl>& key) { return key->existingHash(); }
202     static unsigned hash(StringImpl* key) { return key->existingHash(); }
203 };
204
205 struct IdentifierMapIndexHashTraits : HashTraits<int> {
206     static int emptyValue() { return std::numeric_limits<int>::max(); }
207     static const bool emptyValueIsZero = false;
208 };
209
210 typedef HashMap<RefPtr<StringImpl>, int, IdentifierRepHash, HashTraits<RefPtr<StringImpl>>, IdentifierMapIndexHashTraits> IdentifierMap;
211 typedef HashMap<StringImpl*, int, IdentifierRepHash, HashTraits<StringImpl*>, IdentifierMapIndexHashTraits> BorrowedIdentifierMap;
212
213 } // namespace JSC
214
215 namespace WTF {
216
217 template <> struct VectorTraits<JSC::Identifier> : SimpleClassVectorTraits { };
218
219 } // namespace WTF
220
221 #endif // Identifier_h