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