Modernize some aspects of text codecs, eliminate WebKit use of strcasecmp
[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 <runtime/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 "GUniquePtrSoup.h"
44 #endif
45
46 #if USE(FOUNDATION)
47 OBJC_CLASS NSArray;
48 OBJC_CLASS NSData;
49 #endif
50
51 namespace WebCore {
52
53 class SharedBufferDataView;
54
55 class WEBCORE_EXPORT SharedBuffer : public RefCounted<SharedBuffer> {
56 public:
57     static Ref<SharedBuffer> create() { return adoptRef(*new SharedBuffer); }
58     static Ref<SharedBuffer> create(const char* data, size_t size) { return adoptRef(*new SharedBuffer(data, size)); }
59     static Ref<SharedBuffer> create(const unsigned char* data, size_t size) { return adoptRef(*new SharedBuffer(data, size)); }
60     static RefPtr<SharedBuffer> createWithContentsOfFile(const String& filePath);
61
62     static Ref<SharedBuffer> create(Vector<char>&&);
63     static Ref<SharedBuffer> create(Vector<uint8_t>&&);
64
65 #if USE(FOUNDATION)
66     RetainPtr<NSData> createNSData() const;
67     RetainPtr<NSArray> createNSDataArray() const;
68     static Ref<SharedBuffer> create(NSData *);
69 #endif
70 #if USE(CF)
71     RetainPtr<CFDataRef> createCFData() const;
72     static Ref<SharedBuffer> create(CFDataRef);
73     void append(CFDataRef);
74 #endif
75
76 #if USE(SOUP)
77     GUniquePtr<SoupBuffer> createSoupBuffer(unsigned offset = 0, unsigned size = 0);
78     static Ref<SharedBuffer> wrapSoupBuffer(SoupBuffer*);
79 #endif
80
81     // Calling data() causes all the data segments to be copied into one segment if they are not already.
82     // Iterate the segments using begin() and end() instead.
83     // FIXME: Audit the call sites of this function and replace them with iteration if possible.
84     const char* data() const;
85
86     // Creates an ArrayBuffer and copies this SharedBuffer's contents to that
87     // ArrayBuffer without merging segmented buffers into a flat buffer.
88     RefPtr<ArrayBuffer> tryCreateArrayBuffer() const;
89
90     size_t size() const { return m_size; }
91
92     bool isEmpty() const { return !size(); }
93
94     void append(const SharedBuffer&);
95     void append(const char*, size_t);
96     void append(Vector<char>&&);
97
98     void clear();
99
100     Ref<SharedBuffer> copy() const;
101
102     // Data wrapped by a DataSegment should be immutable because it can be referenced by other objects.
103     // To modify or combine the data, allocate a new DataSegment.
104     class DataSegment : public ThreadSafeRefCounted<DataSegment> {
105     public:
106         const char* data() const;
107         size_t size() const;
108
109         static Ref<DataSegment> create(Vector<char>&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
110 #if USE(CF)
111         static Ref<DataSegment> create(RetainPtr<CFDataRef>&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
112 #endif
113 #if USE(SOUP)
114         static Ref<DataSegment> create(GUniquePtr<SoupBuffer>&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
115 #endif
116         static Ref<DataSegment> create(FileSystem::MappedFileData&& data) { return adoptRef(*new DataSegment(WTFMove(data))); }
117
118     private:
119         DataSegment(Vector<char>&& data)
120             : m_immutableData(WTFMove(data)) { }
121 #if USE(CF)
122         DataSegment(RetainPtr<CFDataRef>&& data)
123             : m_immutableData(WTFMove(data)) { }
124 #endif
125 #if USE(SOUP)
126         DataSegment(GUniquePtr<SoupBuffer>&& data)
127             : m_immutableData(WTFMove(data)) { }
128 #endif
129         DataSegment(FileSystem::MappedFileData&& data)
130             : m_immutableData(WTFMove(data)) { }
131
132         Variant<Vector<char>,
133 #if USE(CF)
134             RetainPtr<CFDataRef>,
135 #endif
136 #if USE(SOUP)
137             GUniquePtr<SoupBuffer>,
138 #endif
139             FileSystem::MappedFileData> m_immutableData;
140         friend class SharedBuffer;
141     };
142
143     struct DataSegmentVectorEntry {
144         size_t beginPosition;
145         Ref<DataSegment> segment;
146     };
147     using DataSegmentVector = Vector<DataSegmentVectorEntry, 1>;
148     DataSegmentVector::const_iterator begin() const { return m_segments.begin(); }
149     DataSegmentVector::const_iterator end() const { return m_segments.end(); }
150     
151     // begin and end take O(1) time, this takes O(log(N)) time.
152     SharedBufferDataView getSomeData(size_t position) const;
153
154     void hintMemoryNotNeededSoon() const;
155
156 private:
157     explicit SharedBuffer() = default;
158     explicit SharedBuffer(const char*, size_t);
159     explicit SharedBuffer(const unsigned char*, size_t);
160     explicit SharedBuffer(Vector<char>&&);
161     explicit SharedBuffer(FileSystem::MappedFileData&&);
162 #if USE(CF)
163     explicit SharedBuffer(CFDataRef);
164 #endif
165 #if USE(SOUP)
166     explicit SharedBuffer(SoupBuffer*);
167 #endif
168
169     void combineIntoOneSegment() const;
170     
171     static RefPtr<SharedBuffer> createFromReadingFile(const String& filePath);
172
173     size_t m_size { 0 };
174     mutable DataSegmentVector m_segments;
175
176 #if !ASSERT_DISABLED
177     mutable bool m_hasBeenCombinedIntoOneSegment { false };
178     bool internallyConsistent() const;
179 #endif
180 };
181
182 class WEBCORE_EXPORT SharedBufferDataView {
183 public:
184     SharedBufferDataView(Ref<SharedBuffer::DataSegment>&&, size_t);
185     size_t size() const;
186     const char* data() const;
187 private:
188     size_t m_positionWithinSegment;
189     Ref<SharedBuffer::DataSegment> m_segment;
190 };
191
192 RefPtr<SharedBuffer> utf8Buffer(const String&);
193
194 } // namespace WebCore