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