cef/libcef_dll/cpptoc/browser_cpptoc.cc
Marshall Greenblatt e411b513be Add CefFrameHandler callbacks for tracking CefFrame lifespan (see issue #2421)
See the new cef_frame_handler.h for complete usage documentation.

This change includes the following related enhancements:
- The newly added CefBrowser::IsValid method will return false (in the browser
  process) after CefLifeSpanHandler::OnBeforeClose is called.
- CefBrowser::GetMainFrame will return a valid object (in the browser process)
  until after CefLifeSpanHandler::OnBeforeClose is called.
- The main frame object will change during cross-origin navigation or
  re-navigation after renderer process termination. During that time,
  GetMainFrame will return the new/pending frame (in the browser process) and
  any messages that arrive for the new/pending frame will be correctly
  attributed in OnProcessMessageReceived.
- Commands to be executed in the renderer process that may fail during early
  frame initialization (ExecuteJavaScript, LoadRequest, etc.) will now be
  queued until after the JavaScript context for the frame has been created.
- Logging has been added for any commands that are dropped because they arrived
  after frame detachment.
2021-05-31 18:58:27 -04:00

439 lines
11 KiB
C++

// Copyright (c) 2021 The Chromium Embedded Framework Authors. All rights
// reserved. Use of this source code is governed by a BSD-style license that
// can be found in the LICENSE file.
//
// ---------------------------------------------------------------------------
//
// This file was generated by the CEF translator tool. If making changes by
// hand only do so within the body of existing method and function
// implementations. See the translator.README.txt file in the tools directory
// for more information.
//
// $hash=f2b6ec1af9292dc180975a7566296b019c25772f$
//
#include "libcef_dll/cpptoc/browser_cpptoc.h"
#include <algorithm>
#include "libcef_dll/cpptoc/browser_host_cpptoc.h"
#include "libcef_dll/cpptoc/frame_cpptoc.h"
#include "libcef_dll/shutdown_checker.h"
#include "libcef_dll/transfer_util.h"
namespace {
// MEMBER FUNCTIONS - Body may be edited by hand.
int CEF_CALLBACK browser_is_valid(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return 0;
// Execute
bool _retval = CefBrowserCppToC::Get(self)->IsValid();
// Return type: bool
return _retval;
}
struct _cef_browser_host_t* CEF_CALLBACK
browser_get_host(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return NULL;
// Execute
CefRefPtr<CefBrowserHost> _retval = CefBrowserCppToC::Get(self)->GetHost();
// Return type: refptr_same
return CefBrowserHostCppToC::Wrap(_retval);
}
int CEF_CALLBACK browser_can_go_back(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return 0;
// Execute
bool _retval = CefBrowserCppToC::Get(self)->CanGoBack();
// Return type: bool
return _retval;
}
void CEF_CALLBACK browser_go_back(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return;
// Execute
CefBrowserCppToC::Get(self)->GoBack();
}
int CEF_CALLBACK browser_can_go_forward(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return 0;
// Execute
bool _retval = CefBrowserCppToC::Get(self)->CanGoForward();
// Return type: bool
return _retval;
}
void CEF_CALLBACK browser_go_forward(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return;
// Execute
CefBrowserCppToC::Get(self)->GoForward();
}
int CEF_CALLBACK browser_is_loading(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return 0;
// Execute
bool _retval = CefBrowserCppToC::Get(self)->IsLoading();
// Return type: bool
return _retval;
}
void CEF_CALLBACK browser_reload(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return;
// Execute
CefBrowserCppToC::Get(self)->Reload();
}
void CEF_CALLBACK browser_reload_ignore_cache(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return;
// Execute
CefBrowserCppToC::Get(self)->ReloadIgnoreCache();
}
void CEF_CALLBACK browser_stop_load(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return;
// Execute
CefBrowserCppToC::Get(self)->StopLoad();
}
int CEF_CALLBACK browser_get_identifier(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return 0;
// Execute
int _retval = CefBrowserCppToC::Get(self)->GetIdentifier();
// Return type: simple
return _retval;
}
int CEF_CALLBACK browser_is_same(struct _cef_browser_t* self,
struct _cef_browser_t* that) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return 0;
// Verify param: that; type: refptr_same
DCHECK(that);
if (!that)
return 0;
// Execute
bool _retval =
CefBrowserCppToC::Get(self)->IsSame(CefBrowserCppToC::Unwrap(that));
// Return type: bool
return _retval;
}
int CEF_CALLBACK browser_is_popup(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return 0;
// Execute
bool _retval = CefBrowserCppToC::Get(self)->IsPopup();
// Return type: bool
return _retval;
}
int CEF_CALLBACK browser_has_document(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return 0;
// Execute
bool _retval = CefBrowserCppToC::Get(self)->HasDocument();
// Return type: bool
return _retval;
}
struct _cef_frame_t* CEF_CALLBACK
browser_get_main_frame(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return NULL;
// Execute
CefRefPtr<CefFrame> _retval = CefBrowserCppToC::Get(self)->GetMainFrame();
// Return type: refptr_same
return CefFrameCppToC::Wrap(_retval);
}
struct _cef_frame_t* CEF_CALLBACK
browser_get_focused_frame(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return NULL;
// Execute
CefRefPtr<CefFrame> _retval = CefBrowserCppToC::Get(self)->GetFocusedFrame();
// Return type: refptr_same
return CefFrameCppToC::Wrap(_retval);
}
struct _cef_frame_t* CEF_CALLBACK
browser_get_frame_byident(struct _cef_browser_t* self, int64 identifier) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return NULL;
// Execute
CefRefPtr<CefFrame> _retval =
CefBrowserCppToC::Get(self)->GetFrame(identifier);
// Return type: refptr_same
return CefFrameCppToC::Wrap(_retval);
}
struct _cef_frame_t* CEF_CALLBACK browser_get_frame(struct _cef_browser_t* self,
const cef_string_t* name) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return NULL;
// Unverified params: name
// Execute
CefRefPtr<CefFrame> _retval =
CefBrowserCppToC::Get(self)->GetFrame(CefString(name));
// Return type: refptr_same
return CefFrameCppToC::Wrap(_retval);
}
size_t CEF_CALLBACK browser_get_frame_count(struct _cef_browser_t* self) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return 0;
// Execute
size_t _retval = CefBrowserCppToC::Get(self)->GetFrameCount();
// Return type: simple
return _retval;
}
void CEF_CALLBACK browser_get_frame_identifiers(struct _cef_browser_t* self,
size_t* identifiersCount,
int64* identifiers) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return;
// Verify param: identifiers; type: simple_vec_byref
DCHECK(identifiersCount && (*identifiersCount == 0 || identifiers));
if (!identifiersCount || (*identifiersCount > 0 && !identifiers))
return;
// Translate param: identifiers; type: simple_vec_byref
std::vector<int64> identifiersList;
if (identifiersCount && *identifiersCount > 0 && identifiers) {
for (size_t i = 0; i < *identifiersCount; ++i) {
identifiersList.push_back(identifiers[i]);
}
}
// Execute
CefBrowserCppToC::Get(self)->GetFrameIdentifiers(identifiersList);
// Restore param: identifiers; type: simple_vec_byref
if (identifiersCount && identifiers) {
*identifiersCount = std::min(identifiersList.size(), *identifiersCount);
if (*identifiersCount > 0) {
for (size_t i = 0; i < *identifiersCount; ++i) {
identifiers[i] = identifiersList[i];
}
}
}
}
void CEF_CALLBACK browser_get_frame_names(struct _cef_browser_t* self,
cef_string_list_t names) {
shutdown_checker::AssertNotShutdown();
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
DCHECK(self);
if (!self)
return;
// Verify param: names; type: string_vec_byref
DCHECK(names);
if (!names)
return;
// Translate param: names; type: string_vec_byref
std::vector<CefString> namesList;
transfer_string_list_contents(names, namesList);
// Execute
CefBrowserCppToC::Get(self)->GetFrameNames(namesList);
// Restore param: names; type: string_vec_byref
cef_string_list_clear(names);
transfer_string_list_contents(namesList, names);
}
} // namespace
// CONSTRUCTOR - Do not edit by hand.
CefBrowserCppToC::CefBrowserCppToC() {
GetStruct()->is_valid = browser_is_valid;
GetStruct()->get_host = browser_get_host;
GetStruct()->can_go_back = browser_can_go_back;
GetStruct()->go_back = browser_go_back;
GetStruct()->can_go_forward = browser_can_go_forward;
GetStruct()->go_forward = browser_go_forward;
GetStruct()->is_loading = browser_is_loading;
GetStruct()->reload = browser_reload;
GetStruct()->reload_ignore_cache = browser_reload_ignore_cache;
GetStruct()->stop_load = browser_stop_load;
GetStruct()->get_identifier = browser_get_identifier;
GetStruct()->is_same = browser_is_same;
GetStruct()->is_popup = browser_is_popup;
GetStruct()->has_document = browser_has_document;
GetStruct()->get_main_frame = browser_get_main_frame;
GetStruct()->get_focused_frame = browser_get_focused_frame;
GetStruct()->get_frame_byident = browser_get_frame_byident;
GetStruct()->get_frame = browser_get_frame;
GetStruct()->get_frame_count = browser_get_frame_count;
GetStruct()->get_frame_identifiers = browser_get_frame_identifiers;
GetStruct()->get_frame_names = browser_get_frame_names;
}
// DESTRUCTOR - Do not edit by hand.
CefBrowserCppToC::~CefBrowserCppToC() {
shutdown_checker::AssertNotShutdown();
}
template <>
CefRefPtr<CefBrowser>
CefCppToCRefCounted<CefBrowserCppToC, CefBrowser, cef_browser_t>::UnwrapDerived(
CefWrapperType type,
cef_browser_t* s) {
NOTREACHED() << "Unexpected class type: " << type;
return nullptr;
}
template <>
CefWrapperType CefCppToCRefCounted<CefBrowserCppToC,
CefBrowser,
cef_browser_t>::kWrapperType = WT_BROWSER;