dom/indexedDB/IDBRequest.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_indexeddb_idbrequest_h__
   8 #define mozilla_dom_indexeddb_idbrequest_h__
   9
  10 #include "mozilla/dom/indexedDB/IndexedDatabase.h"
  11
  12 #include "mozilla/Attributes.h"
  13 #include "mozilla/EventForwards.h"
  14 #include "mozilla/dom/DOMError.h"
  15 #include "mozilla/dom/IDBRequestBinding.h"
  16 #include "mozilla/ErrorResult.h"
  17 #include "nsCycleCollectionParticipant.h"
  18 #include "nsWrapperCache.h"
  19
  20 #include "mozilla/dom/indexedDB/IDBWrapperCache.h"
  21
  22 class nsIScriptContext;
  23 class nsPIDOMWindow;
  24
  25 namespace mozilla {
  26 class EventChainPostVisitor;
  27 class EventChainPreVisitor;
  28 namespace dom {
  29 class OwningIDBObjectStoreOrIDBIndexOrIDBCursor;
  30 struct ErrorEventInit;
  31 }
  32 }
  33
  34 BEGIN_INDEXEDDB_NAMESPACE
  35
  36 class HelperBase;
  37 class IDBCursor;
  38 class IDBFactory;
  39 class IDBIndex;
  40 class IDBObjectStore;
  41 class IDBTransaction;
  42 class IndexedDBRequestParentBase;
  43
  44 class IDBRequest : public IDBWrapperCache
  45 {
  46 public:
  47   NS_DECL_ISUPPORTS_INHERITED
  48   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(IDBRequest,
  49                                                          IDBWrapperCache)
  50
  51   static
  52   already_AddRefed<IDBRequest> Create(IDBDatabase* aDatabase,
  53                                       IDBTransaction* aTransaction);
  54
  55   static
  56   already_AddRefed<IDBRequest> Create(IDBObjectStore* aSource,
  57                                       IDBDatabase* aDatabase,
  58                                       IDBTransaction* aTransaction);
  59
  60   static
  61   already_AddRefed<IDBRequest> Create(IDBIndex* aSource,
  62                                       IDBDatabase* aDatabase,
  63                                       IDBTransaction* aTransaction);
  64
  65   // nsIDOMEventTarget
  66   virtual nsresult PreHandleEvent(EventChainPreVisitor& aVisitor) MOZ_OVERRIDE;
  67
  68   void GetSource(Nullable<OwningIDBObjectStoreOrIDBIndexOrIDBCursor>& aSource) const;
  69
  70   void Reset();
  71
  72   nsresult NotifyHelperCompleted(HelperBase* aHelper);
  73   void NotifyHelperSentResultsToChildProcess(nsresult aRv);
  74
  75   void SetError(nsresult aRv);
  76
  77   nsresult
  78   GetErrorCode() const
  79 #ifdef DEBUG
  80   ;
  81 #else
  82   {
  83     return mErrorCode;
  84   }
  85 #endif
  86
  87   DOMError* GetError(ErrorResult& aRv);
  88
  89   void
  90   SetActor(IndexedDBRequestParentBase* aActorParent)
  91   {
  92     NS_ASSERTION(!aActorParent || !mActorParent,
  93                  "Shouldn't have more than one!");
  94     mActorParent = aActorParent;
  95   }
  96
  97   IndexedDBRequestParentBase*
  98   GetActorParent() const
  99   {
 100     return mActorParent;
 101   }
 102
 103   void CaptureCaller();
 104
 105   void FillScriptErrorEvent(ErrorEventInit& aEventInit) const;
 106
 107   bool
 108   IsPending() const
 109   {
 110     return !mHaveResultOrErrorCode;
 111   }
 112
 113 #ifdef MOZ_ENABLE_PROFILER_SPS
 114   uint64_t
 115   GetSerialNumber() const
 116   {
 117     return mSerialNumber;
 118   }
 119 #endif
 120
 121   // nsWrapperCache
 122   virtual JSObject*
 123   WrapObject(JSContext* aCx) MOZ_OVERRIDE;
 124
 125   // WebIDL
 126   nsPIDOMWindow*
 127   GetParentObject() const
 128   {
 129     return GetOwner();
 130   }
 131
 132   void
 133   GetResult(JS::MutableHandle<JS::Value> aResult, ErrorResult& aRv) const;
 134
 135   void
 136   GetResult(JSContext* aCx, JS::MutableHandle<JS::Value> aResult,
 137             ErrorResult& aRv) const
 138   {
 139     GetResult(aResult, aRv);
 140   }
 141
 142   IDBTransaction*
 143   GetTransaction() const
 144   {
 145     NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
 146     return mTransaction;
 147   }
 148
 149   IDBRequestReadyState
 150   ReadyState() const;
 151
 152   IMPL_EVENT_HANDLER(success);
 153   IMPL_EVENT_HANDLER(error);
 154
 155 protected:
 156   explicit IDBRequest(IDBDatabase* aDatabase);
 157   explicit IDBRequest(nsPIDOMWindow* aOwner);
 158   ~IDBRequest();
 159
 160   // At most one of these three fields can be non-null.
 161   nsRefPtr<IDBObjectStore> mSourceAsObjectStore;
 162   nsRefPtr<IDBIndex> mSourceAsIndex;
 163   nsRefPtr<IDBCursor> mSourceAsCursor;
 164
 165   // Check that the above condition holds.
 166 #ifdef DEBUG
 167   void AssertSourceIsCorrect() const;
 168 #else
 169   void AssertSourceIsCorrect() const {}
 170 #endif
 171
 172   nsRefPtr<IDBTransaction> mTransaction;
 173
 174   JS::Heap<JS::Value> mResultVal;
 175   nsRefPtr<mozilla::dom::DOMError> mError;
 176   IndexedDBRequestParentBase* mActorParent;
 177   nsString mFilename;
 178 #ifdef MOZ_ENABLE_PROFILER_SPS
 179   uint64_t mSerialNumber;
 180 #endif
 181   nsresult mErrorCode;
 182   uint32_t mLineNo;
 183   bool mHaveResultOrErrorCode;
 184 };
 185
 186 class IDBOpenDBRequest : public IDBRequest
 187 {
 188 public:
 189   NS_DECL_ISUPPORTS_INHERITED
 190   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(IDBOpenDBRequest, IDBRequest)
 191
 192   static
 193   already_AddRefed<IDBOpenDBRequest>
 194   Create(IDBFactory* aFactory,
 195          nsPIDOMWindow* aOwner,
 196          JS::Handle<JSObject*> aScriptOwner);
 197
 198   void SetTransaction(IDBTransaction* aTransaction);
 199
 200   // nsIDOMEventTarget
 201   virtual nsresult PostHandleEvent(
 202                      EventChainPostVisitor& aVisitor) MOZ_OVERRIDE;
 203
 204   DOMError* GetError(ErrorResult& aRv)
 205   {
 206     return IDBRequest::GetError(aRv);
 207   }
 208
 209   IDBFactory*
 210   Factory() const
 211   {
 212     return mFactory;
 213   }
 214
 215   // nsWrapperCache
 216   virtual JSObject*
 217   WrapObject(JSContext* aCx) MOZ_OVERRIDE;
 218
 219   // WebIDL
 220   IMPL_EVENT_HANDLER(blocked);
 221   IMPL_EVENT_HANDLER(upgradeneeded);
 222
 223 protected:
 224   explicit IDBOpenDBRequest(nsPIDOMWindow* aOwner);
 225   ~IDBOpenDBRequest();
 226
 227   // Only touched on the main thread.
 228   nsRefPtr<IDBFactory> mFactory;
 229 };
 230
 231 END_INDEXEDDB_NAMESPACE
 232
 233 #endif // mozilla_dom_indexeddb_idbrequest_h__