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