mirror of
https://github.com/electron/electron.git
synced 2026-02-19 03:14:51 -05:00
275 lines
9.2 KiB
C++
275 lines
9.2 KiB
C++
// Copyright (c) 2013 GitHub, Inc.
|
|
// Use of this source code is governed by the MIT license that can be
|
|
// found in the LICENSE file.
|
|
|
|
#include "shell/browser/api/electron_api_screen.h"
|
|
|
|
#include <string>
|
|
#include <string_view>
|
|
|
|
#include "base/functional/bind.h"
|
|
#include "shell/browser/browser.h"
|
|
#include "shell/common/gin_converters/gfx_converter.h"
|
|
#include "shell/common/gin_converters/native_window_converter.h"
|
|
#include "shell/common/gin_helper/dictionary.h"
|
|
#include "shell/common/gin_helper/error_thrower.h"
|
|
#include "shell/common/gin_helper/object_template_builder.h"
|
|
#include "shell/common/node_includes.h"
|
|
#include "ui/display/display.h"
|
|
#include "ui/display/screen.h"
|
|
#include "ui/gfx/geometry/point.h"
|
|
#include "ui/gfx/geometry/point_conversions.h"
|
|
#include "ui/gfx/geometry/point_f.h"
|
|
#include "ui/gfx/geometry/vector2d_conversions.h"
|
|
#include "v8/include/cppgc/allocation.h"
|
|
#include "v8/include/v8-cppgc.h"
|
|
|
|
#if BUILDFLAG(IS_WIN)
|
|
#include "ui/display/win/screen_win.h"
|
|
#endif
|
|
|
|
#if BUILDFLAG(IS_LINUX)
|
|
#include "shell/browser/linux/x11_util.h"
|
|
#endif
|
|
|
|
#if defined(USE_OZONE)
|
|
#include "ui/ozone/public/ozone_platform.h"
|
|
#endif
|
|
|
|
namespace electron::api {
|
|
|
|
const gin::WrapperInfo Screen::kWrapperInfo = {{gin::kEmbedderNativeGin},
|
|
gin::kElectronScreen};
|
|
|
|
namespace {
|
|
|
|
// Convert the changed_metrics bitmask to string array.
|
|
std::vector<std::string> MetricsToArray(uint32_t metrics) {
|
|
std::vector<std::string> array;
|
|
if (metrics & display::DisplayObserver::DISPLAY_METRIC_BOUNDS)
|
|
array.emplace_back("bounds");
|
|
if (metrics & display::DisplayObserver::DISPLAY_METRIC_WORK_AREA)
|
|
array.emplace_back("workArea");
|
|
if (metrics & display::DisplayObserver::DISPLAY_METRIC_DEVICE_SCALE_FACTOR)
|
|
array.emplace_back("scaleFactor");
|
|
if (metrics & display::DisplayObserver::DISPLAY_METRIC_ROTATION)
|
|
array.emplace_back("rotation");
|
|
return array;
|
|
}
|
|
|
|
void DelayEmit(Screen* screen,
|
|
const std::string_view name,
|
|
const display::Display& display) {
|
|
screen->Emit(name, display);
|
|
}
|
|
|
|
void DelayEmitWithMetrics(Screen* screen,
|
|
const std::string_view name,
|
|
const display::Display& display,
|
|
const std::vector<std::string>& metrics) {
|
|
screen->Emit(name, display, metrics);
|
|
}
|
|
|
|
// Calls the one-liner `display::Screen::Get()` to get ui's global screen.
|
|
// NOTE: during shutdown, that screen can be destroyed before us. This means:
|
|
// 1. Call this instead of keeping a possibly-dangling raw_ptr in api::Screen.
|
|
// 2. Always check this function's return value for nullptr before use.
|
|
[[nodiscard]] auto* GetDisplayScreen() {
|
|
return display::Screen::Get();
|
|
}
|
|
|
|
[[nodiscard]] auto GetFallbackDisplay() {
|
|
return display::Display::GetDefaultDisplay();
|
|
}
|
|
} // namespace
|
|
|
|
Screen::Screen() {
|
|
if (auto* screen = GetDisplayScreen())
|
|
screen->AddObserver(this);
|
|
}
|
|
|
|
Screen::~Screen() {
|
|
if (auto* screen = GetDisplayScreen())
|
|
screen->RemoveObserver(this);
|
|
}
|
|
|
|
gfx::Point Screen::GetCursorScreenPoint(v8::Isolate* isolate) {
|
|
#if defined(USE_OZONE)
|
|
// Wayland will crash unless a window is created prior to calling
|
|
// GetCursorScreenPoint.
|
|
if (!ui::OzonePlatform::IsInitialized()) {
|
|
gin_helper::ErrorThrower thrower(isolate);
|
|
thrower.ThrowError(
|
|
"screen.getCursorScreenPoint() cannot be called before a window has "
|
|
"been created.");
|
|
return {};
|
|
}
|
|
#endif
|
|
auto* screen = GetDisplayScreen();
|
|
return screen ? screen->GetCursorScreenPoint() : gfx::Point{};
|
|
}
|
|
|
|
display::Display Screen::GetPrimaryDisplay() const {
|
|
const auto* screen = GetDisplayScreen();
|
|
return screen ? screen->GetPrimaryDisplay() : GetFallbackDisplay();
|
|
}
|
|
|
|
std::vector<display::Display> Screen::GetAllDisplays() const {
|
|
if (const auto* screen = GetDisplayScreen())
|
|
return screen->GetAllDisplays();
|
|
|
|
// Even though this is only reached during shutdown by Screen::Get() failing,
|
|
// display::Screen::GetAllDisplays() is guaranteed to return >= 1 display.
|
|
// For consistency with that API, let's return a nonempty vector here.
|
|
return {GetFallbackDisplay()};
|
|
}
|
|
|
|
display::Display Screen::GetDisplayNearestPoint(const gfx::Point& point) const {
|
|
const auto* screen = GetDisplayScreen();
|
|
return screen ? screen->GetDisplayNearestPoint(point) : GetFallbackDisplay();
|
|
}
|
|
|
|
display::Display Screen::GetDisplayMatching(const gfx::Rect& match_rect) const {
|
|
const auto* screen = GetDisplayScreen();
|
|
return screen ? screen->GetDisplayMatching(match_rect) : GetFallbackDisplay();
|
|
}
|
|
|
|
#if BUILDFLAG(IS_WIN)
|
|
|
|
static gfx::Rect ScreenToDIPRect(electron::NativeWindow* window,
|
|
const gfx::Rect& rect) {
|
|
HWND hwnd = window ? window->GetAcceleratedWidget() : nullptr;
|
|
return display::win::GetScreenWin()->ScreenToDIPRect(hwnd, rect);
|
|
}
|
|
|
|
static gfx::Rect DIPToScreenRect(electron::NativeWindow* window,
|
|
const gfx::Rect& rect) {
|
|
HWND hwnd = window ? window->GetAcceleratedWidget() : nullptr;
|
|
return display::win::GetScreenWin()->DIPToScreenRect(hwnd, rect);
|
|
}
|
|
|
|
#endif
|
|
|
|
void Screen::OnDisplayAdded(const display::Display& new_display) {
|
|
base::SingleThreadTaskRunner::GetCurrentDefault()->PostNonNestableTask(
|
|
FROM_HERE, base::BindOnce(&DelayEmit, base::Unretained(this),
|
|
"display-added", new_display));
|
|
}
|
|
|
|
void Screen::OnDisplaysRemoved(const display::Displays& old_displays) {
|
|
for (const auto& old_display : old_displays) {
|
|
base::SingleThreadTaskRunner::GetCurrentDefault()->PostNonNestableTask(
|
|
FROM_HERE, base::BindOnce(&DelayEmit, base::Unretained(this),
|
|
"display-removed", old_display));
|
|
}
|
|
}
|
|
|
|
void Screen::OnDisplayMetricsChanged(const display::Display& display,
|
|
uint32_t changed_metrics) {
|
|
base::SingleThreadTaskRunner::GetCurrentDefault()->PostNonNestableTask(
|
|
FROM_HERE, base::BindOnce(&DelayEmitWithMetrics, base::Unretained(this),
|
|
"display-metrics-changed", display,
|
|
MetricsToArray(changed_metrics)));
|
|
}
|
|
|
|
gfx::PointF Screen::ScreenToDIPPoint(const gfx::PointF& point_px) {
|
|
#if BUILDFLAG(IS_WIN)
|
|
return display::win::GetScreenWin()->ScreenToDIPPoint(point_px);
|
|
#elif BUILDFLAG(IS_LINUX)
|
|
if (x11_util::IsX11()) {
|
|
gfx::Point pt_px = gfx::ToFlooredPoint(point_px);
|
|
display::Display display = GetDisplayNearestPoint(pt_px);
|
|
gfx::Vector2d delta_px = pt_px - display.native_origin();
|
|
gfx::Vector2dF delta_dip =
|
|
gfx::ScaleVector2d(delta_px, 1.0 / display.device_scale_factor());
|
|
return gfx::PointF(display.bounds().origin()) + delta_dip;
|
|
} else {
|
|
return point_px;
|
|
}
|
|
#else
|
|
return point_px;
|
|
#endif
|
|
}
|
|
|
|
gfx::Point Screen::DIPToScreenPoint(const gfx::Point& point_dip) {
|
|
#if BUILDFLAG(IS_WIN)
|
|
return display::win::GetScreenWin()->DIPToScreenPoint(point_dip);
|
|
#elif BUILDFLAG(IS_LINUX)
|
|
if (x11_util::IsX11()) {
|
|
display::Display display = GetDisplayNearestPoint(point_dip);
|
|
gfx::Rect bounds_dip = display.bounds();
|
|
gfx::Vector2d delta_dip = point_dip - bounds_dip.origin();
|
|
gfx::Vector2d delta_px = gfx::ToFlooredVector2d(
|
|
gfx::ScaleVector2d(delta_dip, display.device_scale_factor()));
|
|
return display.native_origin() + delta_px;
|
|
} else {
|
|
return point_dip;
|
|
}
|
|
#else
|
|
return point_dip;
|
|
#endif
|
|
}
|
|
|
|
// static
|
|
Screen* Screen::Create(gin_helper::ErrorThrower error_thrower) {
|
|
if (!Browser::Get()->is_ready()) {
|
|
error_thrower.ThrowError(
|
|
"The 'screen' module can't be used before the app 'ready' event");
|
|
return {};
|
|
}
|
|
|
|
display::Screen* screen = GetDisplayScreen();
|
|
if (!screen) {
|
|
error_thrower.ThrowError("Failed to get screen information");
|
|
return {};
|
|
}
|
|
|
|
return cppgc::MakeGarbageCollected<Screen>(
|
|
error_thrower.isolate()->GetCppHeap()->GetAllocationHandle());
|
|
}
|
|
|
|
gin::ObjectTemplateBuilder Screen::GetObjectTemplateBuilder(
|
|
v8::Isolate* isolate) {
|
|
return gin_helper::EventEmitterMixin<Screen>::GetObjectTemplateBuilder(
|
|
isolate)
|
|
.SetMethod("getCursorScreenPoint", &Screen::GetCursorScreenPoint)
|
|
.SetMethod("getPrimaryDisplay", &Screen::GetPrimaryDisplay)
|
|
.SetMethod("getAllDisplays", &Screen::GetAllDisplays)
|
|
.SetMethod("getDisplayNearestPoint", &Screen::GetDisplayNearestPoint)
|
|
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_LINUX)
|
|
.SetMethod("screenToDipPoint", &Screen::ScreenToDIPPoint)
|
|
.SetMethod("dipToScreenPoint", &Screen::DIPToScreenPoint)
|
|
#endif
|
|
#if BUILDFLAG(IS_WIN)
|
|
.SetMethod("screenToDipRect", &ScreenToDIPRect)
|
|
.SetMethod("dipToScreenRect", &DIPToScreenRect)
|
|
#endif
|
|
.SetMethod("getDisplayMatching", &Screen::GetDisplayMatching);
|
|
}
|
|
|
|
const gin::WrapperInfo* Screen::wrapper_info() const {
|
|
return &kWrapperInfo;
|
|
}
|
|
|
|
const char* Screen::GetHumanReadableName() const {
|
|
return "Electron / Screen";
|
|
}
|
|
} // namespace electron::api
|
|
|
|
namespace {
|
|
|
|
using electron::api::Screen;
|
|
|
|
void Initialize(v8::Local<v8::Object> exports,
|
|
v8::Local<v8::Value> unused,
|
|
v8::Local<v8::Context> context,
|
|
void* priv) {
|
|
v8::Isolate* const isolate = electron::JavascriptEnvironment::GetIsolate();
|
|
gin_helper::Dictionary dict(isolate, exports);
|
|
dict.SetMethod("createScreen", base::BindRepeating(&Screen::Create));
|
|
}
|
|
|
|
} // namespace
|
|
|
|
NODE_LINKED_BINDING_CONTEXT_AWARE(electron_browser_screen, Initialize)
|