Addressing post-review comments on r184353
[WebKit-https.git] / Source / WTF / wtf / text / AtomicString.h
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2008, 2014 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 AtomicString_h
22 #define AtomicString_h
23
24 #include <utility>
25 #include <wtf/text/AtomicStringImpl.h>
26 #include <wtf/text/WTFString.h>
27
28 // Define 'NO_IMPLICIT_ATOMICSTRING' before including this header,
29 // to disallow (expensive) implicit String-->AtomicString conversions.
30 #ifdef NO_IMPLICIT_ATOMICSTRING
31 #define ATOMICSTRING_CONVERSION explicit
32 #else
33 #define ATOMICSTRING_CONVERSION
34 #endif
35
36 namespace WTF {
37
38 class AtomicStringTable;
39 struct AtomicStringHash;
40
41 class AtomicString {
42 public:
43     WTF_EXPORT_PRIVATE static void init();
44
45     AtomicString() { }
46     AtomicString(const LChar* s) : m_string(add(s)) { }
47     AtomicString(const char* s) : m_string(add(s)) { }
48     AtomicString(const LChar* s, unsigned length) : m_string(add(s, length)) { }
49     AtomicString(const UChar* s, unsigned length) : m_string(add(s, length)) { }
50     AtomicString(const UChar* s, unsigned length, unsigned existingHash) : m_string(add(s, length, existingHash)) { }
51     AtomicString(const UChar* s) : m_string(add(s)) { }
52
53     template<size_t inlineCapacity>
54     explicit AtomicString(const Vector<UChar, inlineCapacity>& characters)
55         : m_string(add(characters.data(), characters.size()))
56     {
57     }
58
59     ATOMICSTRING_CONVERSION AtomicString(StringImpl* imp) : m_string(add(imp)) { }
60     AtomicString(AtomicStringImpl* imp) : m_string(imp) { }
61     ATOMICSTRING_CONVERSION AtomicString(const String& s) : m_string(add(s.impl())) { }
62     AtomicString(StringImpl* baseString, unsigned start, unsigned length) : m_string(add(baseString, start, length)) { }
63
64     enum ConstructFromLiteralTag { ConstructFromLiteral };
65     AtomicString(const char* characters, unsigned length, ConstructFromLiteralTag)
66         : m_string(addFromLiteralData(characters, length))
67     {
68     }
69
70     template<unsigned charactersCount>
71     ALWAYS_INLINE AtomicString(const char (&characters)[charactersCount], ConstructFromLiteralTag)
72         : m_string(addFromLiteralData(characters, charactersCount - 1))
73     {
74         COMPILE_ASSERT(charactersCount > 1, AtomicStringFromLiteralNotEmpty);
75         COMPILE_ASSERT((charactersCount - 1 <= ((unsigned(~0) - sizeof(StringImpl)) / sizeof(LChar))), AtomicStringFromLiteralCannotOverflow);
76     }
77
78     // We have to declare the copy constructor and copy assignment operator as well, otherwise
79     // they'll be implicitly deleted by adding the move constructor and move assignment operator.
80     AtomicString(const AtomicString& other) : m_string(other.m_string) { }
81     AtomicString(AtomicString&& other) : m_string(WTF::move(other.m_string)) { }
82     AtomicString& operator=(const AtomicString& other) { m_string = other.m_string; return *this; }
83     AtomicString& operator=(AtomicString&& other) { m_string = WTF::move(other.m_string); return *this; }
84
85     // Hash table deleted values, which are only constructed and never copied or destroyed.
86     AtomicString(WTF::HashTableDeletedValueType) : m_string(WTF::HashTableDeletedValue) { }
87     bool isHashTableDeletedValue() const { return m_string.isHashTableDeletedValue(); }
88
89     static AtomicStringImpl* find(LChar* characters, unsigned length)
90     {
91         return findInternal(characters, length);
92     }
93     static AtomicStringImpl* find(UChar* characters, unsigned length)
94     {
95         return findInternal(characters, length);
96     }
97     static AtomicStringImpl* find(StringImpl* string)
98     {
99         if (!string || string->isAtomic())
100             return static_cast<AtomicStringImpl*>(string);
101         return findSlowCase(*string);
102     }
103
104     operator const String&() const { return m_string; }
105     const String& string() const { return m_string; };
106
107     AtomicStringImpl* impl() const { return static_cast<AtomicStringImpl *>(m_string.impl()); }
108
109     bool is8Bit() const { return m_string.is8Bit(); }
110     const LChar* characters8() const { return m_string.characters8(); }
111     const UChar* characters16() const { return m_string.characters16(); }
112     unsigned length() const { return m_string.length(); }
113     
114     UChar operator[](unsigned int i) const { return m_string[i]; }
115
116     WTF_EXPORT_STRING_API static AtomicString number(int);
117     WTF_EXPORT_STRING_API static AtomicString number(unsigned);
118     WTF_EXPORT_STRING_API static AtomicString number(double);
119     // If we need more overloads of the number function, we can add all the others that String has, but these seem to do for now.
120
121     bool contains(UChar c) const { return m_string.contains(c); }
122     bool contains(const LChar* s, bool caseSensitive = true) const
123         { return m_string.contains(s, caseSensitive); }
124     bool contains(const String& s) const
125         { return m_string.contains(s); }
126     bool contains(const String& s, bool caseSensitive) const
127         { return m_string.contains(s, caseSensitive); }
128     bool containsIgnoringASCIICase(const String& s) const
129         { return m_string.containsIgnoringASCIICase(s); }
130
131     size_t find(UChar c, unsigned start = 0) const { return m_string.find(c, start); }
132     size_t find(const LChar* s, unsigned start = 0, bool caseSentitive = true) const
133         { return m_string.find(s, start, caseSentitive); }
134     size_t find(const String& s, unsigned start = 0, bool caseSentitive = true) const
135         { return m_string.find(s, start, caseSentitive); }
136     size_t findIgnoringASCIICase(const String& s) const
137         { return m_string.findIgnoringASCIICase(s); }
138     size_t findIgnoringASCIICase(const String& s, unsigned startOffset) const
139         { return m_string.findIgnoringASCIICase(s, startOffset); }
140     size_t find(CharacterMatchFunctionPtr matchFunction, unsigned start = 0) const
141         { return m_string.find(matchFunction, start); }
142
143     bool startsWith(const String& s) const
144         { return m_string.startsWith(s); }
145     bool startsWithIgnoringASCIICase(const String& s) const
146         { return m_string.startsWithIgnoringASCIICase(s); }
147     bool startsWith(const String& s, bool caseSensitive) const
148         { return m_string.startsWith(s, caseSensitive); }
149     bool startsWith(UChar character) const
150         { return m_string.startsWith(character); }
151     template<unsigned matchLength>
152     bool startsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const
153         { return m_string.startsWith<matchLength>(prefix, caseSensitive); }
154
155     bool endsWith(const String& s) const
156         { return m_string.endsWith(s); }
157     bool endsWithIgnoringASCIICase(const String& s) const
158         { return m_string.endsWithIgnoringASCIICase(s); }
159     bool endsWith(const String& s, bool caseSensitive) const
160         { return m_string.endsWith(s, caseSensitive); }
161     bool endsWith(UChar character) const
162         { return m_string.endsWith(character); }
163     template<unsigned matchLength>
164     bool endsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const
165         { return m_string.endsWith<matchLength>(prefix, caseSensitive); }
166     
167     WTF_EXPORT_STRING_API AtomicString convertToASCIILowercase() const;
168     WTF_EXPORT_STRING_API AtomicString lower() const;
169     AtomicString upper() const { return AtomicString(impl()->upper()); }
170
171     int toInt(bool* ok = 0) const { return m_string.toInt(ok); }
172     double toDouble(bool* ok = 0) const { return m_string.toDouble(ok); }
173     float toFloat(bool* ok = 0) const { return m_string.toFloat(ok); }
174     bool percentage(int& p) const { return m_string.percentage(p); }
175
176     bool isNull() const { return m_string.isNull(); }
177     bool isEmpty() const { return m_string.isEmpty(); }
178
179     static void remove(StringImpl*);
180     
181 #if USE(CF)
182     AtomicString(CFStringRef s) :  m_string(add(s)) { }
183 #endif    
184 #ifdef __OBJC__
185     AtomicString(NSString* s) : m_string(add((CFStringRef)s)) { }
186     operator NSString*() const { return m_string; }
187 #endif
188
189     // AtomicString::fromUTF8 will return a null string if
190     // the input data contains invalid UTF-8 sequences.
191     static AtomicString fromUTF8(const char*, size_t);
192     static AtomicString fromUTF8(const char*);
193
194 #ifndef NDEBUG
195     void show() const;
196 #endif
197
198     WTF_EXPORT_STRING_API static RefPtr<StringImpl> add(const LChar*);
199     ALWAYS_INLINE static RefPtr<StringImpl> add(const char* s) { return add(reinterpret_cast<const LChar*>(s)); };
200     WTF_EXPORT_STRING_API static RefPtr<StringImpl> add(const LChar*, unsigned length);
201     WTF_EXPORT_STRING_API static RefPtr<StringImpl> add(const UChar*, unsigned length);
202     ALWAYS_INLINE static RefPtr<StringImpl> add(const char* s, unsigned length) { return add(reinterpret_cast<const LChar*>(s), length); };
203     WTF_EXPORT_STRING_API static Ref<StringImpl> add(const UChar*, unsigned length, unsigned existingHash);
204     WTF_EXPORT_STRING_API static RefPtr<StringImpl> add(const UChar*);
205     WTF_EXPORT_STRING_API static RefPtr<StringImpl> add(StringImpl*, unsigned offset, unsigned length);
206     ALWAYS_INLINE static RefPtr<StringImpl> add(StringImpl* string)
207     {
208         if (!string)
209             return string;
210         return add(*string);
211     }
212     WTF_EXPORT_STRING_API static Ref<StringImpl> addFromLiteralData(const char* characters, unsigned length);
213 #if USE(CF)
214     WTF_EXPORT_STRING_API static RefPtr<StringImpl> add(CFStringRef);
215 #endif
216
217     template<typename StringTableProvider>
218     ALWAYS_INLINE static RefPtr<StringImpl> addWithStringTableProvider(StringTableProvider& stringTableProvider, StringImpl* string)
219     {
220         if (!string)
221             return string;
222         return add(*stringTableProvider.atomicStringTable(), *string);
223     }
224
225 #if !ASSERT_DISABLED
226     WTF_EXPORT_STRING_API static bool isInAtomicStringTable(StringImpl*);
227 #endif
228
229 private:
230     // The explicit constructors with AtomicString::ConstructFromLiteral must be used for literals.
231     AtomicString(ASCIILiteral);
232
233     String m_string;
234
235     ALWAYS_INLINE static Ref<StringImpl> add(StringImpl& string)
236     {
237         if (string.isAtomic()) {
238             ASSERT_WITH_MESSAGE(!string.length() || isInAtomicStringTable(&string), "The atomic string comes from an other thread!");
239             return string;
240         }
241         return addSlowCase(string);
242     }
243
244     ALWAYS_INLINE static Ref<StringImpl> add(AtomicStringTable& stringTable, StringImpl& string)
245     {
246         if (string.isAtomic()) {
247             ASSERT_WITH_MESSAGE(!string.length() || isInAtomicStringTable(&string), "The atomic string comes from an other thread!");
248             return string;
249         }
250         return addSlowCase(stringTable, string);
251     }
252
253     WTF_EXPORT_STRING_API static Ref<StringImpl> addSlowCase(StringImpl&);
254     WTF_EXPORT_STRING_API static Ref<StringImpl> addSlowCase(AtomicStringTable&, StringImpl&);
255
256     WTF_EXPORT_STRING_API static AtomicStringImpl* findSlowCase(StringImpl&);
257     WTF_EXPORT_STRING_API static AtomicString fromUTF8Internal(const char*, const char*);
258
259     WTF_EXPORT_STRING_API static AtomicStringImpl* findInternal(const LChar*, unsigned length);
260     WTF_EXPORT_STRING_API static AtomicStringImpl* findInternal(const UChar*, unsigned length);
261 };
262
263 inline bool operator==(const AtomicString& a, const AtomicString& b) { return a.impl() == b.impl(); }
264 bool operator==(const AtomicString&, const LChar*);
265 inline bool operator==(const AtomicString& a, const char* b) { return WTF::equal(a.impl(), reinterpret_cast<const LChar*>(b)); }
266 inline bool operator==(const AtomicString& a, const Vector<UChar>& b) { return a.impl() && equal(a.impl(), b.data(), b.size()); }    
267 inline bool operator==(const AtomicString& a, const String& b) { return equal(a.impl(), b.impl()); }
268 inline bool operator==(const LChar* a, const AtomicString& b) { return b == a; }
269 inline bool operator==(const String& a, const AtomicString& b) { return equal(a.impl(), b.impl()); }
270 inline bool operator==(const Vector<UChar>& a, const AtomicString& b) { return b == a; }
271
272 inline bool operator!=(const AtomicString& a, const AtomicString& b) { return a.impl() != b.impl(); }
273 inline bool operator!=(const AtomicString& a, const LChar* b) { return !(a == b); }
274 inline bool operator!=(const AtomicString& a, const char* b) { return !(a == b); }
275 inline bool operator!=(const AtomicString& a, const String& b) { return !equal(a.impl(), b.impl()); }
276 inline bool operator!=(const AtomicString& a, const Vector<UChar>& b) { return !(a == b); }
277 inline bool operator!=(const LChar* a, const AtomicString& b) { return !(b == a); }
278 inline bool operator!=(const String& a, const AtomicString& b) { return !equal(a.impl(), b.impl()); }
279 inline bool operator!=(const Vector<UChar>& a, const AtomicString& b) { return !(a == b); }
280
281 inline bool equalIgnoringCase(const AtomicString& a, const AtomicString& b) { return equalIgnoringCase(a.impl(), b.impl()); }
282 inline bool equalIgnoringCase(const AtomicString& a, const LChar* b) { return equalIgnoringCase(a.impl(), b); }
283 inline bool equalIgnoringCase(const AtomicString& a, const char* b) { return equalIgnoringCase(a.impl(), reinterpret_cast<const LChar*>(b)); }
284 inline bool equalIgnoringCase(const AtomicString& a, const String& b) { return equalIgnoringCase(a.impl(), b.impl()); }
285 inline bool equalIgnoringCase(const LChar* a, const AtomicString& b) { return equalIgnoringCase(a, b.impl()); }
286 inline bool equalIgnoringCase(const char* a, const AtomicString& b) { return equalIgnoringCase(reinterpret_cast<const LChar*>(a), b.impl()); }
287 inline bool equalIgnoringCase(const String& a, const AtomicString& b) { return equalIgnoringCase(a.impl(), b.impl()); }
288
289 inline bool equalIgnoringASCIICase(const AtomicString& a, const AtomicString& b) { return equalIgnoringASCIICase(a.impl(), b.impl()); }
290 inline bool equalIgnoringASCIICase(const AtomicString& a, const String& b) { return equalIgnoringASCIICase(a.impl(), b.impl()); }
291 inline bool equalIgnoringASCIICase(const String& a, const AtomicString& b) { return equalIgnoringASCIICase(a.impl(), b.impl()); }
292
293 template <unsigned charactersCount>
294 inline bool equalIgnoringASCIICase(const AtomicString& a, const char (&b)[charactersCount]) { return equalIgnoringASCIICase<charactersCount>(a.impl(), b); }
295
296 // Define external global variables for the commonly used atomic strings.
297 // These are only usable from the main thread.
298 #ifndef ATOMICSTRING_HIDE_GLOBALS
299 extern const WTF_EXPORTDATA AtomicString nullAtom;
300 extern const WTF_EXPORTDATA AtomicString emptyAtom;
301 extern const WTF_EXPORTDATA AtomicString textAtom;
302 extern const WTF_EXPORTDATA AtomicString commentAtom;
303 extern const WTF_EXPORTDATA AtomicString starAtom;
304 extern const WTF_EXPORTDATA AtomicString xmlAtom;
305 extern const WTF_EXPORTDATA AtomicString xmlnsAtom;
306 extern const WTF_EXPORTDATA AtomicString xlinkAtom;
307
308 inline AtomicString AtomicString::fromUTF8(const char* characters, size_t length)
309 {
310     if (!characters)
311         return nullAtom;
312     if (!length)
313         return emptyAtom;
314     return fromUTF8Internal(characters, characters + length);
315 }
316
317 inline AtomicString AtomicString::fromUTF8(const char* characters)
318 {
319     if (!characters)
320         return nullAtom;
321     if (!*characters)
322         return emptyAtom;
323     return fromUTF8Internal(characters, 0);
324 }
325 #endif
326
327 // AtomicStringHash is the default hash for AtomicString
328 template<typename T> struct DefaultHash;
329 template<> struct DefaultHash<AtomicString> {
330     typedef AtomicStringHash Hash;
331 };
332
333 } // namespace WTF
334
335 #ifndef ATOMICSTRING_HIDE_GLOBALS
336 using WTF::AtomicString;
337 using WTF::nullAtom;
338 using WTF::emptyAtom;
339 using WTF::textAtom;
340 using WTF::commentAtom;
341 using WTF::starAtom;
342 using WTF::xmlAtom;
343 using WTF::xmlnsAtom;
344 using WTF::xlinkAtom;
345 #endif
346
347 #include <wtf/text/StringConcatenate.h>
348 #endif // AtomicString_h