WebCore/CString.h

   1 /*
   2  * Copyright (C) 2003, 2006, 2008 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 "SharedBuffer.h"
  30
  31 #include <wtf/PassRefPtr.h>
  32 #include <wtf/RefCounted.h>
  33 #include <wtf/Vector.h>
  34
  35 namespace WebCore {
  36
  37     class CStringBuffer : public RefCounted<CStringBuffer> {
  38     public:
  39         static PassRefPtr<CStringBuffer> create(unsigned length) { return adoptRef(new CStringBuffer(length)); }
  40
  41         char* data() { return m_vector.data(); }
  42         size_t length() const { return m_vector.size(); }
  43
  44         PassRefPtr<SharedBuffer> releaseBuffer() { return SharedBuffer::adoptVector(m_vector); }
  45
  46     private:
  47         CStringBuffer(unsigned length) : m_vector(length) { }
  48
  49         Vector<char> m_vector;
  50     };
  51
  52     // A container for a null-terminated char array supporting copy-on-write
  53     // assignment.  The contained char array may be null.
  54     class CString {
  55     public:
  56         CString() { }
  57         CString(const char*);
  58         CString(const char*, unsigned length);
  59         static CString newUninitialized(size_t length, char*& characterBuffer);
  60
  61         const char* data() const;
  62         char* mutableData();
  63         unsigned length() const;
  64
  65         bool isNull() const { return !m_buffer; }
  66
  67         PassRefPtr<SharedBuffer> releaseBuffer();
  68
  69     private:
  70         void copyBufferIfNeeded();
  71         void init(const char*, unsigned length);
  72         RefPtr<CStringBuffer> m_buffer;
  73     };
  74
  75     bool operator==(const CString& a, const CString& b);
  76     inline bool operator!=(const CString& a, const CString& b) { return !(a == b); }
  77
  78 } // namespace WebCore
  79
  80 #endif // CString_h