dom/base/ContentProcessMessageManager.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=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_ContentProcessMessageManager_h
   8 #define mozilla_dom_ContentProcessMessageManager_h
   9
  10 #include "mozilla/Attributes.h"
  11 #include "mozilla/dom/MessageManagerGlobal.h"
  12 #include "mozilla/dom/MessageManagerCallback.h"
  13 #include "nsCOMPtr.h"
  14 #include "nsIScriptContext.h"
  15 #include "nsIScriptContext.h"
  16 #include "nsServiceManagerUtils.h"
  17 #include "nsWeakReference.h"
  18 #include "nsWrapperCache.h"
  19 #include "xpcpublic.h"
  20
  21 class nsFrameMessageManager;
  22
  23 namespace mozilla {
  24 namespace dom {
  25
  26 namespace ipc {
  27 class SharedMap;
  28 }
  29
  30 /**
  31  * This class implements a singleton process message manager for content
  32  * processes. Each child process has exactly one instance of this class, which
  33  * hosts the process's process scripts, and may exchange messages with its
  34  * corresponding ParentProcessMessageManager on the parent side.
  35  */
  36
  37 class ContentProcessMessageManager : public nsIMessageSender,
  38                                      public nsMessageManagerScriptExecutor,
  39                                      public nsSupportsWeakReference,
  40                                      public ipc::MessageManagerCallback,
  41                                      public MessageManagerGlobal,
  42                                      public nsWrapperCache {
  43  public:
  44   explicit ContentProcessMessageManager(nsFrameMessageManager* aMessageManager);
  45
  46   using ipc::MessageManagerCallback::GetProcessMessageManager;
  47   using MessageManagerGlobal::GetProcessMessageManager;
  48
  49   bool Init();
  50
  51   static ContentProcessMessageManager* Get();
  52   static bool WasCreated();
  53
  54   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  55   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_AMBIGUOUS(
  56       ContentProcessMessageManager, nsIMessageSender)
  57
  58   void MarkForCC();
  59
  60   virtual JSObject* WrapObject(JSContext* aCx,
  61                                JS::Handle<JSObject*> aGivenProto) override;
  62
  63   JSObject* GetOrCreateWrapper();
  64
  65   using MessageManagerGlobal::AddMessageListener;
  66   using MessageManagerGlobal::AddWeakMessageListener;
  67   using MessageManagerGlobal::RemoveMessageListener;
  68   using MessageManagerGlobal::RemoveWeakMessageListener;
  69
  70   // ContentProcessMessageManager
  71   void GetInitialProcessData(JSContext* aCx,
  72                              JS::MutableHandle<JS::Value> aInitialProcessData,
  73                              ErrorResult& aError) {
  74     if (!mMessageManager) {
  75       aError.Throw(NS_ERROR_NOT_INITIALIZED);
  76       return;
  77     }
  78     mMessageManager->GetInitialProcessData(aCx, aInitialProcessData, aError);
  79   }
  80
  81   already_AddRefed<ipc::SharedMap> GetSharedData();
  82
  83   NS_FORWARD_SAFE_NSIMESSAGESENDER(mMessageManager)
  84
  85   nsIGlobalObject* GetParentObject() const {
  86     return xpc::NativeGlobal(xpc::PrivilegedJunkScope());
  87   }
  88
  89   virtual void LoadScript(const nsAString& aURL);
  90
  91   bool IsProcessScoped() const override { return true; }
  92
  93   void SetInitialProcessData(JS::HandleValue aInitialData);
  94
  95  protected:
  96   virtual ~ContentProcessMessageManager();
  97
  98  private:
  99   bool mInitialized;
 100
 101   static bool sWasCreated;
 102 };
 103
 104 }  // namespace dom
 105 }  // namespace mozilla
 106
 107 #endif  // mozilla_dom_ContentProcessMessageManager_h