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