2008-03-19 Stephanie Lewis <slewis@apple.com>
[WebKit-https.git] / WebCore / platform / SharedBuffer.h
1 /*
2  * Copyright (C) 2006 Apple Computer, 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 #ifndef SharedBuffer_h
26 #define SharedBuffer_h
27
28 #include "PlatformString.h"
29 #include <wtf/RefCounted.h>
30 #include <wtf/Forward.h>
31 #include <wtf/Vector.h>
32
33 #if PLATFORM(CF)
34 #include <wtf/RetainPtr.h>
35 #endif
36
37 #if PLATFORM(MAC)
38 #ifdef __OBJC__
39 @class NSData;
40 #else
41 class NSData;
42 #endif
43
44 #endif
45
46 namespace WebCore {
47
48 class SharedBuffer : public RefCounted<SharedBuffer> {
49 public:
50     static PassRefPtr<SharedBuffer> create() { return adoptRef(new SharedBuffer); }
51     static PassRefPtr<SharedBuffer> create(const char* c, int i) { return adoptRef(new SharedBuffer(c, i)); }
52     static PassRefPtr<SharedBuffer> create(const unsigned char* c, int i) { return adoptRef(new SharedBuffer(c, i)); }
53
54     static PassRefPtr<SharedBuffer> createWithContentsOfFile(const String& filePath);
55     
56 #if PLATFORM(MAC)
57     NSData *createNSData();
58     static PassRefPtr<SharedBuffer> wrapNSData(NSData *data);
59 #endif
60 #if PLATFORM(CF)
61     CFDataRef createCFData();
62 #endif
63
64     const char* data() const;
65     unsigned size() const;
66     const Vector<char> &buffer() { return m_buffer; }
67
68     bool isEmpty() const { return size() == 0; }
69
70     void append(const char*, int);
71     void clear();
72     const char* platformData() const;
73     unsigned platformDataSize() const;
74
75     PassRefPtr<SharedBuffer> copy() const;
76     
77 private:
78     SharedBuffer();
79     SharedBuffer(const char*, int);
80     SharedBuffer(const unsigned char*, int);
81     
82     void clearPlatformData();
83     void maybeTransferPlatformData();
84     bool hasPlatformData() const;
85     
86     Vector<char> m_buffer;
87 #if PLATFORM(CF)
88     SharedBuffer(CFDataRef);
89     RetainPtr<CFDataRef> m_cfData;
90 #endif
91 };
92     
93 }
94
95 #endif