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