summaryrefslogtreecommitdiffstats
path: root/dom/ipc/BrowserHost.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /dom/ipc/BrowserHost.h
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/ipc/BrowserHost.h')
-rw-r--r--dom/ipc/BrowserHost.h109
1 files changed, 109 insertions, 0 deletions
diff --git a/dom/ipc/BrowserHost.h b/dom/ipc/BrowserHost.h
new file mode 100644
index 0000000000..5b651a1df0
--- /dev/null
+++ b/dom/ipc/BrowserHost.h
@@ -0,0 +1,109 @@
+/* -*- 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 http://mozilla.org/MPL/2.0/. */
+
+#ifndef mozilla_dom_BrowserHost_h
+#define mozilla_dom_BrowserHost_h
+
+#include "nsIRemoteTab.h"
+#include "mozilla/dom/RemoteBrowser.h"
+#include "mozilla/dom/BrowserParent.h"
+
+class nsPIDOMWindowOuter;
+
+namespace mozilla {
+
+namespace a11y {
+class DocAccessibleParent;
+} // namespace a11y
+
+namespace dom {
+
+class Element;
+
+/**
+ * BrowserHost manages a remote browser from the chrome process.
+ *
+ * It is used via the RemoteBrowser interface in nsFrameLoader and supports
+ * operations over the tree of BrowserParent/BrowserBridgeParent's.
+ *
+ * See `dom/docs/Fission-IPC-Diagram.svg` for an overview of the DOM IPC
+ * actors.
+ */
+class BrowserHost : public RemoteBrowser,
+ public nsIRemoteTab,
+ public nsSupportsWeakReference {
+ public:
+ typedef mozilla::layers::LayersId LayersId;
+
+ explicit BrowserHost(BrowserParent* aParent);
+
+ static BrowserHost* GetFrom(nsIRemoteTab* aRemoteTab);
+
+ // NS_DECL_ISUPPORTS_INHERITED
+ NS_DECL_CYCLE_COLLECTING_ISUPPORTS
+ // nsIRemoteTab
+ NS_DECL_NSIREMOTETAB
+
+ NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(BrowserHost, RemoteBrowser)
+
+ // Get the IPDL actor for the root BrowserParent. This method should be
+ // avoided and consumers migrated to use this class.
+ BrowserParent* GetActor() { return mRoot; }
+ ContentParent* GetContentParent() const {
+ return mRoot ? mRoot->Manager() : nullptr;
+ }
+
+ BrowserHost* AsBrowserHost() override { return this; }
+ BrowserBridgeHost* AsBrowserBridgeHost() override { return nullptr; }
+
+ TabId GetTabId() const override;
+ LayersId GetLayersId() const override;
+ BrowsingContext* GetBrowsingContext() const override;
+ nsILoadContext* GetLoadContext() const override;
+ bool CanRecv() const override;
+
+ Element* GetOwnerElement() const { return mRoot->GetOwnerElement(); }
+ already_AddRefed<nsPIDOMWindowOuter> GetParentWindowOuter() const {
+ return mRoot->GetParentWindowOuter();
+ }
+ a11y::DocAccessibleParent* GetTopLevelDocAccessible() const;
+
+ // Visit each BrowserParent in the tree formed by PBrowser and
+ // PBrowserBridge that is anchored by `mRoot`.
+ template <typename Callback>
+ void VisitAll(Callback aCallback) {
+ if (!mRoot) {
+ return;
+ }
+ mRoot->VisitAll(aCallback);
+ }
+
+ void LoadURL(nsDocShellLoadState* aLoadState) override;
+ void ResumeLoad(uint64_t aPendingSwitchId) override;
+ void DestroyStart() override;
+ void DestroyComplete() override;
+
+ bool Show(const OwnerShowInfo&) override;
+ void UpdateDimensions(const nsIntRect& aRect,
+ const ScreenIntSize& aSize) override;
+
+ void UpdateEffects(EffectsInfo aInfo) override;
+
+ private:
+ virtual ~BrowserHost() = default;
+
+ // The TabID for the root BrowserParent, we cache this so that we can access
+ // it after the remote browser has been destroyed
+ TabId mId;
+ // The root BrowserParent of this remote browser
+ RefPtr<BrowserParent> mRoot;
+ EffectsInfo mEffectsInfo;
+};
+
+} // namespace dom
+} // namespace mozilla
+
+#endif // mozilla_dom_BrowserHost_h