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