Blob type cannot be stored correctly in IDB when IDBObjectStore has autoIncrement...
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBCursor.h
1 /*
2  * Copyright (C) 2015 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 #pragma once
27
28 #if ENABLE(INDEXED_DATABASE)
29
30 #include "ExceptionOr.h"
31 #include "IDBCursorDirection.h"
32 #include "IDBCursorInfo.h"
33 #include "IDBKeyPath.h"
34 #include "IDBValue.h"
35 #include "JSValueInWrappedObject.h"
36 #include <JavaScriptCore/Strong.h>
37 #include <wtf/Variant.h>
38 #include <wtf/WeakPtr.h>
39
40 namespace WebCore {
41
42 class IDBGetResult;
43 class IDBIndex;
44 class IDBObjectStore;
45 class IDBTransaction;
46
47 class IDBCursor : public ScriptWrappable, public RefCounted<IDBCursor> {
48 public:
49     static Ref<IDBCursor> create(IDBObjectStore&, const IDBCursorInfo&);
50     static Ref<IDBCursor> create(IDBIndex&, const IDBCursorInfo&);
51     
52     virtual ~IDBCursor();
53
54     using Source = Variant<RefPtr<IDBObjectStore>, RefPtr<IDBIndex>>;
55
56     const Source& source() const;
57     IDBCursorDirection direction() const;
58
59     IDBKey* key() { return m_key.get(); };
60     IDBKey* primaryKey() { return m_primaryKey.get(); };
61     IDBValue value() { return m_value; };
62     const Optional<IDBKeyPath>& primaryKeyPath() { return m_keyPath; };
63     JSValueInWrappedObject& keyWrapper() { return m_keyWrapper; }
64     JSValueInWrappedObject& primaryKeyWrapper() { return m_primaryKeyWrapper; }
65     JSValueInWrappedObject& valueWrapper() { return m_valueWrapper; }
66
67     ExceptionOr<Ref<IDBRequest>> update(JSC::ExecState&, JSC::JSValue);
68     ExceptionOr<void> advance(unsigned);
69     ExceptionOr<void> continueFunction(JSC::ExecState&, JSC::JSValue key);
70     ExceptionOr<void> continuePrimaryKey(JSC::ExecState&, JSC::JSValue key, JSC::JSValue primaryKey);
71     ExceptionOr<Ref<IDBRequest>> deleteFunction(JSC::ExecState&);
72
73     ExceptionOr<void> continueFunction(const IDBKeyData&);
74
75     const IDBCursorInfo& info() const { return m_info; }
76
77     void setRequest(IDBRequest& request) { m_request = makeWeakPtr(&request); }
78     void clearRequest() { m_request.clear(); }
79     void clearWrappers();
80     IDBRequest* request() { return m_request.get(); }
81
82     bool setGetResult(IDBRequest&, const IDBGetResult&);
83
84     virtual bool isKeyCursorWithValue() const { return false; }
85
86 protected:
87     IDBCursor(IDBObjectStore&, const IDBCursorInfo&);
88     IDBCursor(IDBIndex&, const IDBCursorInfo&);
89
90 private:
91     bool sourcesDeleted() const;
92     IDBObjectStore& effectiveObjectStore() const;
93     IDBTransaction& transaction() const;
94
95     void uncheckedIterateCursor(const IDBKeyData&, unsigned count);
96     void uncheckedIterateCursor(const IDBKeyData&, const IDBKeyData&);
97
98     IDBCursorInfo m_info;
99     Source m_source;
100     WeakPtr<IDBRequest> m_request;
101
102     bool m_gotValue { false };
103
104     RefPtr<IDBKey> m_key;
105     RefPtr<IDBKey> m_primaryKey;
106     IDBKeyData m_keyData;
107     IDBKeyData m_primaryKeyData;
108     IDBValue m_value;
109     Optional<IDBKeyPath> m_keyPath;
110
111     JSValueInWrappedObject m_keyWrapper;
112     JSValueInWrappedObject m_primaryKeyWrapper;
113     JSValueInWrappedObject m_valueWrapper;
114 };
115
116
117 inline const IDBCursor::Source& IDBCursor::source() const
118 {
119     return m_source;
120 }
121
122 inline IDBCursorDirection IDBCursor::direction() const
123 {
124     return m_info.cursorDirection();
125 }
126
127 } // namespace WebCore
128
129 #endif // ENABLE(INDEXED_DATABASE)