blob: 2861949e5dbc43512376e91fb8c5800bb8049711 [file] [log] [blame]
/*
* Copyright (C) 1999 Lars Knoll (knoll@kde.org)
* Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
* Copyright (C) 2009 Google Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#ifndef StringImpl_h
#define StringImpl_h
#include <limits.h>
#include <wtf/ASCIICType.h>
#include <wtf/Forward.h>
#include <wtf/StdLibExtras.h>
#include <wtf/StringHasher.h>
#include <wtf/Vector.h>
#include <wtf/unicode/Unicode.h>
#if PLATFORM(QT)
#include <QString>
#endif
#if USE(CF)
typedef const struct __CFString * CFStringRef;
#endif
#ifdef __OBJC__
@class NSString;
#endif
#if PLATFORM(BLACKBERRY)
#include <BlackBerryPlatformString.h>
#endif
// FIXME: This is a temporary layering violation while we move string code to WTF.
// Landing the file moves in one patch, will follow on with patches to change the namespaces.
namespace JSC {
struct IdentifierASCIIStringTranslator;
namespace LLInt { class Data; }
class LLIntOffsetsExtractor;
template <typename T> struct IdentifierCharBufferTranslator;
struct IdentifierLCharFromUCharTranslator;
}
namespace WTF {
struct CStringTranslator;
template<typename CharacterType> struct HashAndCharactersTranslator;
struct HashAndUTF8CharactersTranslator;
struct LCharBufferTranslator;
struct CharBufferFromLiteralDataTranslator;
class MemoryObjectInfo;
struct SubstringTranslator;
struct UCharBufferTranslator;
template<typename> class RetainPtr;
enum TextCaseSensitivity { TextCaseSensitive, TextCaseInsensitive };
typedef bool (*CharacterMatchFunctionPtr)(UChar);
typedef bool (*IsWhiteSpaceFunctionPtr)(UChar);
// Define STRING_STATS to turn on run time statistics of string sizes and memory usage
#undef STRING_STATS
#ifdef STRING_STATS
struct StringStats {
inline void add8BitString(unsigned length, bool isSubString = false)
{
++m_totalNumberStrings;
++m_number8BitStrings;
if (!isSubString)
m_total8BitData += length;
}
inline void add16BitString(unsigned length, bool isSubString = false)
{
++m_totalNumberStrings;
++m_number16BitStrings;
if (!isSubString)
m_total16BitData += length;
}
inline void addUpconvertedString(unsigned length)
{
++m_numberUpconvertedStrings;
m_totalUpconvertedData += length;
}
void removeString(StringImpl*);
void printStats();
static const unsigned s_printStringStatsFrequency = 5000;
static unsigned s_stringRemovesTillPrintStats;
unsigned m_totalNumberStrings;
unsigned m_number8BitStrings;
unsigned m_number16BitStrings;
unsigned m_numberUpconvertedStrings;
unsigned long long m_total8BitData;
unsigned long long m_total16BitData;
unsigned long long m_totalUpconvertedData;
};
#define STRING_STATS_ADD_8BIT_STRING(length) StringImpl::stringStats().add8BitString(length)
#define STRING_STATS_ADD_8BIT_STRING2(length, isSubString) StringImpl::stringStats().add8BitString(length, isSubString)
#define STRING_STATS_ADD_16BIT_STRING(length) StringImpl::stringStats().add16BitString(length)
#define STRING_STATS_ADD_16BIT_STRING2(length, isSubString) StringImpl::stringStats().add16BitString(length, isSubString)
#define STRING_STATS_ADD_UPCONVERTED_STRING(length) StringImpl::stringStats().addUpconvertedString(length)
#define STRING_STATS_REMOVE_STRING(string) StringImpl::stringStats().removeString(string)
#else
#define STRING_STATS_ADD_8BIT_STRING(length) ((void)0)
#define STRING_STATS_ADD_8BIT_STRING2(length, isSubString) ((void)0)
#define STRING_STATS_ADD_16BIT_STRING(length) ((void)0)
#define STRING_STATS_ADD_16BIT_STRING2(length, isSubString) ((void)0)
#define STRING_STATS_ADD_UPCONVERTED_STRING(length) ((void)0)
#define STRING_STATS_REMOVE_STRING(string) ((void)0)
#endif
class StringImpl {
WTF_MAKE_NONCOPYABLE(StringImpl); WTF_MAKE_FAST_ALLOCATED;
friend struct JSC::IdentifierASCIIStringTranslator;
friend struct JSC::IdentifierCharBufferTranslator<LChar>;
friend struct JSC::IdentifierCharBufferTranslator<UChar>;
friend struct JSC::IdentifierLCharFromUCharTranslator;
friend struct WTF::CStringTranslator;
template<typename CharacterType> friend struct WTF::HashAndCharactersTranslator;
friend struct WTF::HashAndUTF8CharactersTranslator;
friend struct WTF::CharBufferFromLiteralDataTranslator;
friend struct WTF::LCharBufferTranslator;
friend struct WTF::SubstringTranslator;
friend struct WTF::UCharBufferTranslator;
friend class AtomicStringImpl;
friend class JSC::LLInt::Data;
friend class JSC::LLIntOffsetsExtractor;
private:
enum BufferOwnership {
BufferInternal,
BufferOwned,
BufferSubstring,
#if PLATFORM(QT)
BufferAdoptedQString
#endif
// NOTE: Adding more ownership types needs to extend m_hashAndFlags as we're at capacity
};
// Used to construct static strings, which have an special refCount that can never hit zero.
// This means that the static string will never be destroyed, which is important because
// static strings will be shared across threads & ref-counted in a non-threadsafe manner.
enum ConstructStaticStringTag { ConstructStaticString };
StringImpl(const UChar* characters, unsigned length, ConstructStaticStringTag)
: m_refCount(s_refCountFlagIsStaticString)
, m_length(length)
, m_data16(characters)
, m_buffer(0)
, m_hashAndFlags(s_hashFlagIsIdentifier | BufferOwned)
{
// Ensure that the hash is computed so that AtomicStringHash can call existingHash()
// with impunity. The empty string is special because it is never entered into
// AtomicString's HashKey, but still needs to compare correctly.
STRING_STATS_ADD_16BIT_STRING(m_length);
hash();
}
// Used to construct static strings, which have an special refCount that can never hit zero.
// This means that the static string will never be destroyed, which is important because
// static strings will be shared across threads & ref-counted in a non-threadsafe manner.
StringImpl(const LChar* characters, unsigned length, ConstructStaticStringTag)
: m_refCount(s_refCountFlagIsStaticString)
, m_length(length)
, m_data8(characters)
, m_buffer(0)
, m_hashAndFlags(s_hashFlag8BitBuffer | s_hashFlagIsIdentifier | BufferOwned)
{
// Ensure that the hash is computed so that AtomicStringHash can call existingHash()
// with impunity. The empty string is special because it is never entered into
// AtomicString's HashKey, but still needs to compare correctly.
STRING_STATS_ADD_8BIT_STRING(m_length);
hash();
}
// FIXME: there has to be a less hacky way to do this.
enum Force8Bit { Force8BitConstructor };
// Create a normal 8-bit string with internal storage (BufferInternal)
StringImpl(unsigned length, Force8Bit)
: m_refCount(s_refCountIncrement)
, m_length(length)
, m_data8(reinterpret_cast<const LChar*>(this + 1))
, m_buffer(0)
, m_hashAndFlags(s_hashFlag8BitBuffer | BufferInternal)
{
ASSERT(m_data8);
ASSERT(m_length);
STRING_STATS_ADD_8BIT_STRING(m_length);
}
// Create a normal 16-bit string with internal storage (BufferInternal)
StringImpl(unsigned length)
: m_refCount(s_refCountIncrement)
, m_length(length)
, m_data16(reinterpret_cast<const UChar*>(this + 1))
, m_buffer(0)
, m_hashAndFlags(BufferInternal)
{
ASSERT(m_data16);
ASSERT(m_length);
STRING_STATS_ADD_16BIT_STRING(m_length);
}
// Create a StringImpl adopting ownership of the provided buffer (BufferOwned)
StringImpl(const LChar* characters, unsigned length)
: m_refCount(s_refCountIncrement)
, m_length(length)
, m_data8(characters)
, m_buffer(0)
, m_hashAndFlags(s_hashFlag8BitBuffer | BufferOwned)
{
ASSERT(m_data8);
ASSERT(m_length);
STRING_STATS_ADD_8BIT_STRING(m_length);
}
enum ConstructFromLiteralTag { ConstructFromLiteral };
StringImpl(const char* characters, unsigned length, ConstructFromLiteralTag)
: m_refCount(s_refCountIncrement)
, m_length(length)
, m_data8(reinterpret_cast<const LChar*>(characters))
, m_buffer(0)
, m_hashAndFlags(s_hashFlag8BitBuffer | BufferInternal | s_hashFlagHasTerminatingNullCharacter)
{
ASSERT(m_data8);
ASSERT(m_length);
ASSERT(!characters[length]);
STRING_STATS_ADD_8BIT_STRING(0);
}
// Create a StringImpl adopting ownership of the provided buffer (BufferOwned)
StringImpl(const UChar* characters, unsigned length)
: m_refCount(s_refCountIncrement)
, m_length(length)
, m_data16(characters)
, m_buffer(0)
, m_hashAndFlags(BufferOwned)
{
ASSERT(m_data16);
ASSERT(m_length);
STRING_STATS_ADD_16BIT_STRING(m_length);
}
// Used to create new strings that are a substring of an existing 8-bit StringImpl (BufferSubstring)
StringImpl(const LChar* characters, unsigned length, PassRefPtr<StringImpl> base)
: m_refCount(s_refCountIncrement)
, m_length(length)
, m_data8(characters)
, m_substringBuffer(base.leakRef())
, m_hashAndFlags(s_hashFlag8BitBuffer | BufferSubstring)
{
ASSERT(is8Bit());
ASSERT(m_data8);
ASSERT(m_length);
ASSERT(m_substringBuffer->bufferOwnership() != BufferSubstring);
STRING_STATS_ADD_8BIT_STRING2(m_length, true);
}
// Used to create new strings that are a substring of an existing 16-bit StringImpl (BufferSubstring)
StringImpl(const UChar* characters, unsigned length, PassRefPtr<StringImpl> base)
: m_refCount(s_refCountIncrement)
, m_length(length)
, m_data16(characters)
, m_substringBuffer(base.leakRef())
, m_hashAndFlags(BufferSubstring)
{
ASSERT(!is8Bit());
ASSERT(m_data16);
ASSERT(m_length);
ASSERT(m_substringBuffer->bufferOwnership() != BufferSubstring);
STRING_STATS_ADD_16BIT_STRING2(m_length, true);
}
enum CreateEmptyUnique_T { CreateEmptyUnique };
StringImpl(CreateEmptyUnique_T)
: m_refCount(s_refCountIncrement)
, m_length(0)
, m_data16(reinterpret_cast<const UChar*>(1))
, m_buffer(0)
{
ASSERT(m_data16);
// Set the hash early, so that all empty unique StringImpls have a hash,
// and don't use the normal hashing algorithm - the unique nature of these
// keys means that we don't need them to match any other string (in fact,
// that's exactly the oposite of what we want!), and teh normal hash would
// lead to lots of conflicts.
unsigned hash = reinterpret_cast<uintptr_t>(this);
hash <<= s_flagCount;
if (!hash)
hash = 1 << s_flagCount;
m_hashAndFlags = hash | BufferInternal;
STRING_STATS_ADD_16BIT_STRING(m_length);
}
#if PLATFORM(QT)
// Used to create new strings that adopt an existing QString's data
enum ConstructAdoptedQStringTag { ConstructAdoptedQString };
StringImpl(QStringData* qStringData, ConstructAdoptedQStringTag)
: m_refCount(s_refCountIncrement)
, m_length(qStringData->size)
, m_data16(0)
, m_qStringData(qStringData)
, m_hashAndFlags(BufferAdoptedQString)
{
ASSERT(m_length);
// We ref the string-data to ensure it will be valid for the lifetime of
// this string. We then deref it in the destructor, so that the string
// data can eventually be freed.
m_qStringData->ref.ref();
// Now that we have a ref we can safely reference the string data
m_data16 = reinterpret_cast_ptr<const UChar*>(qStringData->data());
ASSERT(m_data16);
STRING_STATS_ADD_16BIT_STRING(m_length);
}
#endif
public:
WTF_EXPORT_STRING_API ~StringImpl();
WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> create(const UChar*, unsigned length);
WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> create(const LChar*, unsigned length);
WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> create8BitIfPossible(const UChar*, unsigned length);
ALWAYS_INLINE static PassRefPtr<StringImpl> create(const char* s, unsigned length) { return create(reinterpret_cast<const LChar*>(s), length); }
WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> create(const LChar*);
ALWAYS_INLINE static PassRefPtr<StringImpl> create(const char* s) { return create(reinterpret_cast<const LChar*>(s)); }
static ALWAYS_INLINE PassRefPtr<StringImpl> create8(PassRefPtr<StringImpl> rep, unsigned offset, unsigned length)
{
ASSERT(rep);
ASSERT(length <= rep->length());
if (!length)
return empty();
ASSERT(rep->is8Bit());
StringImpl* ownerRep = (rep->bufferOwnership() == BufferSubstring) ? rep->m_substringBuffer : rep.get();
return adoptRef(new StringImpl(rep->m_data8 + offset, length, ownerRep));
}
static ALWAYS_INLINE PassRefPtr<StringImpl> create(PassRefPtr<StringImpl> rep, unsigned offset, unsigned length)
{
ASSERT(rep);
ASSERT(length <= rep->length());
if (!length)
return empty();
StringImpl* ownerRep = (rep->bufferOwnership() == BufferSubstring) ? rep->m_substringBuffer : rep.get();
if (rep->is8Bit())
return adoptRef(new StringImpl(rep->m_data8 + offset, length, ownerRep));
return adoptRef(new StringImpl(rep->m_data16 + offset, length, ownerRep));
}
WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> createFromLiteral(const char* characters, unsigned length);
template<unsigned charactersCount>
ALWAYS_INLINE static PassRefPtr<StringImpl> createFromLiteral(const char (&characters)[charactersCount])
{
COMPILE_ASSERT(charactersCount > 1, StringImplFromLiteralNotEmpty);
COMPILE_ASSERT((charactersCount - 1 <= ((unsigned(~0) - sizeof(StringImpl)) / sizeof(LChar))), StringImplFromLiteralCannotOverflow);
return createFromLiteral(characters, charactersCount - 1);
}
WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> createFromLiteral(const char* characters);
WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> createUninitialized(unsigned length, LChar*& data);
WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> createUninitialized(unsigned length, UChar*& data);
template <typename T> static ALWAYS_INLINE PassRefPtr<StringImpl> tryCreateUninitialized(unsigned length, T*& output)
{
if (!length) {
output = 0;
return empty();
}
if (length > ((std::numeric_limits<unsigned>::max() - sizeof(StringImpl)) / sizeof(T))) {
output = 0;
return 0;
}
StringImpl* resultImpl;
if (!tryFastMalloc(sizeof(T) * length + sizeof(StringImpl)).getValue(resultImpl)) {
output = 0;
return 0;
}
output = reinterpret_cast<T*>(resultImpl + 1);
if (sizeof(T) == sizeof(char))
return adoptRef(new (NotNull, resultImpl) StringImpl(length, Force8BitConstructor));
return adoptRef(new (NotNull, resultImpl) StringImpl(length));
}
static PassRefPtr<StringImpl> createEmptyUnique()
{
return adoptRef(new StringImpl(CreateEmptyUnique));
}
// Reallocate the StringImpl. The originalString must be only owned by the PassRefPtr,
// and the buffer ownership must be BufferInternal. Just like the input pointer of realloc(),
// the originalString can't be used after this function.
static PassRefPtr<StringImpl> reallocate(PassRefPtr<StringImpl> originalString, unsigned length, LChar*& data);
static PassRefPtr<StringImpl> reallocate(PassRefPtr<StringImpl> originalString, unsigned length, UChar*& data);
static unsigned flagsOffset() { return OBJECT_OFFSETOF(StringImpl, m_hashAndFlags); }
static unsigned flagIs8Bit() { return s_hashFlag8BitBuffer; }
static unsigned dataOffset() { return OBJECT_OFFSETOF(StringImpl, m_data8); }
static PassRefPtr<StringImpl> createWithTerminatingNullCharacter(const StringImpl&);
template<typename CharType, size_t inlineCapacity>
static PassRefPtr<StringImpl> adopt(Vector<CharType, inlineCapacity>& vector)
{
if (size_t size = vector.size()) {
ASSERT(vector.data());
if (size > std::numeric_limits<unsigned>::max())
CRASH();
return adoptRef(new StringImpl(vector.releaseBuffer(), size));
}
return empty();
}
WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> adopt(StringBuffer<UChar>&);
WTF_EXPORT_STRING_API static PassRefPtr<StringImpl> adopt(StringBuffer<LChar>&);
#if PLATFORM(QT)
static PassRefPtr<StringImpl> adopt(QStringData*);
#endif
unsigned length() const { return m_length; }
bool is8Bit() const { return m_hashAndFlags & s_hashFlag8BitBuffer; }
bool hasInternalBuffer() const { return bufferOwnership() == BufferInternal; }
bool hasOwnedBuffer() const { return bufferOwnership() == BufferOwned; }
StringImpl* baseString() const { return bufferOwnership() == BufferSubstring ? m_substringBuffer : 0; }
// FIXME: Remove all unnecessary usages of characters()
ALWAYS_INLINE const LChar* characters8() const { ASSERT(is8Bit()); return m_data8; }
ALWAYS_INLINE const UChar* characters16() const { ASSERT(!is8Bit()); return m_data16; }
ALWAYS_INLINE const UChar* characters() const
{
if (!is8Bit())
return m_data16;
return getData16SlowCase();
}
template <typename CharType>
ALWAYS_INLINE const CharType * getCharacters() const;
size_t cost()
{
// For substrings, return the cost of the base string.
if (bufferOwnership() == BufferSubstring)
return m_substringBuffer->cost();
if (m_hashAndFlags & s_hashFlagDidReportCost)
return 0;
m_hashAndFlags |= s_hashFlagDidReportCost;
return m_length;
}
WTF_EXPORT_STRING_API size_t sizeInBytes() const;
bool has16BitShadow() const { return m_hashAndFlags & s_hashFlagHas16BitShadow; }
WTF_EXPORT_STRING_API void upconvertCharacters(unsigned, unsigned) const;
bool isIdentifier() const { return m_hashAndFlags & s_hashFlagIsIdentifier; }
void setIsIdentifier(bool isIdentifier)
{
ASSERT(!isStatic());
if (isIdentifier)
m_hashAndFlags |= s_hashFlagIsIdentifier;
else
m_hashAndFlags &= ~s_hashFlagIsIdentifier;
}
bool isEmptyUnique() const
{
return !length() && !isStatic();
}
bool hasTerminatingNullCharacter() const { return m_hashAndFlags & s_hashFlagHasTerminatingNullCharacter; }
bool isAtomic() const { return m_hashAndFlags & s_hashFlagIsAtomic; }
void setIsAtomic(bool isIdentifier)
{
ASSERT(!isStatic());
if (isIdentifier)
m_hashAndFlags |= s_hashFlagIsAtomic;
else
m_hashAndFlags &= ~s_hashFlagIsAtomic;
}
#ifdef STRING_STATS
bool isSubString() const { return bufferOwnership() == BufferSubstring; }
#endif
#if PLATFORM(QT)
QStringData* qStringData() { return bufferOwnership() == BufferAdoptedQString ? m_qStringData : 0; }
#endif
private:
// The high bits of 'hash' are always empty, but we prefer to store our flags
// in the low bits because it makes them slightly more efficient to access.
// So, we shift left and right when setting and getting our hash code.
void setHash(unsigned hash) const
{
ASSERT(!hasHash());
// Multiple clients assume that StringHasher is the canonical string hash function.
ASSERT(hash == (is8Bit() ? StringHasher::computeHashAndMaskTop8Bits(m_data8, m_length) : StringHasher::computeHashAndMaskTop8Bits(m_data16, m_length)));
ASSERT(!(hash & (s_flagMask << (8 * sizeof(hash) - s_flagCount)))); // Verify that enough high bits are empty.
hash <<= s_flagCount;
ASSERT(!(hash & m_hashAndFlags)); // Verify that enough low bits are empty after shift.
ASSERT(hash); // Verify that 0 is a valid sentinel hash value.
m_hashAndFlags |= hash; // Store hash with flags in low bits.
}
unsigned rawHash() const
{
return m_hashAndFlags >> s_flagCount;
}
public:
bool hasHash() const
{
return rawHash() != 0;
}
unsigned existingHash() const
{
ASSERT(hasHash());
return rawHash();
}
unsigned hash() const
{
if (hasHash())
return existingHash();
return hashSlowCase();
}
inline bool hasOneRef() const
{
return m_refCount == s_refCountIncrement;
}
inline void ref()
{
m_refCount += s_refCountIncrement;
}
inline void deref()
{
if (m_refCount == s_refCountIncrement) {
delete this;
return;
}
m_refCount -= s_refCountIncrement;
}
WTF_EXPORT_PRIVATE static StringImpl* empty();
// FIXME: Does this really belong in StringImpl?
template <typename T> static void copyChars(T* destination, const T* source, unsigned numCharacters)
{
if (numCharacters == 1) {
*destination = *source;
return;
}
if (numCharacters <= s_copyCharsInlineCutOff) {
unsigned i = 0;
#if (CPU(X86) || CPU(X86_64))
const unsigned charsPerInt = sizeof(uint32_t) / sizeof(T);
if (numCharacters > charsPerInt) {
unsigned stopCount = numCharacters & ~(charsPerInt - 1);
const uint32_t* srcCharacters = reinterpret_cast<const uint32_t*>(source);
uint32_t* destCharacters = reinterpret_cast<uint32_t*>(destination);
for (unsigned j = 0; i < stopCount; i += charsPerInt, ++j)
destCharacters[j] = srcCharacters[j];
}
#endif
for (; i < numCharacters; ++i)
destination[i] = source[i];
} else
memcpy(destination, source, numCharacters * sizeof(T));
}
ALWAYS_INLINE static void copyChars(UChar* destination, const LChar* source, unsigned numCharacters)
{
for (unsigned i = 0; i < numCharacters; ++i)
destination[i] = source[i];
}
// Some string features, like refcounting and the atomicity flag, are not
// thread-safe. We achieve thread safety by isolation, giving each thread
// its own copy of the string.
PassRefPtr<StringImpl> isolatedCopy() const;
WTF_EXPORT_STRING_API PassRefPtr<StringImpl> substring(unsigned pos, unsigned len = UINT_MAX);
UChar operator[](unsigned i) const
{
ASSERT(i < m_length);
if (is8Bit())
return m_data8[i];
return m_data16[i];
}
WTF_EXPORT_STRING_API UChar32 characterStartingAt(unsigned);
WTF_EXPORT_STRING_API bool containsOnlyWhitespace();
int toIntStrict(bool* ok = 0, int base = 10);
unsigned toUIntStrict(bool* ok = 0, int base = 10);
int64_t toInt64Strict(bool* ok = 0, int base = 10);
uint64_t toUInt64Strict(bool* ok = 0, int base = 10);
intptr_t toIntPtrStrict(bool* ok = 0, int base = 10);
WTF_EXPORT_STRING_API int toInt(bool* ok = 0); // ignores trailing garbage
unsigned toUInt(bool* ok = 0); // ignores trailing garbage
int64_t toInt64(bool* ok = 0); // ignores trailing garbage
uint64_t toUInt64(bool* ok = 0); // ignores trailing garbage
intptr_t toIntPtr(bool* ok = 0); // ignores trailing garbage
// FIXME: Like the strict functions above, these give false for "ok" when there is trailing garbage.
// Like the non-strict functions above, these return the value when there is trailing garbage.
// It would be better if these were more consistent with the above functions instead.
double toDouble(bool* ok = 0);
float toFloat(bool* ok = 0);
WTF_EXPORT_STRING_API PassRefPtr<StringImpl> lower();
WTF_EXPORT_STRING_API PassRefPtr<StringImpl> upper();
WTF_EXPORT_STRING_API PassRefPtr<StringImpl> fill(UChar);
// FIXME: Do we need fill(char) or can we just do the right thing if UChar is ASCII?
PassRefPtr<StringImpl> foldCase();
PassRefPtr<StringImpl> stripWhiteSpace();
PassRefPtr<StringImpl> stripWhiteSpace(IsWhiteSpaceFunctionPtr);
WTF_EXPORT_STRING_API PassRefPtr<StringImpl> simplifyWhiteSpace();
PassRefPtr<StringImpl> simplifyWhiteSpace(IsWhiteSpaceFunctionPtr);
PassRefPtr<StringImpl> removeCharacters(CharacterMatchFunctionPtr);
template <typename CharType>
ALWAYS_INLINE PassRefPtr<StringImpl> removeCharacters(const CharType* characters, CharacterMatchFunctionPtr);
size_t find(LChar character, unsigned start = 0);
size_t find(char character, unsigned start = 0);
size_t find(UChar character, unsigned start = 0);
WTF_EXPORT_STRING_API size_t find(CharacterMatchFunctionPtr, unsigned index = 0);
size_t find(const LChar*, unsigned index = 0);
ALWAYS_INLINE size_t find(const char* s, unsigned index = 0) { return find(reinterpret_cast<const LChar*>(s), index); };
WTF_EXPORT_STRING_API size_t find(StringImpl*);
WTF_EXPORT_STRING_API size_t find(StringImpl*, unsigned index);
size_t findIgnoringCase(const LChar*, unsigned index = 0);
ALWAYS_INLINE size_t findIgnoringCase(const char* s, unsigned index = 0) { return findIgnoringCase(reinterpret_cast<const LChar*>(s), index); };
WTF_EXPORT_STRING_API size_t findIgnoringCase(StringImpl*, unsigned index = 0);
WTF_EXPORT_STRING_API size_t reverseFind(UChar, unsigned index = UINT_MAX);
WTF_EXPORT_STRING_API size_t reverseFind(StringImpl*, unsigned index = UINT_MAX);
WTF_EXPORT_STRING_API size_t reverseFindIgnoringCase(StringImpl*, unsigned index = UINT_MAX);
bool startsWith(StringImpl* str, bool caseSensitive = true) { return (caseSensitive ? reverseFind(str, 0) : reverseFindIgnoringCase(str, 0)) == 0; }
WTF_EXPORT_STRING_API bool startsWith(UChar) const;
WTF_EXPORT_STRING_API bool startsWith(const char*, unsigned matchLength, bool caseSensitive) const;
template<unsigned matchLength>
bool startsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const { return startsWith(prefix, matchLength - 1, caseSensitive); };
WTF_EXPORT_STRING_API bool endsWith(StringImpl*, bool caseSensitive = true);
WTF_EXPORT_STRING_API bool endsWith(UChar) const;
WTF_EXPORT_STRING_API bool endsWith(const char*, unsigned matchLength, bool caseSensitive) const;
template<unsigned matchLength>
bool endsWith(const char (&prefix)[matchLength], bool caseSensitive = true) const { return endsWith(prefix, matchLength - 1, caseSensitive); }
WTF_EXPORT_STRING_API PassRefPtr<StringImpl> replace(UChar, UChar);
WTF_EXPORT_STRING_API PassRefPtr<StringImpl> replace(UChar, StringImpl*);
ALWAYS_INLINE PassRefPtr<StringImpl> replace(UChar pattern, const char* replacement, unsigned replacementLength) { return replace(pattern, reinterpret_cast<const LChar*>(replacement), replacementLength); }
WTF_EXPORT_STRING_API PassRefPtr<StringImpl> replace(UChar, const LChar*, unsigned replacementLength);
PassRefPtr<StringImpl> replace(UChar, const UChar*, unsigned replacementLength);
WTF_EXPORT_STRING_API PassRefPtr<StringImpl> replace(StringImpl*, StringImpl*);
WTF_EXPORT_STRING_API PassRefPtr<StringImpl> replace(unsigned index, unsigned len, StringImpl*);
WTF_EXPORT_STRING_API WTF::Unicode::Direction defaultWritingDirection(bool* hasStrongDirectionality = 0);
#if USE(CF)
RetainPtr<CFStringRef> createCFString();
#endif
#ifdef __OBJC__
operator NSString*();
#endif
#ifdef STRING_STATS
ALWAYS_INLINE static StringStats& stringStats() { return m_stringStats; }
#endif
private:
// This number must be at least 2 to avoid sharing empty, null as well as 1 character strings from SmallStrings.
static const unsigned s_copyCharsInlineCutOff = 20;
BufferOwnership bufferOwnership() const { return static_cast<BufferOwnership>(m_hashAndFlags & s_hashMaskBufferOwnership); }
bool isStatic() const { return m_refCount & s_refCountFlagIsStaticString; }
template <class UCharPredicate> PassRefPtr<StringImpl> stripMatchedCharacters(UCharPredicate);
template <typename CharType, class UCharPredicate> PassRefPtr<StringImpl> simplifyMatchedCharactersToSpace(UCharPredicate);
WTF_EXPORT_STRING_API NEVER_INLINE const UChar* getData16SlowCase() const;
WTF_EXPORT_PRIVATE NEVER_INLINE unsigned hashSlowCase() const;
// The bottom bit in the ref count indicates a static (immortal) string.
static const unsigned s_refCountFlagIsStaticString = 0x1;
static const unsigned s_refCountIncrement = 0x2; // This allows us to ref / deref without disturbing the static string flag.
// The bottom 8 bits in the hash are flags.
static const unsigned s_flagCount = 8;
static const unsigned s_flagMask = (1u << s_flagCount) - 1;
COMPILE_ASSERT(s_flagCount == StringHasher::flagCount, StringHasher_reserves_enough_bits_for_StringImpl_flags);
static const unsigned s_hashFlagHas16BitShadow = 1u << 7;
static const unsigned s_hashFlag8BitBuffer = 1u << 6;
static const unsigned s_hashFlagHasTerminatingNullCharacter = 1u << 5;
static const unsigned s_hashFlagIsAtomic = 1u << 4;
static const unsigned s_hashFlagDidReportCost = 1u << 3;
static const unsigned s_hashFlagIsIdentifier = 1u << 2;
static const unsigned s_hashMaskBufferOwnership = 1u | (1u << 1);
#ifdef STRING_STATS
WTF_EXPORTDATA static StringStats m_stringStats;
#endif
unsigned m_refCount;
unsigned m_length;
union {
const LChar* m_data8;
const UChar* m_data16;
};
union {
void* m_buffer;
StringImpl* m_substringBuffer;
mutable UChar* m_copyData16;
#if PLATFORM(QT)
QStringData* m_qStringData;
#endif
};
mutable unsigned m_hashAndFlags;
};
template <>
ALWAYS_INLINE const LChar* StringImpl::getCharacters<LChar>() const { return characters8(); }
template <>
ALWAYS_INLINE const UChar* StringImpl::getCharacters<UChar>() const { return characters(); }
WTF_EXPORT_STRING_API bool equal(const StringImpl*, const StringImpl*);
WTF_EXPORT_STRING_API bool equal(const StringImpl*, const LChar*);
inline bool equal(const StringImpl* a, const char* b) { return equal(a, reinterpret_cast<const LChar*>(b)); }
WTF_EXPORT_STRING_API bool equal(const StringImpl*, const LChar*, unsigned);
inline bool equal(const StringImpl* a, const char* b, unsigned length) { return equal(a, reinterpret_cast<const LChar*>(b), length); }
inline bool equal(const LChar* a, StringImpl* b) { return equal(b, a); }
inline bool equal(const char* a, StringImpl* b) { return equal(b, reinterpret_cast<const LChar*>(a)); }
WTF_EXPORT_STRING_API bool equal(const StringImpl*, const UChar*, unsigned);
// Do comparisons 8 or 4 bytes-at-a-time on architectures where it's safe.
#if CPU(X86_64)
ALWAYS_INLINE bool equal(const LChar* a, const LChar* b, unsigned length)
{
unsigned dwordLength = length >> 3;
if (dwordLength) {
const uint64_t* aDWordCharacters = reinterpret_cast<const uint64_t*>(a);
const uint64_t* bDWordCharacters = reinterpret_cast<const uint64_t*>(b);
for (unsigned i = 0; i != dwordLength; ++i) {
if (*aDWordCharacters++ != *bDWordCharacters++)
return false;
}
a = reinterpret_cast<const LChar*>(aDWordCharacters);
b = reinterpret_cast<const LChar*>(bDWordCharacters);
}
if (length & 4) {
if (*reinterpret_cast<const uint32_t*>(a) != *reinterpret_cast<const uint32_t*>(b))
return false;
a += 4;
b += 4;
}
if (length & 2) {
if (*reinterpret_cast<const uint16_t*>(a) != *reinterpret_cast<const uint16_t*>(b))
return false;
a += 2;
b += 2;
}
if (length & 1 && (*a != *b))
return false;
return true;
}
ALWAYS_INLINE bool equal(const UChar* a, const UChar* b, unsigned length)
{
unsigned dwordLength = length >> 2;
if (dwordLength) {
const uint64_t* aDWordCharacters = reinterpret_cast<const uint64_t*>(a);
const uint64_t* bDWordCharacters = reinterpret_cast<const uint64_t*>(b);
for (unsigned i = 0; i != dwordLength; ++i) {
if (*aDWordCharacters++ != *bDWordCharacters++)
return false;
}
a = reinterpret_cast<const UChar*>(aDWordCharacters);
b = reinterpret_cast<const UChar*>(bDWordCharacters);
}
if (length & 2) {
if (*reinterpret_cast<const uint32_t*>(a) != *reinterpret_cast<const uint32_t*>(b))
return false;
a += 2;
b += 2;
}
if (length & 1 && (*a != *b))
return false;
return true;
}
#elif CPU(X86)
ALWAYS_INLINE bool equal(const LChar* a, const LChar* b, unsigned length)
{
const uint32_t* aCharacters = reinterpret_cast<const uint32_t*>(a);
const uint32_t* bCharacters = reinterpret_cast<const uint32_t*>(b);
unsigned wordLength = length >> 2;
for (unsigned i = 0; i != wordLength; ++i) {
if (*aCharacters++ != *bCharacters++)
return false;
}
length &= 3;
if (length) {
const LChar* aRemainder = reinterpret_cast<const LChar*>(aCharacters);
const LChar* bRemainder = reinterpret_cast<const LChar*>(bCharacters);
for (unsigned i = 0; i < length; ++i) {
if (aRemainder[i] != bRemainder[i])
return false;
}
}
return true;
}
ALWAYS_INLINE bool equal(const UChar* a, const UChar* b, unsigned length)
{
const uint32_t* aCharacters = reinterpret_cast<const uint32_t*>(a);
const uint32_t* bCharacters = reinterpret_cast<const uint32_t*>(b);
unsigned wordLength = length >> 1;
for (unsigned i = 0; i != wordLength; ++i) {
if (*aCharacters++ != *bCharacters++)
return false;
}
if (length & 1 && *reinterpret_cast<const UChar*>(aCharacters) != *reinterpret_cast<const UChar*>(bCharacters))
return false;
return true;
}
#else
ALWAYS_INLINE bool equal(const LChar* a, const LChar* b, unsigned length)
{
for (unsigned i = 0; i != length; ++i) {
if (a[i] != b[i])
return false;
}
return true;
}
ALWAYS_INLINE bool equal(const UChar* a, const UChar* b, unsigned length)
{
for (unsigned i = 0; i != length; ++i) {
if (a[i] != b[i])
return false;
}
return true;
}
#endif
ALWAYS_INLINE bool equal(const LChar* a, const UChar* b, unsigned length)
{
for (unsigned i = 0; i != length; ++i) {
if (a[i] != b[i])
return false;
}
return true;
}
ALWAYS_INLINE bool equal(const UChar* a, const LChar* b, unsigned length)
{
for (unsigned i = 0; i != length; ++i) {
if (a[i] != b[i])
return false;
}
return true;
}
WTF_EXPORT_STRING_API bool equalIgnoringCase(StringImpl*, StringImpl*);
WTF_EXPORT_STRING_API bool equalIgnoringCase(StringImpl*, const LChar*);
inline bool equalIgnoringCase(const LChar* a, StringImpl* b) { return equalIgnoringCase(b, a); }
WTF_EXPORT_STRING_API bool equalIgnoringCase(const LChar*, const LChar*, unsigned);
WTF_EXPORT_STRING_API bool equalIgnoringCase(const UChar*, const LChar*, unsigned);
inline bool equalIgnoringCase(const UChar* a, const char* b, unsigned length) { return equalIgnoringCase(a, reinterpret_cast<const LChar*>(b), length); }
inline bool equalIgnoringCase(const LChar* a, const UChar* b, unsigned length) { return equalIgnoringCase(b, a, length); }
inline bool equalIgnoringCase(const char* a, const UChar* b, unsigned length) { return equalIgnoringCase(b, reinterpret_cast<const LChar*>(a), length); }
inline bool equalIgnoringCase(const char* a, const LChar* b, unsigned length) { return equalIgnoringCase(b, reinterpret_cast<const LChar*>(a), length); }
inline bool equalIgnoringCase(const UChar* a, const UChar* b, int length)
{
ASSERT(length >= 0);
return !Unicode::umemcasecmp(a, b, length);
}
WTF_EXPORT_STRING_API bool equalIgnoringNullity(StringImpl*, StringImpl*);
template<typename CharacterType>
inline size_t find(const CharacterType* characters, unsigned length, CharacterType matchCharacter, unsigned index = 0)
{
while (index < length) {
if (characters[index] == matchCharacter)
return index;
++index;
}
return notFound;
}
ALWAYS_INLINE size_t find(const UChar* characters, unsigned length, LChar matchCharacter, unsigned index = 0)
{
return find(characters, length, static_cast<UChar>(matchCharacter), index);
}
inline size_t find(const LChar* characters, unsigned length, UChar matchCharacter, unsigned index = 0)
{
if (matchCharacter & ~0xFF)
return notFound;
return find(characters, length, static_cast<LChar>(matchCharacter), index);
}
inline size_t find(const LChar* characters, unsigned length, CharacterMatchFunctionPtr matchFunction, unsigned index = 0)
{
while (index < length) {
if (matchFunction(characters[index]))
return index;
++index;
}
return notFound;
}
inline size_t find(const UChar* characters, unsigned length, CharacterMatchFunctionPtr matchFunction, unsigned index = 0)
{
while (index < length) {
if (matchFunction(characters[index]))
return index;
++index;
}
return notFound;
}
template <typename CharacterType>
inline size_t reverseFind(const CharacterType* characters, unsigned length, CharacterType matchCharacter, unsigned index = UINT_MAX)
{
if (!length)
return notFound;
if (index >= length)
index = length - 1;
while (characters[index] != matchCharacter) {
if (!index--)
return notFound;
}
return index;
}
ALWAYS_INLINE size_t reverseFind(const UChar* characters, unsigned length, LChar matchCharacter, unsigned index = UINT_MAX)
{
return reverseFind(characters, length, static_cast<UChar>(matchCharacter), index);
}
inline size_t reverseFind(const LChar* characters, unsigned length, UChar matchCharacter, unsigned index = UINT_MAX)
{
if (matchCharacter & ~0xFF)
return notFound;
return reverseFind(characters, length, static_cast<LChar>(matchCharacter), index);
}
inline size_t StringImpl::find(LChar character, unsigned start)
{
if (is8Bit())
return WTF::find(characters8(), m_length, character, start);
return WTF::find(characters16(), m_length, character, start);
}
ALWAYS_INLINE size_t StringImpl::find(char character, unsigned start)
{
return find(static_cast<LChar>(character), start);
}
inline size_t StringImpl::find(UChar character, unsigned start)
{
if (is8Bit())
return WTF::find(characters8(), m_length, character, start);
return WTF::find(characters16(), m_length, character, start);
}
template<size_t inlineCapacity>
bool equalIgnoringNullity(const Vector<UChar, inlineCapacity>& a, StringImpl* b)
{
if (!b)
return !a.size();
if (a.size() != b->length())
return false;
return !memcmp(a.data(), b->characters(), b->length() * sizeof(UChar));
}
template<typename CharacterType1, typename CharacterType2>
static inline int codePointCompare(unsigned l1, unsigned l2, const CharacterType1* c1, const CharacterType2* c2)
{
const unsigned lmin = l1 < l2 ? l1 : l2;
unsigned pos = 0;
while (pos < lmin && *c1 == *c2) {
++c1;
++c2;
++pos;
}
if (pos < lmin)
return (c1[0] > c2[0]) ? 1 : -1;
if (l1 == l2)
return 0;
return (l1 > l2) ? 1 : -1;
}
static inline int codePointCompare8(const StringImpl* string1, const StringImpl* string2)
{
return codePointCompare(string1->length(), string2->length(), string1->characters8(), string2->characters8());
}
static inline int codePointCompare16(const StringImpl* string1, const StringImpl* string2)
{
return codePointCompare(string1->length(), string2->length(), string1->characters16(), string2->characters16());
}
static inline int codePointCompare8To16(const StringImpl* string1, const StringImpl* string2)
{
return codePointCompare(string1->length(), string2->length(), string1->characters8(), string2->characters16());
}
static inline int codePointCompare(const StringImpl* string1, const StringImpl* string2)
{
if (!string1)
return (string2 && string2->length()) ? -1 : 0;
if (!string2)
return string1->length() ? 1 : 0;
bool string1Is8Bit = string1->is8Bit();
bool string2Is8Bit = string2->is8Bit();
if (string1Is8Bit) {
if (string2Is8Bit)
return codePointCompare8(string1, string2);
return codePointCompare8To16(string1, string2);
}
if (string2Is8Bit)
return -codePointCompare8To16(string2, string1);
return codePointCompare16(string1, string2);
}
static inline bool isSpaceOrNewline(UChar c)
{
// Use isASCIISpace() for basic Latin-1.
// This will include newlines, which aren't included in Unicode DirWS.
return c <= 0x7F ? WTF::isASCIISpace(c) : WTF::Unicode::direction(c) == WTF::Unicode::WhiteSpaceNeutral;
}
inline PassRefPtr<StringImpl> StringImpl::isolatedCopy() const
{
if (is8Bit())
return create(m_data8, m_length);
return create(m_data16, m_length);
}
struct StringHash;
// StringHash is the default hash for StringImpl* and RefPtr<StringImpl>
template<typename T> struct DefaultHash;
template<> struct DefaultHash<StringImpl*> {
typedef StringHash Hash;
};
template<> struct DefaultHash<RefPtr<StringImpl> > {
typedef StringHash Hash;
};
}
using WTF::StringImpl;
using WTF::equal;
using WTF::TextCaseSensitivity;
using WTF::TextCaseSensitive;
using WTF::TextCaseInsensitive;
#endif