bcarrella/cef
1
0
Fork 0
mirror of https://bitbucket.org/chromiumembedded/cef synced 2025-03-26 00:40:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Clarify expectations for CefRenderHandler::GetViewRect (issue #1910)

Browse Source
This commit is contained in:
Marshall Greenblatt 2018-09-25 15:40:02 +02:00
parent 64cd460c73
commit 09afa3a843
17 changed files with 100 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
include/capi/cef_render_handler_capi.h
View File

@ -33,7 +33,7 @@
// by hand. See the translator.README.txt file in the tools directory for
// more information.
//
// $hash=f2f3acb1df9815e4ac9bf34010ce260a2496ae5a$
// $hash=d259309846e69d866a834aa701bbf8c9562dd117$
//
#ifndef CEF_INCLUDE_CAPI_CEF_RENDER_HANDLER_CAPI_H_
@ -68,7 +68,8 @@ typedef struct _cef_render_handler_t {
///
// Called to retrieve the root window rectangle in screen coordinates. Return
// true (1) if the rectangle was provided.
// true (1) if the rectangle was provided. If this function returns false (0)
// the rectangle from GetViewRect will be used.
///
int(CEF_CALLBACK* get_root_screen_rect)(struct _cef_render_handler_t* self,
struct _cef_browser_t* browser,
@ -76,11 +77,11 @@ typedef struct _cef_render_handler_t {
///
// Called to retrieve the view rectangle which is relative to screen
// coordinates. Return true (1) if the rectangle was provided.
// coordinates. This function must always provide a non-NULL rectangle.
///
int(CEF_CALLBACK* get_view_rect)(struct _cef_render_handler_t* self,
struct _cef_browser_t* browser,
cef_rect_t* rect);
void(CEF_CALLBACK* get_view_rect)(struct _cef_render_handler_t* self,
struct _cef_browser_t* browser,
cef_rect_t* rect);
///
// Called to retrieve the translation from view coordinates to actual screen

7
include/cef_render_handler.h
View File

@ -69,7 +69,8 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
///
// Called to retrieve the root window rectangle in screen coordinates. Return
// true if the rectangle was provided.
// true if the rectangle was provided. If this method returns false the
// rectangle from GetViewRect will be used.
///
/*--cef()--*/
virtual bool GetRootScreenRect(CefRefPtr<CefBrowser> browser, CefRect& rect) {
@ -78,10 +79,10 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
///
// Called to retrieve the view rectangle which is relative to screen
// coordinates. Return true if the rectangle was provided.
// coordinates. This method must always provide a non-empty rectangle.
///
/*--cef()--*/
virtual bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) = 0;
virtual void GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) = 0;
///
// Called to retrieve the translation from view coordinates to actual screen

82
libcef/browser/osr/render_widget_host_view_osr.cc
View File

@ -414,8 +414,12 @@ gfx::Rect CefRenderWidgetHostViewOSR::GetViewBounds() const {
CefRect rc;
CefRefPtr<CefRenderHandler> handler =
browser_impl_->GetClient()->GetRenderHandler();
if (handler.get())
handler->GetViewRect(browser_impl_.get(), rc);
CHECK(handler);
handler->GetViewRect(browser_impl_.get(), rc);
CHECK_GT(rc.width, 0);
CHECK_GT(rc.height, 0);
return gfx::Rect(rc.x, rc.y, rc.width, rc.height);
}
@ -557,8 +561,9 @@ void CefRenderWidgetHostViewOSR::InitAsPopup(
CefRefPtr<CefRenderHandler> handler =
browser_impl_->GetClient()->GetRenderHandler();
if (handler.get())
handler->OnPopupShow(browser_impl_.get(), true);
CHECK(handler);
handler->OnPopupShow(browser_impl_.get(), true);
popup_position_ = pos;
@ -595,8 +600,7 @@ void CefRenderWidgetHostViewOSR::UpdateCursor(
CefRefPtr<CefRenderHandler> handler =
browser_impl_->GetClient()->GetRenderHandler();
if (!handler.get())
return;
CHECK(handler);
content::CursorInfo cursor_info;
cursor.GetCursorInfo(&cursor_info);
@ -717,25 +721,26 @@ void CefRenderWidgetHostViewOSR::GetScreenInfo(
CefRefPtr<CefRenderHandler> handler =
browser_impl_->client()->GetRenderHandler();
if (handler.get() &&
(!handler->GetScreenInfo(browser_impl_.get(), screen_info) ||
screen_info.rect.width == 0 || screen_info.rect.height == 0 ||
screen_info.available_rect.width == 0 ||
screen_info.available_rect.height == 0)) {
CHECK(handler);
if (!handler->GetScreenInfo(browser_impl_.get(), screen_info) ||
screen_info.rect.width == 0 || screen_info.rect.height == 0 ||
screen_info.available_rect.width == 0 ||
screen_info.available_rect.height == 0) {
// If a screen rectangle was not provided, try using the view rectangle
// instead. Otherwise, popup views may be drawn incorrectly, or not at all.
CefRect screenRect;
if (!handler->GetViewRect(browser_impl_.get(), screenRect)) {
NOTREACHED();
screenRect = CefRect();
handler->GetViewRect(browser_impl_.get(), screenRect);
CHECK_GT(screenRect.width, 0);
CHECK_GT(screenRect.height, 0);
if (screen_info.rect.width == 0 || screen_info.rect.height == 0) {
screen_info.rect = screenRect;
}
if (screen_info.rect.width == 0 && screen_info.rect.height == 0)
screen_info.rect = screenRect;
if (screen_info.available_rect.width == 0 &&
screen_info.available_rect.height == 0)
if (screen_info.available_rect.width == 0 ||
screen_info.available_rect.height == 0) {
screen_info.available_rect = screenRect;
}
}
*results = ScreenInfoFrom(screen_info);
@ -751,7 +756,8 @@ gfx::Rect CefRenderWidgetHostViewOSR::GetBoundsInRootWindow() {
CefRect rc;
CefRefPtr<CefRenderHandler> handler =
browser_impl_->client()->GetRenderHandler();
if (handler.get() && handler->GetRootScreenRect(browser_impl_.get(), rc))
CHECK(handler);
if (handler->GetRootScreenRect(browser_impl_.get(), rc))
return gfx::Rect(rc.x, rc.y, rc.width, rc.height);
return GetViewBounds();
}
@ -852,11 +858,11 @@ void CefRenderWidgetHostViewOSR::SelectionChanged(const base::string16& text,
CefRefPtr<CefRenderHandler> handler =
browser_impl_->GetClient()->GetRenderHandler();
if (handler.get()) {
CefRange cef_range(range.start(), range.end());
handler->OnTextSelectionChanged(browser_impl_.get(), selected_text,
cef_range);
}
CHECK(handler);
CefRange cef_range(range.start(), range.end());
handler->OnTextSelectionChanged(browser_impl_.get(), selected_text,
cef_range);
}
#if !defined(OS_MACOSX)
@ -1242,8 +1248,7 @@ void CefRenderWidgetHostViewOSR::OnPaint(const gfx::Rect& damage_rect,
CefRefPtr<CefRenderHandler> handler =
browser_impl_->client()->GetRenderHandler();
if (!handler.get())
return;
CHECK(handler);
// Don't execute SynchronizeVisualProperties while the OnPaint callback is
// pending.
@ -1326,8 +1331,8 @@ void CefRenderWidgetHostViewOSR::SetDeviceScaleFactor() {
CefRect());
CefRefPtr<CefRenderHandler> handler =
browser_impl_->client()->GetRenderHandler();
if (handler.get() &&
handler->GetScreenInfo(browser_impl_.get(), screen_info)) {
CHECK(handler);
if (handler->GetScreenInfo(browser_impl_.get(), screen_info)) {
new_scale_factor = screen_info.device_scale_factor;
}
}
@ -1432,8 +1437,8 @@ void CefRenderWidgetHostViewOSR::CancelWidget() {
if (IsPopupWidget() && browser_impl_.get()) {
CefRefPtr<CefRenderHandler> handler =
browser_impl_->client()->GetRenderHandler();
if (handler.get())
handler->OnPopupShow(browser_impl_.get(), false);
CHECK(handler);
handler->OnPopupShow(browser_impl_.get(), false);
browser_impl_ = NULL;
}
@ -1467,11 +1472,9 @@ void CefRenderWidgetHostViewOSR::OnScrollOffsetChanged() {
if (browser_impl_.get()) {
CefRefPtr<CefRenderHandler> handler =
browser_impl_->client()->GetRenderHandler();
if (handler.get()) {
handler->OnScrollOffsetChanged(browser_impl_.get(),
last_scroll_offset_.x(),
last_scroll_offset_.y());
}
CHECK(handler);
handler->OnScrollOffsetChanged(browser_impl_.get(), last_scroll_offset_.x(),
last_scroll_offset_.y());
}
is_scroll_offset_changed_pending_ = false;
}
@ -1534,10 +1537,9 @@ void CefRenderWidgetHostViewOSR::ImeCompositionRangeChanged(
CefRefPtr<CefRenderHandler> handler =
browser_impl_->GetClient()->GetRenderHandler();
if (handler.get()) {
handler->OnImeCompositionRangeChanged(browser_impl_->GetBrowser(),
cef_range, rcList);
}
CHECK(handler);
handler->OnImeCompositionRangeChanged(browser_impl_->GetBrowser(),
cef_range, rcList);
}
}

15
libcef_dll/cpptoc/render_handler_cpptoc.cc
View File

@ -9,7 +9,7 @@
// implementations. See the translator.README.txt file in the tools directory
// for more information.
//
// $hash=98625368df8daaeca9df1791f1867828a6271a89$
// $hash=6cf6466ab2a1b87a1b57b5994aab64992b9f12dd$
//
#include "libcef_dll/cpptoc/render_handler_cpptoc.h"
@ -70,7 +70,7 @@ render_handler_get_root_screen_rect(struct _cef_render_handler_t* self,
return _retval;
}
int CEF_CALLBACK
void CEF_CALLBACK
render_handler_get_view_rect(struct _cef_render_handler_t* self,
cef_browser_t* browser,
cef_rect_t* rect) {
@ -78,29 +78,26 @@ render_handler_get_view_rect(struct _cef_render_handler_t* self,
DCHECK(self);
if (!self)
return 0;
return;
// Verify param: browser; type: refptr_diff
DCHECK(browser);
if (!browser)
return 0;
return;
// Verify param: rect; type: simple_byref
DCHECK(rect);
if (!rect)
return 0;
return;
// Translate param: rect; type: simple_byref
CefRect rectVal = rect ? *rect : CefRect();
// Execute
bool _retval = CefRenderHandlerCppToC::Get(self)->GetViewRect(
CefRenderHandlerCppToC::Get(self)->GetViewRect(
CefBrowserCToCpp::Wrap(browser), rectVal);
// Restore param: rect; type: simple_byref
if (rect)
*rect = rectVal;
// Return type: bool
return _retval;
}
int CEF_CALLBACK

14
libcef_dll/ctocpp/render_handler_ctocpp.cc
View File

@ -9,7 +9,7 @@
// implementations. See the translator.README.txt file in the tools directory
// for more information.
//
// $hash=bd2800111c1f3f3a5c6107d0454a2b5fe67067b6$
// $hash=db89496c825cdc7fe1eaa4b7822d8492ae3a3f23$
//
#include "libcef_dll/ctocpp/render_handler_ctocpp.h"
@ -59,25 +59,21 @@ bool CefRenderHandlerCToCpp::GetRootScreenRect(CefRefPtr<CefBrowser> browser,
}
NO_SANITIZE("cfi-icall")
bool CefRenderHandlerCToCpp::GetViewRect(CefRefPtr<CefBrowser> browser,
void CefRenderHandlerCToCpp::GetViewRect(CefRefPtr<CefBrowser> browser,
CefRect& rect) {
cef_render_handler_t* _struct = GetStruct();
if (CEF_MEMBER_MISSING(_struct, get_view_rect))
return false;
return;
// AUTO-GENERATED CONTENT - DELETE THIS COMMENT BEFORE MODIFYING
// Verify param: browser; type: refptr_diff
DCHECK(browser.get());
if (!browser.get())
return false;
return;
// Execute
int _retval =
_struct->get_view_rect(_struct, CefBrowserCppToC::Wrap(browser), &rect);
// Return type: bool
return _retval ? true : false;
_struct->get_view_rect(_struct, CefBrowserCppToC::Wrap(browser), &rect);
}
NO_SANITIZE("cfi-icall")

4
libcef_dll/ctocpp/render_handler_ctocpp.h
View File

@ -9,7 +9,7 @@
// implementations. See the translator.README.txt file in the tools directory
// for more information.
//
// $hash=9e2bcb61512095fba2fca928f4696fbb39d9d3b1$
// $hash=46dd8560076264a776129a02ba11e2c2f56bf209$
//
#ifndef CEF_LIBCEF_DLL_CTOCPP_RENDER_HANDLER_CTOCPP_H_
@ -36,7 +36,7 @@ class CefRenderHandlerCToCpp
// CefRenderHandler methods.
CefRefPtr<CefAccessibilityHandler> GetAccessibilityHandler() override;
bool GetRootScreenRect(CefRefPtr<CefBrowser> browser, CefRect& rect) override;
bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) override;
void GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) override;
bool GetScreenPoint(CefRefPtr<CefBrowser> browser,
int viewX,
int viewY,

13
tests/cefclient/browser/browser_window_osr_gtk.cc
View File

@ -1122,12 +1122,17 @@ bool BrowserWindowOsrGtk::GetRootScreenRect(CefRefPtr<CefBrowser> browser,
return false;
}
bool BrowserWindowOsrGtk::GetViewRect(CefRefPtr<CefBrowser> browser,
void BrowserWindowOsrGtk::GetViewRect(CefRefPtr<CefBrowser> browser,
CefRect& rect) {
CEF_REQUIRE_UI_THREAD();
if (!glarea_)
return false;
rect.x = rect.y = 0;
if (!glarea_) {
// Never return an empty rectangle.
rect.width = rect.height = 1;
return;
}
float device_scale_factor;
{
@ -1137,11 +1142,9 @@ bool BrowserWindowOsrGtk::GetViewRect(CefRefPtr<CefBrowser> browser,
// The simulated screen and view rectangle are the same. This is necessary
// for popup menus to be located and sized inside the view.
rect.x = rect.y = 0;
rect.width = DeviceToLogical(glarea_->allocation.width, device_scale_factor);
rect.height =
DeviceToLogical(glarea_->allocation.height, device_scale_factor);
return true;
}
bool BrowserWindowOsrGtk::GetScreenPoint(CefRefPtr<CefBrowser> browser,

2
tests/cefclient/browser/browser_window_osr_gtk.h
View File

@ -55,7 +55,7 @@ class BrowserWindowOsrGtk : public BrowserWindow,
void OnAfterCreated(CefRefPtr<CefBrowser> browser) OVERRIDE;
void OnBeforeClose(CefRefPtr<CefBrowser> browser) OVERRIDE;
bool GetRootScreenRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
void GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
bool GetScreenPoint(CefRefPtr<CefBrowser> browser,
int viewX,
int viewY,

2
tests/cefclient/browser/browser_window_osr_mac.h
View File

@ -52,7 +52,7 @@ class BrowserWindowOsrMac : public BrowserWindow,
void OnAfterCreated(CefRefPtr<CefBrowser> browser) OVERRIDE;
void OnBeforeClose(CefRefPtr<CefBrowser> browser) OVERRIDE;
bool GetRootScreenRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
void GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
bool GetScreenPoint(CefRefPtr<CefBrowser> browser,
int viewX,
int viewY,

14
tests/cefclient/browser/browser_window_osr_mac.mm
View File

@ -1348,13 +1348,18 @@ bool BrowserWindowOsrMac::GetRootScreenRect(CefRefPtr<CefBrowser> browser,
return false;
}
bool BrowserWindowOsrMac::GetViewRect(CefRefPtr<CefBrowser> browser,
void BrowserWindowOsrMac::GetViewRect(CefRefPtr<CefBrowser> browser,
CefRect& rect) {
CEF_REQUIRE_UI_THREAD();
REQUIRE_MAIN_THREAD();
if (!nsview_)
return false;
rect.x = rect.y = 0;
if (!nsview_) {
// Never return an empty rectangle.
rect.width = rect.height = 1;
return;
}
const float device_scale_factor = [GLView(nsview_) getDeviceScaleFactor];
@ -1365,11 +1370,8 @@ bool BrowserWindowOsrMac::GetViewRect(CefRefPtr<CefBrowser> browser,
bounds = [GLView(nsview_) convertRectToBackingInternal:bounds];
// Convert to browser view coordinates.
rect.x = rect.y = 0;
rect.width = DeviceToLogical(bounds.size.width, device_scale_factor);
rect.height = DeviceToLogical(bounds.size.height, device_scale_factor);
return true;
}
bool BrowserWindowOsrMac::GetScreenPoint(CefRefPtr<CefBrowser> browser,

11
tests/cefclient/browser/client_handler_osr.cc
View File

@ -50,12 +50,15 @@ bool ClientHandlerOsr::GetRootScreenRect(CefRefPtr<CefBrowser> browser,
return osr_delegate_->GetRootScreenRect(browser, rect);
}
bool ClientHandlerOsr::GetViewRect(CefRefPtr<CefBrowser> browser,
void ClientHandlerOsr::GetViewRect(CefRefPtr<CefBrowser> browser,
CefRect& rect) {
CEF_REQUIRE_UI_THREAD();
if (!osr_delegate_)
return false;
return osr_delegate_->GetViewRect(browser, rect);
if (!osr_delegate_) {
// Never return an empty rectangle.
rect.width = rect.height = 1;
return;
}
osr_delegate_->GetViewRect(browser, rect);
}
bool ClientHandlerOsr::GetScreenPoint(CefRefPtr<CefBrowser> browser,

4
tests/cefclient/browser/client_handler_osr.h
View File

@ -27,7 +27,7 @@ class ClientHandlerOsr : public ClientHandler,
// These methods match the CefRenderHandler interface.
virtual bool GetRootScreenRect(CefRefPtr<CefBrowser> browser,
CefRect& rect) = 0;
virtual bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) = 0;
virtual void GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) = 0;
virtual bool GetScreenPoint(CefRefPtr<CefBrowser> browser,
int viewX,
int viewY,
@ -87,7 +87,7 @@ class ClientHandlerOsr : public ClientHandler,
// CefRenderHandler methods.
bool GetRootScreenRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
void GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
bool GetScreenPoint(CefRefPtr<CefBrowser> browser,
int viewX,
int viewY,

3
tests/cefclient/browser/osr_window_win.cc
View File

@ -870,7 +870,7 @@ bool OsrWindowWin::GetRootScreenRect(CefRefPtr<CefBrowser> browser,
return false;
}
bool OsrWindowWin::GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) {
void OsrWindowWin::GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) {
CEF_REQUIRE_UI_THREAD();
DCHECK_GT(device_scale_factor_, 0);
@ -879,7 +879,6 @@ bool OsrWindowWin::GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) {
device_scale_factor_);
rect.height = DeviceToLogical(client_rect_.bottom - client_rect_.top,
device_scale_factor_);
return true;
}
bool OsrWindowWin::GetScreenPoint(CefRefPtr<CefBrowser> browser,

4
tests/cefclient/browser/osr_window_win.h
View File

@ -27,7 +27,7 @@ class OsrWindowWin
: public base::RefCountedThreadSafe<OsrWindowWin, CefDeleteOnUIThread>,
public ClientHandlerOsr::OsrDelegate
#if defined(CEF_USE_ATL)
,
,
public OsrDragEvents
#endif
{
@ -114,7 +114,7 @@ class OsrWindowWin
void OnAfterCreated(CefRefPtr<CefBrowser> browser) OVERRIDE;
void OnBeforeClose(CefRefPtr<CefBrowser> browser) OVERRIDE;
bool GetRootScreenRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
void GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) OVERRIDE;
bool GetScreenPoint(CefRefPtr<CefBrowser> browser,
int viewX,
int viewY,

5
tests/ceftests/os_rendering_unittest.cc
View File

@ -324,13 +324,12 @@ class OSRTestHandler : public RoutingTestHandler,
}
// CefRenderHandler methods
bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) override {
void GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) override {
if (test_type_ == OSR_TEST_RESIZE && started()) {
rect = CefRect(0, 0, kOsrWidth * 2, kOsrHeight * 2);
return true;
return;
}
rect = CefRect(0, 0, kOsrWidth, kOsrHeight);
return true;
}
bool GetScreenPoint(CefRefPtr<CefBrowser> browser,

3
tests/ceftests/osr_accessibility_unittest.cc
View File

@ -47,9 +47,8 @@ class AccessibilityTestHandler : public TestHandler,
CefRefPtr<CefRenderHandler> GetRenderHandler() override { return this; }
// Cef Renderer Handler Methods
bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) override {
void GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) override {
rect = CefRect(0, 0, kOsrWidth, kOsrHeight);
return true;
}
bool GetScreenInfo(CefRefPtr<CefBrowser> browser,

3
tests/ceftests/osr_display_unittest.cc
View File

@ -24,9 +24,8 @@ class DisplayTestHandler : public RoutingTestHandler, public CefRenderHandler {
CefRefPtr<CefRenderHandler> GetRenderHandler() override { return this; }
bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) override {
void GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) override {
rect = CefRect(0, 0, kOsrWidth, kOsrHeight);
return true;
}
bool GetScreenInfo(CefRefPtr<CefBrowser> browser,