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