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