IndexedDB: Snapshot metadata in front end to avoid IPC round-trips
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBDatabase.h
1 /*
2  * Copyright (C) 2010 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 IDBDatabase_h
27 #define IDBDatabase_h
28
29 #include "ActiveDOMObject.h"
30 #include "DOMStringList.h"
31 #include "Dictionary.h"
32 #include "Event.h"
33 #include "EventTarget.h"
34 #include "IDBDatabaseBackendInterface.h"
35 #include "IDBDatabaseCallbacksImpl.h"
36 #include "IDBMetadata.h"
37 #include "IDBObjectStore.h"
38 #include "IDBTransaction.h"
39 #include <wtf/PassRefPtr.h>
40 #include <wtf/RefCounted.h>
41 #include <wtf/RefPtr.h>
42
43 #if ENABLE(INDEXED_DATABASE)
44
45 namespace WebCore {
46
47 class IDBVersionChangeRequest;
48 class ScriptExecutionContext;
49
50 typedef int ExceptionCode;
51
52 class IDBDatabase : public RefCounted<IDBDatabase>, public EventTarget, public ActiveDOMObject {
53 public:
54     static PassRefPtr<IDBDatabase> create(ScriptExecutionContext*, PassRefPtr<IDBDatabaseBackendInterface>);
55     ~IDBDatabase();
56
57     void transactionCreated(IDBTransaction*);
58     void transactionFinished(IDBTransaction*);
59
60     // Implement the IDL
61     const String name() const { return m_metadata.name; }
62     const String version() const { return m_metadata.version; }
63     PassRefPtr<DOMStringList> objectStoreNames() const;
64
65     // FIXME: Try to modify the code generator so this is unneeded.
66     PassRefPtr<IDBObjectStore> createObjectStore(const String& name, ExceptionCode& ec) { return createObjectStore(name, Dictionary(), ec); }
67     PassRefPtr<IDBObjectStore> createObjectStore(const String& name, const Dictionary&, ExceptionCode&);
68     PassRefPtr<IDBTransaction> transaction(ScriptExecutionContext*, PassRefPtr<DOMStringList>, const String& mode, ExceptionCode&);
69     PassRefPtr<IDBTransaction> transaction(ScriptExecutionContext*, const String&, const String& mode, ExceptionCode&);
70     PassRefPtr<IDBTransaction> transaction(ScriptExecutionContext*, PassRefPtr<DOMStringList>, unsigned short mode, ExceptionCode&);
71     PassRefPtr<IDBTransaction> transaction(ScriptExecutionContext*, const String&, unsigned short mode, ExceptionCode&);
72     void deleteObjectStore(const String& name, ExceptionCode&);
73     PassRefPtr<IDBVersionChangeRequest> setVersion(ScriptExecutionContext*, const String& version, ExceptionCode&);
74     void close();
75
76     DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
77     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
78     DEFINE_ATTRIBUTE_EVENT_LISTENER(versionchange);
79
80     // IDBDatabaseCallbacks
81     virtual void onVersionChange(const String& requestedVersion);
82
83     // ActiveDOMObject
84     virtual void stop() OVERRIDE;
85
86     // EventTarget
87     virtual const AtomicString& interfaceName() const;
88     virtual ScriptExecutionContext* scriptExecutionContext() const;
89
90     void registerFrontendCallbacks();
91     const IDBDatabaseMetadata metadata() const { return m_metadata; }
92     void enqueueEvent(PassRefPtr<Event>);
93     bool dispatchEvent(PassRefPtr<Event> event, ExceptionCode& ec) { return EventTarget::dispatchEvent(event, ec); }
94     virtual bool dispatchEvent(PassRefPtr<Event>);
95
96     using RefCounted<IDBDatabase>::ref;
97     using RefCounted<IDBDatabase>::deref;
98
99 private:
100     IDBDatabase(ScriptExecutionContext*, PassRefPtr<IDBDatabaseBackendInterface>);
101
102     // EventTarget
103     virtual void refEventTarget() { ref(); }
104     virtual void derefEventTarget() { deref(); }
105     virtual EventTargetData* eventTargetData();
106     virtual EventTargetData* ensureEventTargetData();
107
108     void closeConnection();
109
110     IDBDatabaseMetadata m_metadata;
111     RefPtr<IDBDatabaseBackendInterface> m_backend;
112     RefPtr<IDBTransaction> m_versionChangeTransaction;
113     HashSet<IDBTransaction*> m_transactions;
114
115     bool m_closePending;
116     bool m_contextStopped;
117
118     EventTargetData m_eventTargetData;
119
120     // Keep track of the versionchange events waiting to be fired on this
121     // database so that we can cancel them if the database closes.
122     Vector<RefPtr<Event> > m_enqueuedEvents;
123
124     RefPtr<IDBDatabaseCallbacksImpl> m_databaseCallbacks;
125 };
126
127 } // namespace WebCore
128
129 #endif
130
131 #endif // IDBDatabase_h