third_party/WebKit/Source/wtf/text/CString.h

/*
 * Copyright (C) 2003, 2006, 2008, 2009, 2010, 2012 Apple Inc. All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef CString_h
#define CString_h

#include "wtf/Allocator.h"
#include "wtf/RefCounted.h"
#include "wtf/RefPtr.h"
#include "wtf/WTFExport.h"
#include <string.h>

namespace WTF {

// CStringBuffer is an immutable ref-counted storage for the characters in a
// CString. It's analogous to a StringImpl but may contain any arbitrary
// sequence of bytes. The data is always allocated 1 longer than length() and is
// null terminated.
// TODO(esprehn): Rename to CStringImpl.
class WTF_EXPORT CStringBuffer : public RefCounted<CStringBuffer> {
  WTF_MAKE_NONCOPYABLE(CStringBuffer);

 public:
  // CStringBuffers are allocated out of the WTF buffer partition.
  void* operator new(size_t, void* ptr) { return ptr; }
  void operator delete(void*);

  static PassRefPtr<CStringBuffer> createUninitialized(size_t length,
                                                       char*& data);

  const char* data() const { return reinterpret_cast<const char*>(this + 1); }
  size_t length() const { return m_length; }

 private:
  explicit CStringBuffer(size_t length) : m_length(length) {}

  const unsigned m_length;
};

// A container for an immutable ref-counted null-terminated char array. This is
// analogous to a WTF::String but does not require the contained bytes to be
// valid Latin1 or UTF-16. Instead a CString can contain any arbitrary bytes.
class WTF_EXPORT CString {
  USING_FAST_MALLOC(CString);

 public:
  // Construct a null string, distinguishable from an empty string.
  CString() {}

  // Construct a string from arbitrary bytes.
  CString(const char* chars) : CString(chars, chars ? strlen(chars) : 0) {}
  CString(const char*, size_t length);

  // Construct a string referencing an existing buffer.
  CString(CStringBuffer* buffer) : m_buffer(buffer) {}
  CString(PassRefPtr<CStringBuffer> buffer) : m_buffer(buffer) {}

  // TODO(esprehn): Rename to createUninitialized.
  static CString newUninitialized(size_t length, char*& data) {
    return CStringBuffer::createUninitialized(length, data);
  }

  // The bytes of the string, always NUL terminated. May be null.
  const char* data() const { return m_buffer ? m_buffer->data() : 0; }

  // The length of the data(), *not* including the NUL terminator.
  size_t length() const { return m_buffer ? m_buffer->length() : 0; }

  bool isNull() const { return !m_buffer; }

  bool isSafeToSendToAnotherThread() const;

  // TODO(esprehn): Rename to impl() when CStringBuffer is renamed.
  CStringBuffer* buffer() const { return m_buffer.get(); }

 private:
  RefPtr<CStringBuffer> m_buffer;
};

WTF_EXPORT bool operator==(const CString& a, const CString& b);
inline bool operator!=(const CString& a, const CString& b) {
  return !(a == b);
}
WTF_EXPORT bool operator==(const CString& a, const char* b);
inline bool operator!=(const CString& a, const char* b) {
  return !(a == b);
}

// Pretty printer for gtest and base/logging.*.  It prepends and appends
// double-quotes, and escapes characters other than ASCII printables.
WTF_EXPORT std::ostream& operator<<(std::ostream&, const CString&);

}  // namespace WTF

using WTF::CString;

#endif  // CString_h