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