Fix IndexedDB build with JSC
[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 "DOMStringList.h"
36 #include "Event.h"
37 #include "EventListener.h"
38 #include "EventNames.h"
39 #include "EventTarget.h"
40 #include "IDBAny.h"
41 #include "IDBCallbacks.h"
42
43 namespace WebCore {
44
45 class IDBTransaction;
46
47 typedef int ExceptionCode;
48
49 class IDBRequest : public IDBCallbacks, public EventTarget, public ActiveDOMObject {
50 public:
51     static PassRefPtr<IDBRequest> create(ScriptExecutionContext*, PassRefPtr<IDBAny> source, IDBTransaction*);
52     virtual ~IDBRequest();
53
54     PassRefPtr<IDBAny> result(ExceptionCode&) const;
55     unsigned short errorCode(ExceptionCode&) const;
56     String webkitErrorMessage(ExceptionCode&) const;
57     PassRefPtr<IDBAny> source() const;
58     PassRefPtr<IDBTransaction> transaction() const;
59
60     // Defined in the IDL
61     enum ReadyState {
62         LOADING = 1,
63         DONE = 2,
64         EarlyDeath = 3
65     };
66     unsigned short readyState() const;
67
68     DEFINE_ATTRIBUTE_EVENT_LISTENER(success);
69     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
70
71     void markEarlyDeath();
72     bool resetReadyState(IDBTransaction*);
73     void setCursorType(IDBCursorBackendInterface::CursorType);
74     void setCursor(PassRefPtr<IDBCursor>);
75     void finishCursor();
76     IDBAny* source();
77     void abort();
78
79     // IDBCallbacks
80     virtual void onError(PassRefPtr<IDBDatabaseError>);
81     virtual void onSuccess(PassRefPtr<DOMStringList>);
82     virtual void onSuccess(PassRefPtr<IDBDatabaseBackendInterface>);
83     virtual void onSuccess(PassRefPtr<IDBCursorBackendInterface>);
84     virtual void onSuccess(PassRefPtr<IDBKey>);
85     virtual void onSuccess(PassRefPtr<IDBTransactionBackendInterface>);
86     virtual void onSuccess(PassRefPtr<SerializedScriptValue>);
87     virtual void onSuccessWithContinuation();
88     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.
89     virtual void onBlocked();
90
91     // ActiveDOMObject
92     virtual bool hasPendingActivity() const OVERRIDE;
93     virtual void stop() OVERRIDE;
94
95     // EventTarget
96     virtual const AtomicString& interfaceName() const;
97     virtual ScriptExecutionContext* scriptExecutionContext() const;
98     virtual bool dispatchEvent(PassRefPtr<Event>);
99     bool dispatchEvent(PassRefPtr<Event> event, ExceptionCode& ec) { return EventTarget::dispatchEvent(event, ec); }
100     virtual void uncaughtExceptionInEventHandler();
101
102     using ThreadSafeRefCounted<IDBCallbacks>::ref;
103     using ThreadSafeRefCounted<IDBCallbacks>::deref;
104
105 protected:
106     IDBRequest(ScriptExecutionContext*, PassRefPtr<IDBAny> source, IDBTransaction*);
107     void enqueueEvent(PassRefPtr<Event>);
108     RefPtr<IDBAny> m_result;
109     unsigned short m_errorCode;
110     String m_errorMessage;
111
112 private:
113     // EventTarget
114     virtual void refEventTarget() { ref(); }
115     virtual void derefEventTarget() { deref(); }
116     virtual EventTargetData* eventTargetData();
117     virtual EventTargetData* ensureEventTargetData();
118
119     void setResultCursor(PassRefPtr<IDBCursor>, IDBCursorBackendInterface::CursorType);
120
121     RefPtr<IDBAny> m_source;
122     RefPtr<IDBTransaction> m_transaction;
123
124     ReadyState m_readyState;
125     bool m_requestFinished; // Is it possible that we'll fire any more events? If not, we're finished.
126     bool m_cursorFinished;
127     bool m_contextStopped;
128     Vector<RefPtr<Event> > m_enqueuedEvents;
129
130     // Only used if the result type will be a cursor.
131     IDBCursorBackendInterface::CursorType m_cursorType;
132     RefPtr<IDBCursor> m_cursor;
133
134     EventTargetData m_eventTargetData;
135 };
136
137 } // namespace WebCore
138
139 #endif // ENABLE(INDEXED_DATABASE)
140
141 #endif // IDBRequest_h