83d6628020039f1a5704f85905d80e390cf4216b
[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 <wtf/Function.h>
29 #include <wtf/text/ASCIIFastPath.h>
30 #include <wtf/text/IntegerToStringConversion.h>
31 #include <wtf/text/StringImpl.h>
32
33 #ifdef __OBJC__
34 #include <objc/objc.h>
35 #endif
36
37 namespace WTF {
38
39 class ASCIILiteral;
40
41 // Declarations of string operations
42
43 WTF_EXPORT_STRING_API int charactersToIntStrict(const LChar*, size_t, bool* ok = nullptr, int base = 10);
44 WTF_EXPORT_STRING_API int charactersToIntStrict(const UChar*, size_t, bool* ok = nullptr, int base = 10);
45 WTF_EXPORT_STRING_API unsigned charactersToUIntStrict(const LChar*, size_t, bool* ok = nullptr, int base = 10);
46 WTF_EXPORT_STRING_API unsigned charactersToUIntStrict(const UChar*, size_t, bool* ok = nullptr, int base = 10);
47 int64_t charactersToInt64Strict(const LChar*, size_t, bool* ok = nullptr, int base = 10);
48 int64_t charactersToInt64Strict(const UChar*, size_t, bool* ok = nullptr, int base = 10);
49 uint64_t charactersToUInt64Strict(const LChar*, size_t, bool* ok = nullptr, int base = 10);
50 uint64_t charactersToUInt64Strict(const UChar*, size_t, bool* ok = nullptr, int base = 10);
51 intptr_t charactersToIntPtrStrict(const LChar*, size_t, bool* ok = nullptr, int base = 10);
52 intptr_t charactersToIntPtrStrict(const UChar*, size_t, bool* ok = nullptr, int base = 10);
53
54 WTF_EXPORT_STRING_API int charactersToInt(const LChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
55 WTF_EXPORT_STRING_API int charactersToInt(const UChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
56 unsigned charactersToUInt(const LChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
57 unsigned charactersToUInt(const UChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
58 int64_t charactersToInt64(const LChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
59 int64_t charactersToInt64(const UChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
60 uint64_t charactersToUInt64(const LChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
61 WTF_EXPORT_STRING_API uint64_t charactersToUInt64(const UChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
62 intptr_t charactersToIntPtr(const LChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
63 intptr_t charactersToIntPtr(const UChar*, size_t, bool* ok = nullptr); // ignores trailing garbage
64
65 // FIXME: Like the strict functions above, these give false for "ok" when there is trailing garbage.
66 // Like the non-strict functions above, these return the value when there is trailing garbage.
67 // It would be better if these were more consistent with the above functions instead.
68 WTF_EXPORT_STRING_API double charactersToDouble(const LChar*, size_t, bool* ok = nullptr);
69 WTF_EXPORT_STRING_API double charactersToDouble(const UChar*, size_t, bool* ok = nullptr);
70 WTF_EXPORT_STRING_API float charactersToFloat(const LChar*, size_t, bool* ok = nullptr);
71 WTF_EXPORT_STRING_API float charactersToFloat(const UChar*, size_t, bool* ok = nullptr);
72 WTF_EXPORT_STRING_API float charactersToFloat(const LChar*, size_t, size_t& parsedLength);
73 WTF_EXPORT_STRING_API float charactersToFloat(const UChar*, size_t, size_t& parsedLength);
74
75 template<bool isSpecialCharacter(UChar), typename CharacterType> bool isAllSpecialCharacters(const CharacterType*, size_t);
76
77 enum TrailingZerosTruncatingPolicy { KeepTrailingZeros, TruncateTrailingZeros };
78
79 class String {
80 public:
81     // Construct a null string, distinguishable from an empty string.
82     String() { }
83
84     // Construct a string with UTF-16 data.
85     WTF_EXPORT_STRING_API String(const UChar* characters, unsigned length);
86
87     // Construct a string by copying the contents of a vector.  To avoid
88     // copying, consider using String::adopt instead.
89     // This method will never create a null string. Vectors with size() == 0
90     // will return the empty string.
91     // NOTE: This is different from String(vector.data(), vector.size())
92     // which will sometimes return a null string when vector.data() is null
93     // which can only occur for vectors without inline capacity.
94     // See: https://bugs.webkit.org/show_bug.cgi?id=109792
95     template<size_t inlineCapacity, typename OverflowHandler>
96     explicit String(const Vector<UChar, inlineCapacity, OverflowHandler>&);
97
98     // Construct a string with UTF-16 data, from a null-terminated source.
99     WTF_EXPORT_STRING_API String(const UChar*);
100
101     // Construct a string with latin1 data.
102     WTF_EXPORT_STRING_API String(const LChar* characters, unsigned length);
103     WTF_EXPORT_STRING_API String(const char* characters, unsigned length);
104
105     // Construct a string with latin1 data, from a null-terminated source.
106     WTF_EXPORT_STRING_API String(const LChar* characters);
107     WTF_EXPORT_STRING_API String(const char* characters);
108
109     // Construct a string referencing an existing StringImpl.
110     String(StringImpl&);
111     String(StringImpl*);
112     String(Ref<StringImpl>&&);
113     String(RefPtr<StringImpl>&&);
114
115     String(Ref<AtomicStringImpl>&&);
116     String(RefPtr<AtomicStringImpl>&&);
117
118     String(StaticStringImpl&);
119     String(StaticStringImpl*);
120
121     // Construct a string from a constant string literal.
122     WTF_EXPORT_STRING_API String(ASCIILiteral);
123
124     // Construct a string from a constant string literal.
125     // This constructor is the "big" version, as it put the length in the function call and generate bigger code.
126     enum ConstructFromLiteralTag { ConstructFromLiteral };
127     template<unsigned characterCount>
128     String(const char (&characters)[characterCount], ConstructFromLiteralTag) : m_impl(StringImpl::createFromLiteral<characterCount>(characters)) { }
129
130     // We have to declare the copy constructor and copy assignment operator as well, otherwise
131     // they'll be implicitly deleted by adding the move constructor and move assignment operator.
132     String(const String& other)
133         : m_impl(other.m_impl)
134     { }
135     String(String&& other)
136         : m_impl(WTFMove(other.m_impl))
137     { }
138     String& operator=(const String& other) { m_impl = other.m_impl; return *this; }
139     String& operator=(String&& other) { m_impl = WTFMove(other.m_impl); return *this; }
140
141     // Inline the destructor.
142     ALWAYS_INLINE ~String() { }
143
144     void swap(String& o) { m_impl.swap(o.m_impl); }
145
146     static String adopt(StringBuffer<LChar>&& buffer) { return StringImpl::adopt(WTFMove(buffer)); }
147     static String adopt(StringBuffer<UChar>&& buffer) { return StringImpl::adopt(WTFMove(buffer)); }
148     template<typename CharacterType, size_t inlineCapacity, typename OverflowHandler>
149     static String adopt(Vector<CharacterType, inlineCapacity, OverflowHandler>&& vector) { return StringImpl::adopt(WTFMove(vector)); }
150
151     bool isNull() const { return !m_impl; }
152     bool isEmpty() const { return !m_impl || !m_impl->length(); }
153
154     StringImpl* impl() const { return m_impl.get(); }
155     RefPtr<StringImpl> releaseImpl() { return WTFMove(m_impl); }
156
157     unsigned length() const
158     {
159         if (!m_impl)
160             return 0;
161         return m_impl->length();
162     }
163
164     const LChar* characters8() const
165     {
166         if (!m_impl)
167             return 0;
168         ASSERT(m_impl->is8Bit());
169         return m_impl->characters8();
170     }
171
172     const UChar* characters16() const
173     {
174         if (!m_impl)
175             return 0;
176         ASSERT(!m_impl->is8Bit());
177         return m_impl->characters16();
178     }
179
180     // Return characters8() or characters16() depending on CharacterType.
181     template <typename CharacterType>
182     inline const CharacterType* characters() const;
183
184     bool is8Bit() const { return m_impl->is8Bit(); }
185
186     unsigned sizeInBytes() const
187     {
188         if (!m_impl)
189             return 0;
190         return m_impl->length() * (is8Bit() ? sizeof(LChar) : sizeof(UChar));
191     }
192
193     WTF_EXPORT_STRING_API CString ascii() const;
194     WTF_EXPORT_STRING_API CString latin1() const;
195
196     WTF_EXPORT_STRING_API CString utf8(ConversionMode) const;
197     WTF_EXPORT_STRING_API CString utf8() const;
198
199     UChar at(unsigned index) const
200     {
201         if (!m_impl || index >= m_impl->length())
202             return 0;
203         return (*m_impl)[index];
204     }
205     UChar operator[](unsigned index) const { return at(index); }
206
207     WTF_EXPORT_STRING_API static String number(int);
208     WTF_EXPORT_STRING_API static String number(unsigned int);
209     WTF_EXPORT_STRING_API static String number(long);
210     WTF_EXPORT_STRING_API static String number(unsigned long);
211     WTF_EXPORT_STRING_API static String number(long long);
212     WTF_EXPORT_STRING_API static String number(unsigned long long);
213
214     WTF_EXPORT_STRING_API static String number(double, unsigned precision = 6, TrailingZerosTruncatingPolicy = TruncateTrailingZeros);
215
216     // Number to String conversion following the ECMAScript definition.
217     WTF_EXPORT_STRING_API static String numberToStringECMAScript(double);
218     WTF_EXPORT_STRING_API static String numberToStringFixedWidth(double, unsigned decimalPlaces);
219
220     // Find a single character or string, also with match function & latin1 forms.
221     size_t find(UChar c, unsigned start = 0) const
222         { return m_impl ? m_impl->find(c, start) : notFound; }
223
224     size_t find(const String& str) const
225         { return m_impl ? m_impl->find(str.impl()) : notFound; }
226     size_t find(const String& str, unsigned start) const
227         { return m_impl ? m_impl->find(str.impl(), start) : notFound; }
228     size_t findIgnoringASCIICase(const String& str) const
229         { return m_impl ? m_impl->findIgnoringASCIICase(str.impl()) : notFound; }
230     size_t findIgnoringASCIICase(const String& str, unsigned startOffset) const
231         { return m_impl ? m_impl->findIgnoringASCIICase(str.impl(), startOffset) : notFound; }
232
233     size_t find(CharacterMatchFunctionPtr matchFunction, unsigned start = 0) const
234         { return m_impl ? m_impl->find(matchFunction, start) : notFound; }
235     size_t find(const LChar* str, unsigned start = 0) const
236         { return m_impl ? m_impl->find(str, start) : notFound; }
237
238     // Find the last instance of a single character or string.
239     size_t reverseFind(UChar c, unsigned start = UINT_MAX) const
240         { return m_impl ? m_impl->reverseFind(c, start) : notFound; }
241     size_t reverseFind(const String& str, unsigned start = UINT_MAX) const
242         { return m_impl ? m_impl->reverseFind(str.impl(), start) : notFound; }
243
244     // Case insensitive string matching.
245     size_t findIgnoringCase(const LChar* str, unsigned start = 0) const
246         { return m_impl ? m_impl->findIgnoringCase(str, start) : notFound; }
247     size_t findIgnoringCase(const String& str, unsigned start = 0) const
248         { return m_impl ? m_impl->findIgnoringCase(str.impl(), start) : notFound; }
249     size_t reverseFindIgnoringCase(const String& str, unsigned start = UINT_MAX) const
250         { return m_impl ? m_impl->reverseFindIgnoringCase(str.impl(), start) : notFound; }
251
252     // Wrappers for find & reverseFind adding dynamic sensitivity check.
253     size_t find(const LChar* str, unsigned start, bool caseSensitive) const
254         { return caseSensitive ? find(str, start) : findIgnoringCase(str, start); }
255     size_t find(const String& str, unsigned start, bool caseSensitive) const
256         { return caseSensitive ? find(str, start) : findIgnoringCase(str, start); }
257     size_t reverseFind(const String& str, unsigned start, bool caseSensitive) const
258         { return caseSensitive ? reverseFind(str, start) : reverseFindIgnoringCase(str, start); }
259
260     WTF_EXPORT_STRING_API Vector<UChar> charactersWithNullTermination() const;
261
262     WTF_EXPORT_STRING_API UChar32 characterStartingAt(unsigned) const; // Ditto.
263
264     bool contains(UChar c) const { return find(c) != notFound; }
265     bool contains(const LChar* str, bool caseSensitive = true, unsigned startOffset = 0) const
266         { return find(str, startOffset, caseSensitive) != notFound; }
267     bool contains(const String& str) const
268         { return find(str) != notFound; }
269     bool contains(const String& str, bool caseSensitive, unsigned startOffset = 0) const
270         { return find(str, startOffset, caseSensitive) != notFound; }
271     bool containsIgnoringASCIICase(const String& str) const
272         { return findIgnoringASCIICase(str) != notFound; }
273     bool containsIgnoringASCIICase(const String& str, unsigned startOffset) const
274         { return findIgnoringASCIICase(str, startOffset) != notFound; }
275
276     bool startsWith(const String& s) const
277         { return m_impl ? m_impl->startsWith(s.impl()) : s.isEmpty(); }
278     bool startsWithIgnoringASCIICase(const String& s) const
279         { return m_impl ? m_impl->startsWithIgnoringASCIICase(s.impl()) : s.isEmpty(); }
280     bool startsWith(const String& s, bool caseSensitive) const
281         { return m_impl ? m_impl->startsWith(s.impl(), caseSensitive) : s.isEmpty(); }
282     bool startsWith(UChar character) const
283         { return m_impl ? m_impl->startsWith(character) : false; }
284     template<unsigned matchLength>
285     bool startsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const
286         { return m_impl ? m_impl->startsWith<matchLength>(prefix, caseSensitive) : !matchLength; }
287     bool hasInfixStartingAt(const String& prefix, unsigned startOffset) const
288         { return m_impl && prefix.impl() ? m_impl->hasInfixStartingAt(*prefix.impl(), startOffset) : false; }
289
290     bool endsWith(const String& s) const
291         { return m_impl ? m_impl->endsWith(s.impl()) : s.isEmpty(); }
292     bool endsWithIgnoringASCIICase(const String& s) const
293         { return m_impl ? m_impl->endsWithIgnoringASCIICase(s.impl()) : s.isEmpty(); }
294     bool endsWith(const String& s, bool caseSensitive) const
295         { return m_impl ? m_impl->endsWith(s.impl(), caseSensitive) : s.isEmpty(); }
296     bool endsWith(UChar character) const
297         { return m_impl ? m_impl->endsWith(character) : false; }
298     bool endsWith(char character) const { return endsWith(static_cast<UChar>(character)); }
299     template<unsigned matchLength>
300     bool endsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const
301         { return m_impl ? m_impl->endsWith<matchLength>(prefix, caseSensitive) : !matchLength; }
302     bool hasInfixEndingAt(const String& suffix, unsigned endOffset) const
303         { return m_impl && suffix.impl() ? m_impl->hasInfixEndingAt(*suffix.impl(), endOffset) : false; }
304
305     WTF_EXPORT_STRING_API void append(const String&);
306     WTF_EXPORT_STRING_API void append(LChar);
307     void append(char c) { append(static_cast<LChar>(c)); };
308     WTF_EXPORT_STRING_API void append(UChar);
309     WTF_EXPORT_STRING_API void append(const LChar*, unsigned length);
310     WTF_EXPORT_STRING_API void append(const UChar*, unsigned length);
311     WTF_EXPORT_STRING_API void insert(const String&, unsigned pos);
312
313     String& replace(UChar a, UChar b) { if (m_impl) m_impl = m_impl->replace(a, b); return *this; }
314     String& replace(UChar a, const String& b) { if (m_impl) m_impl = m_impl->replace(a, b.impl()); return *this; }
315     String& replace(const String& a, const String& b) { if (m_impl) m_impl = m_impl->replace(a.impl(), b.impl()); return *this; }
316     String& replace(unsigned index, unsigned len, const String& b) { if (m_impl) m_impl = m_impl->replace(index, len, b.impl()); return *this; }
317
318     template<unsigned characterCount>
319     ALWAYS_INLINE String& replaceWithLiteral(UChar a, const char (&characters)[characterCount])
320     {
321         if (m_impl)
322             m_impl = m_impl->replace(a, characters, characterCount - 1);
323
324         return *this;
325     }
326
327     WTF_EXPORT_STRING_API void truncate(unsigned len);
328     WTF_EXPORT_STRING_API void remove(unsigned pos, int len = 1);
329
330     WTF_EXPORT_STRING_API String substring(unsigned pos, unsigned len = UINT_MAX) const;
331     WTF_EXPORT_STRING_API String substringSharingImpl(unsigned pos, unsigned len = UINT_MAX) const;
332     String left(unsigned len) const { return substring(0, len); }
333     String right(unsigned len) const { return substring(length() - len, len); }
334
335     WTF_EXPORT_STRING_API String convertToASCIILowercase() const;
336     WTF_EXPORT_STRING_API String convertToASCIIUppercase() const;
337     WTF_EXPORT_STRING_API String convertToLowercaseWithoutLocale() const;
338     WTF_EXPORT_STRING_API String convertToLowercaseWithoutLocaleStartingAtFailingIndex8Bit(unsigned) const;
339     WTF_EXPORT_STRING_API String convertToUppercaseWithoutLocale() const;
340     WTF_EXPORT_STRING_API String convertToLowercaseWithLocale(const AtomicString& localeIdentifier) const;
341     WTF_EXPORT_STRING_API String convertToUppercaseWithLocale(const AtomicString& localeIdentifier) const;
342
343     WTF_EXPORT_STRING_API String stripWhiteSpace() const;
344     WTF_EXPORT_STRING_API String stripWhiteSpace(IsWhiteSpaceFunctionPtr) const;
345     WTF_EXPORT_STRING_API String simplifyWhiteSpace() const;
346     WTF_EXPORT_STRING_API String simplifyWhiteSpace(IsWhiteSpaceFunctionPtr) const;
347
348     WTF_EXPORT_STRING_API String removeCharacters(CharacterMatchFunctionPtr) const;
349     template<bool isSpecialCharacter(UChar)> bool isAllSpecialCharacters() const;
350
351     // Returns the string with case folded for case insensitive comparison.
352     // Use convertToASCIILowercase instead if ASCII case insensitive comparison is desired.
353     WTF_EXPORT_STRING_API String foldCase() const;
354
355     WTF_EXPORT_STRING_API static String format(const char *, ...) WTF_ATTRIBUTE_PRINTF(1, 2);
356
357     // Returns an uninitialized string. The characters needs to be written
358     // into the buffer returned in data before the returned string is used.
359     // Failure to do this will have unpredictable results.
360     static String createUninitialized(unsigned length, UChar*& data) { return StringImpl::createUninitialized(length, data); }
361     static String createUninitialized(unsigned length, LChar*& data) { return StringImpl::createUninitialized(length, data); }
362
363     WTF_EXPORT_STRING_API void split(const String& separator, bool allowEmptyEntries, Vector<String>& result) const;
364     void split(const String& separator, Vector<String>& result) const
365     {
366         split(separator, false, result);
367     }
368
369     using SplitFunctor = WTF::Function<void(const StringView&)>;
370     WTF_EXPORT_STRING_API void split(UChar separator, bool allowEmptyEntries, const SplitFunctor&) const;
371     WTF_EXPORT_STRING_API void split(UChar separator, bool allowEmptyEntries, Vector<String>& result) const;
372     void split(UChar separator, Vector<String>& result) const
373     {
374         split(separator, false, result);
375     }
376     Vector<String> split(UChar separator) const
377     {
378         Vector<String> result;
379         split(separator, false, result);
380         return result;
381     }
382     Vector<String> split(const String& separator) const
383     {
384         Vector<String> result;
385         split(separator, false, result);
386         return result;
387     }
388
389     WTF_EXPORT_STRING_API int toIntStrict(bool* ok = nullptr, int base = 10) const;
390     WTF_EXPORT_STRING_API unsigned toUIntStrict(bool* ok = nullptr, int base = 10) const;
391     WTF_EXPORT_STRING_API int64_t toInt64Strict(bool* ok = nullptr, int base = 10) const;
392     WTF_EXPORT_STRING_API uint64_t toUInt64Strict(bool* ok = nullptr, int base = 10) const;
393     WTF_EXPORT_STRING_API intptr_t toIntPtrStrict(bool* ok = nullptr, int base = 10) const;
394
395     WTF_EXPORT_STRING_API int toInt(bool* ok = nullptr) const;
396     WTF_EXPORT_STRING_API unsigned toUInt(bool* ok = nullptr) const;
397     WTF_EXPORT_STRING_API int64_t toInt64(bool* ok = nullptr) const;
398     WTF_EXPORT_STRING_API uint64_t toUInt64(bool* ok = nullptr) const;
399     WTF_EXPORT_STRING_API intptr_t toIntPtr(bool* ok = nullptr) const;
400
401     // FIXME: Like the strict functions above, these give false for "ok" when there is trailing garbage.
402     // Like the non-strict functions above, these return the value when there is trailing garbage.
403     // It would be better if these were more consistent with the above functions instead.
404     WTF_EXPORT_STRING_API double toDouble(bool* ok = nullptr) const;
405     WTF_EXPORT_STRING_API float toFloat(bool* ok = nullptr) const;
406
407     bool percentage(int& percentage) const;
408
409 #if COMPILER_SUPPORTS(CXX_REFERENCE_QUALIFIED_FUNCTIONS)
410     WTF_EXPORT_STRING_API String isolatedCopy() const &;
411     WTF_EXPORT_STRING_API String isolatedCopy() &&;
412 #else
413     WTF_EXPORT_STRING_API String isolatedCopy() const;
414 #endif
415
416     WTF_EXPORT_STRING_API bool isSafeToSendToAnotherThread() const;
417
418     // Prevent Strings from being implicitly convertable to bool as it will be ambiguous on any platform that
419     // allows implicit conversion to another pointer type (e.g., Mac allows implicit conversion to NSString *).
420     typedef struct ImplicitConversionFromWTFStringToBoolDisallowedA* (String::*UnspecifiedBoolTypeA);
421     typedef struct ImplicitConversionFromWTFStringToBoolDisallowedB* (String::*UnspecifiedBoolTypeB);
422     operator UnspecifiedBoolTypeA() const;
423     operator UnspecifiedBoolTypeB() const;
424
425 #if USE(CF)
426     WTF_EXPORT_STRING_API String(CFStringRef);
427     WTF_EXPORT_STRING_API RetainPtr<CFStringRef> createCFString() const;
428 #endif
429
430 #ifdef __OBJC__
431     WTF_EXPORT_STRING_API String(NSString *);
432
433     // This conversion converts the null string to an empty NSString rather than to nil.
434     // Given Cocoa idioms, this is a more useful default. Clients that need to preserve the
435     // null string can check isNull explicitly.
436     operator NSString *() const;
437 #endif
438
439     WTF_EXPORT_STRING_API static String make8BitFrom16BitSource(const UChar*, size_t);
440     template<size_t inlineCapacity>
441     static String make8BitFrom16BitSource(const Vector<UChar, inlineCapacity>& buffer)
442     {
443         return make8BitFrom16BitSource(buffer.data(), buffer.size());
444     }
445
446     WTF_EXPORT_STRING_API static String make16BitFrom8BitSource(const LChar*, size_t);
447
448     // String::fromUTF8 will return a null string if
449     // the input data contains invalid UTF-8 sequences.
450     WTF_EXPORT_STRING_API static String fromUTF8(const LChar*, size_t);
451     WTF_EXPORT_STRING_API static String fromUTF8(const LChar*);
452     static String fromUTF8(const char* s, size_t length) { return fromUTF8(reinterpret_cast<const LChar*>(s), length); };
453     static String fromUTF8(const char* s) { return fromUTF8(reinterpret_cast<const LChar*>(s)); };
454     WTF_EXPORT_STRING_API static String fromUTF8(const CString&);
455     static String fromUTF8(const Vector<LChar>& characters);
456
457     // 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.
458     WTF_EXPORT_STRING_API static String fromUTF8WithLatin1Fallback(const LChar*, size_t);
459     static String fromUTF8WithLatin1Fallback(const char* s, size_t length) { return fromUTF8WithLatin1Fallback(reinterpret_cast<const LChar*>(s), length); };
460
461     // Determines the writing direction using the Unicode Bidi Algorithm rules P2 and P3.
462     UCharDirection defaultWritingDirection(bool* hasStrongDirectionality = nullptr) const
463     {
464         if (m_impl)
465             return m_impl->defaultWritingDirection(hasStrongDirectionality);
466         if (hasStrongDirectionality)
467             *hasStrongDirectionality = false;
468         return U_LEFT_TO_RIGHT;
469     }
470
471     bool containsOnlyASCII() const;
472     bool containsOnlyLatin1() const;
473     bool containsOnlyWhitespace() const { return !m_impl || m_impl->containsOnlyWhitespace(); }
474
475     // Hash table deleted values, which are only constructed and never copied or destroyed.
476     String(WTF::HashTableDeletedValueType) : m_impl(WTF::HashTableDeletedValue) { }
477     bool isHashTableDeletedValue() const { return m_impl.isHashTableDeletedValue(); }
478
479     unsigned existingHash() const { return isNull() ? 0 : impl()->existingHash(); }
480
481 #ifndef NDEBUG
482     WTF_EXPORT_STRING_API void show() const;
483 #endif
484
485     // Workaround for a compiler bug. Use operator[] instead.
486     UChar characterAt(unsigned index) const
487     {
488         if (!m_impl || index >= m_impl->length())
489             return 0;
490         return (*m_impl)[index];
491     }
492
493     // Turns this String empty if the StringImpl is not referenced by anyone else.
494     // This is useful for clearing String-based caches.
495     void clearImplIfNotShared()
496     {
497         if (m_impl && m_impl->hasOneRef())
498             m_impl = nullptr;
499     }
500
501 private:
502     template <typename CharacterType>
503     void removeInternal(const CharacterType*, unsigned, int);
504
505     template <typename CharacterType>
506     void appendInternal(CharacterType);
507
508     RefPtr<StringImpl> m_impl;
509 };
510
511 static_assert(sizeof(String) == sizeof(void*), "String should effectively be a pointer to a StringImpl, and efficient to pass by value");
512
513 inline bool operator==(const String& a, const String& b) { return equal(a.impl(), b.impl()); }
514 inline bool operator==(const String& a, const LChar* b) { return equal(a.impl(), b); }
515 inline bool operator==(const String& a, const char* b) { return equal(a.impl(), reinterpret_cast<const LChar*>(b)); }
516 inline bool operator==(const LChar* a, const String& b) { return equal(a, b.impl()); }
517 inline bool operator==(const char* a, const String& b) { return equal(reinterpret_cast<const LChar*>(a), b.impl()); }
518 template<size_t inlineCapacity> inline bool operator==(const Vector<char, inlineCapacity>& a, const String& b) { return equal(b.impl(), a.data(), a.size()); }
519 template<size_t inlineCapacity> inline bool operator==(const String& a, const Vector<char, inlineCapacity>& b) { return b == a; }
520
521
522 inline bool operator!=(const String& a, const String& b) { return !equal(a.impl(), b.impl()); }
523 inline bool operator!=(const String& a, const LChar* b) { return !equal(a.impl(), b); }
524 inline bool operator!=(const String& a, const char* b) { return !equal(a.impl(), reinterpret_cast<const LChar*>(b)); }
525 inline bool operator!=(const LChar* a, const String& b) { return !equal(a, b.impl()); }
526 inline bool operator!=(const char* a, const String& b) { return !equal(reinterpret_cast<const LChar*>(a), b.impl()); }
527 template<size_t inlineCapacity> inline bool operator!=(const Vector<char, inlineCapacity>& a, const String& b) { return !(a == b); }
528 template<size_t inlineCapacity> inline bool operator!=(const String& a, const Vector<char, inlineCapacity>& b) { return b != a; }
529
530 bool equalIgnoringASCIICase(const String&, const String&);
531 bool equalIgnoringASCIICase(const String&, const char*);
532
533 template<unsigned length> bool equalLettersIgnoringASCIICase(const String&, const char (&lowercaseLetters)[length]);
534 template<unsigned length> bool startsWithLettersIgnoringASCIICase(const String&, const char (&lowercaseLetters)[length]);
535
536 inline bool equalIgnoringNullity(const String& a, const String& b) { return equalIgnoringNullity(a.impl(), b.impl()); }
537 template<size_t inlineCapacity> inline bool equalIgnoringNullity(const Vector<UChar, inlineCapacity>& a, const String& b) { return equalIgnoringNullity(a, b.impl()); }
538
539 inline bool operator!(const String& str) { return str.isNull(); }
540
541 inline void swap(String& a, String& b) { a.swap(b); }
542
543 #ifdef __OBJC__
544
545 // Used in a small number of places where the long standing behavior has been "nil if empty".
546 NSString * nsStringNilIfEmpty(const String&);
547
548 #endif
549
550 // Definitions of string operations
551
552 inline String::String(StringImpl& impl)
553     : m_impl(&impl)
554 {
555 }
556
557 inline String::String(StringImpl* impl)
558     : m_impl(impl)
559 {
560 }
561
562 inline String::String(Ref<StringImpl>&& impl)
563     : m_impl(WTFMove(impl))
564 {
565 }
566
567 inline String::String(RefPtr<StringImpl>&& impl)
568     : m_impl(WTFMove(impl))
569 {
570 }
571
572 inline String::String(Ref<AtomicStringImpl>&& impl)
573     : m_impl(WTFMove(impl))
574 {
575 }
576
577 inline String::String(RefPtr<AtomicStringImpl>&& impl)
578     : m_impl(WTFMove(impl))
579 {
580 }
581
582 inline String::String(StaticStringImpl& impl)
583     : m_impl(reinterpret_cast<StringImpl*>(&impl))
584 {
585 }
586
587 inline String::String(StaticStringImpl* impl)
588     : m_impl(reinterpret_cast<StringImpl*>(impl))
589 {
590 }
591
592 template<size_t inlineCapacity, typename OverflowHandler>
593 String::String(const Vector<UChar, inlineCapacity, OverflowHandler>& vector)
594     : m_impl(vector.size() ? StringImpl::create(vector.data(), vector.size()) : Ref<StringImpl>(*StringImpl::empty()))
595 {
596 }
597
598 template<>
599 inline const LChar* String::characters<LChar>() const
600 {
601     ASSERT(is8Bit());
602     return characters8();
603 }
604
605 template<>
606 inline const UChar* String::characters<UChar>() const
607 {
608     ASSERT(!is8Bit());
609     return characters16();
610 }
611
612 inline bool String::containsOnlyLatin1() const
613 {
614     if (isEmpty())
615         return true;
616
617     if (is8Bit())
618         return true;
619
620     const UChar* characters = characters16();
621     UChar ored = 0;
622     for (size_t i = 0; i < m_impl->length(); ++i)
623         ored |= characters[i];
624     return !(ored & 0xFF00);
625 }
626
627 #ifdef __OBJC__
628
629 inline String::operator NSString *() const
630 {
631     if (!m_impl)
632         return @"";
633     return *m_impl;
634 }
635
636 inline NSString * nsStringNilIfEmpty(const String& string)
637 {
638     if (string.isEmpty())
639         return nil;
640     return *string.impl();
641 }
642
643 #endif
644
645 inline bool String::containsOnlyASCII() const
646 {
647     if (isEmpty())
648         return true;
649
650     if (is8Bit())
651         return charactersAreAllASCII(characters8(), m_impl->length());
652
653     return charactersAreAllASCII(characters16(), m_impl->length());
654 }
655
656 WTF_EXPORT_STRING_API int codePointCompare(const String&, const String&);
657
658 inline bool codePointCompareLessThan(const String& a, const String& b)
659 {
660     return codePointCompare(a.impl(), b.impl()) < 0;
661 }
662
663 template<typename CharacterType>
664 inline void appendNumber(Vector<CharacterType>& vector, unsigned char number)
665 {
666     int numberLength = number > 99 ? 3 : (number > 9 ? 2 : 1);
667     size_t vectorSize = vector.size();
668     vector.grow(vectorSize + numberLength);
669
670     switch (numberLength) {
671     case 3:
672         vector[vectorSize + 2] = number % 10 + '0';
673         number /= 10;
674         FALLTHROUGH;
675
676     case 2:
677         vector[vectorSize + 1] = number % 10 + '0';
678         number /= 10;
679         FALLTHROUGH;
680
681     case 1:
682         vector[vectorSize] = number % 10 + '0';
683     }
684 }
685
686 template<bool isSpecialCharacter(UChar), typename CharacterType>
687 inline bool isAllSpecialCharacters(const CharacterType* characters, size_t length)
688 {
689     for (size_t i = 0; i < length; ++i) {
690         if (!isSpecialCharacter(characters[i]))
691             return false;
692     }
693     return true;
694 }
695
696 template<bool isSpecialCharacter(UChar)>
697 inline bool String::isAllSpecialCharacters() const
698 {
699     size_t len = length();
700
701     if (!len)
702         return true;
703
704     if (is8Bit())
705         return WTF::isAllSpecialCharacters<isSpecialCharacter, LChar>(characters8(), len);
706     return WTF::isAllSpecialCharacters<isSpecialCharacter, UChar>(characters16(), len);
707 }
708
709 // StringHash is the default hash for String
710 template<typename T> struct DefaultHash;
711 template<> struct DefaultHash<String> {
712     typedef StringHash Hash;
713 };
714
715 template <> struct VectorTraits<String> : SimpleClassVectorTraits { };
716
717 class ASCIILiteral {
718 public:
719     explicit ASCIILiteral(const char* characters) : m_characters(characters) { }
720     operator const char*() { return m_characters; }
721
722 private:
723     const char* m_characters;
724 };
725
726 // Shared global empty string.
727 WTF_EXPORT_STRING_API const String& emptyString();
728
729 inline String String::fromUTF8(const Vector<LChar>& characters)
730 {
731     if (characters.isEmpty())
732         return emptyString();
733     return fromUTF8(characters.data(), characters.size());
734 }
735
736 template<unsigned length> inline bool equalLettersIgnoringASCIICase(const String& string, const char (&lowercaseLetters)[length])
737 {
738     return equalLettersIgnoringASCIICase(string.impl(), lowercaseLetters);
739 }
740
741 inline bool equalIgnoringASCIICase(const String& a, const String& b)
742 {
743     return equalIgnoringASCIICase(a.impl(), b.impl());
744 }
745
746 inline bool equalIgnoringASCIICase(const String& a, const char* b)
747 {
748     return equalIgnoringASCIICase(a.impl(), b);
749 }
750
751 template<unsigned length> inline bool startsWithLettersIgnoringASCIICase(const String& string, const char (&lowercaseLetters)[length])
752 {
753     return startsWithLettersIgnoringASCIICase(string.impl(), lowercaseLetters);
754 }
755
756 template<> struct IntegerToStringConversionTrait<String> {
757     using ReturnType = String;
758     using AdditionalArgumentType = void;
759     static String flush(LChar* characters, unsigned length, void*) { return { characters, length }; }
760 };
761
762 } // namespace WTF
763
764 using WTF::CString;
765 using WTF::KeepTrailingZeros;
766 using WTF::String;
767 using WTF::emptyString;
768 using WTF::appendNumber;
769 using WTF::charactersAreAllASCII;
770 using WTF::charactersToIntStrict;
771 using WTF::charactersToUIntStrict;
772 using WTF::charactersToInt64Strict;
773 using WTF::charactersToUInt64Strict;
774 using WTF::charactersToIntPtrStrict;
775 using WTF::charactersToInt;
776 using WTF::charactersToUInt;
777 using WTF::charactersToInt64;
778 using WTF::charactersToUInt64;
779 using WTF::charactersToIntPtr;
780 using WTF::charactersToDouble;
781 using WTF::charactersToFloat;
782 using WTF::equal;
783 using WTF::find;
784 using WTF::isAllSpecialCharacters;
785 using WTF::isSpaceOrNewline;
786 using WTF::reverseFind;
787 using WTF::ASCIILiteral;
788
789 #include <wtf/text/AtomicString.h>
790
791 #endif