Modern IDB: IDBObjectStore.deleteIndex() support.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / MemoryIndex.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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef MemoryIndex_h
27 #define MemoryIndex_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBGetResult.h"
32 #include "IDBIndexInfo.h"
33 #include "IDBKeyData.h"
34 #include "IndexValueStore.h"
35 #include "MemoryIndexCursor.h"
36 #include <set>
37 #include <wtf/HashMap.h>
38
39 namespace WebCore {
40
41 class IDBError;
42 class IndexKey;
43 class ThreadSafeDataBuffer;
44
45 struct IDBKeyRangeData;
46
47 namespace IndexedDB {
48 enum class IndexRecordType;
49 }
50
51 namespace IDBServer {
52
53 class MemoryBackingStoreTransaction;
54 class MemoryObjectStore;
55
56 class MemoryIndex {
57     friend std::unique_ptr<MemoryIndex> std::make_unique<MemoryIndex>(const WebCore::IDBIndexInfo&, WebCore::IDBServer::MemoryObjectStore&);
58 public:
59     static std::unique_ptr<MemoryIndex> create(const IDBIndexInfo&, MemoryObjectStore&);
60
61     ~MemoryIndex();
62
63     const IDBIndexInfo& info() const { return m_info; }
64
65     IDBGetResult getResultForKeyRange(IndexedDB::IndexRecordType, const IDBKeyRangeData&) const;
66     uint64_t countForKeyRange(const IDBKeyRangeData&);
67
68     IDBError putIndexKey(const IDBKeyData&, const IndexKey&);
69
70     void removeEntriesWithValueKey(const IDBKeyData&);
71     void removeRecord(const IDBKeyData&, const IndexKey&);
72
73     void objectStoreCleared();
74     void clearIndexValueStore();
75     void replaceIndexValueStore(std::unique_ptr<IndexValueStore>&&);
76
77     MemoryIndexCursor* maybeOpenCursor(const IDBCursorInfo&);
78
79     IndexValueStore* valueStore() { return m_records.get(); }
80
81     MemoryObjectStore& objectStore() { return m_objectStore; }
82
83     void cursorDidBecomeClean(MemoryIndexCursor&);
84     void cursorDidBecomeDirty(MemoryIndexCursor&);
85
86     void notifyCursorsOfValueChange(const IDBKeyData& indexKey, const IDBKeyData& primaryKey);
87
88 private:
89     MemoryIndex(const IDBIndexInfo&, MemoryObjectStore&);
90
91     uint64_t recordCountForKey(const IDBKeyData&) const;
92
93     void notifyCursorsOfAllRecordsChanged();
94
95     IDBIndexInfo m_info;
96     MemoryObjectStore& m_objectStore;
97
98     std::unique_ptr<IndexValueStore> m_records;
99
100     HashMap<IDBResourceIdentifier, std::unique_ptr<MemoryIndexCursor>> m_cursors;
101     HashSet<MemoryIndexCursor*> m_cleanCursors;
102 };
103
104 } // namespace IDBServer
105 } // namespace WebCore
106
107 #endif // ENABLE(INDEXED_DATABASE)
108 #endif // MemoryIndex_h