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