1704cee70af5d40960d5d15aa0eb22a19d6ab9ea
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / SQLiteIDBCursor.h
1 /*
2  * Copyright (C) 2014, 2016 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 #ifndef SQLiteIDBCursor_h
26 #define SQLiteIDBCursor_h
27
28 #if ENABLE(INDEXED_DATABASE)
29
30 #include "IDBDatabaseBackend.h"
31 #include "IDBKeyData.h"
32 #include "IDBKeyRangeData.h"
33 #include "IDBResourceIdentifier.h"
34 #include "SQLiteStatement.h"
35 #include <wtf/Noncopyable.h>
36
37 namespace WebCore {
38
39 class IDBCursorInfo;
40 class IDBGetResult;
41
42 namespace IDBServer {
43
44 class SQLiteIDBTransaction;
45
46 class SQLiteIDBCursor {
47     WTF_MAKE_NONCOPYABLE(SQLiteIDBCursor);
48 public:
49     static std::unique_ptr<SQLiteIDBCursor> maybeCreate(SQLiteIDBTransaction&, const IDBCursorInfo&);
50     static std::unique_ptr<SQLiteIDBCursor> maybeCreateBackingStoreCursor(SQLiteIDBTransaction&, const uint64_t objectStoreIdentifier, const uint64_t indexIdentifier, const IDBKeyRangeData&);
51
52     SQLiteIDBCursor(SQLiteIDBTransaction&, const IDBCursorInfo&);
53     SQLiteIDBCursor(SQLiteIDBTransaction&, uint64_t objectStoreID, uint64_t indexID, const IDBKeyRangeData&);
54
55     ~SQLiteIDBCursor();
56
57     const IDBResourceIdentifier& identifier() const { return m_cursorIdentifier; }
58     SQLiteIDBTransaction* transaction() const { return m_transaction; }
59
60     int64_t objectStoreID() const { return m_objectStoreID; }
61
62     const IDBKeyData& currentKey() const { return m_currentKey; }
63     const IDBKeyData& currentPrimaryKey() const { return m_currentPrimaryKey; }
64     const Vector<uint8_t>& currentValueBuffer() const { return m_currentValueBuffer; }
65
66     bool advance(uint64_t count);
67     bool iterate(const IDBKeyData& targetKey);
68
69     bool didComplete() const { return m_completed; }
70     bool didError() const { return m_errored; }
71
72     void objectStoreRecordsChanged();
73
74     void currentData(IDBGetResult&);
75
76 private:
77     bool establishStatement();
78     bool createSQLiteStatement(const String& sql);
79     bool bindArguments();
80
81     void resetAndRebindStatement();
82
83     enum class AdvanceResult {
84         Success,
85         Failure,
86         ShouldAdvanceAgain
87     };
88
89     AdvanceResult internalAdvanceOnce();
90     bool advanceOnce();
91     bool advanceUnique();
92
93     SQLiteIDBTransaction* m_transaction;
94     IDBResourceIdentifier m_cursorIdentifier;
95     int64_t m_objectStoreID;
96     int64_t m_indexID { IDBIndexMetadata::InvalidId };
97     IndexedDB::CursorDirection m_cursorDirection { IndexedDB::CursorDirection::Next };
98     IDBKeyRangeData m_keyRange;
99
100     IDBKeyData m_currentLowerKey;
101     IDBKeyData m_currentUpperKey;
102
103     int64_t m_currentRecordID { -1 };
104     IDBKeyData m_currentKey;
105     IDBKeyData m_currentPrimaryKey;
106     Vector<uint8_t> m_currentValueBuffer;
107
108     std::unique_ptr<SQLiteStatement> m_statement;
109     bool m_statementNeedsReset { false };
110     int64_t m_boundID { 0 };
111
112     bool m_completed { false };
113     bool m_errored { false };
114
115     bool m_backingStoreCursor { false };
116 };
117
118
119 } // namespace IDBServer
120 } // namespace WebCore
121
122 #endif // ENABLE(INDEXED_DATABASE)
123 #endif // SQLiteIDBCursor_h