Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / platform / SharedBuffer.h
1 /*
2  * Copyright (C) 2006-2017 Apple 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 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 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 #pragma once
28
29 #include "FileSystem.h"
30 #include <JavaScriptCore/ArrayBuffer.h>
31 #include <wtf/Forward.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/ThreadSafeRefCounted.h>
34 #include <wtf/Variant.h>
35 #include <wtf/Vector.h>
36 #include <wtf/text/WTFString.h>
37
38 #if USE(CF)
39 #include <wtf/RetainPtr.h>
40 #endif
41
42 #if USE(SOUP)
43 #include <wtf/glib/GUniquePtrSoup.h>
44 #endif
45
46 #if USE(GLIB)
47 #include <wtf/glib/GRefPtr.h>
48 typedef struct _GBytes GBytes;
49 #endif
50
51 #if USE(FOUNDATION)
52 OBJC_CLASS NSArray;
53 OBJC_CLASS NSData;
54 #endif
55
56 namespace WebCore {
57
58 class SharedBufferDataView;
59
60 class WEBCORE_EXPORT SharedBuffer : public RefCounted<SharedBuffer> {
61 public:
62     static Ref<SharedBuffer> create() { return adoptRef(*new SharedBuffer); }
63     static Ref<SharedBuffer> create(const char* data, size_t size) { return adoptRef(*new SharedBuffer(data, size)); }
64     static Ref<SharedBuffer> create(const unsigned char* data, size_t size) { return adoptRef(*new SharedBuffer(data, size)); }
65     static RefPtr<SharedBuffer> createWithContentsOfFile(const String& filePath);
66
67     static Ref<SharedBuffer> create(Vector<char>&&);
68     static Ref<SharedBuffer> create(Vector<uint8_t>&&);
69
70 #if USE(FOUNDATION)
71     RetainPtr<NSData> createNSData() const;
72     RetainPtr<NSArray> createNSDataArray() const;
73     static Ref<SharedBuffer> create(NSData *);
74     void append(NSData *);
75 #endif
76 #if USE(CF)
77     RetainPtr<CFDataRef> createCFData() const;
78     static Ref<SharedBuffer> create(CFDataRef);
79     void append(CFDataRef);
80 #endif
81
82 #if USE(SOUP)
83     GUniquePtr<SoupBuffer> createSoupBuffer(unsigned offset = 0, unsigned size = 0);
84     static Ref<SharedBuffer> wrapSoupBuffer(SoupBuffer*);
85 #endif
86
87 #if USE(GLIB)
88     static Ref<SharedBuffer> create(GBytes*);
89 #endif
90
91     // Calling data() causes all the data segments to be copied into one segment if they are not already.
92     // Iterate the segments using begin() and end() instead.
93     // FIXME: Audit the call sites of this function and replace them with iteration if possible.
94     const char* data() const;
95
96     // Creates an ArrayBuffer and copies this SharedBuffer's contents to that
97     // ArrayBuffer without merging segmented buffers into a flat buffer.
98     RefPtr<ArrayBuffer> tryCreateArrayBuffer() const;
99
100     size_t size() const { return m_size; }
101
102     bool isEmpty() const { return !size(); }
103
104     void append(const SharedBuffer&);
105     void append(const char*, size_t);
106     void append(Vector<char>&&);
107
108     void clear();
109
110     Ref<SharedBuffer> copy() const;
111
112     // Data wrapped by a DataSegment should be immutable because it can be referenced by other objects.
113     // To modify or combine the data, allocate a new DataSegment.
114     class DataSegment : public ThreadSafeRefCounted<DataSegment> {
115     public:
116         WEBCORE_EXPORT const char* data() const;
117         WEBCORE_EXPORT size_t size() const;
118
119         static Ref<DataSegment> create(Vector<char>&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
120 #if USE(CF)
121         static Ref<DataSegment> create(RetainPtr<CFDataRef>&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
122 #endif
123 #if USE(SOUP)
124         static Ref<DataSegment> create(GUniquePtr<SoupBuffer>&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
125 #endif
126 #if USE(GLIB)
127         static Ref<DataSegment> create(GRefPtr<GBytes>&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
128 #endif
129         static Ref<DataSegment> create(FileSystem::MappedFileData&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
130
131     private:
132         DataSegment(Vector<char>&& data)
133             : m_immutableData(WTFMove(data)) { }
134 #if USE(CF)
135         DataSegment(RetainPtr<CFDataRef>&& data)
136             : m_immutableData(WTFMove(data)) { }
137 #endif
138 #if USE(SOUP)
139         DataSegment(GUniquePtr<SoupBuffer>&& data)
140             : m_immutableData(WTFMove(data)) { }
141 #endif
142 #if USE(GLIB)
143         DataSegment(GRefPtr<GBytes>&& data)
144             : m_immutableData(WTFMove(data)) { }
145 #endif
146         DataSegment(FileSystem::MappedFileData&& data)
147             : m_immutableData(WTFMove(data)) { }
148
149         Variant<Vector<char>,
150 #if USE(CF)
151             RetainPtr<CFDataRef>,
152 #endif
153 #if USE(SOUP)
154             GUniquePtr<SoupBuffer>,
155 #endif
156 #if USE(GLIB)
157             GRefPtr<GBytes>,
158 #endif
159             FileSystem::MappedFileData> m_immutableData;
160         friend class SharedBuffer;
161     };
162
163     struct DataSegmentVectorEntry {
164         size_t beginPosition;
165         Ref<DataSegment> segment;
166     };
167     using DataSegmentVector = Vector<DataSegmentVectorEntry, 1>;
168     DataSegmentVector::const_iterator begin() const { return m_segments.begin(); }
169     DataSegmentVector::const_iterator end() const { return m_segments.end(); }
170     
171     // begin and end take O(1) time, this takes O(log(N)) time.
172     SharedBufferDataView getSomeData(size_t position) const;
173
174     void hintMemoryNotNeededSoon() const;
175
176     bool operator==(const SharedBuffer&) const;
177     bool operator!=(const SharedBuffer& other) const { return !operator==(other); }
178
179 private:
180     explicit SharedBuffer() = default;
181     explicit SharedBuffer(const char*, size_t);
182     explicit SharedBuffer(const unsigned char*, size_t);
183     explicit SharedBuffer(Vector<char>&&);
184     explicit SharedBuffer(FileSystem::MappedFileData&&);
185 #if USE(CF)
186     explicit SharedBuffer(CFDataRef);
187 #endif
188 #if USE(SOUP)
189     explicit SharedBuffer(SoupBuffer*);
190 #endif
191 #if USE(GLIB)
192     explicit SharedBuffer(GBytes*);
193 #endif
194
195     void combineIntoOneSegment() const;
196     
197     static RefPtr<SharedBuffer> createFromReadingFile(const String& filePath);
198
199     size_t m_size { 0 };
200     mutable DataSegmentVector m_segments;
201
202 #if !ASSERT_DISABLED
203     mutable bool m_hasBeenCombinedIntoOneSegment { false };
204     bool internallyConsistent() const;
205 #endif
206 };
207
208 inline bool operator==(const Ref<SharedBuffer>& left, const SharedBuffer& right)
209 {
210     return left.get() == right;
211 }
212
213 inline bool operator!=(const Ref<SharedBuffer>& left, const SharedBuffer& right)
214 {
215     return left.get() != right;
216 }
217
218 class WEBCORE_EXPORT SharedBufferDataView {
219 public:
220     SharedBufferDataView(Ref<SharedBuffer::DataSegment>&&, size_t);
221     size_t size() const;
222     const char* data() const;
223 private:
224     size_t m_positionWithinSegment;
225     Ref<SharedBuffer::DataSegment> m_segment;
226 };
227
228 RefPtr<SharedBuffer> utf8Buffer(const String&);
229
230 } // namespace WebCore