IndexedDB: Snapshot metadata in front end to avoid IPC round-trips
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBObjectStoreBackendImpl.h
1 /*
2  * Copyright (C) 2011 Google 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef IDBObjectStoreBackendImpl_h
27 #define IDBObjectStoreBackendImpl_h
28
29 #include "IDBDatabaseBackendImpl.h"
30 #include "IDBKeyPath.h"
31 #include "IDBMetadata.h"
32 #include "IDBObjectStoreBackendInterface.h"
33 #include <wtf/HashMap.h>
34 #include <wtf/text/StringHash.h>
35
36 #if ENABLE(INDEXED_DATABASE)
37
38 namespace WebCore {
39
40 class IDBDatabaseBackendImpl;
41 class IDBIndexBackendImpl;
42 class IDBTransactionBackendInterface;
43 class ScriptExecutionContext;
44 struct IDBObjectStoreMetadata;
45
46 class IDBObjectStoreBackendImpl : public IDBObjectStoreBackendInterface {
47 public:
48     static PassRefPtr<IDBObjectStoreBackendImpl> create(const IDBDatabaseBackendImpl* database, int64_t id, const String& name, const IDBKeyPath& keyPath, bool autoIncrement)
49     {
50         return adoptRef(new IDBObjectStoreBackendImpl(database, id, name, keyPath, autoIncrement));
51     }
52     static PassRefPtr<IDBObjectStoreBackendImpl> create(const IDBDatabaseBackendImpl* database, const String& name, const IDBKeyPath& keyPath, bool autoIncrement)
53     {
54         return adoptRef(new IDBObjectStoreBackendImpl(database, name, keyPath, autoIncrement));
55     }
56     virtual ~IDBObjectStoreBackendImpl();
57
58     static const int64_t InvalidId = 0;
59     int64_t id() const
60     {
61         ASSERT(m_id != InvalidId);
62         return m_id;
63     }
64     void setId(int64_t id) { m_id = id; }
65
66     virtual IDBObjectStoreMetadata metadata() const;
67     virtual String name() const { return m_name; }
68     virtual IDBKeyPath keyPath() const { return m_keyPath; }
69     virtual PassRefPtr<DOMStringList> indexNames() const;
70     virtual bool autoIncrement() const { return m_autoIncrement; }
71
72     virtual void get(PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
73     virtual void put(PassRefPtr<SerializedScriptValue>, PassRefPtr<IDBKey>, PutMode, PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
74     virtual void deleteFunction(PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
75     virtual void clear(PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
76
77     virtual PassRefPtr<IDBIndexBackendInterface> createIndex(const String& name, const IDBKeyPath&, bool unique, bool multiEntry, IDBTransactionBackendInterface*, ExceptionCode&);
78     virtual PassRefPtr<IDBIndexBackendInterface> index(const String& name, ExceptionCode&);
79     virtual void deleteIndex(const String& name, IDBTransactionBackendInterface*, ExceptionCode&);
80
81     virtual void openCursor(PassRefPtr<IDBKeyRange> range, unsigned short direction, PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
82     virtual void count(PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
83
84     static bool populateIndex(IDBBackingStore&, int64_t databaseId, int64_t objectStoreId, PassRefPtr<IDBIndexBackendImpl>);
85
86 private:
87     IDBObjectStoreBackendImpl(const IDBDatabaseBackendImpl*, int64_t databaseId, const String& name, const IDBKeyPath&, bool autoIncrement);
88     IDBObjectStoreBackendImpl(const IDBDatabaseBackendImpl*, const String& name, const IDBKeyPath&, bool autoIncrement);
89
90     void loadIndexes();
91     PassRefPtr<IDBKey> genAutoIncrementKey();
92     void resetAutoIncrementKeyCache() { m_autoIncrementNumber = -1; }
93
94     static void getInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>);
95     static void putInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<SerializedScriptValue>, PassRefPtr<IDBKey>, PutMode, PassRefPtr<IDBCallbacks>, PassRefPtr<IDBTransactionBackendInterface>);
96     static void deleteInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>);
97     static void clearInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBCallbacks>);
98     static void createIndexInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBIndexBackendImpl>, PassRefPtr<IDBTransactionBackendInterface>);
99     static void deleteIndexInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBIndexBackendImpl>, PassRefPtr<IDBTransactionBackendInterface>);
100     static void openCursorInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBKeyRange> range, unsigned short direction, PassRefPtr<IDBCallbacks>, PassRefPtr<IDBTransactionBackendInterface>);
101     static void countInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>, PassRefPtr<IDBTransactionBackendInterface>);
102
103     // These are used as setVersion transaction abort tasks.
104     static void removeIndexFromMap(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBIndexBackendImpl>);
105     static void addIndexToMap(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBIndexBackendImpl>);
106     static void revertAutoIncrementKeyCache(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>);
107
108     PassRefPtr<IDBBackingStore> backingStore() const { return m_database->backingStore(); }
109     int64_t databaseId() const { return m_database->id(); }
110
111     const IDBDatabaseBackendImpl* m_database;
112     int64_t m_id;
113     String m_name;
114     IDBKeyPath m_keyPath;
115     bool m_autoIncrement;
116
117     typedef HashMap<String, RefPtr<IDBIndexBackendImpl> > IndexMap;
118     IndexMap m_indexes;
119     int64_t m_autoIncrementNumber;
120 };
121
122 } // namespace WebCore
123
124 #endif
125
126 #endif // IDBObjectStoreBackendImpl_h