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