Purge PassRefPtr in WebCore/Modules - 3
[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 "IDBDatabaseCallbacks.h"
35 #include "IDBDatabaseMetadata.h"
36 #include "IDBObjectStore.h"
37 #include "IDBTransaction.h"
38 #include "IndexedDB.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 ScriptExecutionContext;
49
50 typedef int ExceptionCode;
51
52 class IDBDatabase final : public RefCounted<IDBDatabase>, public ScriptWrappable, public EventTargetWithInlineData, public ActiveDOMObject {
53 public:
54     static Ref<IDBDatabase> create(ScriptExecutionContext*, PassRefPtr<IDBDatabaseBackend>, PassRefPtr<IDBDatabaseCallbacks>);
55     ~IDBDatabase();
56
57     void setMetadata(const IDBDatabaseMetadata& metadata) { m_metadata = metadata; }
58     void transactionCreated(IDBTransaction*);
59     void transactionFinished(IDBTransaction*);
60
61     // Implement the IDL
62     const String name() const { return m_metadata.name; }
63     uint64_t version() const;
64     PassRefPtr<DOMStringList> objectStoreNames() const;
65
66     PassRefPtr<IDBObjectStore> createObjectStore(const String& name, const Dictionary&, ExceptionCode&);
67     PassRefPtr<IDBObjectStore> createObjectStore(const String& name, const IDBKeyPath&, bool autoIncrement, ExceptionCode&);
68     PassRefPtr<IDBTransaction> transaction(ScriptExecutionContext* context, PassRefPtr<DOMStringList> scope, const String& mode, ExceptionCode& ec) { return transaction(context, *scope, mode, ec); }
69     PassRefPtr<IDBTransaction> transaction(ScriptExecutionContext*, const Vector<String>&, const String& mode, ExceptionCode&);
70     PassRefPtr<IDBTransaction> transaction(ScriptExecutionContext*, const String&, const String& mode, ExceptionCode&);
71     void deleteObjectStore(const String& name, ExceptionCode&);
72     void close();
73
74     // IDBDatabaseCallbacks
75     virtual void onVersionChange(uint64_t oldVersion, uint64_t newVersion, IndexedDB::VersionNullness newVersionNullness);
76     virtual void onAbort(int64_t, PassRefPtr<IDBDatabaseError>);
77     virtual void onComplete(int64_t);
78
79     // EventTarget
80     virtual EventTargetInterface eventTargetInterface() const override final { return IDBDatabaseEventTargetInterfaceType; }
81     virtual ScriptExecutionContext* scriptExecutionContext() const override final { return ActiveDOMObject::scriptExecutionContext(); }
82
83     bool isClosePending() const { return m_closePending; }
84     void forceClose();
85     const IDBDatabaseMetadata metadata() const { return m_metadata; }
86     void enqueueEvent(PassRefPtr<Event>);
87
88     using EventTarget::dispatchEvent;
89     virtual bool dispatchEvent(PassRefPtr<Event>) override;
90
91     int64_t findObjectStoreId(const String& name) const;
92     bool containsObjectStore(const String& name) const
93     {
94         return findObjectStoreId(name) != IDBObjectStoreMetadata::InvalidId;
95     }
96
97     IDBDatabaseBackend* backend() const { return m_backend.get(); }
98
99     static int64_t nextTransactionId();
100
101     using RefCounted<IDBDatabase>::ref;
102     using RefCounted<IDBDatabase>::deref;
103
104     // ActiveDOMObject API.
105     bool hasPendingActivity() const override;
106
107 private:
108     IDBDatabase(ScriptExecutionContext*, PassRefPtr<IDBDatabaseBackend>, PassRefPtr<IDBDatabaseCallbacks>);
109
110     // ActiveDOMObject API.
111     void stop() override;
112     const char* activeDOMObjectName() const override;
113     bool canSuspendForPageCache() const override;
114
115     // EventTarget
116     virtual void refEventTarget() override final { ref(); }
117     virtual void derefEventTarget() override final { deref(); }
118
119     void closeConnection();
120
121     IDBDatabaseMetadata m_metadata;
122     RefPtr<IDBDatabaseBackend> m_backend;
123     RefPtr<IDBTransaction> m_versionChangeTransaction;
124     typedef HashMap<int64_t, IDBTransaction*> TransactionMap;
125     TransactionMap m_transactions;
126
127     bool m_closePending;
128     bool m_isClosed;
129     bool m_contextStopped;
130
131     // Keep track of the versionchange events waiting to be fired on this
132     // database so that we can cancel them if the database closes.
133     Vector<RefPtr<Event>> m_enqueuedEvents;
134
135     RefPtr<IDBDatabaseCallbacks> m_databaseCallbacks;
136 };
137
138 } // namespace WebCore
139
140 #endif
141
142 #endif // IDBDatabase_h