wtf/text/CString.h

   1 /*
   2  * Copyright (C) 2003, 2006, 2008, 2009, 2010 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef CString_h
  27 #define CString_h
  28
  29 #include "PassRefPtr.h"
  30 #include "RefCounted.h"
  31 #include "Vector.h"
  32
  33 namespace WTF {
  34
  35 class CStringBuffer : public RefCounted<CStringBuffer> {
  36 public:
  37     const char* data() { return m_vector.data(); }
  38     size_t length() { return m_vector.size(); }
  39
  40 private:
  41     friend class CString;
  42
  43     static PassRefPtr<CStringBuffer> create(size_t length) { return adoptRef(new CStringBuffer(length)); }
  44     CStringBuffer(size_t length) : m_vector(length) { }
  45     char* mutableData() { return m_vector.data(); }
  46
  47     Vector<char> m_vector;
  48 };
  49
  50 // A container for a null-terminated char array supporting copy-on-write
  51 // assignment.  The contained char array may be null.
  52 class CString {
  53 public:
  54     CString() { }
  55     CString(const char*);
  56     CString(const char*, size_t length);
  57     CString(CStringBuffer* buffer) : m_buffer(buffer) { }
  58     static CString newUninitialized(size_t length, char*& characterBuffer);
  59
  60     const char* data() const
  61     {
  62         return m_buffer ? m_buffer->data() : 0;
  63     }
  64     char* mutableData();
  65     size_t length() const
  66     {
  67         return m_buffer ? m_buffer->length() - 1 : 0;
  68     }
  69
  70     bool isNull() const { return !m_buffer; }
  71
  72     CStringBuffer* buffer() const { return m_buffer.get(); }
  73
  74 private:
  75     void copyBufferIfNeeded();
  76     void init(const char*, size_t length);
  77     RefPtr<CStringBuffer> m_buffer;
  78 };
  79
  80 bool operator==(const CString& a, const CString& b);
  81 inline bool operator!=(const CString& a, const CString& b) { return !(a == b); }
  82
  83 } // namespace WTF
  84
  85 using WTF::CString;
  86
  87 #endif // CString_h