dom/base/DOMRequest.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 file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_domrequest_h__
   8 #define mozilla_dom_domrequest_h__
   9
  10 #include "nsIDOMDOMRequest.h"
  11 #include "mozilla/Attributes.h"
  12 #include "mozilla/DOMEventTargetHelper.h"
  13 #include "mozilla/dom/DOMError.h"
  14 #include "mozilla/dom/DOMRequestBinding.h"
  15
  16 #include "nsCOMPtr.h"
  17
  18 namespace mozilla {
  19
  20 class ErrorResult;
  21
  22 namespace dom {
  23
  24 class AnyCallback;
  25 class Promise;
  26
  27 class DOMRequest : public DOMEventTargetHelper,
  28                    public nsIDOMDOMRequest
  29 {
  30 protected:
  31   JS::Heap<JS::Value> mResult;
  32   nsRefPtr<DOMError> mError;
  33   nsRefPtr<Promise> mPromise;
  34   bool mDone;
  35
  36 public:
  37   NS_DECL_ISUPPORTS_INHERITED
  38   NS_DECL_NSIDOMDOMREQUEST
  39   NS_REALLY_FORWARD_NSIDOMEVENTTARGET(DOMEventTargetHelper)
  40
  41   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(DOMRequest,
  42                                                          DOMEventTargetHelper)
  43
  44   // WrapperCache
  45   nsPIDOMWindow* GetParentObject() const
  46   {
  47     return GetOwner();
  48   }
  49
  50   virtual JSObject* WrapObject(JSContext* aCx) MOZ_OVERRIDE;
  51
  52   // WebIDL Interface
  53   DOMRequestReadyState ReadyState() const
  54   {
  55     return mDone ? DOMRequestReadyState::Done
  56                  : DOMRequestReadyState::Pending;
  57   }
  58
  59   void GetResult(JSContext*, JS::MutableHandle<JS::Value> aRetval) const
  60   {
  61     NS_ASSERTION(mDone || mResult == JSVAL_VOID,
  62                  "Result should be undefined when pending");
  63     JS::ExposeValueToActiveJS(mResult);
  64     aRetval.set(mResult);
  65   }
  66
  67   DOMError* GetError() const
  68   {
  69     NS_ASSERTION(mDone || !mError,
  70                  "Error should be null when pending");
  71     return mError;
  72   }
  73
  74   IMPL_EVENT_HANDLER(success)
  75   IMPL_EVENT_HANDLER(error)
  76
  77   already_AddRefed<mozilla::dom::Promise>
  78   Then(JSContext* aCx, AnyCallback* aResolveCallback,
  79        AnyCallback* aRejectCallback, mozilla::ErrorResult& aRv);
  80
  81   void FireSuccess(JS::Handle<JS::Value> aResult);
  82   void FireError(const nsAString& aError);
  83   void FireError(nsresult aError);
  84   void FireDetailedError(DOMError* aError);
  85
  86   explicit DOMRequest(nsPIDOMWindow* aWindow);
  87
  88 protected:
  89   virtual ~DOMRequest();
  90
  91   void FireEvent(const nsAString& aType, bool aBubble, bool aCancelable);
  92
  93   void RootResultVal();
  94 };
  95
  96 class DOMRequestService MOZ_FINAL : public nsIDOMRequestService
  97 {
  98   ~DOMRequestService() {}
  99
 100 public:
 101   NS_DECL_ISUPPORTS
 102   NS_DECL_NSIDOMREQUESTSERVICE
 103
 104   // Returns an owning reference! No one should call this but the factory.
 105   static DOMRequestService* FactoryCreate()
 106   {
 107     DOMRequestService* res = new DOMRequestService;
 108     NS_ADDREF(res);
 109     return res;
 110   }
 111 };
 112
 113 } // namespace dom
 114 } // namespace mozilla
 115
 116 #define DOMREQUEST_SERVICE_CONTRACTID "@mozilla.org/dom/dom-request-service;1"
 117
 118 #endif // mozilla_dom_domrequest_h__