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