fe3e4b6b893576b4cfe1a5cfab0659f1da176ff8
[WebKit-https.git] / Source / WebCore / platform / SharedBuffer.h
1 /*
2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
3  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef SharedBuffer_h
28 #define SharedBuffer_h
29
30 #include "PlatformString.h"
31 #include <wtf/Forward.h>
32 #include <wtf/OwnPtr.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/Vector.h>
35
36 #if USE(CF)
37 #include <wtf/RetainPtr.h>
38 #endif
39
40 #if PLATFORM(MAC) || (PLATFORM(QT) && USE(QTKIT))
41 OBJC_CLASS NSData;
42 #endif
43
44 namespace WebCore {
45     
46 class PurgeableBuffer;
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     static PassRefPtr<SharedBuffer> adoptVector(Vector<char>& vector);
57     
58     // The buffer must be in non-purgeable state before adopted to a SharedBuffer. 
59     // It will stay that way until released.
60     static PassRefPtr<SharedBuffer> adoptPurgeableBuffer(PassOwnPtr<PurgeableBuffer>);
61     
62     ~SharedBuffer();
63     
64 #if PLATFORM(MAC) || (PLATFORM(QT) && USE(QTKIT))
65     NSData *createNSData();
66     static PassRefPtr<SharedBuffer> wrapNSData(NSData *data);
67 #endif
68 #if USE(CF)
69     CFDataRef createCFData();
70     static PassRefPtr<SharedBuffer> wrapCFData(CFDataRef);
71 #endif
72
73     // Calling this function will force internal segmented buffers
74     // to be merged into a flat buffer. Use getSomeData() whenever possible
75     // for better performance.
76     const char* data() const;
77
78     unsigned size() const;
79
80
81     bool isEmpty() const { return !size(); }
82
83     void append(SharedBuffer*);
84     void append(const char*, unsigned);
85     void append(const Vector<char>&);
86
87     void clear();
88     const char* platformData() const;
89     unsigned platformDataSize() const;
90
91 #if HAVE(NETWORK_CFDATA_ARRAY_CALLBACK)
92     void append(CFDataRef);
93 #endif
94
95     PassRefPtr<SharedBuffer> copy() const;
96     
97     bool hasPurgeableBuffer() const { return m_purgeableBuffer.get(); }
98
99     // Ensure this buffer has no other clients before calling this.
100     PassOwnPtr<PurgeableBuffer> releasePurgeableBuffer();
101
102     // Return the number of consecutive bytes after "position". "data"
103     // points to the first byte.
104     // Return 0 when no more data left.
105     // When extracting all data with getSomeData(), the caller should
106     // repeat calling it until it returns 0.
107     // Usage:
108     //      const char* segment;
109     //      unsigned pos = 0;
110     //      while (unsigned length = sharedBuffer->getSomeData(segment, pos)) {
111     //          // Use the data. for example: decoder->decode(segment, length);
112     //          pos += length;
113     //      }
114     unsigned getSomeData(const char*& data, unsigned position = 0) const;
115
116 private:
117     SharedBuffer();
118     SharedBuffer(const char*, int);
119     SharedBuffer(const unsigned char*, int);
120     
121     // Calling this function will force internal segmented buffers
122     // to be merged into a flat buffer. Use getSomeData() whenever possible
123     // for better performance.
124     // As well, be aware that this method does *not* return any purgeable
125     // memory, which can be a source of bugs.
126     const Vector<char>& buffer() const;
127
128     void clearPlatformData();
129     void maybeTransferPlatformData();
130     bool hasPlatformData() const;
131     
132     unsigned m_size;
133     mutable Vector<char> m_buffer;
134     mutable Vector<char*> m_segments;
135     OwnPtr<PurgeableBuffer> m_purgeableBuffer;
136 #if HAVE(NETWORK_CFDATA_ARRAY_CALLBACK)
137     mutable Vector<RetainPtr<CFDataRef> > m_dataArray;
138     void copyDataArrayAndClear(char *destination, unsigned bytesToCopy) const;
139     unsigned copySomeDataFromDataArray(const char*& someData, unsigned position) const;
140 #endif
141 #if USE(CF)
142     SharedBuffer(CFDataRef);
143     RetainPtr<CFDataRef> m_cfData;
144 #endif
145 };
146     
147 }
148
149 #endif // SharedBuffer_h