Unreviewed, rolling out r234489.
[WebKit-https.git] / Source / WTF / wtf / text / WTFString.h
1 /*
2  * (C) 1999 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2004-2017 Apple Inc. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  *
20  */
21
22 #ifndef WTFString_h
23 #define WTFString_h
24
25 // This file would be called String.h, but that conflicts with <string.h>
26 // on systems without case-sensitive file systems.
27
28 #include <stdarg.h>
29 #include <wtf/Function.h>
30 #include <wtf/text/ASCIILiteral.h>
31 #include <wtf/text/IntegerToStringConversion.h>
32 #include <wtf/text/StringImpl.h>
33
34 #ifdef __OBJC__
35 #include <objc/objc.h>
36 #endif
37
38 namespace WTF {
39
40 // Declarations of string operations
41
42 WTF_EXPORT_PRIVATE int charactersToIntStrict(const LChar*, size_t, bool* ok = nullptr, int base = 10);
43 WTF_EXPORT_PRIVATE int charactersToIntStrict(const UChar*, size_t, bool* ok = nullptr, int base = 10);
44 WTF_EXPORT_PRIVATE unsigned charactersToUIntStrict(const LChar*, size_t, bool* ok = nullptr, int base = 10);
45 WTF_EXPORT_PRIVATE unsigned charactersToUIntStrict(const UChar*, size_t, bool* ok = nullptr, int base = 10);
46 int64_t charactersToInt64Strict(const LChar*, size_t, bool* ok = nullptr, int base = 10);
47 int64_t charactersToInt64Strict(const UChar*, size_t, bool* ok = nullptr, int base = 10);
48 WTF_EXPORT_PRIVATE uint64_t charactersToUInt64Strict(const LChar*, size_t, bool* ok = nullptr, int base = 10);
49 WTF_EXPORT_PRIVATE uint64_t charactersToUInt64Strict(const UChar*, size_t, bool* ok = nullptr, int base = 10);
50 intptr_t charactersToIntPtrStrict(const LChar*, size_t, bool* ok = nullptr, int base = 10);
51 intptr_t charactersToIntPtrStrict(const UChar*, size_t, bool* ok = nullptr, int base = 10);
52
53 WTF_EXPORT_PRIVATE int charactersToInt(const LChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
54 WTF_EXPORT_PRIVATE int charactersToInt(const UChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
55 unsigned charactersToUInt(const LChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
56 unsigned charactersToUInt(const UChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
57 int64_t charactersToInt64(const LChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
58 int64_t charactersToInt64(const UChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
59 uint64_t charactersToUInt64(const LChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
60 WTF_EXPORT_PRIVATE uint64_t charactersToUInt64(const UChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
61 intptr_t charactersToIntPtr(const LChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
62 intptr_t charactersToIntPtr(const UChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
63
64 // FIXME: Like the strict functions above, these give false for "ok" when there is trailing garbage.
65 // Like the non-strict functions above, these return the value when there is trailing garbage.
66 // It would be better if these were more consistent with the above functions instead.
67 WTF_EXPORT_PRIVATE double charactersToDouble(const LChar*, size_t, bool* ok = nullptr);
68 WTF_EXPORT_PRIVATE double charactersToDouble(const UChar*, size_t, bool* ok = nullptr);
69 WTF_EXPORT_PRIVATE float charactersToFloat(const LChar*, size_t, bool* ok = nullptr);
70 WTF_EXPORT_PRIVATE float charactersToFloat(const UChar*, size_t, bool* ok = nullptr);
71 WTF_EXPORT_PRIVATE float charactersToFloat(const LChar*, size_t, size_t& parsedLength);
72 WTF_EXPORT_PRIVATE float charactersToFloat(const UChar*, size_t, size_t& parsedLength);
73
74 template<bool isSpecialCharacter(UChar), typename CharacterType> bool isAllSpecialCharacters(const CharacterType*, size_t);
75
76 enum TrailingZerosTruncatingPolicy { KeepTrailingZeros, TruncateTrailingZeros };
77
78 class String {
79 public:
80     // Construct a null string, distinguishable from an empty string.
81     String() = default;
82
83     // Construct a string with UTF-16 data.
84     WTF_EXPORT_PRIVATE String(const UChar* characters, unsigned length);
85
86     // Construct a string by copying the contents of a vector.  To avoid
87     // copying, consider using String::adopt instead.
88     // This method will never create a null string. Vectors with size() == 0
89     // will return the empty string.
90     // NOTE: This is different from String(vector.data(), vector.size())
91     // which will sometimes return a null string when vector.data() is null
92     // which can only occur for vectors without inline capacity.
93     // See: https://bugs.webkit.org/show_bug.cgi?id=109792
94     template<size_t inlineCapacity, typename OverflowHandler>
95     explicit String(const Vector<UChar, inlineCapacity, OverflowHandler>&);
96
97     // Construct a string with UTF-16 data, from a null-terminated source.
98     WTF_EXPORT_PRIVATE String(const UChar*);
99
100     // Construct a string with latin1 data.
101     WTF_EXPORT_PRIVATE String(const LChar* characters, unsigned length);
102     WTF_EXPORT_PRIVATE String(const char* characters, unsigned length);
103
104     // Construct a string with latin1 data, from a null-terminated source.
105     WTF_EXPORT_PRIVATE String(const LChar* characters);
106     WTF_EXPORT_PRIVATE String(const char* characters);
107
108     // Construct a string referencing an existing StringImpl.
109     String(StringImpl&);
110     String(StringImpl*);
111     String(Ref<StringImpl>&&);
112     String(RefPtr<StringImpl>&&);
113
114     String(Ref<AtomicStringImpl>&&);
115     String(RefPtr<AtomicStringImpl>&&);
116
117     String(StaticStringImpl&);
118     String(StaticStringImpl*);
119
120     // Construct a string from a constant string literal.
121     WTF_EXPORT_PRIVATE String(ASCIILiteral);
122
123     // Construct a string from a constant string literal.
124     // This constructor is the "big" version, as it put the length in the function call and generate bigger code.
125     enum ConstructFromLiteralTag { ConstructFromLiteral };
126     template<unsigned characterCount> String(const char (&characters)[characterCount], ConstructFromLiteralTag) : m_impl(StringImpl::createFromLiteral<characterCount>(characters)) { }
127
128     // FIXME: Why do we have to define these explicitly given that we just want the default versions?
129     // We have verified empirically that we do.
130     String(const String&) = default;
131     String(String&&) = default;
132     String& operator=(const String&) = default;
133     String& operator=(String&&) = default;
134
135     ALWAYS_INLINE ~String() = default;
136
137     void swap(String& o) { m_impl.swap(o.m_impl); }
138
139     static String adopt(StringBuffer<LChar>&& buffer) { return StringImpl::adopt(WTFMove(buffer)); }
140     static String adopt(StringBuffer<UChar>&& buffer) { return StringImpl::adopt(WTFMove(buffer)); }
141     template<typename CharacterType, size_t inlineCapacity, typename OverflowHandler, size_t minCapacity>
142     static String adopt(Vector<CharacterType, inlineCapacity, OverflowHandler, minCapacity>&& vector) { return StringImpl::adopt(WTFMove(vector)); }
143
144     bool isNull() const { return !m_impl; }
145     bool isEmpty() const { return !m_impl || m_impl->isEmpty(); }
146
147     StringImpl* impl() const { return m_impl.get(); }
148     RefPtr<StringImpl> releaseImpl() { return WTFMove(m_impl); }
149
150     unsigned length() const { return m_impl ? m_impl->length() : 0; }
151     const LChar* characters8() const { return m_impl ? m_impl->characters8() : nullptr; }
152     const UChar* characters16() const { return m_impl ? m_impl->characters16() : nullptr; }
153
154     // Return characters8() or characters16() depending on CharacterType.
155     template<typename CharacterType> const CharacterType* characters() const;
156
157     bool is8Bit() const { return m_impl->is8Bit(); }
158
159     unsigned sizeInBytes() const { return m_impl ? m_impl->length() * (is8Bit() ? sizeof(LChar) : sizeof(UChar)) : 0; }
160
161     WTF_EXPORT_PRIVATE CString ascii() const;
162     WTF_EXPORT_PRIVATE CString latin1() const;
163
164     WTF_EXPORT_PRIVATE CString utf8(ConversionMode) const;
165     WTF_EXPORT_PRIVATE CString utf8() const;
166
167     WTF_EXPORT_PRIVATE Expected<CString, UTF8ConversionError> tryGetUtf8(ConversionMode) const;
168     WTF_EXPORT_PRIVATE Expected<CString, UTF8ConversionError> tryGetUtf8() const;
169
170     UChar characterAt(unsigned index) const;
171     UChar operator[](unsigned index) const { return characterAt(index); }
172
173     WTF_EXPORT_PRIVATE static String number(int);
174     WTF_EXPORT_PRIVATE static String number(unsigned);
175     WTF_EXPORT_PRIVATE static String number(long);
176     WTF_EXPORT_PRIVATE static String number(unsigned long);
177     WTF_EXPORT_PRIVATE static String number(long long);
178     WTF_EXPORT_PRIVATE static String number(unsigned long long);
179
180     WTF_EXPORT_PRIVATE static String number(double, unsigned precision = 6, TrailingZerosTruncatingPolicy = TruncateTrailingZeros);
181
182     // Number to String conversion following the ECMAScript definition.
183     WTF_EXPORT_PRIVATE static String numberToStringECMAScript(double);
184     WTF_EXPORT_PRIVATE static String numberToStringFixedWidth(double, unsigned decimalPlaces);
185
186     // Find a single character or string, also with match function & latin1 forms.
187     size_t find(UChar character, unsigned start = 0) const { return m_impl ? m_impl->find(character, start) : notFound; }
188
189     size_t find(const String& string) const { return m_impl ? m_impl->find(string.impl()) : notFound; }
190     size_t find(const String& string, unsigned start) const { return m_impl ? m_impl->find(string.impl(), start) : notFound; }
191     size_t findIgnoringASCIICase(const String& string) const { return m_impl ? m_impl->findIgnoringASCIICase(string.impl()) : notFound; }
192     size_t findIgnoringASCIICase(const String& string, unsigned startOffset) const { return m_impl ? m_impl->findIgnoringASCIICase(string.impl(), startOffset) : notFound; }
193
194     size_t find(CodeUnitMatchFunction matchFunction, unsigned start = 0) const { return m_impl ? m_impl->find(matchFunction, start) : notFound; }
195     size_t find(const LChar* string, unsigned start = 0) const { return m_impl ? m_impl->find(string, start) : notFound; }
196
197     // Find the last instance of a single character or string.
198     size_t reverseFind(UChar character, unsigned start = std::numeric_limits<unsigned>::max()) const { return m_impl ? m_impl->reverseFind(character, start) : notFound; }
199     size_t reverseFind(const String& string, unsigned start = std::numeric_limits<unsigned>::max()) const { return m_impl ? m_impl->reverseFind(string.impl(), start) : notFound; }
200
201     WTF_EXPORT_PRIVATE Vector<UChar> charactersWithNullTermination() const;
202
203     WTF_EXPORT_PRIVATE UChar32 characterStartingAt(unsigned) const;
204
205     bool contains(UChar character) const { return find(character) != notFound; }
206     bool contains(const LChar* string) const { return find(string) != notFound; }
207     bool contains(const String& string) const { return find(string) != notFound; }
208     bool containsIgnoringASCIICase(const String& string) const { return findIgnoringASCIICase(string) != notFound; }
209     bool containsIgnoringASCIICase(const String& string, unsigned startOffset) const { return findIgnoringASCIICase(string, startOffset) != notFound; }
210
211     bool startsWith(const String& string) const { return m_impl ? m_impl->startsWith(string.impl()) : string.isEmpty(); }
212     bool startsWithIgnoringASCIICase(const String& string) const { return m_impl ? m_impl->startsWithIgnoringASCIICase(string.impl()) : string.isEmpty(); }
213     bool startsWith(UChar character) const { return m_impl && m_impl->startsWith(character); }
214     template<unsigned matchLength> bool startsWith(const char (&prefix)[matchLength]) const { return m_impl ? m_impl->startsWith<matchLength>(prefix) : !matchLength; }
215     bool hasInfixStartingAt(const String& prefix, unsigned startOffset) const { return m_impl && prefix.impl() && m_impl->hasInfixStartingAt(*prefix.impl(), startOffset); }
216
217     bool endsWith(const String& string) const { return m_impl ? m_impl->endsWith(string.impl()) : string.isEmpty(); }
218     bool endsWithIgnoringASCIICase(const String& string) const { return m_impl ? m_impl->endsWithIgnoringASCIICase(string.impl()) : string.isEmpty(); }
219     bool endsWith(UChar character) const { return m_impl && m_impl->endsWith(character); }
220     bool endsWith(char character) const { return endsWith(static_cast<UChar>(character)); }
221     template<unsigned matchLength> bool endsWith(const char (&prefix)[matchLength]) const { return m_impl ? m_impl->endsWith<matchLength>(prefix) : !matchLength; }
222     bool hasInfixEndingAt(const String& suffix, unsigned endOffset) const { return m_impl && suffix.impl() && m_impl->hasInfixEndingAt(*suffix.impl(), endOffset); }
223
224     WTF_EXPORT_PRIVATE void append(const String&);
225     WTF_EXPORT_PRIVATE void append(LChar);
226     void append(char character) { append(static_cast<LChar>(character)); };
227     WTF_EXPORT_PRIVATE void append(UChar);
228     WTF_EXPORT_PRIVATE void append(const LChar*, unsigned length);
229     WTF_EXPORT_PRIVATE void append(const UChar*, unsigned length);
230     WTF_EXPORT_PRIVATE void insert(const String&, unsigned position);
231
232     String& replace(UChar target, UChar replacement);
233     String& replace(UChar target, const String& replacement);
234     String& replace(const String& target, const String& replacement);
235     String& replace(unsigned start, unsigned length, const String& replacement);
236     template<unsigned characterCount> String& replaceWithLiteral(UChar target, const char (&replacement)[characterCount]);
237
238     WTF_EXPORT_PRIVATE void truncate(unsigned length);
239     WTF_EXPORT_PRIVATE void remove(unsigned position, unsigned length = 1);
240
241     WTF_EXPORT_PRIVATE String substring(unsigned position, unsigned length = std::numeric_limits<unsigned>::max()) const;
242     WTF_EXPORT_PRIVATE String substringSharingImpl(unsigned position, unsigned length = std::numeric_limits<unsigned>::max()) const;
243     String left(unsigned length) const { return substring(0, length); }
244     String right(unsigned length) const { return substring(this->length() - length, length); }
245
246     WTF_EXPORT_PRIVATE String convertToASCIILowercase() const;
247     WTF_EXPORT_PRIVATE String convertToASCIIUppercase() const;
248     WTF_EXPORT_PRIVATE String convertToLowercaseWithoutLocale() const;
249     WTF_EXPORT_PRIVATE String convertToLowercaseWithoutLocaleStartingAtFailingIndex8Bit(unsigned) const;
250     WTF_EXPORT_PRIVATE String convertToUppercaseWithoutLocale() const;
251     WTF_EXPORT_PRIVATE String convertToLowercaseWithLocale(const AtomicString& localeIdentifier) const;
252     WTF_EXPORT_PRIVATE String convertToUppercaseWithLocale(const AtomicString& localeIdentifier) const;
253
254     WTF_EXPORT_PRIVATE String stripWhiteSpace() const;
255     WTF_EXPORT_PRIVATE String simplifyWhiteSpace() const;
256     WTF_EXPORT_PRIVATE String simplifyWhiteSpace(CodeUnitMatchFunction) const;
257
258     WTF_EXPORT_PRIVATE String stripLeadingAndTrailingCharacters(CodeUnitMatchFunction) const;
259     WTF_EXPORT_PRIVATE String removeCharacters(CodeUnitMatchFunction) const;
260
261     // Returns the string with case folded for case insensitive comparison.
262     // Use convertToASCIILowercase instead if ASCII case insensitive comparison is desired.
263     WTF_EXPORT_PRIVATE String foldCase() const;
264
265     WTF_EXPORT_PRIVATE static String format(const char *, ...) WTF_ATTRIBUTE_PRINTF(1, 2);
266
267     // Returns an uninitialized string. The characters needs to be written
268     // into the buffer returned in data before the returned string is used.
269     static String createUninitialized(unsigned length, UChar*& data) { return StringImpl::createUninitialized(length, data); }
270     static String createUninitialized(unsigned length, LChar*& data) { return StringImpl::createUninitialized(length, data); }
271
272     using SplitFunctor = WTF::Function<void(const StringView&)>;
273
274     WTF_EXPORT_PRIVATE void split(UChar separator, const SplitFunctor&) const;
275     WTF_EXPORT_PRIVATE Vector<String> split(UChar separator) const;
276     WTF_EXPORT_PRIVATE Vector<String> split(const String& separator) const;
277
278     WTF_EXPORT_PRIVATE void splitAllowingEmptyEntries(UChar separator, const SplitFunctor&) const;
279     WTF_EXPORT_PRIVATE Vector<String> splitAllowingEmptyEntries(UChar separator) const;
280     WTF_EXPORT_PRIVATE Vector<String> splitAllowingEmptyEntries(const String& separator) const;
281
282     WTF_EXPORT_PRIVATE int toIntStrict(bool* ok = nullptr, int base = 10) const;
283     WTF_EXPORT_PRIVATE unsigned toUIntStrict(bool* ok = nullptr, int base = 10) const;
284     WTF_EXPORT_PRIVATE int64_t toInt64Strict(bool* ok = nullptr, int base = 10) const;
285     WTF_EXPORT_PRIVATE uint64_t toUInt64Strict(bool* ok = nullptr, int base = 10) const;
286     WTF_EXPORT_PRIVATE intptr_t toIntPtrStrict(bool* ok = nullptr, int base = 10) const;
287
288     WTF_EXPORT_PRIVATE int toInt(bool* ok = nullptr) const;
289     WTF_EXPORT_PRIVATE unsigned toUInt(bool* ok = nullptr) const;
290     WTF_EXPORT_PRIVATE int64_t toInt64(bool* ok = nullptr) const;
291     WTF_EXPORT_PRIVATE uint64_t toUInt64(bool* ok = nullptr) const;
292     WTF_EXPORT_PRIVATE intptr_t toIntPtr(bool* ok = nullptr) const;
293
294     // FIXME: Like the strict functions above, these give false for "ok" when there is trailing garbage.
295     // Like the non-strict functions above, these return the value when there is trailing garbage.
296     // It would be better if these were more consistent with the above functions instead.
297     WTF_EXPORT_PRIVATE double toDouble(bool* ok = nullptr) const;
298     WTF_EXPORT_PRIVATE float toFloat(bool* ok = nullptr) const;
299
300     bool percentage(int& percentage) const;
301
302     WTF_EXPORT_PRIVATE String isolatedCopy() const &;
303     WTF_EXPORT_PRIVATE String isolatedCopy() &&;
304
305     WTF_EXPORT_PRIVATE bool isSafeToSendToAnotherThread() const;
306
307     // Prevent Strings from being implicitly convertable to bool as it will be ambiguous on any platform that
308     // allows implicit conversion to another pointer type (e.g., Mac allows implicit conversion to NSString *).
309     typedef struct ImplicitConversionFromWTFStringToBoolDisallowedA* (String::*UnspecifiedBoolTypeA);
310     typedef struct ImplicitConversionFromWTFStringToBoolDisallowedB* (String::*UnspecifiedBoolTypeB);
311     operator UnspecifiedBoolTypeA() const;
312     operator UnspecifiedBoolTypeB() const;
313
314 #if USE(CF)
315     WTF_EXPORT_PRIVATE String(CFStringRef);
316     WTF_EXPORT_PRIVATE RetainPtr<CFStringRef> createCFString() const;
317 #endif
318
319 #ifdef __OBJC__
320     WTF_EXPORT_PRIVATE String(NSString *);
321
322     // This conversion converts the null string to an empty NSString rather than to nil.
323     // Given Cocoa idioms, this is a more useful default. Clients that need to preserve the
324     // null string can check isNull explicitly.
325     operator NSString *() const;
326 #endif
327
328     WTF_EXPORT_PRIVATE static String make8BitFrom16BitSource(const UChar*, size_t);
329     template<size_t inlineCapacity> static String make8BitFrom16BitSource(const Vector<UChar, inlineCapacity>&);
330
331     WTF_EXPORT_PRIVATE static String make16BitFrom8BitSource(const LChar*, size_t);
332
333     // String::fromUTF8 will return a null string if
334     // the input data contains invalid UTF-8 sequences.
335     WTF_EXPORT_PRIVATE static String fromUTF8(const LChar*, size_t);
336     WTF_EXPORT_PRIVATE static String fromUTF8(const LChar*);
337     static String fromUTF8(const char* characters, size_t length) { return fromUTF8(reinterpret_cast<const LChar*>(characters), length); };
338     static String fromUTF8(const char* string) { return fromUTF8(reinterpret_cast<const LChar*>(string)); };
339     WTF_EXPORT_PRIVATE static String fromUTF8(const CString&);
340     static String fromUTF8(const Vector<LChar>& characters);
341
342     // Tries to convert the passed in string to UTF-8, but will fall back to Latin-1 if the string is not valid UTF-8.
343     WTF_EXPORT_PRIVATE static String fromUTF8WithLatin1Fallback(const LChar*, size_t);
344     static String fromUTF8WithLatin1Fallback(const char* characters, size_t length) { return fromUTF8WithLatin1Fallback(reinterpret_cast<const LChar*>(characters), length); };
345
346     // Determines the writing direction using the Unicode Bidi Algorithm rules P2 and P3.
347     UCharDirection defaultWritingDirection(bool* hasStrongDirectionality = nullptr) const;
348
349     bool isAllASCII() const { return !m_impl || m_impl->isAllASCII(); }
350     bool isAllLatin1() const { return !m_impl || m_impl->isAllLatin1(); }
351     template<bool isSpecialCharacter(UChar)> bool isAllSpecialCharacters() const { return !m_impl || m_impl->isAllSpecialCharacters<isSpecialCharacter>(); }
352
353     // Hash table deleted values, which are only constructed and never copied or destroyed.
354     String(WTF::HashTableDeletedValueType) : m_impl(WTF::HashTableDeletedValue) { }
355     bool isHashTableDeletedValue() const { return m_impl.isHashTableDeletedValue(); }
356
357     unsigned hash() const { return isNull() ? 0 : impl()->hash(); }
358     unsigned existingHash() const { return isNull() ? 0 : impl()->existingHash(); }
359
360 #ifndef NDEBUG
361     WTF_EXPORT_PRIVATE void show() const;
362 #endif
363
364     // Turns this String empty if the StringImpl is not referenced by anyone else.
365     // This is useful for clearing String-based caches.
366     void clearImplIfNotShared();
367
368 private:
369     template<typename CharacterType> void removeInternal(const CharacterType*, unsigned, unsigned);
370
371     template<bool allowEmptyEntries> void splitInternal(UChar separator, const SplitFunctor&) const;
372     template<bool allowEmptyEntries> Vector<String> splitInternal(UChar separator) const;
373     template<bool allowEmptyEntries> Vector<String> splitInternal(const String& separator) const;
374
375     RefPtr<StringImpl> m_impl;
376 };
377
378 static_assert(sizeof(String) == sizeof(void*), "String should effectively be a pointer to a StringImpl, and efficient to pass by value");
379
380 inline bool operator==(const String& a, const String& b) { return equal(a.impl(), b.impl()); }
381 inline bool operator==(const String& a, const LChar* b) { return equal(a.impl(), b); }
382 inline bool operator==(const String& a, const char* b) { return equal(a.impl(), reinterpret_cast<const LChar*>(b)); }
383 inline bool operator==(const String& a, ASCIILiteral b) { return equal(a.impl(), reinterpret_cast<const LChar*>(b.characters())); }
384 inline bool operator==(const LChar* a, const String& b) { return equal(a, b.impl()); }
385 inline bool operator==(const char* a, const String& b) { return equal(reinterpret_cast<const LChar*>(a), b.impl()); }
386 inline bool operator==(ASCIILiteral a, const String& b) { return equal(reinterpret_cast<const LChar*>(a.characters()), b.impl()); }
387 template<size_t inlineCapacity> inline bool operator==(const Vector<char, inlineCapacity>& a, const String& b) { return equal(b.impl(), a.data(), a.size()); }
388 template<size_t inlineCapacity> inline bool operator==(const String& a, const Vector<char, inlineCapacity>& b) { return b == a; }
389
390 inline bool operator!=(const String& a, const String& b) { return !equal(a.impl(), b.impl()); }
391 inline bool operator!=(const String& a, const LChar* b) { return !equal(a.impl(), b); }
392 inline bool operator!=(const String& a, const char* b) { return !equal(a.impl(), reinterpret_cast<const LChar*>(b)); }
393 inline bool operator!=(const String& a, ASCIILiteral b) { return !equal(a.impl(), reinterpret_cast<const LChar*>(b.characters())); }
394 inline bool operator!=(const LChar* a, const String& b) { return !equal(a, b.impl()); }
395 inline bool operator!=(const char* a, const String& b) { return !equal(reinterpret_cast<const LChar*>(a), b.impl()); }
396 inline bool operator!=(ASCIILiteral a, const String& b) { return !equal(reinterpret_cast<const LChar*>(a.characters()), b.impl()); }
397 template<size_t inlineCapacity> inline bool operator!=(const Vector<char, inlineCapacity>& a, const String& b) { return !(a == b); }
398 template<size_t inlineCapacity> inline bool operator!=(const String& a, const Vector<char, inlineCapacity>& b) { return b != a; }
399
400 bool equalIgnoringASCIICase(const String&, const String&);
401 bool equalIgnoringASCIICase(const String&, const char*);
402
403 template<unsigned length> bool equalLettersIgnoringASCIICase(const String&, const char (&lowercaseLetters)[length]);
404 template<unsigned length> bool startsWithLettersIgnoringASCIICase(const String&, const char (&lowercaseLetters)[length]);
405
406 inline bool equalIgnoringNullity(const String& a, const String& b) { return equalIgnoringNullity(a.impl(), b.impl()); }
407 template<size_t inlineCapacity> inline bool equalIgnoringNullity(const Vector<UChar, inlineCapacity>& a, const String& b) { return equalIgnoringNullity(a, b.impl()); }
408
409 inline bool operator!(const String& string) { return string.isNull(); }
410
411 inline void swap(String& a, String& b) { a.swap(b); }
412
413 #ifdef __OBJC__
414
415 // Used in a small number of places where the long standing behavior has been "nil if empty".
416 NSString * nsStringNilIfEmpty(const String&);
417
418 #endif
419
420 WTF_EXPORT_PRIVATE int codePointCompare(const String&, const String&);
421 bool codePointCompareLessThan(const String&, const String&);
422
423 template<typename CharacterType> void appendNumber(Vector<CharacterType>&, unsigned char number);
424
425 // Shared global empty string.
426 WTF_EXPORT_PRIVATE const String& emptyString();
427
428 template<typename> struct DefaultHash;
429 template<> struct DefaultHash<String> { using Hash = StringHash; };
430 template<> struct VectorTraits<String> : SimpleClassVectorTraits { };
431
432 template<> struct IntegerToStringConversionTrait<String> {
433     using ReturnType = String;
434     using AdditionalArgumentType = void;
435     static String flush(LChar* characters, unsigned length, void*) { return { characters, length }; }
436 };
437
438 // Definitions of string operations
439
440 inline String::String(StringImpl& string)
441     : m_impl(&string)
442 {
443 }
444
445 inline String::String(StringImpl* string)
446     : m_impl(string)
447 {
448 }
449
450 inline String::String(Ref<StringImpl>&& string)
451     : m_impl(WTFMove(string))
452 {
453 }
454
455 inline String::String(RefPtr<StringImpl>&& string)
456     : m_impl(WTFMove(string))
457 {
458 }
459
460 inline String::String(Ref<AtomicStringImpl>&& string)
461     : m_impl(WTFMove(string))
462 {
463 }
464
465 inline String::String(RefPtr<AtomicStringImpl>&& string)
466     : m_impl(WTFMove(string))
467 {
468 }
469
470 inline String::String(StaticStringImpl& string)
471     : m_impl(reinterpret_cast<StringImpl*>(&string))
472 {
473 }
474
475 inline String::String(StaticStringImpl* string)
476     : m_impl(reinterpret_cast<StringImpl*>(string))
477 {
478 }
479
480 template<size_t inlineCapacity, typename OverflowHandler> String::String(const Vector<UChar, inlineCapacity, OverflowHandler>& vector)
481     : m_impl(vector.size() ? StringImpl::create(vector.data(), vector.size()) : Ref<StringImpl> { *StringImpl::empty() })
482 {
483 }
484
485 template<> inline const LChar* String::characters<LChar>() const
486 {
487     return characters8();
488 }
489
490 template<> inline const UChar* String::characters<UChar>() const
491 {
492     return characters16();
493 }
494
495 inline UChar String::characterAt(unsigned index) const
496 {
497     if (!m_impl || index >= m_impl->length())
498         return 0;
499     return (*m_impl)[index];
500 }
501
502 inline String& String::replace(UChar target, UChar replacement)
503 {
504     if (m_impl)
505         m_impl = m_impl->replace(target, replacement);
506     return *this;
507 }
508
509 inline String& String::replace(UChar target, const String& replacement)
510 {
511     if (m_impl)
512         m_impl = m_impl->replace(target, replacement.impl());
513     return *this;
514 }
515
516 inline String& String::replace(const String& target, const String& replacement)
517 {
518     if (m_impl)
519         m_impl = m_impl->replace(target.impl(), replacement.impl());
520     return *this;
521 }
522
523 inline String& String::replace(unsigned start, unsigned length, const String& replacement)
524 {
525     if (m_impl)
526         m_impl = m_impl->replace(start, length, replacement.impl());
527     return *this;
528 }
529
530 template<unsigned characterCount> ALWAYS_INLINE String& String::replaceWithLiteral(UChar target, const char (&characters)[characterCount])
531 {
532     if (m_impl)
533         m_impl = m_impl->replace(target, characters, characterCount - 1);
534     return *this;
535 }
536
537 template<size_t inlineCapacity> inline String String::make8BitFrom16BitSource(const Vector<UChar, inlineCapacity>& buffer)
538 {
539     return make8BitFrom16BitSource(buffer.data(), buffer.size());
540 }
541
542 inline UCharDirection String::defaultWritingDirection(bool* hasStrongDirectionality) const
543 {
544     if (m_impl)
545         return m_impl->defaultWritingDirection(hasStrongDirectionality);
546     if (hasStrongDirectionality)
547         *hasStrongDirectionality = false;
548     return U_LEFT_TO_RIGHT;
549 }
550
551 inline void String::clearImplIfNotShared()
552 {
553     if (m_impl && m_impl->hasOneRef())
554         m_impl = nullptr;
555 }
556
557 #ifdef __OBJC__
558
559 inline String::operator NSString *() const
560 {
561     if (!m_impl)
562         return @"";
563     return *m_impl;
564 }
565
566 inline NSString * nsStringNilIfEmpty(const String& string)
567 {
568     if (string.isEmpty())
569         return nil;
570     return *string.impl();
571 }
572
573 #endif
574
575 inline bool codePointCompareLessThan(const String& a, const String& b)
576 {
577     return codePointCompare(a.impl(), b.impl()) < 0;
578 }
579
580 template<typename CharacterType>
581 inline void appendNumber(Vector<CharacterType>& vector, unsigned char number)
582 {
583     int numberLength = number > 99 ? 3 : (number > 9 ? 2 : 1);
584     size_t vectorSize = vector.size();
585     vector.grow(vectorSize + numberLength);
586
587     switch (numberLength) {
588     case 3:
589         vector[vectorSize + 2] = number % 10 + '0';
590         number /= 10;
591         FALLTHROUGH;
592
593     case 2:
594         vector[vectorSize + 1] = number % 10 + '0';
595         number /= 10;
596         FALLTHROUGH;
597
598     case 1:
599         vector[vectorSize] = number % 10 + '0';
600     }
601 }
602
603 inline String String::fromUTF8(const Vector<LChar>& characters)
604 {
605     if (characters.isEmpty())
606         return emptyString();
607     return fromUTF8(characters.data(), characters.size());
608 }
609
610 template<unsigned length> inline bool equalLettersIgnoringASCIICase(const String& string, const char (&lowercaseLetters)[length])
611 {
612     return equalLettersIgnoringASCIICase(string.impl(), lowercaseLetters);
613 }
614
615 inline bool equalIgnoringASCIICase(const String& a, const String& b)
616 {
617     return equalIgnoringASCIICase(a.impl(), b.impl());
618 }
619
620 inline bool equalIgnoringASCIICase(const String& a, const char* b)
621 {
622     return equalIgnoringASCIICase(a.impl(), b);
623 }
624
625 template<unsigned length> inline bool startsWithLettersIgnoringASCIICase(const String& string, const char (&lowercaseLetters)[length])
626 {
627     return startsWithLettersIgnoringASCIICase(string.impl(), lowercaseLetters);
628 }
629
630 } // namespace WTF
631
632 using WTF::KeepTrailingZeros;
633 using WTF::String;
634 using WTF::appendNumber;
635 using WTF::charactersToDouble;
636 using WTF::charactersToFloat;
637 using WTF::charactersToInt64;
638 using WTF::charactersToInt64Strict;
639 using WTF::charactersToInt;
640 using WTF::charactersToIntPtr;
641 using WTF::charactersToIntPtrStrict;
642 using WTF::charactersToIntStrict;
643 using WTF::charactersToUInt64;
644 using WTF::charactersToUInt64Strict;
645 using WTF::charactersToUInt;
646 using WTF::charactersToUIntStrict;
647 using WTF::emptyString;
648 using WTF::equal;
649 using WTF::find;
650 using WTF::isAllSpecialCharacters;
651 using WTF::isSpaceOrNewline;
652 using WTF::reverseFind;
653
654 #include <wtf/text/AtomicString.h>
655
656 #endif