d44e5cfa5709add6dc1efcd9e7dd5dafc9d25c9b
[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, PassRefPtr<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, PassRefPtr<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, PassRefPtr<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, PassRefPtr<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(PassRefPtr<StringImpl> rep, unsigned offset, unsigned length)
356     {
357         ASSERT(rep);
358         ASSERT(length <= rep->length());
359
360         if (!length)
361             return *empty();
362
363         StringImpl* ownerRep = (rep->bufferOwnership() == BufferSubstring) ? rep->substringBuffer() : rep.get();
364
365         // We allocate a buffer that contains both the StringImpl struct as well as the pointer to the owner string.
366         StringImpl* stringImpl = static_cast<StringImpl*>(fastMalloc(allocationSize<StringImpl*>(1)));
367         if (rep->is8Bit())
368             return adoptRef(*new (NotNull, stringImpl) StringImpl(rep->m_data8 + offset, length, ownerRep));
369         return adoptRef(*new (NotNull, stringImpl) StringImpl(rep->m_data16 + offset, length, ownerRep));
370     }
371
372     template<unsigned charactersCount>
373     ALWAYS_INLINE static Ref<StringImpl> createFromLiteral(const char (&characters)[charactersCount])
374     {
375         COMPILE_ASSERT(charactersCount > 1, StringImplFromLiteralNotEmpty);
376         COMPILE_ASSERT((charactersCount - 1 <= ((unsigned(~0) - sizeof(StringImpl)) / sizeof(LChar))), StringImplFromLiteralCannotOverflow);
377
378         return createWithoutCopying(reinterpret_cast<const LChar*>(characters), charactersCount - 1);
379     }
380
381     // FIXME: Transition off of these functions to createWithoutCopying instead.
382     WTF_EXPORT_STRING_API static Ref<StringImpl> createFromLiteral(const char* characters, unsigned length);
383     WTF_EXPORT_STRING_API static Ref<StringImpl> createFromLiteral(const char* characters);
384
385     WTF_EXPORT_STRING_API static Ref<StringImpl> createWithoutCopying(const UChar* characters, unsigned length);
386     WTF_EXPORT_STRING_API static Ref<StringImpl> createWithoutCopying(const LChar* characters, unsigned length);
387
388     WTF_EXPORT_STRING_API static Ref<StringImpl> createUninitialized(unsigned length, LChar*& data);
389     WTF_EXPORT_STRING_API static Ref<StringImpl> createUninitialized(unsigned length, UChar*& data);
390     template <typename T> static ALWAYS_INLINE PassRefPtr<StringImpl> tryCreateUninitialized(unsigned length, T*& output)
391     {
392         if (!length) {
393             output = 0;
394             return empty();
395         }
396
397         if (length > ((std::numeric_limits<unsigned>::max() - sizeof(StringImpl)) / sizeof(T))) {
398             output = 0;
399             return 0;
400         }
401         StringImpl* resultImpl;
402         if (!tryFastMalloc(allocationSize<T>(length)).getValue(resultImpl)) {
403             output = 0;
404             return 0;
405         }
406         output = resultImpl->tailPointer<T>();
407
408         return constructInternal<T>(resultImpl, length);
409     }
410
411     WTF_EXPORT_STRING_API static Ref<SymbolImpl> createSymbolEmpty();
412     WTF_EXPORT_STRING_API static Ref<SymbolImpl> createSymbol(PassRefPtr<StringImpl> rep);
413
414     // Reallocate the StringImpl. The originalString must be only owned by the PassRefPtr,
415     // and the buffer ownership must be BufferInternal. Just like the input pointer of realloc(),
416     // the originalString can't be used after this function.
417     static Ref<StringImpl> reallocate(PassRefPtr<StringImpl> originalString, unsigned length, LChar*& data);
418     static Ref<StringImpl> reallocate(PassRefPtr<StringImpl> originalString, unsigned length, UChar*& data);
419
420     static unsigned flagsOffset() { return OBJECT_OFFSETOF(StringImpl, m_hashAndFlags); }
421     static unsigned flagIs8Bit() { return s_hashFlag8BitBuffer; }
422     static unsigned flagIsAtomic() { return s_hashFlagStringKindIsAtomic; }
423     static unsigned flagIsSymbol() { return s_hashFlagStringKindIsSymbol; }
424     static unsigned maskStringKind() { return s_hashMaskStringKind; }
425     static unsigned dataOffset() { return OBJECT_OFFSETOF(StringImpl, m_data8); }
426
427     template<typename CharType, size_t inlineCapacity, typename OverflowHandler>
428     static Ref<StringImpl> adopt(Vector<CharType, inlineCapacity, OverflowHandler>& vector)
429     {
430         if (size_t size = vector.size()) {
431             ASSERT(vector.data());
432             if (size > std::numeric_limits<unsigned>::max())
433                 CRASH();
434             return adoptRef(*new StringImpl(vector.releaseBuffer(), size));
435         }
436         return *empty();
437     }
438
439     WTF_EXPORT_STRING_API static Ref<StringImpl> adopt(StringBuffer<UChar>&);
440     WTF_EXPORT_STRING_API static Ref<StringImpl> adopt(StringBuffer<LChar>&);
441
442     unsigned length() const { return m_length; }
443     static ptrdiff_t lengthMemoryOffset() { return OBJECT_OFFSETOF(StringImpl, m_length); }
444     bool is8Bit() const { return m_hashAndFlags & s_hashFlag8BitBuffer; }
445
446     ALWAYS_INLINE const LChar* characters8() const { ASSERT(is8Bit()); return m_data8; }
447     ALWAYS_INLINE const UChar* characters16() const { ASSERT(!is8Bit()); return m_data16; }
448
449     template <typename CharType>
450     ALWAYS_INLINE const CharType *characters() const;
451
452     size_t cost() const
453     {
454         // For substrings, return the cost of the base string.
455         if (bufferOwnership() == BufferSubstring)
456             return substringBuffer()->cost();
457
458         if (m_hashAndFlags & s_hashFlagDidReportCost)
459             return 0;
460
461         m_hashAndFlags |= s_hashFlagDidReportCost;
462         size_t result = m_length;
463         if (!is8Bit())
464             result <<= 1;
465         return result;
466     }
467     
468     size_t costDuringGC()
469     {
470         if (isStatic())
471             return 0;
472         
473         if (bufferOwnership() == BufferSubstring)
474             return divideRoundedUp(substringBuffer()->costDuringGC(), refCount());
475         
476         size_t result = m_length;
477         if (!is8Bit())
478             result <<= 1;
479         return divideRoundedUp(result, refCount());
480     }
481
482     WTF_EXPORT_STRING_API size_t sizeInBytes() const;
483
484     StringKind stringKind() const { return static_cast<StringKind>(m_hashAndFlags & s_hashMaskStringKind); }
485     bool isSymbol() const { return m_hashAndFlags & s_hashFlagStringKindIsSymbol; }
486     bool isAtomic() const { return m_hashAndFlags & s_hashFlagStringKindIsAtomic; }
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         ASSERT(!isCompilationThread());
589
590         STRING_STATS_REF_STRING(*this);
591
592         m_refCount += s_refCountIncrement;
593     }
594
595     inline void deref()
596     {
597         ASSERT(!isCompilationThread());
598
599         STRING_STATS_DEREF_STRING(*this);
600
601         unsigned tempRefCount = m_refCount - s_refCountIncrement;
602         if (!tempRefCount) {
603             StringImpl::destroy(this);
604             return;
605         }
606         m_refCount = tempRefCount;
607     }
608
609     WTF_EXPORT_PRIVATE static StringImpl* empty();
610
611     // FIXME: Does this really belong in StringImpl?
612     template <typename T> static void copyChars(T* destination, const T* source, unsigned numCharacters)
613     {
614         if (numCharacters == 1) {
615             *destination = *source;
616             return;
617         }
618
619         if (numCharacters <= s_copyCharsInlineCutOff) {
620             unsigned i = 0;
621 #if (CPU(X86) || CPU(X86_64))
622             const unsigned charsPerInt = sizeof(uint32_t) / sizeof(T);
623
624             if (numCharacters > charsPerInt) {
625                 unsigned stopCount = numCharacters & ~(charsPerInt - 1);
626
627                 const uint32_t* srcCharacters = reinterpret_cast<const uint32_t*>(source);
628                 uint32_t* destCharacters = reinterpret_cast<uint32_t*>(destination);
629                 for (unsigned j = 0; i < stopCount; i += charsPerInt, ++j)
630                     destCharacters[j] = srcCharacters[j];
631             }
632 #endif
633             for (; i < numCharacters; ++i)
634                 destination[i] = source[i];
635         } else
636             memcpy(destination, source, numCharacters * sizeof(T));
637     }
638
639     ALWAYS_INLINE static void copyChars(UChar* destination, const LChar* source, unsigned numCharacters)
640     {
641         for (unsigned i = 0; i < numCharacters; ++i)
642             destination[i] = source[i];
643     }
644
645     // Some string features, like refcounting and the atomicity flag, are not
646     // thread-safe. We achieve thread safety by isolation, giving each thread
647     // its own copy of the string.
648     Ref<StringImpl> isolatedCopy() const;
649
650     WTF_EXPORT_STRING_API Ref<StringImpl> substring(unsigned pos, unsigned len = UINT_MAX);
651
652     UChar at(unsigned i) const
653     {
654         ASSERT_WITH_SECURITY_IMPLICATION(i < m_length);
655         if (is8Bit())
656             return m_data8[i];
657         return m_data16[i];
658     }
659     UChar operator[](unsigned i) const { return at(i); }
660     WTF_EXPORT_STRING_API UChar32 characterStartingAt(unsigned);
661
662     WTF_EXPORT_STRING_API bool containsOnlyWhitespace();
663
664     int toIntStrict(bool* ok = 0, int base = 10);
665     unsigned toUIntStrict(bool* ok = 0, int base = 10);
666     int64_t toInt64Strict(bool* ok = 0, int base = 10);
667     uint64_t toUInt64Strict(bool* ok = 0, int base = 10);
668     intptr_t toIntPtrStrict(bool* ok = 0, int base = 10);
669
670     WTF_EXPORT_STRING_API int toInt(bool* ok = 0); // ignores trailing garbage
671     unsigned toUInt(bool* ok = 0); // ignores trailing garbage
672     int64_t toInt64(bool* ok = 0); // ignores trailing garbage
673     uint64_t toUInt64(bool* ok = 0); // ignores trailing garbage
674     intptr_t toIntPtr(bool* ok = 0); // ignores trailing garbage
675
676     // FIXME: Like the strict functions above, these give false for "ok" when there is trailing garbage.
677     // Like the non-strict functions above, these return the value when there is trailing garbage.
678     // It would be better if these were more consistent with the above functions instead.
679     double toDouble(bool* ok = 0);
680     float toFloat(bool* ok = 0);
681
682     WTF_EXPORT_STRING_API Ref<StringImpl> convertToASCIILowercase();
683     WTF_EXPORT_STRING_API Ref<StringImpl> convertToASCIIUppercase();
684     WTF_EXPORT_STRING_API Ref<StringImpl> lower();
685     WTF_EXPORT_STRING_API Ref<StringImpl> upper();
686     WTF_EXPORT_STRING_API Ref<StringImpl> lower(const AtomicString& localeIdentifier);
687     WTF_EXPORT_STRING_API Ref<StringImpl> upper(const AtomicString& localeIdentifier);
688
689     Ref<StringImpl> foldCase();
690
691     Ref<StringImpl> stripWhiteSpace();
692     Ref<StringImpl> stripWhiteSpace(IsWhiteSpaceFunctionPtr);
693     WTF_EXPORT_STRING_API Ref<StringImpl> simplifyWhiteSpace();
694     Ref<StringImpl> simplifyWhiteSpace(IsWhiteSpaceFunctionPtr);
695
696     Ref<StringImpl> removeCharacters(CharacterMatchFunctionPtr);
697     template <typename CharType>
698     ALWAYS_INLINE Ref<StringImpl> removeCharacters(const CharType* characters, CharacterMatchFunctionPtr);
699
700     size_t find(LChar character, unsigned start = 0);
701     size_t find(char character, unsigned start = 0);
702     size_t find(UChar character, unsigned start = 0);
703     WTF_EXPORT_STRING_API size_t find(CharacterMatchFunctionPtr, unsigned index = 0);
704     size_t find(const LChar*, unsigned index = 0);
705     ALWAYS_INLINE size_t find(const char* s, unsigned index = 0) { return find(reinterpret_cast<const LChar*>(s), index); }
706     WTF_EXPORT_STRING_API size_t find(StringImpl*);
707     WTF_EXPORT_STRING_API size_t find(StringImpl*, unsigned index);
708     size_t findIgnoringCase(const LChar*, unsigned index = 0);
709     ALWAYS_INLINE size_t findIgnoringCase(const char* s, unsigned index = 0) { return findIgnoringCase(reinterpret_cast<const LChar*>(s), index); }
710     WTF_EXPORT_STRING_API size_t findIgnoringCase(StringImpl*, unsigned index = 0);
711     WTF_EXPORT_STRING_API size_t findIgnoringASCIICase(const StringImpl&) const;
712     WTF_EXPORT_STRING_API size_t findIgnoringASCIICase(const StringImpl&, unsigned startOffset) const;
713     WTF_EXPORT_STRING_API size_t findIgnoringASCIICase(const StringImpl*) const;
714     WTF_EXPORT_STRING_API size_t findIgnoringASCIICase(const StringImpl*, unsigned startOffset) const;
715
716     WTF_EXPORT_STRING_API size_t findNextLineStart(unsigned index = UINT_MAX);
717
718     WTF_EXPORT_STRING_API size_t reverseFind(UChar, unsigned index = UINT_MAX);
719     WTF_EXPORT_STRING_API size_t reverseFind(StringImpl*, unsigned index = UINT_MAX);
720     WTF_EXPORT_STRING_API size_t reverseFindIgnoringCase(StringImpl*, unsigned index = UINT_MAX);
721
722     WTF_EXPORT_STRING_API bool startsWith(const StringImpl*) const;
723     WTF_EXPORT_STRING_API bool startsWith(const StringImpl&) const;
724     WTF_EXPORT_STRING_API bool startsWithIgnoringASCIICase(const StringImpl*) const;
725     WTF_EXPORT_STRING_API bool startsWithIgnoringASCIICase(const StringImpl&) const;
726     bool startsWith(StringImpl* str, bool caseSensitive) { return caseSensitive ? startsWith(str) : (reverseFindIgnoringCase(str, 0) == 0); }
727     WTF_EXPORT_STRING_API bool startsWith(UChar) const;
728     WTF_EXPORT_STRING_API bool startsWith(const char*, unsigned matchLength, bool caseSensitive) const;
729     template<unsigned matchLength>
730     bool startsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const { return startsWith(prefix, matchLength - 1, caseSensitive); }
731     WTF_EXPORT_STRING_API bool hasInfixStartingAt(const StringImpl&, unsigned startOffset) const;
732
733     WTF_EXPORT_STRING_API bool endsWith(StringImpl*);
734     WTF_EXPORT_STRING_API bool endsWith(StringImpl&);
735     WTF_EXPORT_STRING_API bool endsWithIgnoringASCIICase(const StringImpl*) const;
736     WTF_EXPORT_STRING_API bool endsWithIgnoringASCIICase(const StringImpl&) const;
737     WTF_EXPORT_STRING_API bool endsWith(StringImpl*, bool caseSensitive);
738     WTF_EXPORT_STRING_API bool endsWith(UChar) const;
739     WTF_EXPORT_STRING_API bool endsWith(const char*, unsigned matchLength, bool caseSensitive) const;
740     template<unsigned matchLength>
741     bool endsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const { return endsWith(prefix, matchLength - 1, caseSensitive); }
742     WTF_EXPORT_STRING_API bool hasInfixEndingAt(const StringImpl&, unsigned endOffset) const;
743
744     WTF_EXPORT_STRING_API Ref<StringImpl> replace(UChar, UChar);
745     WTF_EXPORT_STRING_API Ref<StringImpl> replace(UChar, StringImpl*);
746     ALWAYS_INLINE Ref<StringImpl> replace(UChar pattern, const char* replacement, unsigned replacementLength) { return replace(pattern, reinterpret_cast<const LChar*>(replacement), replacementLength); }
747     WTF_EXPORT_STRING_API Ref<StringImpl> replace(UChar, const LChar*, unsigned replacementLength);
748     Ref<StringImpl> replace(UChar, const UChar*, unsigned replacementLength);
749     WTF_EXPORT_STRING_API Ref<StringImpl> replace(StringImpl*, StringImpl*);
750     WTF_EXPORT_STRING_API Ref<StringImpl> replace(unsigned index, unsigned len, StringImpl*);
751
752     WTF_EXPORT_STRING_API UCharDirection defaultWritingDirection(bool* hasStrongDirectionality = nullptr);
753
754 #if USE(CF)
755     RetainPtr<CFStringRef> createCFString();
756 #endif
757 #ifdef __OBJC__
758     WTF_EXPORT_STRING_API operator NSString *();
759 #endif
760
761 #if STRING_STATS
762     ALWAYS_INLINE static StringStats& stringStats() { return m_stringStats; }
763 #endif
764
765     WTF_EXPORT_STRING_API static const UChar latin1CaseFoldTable[256];
766
767     Ref<StringImpl> extractFoldedStringInSymbol()
768     {
769         ASSERT(isSymbol());
770         ASSERT(bufferOwnership() == BufferSubstring);
771         ASSERT(substringBuffer());
772         ASSERT(!substringBuffer()->isSymbol());
773         return createSubstringSharingImpl(this, 0, length());
774     }
775
776     SymbolRegistry* const& symbolRegistry() const
777     {
778         ASSERT(isSymbol());
779         return *(tailPointer<SymbolRegistry*>() + 1);
780     }
781
782     SymbolRegistry*& symbolRegistry()
783     {
784         ASSERT(isSymbol());
785         return *(tailPointer<SymbolRegistry*>() + 1);
786     }
787
788     const unsigned& hashForSymbol() const
789     {
790         return const_cast<StringImpl*>(this)->hashForSymbol();
791     }
792
793     unsigned& hashForSymbol()
794     {
795         ASSERT(isSymbol());
796         return *reinterpret_cast<unsigned*>((tailPointer<SymbolRegistry*>() + 2));
797     }
798
799 protected:
800     ~StringImpl();
801
802 private:
803     bool requiresCopy() const
804     {
805         if (bufferOwnership() != BufferInternal)
806             return true;
807
808         if (is8Bit())
809             return m_data8 == tailPointer<LChar>();
810         return m_data16 == tailPointer<UChar>();
811     }
812
813     template<typename T>
814     static size_t allocationSize(unsigned tailElementCount)
815     {
816         return tailOffset<T>() + tailElementCount * sizeof(T);
817     }
818
819     template<typename T>
820     static ptrdiff_t tailOffset()
821     {
822 #if COMPILER(MSVC)
823         // MSVC doesn't support alignof yet.
824         return roundUpToMultipleOf<sizeof(T)>(sizeof(StringImpl));
825 #else
826         return roundUpToMultipleOf<alignof(T)>(offsetof(StringImpl, m_hashAndFlags) + sizeof(StringImpl::m_hashAndFlags));
827 #endif
828     }
829
830     template<typename T>
831     const T* tailPointer() const
832     {
833         return reinterpret_cast_ptr<const T*>(reinterpret_cast<const uint8_t*>(this) + tailOffset<T>());
834     }
835
836     template<typename T>
837     T* tailPointer()
838     {
839         return reinterpret_cast_ptr<T*>(reinterpret_cast<uint8_t*>(this) + tailOffset<T>());
840     }
841
842     StringImpl* const& substringBuffer() const
843     {
844         ASSERT(bufferOwnership() == BufferSubstring);
845
846         return *tailPointer<StringImpl*>();
847     }
848
849     StringImpl*& substringBuffer()
850     {
851         ASSERT(bufferOwnership() == BufferSubstring);
852
853         return *tailPointer<StringImpl*>();
854     }
855
856     // This number must be at least 2 to avoid sharing empty, null as well as 1 character strings from SmallStrings.
857     static const unsigned s_copyCharsInlineCutOff = 20;
858
859     enum class CaseConvertType { Upper, Lower };
860     template<CaseConvertType type, typename CharacterType> static Ref<StringImpl> convertASCIICase(StringImpl&, const CharacterType*, unsigned);
861
862     BufferOwnership bufferOwnership() const { return static_cast<BufferOwnership>(m_hashAndFlags & s_hashMaskBufferOwnership); }
863     template <class UCharPredicate> Ref<StringImpl> stripMatchedCharacters(UCharPredicate);
864     template <typename CharType, class UCharPredicate> Ref<StringImpl> simplifyMatchedCharactersToSpace(UCharPredicate);
865     template <typename CharType> static Ref<StringImpl> constructInternal(StringImpl*, unsigned);
866     template <typename CharType> static Ref<StringImpl> createUninitializedInternal(unsigned, CharType*&);
867     template <typename CharType> static Ref<StringImpl> createUninitializedInternalNonEmpty(unsigned, CharType*&);
868     template <typename CharType> static Ref<StringImpl> reallocateInternal(PassRefPtr<StringImpl>, unsigned, CharType*&);
869     template <typename CharType> static Ref<StringImpl> createInternal(const CharType*, unsigned);
870     WTF_EXPORT_PRIVATE NEVER_INLINE unsigned hashSlowCase() const;
871     WTF_EXPORT_PRIVATE static unsigned nextHashForSymbol();
872
873     // The bottom bit in the ref count indicates a static (immortal) string.
874     static const unsigned s_refCountFlagIsStaticString = 0x1;
875     static const unsigned s_refCountIncrement = 0x2; // This allows us to ref / deref without disturbing the static string flag.
876
877 #if STRING_STATS
878     WTF_EXPORTDATA static StringStats m_stringStats;
879 #endif
880
881 public:
882     struct StaticASCIILiteral {
883         // These member variables must match the layout of StringImpl.
884         unsigned m_refCount;
885         unsigned m_length;
886         const LChar* m_data8;
887         unsigned m_hashAndFlags;
888
889         // These values mimic ConstructFromLiteral.
890         static const unsigned s_initialRefCount = s_refCountIncrement;
891         static const unsigned s_initialFlags = s_hashFlag8BitBuffer | StringNormal | BufferInternal;
892         static const unsigned s_hashShift = s_flagCount;
893     };
894
895 #ifndef NDEBUG
896     void assertHashIsCorrect()
897     {
898         ASSERT(hasHash());
899         ASSERT(existingHash() == StringHasher::computeHashAndMaskTop8Bits(characters8(), length()));
900     }
901 #endif
902
903 private:
904     // These member variables must match the layout of StaticASCIILiteral.
905     unsigned m_refCount;
906     unsigned m_length;
907     union {
908         const LChar* m_data8;
909         const UChar* m_data16;
910     };
911     mutable unsigned m_hashAndFlags;
912 };
913
914 static_assert(sizeof(StringImpl) == sizeof(StringImpl::StaticASCIILiteral), "");
915
916 #if !ASSERT_DISABLED
917 // StringImpls created from StaticASCIILiteral will ASSERT
918 // in the generic ValueCheck<T>::checkConsistency
919 // as they are not allocated by fastMalloc.
920 // We don't currently have any way to detect that case
921 // so we ignore the consistency check for all StringImpl*.
922 template<> struct
923 ValueCheck<StringImpl*> {
924     static void checkConsistency(const StringImpl*) { }
925 };
926 #endif
927
928 template <>
929 ALWAYS_INLINE Ref<StringImpl> StringImpl::constructInternal<LChar>(StringImpl* impl, unsigned length) { return adoptRef(*new (NotNull, impl) StringImpl(length, Force8BitConstructor)); }
930 template <>
931 ALWAYS_INLINE Ref<StringImpl> StringImpl::constructInternal<UChar>(StringImpl* impl, unsigned length) { return adoptRef(*new (NotNull, impl) StringImpl(length)); }
932
933 template <>
934 ALWAYS_INLINE const LChar* StringImpl::characters<LChar>() const { return characters8(); }
935
936 template <>
937 ALWAYS_INLINE const UChar* StringImpl::characters<UChar>() const { return characters16(); }
938
939 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const StringImpl*);
940 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const LChar*);
941 inline bool equal(const StringImpl* a, const char* b) { return equal(a, reinterpret_cast<const LChar*>(b)); }
942 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const LChar*, unsigned);
943 WTF_EXPORT_STRING_API bool equal(const StringImpl*, const UChar*, unsigned);
944 inline bool equal(const StringImpl* a, const char* b, unsigned length) { return equal(a, reinterpret_cast<const LChar*>(b), length); }
945 inline bool equal(const LChar* a, StringImpl* b) { return equal(b, a); }
946 inline bool equal(const char* a, StringImpl* b) { return equal(b, reinterpret_cast<const LChar*>(a)); }
947 WTF_EXPORT_STRING_API bool equal(const StringImpl& a, const StringImpl& b);
948
949 // FIXME: Deprecated. Used only by CaseFoldingHash, which itself is soon to be deprecated and removed, replaced by ASCIICaseFoldingHash.
950 WTF_EXPORT_STRING_API bool equalCompatibiltyCaselessNonNull(const StringImpl*, const StringImpl*);
951
952 WTF_EXPORT_STRING_API bool equalIgnoringNullity(StringImpl*, StringImpl*);
953 WTF_EXPORT_STRING_API bool equalIgnoringNullity(const UChar*, size_t length, StringImpl*);
954
955 bool equalIgnoringASCIICase(const StringImpl&, const StringImpl&);
956 WTF_EXPORT_STRING_API bool equalIgnoringASCIICase(const StringImpl*, const StringImpl*);
957 WTF_EXPORT_STRING_API bool equalIgnoringASCIICase(const StringImpl&, const char*);
958 WTF_EXPORT_STRING_API bool equalIgnoringASCIICase(const StringImpl*, const char*);
959
960 WTF_EXPORT_STRING_API bool equalIgnoringASCIICaseNonNull(const StringImpl*, const StringImpl*);
961
962 template<unsigned length> bool equalLettersIgnoringASCIICase(const StringImpl&, const char (&lowercaseLetters)[length]);
963 template<unsigned length> bool equalLettersIgnoringASCIICase(const StringImpl*, const char (&lowercaseLetters)[length]);
964
965 inline size_t find(const LChar* characters, unsigned length, CharacterMatchFunctionPtr matchFunction, unsigned index = 0)
966 {
967     while (index < length) {
968         if (matchFunction(characters[index]))
969             return index;
970         ++index;
971     }
972     return notFound;
973 }
974
975 inline size_t find(const UChar* characters, unsigned length, CharacterMatchFunctionPtr matchFunction, unsigned index = 0)
976 {
977     while (index < length) {
978         if (matchFunction(characters[index]))
979             return index;
980         ++index;
981     }
982     return notFound;
983 }
984
985 template<typename CharacterType>
986 inline size_t findNextLineStart(const CharacterType* characters, unsigned length, unsigned index = 0)
987 {
988     while (index < length) {
989         CharacterType c = characters[index++];
990         if ((c != '\n') && (c != '\r'))
991             continue;
992
993         // There can only be a start of a new line if there are more characters
994         // beyond the current character.
995         if (index < length) {
996             // The 3 common types of line terminators are 1. \r\n (Windows), 
997             // 2. \r (old MacOS) and 3. \n (Unix'es).
998
999             if (c == '\n')
1000                 return index; // Case 3: just \n.
1001
1002             CharacterType c2 = characters[index];
1003             if (c2 != '\n')
1004                 return index; // Case 2: just \r.
1005
1006             // Case 1: \r\n.
1007             // But, there's only a start of a new line if there are more
1008             // characters beyond the \r\n.
1009             if (++index < length)
1010                 return index; 
1011         }
1012     }
1013     return notFound;
1014 }
1015
1016 template<typename CharacterType>
1017 inline size_t reverseFindLineTerminator(const CharacterType* characters, unsigned length, unsigned index = UINT_MAX)
1018 {
1019     if (!length)
1020         return notFound;
1021     if (index >= length)
1022         index = length - 1;
1023     CharacterType c = characters[index];
1024     while ((c != '\n') && (c != '\r')) {
1025         if (!index--)
1026             return notFound;
1027         c = characters[index];
1028     }
1029     return index;
1030 }
1031
1032 template<typename CharacterType>
1033 inline size_t reverseFind(const CharacterType* characters, unsigned length, CharacterType matchCharacter, unsigned index = UINT_MAX)
1034 {
1035     if (!length)
1036         return notFound;
1037     if (index >= length)
1038         index = length - 1;
1039     while (characters[index] != matchCharacter) {
1040         if (!index--)
1041             return notFound;
1042     }
1043     return index;
1044 }
1045
1046 ALWAYS_INLINE size_t reverseFind(const UChar* characters, unsigned length, LChar matchCharacter, unsigned index = UINT_MAX)
1047 {
1048     return reverseFind(characters, length, static_cast<UChar>(matchCharacter), index);
1049 }
1050
1051 inline size_t reverseFind(const LChar* characters, unsigned length, UChar matchCharacter, unsigned index = UINT_MAX)
1052 {
1053     if (matchCharacter & ~0xFF)
1054         return notFound;
1055     return reverseFind(characters, length, static_cast<LChar>(matchCharacter), index);
1056 }
1057
1058 inline size_t StringImpl::find(LChar character, unsigned start)
1059 {
1060     if (is8Bit())
1061         return WTF::find(characters8(), m_length, character, start);
1062     return WTF::find(characters16(), m_length, character, start);
1063 }
1064
1065 ALWAYS_INLINE size_t StringImpl::find(char character, unsigned start)
1066 {
1067     return find(static_cast<LChar>(character), start);
1068 }
1069
1070 inline size_t StringImpl::find(UChar character, unsigned start)
1071 {
1072     if (is8Bit())
1073         return WTF::find(characters8(), m_length, character, start);
1074     return WTF::find(characters16(), m_length, character, start);
1075 }
1076
1077 template<size_t inlineCapacity> inline bool equalIgnoringNullity(const Vector<UChar, inlineCapacity>& a, StringImpl* b)
1078 {
1079     return equalIgnoringNullity(a.data(), a.size(), b);
1080 }
1081
1082 template<typename CharacterType1, typename CharacterType2>
1083 inline int codePointCompare(unsigned l1, unsigned l2, const CharacterType1* c1, const CharacterType2* c2)
1084 {
1085     const unsigned lmin = l1 < l2 ? l1 : l2;
1086     unsigned pos = 0;
1087     while (pos < lmin && *c1 == *c2) {
1088         ++c1;
1089         ++c2;
1090         ++pos;
1091     }
1092
1093     if (pos < lmin)
1094         return (c1[0] > c2[0]) ? 1 : -1;
1095
1096     if (l1 == l2)
1097         return 0;
1098
1099     return (l1 > l2) ? 1 : -1;
1100 }
1101
1102 inline int codePointCompare8(const StringImpl* string1, const StringImpl* string2)
1103 {
1104     return codePointCompare(string1->length(), string2->length(), string1->characters8(), string2->characters8());
1105 }
1106
1107 inline int codePointCompare16(const StringImpl* string1, const StringImpl* string2)
1108 {
1109     return codePointCompare(string1->length(), string2->length(), string1->characters16(), string2->characters16());
1110 }
1111
1112 inline int codePointCompare8To16(const StringImpl* string1, const StringImpl* string2)
1113 {
1114     return codePointCompare(string1->length(), string2->length(), string1->characters8(), string2->characters16());
1115 }
1116
1117 inline int codePointCompare(const StringImpl* string1, const StringImpl* string2)
1118 {
1119     if (!string1)
1120         return (string2 && string2->length()) ? -1 : 0;
1121
1122     if (!string2)
1123         return string1->length() ? 1 : 0;
1124
1125     bool string1Is8Bit = string1->is8Bit();
1126     bool string2Is8Bit = string2->is8Bit();
1127     if (string1Is8Bit) {
1128         if (string2Is8Bit)
1129             return codePointCompare8(string1, string2);
1130         return codePointCompare8To16(string1, string2);
1131     }
1132     if (string2Is8Bit)
1133         return -codePointCompare8To16(string2, string1);
1134     return codePointCompare16(string1, string2);
1135 }
1136
1137 inline bool isSpaceOrNewline(UChar c)
1138 {
1139     // Use isASCIISpace() for basic Latin-1.
1140     // This will include newlines, which aren't included in Unicode DirWS.
1141     return c <= 0x7F ? isASCIISpace(c) : u_charDirection(c) == U_WHITE_SPACE_NEUTRAL;
1142 }
1143
1144 template<typename CharacterType>
1145 inline unsigned lengthOfNullTerminatedString(const CharacterType* string)
1146 {
1147     ASSERT(string);
1148     size_t length = 0;
1149     while (string[length])
1150         ++length;
1151
1152     RELEASE_ASSERT(length < std::numeric_limits<unsigned>::max());
1153     return static_cast<unsigned>(length);
1154 }
1155
1156 inline Ref<StringImpl> StringImpl::isolatedCopy() const
1157 {
1158     if (!requiresCopy()) {
1159         if (is8Bit())
1160             return StringImpl::createWithoutCopying(m_data8, m_length);
1161         return StringImpl::createWithoutCopying(m_data16, m_length);
1162     }
1163
1164     if (is8Bit())
1165         return create(m_data8, m_length);
1166     return create(m_data16, m_length);
1167 }
1168
1169 // StringHash is the default hash for StringImpl* and RefPtr<StringImpl>
1170 template<typename T> struct DefaultHash;
1171 template<> struct DefaultHash<StringImpl*> {
1172     typedef StringHash Hash;
1173 };
1174 template<> struct DefaultHash<RefPtr<StringImpl>> {
1175     typedef StringHash Hash;
1176 };
1177
1178 inline bool equalIgnoringASCIICase(const StringImpl& a, const StringImpl& b)
1179 {
1180     return equalIgnoringASCIICaseCommon(a, b);
1181 }
1182
1183 inline bool equalIgnoringASCIICase(const StringImpl& a, const char* b)
1184 {
1185     return equalIgnoringASCIICaseCommon(a, b);
1186 }
1187
1188 inline bool equalIgnoringASCIICase(const StringImpl* a, const char* b)
1189 {
1190     return a && equalIgnoringASCIICase(*a, b);
1191 }
1192
1193 template<unsigned length> inline bool equalLettersIgnoringASCIICase(const StringImpl& string, const char (&lowercaseLetters)[length])
1194 {
1195     return equalLettersIgnoringASCIICaseCommon(string, lowercaseLetters);
1196 }
1197
1198 template<unsigned length> inline bool equalLettersIgnoringASCIICase(const StringImpl* string, const char (&lowercaseLetters)[length])
1199 {
1200     return string && equalLettersIgnoringASCIICase(*string, lowercaseLetters);
1201 }
1202
1203 } // namespace WTF
1204
1205 using WTF::StringImpl;
1206 using WTF::equal;
1207 using WTF::TextCaseSensitivity;
1208 using WTF::TextCaseSensitive;
1209 using WTF::TextCaseInsensitive;
1210
1211 #endif