| // Copyright 2018 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef CONTENT_BROWSER_PORTAL_PORTAL_H_ |
| #define CONTENT_BROWSER_PORTAL_PORTAL_H_ |
| |
| #include <memory> |
| |
| #include "content/common/content_export.h" |
| #include "content/public/browser/web_contents_observer.h" |
| #include "mojo/public/cpp/bindings/strong_binding.h" |
| #include "third_party/blink/public/mojom/portal/portal.mojom.h" |
| |
| namespace content { |
| |
| class RenderFrameHostImpl; |
| |
| // A Portal provides a way to embed a WebContents inside a frame in another |
| // WebContents. It also provides an API that the owning frame can interact with |
| // the portal WebContents. The portal can be activated, where the portal |
| // WebContents replaces the outer WebContents and inherit it as a new Portal. |
| // |
| // The Portal is owned by its mojo binding, so it is kept alive as long as the |
| // other end of the pipe (typically in the renderer) exists. |
| class CONTENT_EXPORT Portal : public blink::mojom::Portal, |
| public WebContentsObserver { |
| public: |
| ~Portal() override; |
| |
| static bool IsEnabled(); |
| |
| // Creates a Portal and binds it to the pipe specified in the |request|. This |
| // function creates a strong binding, so the ownership of the Portal is |
| // delegated to the binding. |
| static Portal* Create(RenderFrameHostImpl* owner_render_frame_host, |
| blink::mojom::PortalRequest request); |
| |
| // Creates a portal without binding it to any pipe. Only used in tests. |
| static std::unique_ptr<Portal> CreateForTesting( |
| RenderFrameHostImpl* owner_render_frame_host); |
| |
| // blink::mojom::Portal implementation. |
| void Init(base::OnceCallback<void(const base::UnguessableToken&)> callback) |
| override; |
| void Navigate(const GURL& url) override; |
| void Activate(base::OnceCallback<void(blink::mojom::PortalActivationStatus)> |
| callback) override; |
| |
| // WebContentsObserver overrides. |
| void RenderFrameDeleted(RenderFrameHost* render_frame_host) override; |
| |
| // Returns the Portal's WebContents. |
| WebContents* GetPortalContents(); |
| |
| // Gets/sets the mojo binding. Only used in tests. |
| mojo::StrongBindingPtr<blink::mojom::Portal> GetBindingForTesting() { |
| return binding_; |
| } |
| void SetBindingForTesting( |
| mojo::StrongBindingPtr<blink::mojom::Portal> binding); |
| |
| private: |
| explicit Portal(RenderFrameHostImpl* owner_render_frame_host); |
| |
| RenderFrameHostImpl* owner_render_frame_host_; |
| |
| // Uniquely identifies the portal, this token is used by the browser process |
| // to reference this portal when communicating with the renderer. |
| base::UnguessableToken portal_token_; |
| |
| // WeakPtr to StrongBinding. |
| mojo::StrongBindingPtr<blink::mojom::Portal> binding_; |
| |
| std::unique_ptr<WebContents> portal_contents_; |
| }; |
| |
| } // namespace content |
| |
| #endif // CONTENT_BROWSER_PORTAL_PORTAL_H_ |