Purge all uses of PassRefPtr in WebCore/Modules
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBGetResult.h
1 /*
2  * Copyright (C) 2014 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef IDBGetResult_h
27 #define IDBGetResult_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBKey.h"
32 #include "IDBKeyData.h"
33 #include "IDBKeyPath.h"
34 #include "IDBValue.h"
35 #include "SharedBuffer.h"
36
37 namespace WebCore {
38
39 class IDBGetResult {
40 public:
41     IDBGetResult()
42         : m_isDefined(false)
43     {
44     }
45
46     IDBGetResult(const IDBValue& value, const IDBKeyData& currentPrimaryKey)
47         : m_value(value)
48         , m_primaryKeyData(currentPrimaryKey)
49     {
50     }
51
52     IDBGetResult(const ThreadSafeDataBuffer& buffer)
53         : m_value(buffer)
54     {
55     }
56
57     IDBGetResult(IDBValue&& buffer)
58         : m_value(WTFMove(buffer))
59     {
60     }
61
62     IDBGetResult(IDBKey& key)
63         : m_keyData(&key)
64     {
65     }
66
67     IDBGetResult(const IDBKeyData& keyData)
68         : m_keyData(keyData)
69     {
70     }
71
72     IDBGetResult(SharedBuffer* buffer, IDBKey& key, const IDBKeyPath& path)
73         : m_keyData(&key)
74         , m_keyPath(path)
75     {
76         if (buffer)
77             dataFromBuffer(*buffer);
78     }
79
80     IDBGetResult(const IDBKeyData& keyData, const IDBKeyData& primaryKeyData)
81         : m_keyData(keyData)
82         , m_primaryKeyData(primaryKeyData)
83     {
84     }
85
86     IDBGetResult(const IDBKeyData& keyData, const IDBKeyData& primaryKeyData, IDBValue&& value)
87         : m_value(WTFMove(value))
88         , m_keyData(keyData)
89         , m_primaryKeyData(primaryKeyData)
90     {
91     }
92
93     IDBGetResult(const IDBKeyData& keyData, const IDBKeyData& primaryKeyData, const IDBValue& value)
94         : m_value(value)
95         , m_keyData(keyData)
96         , m_primaryKeyData(primaryKeyData)
97     {
98     }
99
100     enum IsolatedCopyTag { IsolatedCopy };
101     IDBGetResult(const IDBGetResult&, IsolatedCopyTag);
102
103     IDBGetResult isolatedCopy() const;
104
105     const IDBValue& value() const { return m_value; }
106     const IDBKeyData& keyData() const { return m_keyData; }
107     const IDBKeyData& primaryKeyData() const { return m_primaryKeyData; }
108     const IDBKeyPath& keyPath() const { return m_keyPath; }
109     bool isDefined() const { return m_isDefined; }
110
111     template<class Encoder> void encode(Encoder&) const;
112     template<class Decoder> static bool decode(Decoder&, IDBGetResult&);
113
114 private:
115     void dataFromBuffer(SharedBuffer&);
116
117     static void isolatedCopy(const IDBGetResult& source, IDBGetResult& destination);
118
119     IDBValue m_value;
120     IDBKeyData m_keyData;
121     IDBKeyData m_primaryKeyData;
122     IDBKeyPath m_keyPath;
123     bool m_isDefined { true };
124 };
125
126 template<class Encoder>
127 void IDBGetResult::encode(Encoder& encoder) const
128 {
129     encoder << m_keyData << m_primaryKeyData << m_keyPath << m_isDefined << m_value;
130 }
131
132 template<class Decoder>
133 bool IDBGetResult::decode(Decoder& decoder, IDBGetResult& result)
134 {
135     if (!decoder.decode(result.m_keyData))
136         return false;
137
138     if (!decoder.decode(result.m_primaryKeyData))
139         return false;
140
141     if (!decoder.decode(result.m_keyPath))
142         return false;
143
144     if (!decoder.decode(result.m_isDefined))
145         return false;
146
147     if (!decoder.decode(result.m_value))
148         return false;
149
150     return true;
151 }
152
153 } // namespace WebCore
154
155 #endif // ENABLE(INDEXED_DATABASE)
156 #endif // IDBGetResult_h