Replace PassRef with Ref/Ref&& across the board.
[WebKit-https.git] / Source / WTF / wtf / text / StringImpl.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2005-2010, 2013-2014 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 <unicode/uchar.h>
28 #include <unicode/ustring.h>
29 #include <wtf/ASCIICType.h>
30 #include <wtf/Forward.h>
31 #include <wtf/MathExtras.h>
32 #include <wtf/StdLibExtras.h>
33 #include <wtf/StringHasher.h>
34 #include <wtf/Vector.h>
35 #include <wtf/text/ConversionMode.h>
36
37 #if USE(CF)
38 typedef const struct __CFString * CFStringRef;
39 #endif
40
41 #ifdef __OBJC__
42 @class NSString;
43 #endif
44
45 namespace JSC {
46 namespace LLInt { class Data; }
47 class LLIntOffsetsExtractor;
48 }
49
50 namespace WTF {
51
52 struct CStringTranslator;
53 template<typename CharacterType> struct HashAndCharactersTranslator;
54 struct HashAndUTF8CharactersTranslator;
55 struct LCharBufferTranslator;
56 struct CharBufferFromLiteralDataTranslator;
57 struct SubstringTranslator;
58 struct UCharBufferTranslator;
59 template<typename> class RetainPtr;
60
61 enum TextCaseSensitivity {
62     TextCaseSensitive,
63     TextCaseInsensitive
64 };
65
66 typedef bool (*CharacterMatchFunctionPtr)(UChar);
67 typedef bool (*IsWhiteSpaceFunctionPtr)(UChar);
68
69 // Define STRING_STATS to 1 turn on run time statistics of string sizes and memory usage
70 #define STRING_STATS 0
71
72 #if STRING_STATS
73 struct StringStats {
74     inline void add8BitString(unsigned length, bool isSubString = false)
75     {
76         ++m_totalNumberStrings;
77         ++m_number8BitStrings;
78         if (!isSubString)
79             m_total8BitData += length;
80     }
81
82     inline void add16BitString(unsigned length, bool isSubString = false)
83     {
84         ++m_totalNumberStrings;
85         ++m_number16BitStrings;
86         if (!isSubString)
87             m_total16BitData += length;
88     }
89
90     void removeString(StringImpl&);
91     void printStats();
92
93     static const unsigned s_printStringStatsFrequency = 5000;
94     static std::atomic<unsigned> s_stringRemovesTillPrintStats;
95
96     std::atomic<unsigned> m_refCalls;
97     std::atomic<unsigned> m_derefCalls;
98
99     std::atomic<unsigned> m_totalNumberStrings;
100     std::atomic<unsigned> m_number8BitStrings;
101     std::atomic<unsigned> m_number16BitStrings;
102     std::atomic<unsigned long long> m_total8BitData;
103     std::atomic<unsigned long long> m_total16BitData;
104 };
105
106 #define STRING_STATS_ADD_8BIT_STRING(length) StringImpl::stringStats().add8BitString(length)
107 #define STRING_STATS_ADD_8BIT_STRING2(length, isSubString) StringImpl::stringStats().add8BitString(length, isSubString)
108 #define STRING_STATS_ADD_16BIT_STRING(length) StringImpl::stringStats().add16BitString(length)
109 #define STRING_STATS_ADD_16BIT_STRING2(length, isSubString) StringImpl::stringStats().add16BitString(length, isSubString)
110 #define STRING_STATS_REMOVE_STRING(string) StringImpl::stringStats().removeString(string)
111 #define STRING_STATS_REF_STRING(string) ++StringImpl::stringStats().m_refCalls;
112 #define STRING_STATS_DEREF_STRING(string) ++StringImpl::stringStats().m_derefCalls;
113 #else
114 #define STRING_STATS_ADD_8BIT_STRING(length) ((void)0)
115 #define STRING_STATS_ADD_8BIT_STRING2(length, isSubString) ((void)0)
116 #define STRING_STATS_ADD_16BIT_STRING(length) ((void)0)
117 #define STRING_STATS_ADD_16BIT_STRING2(length, isSubString) ((void)0)
118 #define STRING_STATS_ADD_UPCONVERTED_STRING(length) ((void)0)
119 #define STRING_STATS_REMOVE_STRING(string) ((void)0)
120 #define STRING_STATS_REF_STRING(string) ((void)0)
121 #define STRING_STATS_DEREF_STRING(string) ((void)0)
122 #endif
123
124 class StringImpl {
125     WTF_MAKE_NONCOPYABLE(StringImpl); WTF_MAKE_FAST_ALLOCATED;
126     friend struct WTF::CStringTranslator;
127     template<typename CharacterType> friend struct WTF::HashAndCharactersTranslator;
128     friend struct WTF::HashAndUTF8CharactersTranslator;
129     friend struct WTF::CharBufferFromLiteralDataTranslator;
130     friend struct WTF::LCharBufferTranslator;
131     friend struct WTF::SubstringTranslator;
132     friend struct WTF::UCharBufferTranslator;
133     friend class AtomicStringImpl;
134     friend class JSC::LLInt::Data;
135     friend class JSC::LLIntOffsetsExtractor;
136     
137 private:
138     enum BufferOwnership {
139         BufferInternal,
140         BufferOwned,
141         BufferSubstring,
142     };
143
144     // Used to construct static strings, which have an special refCount that can never hit zero.
145     // This means that the static string will never be destroyed, which is important because
146     // static strings will be shared across threads & ref-counted in a non-threadsafe manner.
147     friend class NeverDestroyed<StringImpl>;
148     enum ConstructEmptyStringTag { ConstructEmptyString };
149     StringImpl(ConstructEmptyStringTag)
150         : m_refCount(s_refCountFlagIsStaticString)
151         , m_length(0)
152         , m_data8(reinterpret_cast<const LChar*>(&m_length))
153         , m_hashAndFlags(s_hashFlag8BitBuffer | s_hashFlagIsAtomic | BufferOwned)
154     {
155         // Ensure that the hash is computed so that AtomicStringHash can call existingHash()
156         // with impunity. The empty string is special because it is never entered into
157         // AtomicString's HashKey, but still needs to compare correctly.
158         STRING_STATS_ADD_8BIT_STRING(m_length);
159
160         hash();
161     }
162
163     // FIXME: there has to be a less hacky way to do this.
164     enum Force8Bit { Force8BitConstructor };
165     // Create a normal 8-bit string with internal storage (BufferInternal)
166     StringImpl(unsigned length, Force8Bit)
167         : m_refCount(s_refCountIncrement)
168         , m_length(length)
169         , m_data8(tailPointer<LChar>())
170         , m_hashAndFlags(s_hashFlag8BitBuffer | BufferInternal)
171     {
172         ASSERT(m_data8);
173         ASSERT(m_length);
174
175         STRING_STATS_ADD_8BIT_STRING(m_length);
176     }
177
178     // Create a normal 16-bit string with internal storage (BufferInternal)
179     StringImpl(unsigned length)
180         : m_refCount(s_refCountIncrement)
181         , m_length(length)
182         , m_data16(tailPointer<UChar>())
183         , m_hashAndFlags(BufferInternal)
184     {
185         ASSERT(m_data16);
186         ASSERT(m_length);
187
188         STRING_STATS_ADD_16BIT_STRING(m_length);
189     }
190
191     // Create a StringImpl adopting ownership of the provided buffer (BufferOwned)
192     StringImpl(MallocPtr<LChar> characters, unsigned length)
193         : m_refCount(s_refCountIncrement)
194         , m_length(length)
195         , m_data8(characters.leakPtr())
196         , m_hashAndFlags(s_hashFlag8BitBuffer | BufferOwned)
197     {
198         ASSERT(m_data8);
199         ASSERT(m_length);
200
201         STRING_STATS_ADD_8BIT_STRING(m_length);
202     }
203
204     enum ConstructWithoutCopyingTag { ConstructWithoutCopying };
205     StringImpl(const UChar* characters, unsigned length, ConstructWithoutCopyingTag)
206         : m_refCount(s_refCountIncrement)
207         , m_length(length)
208         , m_data16(characters)
209         , m_hashAndFlags(BufferInternal)
210     {
211         ASSERT(m_data16);
212         ASSERT(m_length);
213
214         STRING_STATS_ADD_16BIT_STRING(m_length);
215     }
216
217     StringImpl(const LChar* characters, unsigned length, ConstructWithoutCopyingTag)
218         : m_refCount(s_refCountIncrement)
219         , m_length(length)
220         , m_data8(characters)
221         , m_hashAndFlags(s_hashFlag8BitBuffer | BufferInternal)
222     {
223         ASSERT(m_data8);
224         ASSERT(m_length);
225
226         STRING_STATS_ADD_8BIT_STRING(m_length);
227     }
228
229     // Create a StringImpl adopting ownership of the provided buffer (BufferOwned)
230     StringImpl(MallocPtr<UChar> characters, unsigned length)
231         : m_refCount(s_refCountIncrement)
232         , m_length(length)
233         , m_data16(characters.leakPtr())
234         , m_hashAndFlags(BufferOwned)
235     {
236         ASSERT(m_data16);
237         ASSERT(m_length);
238
239         STRING_STATS_ADD_16BIT_STRING(m_length);
240     }
241
242     // Used to create new strings that are a substring of an existing 8-bit StringImpl (BufferSubstring)
243     StringImpl(const LChar* characters, unsigned length, PassRefPtr<StringImpl> base)
244         : m_refCount(s_refCountIncrement)
245         , m_length(length)
246         , m_data8(characters)
247         , m_hashAndFlags(s_hashFlag8BitBuffer | BufferSubstring)
248     {
249         ASSERT(is8Bit());
250         ASSERT(m_data8);
251         ASSERT(m_length);
252         ASSERT(base->bufferOwnership() != BufferSubstring);
253
254         substringBuffer() = base.leakRef();
255
256         STRING_STATS_ADD_8BIT_STRING2(m_length, true);
257     }
258
259     // Used to create new strings that are a substring of an existing 16-bit StringImpl (BufferSubstring)
260     StringImpl(const UChar* characters, unsigned length, PassRefPtr<StringImpl> base)
261         : m_refCount(s_refCountIncrement)
262         , m_length(length)
263         , m_data16(characters)
264         , m_hashAndFlags(BufferSubstring)
265     {
266         ASSERT(!is8Bit());
267         ASSERT(m_data16);
268         ASSERT(m_length);
269         ASSERT(base->bufferOwnership() != BufferSubstring);
270
271         substringBuffer() = base.leakRef();
272
273         STRING_STATS_ADD_16BIT_STRING2(m_length, true);
274     }
275
276     enum CreateEmptyUniqueTag { CreateEmptyUnique };
277     StringImpl(CreateEmptyUniqueTag)
278         : m_refCount(s_refCountIncrement)
279         , m_length(0)
280         // We expect m_length to be initialized to 0 as we use it
281         // to represent a null terminated buffer.
282         , m_data8(reinterpret_cast<const LChar*>(&m_length))
283         , m_hashAndFlags(hashAndFlagsForEmptyUnique())
284     {
285         ASSERT(m_data8);
286
287         STRING_STATS_ADD_8BIT_STRING(m_length);
288     }
289
290     ~StringImpl();
291
292 public:
293     WTF_EXPORT_STRING_API static void destroy(StringImpl*);
294
295     WTF_EXPORT_STRING_API static Ref<StringImpl> create(const UChar*, unsigned length);
296     WTF_EXPORT_STRING_API static Ref<StringImpl> create(const LChar*, unsigned length);
297     WTF_EXPORT_STRING_API static Ref<StringImpl> create8BitIfPossible(const UChar*, unsigned length);
298     template<size_t inlineCapacity>
299     static Ref<StringImpl> create8BitIfPossible(const Vector<UChar, inlineCapacity>& vector)
300     {
301         return create8BitIfPossible(vector.data(), vector.size());
302     }
303     WTF_EXPORT_STRING_API static Ref<StringImpl> create8BitIfPossible(const UChar*);
304
305     ALWAYS_INLINE static Ref<StringImpl> create(const char* s, unsigned length) { return create(reinterpret_cast<const LChar*>(s), length); }
306     WTF_EXPORT_STRING_API static Ref<StringImpl> create(const LChar*);
307     ALWAYS_INLINE static Ref<StringImpl> create(const char* s) { return create(reinterpret_cast<const LChar*>(s)); }
308
309     static ALWAYS_INLINE Ref<StringImpl> createSubstringSharingImpl8(PassRefPtr<StringImpl> rep, unsigned offset, unsigned length)
310     {
311         ASSERT(rep);
312         ASSERT(length <= rep->length());
313
314         if (!length)
315             return *empty();
316
317         ASSERT(rep->is8Bit());
318         StringImpl* ownerRep = (rep->bufferOwnership() == BufferSubstring) ? rep->substringBuffer() : rep.get();
319
320         // We allocate a buffer that contains both the StringImpl struct as well as the pointer to the owner string.
321         StringImpl* stringImpl = static_cast<StringImpl*>(fastMalloc(allocationSize<StringImpl*>(1)));
322         return adoptRef(*new (NotNull, stringImpl) StringImpl(rep->m_data8 + offset, length, ownerRep));
323     }
324
325     static ALWAYS_INLINE Ref<StringImpl> createSubstringSharingImpl(PassRefPtr<StringImpl> rep, unsigned offset, unsigned length)
326     {
327         ASSERT(rep);
328         ASSERT(length <= rep->length());
329
330         if (!length)
331             return *empty();
332
333         StringImpl* ownerRep = (rep->bufferOwnership() == BufferSubstring) ? rep->substringBuffer() : rep.get();
334
335         // We allocate a buffer that contains both the StringImpl struct as well as the pointer to the owner string.
336         StringImpl* stringImpl = static_cast<StringImpl*>(fastMalloc(allocationSize<StringImpl*>(1)));
337         if (rep->is8Bit())
338             return adoptRef(*new (NotNull, stringImpl) StringImpl(rep->m_data8 + offset, length, ownerRep));
339         return adoptRef(*new (NotNull, stringImpl) StringImpl(rep->m_data16 + offset, length, ownerRep));
340     }
341
342     template<unsigned charactersCount>
343     ALWAYS_INLINE static Ref<StringImpl> createFromLiteral(const char (&characters)[charactersCount])
344     {
345         COMPILE_ASSERT(charactersCount > 1, StringImplFromLiteralNotEmpty);
346         COMPILE_ASSERT((charactersCount - 1 <= ((unsigned(~0) - sizeof(StringImpl)) / sizeof(LChar))), StringImplFromLiteralCannotOverflow);
347
348         return createWithoutCopying(reinterpret_cast<const LChar*>(characters), charactersCount - 1);
349     }
350
351     // FIXME: Transition off of these functions to createWithoutCopying instead.
352     WTF_EXPORT_STRING_API static Ref<StringImpl> createFromLiteral(const char* characters, unsigned length);
353     WTF_EXPORT_STRING_API static Ref<StringImpl> createFromLiteral(const char* characters);
354
355     WTF_EXPORT_STRING_API static Ref<StringImpl> createWithoutCopying(const UChar* characters, unsigned length);
356     WTF_EXPORT_STRING_API static Ref<StringImpl> createWithoutCopying(const LChar* characters, unsigned length);
357
358     WTF_EXPORT_STRING_API static Ref<StringImpl> createUninitialized(unsigned length, LChar*& data);
359     WTF_EXPORT_STRING_API static Ref<StringImpl> createUninitialized(unsigned length, UChar*& data);
360     template <typename T> static ALWAYS_INLINE PassRefPtr<StringImpl> tryCreateUninitialized(unsigned length, T*& output)
361     {
362         if (!length) {
363             output = 0;
364             return empty();
365         }
366
367         if (length > ((std::numeric_limits<unsigned>::max() - sizeof(StringImpl)) / sizeof(T))) {
368             output = 0;
369             return 0;
370         }
371         StringImpl* resultImpl;
372         if (!tryFastMalloc(allocationSize<T>(length)).getValue(resultImpl)) {
373             output = 0;
374             return 0;
375         }
376         output = resultImpl->tailPointer<T>();
377
378         return constructInternal<T>(resultImpl, length);
379     }
380
381     static Ref<StringImpl> createEmptyUnique()
382     {
383         return adoptRef(*new StringImpl(CreateEmptyUnique));
384     }
385
386     // Reallocate the StringImpl. The originalString must be only owned by the PassRefPtr,
387     // and the buffer ownership must be BufferInternal. Just like the input pointer of realloc(),
388     // the originalString can't be used after this function.
389     static Ref<StringImpl> reallocate(PassRefPtr<StringImpl> originalString, unsigned length, LChar*& data);
390     static Ref<StringImpl> reallocate(PassRefPtr<StringImpl> originalString, unsigned length, UChar*& data);
391
392     static unsigned flagsOffset() { return OBJECT_OFFSETOF(StringImpl, m_hashAndFlags); }
393     static unsigned flagIs8Bit() { return s_hashFlag8BitBuffer; }
394     static unsigned flagIsAtomic() { return s_hashFlagIsAtomic; }
395     static unsigned dataOffset() { return OBJECT_OFFSETOF(StringImpl, m_data8); }
396
397     template<typename CharType, size_t inlineCapacity, typename OverflowHandler>
398     static Ref<StringImpl> adopt(Vector<CharType, inlineCapacity, OverflowHandler>& vector)
399     {
400         if (size_t size = vector.size()) {
401             ASSERT(vector.data());
402             if (size > std::numeric_limits<unsigned>::max())
403                 CRASH();
404             return adoptRef(*new StringImpl(vector.releaseBuffer(), size));
405         }
406         return *empty();
407     }
408
409     WTF_EXPORT_STRING_API static Ref<StringImpl> adopt(StringBuffer<UChar>&);
410     WTF_EXPORT_STRING_API static Ref<StringImpl> adopt(StringBuffer<LChar>&);
411
412     unsigned length() const { return m_length; }
413     static ptrdiff_t lengthMemoryOffset() { return OBJECT_OFFSETOF(StringImpl, m_length); }
414     bool is8Bit() const { return m_hashAndFlags & s_hashFlag8BitBuffer; }
415
416     ALWAYS_INLINE const LChar* characters8() const { ASSERT(is8Bit()); return m_data8; }
417     ALWAYS_INLINE const UChar* characters16() const { ASSERT(!is8Bit()); return m_data16; }
418
419     template <typename CharType>
420     ALWAYS_INLINE const CharType *characters() const;
421
422     size_t cost() const
423     {
424         // For substrings, return the cost of the base string.
425         if (bufferOwnership() == BufferSubstring)
426             return substringBuffer()->cost();
427
428         if (m_hashAndFlags & s_hashFlagDidReportCost)
429             return 0;
430
431         m_hashAndFlags |= s_hashFlagDidReportCost;
432         size_t result = m_length;
433         if (!is8Bit())
434             result <<= 1;
435         return result;
436     }
437     
438     size_t costDuringGC()
439     {
440         if (isStatic())
441             return 0;
442         
443         if (bufferOwnership() == BufferSubstring)
444             return divideRoundedUp(substringBuffer()->costDuringGC(), refCount());
445         
446         size_t result = m_length;
447         if (!is8Bit())
448             result <<= 1;
449         return divideRoundedUp(result, refCount());
450     }
451
452     WTF_EXPORT_STRING_API size_t sizeInBytes() const;
453
454     bool isEmptyUnique() const
455     {
456         return !length() && !isStatic();
457     }
458
459     bool isAtomic() const { return m_hashAndFlags & s_hashFlagIsAtomic; }
460     void setIsAtomic(bool isAtomic)
461     {
462         ASSERT(!isStatic());
463         ASSERT(!isEmptyUnique());
464         if (isAtomic)
465             m_hashAndFlags |= s_hashFlagIsAtomic;
466         else
467             m_hashAndFlags &= ~s_hashFlagIsAtomic;
468     }
469
470 #if STRING_STATS
471     bool isSubString() const { return bufferOwnership() == BufferSubstring; }
472 #endif
473
474     static WTF_EXPORT_STRING_API CString utf8ForCharacters(const UChar* characters, unsigned length, ConversionMode = LenientConversion);
475     WTF_EXPORT_STRING_API CString utf8ForRange(unsigned offset, unsigned length, ConversionMode = LenientConversion) const;
476     WTF_EXPORT_STRING_API CString utf8(ConversionMode = LenientConversion) const;
477
478 private:
479     static WTF_EXPORT_STRING_API bool utf8Impl(const UChar* characters, unsigned length, char*& buffer, size_t bufferSize, ConversionMode);
480     
481     // The high bits of 'hash' are always empty, but we prefer to store our flags
482     // in the low bits because it makes them slightly more efficient to access.
483     // So, we shift left and right when setting and getting our hash code.
484     void setHash(unsigned hash) const
485     {
486         ASSERT(!hasHash());
487         // Multiple clients assume that StringHasher is the canonical string hash function.
488         ASSERT(hash == (is8Bit() ? StringHasher::computeHashAndMaskTop8Bits(m_data8, m_length) : StringHasher::computeHashAndMaskTop8Bits(m_data16, m_length)));
489         ASSERT(!(hash & (s_flagMask << (8 * sizeof(hash) - s_flagCount)))); // Verify that enough high bits are empty.
490         
491         hash <<= s_flagCount;
492         ASSERT(!(hash & m_hashAndFlags)); // Verify that enough low bits are empty after shift.
493         ASSERT(hash); // Verify that 0 is a valid sentinel hash value.
494
495         m_hashAndFlags |= hash; // Store hash with flags in low bits.
496     }
497
498     unsigned rawHash() const
499     {
500         return m_hashAndFlags >> s_flagCount;
501     }
502
503 public:
504     bool hasHash() const
505     {
506         return rawHash() != 0;
507     }
508
509     unsigned existingHash() const
510     {
511         ASSERT(hasHash());
512         return rawHash();
513     }
514
515     unsigned hash() const
516     {
517         if (hasHash())
518             return existingHash();
519         return hashSlowCase();
520     }
521     
522     bool isStatic() const { return m_refCount & s_refCountFlagIsStaticString; }
523
524     inline size_t refCount() const
525     {
526         return m_refCount / s_refCountIncrement;
527     }
528     
529     inline bool hasOneRef() const
530     {
531         return m_refCount == s_refCountIncrement;
532     }
533     
534     // This method is useful for assertions.
535     inline bool hasAtLeastOneRef() const
536     {
537         return !!m_refCount;
538     }
539
540     inline void ref()
541     {
542         ASSERT(!isCompilationThread());
543
544         STRING_STATS_REF_STRING(*this);
545
546         m_refCount += s_refCountIncrement;
547     }
548
549     inline void deref()
550     {
551         ASSERT(!isCompilationThread());
552
553         STRING_STATS_DEREF_STRING(*this);
554
555         unsigned tempRefCount = m_refCount - s_refCountIncrement;
556         if (!tempRefCount) {
557             StringImpl::destroy(this);
558             return;
559         }
560         m_refCount = tempRefCount;
561     }
562
563     WTF_EXPORT_PRIVATE static StringImpl* empty();
564
565     // FIXME: Does this really belong in StringImpl?
566     template <typename T> static void copyChars(T* destination, const T* source, unsigned numCharacters)
567     {
568         if (numCharacters == 1) {
569             *destination = *source;
570             return;
571         }
572
573         if (numCharacters <= s_copyCharsInlineCutOff) {
574             unsigned i = 0;
575 #if (CPU(X86) || CPU(X86_64))
576             const unsigned charsPerInt = sizeof(uint32_t) / sizeof(T);
577
578             if (numCharacters > charsPerInt) {
579                 unsigned stopCount = numCharacters & ~(charsPerInt - 1);
580
581                 const uint32_t* srcCharacters = reinterpret_cast<const uint32_t*>(source);
582                 uint32_t* destCharacters = reinterpret_cast<uint32_t*>(destination);
583                 for (unsigned j = 0; i < stopCount; i += charsPerInt, ++j)
584                     destCharacters[j] = srcCharacters[j];
585             }
586 #endif
587             for (; i < numCharacters; ++i)
588                 destination[i] = source[i];
589         } else
590             memcpy(destination, source, numCharacters * sizeof(T));
591     }
592
593     ALWAYS_INLINE static void copyChars(UChar* destination, const LChar* source, unsigned numCharacters)
594     {
595         for (unsigned i = 0; i < numCharacters; ++i)
596             destination[i] = source[i];
597     }
598
599     // Some string features, like refcounting and the atomicity flag, are not
600     // thread-safe. We achieve thread safety by isolation, giving each thread
601     // its own copy of the string.
602     Ref<StringImpl> isolatedCopy() const;
603
604     WTF_EXPORT_STRING_API Ref<StringImpl> substring(unsigned pos, unsigned len = UINT_MAX);
605
606     UChar at(unsigned i) const
607     {
608         ASSERT_WITH_SECURITY_IMPLICATION(i < m_length);
609         if (is8Bit())
610             return m_data8[i];
611         return m_data16[i];
612     }
613     UChar operator[](unsigned i) const { return at(i); }
614     WTF_EXPORT_STRING_API UChar32 characterStartingAt(unsigned);
615
616     WTF_EXPORT_STRING_API bool containsOnlyWhitespace();
617
618     int toIntStrict(bool* ok = 0, int base = 10);
619     unsigned toUIntStrict(bool* ok = 0, int base = 10);
620     int64_t toInt64Strict(bool* ok = 0, int base = 10);
621     uint64_t toUInt64Strict(bool* ok = 0, int base = 10);
622     intptr_t toIntPtrStrict(bool* ok = 0, int base = 10);
623
624     WTF_EXPORT_STRING_API int toInt(bool* ok = 0); // ignores trailing garbage
625     unsigned toUInt(bool* ok = 0); // ignores trailing garbage
626     int64_t toInt64(bool* ok = 0); // ignores trailing garbage
627     uint64_t toUInt64(bool* ok = 0); // ignores trailing garbage
628     intptr_t toIntPtr(bool* ok = 0); // ignores trailing garbage
629
630     // FIXME: Like the strict functions above, these give false for "ok" when there is trailing garbage.
631     // Like the non-strict functions above, these return the value when there is trailing garbage.
632     // It would be better if these were more consistent with the above functions instead.
633     double toDouble(bool* ok = 0);
634     float toFloat(bool* ok = 0);
635
636     WTF_EXPORT_STRING_API Ref<StringImpl> convertToASCIILowercase();
637     WTF_EXPORT_STRING_API Ref<StringImpl> lower();
638     WTF_EXPORT_STRING_API Ref<StringImpl> upper();
639     WTF_EXPORT_STRING_API Ref<StringImpl> lower(const AtomicString& localeIdentifier);
640     WTF_EXPORT_STRING_API Ref<StringImpl> upper(const AtomicString& localeIdentifier);
641
642     WTF_EXPORT_STRING_API Ref<StringImpl> fill(UChar);
643     // FIXME: Do we need fill(char) or can we just do the right thing if UChar is ASCII?
644
645     Ref<StringImpl> foldCase();
646
647     Ref<StringImpl> stripWhiteSpace();
648     Ref<StringImpl> stripWhiteSpace(IsWhiteSpaceFunctionPtr);
649     WTF_EXPORT_STRING_API Ref<StringImpl> simplifyWhiteSpace();
650     Ref<StringImpl> simplifyWhiteSpace(IsWhiteSpaceFunctionPtr);
651
652     Ref<StringImpl> removeCharacters(CharacterMatchFunctionPtr);
653     template <typename CharType>
654     ALWAYS_INLINE Ref<StringImpl> removeCharacters(const CharType* characters, CharacterMatchFunctionPtr);
655
656     size_t find(LChar character, unsigned start = 0);
657     size_t find(char character, unsigned start = 0);
658     size_t find(UChar character, unsigned start = 0);
659     WTF_EXPORT_STRING_API size_t find(CharacterMatchFunctionPtr, unsigned index = 0);
660     size_t find(const LChar*, unsigned index = 0);
661     ALWAYS_INLINE size_t find(const char* s, unsigned index = 0) { return find(reinterpret_cast<const LChar*>(s), index); }
662     WTF_EXPORT_STRING_API size_t find(StringImpl*);
663     WTF_EXPORT_STRING_API size_t find(StringImpl*, unsigned index);
664     size_t findIgnoringCase(const LChar*, unsigned index = 0);
665     ALWAYS_INLINE size_t findIgnoringCase(const char* s, unsigned index = 0) { return findIgnoringCase(reinterpret_cast<const LChar*>(s), index); }
666     WTF_EXPORT_STRING_API size_t findIgnoringCase(StringImpl*, unsigned index = 0);
667
668     WTF_EXPORT_STRING_API size_t findNextLineStart(unsigned index = UINT_MAX);
669
670     WTF_EXPORT_STRING_API size_t reverseFind(UChar, unsigned index = UINT_MAX);
671     WTF_EXPORT_STRING_API size_t reverseFind(StringImpl*, unsigned index = UINT_MAX);
672     WTF_EXPORT_STRING_API size_t reverseFindIgnoringCase(StringImpl*, unsigned index = UINT_MAX);
673
674     WTF_EXPORT_STRING_API bool startsWith(const StringImpl*) const;
675     bool startsWith(StringImpl* str, bool caseSensitive) { return caseSensitive ? startsWith(str) : (reverseFindIgnoringCase(str, 0) == 0); }
676     WTF_EXPORT_STRING_API bool startsWith(UChar) const;
677     WTF_EXPORT_STRING_API bool startsWith(const char*, unsigned matchLength, bool caseSensitive) const;
678     template<unsigned matchLength>
679     bool startsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const { return startsWith(prefix, matchLength - 1, caseSensitive); }
680     WTF_EXPORT_STRING_API bool startsWith(StringImpl&, unsigned startOffset, bool caseSensitive) const;
681
682     WTF_EXPORT_STRING_API bool endsWith(StringImpl*, bool caseSensitive = true);
683     WTF_EXPORT_STRING_API bool endsWith(UChar) const;
684     WTF_EXPORT_STRING_API bool endsWith(const char*, unsigned matchLength, bool caseSensitive) const;
685     template<unsigned matchLength>
686     bool endsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const { return endsWith(prefix, matchLength - 1, caseSensitive); }
687     WTF_EXPORT_STRING_API bool endsWith(StringImpl&, unsigned endOffset, bool caseSensitive) const;
688
689     WTF_EXPORT_STRING_API Ref<StringImpl> replace(UChar, UChar);
690     WTF_EXPORT_STRING_API Ref<StringImpl> replace(UChar, StringImpl*);
691     ALWAYS_INLINE Ref<StringImpl> replace(UChar pattern, const char* replacement, unsigned replacementLength) { return replace(pattern, reinterpret_cast<const LChar*>(replacement), replacementLength); }
692     WTF_EXPORT_STRING_API Ref<StringImpl> replace(UChar, const LChar*, unsigned replacementLength);
693     Ref<StringImpl> replace(UChar, const UChar*, unsigned replacementLength);
694     WTF_EXPORT_STRING_API Ref<StringImpl> replace(StringImpl*, StringImpl*);
695     WTF_EXPORT_STRING_API Ref<StringImpl> replace(unsigned index, unsigned len, StringImpl*);
696
697     WTF_EXPORT_STRING_API UCharDirection defaultWritingDirection(bool* hasStrongDirectionality = nullptr);
698
699 #if USE(CF)
700     RetainPtr<CFStringRef> createCFString();
701 #endif
702 #ifdef __OBJC__
703     WTF_EXPORT_STRING_API operator NSString*();
704 #endif
705
706 #if STRING_STATS
707     ALWAYS_INLINE static StringStats& stringStats() { return m_stringStats; }
708 #endif
709
710     WTF_EXPORT_STRING_API static const UChar latin1CaseFoldTable[256];
711
712 private:
713     bool requiresCopy() const
714     {
715         if (bufferOwnership() != BufferInternal)
716             return true;
717
718         if (is8Bit())
719             return m_data8 == tailPointer<LChar>();
720         return m_data16 == tailPointer<UChar>();
721     }
722
723     template<typename T>
724     static size_t allocationSize(unsigned tailElementCount)
725     {
726         return tailOffset<T>() + tailElementCount * sizeof(T);
727     }
728
729     template<typename T>
730     static ptrdiff_t tailOffset()
731     {
732 #if COMPILER(MSVC)
733         // MSVC doesn't support alignof yet.
734         return roundUpToMultipleOf<sizeof(T)>(sizeof(StringImpl));
735 #else
736         return roundUpToMultipleOf<alignof(T)>(offsetof(StringImpl, m_hashAndFlags) + sizeof(StringImpl::m_hashAndFlags));
737 #endif
738     }
739
740     template<typename T>
741     const T* tailPointer() const
742     {
743         return reinterpret_cast_ptr<const T*>(reinterpret_cast<const uint8_t*>(this) + tailOffset<T>());
744     }
745
746     template<typename T>
747     T* tailPointer()
748     {
749         return reinterpret_cast_ptr<T*>(reinterpret_cast<uint8_t*>(this) + tailOffset<T>());
750     }
751
752     StringImpl* const& substringBuffer() const
753     {
754         ASSERT(bufferOwnership() == BufferSubstring);
755
756         return *tailPointer<StringImpl*>();
757     }
758
759     StringImpl*& substringBuffer()
760     {
761         ASSERT(bufferOwnership() == BufferSubstring);
762
763         return *tailPointer<StringImpl*>();
764     }
765
766     // This number must be at least 2 to avoid sharing empty, null as well as 1 character strings from SmallStrings.
767     static const unsigned s_copyCharsInlineCutOff = 20;
768
769     BufferOwnership bufferOwnership() const { return static_cast<BufferOwnership>(m_hashAndFlags & s_hashMaskBufferOwnership); }
770     template <class UCharPredicate> Ref<StringImpl> stripMatchedCharacters(UCharPredicate);
771     template <typename CharType, class UCharPredicate> Ref<StringImpl> simplifyMatchedCharactersToSpace(UCharPredicate);
772     template <typename CharType> static Ref<StringImpl> constructInternal(StringImpl*, unsigned);
773     template <typename CharType> static Ref<StringImpl> createUninitializedInternal(unsigned, CharType*&);
774     template <typename CharType> static Ref<StringImpl> createUninitializedInternalNonEmpty(unsigned, CharType*&);
775     template <typename CharType> static Ref<StringImpl> reallocateInternal(PassRefPtr<StringImpl>, unsigned, CharType*&);
776     template <typename CharType> static Ref<StringImpl> createInternal(const CharType*, unsigned);
777     WTF_EXPORT_PRIVATE NEVER_INLINE unsigned hashSlowCase() const;
778     WTF_EXPORT_PRIVATE unsigned hashAndFlagsForEmptyUnique();
779
780     // The bottom bit in the ref count indicates a static (immortal) string.
781     static const unsigned s_refCountFlagIsStaticString = 0x1;
782     static const unsigned s_refCountIncrement = 0x2; // This allows us to ref / deref without disturbing the static string flag.
783
784     // The bottom 6 bits in the hash are flags.
785     static const unsigned s_flagCount = 6;
786     static const unsigned s_flagMask = (1u << s_flagCount) - 1;
787     COMPILE_ASSERT(s_flagCount <= StringHasher::flagCount, StringHasher_reserves_enough_bits_for_StringImpl_flags);
788
789     static const unsigned s_hashFlag8BitBuffer = 1u << 5;
790     static const unsigned s_hashFlagIsAtomic = 1u << 4;
791     static const unsigned s_hashFlagDidReportCost = 1u << 3;
792     static const unsigned s_hashMaskBufferOwnership = 1u | (1u << 1);
793
794 #if STRING_STATS
795     WTF_EXPORTDATA static StringStats m_stringStats;
796 #endif
797
798 public:
799     struct StaticASCIILiteral {
800         // These member variables must match the layout of StringImpl.
801         unsigned m_refCount;
802         unsigned m_length;
803         const LChar* m_data8;
804         unsigned m_hashAndFlags;
805
806         // These values mimic ConstructFromLiteral.
807         static const unsigned s_initialRefCount = s_refCountIncrement;
808         static const unsigned s_initialFlags = s_hashFlag8BitBuffer | BufferInternal;
809         static const unsigned s_hashShift = s_flagCount;
810     };
811
812 #ifndef NDEBUG
813     void assertHashIsCorrect()
814     {
815         ASSERT(hasHash());
816         ASSERT(existingHash() == StringHasher::computeHashAndMaskTop8Bits(characters8(), length()));
817     }
818 #endif
819
820 private:
821     // These member variables must match the layout of StaticASCIILiteral.
822     unsigned m_refCount;
823     unsigned m_length;
824     union {
825         const LChar* m_data8;
826         const UChar* m_data16;
827     };
828     mutable unsigned m_hashAndFlags;
829 };
830
831 static_assert(sizeof(StringImpl) == sizeof(StringImpl::StaticASCIILiteral), "");
832
833 #if !ASSERT_DISABLED
834 // StringImpls created from StaticASCIILiteral will ASSERT
835 // in the generic ValueCheck<T>::checkConsistency
836 // as they are not allocated by fastMalloc.
837 // We don't currently have any way to detect that case
838 // so we ignore the consistency check for all StringImpl*.
839 template<> struct
840 ValueCheck<StringImpl*> {
841     static void checkConsistency(const StringImpl*) { }
842 };
843 #endif
844
845 template <>
846 ALWAYS_INLINE Ref<StringImpl> StringImpl::constructInternal<LChar>(StringImpl* impl, unsigned length) { return adoptRef(*new (NotNull, impl) StringImpl(length, Force8BitConstructor)); }
847 template <>
848 ALWAYS_INLINE Ref<StringImpl> StringImpl::constructInternal<UChar>(StringImpl* impl, unsigned length) { return adoptRef(*new (NotNull, impl) StringImpl(length)); }
849
850 template <>
851 ALWAYS_INLINE const LChar* StringImpl::characters<LChar>() const { return characters8(); }
852
853 template <>
854 ALWAYS_INLINE const UChar* StringImpl::characters<UChar>() const { return characters16(); }
855
856 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const StringImpl*);
857 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const LChar*);
858 inline bool equal(const StringImpl* a, const char* b) { return equal(a, reinterpret_cast<const LChar*>(b)); }
859 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const LChar*, unsigned);
860 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const UChar*, unsigned);
861 inline bool equal(const StringImpl* a, const char* b, unsigned length) { return equal(a, reinterpret_cast<const LChar*>(b), length); }
862 inline bool equal(const LChar* a, StringImpl* b) { return equal(b, a); }
863 inline bool equal(const char* a, StringImpl* b) { return equal(b, reinterpret_cast<const LChar*>(a)); }
864 WTF_EXPORT_STRING_API bool equal(const StringImpl& a, const StringImpl& b);
865
866 template<typename T>
867 inline T loadUnaligned(const char* s)
868 {
869 #if COMPILER(CLANG)
870     T tmp;
871     memcpy(&tmp, s, sizeof(T));
872     return tmp;
873 #else
874     // This may result in undefined behavior due to unaligned access.
875     return *reinterpret_cast<const T*>(s);
876 #endif
877 }
878
879 // Do comparisons 8 or 4 bytes-at-a-time on architectures where it's safe.
880 #if CPU(X86_64) || CPU(ARM64)
881 ALWAYS_INLINE bool equal(const LChar* aLChar, const LChar* bLChar, unsigned length)
882 {
883     unsigned dwordLength = length >> 3;
884
885     const char* a = reinterpret_cast<const char*>(aLChar);
886     const char* b = reinterpret_cast<const char*>(bLChar);
887
888     if (dwordLength) {
889         for (unsigned i = 0; i != dwordLength; ++i) {
890             if (loadUnaligned<uint64_t>(a) != loadUnaligned<uint64_t>(b))
891                 return false;
892
893             a += sizeof(uint64_t);
894             b += sizeof(uint64_t);
895         }
896     }
897
898     if (length & 4) {
899         if (loadUnaligned<uint32_t>(a) != loadUnaligned<uint32_t>(b))
900             return false;
901
902         a += sizeof(uint32_t);
903         b += sizeof(uint32_t);
904     }
905
906     if (length & 2) {
907         if (loadUnaligned<uint16_t>(a) != loadUnaligned<uint16_t>(b))
908             return false;
909
910         a += sizeof(uint16_t);
911         b += sizeof(uint16_t);
912     }
913
914     if (length & 1 && (*reinterpret_cast<const LChar*>(a) != *reinterpret_cast<const LChar*>(b)))
915         return false;
916
917     return true;
918 }
919
920 ALWAYS_INLINE bool equal(const UChar* aUChar, const UChar* bUChar, unsigned length)
921 {
922     unsigned dwordLength = length >> 2;
923
924     const char* a = reinterpret_cast<const char*>(aUChar);
925     const char* b = reinterpret_cast<const char*>(bUChar);
926
927     if (dwordLength) {
928         for (unsigned i = 0; i != dwordLength; ++i) {
929             if (loadUnaligned<uint64_t>(a) != loadUnaligned<uint64_t>(b))
930                 return false;
931
932             a += sizeof(uint64_t);
933             b += sizeof(uint64_t);
934         }
935     }
936
937     if (length & 2) {
938         if (loadUnaligned<uint32_t>(a) != loadUnaligned<uint32_t>(b))
939             return false;
940
941         a += sizeof(uint32_t);
942         b += sizeof(uint32_t);
943     }
944
945     if (length & 1 && (*reinterpret_cast<const UChar*>(a) != *reinterpret_cast<const UChar*>(b)))
946         return false;
947
948     return true;
949 }
950 #elif CPU(X86)
951 ALWAYS_INLINE bool equal(const LChar* aLChar, const LChar* bLChar, unsigned length)
952 {
953     const char* a = reinterpret_cast<const char*>(aLChar);
954     const char* b = reinterpret_cast<const char*>(bLChar);
955
956     unsigned wordLength = length >> 2;
957     for (unsigned i = 0; i != wordLength; ++i) {
958         if (loadUnaligned<uint32_t>(a) != loadUnaligned<uint32_t>(b))
959             return false;
960         a += sizeof(uint32_t);
961         b += sizeof(uint32_t);
962     }
963
964     length &= 3;
965
966     if (length) {
967         const LChar* aRemainder = reinterpret_cast<const LChar*>(a);
968         const LChar* bRemainder = reinterpret_cast<const LChar*>(b);
969
970         for (unsigned i = 0; i <  length; ++i) {
971             if (aRemainder[i] != bRemainder[i])
972                 return false;
973         }
974     }
975
976     return true;
977 }
978
979 ALWAYS_INLINE bool equal(const UChar* aUChar, const UChar* bUChar, unsigned length)
980 {
981     const char* a = reinterpret_cast<const char*>(aUChar);
982     const char* b = reinterpret_cast<const char*>(bUChar);
983
984     unsigned wordLength = length >> 1;
985     for (unsigned i = 0; i != wordLength; ++i) {
986         if (loadUnaligned<uint32_t>(a) != loadUnaligned<uint32_t>(b))
987             return false;
988         a += sizeof(uint32_t);
989         b += sizeof(uint32_t);
990     }
991
992     if (length & 1 && *reinterpret_cast<const UChar*>(a) != *reinterpret_cast<const UChar*>(b))
993         return false;
994
995     return true;
996 }
997 #elif PLATFORM(IOS) && WTF_ARM_ARCH_AT_LEAST(7)
998 ALWAYS_INLINE bool equal(const LChar* a, const LChar* b, unsigned length)
999 {
1000     bool isEqual = false;
1001     uint32_t aValue;
1002     uint32_t bValue;
1003     asm("subs   %[length], #4\n"
1004         "blo    2f\n"
1005
1006         "0:\n" // Label 0 = Start of loop over 32 bits.
1007         "ldr    %[aValue], [%[a]], #4\n"
1008         "ldr    %[bValue], [%[b]], #4\n"
1009         "cmp    %[aValue], %[bValue]\n"
1010         "bne    66f\n"
1011         "subs   %[length], #4\n"
1012         "bhs    0b\n"
1013
1014         // At this point, length can be:
1015         // -0: 00000000000000000000000000000000 (0 bytes left)
1016         // -1: 11111111111111111111111111111111 (3 bytes left)
1017         // -2: 11111111111111111111111111111110 (2 bytes left)
1018         // -3: 11111111111111111111111111111101 (1 byte left)
1019         // -4: 11111111111111111111111111111100 (length was 0)
1020         // The pointers are at the correct position.
1021         "2:\n" // Label 2 = End of loop over 32 bits, check for pair of characters.
1022         "tst    %[length], #2\n"
1023         "beq    1f\n"
1024         "ldrh   %[aValue], [%[a]], #2\n"
1025         "ldrh   %[bValue], [%[b]], #2\n"
1026         "cmp    %[aValue], %[bValue]\n"
1027         "bne    66f\n"
1028
1029         "1:\n" // Label 1 = Check for a single character left.
1030         "tst    %[length], #1\n"
1031         "beq    42f\n"
1032         "ldrb   %[aValue], [%[a]]\n"
1033         "ldrb   %[bValue], [%[b]]\n"
1034         "cmp    %[aValue], %[bValue]\n"
1035         "bne    66f\n"
1036
1037         "42:\n" // Label 42 = Success.
1038         "mov    %[isEqual], #1\n"
1039         "66:\n" // Label 66 = End without changing isEqual to 1.
1040         : [length]"+r"(length), [isEqual]"+r"(isEqual), [a]"+r"(a), [b]"+r"(b), [aValue]"+r"(aValue), [bValue]"+r"(bValue)
1041         :
1042         :
1043         );
1044     return isEqual;
1045 }
1046
1047 ALWAYS_INLINE bool equal(const UChar* a, const UChar* b, unsigned length)
1048 {
1049     bool isEqual = false;
1050     uint32_t aValue;
1051     uint32_t bValue;
1052     asm("subs   %[length], #2\n"
1053         "blo    1f\n"
1054
1055         "0:\n" // Label 0 = Start of loop over 32 bits.
1056         "ldr    %[aValue], [%[a]], #4\n"
1057         "ldr    %[bValue], [%[b]], #4\n"
1058         "cmp    %[aValue], %[bValue]\n"
1059         "bne    66f\n"
1060         "subs   %[length], #2\n"
1061         "bhs    0b\n"
1062
1063         // At this point, length can be:
1064         // -0: 00000000000000000000000000000000 (0 bytes left)
1065         // -1: 11111111111111111111111111111111 (1 character left, 2 bytes)
1066         // -2: 11111111111111111111111111111110 (length was zero)
1067         // The pointers are at the correct position.
1068         "1:\n" // Label 1 = Check for a single character left.
1069         "tst    %[length], #1\n"
1070         "beq    42f\n"
1071         "ldrh   %[aValue], [%[a]]\n"
1072         "ldrh   %[bValue], [%[b]]\n"
1073         "cmp    %[aValue], %[bValue]\n"
1074         "bne    66f\n"
1075
1076         "42:\n" // Label 42 = Success.
1077         "mov    %[isEqual], #1\n"
1078         "66:\n" // Label 66 = End without changing isEqual to 1.
1079         : [length]"+r"(length), [isEqual]"+r"(isEqual), [a]"+r"(a), [b]"+r"(b), [aValue]"+r"(aValue), [bValue]"+r"(bValue)
1080         :
1081         :
1082         );
1083     return isEqual;
1084 }
1085 #else
1086 ALWAYS_INLINE bool equal(const LChar* a, const LChar* b, unsigned length) { return !memcmp(a, b, length); }
1087 ALWAYS_INLINE bool equal(const UChar* a, const UChar* b, unsigned length) { return !memcmp(a, b, length * sizeof(UChar)); }
1088 #endif
1089
1090 ALWAYS_INLINE bool equal(const LChar* a, const UChar* b, unsigned length)
1091 {
1092     for (unsigned i = 0; i < length; ++i) {
1093         if (a[i] != b[i])
1094             return false;
1095     }
1096     return true;
1097 }
1098
1099 ALWAYS_INLINE bool equal(const UChar* a, const LChar* b, unsigned length) { return equal(b, a, length); }
1100
1101 WTF_EXPORT_STRING_API bool equalIgnoringCase(const StringImpl*, const StringImpl*);
1102 WTF_EXPORT_STRING_API bool equalIgnoringCase(const StringImpl*, const LChar*);
1103 inline bool equalIgnoringCase(const LChar* a, const StringImpl* b) { return equalIgnoringCase(b, a); }
1104 WTF_EXPORT_STRING_API bool equalIgnoringCase(const LChar*, const LChar*, unsigned);
1105 WTF_EXPORT_STRING_API bool equalIgnoringCase(const UChar*, const LChar*, unsigned);
1106 inline bool equalIgnoringCase(const UChar* a, const char* b, unsigned length) { return equalIgnoringCase(a, reinterpret_cast<const LChar*>(b), length); }
1107 inline bool equalIgnoringCase(const LChar* a, const UChar* b, unsigned length) { return equalIgnoringCase(b, a, length); }
1108 inline bool equalIgnoringCase(const char* a, const UChar* b, unsigned length) { return equalIgnoringCase(b, reinterpret_cast<const LChar*>(a), length); }
1109 inline bool equalIgnoringCase(const char* a, const LChar* b, unsigned length) { return equalIgnoringCase(b, reinterpret_cast<const LChar*>(a), length); }
1110 inline bool equalIgnoringCase(const UChar* a, const UChar* b, int length)
1111 {
1112     ASSERT(length >= 0);
1113     return !u_memcasecmp(a, b, length, U_FOLD_CASE_DEFAULT);
1114 }
1115 WTF_EXPORT_STRING_API bool equalIgnoringCaseNonNull(const StringImpl*, const StringImpl*);
1116
1117 WTF_EXPORT_STRING_API bool equalIgnoringNullity(StringImpl*, StringImpl*);
1118 WTF_EXPORT_STRING_API bool equalIgnoringNullity(const UChar*, size_t length, StringImpl*);
1119
1120 template<typename CharacterType>
1121 inline size_t find(const CharacterType* characters, unsigned length, CharacterType matchCharacter, unsigned index = 0)
1122 {
1123     while (index < length) {
1124         if (characters[index] == matchCharacter)
1125             return index;
1126         ++index;
1127     }
1128     return notFound;
1129 }
1130
1131 ALWAYS_INLINE size_t find(const UChar* characters, unsigned length, LChar matchCharacter, unsigned index = 0)
1132 {
1133     return find(characters, length, static_cast<UChar>(matchCharacter), index);
1134 }
1135
1136 inline size_t find(const LChar* characters, unsigned length, UChar matchCharacter, unsigned index = 0)
1137 {
1138     if (matchCharacter & ~0xFF)
1139         return notFound;
1140     return find(characters, length, static_cast<LChar>(matchCharacter), index);
1141 }
1142
1143 inline size_t find(const LChar* characters, unsigned length, CharacterMatchFunctionPtr matchFunction, unsigned index = 0)
1144 {
1145     while (index < length) {
1146         if (matchFunction(characters[index]))
1147             return index;
1148         ++index;
1149     }
1150     return notFound;
1151 }
1152
1153 inline size_t find(const UChar* characters, unsigned length, CharacterMatchFunctionPtr matchFunction, unsigned index = 0)
1154 {
1155     while (index < length) {
1156         if (matchFunction(characters[index]))
1157             return index;
1158         ++index;
1159     }
1160     return notFound;
1161 }
1162
1163 template<typename CharacterType>
1164 inline size_t findNextLineStart(const CharacterType* characters, unsigned length, unsigned index = 0)
1165 {
1166     while (index < length) {
1167         CharacterType c = characters[index++];
1168         if ((c != '\n') && (c != '\r'))
1169             continue;
1170
1171         // There can only be a start of a new line if there are more characters
1172         // beyond the current character.
1173         if (index < length) {
1174             // The 3 common types of line terminators are 1. \r\n (Windows), 
1175             // 2. \r (old MacOS) and 3. \n (Unix'es).
1176
1177             if (c == '\n')
1178                 return index; // Case 3: just \n.
1179
1180             CharacterType c2 = characters[index];
1181             if (c2 != '\n')
1182                 return index; // Case 2: just \r.
1183
1184             // Case 1: \r\n.
1185             // But, there's only a start of a new line if there are more
1186             // characters beyond the \r\n.
1187             if (++index < length)
1188                 return index; 
1189         }
1190     }
1191     return notFound;
1192 }
1193
1194 template<typename CharacterType>
1195 inline size_t reverseFindLineTerminator(const CharacterType* characters, unsigned length, unsigned index = UINT_MAX)
1196 {
1197     if (!length)
1198         return notFound;
1199     if (index >= length)
1200         index = length - 1;
1201     CharacterType c = characters[index];
1202     while ((c != '\n') && (c != '\r')) {
1203         if (!index--)
1204             return notFound;
1205         c = characters[index];
1206     }
1207     return index;
1208 }
1209
1210 template<typename CharacterType>
1211 inline size_t reverseFind(const CharacterType* characters, unsigned length, CharacterType matchCharacter, unsigned index = UINT_MAX)
1212 {
1213     if (!length)
1214         return notFound;
1215     if (index >= length)
1216         index = length - 1;
1217     while (characters[index] != matchCharacter) {
1218         if (!index--)
1219             return notFound;
1220     }
1221     return index;
1222 }
1223
1224 ALWAYS_INLINE size_t reverseFind(const UChar* characters, unsigned length, LChar matchCharacter, unsigned index = UINT_MAX)
1225 {
1226     return reverseFind(characters, length, static_cast<UChar>(matchCharacter), index);
1227 }
1228
1229 inline size_t reverseFind(const LChar* characters, unsigned length, UChar matchCharacter, unsigned index = UINT_MAX)
1230 {
1231     if (matchCharacter & ~0xFF)
1232         return notFound;
1233     return reverseFind(characters, length, static_cast<LChar>(matchCharacter), index);
1234 }
1235
1236 inline size_t StringImpl::find(LChar character, unsigned start)
1237 {
1238     if (is8Bit())
1239         return WTF::find(characters8(), m_length, character, start);
1240     return WTF::find(characters16(), m_length, character, start);
1241 }
1242
1243 ALWAYS_INLINE size_t StringImpl::find(char character, unsigned start)
1244 {
1245     return find(static_cast<LChar>(character), start);
1246 }
1247
1248 inline size_t StringImpl::find(UChar character, unsigned start)
1249 {
1250     if (is8Bit())
1251         return WTF::find(characters8(), m_length, character, start);
1252     return WTF::find(characters16(), m_length, character, start);
1253 }
1254
1255 template<size_t inlineCapacity> inline bool equalIgnoringNullity(const Vector<UChar, inlineCapacity>& a, StringImpl* b)
1256 {
1257     return equalIgnoringNullity(a.data(), a.size(), b);
1258 }
1259
1260 template<typename CharacterType1, typename CharacterType2>
1261 inline int codePointCompare(unsigned l1, unsigned l2, const CharacterType1* c1, const CharacterType2* c2)
1262 {
1263     const unsigned lmin = l1 < l2 ? l1 : l2;
1264     unsigned pos = 0;
1265     while (pos < lmin && *c1 == *c2) {
1266         ++c1;
1267         ++c2;
1268         ++pos;
1269     }
1270
1271     if (pos < lmin)
1272         return (c1[0] > c2[0]) ? 1 : -1;
1273
1274     if (l1 == l2)
1275         return 0;
1276
1277     return (l1 > l2) ? 1 : -1;
1278 }
1279
1280 inline int codePointCompare8(const StringImpl* string1, const StringImpl* string2)
1281 {
1282     return codePointCompare(string1->length(), string2->length(), string1->characters8(), string2->characters8());
1283 }
1284
1285 inline int codePointCompare16(const StringImpl* string1, const StringImpl* string2)
1286 {
1287     return codePointCompare(string1->length(), string2->length(), string1->characters16(), string2->characters16());
1288 }
1289
1290 inline int codePointCompare8To16(const StringImpl* string1, const StringImpl* string2)
1291 {
1292     return codePointCompare(string1->length(), string2->length(), string1->characters8(), string2->characters16());
1293 }
1294
1295 inline int codePointCompare(const StringImpl* string1, const StringImpl* string2)
1296 {
1297     if (!string1)
1298         return (string2 && string2->length()) ? -1 : 0;
1299
1300     if (!string2)
1301         return string1->length() ? 1 : 0;
1302
1303     bool string1Is8Bit = string1->is8Bit();
1304     bool string2Is8Bit = string2->is8Bit();
1305     if (string1Is8Bit) {
1306         if (string2Is8Bit)
1307             return codePointCompare8(string1, string2);
1308         return codePointCompare8To16(string1, string2);
1309     }
1310     if (string2Is8Bit)
1311         return -codePointCompare8To16(string2, string1);
1312     return codePointCompare16(string1, string2);
1313 }
1314
1315 inline bool isSpaceOrNewline(UChar c)
1316 {
1317     // Use isASCIISpace() for basic Latin-1.
1318     // This will include newlines, which aren't included in Unicode DirWS.
1319     return c <= 0x7F ? isASCIISpace(c) : u_charDirection(c) == U_WHITE_SPACE_NEUTRAL;
1320 }
1321
1322 template<typename CharacterType>
1323 inline unsigned lengthOfNullTerminatedString(const CharacterType* string)
1324 {
1325     ASSERT(string);
1326     size_t length = 0;
1327     while (string[length])
1328         ++length;
1329
1330     RELEASE_ASSERT(length < std::numeric_limits<unsigned>::max());
1331     return static_cast<unsigned>(length);
1332 }
1333
1334 inline Ref<StringImpl> StringImpl::isolatedCopy() const
1335 {
1336     if (!requiresCopy()) {
1337         if (is8Bit())
1338             return StringImpl::createWithoutCopying(m_data8, m_length);
1339         return StringImpl::createWithoutCopying(m_data16, m_length);
1340     }
1341
1342     if (is8Bit())
1343         return create(m_data8, m_length);
1344     return create(m_data16, m_length);
1345 }
1346
1347 struct StringHash;
1348
1349 // StringHash is the default hash for StringImpl* and RefPtr<StringImpl>
1350 template<typename T> struct DefaultHash;
1351 template<> struct DefaultHash<StringImpl*> {
1352     typedef StringHash Hash;
1353 };
1354 template<> struct DefaultHash<RefPtr<StringImpl>> {
1355     typedef StringHash Hash;
1356 };
1357
1358 } // namespace WTF
1359
1360 using WTF::StringImpl;
1361 using WTF::equal;
1362 using WTF::TextCaseSensitivity;
1363 using WTF::TextCaseSensitive;
1364 using WTF::TextCaseInsensitive;
1365
1366 #endif