Source code

Revision control

Copy as Markdown

Other Tools

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at */
#ifndef nsInProcessBrowserChildGlobal_h
#define nsInProcessBrowserChildGlobal_h
#include "mozilla/Attributes.h"
#include "mozilla/DOMEventTargetHelper.h"
#include "mozilla/RefPtr.h"
#include "mozilla/dom/ContentFrameMessageManager.h"
#include "mozilla/dom/MessageManagerCallback.h"
#include "nsCOMPtr.h"
#include "nsIScriptContext.h"
#include "nsIScriptObjectPrincipal.h"
#include "nsDocShell.h"
#include "nsCOMArray.h"
#include "nsWeakReference.h"
class nsFrameMessageManager;
namespace mozilla {
class EventChainPreVisitor;
namespace dom {
* This class implements a ContentFrameMessageManager for use by frame loaders
* in the parent process. It is bound to a DocShell rather than a BrowserChild,
* and does not use any IPC infrastructure for its message passing.
class InProcessBrowserChildMessageManager final
: public ContentFrameMessageManager,
public nsMessageManagerScriptExecutor,
public nsIInProcessContentFrameMessageManager,
public nsSupportsWeakReference,
public mozilla::dom::ipc::MessageManagerCallback {
using StructuredCloneData = mozilla::dom::ipc::StructuredCloneData;
InProcessBrowserChildMessageManager(nsDocShell* aShell, nsIContent* aOwner,
nsFrameMessageManager* aChrome);
static already_AddRefed<InProcessBrowserChildMessageManager> Create(
nsDocShell* aShell, nsIContent* aOwner, nsFrameMessageManager* aChrome);
InProcessBrowserChildMessageManager, DOMEventTargetHelper)
void MarkForCC();
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
Nullable<WindowProxyHolder> GetContent(ErrorResult& aError) override;
virtual already_AddRefed<nsIDocShell> GetDocShell(
ErrorResult& aError) override {
return do_AddRef(mDocShell);
virtual already_AddRefed<nsIEventTarget> GetTabEventTarget() override;
void CacheFrameLoader(nsFrameLoader* aFrameLoader);
* MessageManagerCallback methods that we override.
virtual bool DoSendBlockingMessage(
const nsAString& aMessage, StructuredCloneData& aData,
nsTArray<StructuredCloneData>* aRetVal) override;
virtual nsresult DoSendAsyncMessage(const nsAString& aMessage,
StructuredCloneData& aData) override;
void GetEventTargetParent(EventChainPreVisitor& aVisitor) override;
void LoadFrameScript(const nsAString& aURL, bool aRunInGlobalScope);
void FireUnloadEvent();
void DisconnectEventListeners();
void Disconnect();
void SendMessageToParent(const nsString& aMessage, bool aSync,
const nsString& aJSON,
nsTArray<nsString>* aJSONRetVal);
nsFrameMessageManager* GetInnerManager() {
return static_cast<nsFrameMessageManager*>(mMessageManager.get());
void SetOwner(nsIContent* aOwner) { mOwner = aOwner; }
nsFrameMessageManager* GetChromeMessageManager() {
return mChromeMessageManager;
void SetChromeMessageManager(nsFrameMessageManager* aParent) {
mChromeMessageManager = aParent;
already_AddRefed<nsFrameLoader> GetFrameLoader();
virtual ~InProcessBrowserChildMessageManager();
RefPtr<nsDocShell> mDocShell;
bool mLoadingScript;
// Is this the message manager for an in-process <iframe mozbrowser>? This
// affects where events get sent, so it affects GetEventTargetParent.
bool mIsBrowserFrame;
bool mPreventEventsEscaping;
// We keep a strong reference to the frameloader after we've started
// teardown. This allows us to dispatch message manager messages during this
// time.
RefPtr<nsFrameLoader> mFrameLoader;
nsIContent* mOwner;
nsFrameMessageManager* mChromeMessageManager;
} // namespace dom
} // namespace mozilla