2011-06-09 Jay Civelli <jcivelli@chromium.org>
[WebKit-https.git] / Source / WebKit / chromium / public / WebData.h
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebData_h
32 #define WebData_h
33
34 #include "WebCommon.h"
35
36 #if WEBKIT_IMPLEMENTATION
37 namespace WebCore { class SharedBuffer; }
38 namespace WTF { template <typename T> class PassRefPtr; }
39 #endif
40
41 namespace WebKit {
42
43 class WebDataPrivate;
44
45 // A container for raw bytes.  It is inexpensive to copy a WebData object.
46 //
47 // WARNING: It is not safe to pass a WebData across threads!!!
48 //
49 class WebData {
50 public:
51     ~WebData() { reset(); }
52
53     WebData() : m_private(0) { }
54
55     WebData(const char* data, size_t size) : m_private(0)
56     {
57         assign(data, size);
58     }
59
60     template <int N>
61     WebData(const char (&data)[N]) : m_private(0)
62     {
63         assign(data, N - 1);
64     }
65
66     WebData(const WebData& d) : m_private(0) { assign(d); }
67
68     WebData& operator=(const WebData& d)
69     {
70         assign(d);
71         return *this;
72     }
73
74     WEBKIT_API void reset();
75     WEBKIT_API void assign(const WebData&);
76     WEBKIT_API void assign(const char* data, size_t size);
77
78     WEBKIT_API size_t size() const;
79
80     // Sets |data| to point to the content of the WebData at index |position|
81     // and returns the number of bytes available to be read in |data|.
82     // Return 0 when no more data is left.
83     // Usage:
84     //      const char* segment;
85     //      size_t position = 0;
86     //      while (size_t length = webData.getSomeData(segment, position)) {
87     //          // Use the data. for example: decoder->decode(segment, length);
88     //          position += length;
89     //      }
90     WEBKIT_API size_t getSomeData(const char*& data, size_t position) const;
91
92     // Returns all the data from the SharedBuffer.
93     // Consider using getSomeData() as data() could require flattening the internal buffer
94     // which might be expensive.
95     WEBKIT_API const char* data() const;
96
97     bool isEmpty() const { return !size(); }
98     bool isNull() const { return !m_private; }
99
100 #if WEBKIT_IMPLEMENTATION
101     WebData(const WTF::PassRefPtr<WebCore::SharedBuffer>&);
102     WebData& operator=(const WTF::PassRefPtr<WebCore::SharedBuffer>&);
103     operator WTF::PassRefPtr<WebCore::SharedBuffer>() const;
104 #else
105     template <class C>
106     WebData(const C& c) : m_private(0)
107     {
108         assign(c.data(), c.size());
109     }
110
111     template <class C>
112     WebData& operator=(const C& c)
113     {
114         assign(c.data(), c.size());
115         return *this;
116     }
117 #endif
118
119 private:
120     void assign(WebDataPrivate*);
121     WebDataPrivate* m_private;
122 };
123
124 } // namespace WebKit
125
126 #endif