Unreviewed, rolling out r126169.
[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 MemoryObjectInfo;
47 class PurgeableBuffer;
48
49 class SharedBuffer : public RefCounted<SharedBuffer> {
50 public:
51     static PassRefPtr<SharedBuffer> create() { return adoptRef(new SharedBuffer); }
52     static PassRefPtr<SharedBuffer> create(size_t size) { return adoptRef(new SharedBuffer(size)); }
53     static PassRefPtr<SharedBuffer> create(const char* c, int i) { return adoptRef(new SharedBuffer(c, i)); }
54     static PassRefPtr<SharedBuffer> create(const unsigned char* c, int i) { return adoptRef(new SharedBuffer(c, i)); }
55
56     static PassRefPtr<SharedBuffer> createWithContentsOfFile(const String& filePath);
57
58     static PassRefPtr<SharedBuffer> adoptVector(Vector<char>& vector);
59     
60     // The buffer must be in non-purgeable state before adopted to a SharedBuffer. 
61     // It will stay that way until released.
62     static PassRefPtr<SharedBuffer> adoptPurgeableBuffer(PassOwnPtr<PurgeableBuffer>);
63     
64     ~SharedBuffer();
65     
66 #if PLATFORM(MAC) || (PLATFORM(QT) && USE(QTKIT))
67     NSData *createNSData();
68     static PassRefPtr<SharedBuffer> wrapNSData(NSData *data);
69 #endif
70 #if USE(CF)
71     CFDataRef createCFData();
72     static PassRefPtr<SharedBuffer> wrapCFData(CFDataRef);
73 #endif
74
75     // Calling this function will force internal segmented buffers
76     // to be merged into a flat buffer. Use getSomeData() whenever possible
77     // for better performance.
78     const char* data() const;
79
80     unsigned size() const;
81
82
83     bool isEmpty() const { return !size(); }
84
85     void append(SharedBuffer*);
86     void append(const char*, unsigned);
87     void append(const Vector<char>&);
88
89     void clear();
90     const char* platformData() const;
91     unsigned platformDataSize() const;
92
93 #if HAVE(NETWORK_CFDATA_ARRAY_CALLBACK)
94     void append(CFDataRef);
95 #endif
96
97     PassRefPtr<SharedBuffer> copy() const;
98     
99     bool hasPurgeableBuffer() const { return m_purgeableBuffer.get(); }
100
101     // Ensure this buffer has no other clients before calling this.
102     PassOwnPtr<PurgeableBuffer> releasePurgeableBuffer();
103
104     // Return the number of consecutive bytes after "position". "data"
105     // points to the first byte.
106     // Return 0 when no more data left.
107     // When extracting all data with getSomeData(), the caller should
108     // repeat calling it until it returns 0.
109     // Usage:
110     //      const char* segment;
111     //      unsigned pos = 0;
112     //      while (unsigned length = sharedBuffer->getSomeData(segment, pos)) {
113     //          // Use the data. for example: decoder->decode(segment, length);
114     //          pos += length;
115     //      }
116     unsigned getSomeData(const char*& data, unsigned position = 0) const;
117
118     void reportMemoryUsage(MemoryObjectInfo*) const;
119
120 private:
121     SharedBuffer();
122     explicit SharedBuffer(size_t);
123     SharedBuffer(const char*, int);
124     SharedBuffer(const unsigned char*, int);
125     
126     // Calling this function will force internal segmented buffers
127     // to be merged into a flat buffer. Use getSomeData() whenever possible
128     // for better performance.
129     // As well, be aware that this method does *not* return any purgeable
130     // memory, which can be a source of bugs.
131     const Vector<char>& buffer() const;
132
133     void clearPlatformData();
134     void maybeTransferPlatformData();
135     bool hasPlatformData() const;
136     
137     unsigned m_size;
138     mutable Vector<char> m_buffer;
139     mutable Vector<char*> m_segments;
140     OwnPtr<PurgeableBuffer> m_purgeableBuffer;
141 #if HAVE(NETWORK_CFDATA_ARRAY_CALLBACK)
142     mutable Vector<RetainPtr<CFDataRef> > m_dataArray;
143     void copyDataArrayAndClear(char *destination, unsigned bytesToCopy) const;
144     unsigned copySomeDataFromDataArray(const char*& someData, unsigned position) const;
145 #endif
146 #if USE(CF)
147     explicit SharedBuffer(CFDataRef);
148     RetainPtr<CFDataRef> m_cfData;
149 #endif
150 };
151     
152 }
153
154 #endif // SharedBuffer_h