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