IndexedDB 2.0: Encapsulate cursor iteration parameters for easy future expansion.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / UniqueIDBDatabaseTransaction.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 "IDBTransactionInfo.h"
31 #include "UniqueIDBDatabaseConnection.h"
32 #include <wtf/Ref.h>
33 #include <wtf/RefCounted.h>
34
35 namespace WebCore {
36
37 class IDBCursorInfo;
38 class IDBDatabaseInfo;
39 class IDBError;
40 class IDBIndexInfo;
41 class IDBKeyData;
42 class IDBObjectStoreInfo;
43 class IDBRequestData;
44 class IDBValue;
45
46 struct IDBGetAllRecordsData;
47 struct IDBGetRecordData;
48 struct IDBIterateCursorData;
49 struct IDBKeyRangeData;
50
51 namespace IDBServer {
52
53 class UniqueIDBDatabaseConnection;
54
55 class UniqueIDBDatabaseTransaction : public RefCounted<UniqueIDBDatabaseTransaction> {
56 public:
57     static Ref<UniqueIDBDatabaseTransaction> create(UniqueIDBDatabaseConnection&, const IDBTransactionInfo&);
58
59     ~UniqueIDBDatabaseTransaction();
60
61     UniqueIDBDatabaseConnection& databaseConnection() { return m_databaseConnection.get(); }
62     const IDBTransactionInfo& info() const { return m_transactionInfo; }
63     bool isVersionChange() const;
64     bool isReadOnly() const;
65
66     IDBDatabaseInfo* originalDatabaseInfo() const;
67
68     void abort();
69     void abortWithoutCallback();
70     void commit();
71
72     void createObjectStore(const IDBRequestData&, const IDBObjectStoreInfo&);
73     void deleteObjectStore(const IDBRequestData&, const String& objectStoreName);
74     void renameObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& newName);
75     void clearObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier);
76     void createIndex(const IDBRequestData&, const IDBIndexInfo&);
77     void deleteIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& indexName);
78     void renameIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName);
79     void putOrAdd(const IDBRequestData&, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode);
80     void getRecord(const IDBRequestData&, const IDBGetRecordData&);
81     void getAllRecords(const IDBRequestData&, const IDBGetAllRecordsData&);
82     void getCount(const IDBRequestData&, const IDBKeyRangeData&);
83     void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&);
84     void openCursor(const IDBRequestData&, const IDBCursorInfo&);
85     void iterateCursor(const IDBRequestData&, const IDBIterateCursorData&);
86
87     void didActivateInBackingStore(const IDBError&);
88
89     const Vector<uint64_t>& objectStoreIdentifiers();
90
91 private:
92     UniqueIDBDatabaseTransaction(UniqueIDBDatabaseConnection&, const IDBTransactionInfo&);
93
94     Ref<UniqueIDBDatabaseConnection> m_databaseConnection;
95     IDBTransactionInfo m_transactionInfo;
96
97     std::unique_ptr<IDBDatabaseInfo> m_originalDatabaseInfo;
98
99     Vector<uint64_t> m_objectStoreIdentifiers;
100 };
101
102 } // namespace IDBServer
103 } // namespace WebCore
104
105 #endif // ENABLE(INDEXED_DATABASE)