dom/workers/WorkerScope.h

   1 /* -*- Mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 40 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_dom_workerscope_h__
   7 #define mozilla_dom_workerscope_h__
   8
   9 #include "Workers.h"
  10 #include "mozilla/DOMEventTargetHelper.h"
  11 #include "mozilla/dom/Headers.h"
  12 #include "mozilla/dom/RequestBinding.h"
  13
  14 namespace mozilla {
  15 namespace dom {
  16
  17 class Console;
  18 class Function;
  19 class Promise;
  20 class RequestOrUSVString;
  21
  22 namespace indexedDB {
  23
  24 class IDBFactory;
  25
  26 } // namespace indexedDB
  27
  28 } // namespace dom
  29 } // namespace mozilla
  30
  31 BEGIN_WORKERS_NAMESPACE
  32
  33 class ServiceWorkerClients;
  34 class WorkerPrivate;
  35 class WorkerLocation;
  36 class WorkerNavigator;
  37 class Performance;
  38
  39 class WorkerGlobalScope : public DOMEventTargetHelper,
  40                           public nsIGlobalObject
  41 {
  42   typedef mozilla::dom::indexedDB::IDBFactory IDBFactory;
  43
  44   nsRefPtr<Console> mConsole;
  45   nsRefPtr<WorkerLocation> mLocation;
  46   nsRefPtr<WorkerNavigator> mNavigator;
  47   nsRefPtr<Performance> mPerformance;
  48   nsRefPtr<IDBFactory> mIndexedDB;
  49
  50 protected:
  51   WorkerPrivate* mWorkerPrivate;
  52
  53   explicit WorkerGlobalScope(WorkerPrivate* aWorkerPrivate);
  54   virtual ~WorkerGlobalScope();
  55
  56 public:
  57   virtual JSObject*
  58   WrapObject(JSContext* aCx) MOZ_OVERRIDE;
  59
  60   virtual JSObject*
  61   WrapGlobalObject(JSContext* aCx) = 0;
  62
  63   virtual JSObject*
  64   GetGlobalJSObject(void) MOZ_OVERRIDE
  65   {
  66     return GetWrapper();
  67   }
  68
  69   NS_DECL_ISUPPORTS_INHERITED
  70   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(WorkerGlobalScope,
  71                                                          DOMEventTargetHelper)
  72
  73   already_AddRefed<WorkerGlobalScope>
  74   Self()
  75   {
  76     return nsRefPtr<WorkerGlobalScope>(this).forget();
  77   }
  78
  79   Console*
  80   GetConsole();
  81
  82   already_AddRefed<WorkerLocation>
  83   Location();
  84
  85   already_AddRefed<WorkerNavigator>
  86   Navigator();
  87
  88   already_AddRefed<WorkerNavigator>
  89   GetExistingNavigator() const;
  90
  91   void
  92   Close(JSContext* aCx);
  93
  94   OnErrorEventHandlerNonNull*
  95   GetOnerror();
  96   void
  97   SetOnerror(OnErrorEventHandlerNonNull* aHandler);
  98
  99   void
 100   ImportScripts(JSContext* aCx, const Sequence<nsString>& aScriptURLs,
 101                 ErrorResult& aRv);
 102
 103   int32_t
 104   SetTimeout(JSContext* aCx, Function& aHandler, const int32_t aTimeout,
 105              const Sequence<JS::Value>& aArguments, ErrorResult& aRv);
 106   int32_t
 107   SetTimeout(JSContext* /* unused */, const nsAString& aHandler,
 108              const int32_t aTimeout, const Sequence<JS::Value>& /* unused */,
 109              ErrorResult& aRv);
 110   void
 111   ClearTimeout(int32_t aHandle, ErrorResult& aRv);
 112   int32_t
 113   SetInterval(JSContext* aCx, Function& aHandler,
 114               const Optional<int32_t>& aTimeout,
 115               const Sequence<JS::Value>& aArguments, ErrorResult& aRv);
 116   int32_t
 117   SetInterval(JSContext* /* unused */, const nsAString& aHandler,
 118               const Optional<int32_t>& aTimeout,
 119               const Sequence<JS::Value>& /* unused */, ErrorResult& aRv);
 120   void
 121   ClearInterval(int32_t aHandle, ErrorResult& aRv);
 122
 123   void
 124   Atob(const nsAString& aAtob, nsAString& aOutput, ErrorResult& aRv) const;
 125   void
 126   Btoa(const nsAString& aBtoa, nsAString& aOutput, ErrorResult& aRv) const;
 127
 128   IMPL_EVENT_HANDLER(online)
 129   IMPL_EVENT_HANDLER(offline)
 130   IMPL_EVENT_HANDLER(close)
 131
 132   void
 133   Dump(const Optional<nsAString>& aString) const;
 134
 135   Performance* GetPerformance();
 136
 137   already_AddRefed<Promise>
 138   Fetch(const RequestOrUSVString& aInput, const RequestInit& aInit, ErrorResult& aRv);
 139
 140   already_AddRefed<IDBFactory>
 141   GetIndexedDB(ErrorResult& aErrorResult);
 142 };
 143
 144 class DedicatedWorkerGlobalScope MOZ_FINAL : public WorkerGlobalScope
 145 {
 146   ~DedicatedWorkerGlobalScope() { }
 147
 148 public:
 149   explicit DedicatedWorkerGlobalScope(WorkerPrivate* aWorkerPrivate);
 150
 151   virtual JSObject*
 152   WrapGlobalObject(JSContext* aCx) MOZ_OVERRIDE;
 153
 154   void
 155   PostMessage(JSContext* aCx, JS::Handle<JS::Value> aMessage,
 156               const Optional<Sequence<JS::Value>>& aTransferable,
 157               ErrorResult& aRv);
 158
 159   IMPL_EVENT_HANDLER(message)
 160 };
 161
 162 class SharedWorkerGlobalScope MOZ_FINAL : public WorkerGlobalScope
 163 {
 164   const nsCString mName;
 165
 166   ~SharedWorkerGlobalScope() { }
 167
 168 public:
 169   SharedWorkerGlobalScope(WorkerPrivate* aWorkerPrivate,
 170                           const nsCString& aName);
 171
 172   virtual JSObject*
 173   WrapGlobalObject(JSContext* aCx) MOZ_OVERRIDE;
 174
 175   void GetName(DOMString& aName) const
 176   {
 177     aName.AsAString() = NS_ConvertUTF8toUTF16(mName);
 178   }
 179
 180   IMPL_EVENT_HANDLER(connect)
 181 };
 182
 183 class ServiceWorkerGlobalScope MOZ_FINAL : public WorkerGlobalScope
 184 {
 185   const nsString mScope;
 186   nsRefPtr<ServiceWorkerClients> mClients;
 187
 188   ~ServiceWorkerGlobalScope();
 189
 190 public:
 191   NS_DECL_ISUPPORTS_INHERITED
 192   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ServiceWorkerGlobalScope,
 193                                            WorkerGlobalScope)
 194
 195   ServiceWorkerGlobalScope(WorkerPrivate* aWorkerPrivate, const nsACString& aScope);
 196
 197   virtual JSObject*
 198   WrapGlobalObject(JSContext* aCx) MOZ_OVERRIDE;
 199
 200   void
 201   GetScope(DOMString& aScope) const
 202   {
 203     aScope.AsAString() = mScope;
 204   }
 205
 206   void
 207   Close() const
 208   {
 209     // no-op close.
 210   }
 211
 212   void
 213   Update();
 214
 215   already_AddRefed<Promise>
 216   Unregister(ErrorResult& aRv);
 217
 218   ServiceWorkerClients*
 219   Clients();
 220
 221   IMPL_EVENT_HANDLER(activate)
 222   IMPL_EVENT_HANDLER(beforeevicted)
 223   IMPL_EVENT_HANDLER(evicted)
 224   IMPL_EVENT_HANDLER(fetch)
 225   IMPL_EVENT_HANDLER(install)
 226   IMPL_EVENT_HANDLER(message)
 227 };
 228
 229 JSObject*
 230 CreateGlobalScope(JSContext* aCx);
 231
 232 END_WORKERS_NAMESPACE
 233
 234 inline nsISupports*
 235 ToSupports(mozilla::dom::workers::WorkerGlobalScope* aScope)
 236 {
 237   return static_cast<nsIDOMEventTarget*>(aScope);
 238 }
 239
 240 #endif /* mozilla_dom_workerscope_h__ */