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