flutter_flutter/sky/engine/wtf/text/AtomicString.h

/*
 * Copyright (C) 2004, 2005, 2006, 2008 Apple 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 SKY_ENGINE_WTF_TEXT_ATOMICSTRING_H_
#define SKY_ENGINE_WTF_TEXT_ATOMICSTRING_H_

#include "flutter/sky/engine/wtf/HashTableDeletedValueType.h"
#include "flutter/sky/engine/wtf/WTFExport.h"
#include "flutter/sky/engine/wtf/text/CString.h"
#include "flutter/sky/engine/wtf/text/WTFString.h"

namespace WTF {

struct AtomicStringHash;

class WTF_EXPORT AtomicString {
 public:
  static void init();

  AtomicString() {}
  AtomicString(const LChar* s) : m_string(add(s)) {}
  AtomicString(const char* s) : m_string(add(s)) {}
  AtomicString(const LChar* s, unsigned length) : m_string(add(s, length)) {}
  AtomicString(const UChar* s, unsigned length) : m_string(add(s, length)) {}
  AtomicString(const UChar* s, unsigned length, unsigned existingHash)
      : m_string(add(s, length, existingHash)) {}
  AtomicString(const UChar* s) : m_string(add(s)) {}

  template <size_t inlineCapacity>
  explicit AtomicString(const Vector<UChar, inlineCapacity>& characters)
      : m_string(add(characters.data(), characters.size())) {}

  // Constructing an AtomicString from a String / StringImpl can be expensive if
  // the StringImpl is not already atomic.
  explicit AtomicString(StringImpl* impl) : m_string(add(impl)) {}
  AtomicString(const String& s) : m_string(add(s.impl())) {}

  AtomicString(StringImpl* baseString, unsigned start, unsigned length)
      : m_string(add(baseString, start, length)) {}

  enum ConstructFromLiteralTag { ConstructFromLiteral };
  AtomicString(const char* characters, unsigned length, ConstructFromLiteralTag)
      : m_string(addFromLiteralData(characters, length)) {}

  template <unsigned charactersCount>
  ALWAYS_INLINE AtomicString(const char (&characters)[charactersCount],
                             ConstructFromLiteralTag)
      : m_string(addFromLiteralData(characters, charactersCount - 1)) {
    COMPILE_ASSERT(charactersCount > 1, AtomicStringFromLiteralNotEmpty);
    COMPILE_ASSERT((charactersCount - 1 <=
                    ((unsigned(~0) - sizeof(StringImpl)) / sizeof(LChar))),
                   AtomicStringFromLiteralCannotOverflow);
  }

  // Hash table deleted values, which are only constructed and never copied or
  // destroyed.
  AtomicString(WTF::HashTableDeletedValueType)
      : m_string(WTF::HashTableDeletedValue) {}
  bool isHashTableDeletedValue() const {
    return m_string.isHashTableDeletedValue();
  }

  static StringImpl* find(const StringImpl*);

  operator const String&() const { return m_string; }
  const String& string() const { return m_string; };

  StringImpl* impl() const { return m_string.impl(); }

  bool is8Bit() const { return m_string.is8Bit(); }
  const LChar* characters8() const { return m_string.characters8(); }
  const UChar* characters16() const { return m_string.characters16(); }
  unsigned length() const { return m_string.length(); }

  UChar operator[](unsigned i) const { return m_string[i]; }

  bool contains(UChar c) const { return m_string.contains(c); }
  bool contains(const LChar* s, bool caseSensitive = true) const {
    return m_string.contains(s, caseSensitive);
  }
  bool contains(const String& s, bool caseSensitive = true) const {
    return m_string.contains(s, caseSensitive);
  }

  size_t find(UChar c, size_t start = 0) const {
    return m_string.find(c, start);
  }
  size_t find(const LChar* s,
              size_t start = 0,
              bool caseSentitive = true) const {
    return m_string.find(s, start, caseSentitive);
  }
  size_t find(const String& s,
              size_t start = 0,
              bool caseSentitive = true) const {
    return m_string.find(s, start, caseSentitive);
  }

  bool startsWith(const String& s, bool caseSensitive = true) const {
    return m_string.startsWith(s, caseSensitive);
  }
  bool startsWith(UChar character) const {
    return m_string.startsWith(character);
  }
  template <unsigned matchLength>
  bool startsWith(const char (&prefix)[matchLength],
                  bool caseSensitive = true) const {
    return m_string.startsWith<matchLength>(prefix, caseSensitive);
  }

  bool endsWith(const String& s, bool caseSensitive = true) const {
    return m_string.endsWith(s, caseSensitive);
  }
  bool endsWith(UChar character) const { return m_string.endsWith(character); }
  template <unsigned matchLength>
  bool endsWith(const char (&prefix)[matchLength],
                bool caseSensitive = true) const {
    return m_string.endsWith<matchLength>(prefix, caseSensitive);
  }

  AtomicString lower() const;
  AtomicString upper() const { return AtomicString(impl()->upper()); }

  int toInt(bool* ok = 0) const { return m_string.toInt(ok); }
  double toDouble(bool* ok = 0) const { return m_string.toDouble(ok); }
  float toFloat(bool* ok = 0) const { return m_string.toFloat(ok); }
  bool percentage(int& p) const { return m_string.percentage(p); }

  static AtomicString number(int);
  static AtomicString number(unsigned);
  static AtomicString number(long);
  static AtomicString number(unsigned long);
  static AtomicString number(long long);
  static AtomicString number(unsigned long long);

  static AtomicString number(
      double,
      unsigned precision = 6,
      TrailingZerosTruncatingPolicy = TruncateTrailingZeros);

  bool isNull() const { return m_string.isNull(); }
  bool isEmpty() const { return m_string.isEmpty(); }

  static void remove(StringImpl*);

#if USE(CF)
  AtomicString(CFStringRef s) : m_string(add(s)) {}
#endif
  // AtomicString::fromUTF8 will return a null string if
  // the input data contains invalid UTF-8 sequences.
  static AtomicString fromUTF8(const char*, size_t);
  static AtomicString fromUTF8(const char*);

  CString ascii() const { return m_string.ascii(); }
  CString latin1() const { return m_string.latin1(); }
  CString utf8(UTF8ConversionMode mode = LenientUTF8Conversion) const {
    return m_string.utf8(mode);
  }

#ifndef NDEBUG
  void show() const;
#endif

 private:
  String m_string;

  static PassRefPtr<StringImpl> add(const LChar*);
  ALWAYS_INLINE static PassRefPtr<StringImpl> add(const char* s) {
    return add(reinterpret_cast<const LChar*>(s));
  };
  static PassRefPtr<StringImpl> add(const LChar*, unsigned length);
  static PassRefPtr<StringImpl> add(const UChar*, unsigned length);
  ALWAYS_INLINE static PassRefPtr<StringImpl> add(const char* s,
                                                  unsigned length) {
    return add(reinterpret_cast<const LChar*>(s), length);
  };
  static PassRefPtr<StringImpl> add(const UChar*,
                                    unsigned length,
                                    unsigned existingHash);
  static PassRefPtr<StringImpl> add(const UChar*);
  static PassRefPtr<StringImpl> add(StringImpl*,
                                    unsigned offset,
                                    unsigned length);
  ALWAYS_INLINE static PassRefPtr<StringImpl> add(StringImpl* r) {
    if (!r || r->isAtomic())
      return r;
    return addSlowCase(r);
  }
  static PassRefPtr<StringImpl> addFromLiteralData(const char* characters,
                                                   unsigned length);
  static PassRefPtr<StringImpl> addSlowCase(StringImpl*);
#if USE(CF)
  static PassRefPtr<StringImpl> add(CFStringRef);
#endif

  static AtomicString fromUTF8Internal(const char*, const char*);
};

inline bool operator==(const AtomicString& a, const AtomicString& b) {
  return a.impl() == b.impl();
}
WTF_EXPORT bool operator==(const AtomicString&, const LChar*);
inline bool operator==(const AtomicString& a, const char* b) {
  return WTF::equal(a.impl(), reinterpret_cast<const LChar*>(b));
}
inline bool operator==(const AtomicString& a, const Vector<UChar>& b) {
  return a.impl() && equal(a.impl(), b.data(), b.size());
}
inline bool operator==(const AtomicString& a, const String& b) {
  return equal(a.impl(), b.impl());
}
inline bool operator==(const LChar* a, const AtomicString& b) {
  return b == a;
}
inline bool operator==(const String& a, const AtomicString& b) {
  return equal(a.impl(), b.impl());
}
inline bool operator==(const Vector<UChar>& a, const AtomicString& b) {
  return b == a;
}

inline bool operator!=(const AtomicString& a, const AtomicString& b) {
  return a.impl() != b.impl();
}
inline bool operator!=(const AtomicString& a, const LChar* b) {
  return !(a == b);
}
inline bool operator!=(const AtomicString& a, const char* b) {
  return !(a == b);
}
inline bool operator!=(const AtomicString& a, const String& b) {
  return !equal(a.impl(), b.impl());
}
inline bool operator!=(const AtomicString& a, const Vector<UChar>& b) {
  return !(a == b);
}
inline bool operator!=(const LChar* a, const AtomicString& b) {
  return !(b == a);
}
inline bool operator!=(const String& a, const AtomicString& b) {
  return !equal(a.impl(), b.impl());
}
inline bool operator!=(const Vector<UChar>& a, const AtomicString& b) {
  return !(a == b);
}

inline bool equalIgnoringCase(const AtomicString& a, const AtomicString& b) {
  return equalIgnoringCase(a.impl(), b.impl());
}
inline bool equalIgnoringCase(const AtomicString& a, const LChar* b) {
  return equalIgnoringCase(a.impl(), b);
}
inline bool equalIgnoringCase(const AtomicString& a, const char* b) {
  return equalIgnoringCase(a.impl(), reinterpret_cast<const LChar*>(b));
}
inline bool equalIgnoringCase(const AtomicString& a, const String& b) {
  return equalIgnoringCase(a.impl(), b.impl());
}
inline bool equalIgnoringCase(const LChar* a, const AtomicString& b) {
  return equalIgnoringCase(a, b.impl());
}
inline bool equalIgnoringCase(const char* a, const AtomicString& b) {
  return equalIgnoringCase(reinterpret_cast<const LChar*>(a), b.impl());
}
inline bool equalIgnoringCase(const String& a, const AtomicString& b) {
  return equalIgnoringCase(a.impl(), b.impl());
}

// Define external global variables for the commonly used atomic strings.
// These are only usable from the main thread.
WTF_EXPORT extern const AtomicString& nullAtom;
WTF_EXPORT extern const AtomicString& emptyAtom;
WTF_EXPORT extern const AtomicString& starAtom;

inline AtomicString AtomicString::fromUTF8(const char* characters,
                                           size_t length) {
  if (!characters)
    return nullAtom;
  if (!length)
    return emptyAtom;
  return fromUTF8Internal(characters, characters + length);
}

inline AtomicString AtomicString::fromUTF8(const char* characters) {
  if (!characters)
    return nullAtom;
  if (!*characters)
    return emptyAtom;
  return fromUTF8Internal(characters, 0);
}

// AtomicStringHash is the default hash for AtomicString
template <typename T>
struct DefaultHash;
template <>
struct DefaultHash<AtomicString> {
  typedef AtomicStringHash Hash;
};

}  // namespace WTF

WTF_ALLOW_MOVE_INIT_AND_COMPARE_WITH_MEM_FUNCTIONS(AtomicString);

using WTF::AtomicString;
using WTF::emptyAtom;
using WTF::nullAtom;
using WTF::starAtom;

#include "flutter/sky/engine/wtf/text/StringConcatenate.h"
#endif  // SKY_ENGINE_WTF_TEXT_ATOMICSTRING_H_