[iOS] Add optimized version of StringImpl's equal(LChar*,LChar*) for Apple CPUs
[WebKit-https.git] / Source / WTF / wtf / text / StringImpl.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2013 Apple Inc. All rights reserved.
4  * Copyright (C) 2009 Google Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef StringImpl_h
24 #define StringImpl_h
25
26 #include <limits.h>
27 #include <wtf/ASCIICType.h>
28 #include <wtf/Forward.h>
29 #include <wtf/StdLibExtras.h>
30 #include <wtf/StringHasher.h>
31 #include <wtf/Vector.h>
32 #include <wtf/unicode/Unicode.h>
33
34 #if PLATFORM(QT)
35 #include <QString>
36 #endif
37
38 #if USE(CF)
39 typedef const struct __CFString * CFStringRef;
40 #endif
41
42 #ifdef __OBJC__
43 @class NSString;
44 #endif
45
46 #if PLATFORM(BLACKBERRY)
47 #include <BlackBerryPlatformString.h>
48 #endif
49
50 // FIXME: This is a temporary layering violation while we move string code to WTF.
51 // Landing the file moves in one patch, will follow on with patches to change the namespaces.
52 namespace JSC {
53 struct IdentifierASCIIStringTranslator;
54 namespace LLInt { class Data; }
55 class LLIntOffsetsExtractor;
56 template <typename T> struct IdentifierCharBufferTranslator;
57 struct IdentifierLCharFromUCharTranslator;
58 }
59
60 namespace WTF {
61
62 struct CStringTranslator;
63 template<typename CharacterType> struct HashAndCharactersTranslator;
64 struct HashAndUTF8CharactersTranslator;
65 struct LCharBufferTranslator;
66 struct CharBufferFromLiteralDataTranslator;
67 class MemoryObjectInfo;
68 struct SubstringTranslator;
69 struct UCharBufferTranslator;
70 template<typename> class RetainPtr;
71
72 enum TextCaseSensitivity { TextCaseSensitive, TextCaseInsensitive };
73
74 typedef bool (*CharacterMatchFunctionPtr)(UChar);
75 typedef bool (*IsWhiteSpaceFunctionPtr)(UChar);
76
77 // Define STRING_STATS to turn on run time statistics of string sizes and memory usage
78 #undef STRING_STATS
79
80 #ifdef STRING_STATS
81 struct StringStats {
82     inline void add8BitString(unsigned length, bool isSubString = false)
83     {
84         ++m_totalNumberStrings;
85         ++m_number8BitStrings;
86         if (!isSubString)
87             m_total8BitData += length;
88     }
89
90     inline void add16BitString(unsigned length, bool isSubString = false)
91     {
92         ++m_totalNumberStrings;
93         ++m_number16BitStrings;
94         if (!isSubString)
95             m_total16BitData += length;
96     }
97
98     inline void addUpconvertedString(unsigned length)
99     {
100         ++m_numberUpconvertedStrings;
101         m_totalUpconvertedData += length;
102     }
103
104     void removeString(StringImpl*);
105     void printStats();
106
107     static const unsigned s_printStringStatsFrequency = 5000;
108     static unsigned s_stringRemovesTillPrintStats;
109
110     unsigned m_totalNumberStrings;
111     unsigned m_number8BitStrings;
112     unsigned m_number16BitStrings;
113     unsigned m_numberUpconvertedStrings;
114     unsigned long long m_total8BitData;
115     unsigned long long m_total16BitData;
116     unsigned long long m_totalUpconvertedData;
117 };
118
119 #define STRING_STATS_ADD_8BIT_STRING(length) StringImpl::stringStats().add8BitString(length)
120 #define STRING_STATS_ADD_8BIT_STRING2(length, isSubString) StringImpl::stringStats().add8BitString(length, isSubString)
121 #define STRING_STATS_ADD_16BIT_STRING(length) StringImpl::stringStats().add16BitString(length)
122 #define STRING_STATS_ADD_16BIT_STRING2(length, isSubString) StringImpl::stringStats().add16BitString(length, isSubString)
123 #define STRING_STATS_ADD_UPCONVERTED_STRING(length) StringImpl::stringStats().addUpconvertedString(length)
124 #define STRING_STATS_REMOVE_STRING(string) StringImpl::stringStats().removeString(string)
125 #else
126 #define STRING_STATS_ADD_8BIT_STRING(length) ((void)0)
127 #define STRING_STATS_ADD_8BIT_STRING2(length, isSubString) ((void)0)
128 #define STRING_STATS_ADD_16BIT_STRING(length) ((void)0)
129 #define STRING_STATS_ADD_16BIT_STRING2(length, isSubString) ((void)0)
130 #define STRING_STATS_ADD_UPCONVERTED_STRING(length) ((void)0)
131 #define STRING_STATS_REMOVE_STRING(string) ((void)0)
132 #endif
133
134 class StringImpl {
135     WTF_MAKE_NONCOPYABLE(StringImpl); WTF_MAKE_FAST_ALLOCATED;
136     friend struct JSC::IdentifierASCIIStringTranslator;
137     friend struct JSC::IdentifierCharBufferTranslator<LChar>;
138     friend struct JSC::IdentifierCharBufferTranslator<UChar>;
139     friend struct JSC::IdentifierLCharFromUCharTranslator;
140     friend struct WTF::CStringTranslator;
141     template<typename CharacterType> friend struct WTF::HashAndCharactersTranslator;
142     friend struct WTF::HashAndUTF8CharactersTranslator;
143     friend struct WTF::CharBufferFromLiteralDataTranslator;
144     friend struct WTF::LCharBufferTranslator;
145     friend struct WTF::SubstringTranslator;
146     friend struct WTF::UCharBufferTranslator;
147     friend class AtomicStringImpl;
148     friend class JSC::LLInt::Data;
149     friend class JSC::LLIntOffsetsExtractor;
150     
151 private:
152     enum BufferOwnership {
153         BufferInternal,
154         BufferOwned,
155         BufferSubstring,
156 #if PLATFORM(QT)
157         BufferAdoptedQString
158 #endif
159         // NOTE: Adding more ownership types needs to extend m_hashAndFlags as we're at capacity
160     };
161
162     // Used to construct static strings, which have an special refCount that can never hit zero.
163     // This means that the static string will never be destroyed, which is important because
164     // static strings will be shared across threads & ref-counted in a non-threadsafe manner.
165     enum ConstructStaticStringTag { ConstructStaticString };
166     StringImpl(const UChar* characters, unsigned length, ConstructStaticStringTag)
167         : m_refCount(s_refCountFlagIsStaticString)
168         , m_length(length)
169         , m_data16(characters)
170         , m_buffer(0)
171         , m_hashAndFlags(s_hashFlagIsIdentifier | BufferOwned)
172     {
173         // Ensure that the hash is computed so that AtomicStringHash can call existingHash()
174         // with impunity. The empty string is special because it is never entered into
175         // AtomicString's HashKey, but still needs to compare correctly.
176         STRING_STATS_ADD_16BIT_STRING(m_length);
177
178         hash();
179     }
180
181     // Used to construct static strings, which have an special refCount that can never hit zero.
182     // This means that the static string will never be destroyed, which is important because
183     // static strings will be shared across threads & ref-counted in a non-threadsafe manner.
184     StringImpl(const LChar* characters, unsigned length, ConstructStaticStringTag)
185         : m_refCount(s_refCountFlagIsStaticString)
186         , m_length(length)
187         , m_data8(characters)
188         , m_buffer(0)
189         , m_hashAndFlags(s_hashFlag8BitBuffer | s_hashFlagIsIdentifier | BufferOwned)
190     {
191         // Ensure that the hash is computed so that AtomicStringHash can call existingHash()
192         // with impunity. The empty string is special because it is never entered into
193         // AtomicString's HashKey, but still needs to compare correctly.
194         STRING_STATS_ADD_8BIT_STRING(m_length);
195
196         hash();
197     }
198
199     // FIXME: there has to be a less hacky way to do this.
200     enum Force8Bit { Force8BitConstructor };
201     // Create a normal 8-bit string with internal storage (BufferInternal)
202     StringImpl(unsigned length, Force8Bit)
203         : m_refCount(s_refCountIncrement)
204         , m_length(length)
205         , m_data8(reinterpret_cast<const LChar*>(this + 1))
206         , m_buffer(0)
207         , m_hashAndFlags(s_hashFlag8BitBuffer | BufferInternal)
208     {
209         ASSERT(m_data8);
210         ASSERT(m_length);
211
212         STRING_STATS_ADD_8BIT_STRING(m_length);
213     }
214
215     // Create a normal 16-bit string with internal storage (BufferInternal)
216     StringImpl(unsigned length)
217         : m_refCount(s_refCountIncrement)
218         , m_length(length)
219         , m_data16(reinterpret_cast<const UChar*>(this + 1))
220         , m_buffer(0)
221         , m_hashAndFlags(BufferInternal)
222     {
223         ASSERT(m_data16);
224         ASSERT(m_length);
225
226         STRING_STATS_ADD_16BIT_STRING(m_length);
227     }
228
229     // Create a StringImpl adopting ownership of the provided buffer (BufferOwned)
230     StringImpl(const LChar* characters, unsigned length)
231         : m_refCount(s_refCountIncrement)
232         , m_length(length)
233         , m_data8(characters)
234         , m_buffer(0)
235         , m_hashAndFlags(s_hashFlag8BitBuffer | BufferOwned)
236     {
237         ASSERT(m_data8);
238         ASSERT(m_length);
239
240         STRING_STATS_ADD_8BIT_STRING(m_length);
241     }
242
243     enum ConstructFromLiteralTag { ConstructFromLiteral };
244     StringImpl(const char* characters, unsigned length, ConstructFromLiteralTag)
245         : m_refCount(s_refCountIncrement)
246         , m_length(length)
247         , m_data8(reinterpret_cast<const LChar*>(characters))
248         , m_buffer(0)
249         , m_hashAndFlags(s_hashFlag8BitBuffer | BufferInternal | s_hashFlagHasTerminatingNullCharacter)
250     {
251         ASSERT(m_data8);
252         ASSERT(m_length);
253         ASSERT(!characters[length]);
254
255         STRING_STATS_ADD_8BIT_STRING(0);
256     }
257
258     // Create a StringImpl adopting ownership of the provided buffer (BufferOwned)
259     StringImpl(const UChar* characters, unsigned length)
260         : m_refCount(s_refCountIncrement)
261         , m_length(length)
262         , m_data16(characters)
263         , m_buffer(0)
264         , m_hashAndFlags(BufferOwned)
265     {
266         ASSERT(m_data16);
267         ASSERT(m_length);
268
269         STRING_STATS_ADD_16BIT_STRING(m_length);
270     }
271
272     // Used to create new strings that are a substring of an existing 8-bit StringImpl (BufferSubstring)
273     StringImpl(const LChar* characters, unsigned length, PassRefPtr<StringImpl> base)
274         : m_refCount(s_refCountIncrement)
275         , m_length(length)
276         , m_data8(characters)
277         , m_substringBuffer(base.leakRef())
278         , m_hashAndFlags(s_hashFlag8BitBuffer | BufferSubstring)
279     {
280         ASSERT(is8Bit());
281         ASSERT(m_data8);
282         ASSERT(m_length);
283         ASSERT(m_substringBuffer->bufferOwnership() != BufferSubstring);
284
285         STRING_STATS_ADD_8BIT_STRING2(m_length, true);
286     }
287
288     // Used to create new strings that are a substring of an existing 16-bit StringImpl (BufferSubstring)
289     StringImpl(const UChar* characters, unsigned length, PassRefPtr<StringImpl> base)
290         : m_refCount(s_refCountIncrement)
291         , m_length(length)
292         , m_data16(characters)
293         , m_substringBuffer(base.leakRef())
294         , m_hashAndFlags(BufferSubstring)
295     {
296         ASSERT(!is8Bit());
297         ASSERT(m_data16);
298         ASSERT(m_length);
299         ASSERT(m_substringBuffer->bufferOwnership() != BufferSubstring);
300
301         STRING_STATS_ADD_16BIT_STRING2(m_length, true);
302     }
303
304     enum CreateEmptyUnique_T { CreateEmptyUnique };
305     StringImpl(CreateEmptyUnique_T)
306         : m_refCount(s_refCountIncrement)
307         , m_length(0)
308         , m_data16(reinterpret_cast<const UChar*>(1))
309         , m_buffer(0)
310     {
311         ASSERT(m_data16);
312         // Set the hash early, so that all empty unique StringImpls have a hash,
313         // and don't use the normal hashing algorithm - the unique nature of these
314         // keys means that we don't need them to match any other string (in fact,
315         // that's exactly the oposite of what we want!), and teh normal hash would
316         // lead to lots of conflicts.
317         unsigned hash = reinterpret_cast<uintptr_t>(this);
318         hash <<= s_flagCount;
319         if (!hash)
320             hash = 1 << s_flagCount;
321         m_hashAndFlags = hash | BufferInternal;
322
323         STRING_STATS_ADD_16BIT_STRING(m_length);
324     }
325
326 #if PLATFORM(QT)
327     // Used to create new strings that adopt an existing QString's data
328     enum ConstructAdoptedQStringTag { ConstructAdoptedQString };
329     StringImpl(QStringData* qStringData, ConstructAdoptedQStringTag)
330         : m_refCount(s_refCountIncrement)
331         , m_length(qStringData->size)
332         , m_data16(0)
333         , m_qStringData(qStringData)
334         , m_hashAndFlags(BufferAdoptedQString)
335     {
336         ASSERT(m_length);
337
338         // We ref the string-data to ensure it will be valid for the lifetime of
339         // this string. We then deref it in the destructor, so that the string
340         // data can eventually be freed.
341         m_qStringData->ref.ref();
342
343         // Now that we have a ref we can safely reference the string data
344         m_data16 = reinterpret_cast_ptr<const UChar*>(qStringData->data());
345         ASSERT(m_data16);
346
347         STRING_STATS_ADD_16BIT_STRING(m_length);
348     }
349 #endif
350
351 public:
352     WTF_EXPORT_STRING_API ~StringImpl();
353
354     WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> create(const UChar*, unsigned length);
355     WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> create(const LChar*, unsigned length);
356     WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> create8BitIfPossible(const UChar*, unsigned length);
357     template<size_t inlineCapacity>
358     static PassRefPtr<StringImpl> create8BitIfPossible(const Vector<UChar, inlineCapacity>& vector)
359     {
360         return create8BitIfPossible(vector.data(), vector.size());
361     }
362
363     ALWAYS_INLINE static PassRefPtr<StringImpl> create(const char* s, unsigned length) { return create(reinterpret_cast<const LChar*>(s), length); }
364     WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> create(const LChar*);
365     ALWAYS_INLINE static PassRefPtr<StringImpl> create(const char* s) { return create(reinterpret_cast<const LChar*>(s)); }
366
367     static ALWAYS_INLINE PassRefPtr<StringImpl> create8(PassRefPtr<StringImpl> rep, unsigned offset, unsigned length)
368     {
369         ASSERT(rep);
370         ASSERT(length <= rep->length());
371
372         if (!length)
373             return empty();
374
375         ASSERT(rep->is8Bit());
376         StringImpl* ownerRep = (rep->bufferOwnership() == BufferSubstring) ? rep->m_substringBuffer : rep.get();
377         return adoptRef(new StringImpl(rep->m_data8 + offset, length, ownerRep));
378     }
379
380     static ALWAYS_INLINE PassRefPtr<StringImpl> create(PassRefPtr<StringImpl> rep, unsigned offset, unsigned length)
381     {
382         ASSERT(rep);
383         ASSERT(length <= rep->length());
384
385         if (!length)
386             return empty();
387
388         StringImpl* ownerRep = (rep->bufferOwnership() == BufferSubstring) ? rep->m_substringBuffer : rep.get();
389         if (rep->is8Bit())
390             return adoptRef(new StringImpl(rep->m_data8 + offset, length, ownerRep));
391         return adoptRef(new StringImpl(rep->m_data16 + offset, length, ownerRep));
392     }
393
394     WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> createFromLiteral(const char* characters, unsigned length);
395     template<unsigned charactersCount>
396     ALWAYS_INLINE static PassRefPtr<StringImpl> createFromLiteral(const char (&characters)[charactersCount])
397     {
398         COMPILE_ASSERT(charactersCount > 1, StringImplFromLiteralNotEmpty);
399         COMPILE_ASSERT((charactersCount - 1 <= ((unsigned(~0) - sizeof(StringImpl)) / sizeof(LChar))), StringImplFromLiteralCannotOverflow);
400
401         return createFromLiteral(characters, charactersCount - 1);
402     }
403     WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> createFromLiteral(const char* characters);
404
405     WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> createUninitialized(unsigned length, LChar*& data);
406     WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> createUninitialized(unsigned length, UChar*& data);
407     template <typename T> static ALWAYS_INLINE PassRefPtr<StringImpl> tryCreateUninitialized(unsigned length, T*& output)
408     {
409         if (!length) {
410             output = 0;
411             return empty();
412         }
413
414         if (length > ((std::numeric_limits<unsigned>::max() - sizeof(StringImpl)) / sizeof(T))) {
415             output = 0;
416             return 0;
417         }
418         StringImpl* resultImpl;
419         if (!tryFastMalloc(sizeof(T) * length + sizeof(StringImpl)).getValue(resultImpl)) {
420             output = 0;
421             return 0;
422         }
423         output = reinterpret_cast<T*>(resultImpl + 1);
424
425         if (sizeof(T) == sizeof(char))
426             return adoptRef(new (NotNull, resultImpl) StringImpl(length, Force8BitConstructor));
427
428         return adoptRef(new (NotNull, resultImpl) StringImpl(length));
429     }
430
431     static PassRefPtr<StringImpl> createEmptyUnique()
432     {
433         return adoptRef(new StringImpl(CreateEmptyUnique));
434     }
435
436     // Reallocate the StringImpl. The originalString must be only owned by the PassRefPtr,
437     // and the buffer ownership must be BufferInternal. Just like the input pointer of realloc(),
438     // the originalString can't be used after this function.
439     static PassRefPtr<StringImpl> reallocate(PassRefPtr<StringImpl> originalString, unsigned length, LChar*& data);
440     static PassRefPtr<StringImpl> reallocate(PassRefPtr<StringImpl> originalString, unsigned length, UChar*& data);
441
442     static unsigned flagsOffset() { return OBJECT_OFFSETOF(StringImpl, m_hashAndFlags); }
443     static unsigned flagIs8Bit() { return s_hashFlag8BitBuffer; }
444     static unsigned dataOffset() { return OBJECT_OFFSETOF(StringImpl, m_data8); }
445     static PassRefPtr<StringImpl> createWithTerminatingNullCharacter(const StringImpl&);
446
447     template<typename CharType, size_t inlineCapacity>
448     static PassRefPtr<StringImpl> adopt(Vector<CharType, inlineCapacity>& vector)
449     {
450         if (size_t size = vector.size()) {
451             ASSERT(vector.data());
452             if (size > std::numeric_limits<unsigned>::max())
453                 CRASH();
454             return adoptRef(new StringImpl(vector.releaseBuffer(), size));
455         }
456         return empty();
457     }
458
459     WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> adopt(StringBuffer<UChar>&);
460     WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> adopt(StringBuffer<LChar>&);
461
462 #if PLATFORM(QT)
463     static PassRefPtr<StringImpl> adopt(QStringData*);
464 #endif
465
466     unsigned length() const { return m_length; }
467     bool is8Bit() const { return m_hashAndFlags & s_hashFlag8BitBuffer; }
468     bool hasInternalBuffer() const { return bufferOwnership() == BufferInternal; }
469     bool hasOwnedBuffer() const { return bufferOwnership() == BufferOwned; }
470     StringImpl* baseString() const { return bufferOwnership() == BufferSubstring ? m_substringBuffer : 0; }
471
472     // FIXME: Remove all unnecessary usages of characters()
473     ALWAYS_INLINE const LChar* characters8() const { ASSERT(is8Bit()); return m_data8; }
474     ALWAYS_INLINE const UChar* characters16() const { ASSERT(!is8Bit()); return m_data16; }
475     ALWAYS_INLINE const UChar* characters() const
476     {
477         if (!is8Bit())
478             return m_data16;
479
480         return getData16SlowCase();
481     }
482
483     template <typename CharType>
484     ALWAYS_INLINE const CharType * getCharacters() const;
485
486     size_t cost()
487     {
488         // For substrings, return the cost of the base string.
489         if (bufferOwnership() == BufferSubstring)
490             return m_substringBuffer->cost();
491
492         if (m_hashAndFlags & s_hashFlagDidReportCost)
493             return 0;
494
495         m_hashAndFlags |= s_hashFlagDidReportCost;
496         return m_length;
497     }
498
499     WTF_EXPORT_STRING_API size_t sizeInBytes() const;
500
501     bool has16BitShadow() const { return m_hashAndFlags & s_hashFlagHas16BitShadow; }
502     WTF_EXPORT_STRING_API void upconvertCharacters(unsigned, unsigned) const;
503     bool isIdentifier() const { return m_hashAndFlags & s_hashFlagIsIdentifier; }
504     void setIsIdentifier(bool isIdentifier)
505     {
506         ASSERT(!isStatic());
507         if (isIdentifier)
508             m_hashAndFlags |= s_hashFlagIsIdentifier;
509         else
510             m_hashAndFlags &= ~s_hashFlagIsIdentifier;
511     }
512
513     bool isEmptyUnique() const
514     {
515         return !length() && !isStatic();
516     }
517
518     bool hasTerminatingNullCharacter() const { return m_hashAndFlags & s_hashFlagHasTerminatingNullCharacter; }
519
520     bool isAtomic() const { return m_hashAndFlags & s_hashFlagIsAtomic; }
521     void setIsAtomic(bool isIdentifier)
522     {
523         ASSERT(!isStatic());
524         if (isIdentifier)
525             m_hashAndFlags |= s_hashFlagIsAtomic;
526         else
527             m_hashAndFlags &= ~s_hashFlagIsAtomic;
528     }
529
530 #ifdef STRING_STATS
531     bool isSubString() const { return  bufferOwnership() == BufferSubstring; }
532 #endif
533
534 #if PLATFORM(QT)
535     QStringData* qStringData() { return bufferOwnership() == BufferAdoptedQString ? m_qStringData : 0; }
536 #endif
537
538 private:
539     // The high bits of 'hash' are always empty, but we prefer to store our flags
540     // in the low bits because it makes them slightly more efficient to access.
541     // So, we shift left and right when setting and getting our hash code.
542     void setHash(unsigned hash) const
543     {
544         ASSERT(!hasHash());
545         // Multiple clients assume that StringHasher is the canonical string hash function.
546         ASSERT(hash == (is8Bit() ? StringHasher::computeHashAndMaskTop8Bits(m_data8, m_length) : StringHasher::computeHashAndMaskTop8Bits(m_data16, m_length)));
547         ASSERT(!(hash & (s_flagMask << (8 * sizeof(hash) - s_flagCount)))); // Verify that enough high bits are empty.
548         
549         hash <<= s_flagCount;
550         ASSERT(!(hash & m_hashAndFlags)); // Verify that enough low bits are empty after shift.
551         ASSERT(hash); // Verify that 0 is a valid sentinel hash value.
552
553         m_hashAndFlags |= hash; // Store hash with flags in low bits.
554     }
555
556     unsigned rawHash() const
557     {
558         return m_hashAndFlags >> s_flagCount;
559     }
560
561 public:
562     bool hasHash() const
563     {
564         return rawHash() != 0;
565     }
566
567     unsigned existingHash() const
568     {
569         ASSERT(hasHash());
570         return rawHash();
571     }
572
573     unsigned hash() const
574     {
575         if (hasHash())
576             return existingHash();
577         return hashSlowCase();
578     }
579
580     inline bool hasOneRef() const
581     {
582         return m_refCount == s_refCountIncrement;
583     }
584
585     inline void ref()
586     {
587         m_refCount += s_refCountIncrement;
588     }
589
590     inline void deref()
591     {
592         if (m_refCount == s_refCountIncrement) {
593             delete this;
594             return;
595         }
596
597         m_refCount -= s_refCountIncrement;
598     }
599
600     WTF_EXPORT_PRIVATE static StringImpl* empty();
601
602     // FIXME: Does this really belong in StringImpl?
603     template <typename T> static void copyChars(T* destination, const T* source, unsigned numCharacters)
604     {
605         if (numCharacters == 1) {
606             *destination = *source;
607             return;
608         }
609
610         if (numCharacters <= s_copyCharsInlineCutOff) {
611             unsigned i = 0;
612 #if (CPU(X86) || CPU(X86_64))
613             const unsigned charsPerInt = sizeof(uint32_t) / sizeof(T);
614
615             if (numCharacters > charsPerInt) {
616                 unsigned stopCount = numCharacters & ~(charsPerInt - 1);
617
618                 const uint32_t* srcCharacters = reinterpret_cast<const uint32_t*>(source);
619                 uint32_t* destCharacters = reinterpret_cast<uint32_t*>(destination);
620                 for (unsigned j = 0; i < stopCount; i += charsPerInt, ++j)
621                     destCharacters[j] = srcCharacters[j];
622             }
623 #endif
624             for (; i < numCharacters; ++i)
625                 destination[i] = source[i];
626         } else
627             memcpy(destination, source, numCharacters * sizeof(T));
628     }
629
630     ALWAYS_INLINE static void copyChars(UChar* destination, const LChar* source, unsigned numCharacters)
631     {
632         for (unsigned i = 0; i < numCharacters; ++i)
633             destination[i] = source[i];
634     }
635
636     // Some string features, like refcounting and the atomicity flag, are not
637     // thread-safe. We achieve thread safety by isolation, giving each thread
638     // its own copy of the string.
639     PassRefPtr<StringImpl> isolatedCopy() const;
640
641     WTF_EXPORT_STRING_API PassRefPtr<StringImpl> substring(unsigned pos, unsigned len = UINT_MAX);
642
643     UChar operator[](unsigned i) const
644     {
645         ASSERT_WITH_SECURITY_IMPLICATION(i < m_length);
646         if (is8Bit())
647             return m_data8[i];
648         return m_data16[i];
649     }
650     WTF_EXPORT_STRING_API UChar32 characterStartingAt(unsigned);
651
652     WTF_EXPORT_STRING_API bool containsOnlyWhitespace();
653
654     int toIntStrict(bool* ok = 0, int base = 10);
655     unsigned toUIntStrict(bool* ok = 0, int base = 10);
656     int64_t toInt64Strict(bool* ok = 0, int base = 10);
657     uint64_t toUInt64Strict(bool* ok = 0, int base = 10);
658     intptr_t toIntPtrStrict(bool* ok = 0, int base = 10);
659
660     WTF_EXPORT_STRING_API int toInt(bool* ok = 0); // ignores trailing garbage
661     unsigned toUInt(bool* ok = 0); // ignores trailing garbage
662     int64_t toInt64(bool* ok = 0); // ignores trailing garbage
663     uint64_t toUInt64(bool* ok = 0); // ignores trailing garbage
664     intptr_t toIntPtr(bool* ok = 0); // ignores trailing garbage
665
666     // FIXME: Like the strict functions above, these give false for "ok" when there is trailing garbage.
667     // Like the non-strict functions above, these return the value when there is trailing garbage.
668     // It would be better if these were more consistent with the above functions instead.
669     double toDouble(bool* ok = 0);
670     float toFloat(bool* ok = 0);
671
672     WTF_EXPORT_STRING_API PassRefPtr<StringImpl> lower();
673     WTF_EXPORT_STRING_API PassRefPtr<StringImpl> upper();
674
675     WTF_EXPORT_STRING_API PassRefPtr<StringImpl> fill(UChar);
676     // FIXME: Do we need fill(char) or can we just do the right thing if UChar is ASCII?
677     PassRefPtr<StringImpl> foldCase();
678
679     PassRefPtr<StringImpl> stripWhiteSpace();
680     PassRefPtr<StringImpl> stripWhiteSpace(IsWhiteSpaceFunctionPtr);
681     WTF_EXPORT_STRING_API PassRefPtr<StringImpl> simplifyWhiteSpace();
682     PassRefPtr<StringImpl> simplifyWhiteSpace(IsWhiteSpaceFunctionPtr);
683
684     PassRefPtr<StringImpl> removeCharacters(CharacterMatchFunctionPtr);
685     template <typename CharType>
686     ALWAYS_INLINE PassRefPtr<StringImpl> removeCharacters(const CharType* characters, CharacterMatchFunctionPtr);
687
688     size_t find(LChar character, unsigned start = 0);
689     size_t find(char character, unsigned start = 0);
690     size_t find(UChar character, unsigned start = 0);
691     WTF_EXPORT_STRING_API size_t find(CharacterMatchFunctionPtr, unsigned index = 0);
692     size_t find(const LChar*, unsigned index = 0);
693     ALWAYS_INLINE size_t find(const char* s, unsigned index = 0) { return find(reinterpret_cast<const LChar*>(s), index); };
694     WTF_EXPORT_STRING_API size_t find(StringImpl*);
695     WTF_EXPORT_STRING_API size_t find(StringImpl*, unsigned index);
696     size_t findIgnoringCase(const LChar*, unsigned index = 0);
697     ALWAYS_INLINE size_t findIgnoringCase(const char* s, unsigned index = 0) { return findIgnoringCase(reinterpret_cast<const LChar*>(s), index); };
698     WTF_EXPORT_STRING_API size_t findIgnoringCase(StringImpl*, unsigned index = 0);
699
700     WTF_EXPORT_STRING_API size_t reverseFind(UChar, unsigned index = UINT_MAX);
701     WTF_EXPORT_STRING_API size_t reverseFind(StringImpl*, unsigned index = UINT_MAX);
702     WTF_EXPORT_STRING_API size_t reverseFindIgnoringCase(StringImpl*, unsigned index = UINT_MAX);
703
704     bool startsWith(StringImpl* str, bool caseSensitive = true) { return (caseSensitive ? reverseFind(str, 0) : reverseFindIgnoringCase(str, 0)) == 0; }
705     WTF_EXPORT_STRING_API bool startsWith(UChar) const;
706     WTF_EXPORT_STRING_API bool startsWith(const char*, unsigned matchLength, bool caseSensitive) const;
707     template<unsigned matchLength>
708     bool startsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const { return startsWith(prefix, matchLength - 1, caseSensitive); };
709
710     WTF_EXPORT_STRING_API bool endsWith(StringImpl*, bool caseSensitive = true);
711     WTF_EXPORT_STRING_API bool endsWith(UChar) const;
712     WTF_EXPORT_STRING_API bool endsWith(const char*, unsigned matchLength, bool caseSensitive) const;
713     template<unsigned matchLength>
714     bool endsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const { return endsWith(prefix, matchLength - 1, caseSensitive); }
715
716     WTF_EXPORT_STRING_API PassRefPtr<StringImpl> replace(UChar, UChar);
717     WTF_EXPORT_STRING_API PassRefPtr<StringImpl> replace(UChar, StringImpl*);
718     ALWAYS_INLINE PassRefPtr<StringImpl> replace(UChar pattern, const char* replacement, unsigned replacementLength) { return replace(pattern, reinterpret_cast<const LChar*>(replacement), replacementLength); }
719     WTF_EXPORT_STRING_API PassRefPtr<StringImpl> replace(UChar, const LChar*, unsigned replacementLength);
720     PassRefPtr<StringImpl> replace(UChar, const UChar*, unsigned replacementLength);
721     WTF_EXPORT_STRING_API PassRefPtr<StringImpl> replace(StringImpl*, StringImpl*);
722     WTF_EXPORT_STRING_API PassRefPtr<StringImpl> replace(unsigned index, unsigned len, StringImpl*);
723
724     WTF_EXPORT_STRING_API WTF::Unicode::Direction defaultWritingDirection(bool* hasStrongDirectionality = 0);
725
726 #if USE(CF)
727     RetainPtr<CFStringRef> createCFString();
728 #endif
729 #ifdef __OBJC__
730     operator NSString*();
731 #endif
732
733 #ifdef STRING_STATS
734     ALWAYS_INLINE static StringStats& stringStats() { return m_stringStats; }
735 #endif
736
737 private:
738
739     bool isASCIILiteral() const
740     {
741         return is8Bit() && hasInternalBuffer() && reinterpret_cast<const void*>(m_data8) != reinterpret_cast<const void*>(this + 1);
742     }
743
744     // This number must be at least 2 to avoid sharing empty, null as well as 1 character strings from SmallStrings.
745     static const unsigned s_copyCharsInlineCutOff = 20;
746
747     BufferOwnership bufferOwnership() const { return static_cast<BufferOwnership>(m_hashAndFlags & s_hashMaskBufferOwnership); }
748     bool isStatic() const { return m_refCount & s_refCountFlagIsStaticString; }
749     template <class UCharPredicate> PassRefPtr<StringImpl> stripMatchedCharacters(UCharPredicate);
750     template <typename CharType, class UCharPredicate> PassRefPtr<StringImpl> simplifyMatchedCharactersToSpace(UCharPredicate);
751     WTF_EXPORT_STRING_API NEVER_INLINE const UChar* getData16SlowCase() const;
752     WTF_EXPORT_PRIVATE NEVER_INLINE unsigned hashSlowCase() const;
753
754     // The bottom bit in the ref count indicates a static (immortal) string.
755     static const unsigned s_refCountFlagIsStaticString = 0x1;
756     static const unsigned s_refCountIncrement = 0x2; // This allows us to ref / deref without disturbing the static string flag.
757
758     // The bottom 8 bits in the hash are flags.
759     static const unsigned s_flagCount = 8;
760     static const unsigned s_flagMask = (1u << s_flagCount) - 1;
761     COMPILE_ASSERT(s_flagCount == StringHasher::flagCount, StringHasher_reserves_enough_bits_for_StringImpl_flags);
762
763     static const unsigned s_hashFlagHas16BitShadow = 1u << 7;
764     static const unsigned s_hashFlag8BitBuffer = 1u << 6;
765     static const unsigned s_hashFlagHasTerminatingNullCharacter = 1u << 5;
766     static const unsigned s_hashFlagIsAtomic = 1u << 4;
767     static const unsigned s_hashFlagDidReportCost = 1u << 3;
768     static const unsigned s_hashFlagIsIdentifier = 1u << 2;
769     static const unsigned s_hashMaskBufferOwnership = 1u | (1u << 1);
770
771 #ifdef STRING_STATS
772     WTF_EXPORTDATA static StringStats m_stringStats;
773 #endif
774     unsigned m_refCount;
775     unsigned m_length;
776     union {
777         const LChar* m_data8;
778         const UChar* m_data16;
779     };
780     union {
781         void* m_buffer;
782         StringImpl* m_substringBuffer;
783         mutable UChar* m_copyData16;
784 #if PLATFORM(QT)
785         QStringData* m_qStringData;
786 #endif
787     };
788     mutable unsigned m_hashAndFlags;
789 };
790
791 template <>
792 ALWAYS_INLINE const LChar* StringImpl::getCharacters<LChar>() const { return characters8(); }
793
794 template <>
795 ALWAYS_INLINE const UChar* StringImpl::getCharacters<UChar>() const { return characters(); }
796
797 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const StringImpl*);
798 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const LChar*);
799 inline bool equal(const StringImpl* a, const char* b) { return equal(a, reinterpret_cast<const LChar*>(b)); }
800 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const LChar*, unsigned);
801 inline bool equal(const StringImpl* a, const char* b, unsigned length) { return equal(a, reinterpret_cast<const LChar*>(b), length); }
802 inline bool equal(const LChar* a, StringImpl* b) { return equal(b, a); }
803 inline bool equal(const char* a, StringImpl* b) { return equal(b, reinterpret_cast<const LChar*>(a)); }
804 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const UChar*, unsigned);
805
806 // Do comparisons 8 or 4 bytes-at-a-time on architectures where it's safe.
807 #if CPU(X86_64)
808 ALWAYS_INLINE bool equal(const LChar* a, const LChar* b, unsigned length)
809 {
810     unsigned dwordLength = length >> 3;
811
812     if (dwordLength) {
813         const uint64_t* aDWordCharacters = reinterpret_cast<const uint64_t*>(a);
814         const uint64_t* bDWordCharacters = reinterpret_cast<const uint64_t*>(b);
815
816         for (unsigned i = 0; i != dwordLength; ++i) {
817             if (*aDWordCharacters++ != *bDWordCharacters++)
818                 return false;
819         }
820
821         a = reinterpret_cast<const LChar*>(aDWordCharacters);
822         b = reinterpret_cast<const LChar*>(bDWordCharacters);
823     }
824
825     if (length & 4) {
826         if (*reinterpret_cast<const uint32_t*>(a) != *reinterpret_cast<const uint32_t*>(b))
827             return false;
828
829         a += 4;
830         b += 4;
831     }
832
833     if (length & 2) {
834         if (*reinterpret_cast<const uint16_t*>(a) != *reinterpret_cast<const uint16_t*>(b))
835             return false;
836
837         a += 2;
838         b += 2;
839     }
840
841     if (length & 1 && (*a != *b))
842         return false;
843
844     return true;
845 }
846
847 ALWAYS_INLINE bool equal(const UChar* a, const UChar* b, unsigned length)
848 {
849     unsigned dwordLength = length >> 2;
850     
851     if (dwordLength) {
852         const uint64_t* aDWordCharacters = reinterpret_cast<const uint64_t*>(a);
853         const uint64_t* bDWordCharacters = reinterpret_cast<const uint64_t*>(b);
854
855         for (unsigned i = 0; i != dwordLength; ++i) {
856             if (*aDWordCharacters++ != *bDWordCharacters++)
857                 return false;
858         }
859
860         a = reinterpret_cast<const UChar*>(aDWordCharacters);
861         b = reinterpret_cast<const UChar*>(bDWordCharacters);
862     }
863
864     if (length & 2) {
865         if (*reinterpret_cast<const uint32_t*>(a) != *reinterpret_cast<const uint32_t*>(b))
866             return false;
867
868         a += 2;
869         b += 2;
870     }
871
872     if (length & 1 && (*a != *b))
873         return false;
874
875     return true;
876 }
877 #elif CPU(X86)
878 ALWAYS_INLINE bool equal(const LChar* a, const LChar* b, unsigned length)
879 {
880     const uint32_t* aCharacters = reinterpret_cast<const uint32_t*>(a);
881     const uint32_t* bCharacters = reinterpret_cast<const uint32_t*>(b);
882
883     unsigned wordLength = length >> 2;
884     for (unsigned i = 0; i != wordLength; ++i) {
885         if (*aCharacters++ != *bCharacters++)
886             return false;
887     }
888
889     length &= 3;
890
891     if (length) {
892         const LChar* aRemainder = reinterpret_cast<const LChar*>(aCharacters);
893         const LChar* bRemainder = reinterpret_cast<const LChar*>(bCharacters);
894         
895         for (unsigned i = 0; i <  length; ++i) {
896             if (aRemainder[i] != bRemainder[i])
897                 return false;
898         }
899     }
900
901     return true;
902 }
903
904 ALWAYS_INLINE bool equal(const UChar* a, const UChar* b, unsigned length)
905 {
906     const uint32_t* aCharacters = reinterpret_cast<const uint32_t*>(a);
907     const uint32_t* bCharacters = reinterpret_cast<const uint32_t*>(b);
908     
909     unsigned wordLength = length >> 1;
910     for (unsigned i = 0; i != wordLength; ++i) {
911         if (*aCharacters++ != *bCharacters++)
912             return false;
913     }
914     
915     if (length & 1 && *reinterpret_cast<const UChar*>(aCharacters) != *reinterpret_cast<const UChar*>(bCharacters))
916         return false;
917     
918     return true;
919 }
920 #elif CPU(APPLE_ARMV7S)
921 ALWAYS_INLINE bool equal(const LChar* a, const LChar* b, unsigned length)
922 {
923     bool isEqual = false;
924     asm("lsr    r3, %[length], #2\n"
925
926         "0:\n" // Tag 0 = Start of loop over 32 bits.
927         "cbz    r3, 2f\n"
928         "ldr    r9, [%[a]], #4\n"
929         "sub    r3, #1\n"
930         "ldr    r12, [%[b]], #4\n"
931         "cmp    r9, r12\n"
932         "beq    0b\n"
933         "b      66f\n"
934
935         "2:\n" // Tag 2 = End of loop over 32 bits, check for pair of characters.
936         "tst    %[length], #2\n"
937         "beq    1f\n"
938         "ldrh   r9, [%[a]], #2\n"
939         "ldrh   r12, [%[b]], #2\n"
940         "cmp    r9, r12\n"
941         "bne    66f\n"
942
943         "1:\n" // Tag 1 = Check for a single character left.
944         "tst    %[length], #1\n"
945         "beq    42f\n"
946         "ldrb   r9, [%[a]]\n"
947         "ldrb   r12, [%[b]]\n"
948         "cmp    r9, r12\n"
949         "bne    66f\n"
950
951         "42:\n" // Tag 42 = Success.
952         "mov    %[isEqual], #1\n"
953         "66:\n" // Tag 66 = End without changing isEqual to 1.
954         : [isEqual]"+r"(isEqual), [a]"+r"(a), [b]"+r"(b)
955         : [length]"r"(length)
956         : "r3", "r9", "r12"
957         );
958     return isEqual;
959 }
960
961 ALWAYS_INLINE bool equal(const UChar* a, const UChar* b, unsigned length)
962 {
963     return !memcmp(a, b, length);
964 }
965 #elif PLATFORM(IOS) && WTF_ARM_ARCH_AT_LEAST(7)
966 ALWAYS_INLINE bool equal(const LChar* a, const LChar* b, unsigned length)
967 {
968     return !memcmp(a, b, length);
969 }
970
971 ALWAYS_INLINE bool equal(const UChar* a, const UChar* b, unsigned length)
972 {
973     return !memcmp(a, b, length);
974 }
975 #else
976 ALWAYS_INLINE bool equal(const LChar* a, const LChar* b, unsigned length)
977 {
978     for (unsigned i = 0; i != length; ++i) {
979         if (a[i] != b[i])
980             return false;
981     }
982
983     return true;
984 }
985
986 ALWAYS_INLINE bool equal(const UChar* a, const UChar* b, unsigned length)
987 {
988     for (unsigned i = 0; i != length; ++i) {
989         if (a[i] != b[i])
990             return false;
991     }
992
993     return true;
994 }
995 #endif
996
997 ALWAYS_INLINE bool equal(const LChar* a, const UChar* b, unsigned length)
998 {
999     for (unsigned i = 0; i != length; ++i) {
1000         if (a[i] != b[i])
1001             return false;
1002     }
1003
1004     return true;
1005 }
1006
1007 ALWAYS_INLINE bool equal(const UChar* a, const LChar* b, unsigned length)
1008 {
1009     for (unsigned i = 0; i != length; ++i) {
1010         if (a[i] != b[i])
1011             return false;
1012     }
1013
1014     return true;
1015 }
1016
1017 WTF_EXPORT_STRING_API bool equalIgnoringCase(StringImpl*, StringImpl*);
1018 WTF_EXPORT_STRING_API bool equalIgnoringCase(StringImpl*, const LChar*);
1019 inline bool equalIgnoringCase(const LChar* a, StringImpl* b) { return equalIgnoringCase(b, a); }
1020 WTF_EXPORT_STRING_API bool equalIgnoringCase(const LChar*, const LChar*, unsigned);
1021 WTF_EXPORT_STRING_API bool equalIgnoringCase(const UChar*, const LChar*, unsigned);
1022 inline bool equalIgnoringCase(const UChar* a, const char* b, unsigned length) { return equalIgnoringCase(a, reinterpret_cast<const LChar*>(b), length); }
1023 inline bool equalIgnoringCase(const LChar* a, const UChar* b, unsigned length) { return equalIgnoringCase(b, a, length); }
1024 inline bool equalIgnoringCase(const char* a, const UChar* b, unsigned length) { return equalIgnoringCase(b, reinterpret_cast<const LChar*>(a), length); }
1025 inline bool equalIgnoringCase(const char* a, const LChar* b, unsigned length) { return equalIgnoringCase(b, reinterpret_cast<const LChar*>(a), length); }
1026 inline bool equalIgnoringCase(const UChar* a, const UChar* b, int length)
1027 {
1028     ASSERT(length >= 0);
1029     return !Unicode::umemcasecmp(a, b, length);
1030 }
1031
1032 WTF_EXPORT_STRING_API bool equalIgnoringNullity(StringImpl*, StringImpl*);
1033
1034 template<typename CharacterType>
1035 inline size_t find(const CharacterType* characters, unsigned length, CharacterType matchCharacter, unsigned index = 0)
1036 {
1037     while (index < length) {
1038         if (characters[index] == matchCharacter)
1039             return index;
1040         ++index;
1041     }
1042     return notFound;
1043 }
1044
1045 ALWAYS_INLINE size_t find(const UChar* characters, unsigned length, LChar matchCharacter, unsigned index = 0)
1046 {
1047     return find(characters, length, static_cast<UChar>(matchCharacter), index);
1048 }
1049
1050 inline size_t find(const LChar* characters, unsigned length, UChar matchCharacter, unsigned index = 0)
1051 {
1052     if (matchCharacter & ~0xFF)
1053         return notFound;
1054     return find(characters, length, static_cast<LChar>(matchCharacter), index);
1055 }
1056
1057 inline size_t find(const LChar* characters, unsigned length, CharacterMatchFunctionPtr matchFunction, unsigned index = 0)
1058 {
1059     while (index < length) {
1060         if (matchFunction(characters[index]))
1061             return index;
1062         ++index;
1063     }
1064     return notFound;
1065 }
1066
1067 inline size_t find(const UChar* characters, unsigned length, CharacterMatchFunctionPtr matchFunction, unsigned index = 0)
1068 {
1069     while (index < length) {
1070         if (matchFunction(characters[index]))
1071             return index;
1072         ++index;
1073     }
1074     return notFound;
1075 }
1076
1077 template <typename CharacterType>
1078 inline size_t reverseFind(const CharacterType* characters, unsigned length, CharacterType matchCharacter, unsigned index = UINT_MAX)
1079 {
1080     if (!length)
1081         return notFound;
1082     if (index >= length)
1083         index = length - 1;
1084     while (characters[index] != matchCharacter) {
1085         if (!index--)
1086             return notFound;
1087     }
1088     return index;
1089 }
1090
1091 ALWAYS_INLINE size_t reverseFind(const UChar* characters, unsigned length, LChar matchCharacter, unsigned index = UINT_MAX)
1092 {
1093     return reverseFind(characters, length, static_cast<UChar>(matchCharacter), index);
1094 }
1095
1096 inline size_t reverseFind(const LChar* characters, unsigned length, UChar matchCharacter, unsigned index = UINT_MAX)
1097 {
1098     if (matchCharacter & ~0xFF)
1099         return notFound;
1100     return reverseFind(characters, length, static_cast<LChar>(matchCharacter), index);
1101 }
1102
1103 inline size_t StringImpl::find(LChar character, unsigned start)
1104 {
1105     if (is8Bit())
1106         return WTF::find(characters8(), m_length, character, start);
1107     return WTF::find(characters16(), m_length, character, start);
1108 }
1109
1110 ALWAYS_INLINE size_t StringImpl::find(char character, unsigned start)
1111 {
1112     return find(static_cast<LChar>(character), start);
1113 }
1114
1115 inline size_t StringImpl::find(UChar character, unsigned start)
1116 {
1117     if (is8Bit())
1118         return WTF::find(characters8(), m_length, character, start);
1119     return WTF::find(characters16(), m_length, character, start);
1120 }
1121
1122 template<size_t inlineCapacity>
1123 bool equalIgnoringNullity(const Vector<UChar, inlineCapacity>& a, StringImpl* b)
1124 {
1125     if (!b)
1126         return !a.size();
1127     if (a.size() != b->length())
1128         return false;
1129     return !memcmp(a.data(), b->characters(), b->length() * sizeof(UChar));
1130 }
1131
1132 template<typename CharacterType1, typename CharacterType2>
1133 static inline int codePointCompare(unsigned l1, unsigned l2, const CharacterType1* c1, const CharacterType2* c2)
1134 {
1135     const unsigned lmin = l1 < l2 ? l1 : l2;
1136     unsigned pos = 0;
1137     while (pos < lmin && *c1 == *c2) {
1138         ++c1;
1139         ++c2;
1140         ++pos;
1141     }
1142
1143     if (pos < lmin)
1144         return (c1[0] > c2[0]) ? 1 : -1;
1145
1146     if (l1 == l2)
1147         return 0;
1148
1149     return (l1 > l2) ? 1 : -1;
1150 }
1151
1152 static inline int codePointCompare8(const StringImpl* string1, const StringImpl* string2)
1153 {
1154     return codePointCompare(string1->length(), string2->length(), string1->characters8(), string2->characters8());
1155 }
1156
1157 static inline int codePointCompare16(const StringImpl* string1, const StringImpl* string2)
1158 {
1159     return codePointCompare(string1->length(), string2->length(), string1->characters16(), string2->characters16());
1160 }
1161
1162 static inline int codePointCompare8To16(const StringImpl* string1, const StringImpl* string2)
1163 {
1164     return codePointCompare(string1->length(), string2->length(), string1->characters8(), string2->characters16());
1165 }
1166
1167 static inline int codePointCompare(const StringImpl* string1, const StringImpl* string2)
1168 {
1169     if (!string1)
1170         return (string2 && string2->length()) ? -1 : 0;
1171
1172     if (!string2)
1173         return string1->length() ? 1 : 0;
1174
1175     bool string1Is8Bit = string1->is8Bit();
1176     bool string2Is8Bit = string2->is8Bit();
1177     if (string1Is8Bit) {
1178         if (string2Is8Bit)
1179             return codePointCompare8(string1, string2);
1180         return codePointCompare8To16(string1, string2);
1181     }
1182     if (string2Is8Bit)
1183         return -codePointCompare8To16(string2, string1);
1184     return codePointCompare16(string1, string2);
1185 }
1186
1187 static inline bool isSpaceOrNewline(UChar c)
1188 {
1189     // Use isASCIISpace() for basic Latin-1.
1190     // This will include newlines, which aren't included in Unicode DirWS.
1191     return c <= 0x7F ? WTF::isASCIISpace(c) : WTF::Unicode::direction(c) == WTF::Unicode::WhiteSpaceNeutral;
1192 }
1193
1194 inline PassRefPtr<StringImpl> StringImpl::isolatedCopy() const
1195 {
1196     if (isASCIILiteral())
1197         return StringImpl::createFromLiteral(reinterpret_cast<const char*>(m_data8), m_length);
1198     if (is8Bit())
1199         return create(m_data8, m_length);
1200     return create(m_data16, m_length);
1201 }
1202
1203 struct StringHash;
1204
1205 // StringHash is the default hash for StringImpl* and RefPtr<StringImpl>
1206 template<typename T> struct DefaultHash;
1207 template<> struct DefaultHash<StringImpl*> {
1208     typedef StringHash Hash;
1209 };
1210 template<> struct DefaultHash<RefPtr<StringImpl> > {
1211     typedef StringHash Hash;
1212 };
1213
1214 }
1215
1216 using WTF::StringImpl;
1217 using WTF::equal;
1218 using WTF::TextCaseSensitivity;
1219 using WTF::TextCaseSensitive;
1220 using WTF::TextCaseInsensitive;
1221
1222 #endif