Modern IDB: Pipe through cursor functions from client to server.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / client / IDBCursorImpl.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 #ifndef IDBCursorImpl_h
27 #define IDBCursorImpl_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBAnyImpl.h"
32 #include "IDBCursorInfo.h"
33 #include "IDBCursorWithValue.h"
34
35 namespace WebCore {
36
37 struct IDBGetResult;
38
39 namespace IDBClient {
40
41 class IDBIndex;
42 class IDBObjectStore;
43 class IDBTransaction;
44
45 class IDBCursor : public WebCore::IDBCursorWithValue {
46 public:
47     static Ref<IDBCursor> create(IDBTransaction&, IDBIndex&, const IDBCursorInfo&);
48
49     virtual ~IDBCursor();
50
51     // Implement the IDL
52     virtual const String& direction() const override final;
53     virtual const Deprecated::ScriptValue& key() const override final;
54     virtual const Deprecated::ScriptValue& primaryKey() const override final;
55     virtual const Deprecated::ScriptValue& value() const override final;
56     virtual IDBAny* source() override final;
57
58     virtual RefPtr<WebCore::IDBRequest> update(JSC::ExecState&, Deprecated::ScriptValue&, ExceptionCode&) override final;
59     virtual void advance(unsigned long, ExceptionCode&) override final;
60     virtual void continueFunction(ScriptExecutionContext*, ExceptionCode&) override final;
61     virtual void continueFunction(ScriptExecutionContext*, const Deprecated::ScriptValue& key, ExceptionCode&) override final;
62     virtual RefPtr<WebCore::IDBRequest> deleteFunction(ScriptExecutionContext*, ExceptionCode&) override final;
63
64     void continueFunction(const IDBKeyData&, ExceptionCode&);
65
66     const IDBCursorInfo& info() const { return m_info; }
67
68     void setRequest(IDBRequest& request) { m_request = &request; }
69     void clearRequest() { m_request = nullptr; }
70     IDBRequest* request() { return m_request; }
71
72     void setGetResult(const IDBGetResult&);
73
74     virtual bool isKeyCursor() const override { return true; }
75
76 protected:
77     IDBCursor(IDBTransaction&, IDBObjectStore&, const IDBCursorInfo&);
78     IDBCursor(IDBTransaction&, IDBIndex&, const IDBCursorInfo&);
79
80 private:
81     IDBCursorInfo m_info;
82     Ref<IDBAny> m_source;
83     IDBObjectStore* m_objectStore { nullptr };
84     IDBIndex* m_index { nullptr };
85     IDBRequest* m_request;
86
87     bool sourcesDeleted() const;
88     IDBObjectStore& effectiveObjectStore() const;
89     IDBTransaction& transaction() const;
90
91     void uncheckedIteratorCursor(const IDBKeyData&, unsigned long count);
92
93     bool m_gotValue { false };
94
95     IDBKeyData m_currentPrimaryKeyData;
96
97     // FIXME: When ditching Legacy IDB and combining this implementation with the abstract IDBCursor,
98     // these Deprecated::ScriptValue members should be JSValues instead.
99     Deprecated::ScriptValue m_deprecatedCurrentKey;
100     Deprecated::ScriptValue m_deprecatedCurrentPrimaryKey;
101     Deprecated::ScriptValue m_deprecatedCurrentValue;
102 };
103
104 } // namespace IDBClient
105 } // namespace WebCore
106
107 #endif // ENABLE(INDEXED_DATABASE)
108 #endif // IDBCursorImpl_h