141 lines
4.6 KiB
C++
141 lines
4.6 KiB
C++
// Copyright (c) 2020 Samuel Maddock <sam@samuelmaddock.com>.
|
|
// Use of this source code is governed by the MIT license that can be
|
|
// found in the LICENSE file.
|
|
|
|
#ifndef ELECTRON_SHELL_BROWSER_API_ELECTRON_API_WEB_FRAME_MAIN_H_
|
|
#define ELECTRON_SHELL_BROWSER_API_ELECTRON_API_WEB_FRAME_MAIN_H_
|
|
|
|
#include <optional>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "base/memory/raw_ptr.h"
|
|
#include "base/memory/weak_ptr.h"
|
|
#include "base/process/process.h"
|
|
#include "gin/handle.h"
|
|
#include "gin/wrappable.h"
|
|
#include "mojo/public/cpp/bindings/remote.h"
|
|
#include "shell/browser/event_emitter_mixin.h"
|
|
#include "shell/common/gin_helper/constructible.h"
|
|
#include "shell/common/gin_helper/pinnable.h"
|
|
#include "third_party/blink/public/mojom/page/page_visibility_state.mojom-forward.h"
|
|
|
|
class GURL;
|
|
|
|
namespace content {
|
|
class RenderFrameHost;
|
|
}
|
|
|
|
namespace gin {
|
|
class Arguments;
|
|
}
|
|
|
|
namespace electron::api {
|
|
|
|
class WebContents;
|
|
|
|
// Bindings for accessing frames from the main process.
|
|
class WebFrameMain : public gin::Wrappable<WebFrameMain>,
|
|
public gin_helper::EventEmitterMixin<WebFrameMain>,
|
|
public gin_helper::Pinnable<WebFrameMain>,
|
|
public gin_helper::Constructible<WebFrameMain> {
|
|
public:
|
|
// Create a new WebFrameMain and return the V8 wrapper of it.
|
|
static gin::Handle<WebFrameMain> New(v8::Isolate* isolate);
|
|
|
|
static gin::Handle<WebFrameMain> From(
|
|
v8::Isolate* isolate,
|
|
content::RenderFrameHost* render_frame_host);
|
|
static gin::Handle<WebFrameMain> FromOrNull(
|
|
v8::Isolate* isolate,
|
|
content::RenderFrameHost* render_frame_host);
|
|
static WebFrameMain* FromFrameTreeNodeId(int frame_tree_node_id);
|
|
static WebFrameMain* FromRenderFrameHost(
|
|
content::RenderFrameHost* render_frame_host);
|
|
|
|
// gin_helper::Constructible
|
|
static void FillObjectTemplate(v8::Isolate*, v8::Local<v8::ObjectTemplate>);
|
|
static const char* GetClassName() { return "WebFrameMain"; }
|
|
|
|
// gin::Wrappable
|
|
static gin::WrapperInfo kWrapperInfo;
|
|
const char* GetTypeName() override;
|
|
|
|
content::RenderFrameHost* render_frame_host() const { return render_frame_; }
|
|
|
|
// disable copy
|
|
WebFrameMain(const WebFrameMain&) = delete;
|
|
WebFrameMain& operator=(const WebFrameMain&) = delete;
|
|
|
|
protected:
|
|
explicit WebFrameMain(content::RenderFrameHost* render_frame);
|
|
~WebFrameMain() override;
|
|
|
|
private:
|
|
friend class WebContents;
|
|
|
|
// Called when FrameTreeNode is deleted.
|
|
void Destroyed();
|
|
|
|
// Mark RenderFrameHost as disposed and to no longer access it. This can
|
|
// happen when the WebFrameMain v8 handle is GC'd or when a FrameTreeNode
|
|
// is removed.
|
|
void MarkRenderFrameDisposed();
|
|
|
|
// Swap out the internal RFH when cross-origin navigation occurs.
|
|
void UpdateRenderFrameHost(content::RenderFrameHost* rfh);
|
|
|
|
const mojo::Remote<mojom::ElectronRenderer>& GetRendererApi();
|
|
void MaybeSetupMojoConnection();
|
|
void TeardownMojoConnection();
|
|
void OnRendererConnectionError();
|
|
|
|
// WebFrameMain can outlive its RenderFrameHost pointer so we need to check
|
|
// whether its been disposed of prior to accessing it.
|
|
bool CheckRenderFrame() const;
|
|
|
|
v8::Local<v8::Promise> ExecuteJavaScript(gin::Arguments* args,
|
|
const std::u16string& code);
|
|
bool Reload();
|
|
void Send(v8::Isolate* isolate,
|
|
bool internal,
|
|
const std::string& channel,
|
|
v8::Local<v8::Value> args);
|
|
void PostMessage(v8::Isolate* isolate,
|
|
const std::string& channel,
|
|
v8::Local<v8::Value> message_value,
|
|
std::optional<v8::Local<v8::Value>> transfer);
|
|
|
|
int FrameTreeNodeID() const;
|
|
std::string Name() const;
|
|
base::ProcessId OSProcessID() const;
|
|
int ProcessID() const;
|
|
int RoutingID() const;
|
|
GURL URL() const;
|
|
std::string Origin() const;
|
|
blink::mojom::PageVisibilityState VisibilityState() const;
|
|
|
|
content::RenderFrameHost* Top() const;
|
|
content::RenderFrameHost* Parent() const;
|
|
std::vector<content::RenderFrameHost*> Frames() const;
|
|
std::vector<content::RenderFrameHost*> FramesInSubtree() const;
|
|
|
|
void DOMContentLoaded();
|
|
|
|
mojo::Remote<mojom::ElectronRenderer> renderer_api_;
|
|
mojo::PendingReceiver<mojom::ElectronRenderer> pending_receiver_;
|
|
|
|
int frame_tree_node_id_;
|
|
|
|
raw_ptr<content::RenderFrameHost> render_frame_ = nullptr;
|
|
|
|
// Whether the RenderFrameHost has been removed and that it should no longer
|
|
// be accessed.
|
|
bool render_frame_disposed_ = false;
|
|
|
|
base::WeakPtrFactory<WebFrameMain> weak_factory_{this};
|
|
};
|
|
|
|
} // namespace electron::api
|
|
|
|
#endif // ELECTRON_SHELL_BROWSER_API_ELECTRON_API_WEB_FRAME_MAIN_H_
|