IndexedDB: Propagate DOMRequestState to IndexedDB binding utility functions
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBRequest.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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef IDBRequest_h
30 #define IDBRequest_h
31
32 #if ENABLE(INDEXED_DATABASE)
33
34 #include "ActiveDOMObject.h"
35 #include "DOMError.h"
36 #include "DOMRequestState.h"
37 #include "DOMStringList.h"
38 #include "Event.h"
39 #include "EventListener.h"
40 #include "EventNames.h"
41 #include "EventTarget.h"
42 #include "IDBAny.h"
43 #include "IDBCallbacks.h"
44 #include "IDBCursor.h"
45 #include "IDBCursorBackendInterface.h"
46 #include "ScriptWrappable.h"
47 #if USE(V8)
48 #include "WorldContextHandle.h"
49 #endif
50
51 namespace WebCore {
52
53 class IDBTransaction;
54
55 typedef int ExceptionCode;
56
57 class IDBRequest : public ScriptWrappable, public IDBCallbacks, public EventTarget, public ActiveDOMObject {
58 public:
59     static PassRefPtr<IDBRequest> create(ScriptExecutionContext*, PassRefPtr<IDBAny> source, IDBTransaction*);
60     static PassRefPtr<IDBRequest> create(ScriptExecutionContext*, PassRefPtr<IDBAny> source, IDBTransactionBackendInterface::TaskType, IDBTransaction*);
61     virtual ~IDBRequest();
62
63     PassRefPtr<IDBAny> result(ExceptionCode&) const;
64     unsigned short errorCode(ExceptionCode&) const;
65     PassRefPtr<DOMError> error(ExceptionCode&) const;
66     String webkitErrorMessage(ExceptionCode&) const;
67     PassRefPtr<IDBAny> source() const;
68     PassRefPtr<IDBTransaction> transaction() const;
69     void preventPropagation() { m_preventPropagation = true; }
70
71     // Defined in the IDL
72     enum ReadyState {
73         PENDING = 1,
74         DONE = 2,
75         EarlyDeath = 3
76     };
77
78     const String& readyState() const;
79
80     DEFINE_ATTRIBUTE_EVENT_LISTENER(success);
81     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
82
83     void markEarlyDeath();
84     void setCursorDetails(IDBCursorBackendInterface::CursorType, IDBCursor::Direction);
85     void setPendingCursor(PassRefPtr<IDBCursor>);
86     void finishCursor();
87     void abort();
88
89     // IDBCallbacks
90     virtual void onError(PassRefPtr<IDBDatabaseError>);
91     virtual void onSuccess(PassRefPtr<DOMStringList>);
92     virtual void onSuccess(PassRefPtr<IDBCursorBackendInterface>, PassRefPtr<IDBKey>, PassRefPtr<IDBKey> primaryKey, PassRefPtr<SerializedScriptValue>);
93     virtual void onSuccess(PassRefPtr<IDBKey>);
94     virtual void onSuccess(PassRefPtr<IDBTransactionBackendInterface>);
95     virtual void onSuccess(PassRefPtr<SerializedScriptValue>);
96     virtual void onSuccess(PassRefPtr<SerializedScriptValue>, PassRefPtr<IDBKey>, const IDBKeyPath&);
97     virtual void onSuccess(int64_t);
98     virtual void onSuccess();
99     virtual void onSuccess(PassRefPtr<IDBKey>, PassRefPtr<IDBKey> primaryKey, PassRefPtr<SerializedScriptValue>);
100     virtual void onSuccessWithPrefetch(const Vector<RefPtr<IDBKey> >&, const Vector<RefPtr<IDBKey> >&, const Vector<RefPtr<SerializedScriptValue> >&) { ASSERT_NOT_REACHED(); } // Not implemented. Callback should not reach the renderer side.
101
102     // ActiveDOMObject
103     virtual bool hasPendingActivity() const OVERRIDE;
104     virtual void stop() OVERRIDE;
105
106     // EventTarget
107     virtual const AtomicString& interfaceName() const;
108     virtual ScriptExecutionContext* scriptExecutionContext() const;
109     virtual bool dispatchEvent(PassRefPtr<Event>);
110     bool dispatchEvent(PassRefPtr<Event> event, ExceptionCode& ec) { return EventTarget::dispatchEvent(event, ec); }
111     virtual void uncaughtExceptionInEventHandler();
112
113     void transactionDidFinishAndDispatch();
114
115     using ThreadSafeRefCounted<IDBCallbacks>::ref;
116     using ThreadSafeRefCounted<IDBCallbacks>::deref;
117
118     IDBTransactionBackendInterface::TaskType taskType() { return m_taskType; }
119
120     DOMRequestState* requestState() { return &m_requestState; }
121
122 protected:
123     IDBRequest(ScriptExecutionContext*, PassRefPtr<IDBAny> source, IDBTransactionBackendInterface::TaskType, IDBTransaction*);
124     void enqueueEvent(PassRefPtr<Event>);
125     virtual bool shouldEnqueueEvent() const;
126     void onSuccessInternal(const ScriptValue&);
127
128     RefPtr<IDBAny> m_result;
129     unsigned short m_errorCode;
130     String m_errorMessage;
131     RefPtr<DOMError> m_error;
132     bool m_contextStopped;
133     RefPtr<IDBTransaction> m_transaction;
134     ReadyState m_readyState;
135     bool m_requestAborted; // May be aborted by transaction then receive async onsuccess; ignore vs. assert.
136
137 private:
138     // EventTarget
139     virtual void refEventTarget() { ref(); }
140     virtual void derefEventTarget() { deref(); }
141     virtual EventTargetData* eventTargetData();
142     virtual EventTargetData* ensureEventTargetData();
143
144     PassRefPtr<IDBCursor> getResultCursor();
145     void setResultCursor(PassRefPtr<IDBCursor>, PassRefPtr<IDBKey>, PassRefPtr<IDBKey> primaryKey, const ScriptValue&);
146
147     RefPtr<IDBAny> m_source;
148     const IDBTransactionBackendInterface::TaskType m_taskType;
149
150     bool m_hasPendingActivity;
151     Vector<RefPtr<Event> > m_enqueuedEvents;
152
153     // Only used if the result type will be a cursor.
154     IDBCursorBackendInterface::CursorType m_cursorType;
155     IDBCursor::Direction m_cursorDirection;
156     bool m_cursorFinished;
157     RefPtr<IDBCursor> m_pendingCursor;
158     RefPtr<IDBKey> m_cursorKey;
159     RefPtr<IDBKey> m_cursorPrimaryKey;
160     ScriptValue m_cursorValue;
161     bool m_didFireUpgradeNeededEvent;
162     bool m_preventPropagation;
163
164     EventTargetData m_eventTargetData;
165     DOMRequestState m_requestState;
166 };
167
168 } // namespace WebCore
169
170 #endif // ENABLE(INDEXED_DATABASE)
171
172 #endif // IDBRequest_h