1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ui/ozone/platform/wayland/host/wayland_toplevel_window.h"
#include <string>
#include "base/nix/xdg_util.h"
#include "base/numerics/safe_conversions.h"
#include "base/run_loop.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/utf_string_conversions.h"
#include "base/unguessable_token.h"
#include "third_party/skia/include/core/SkPath.h"
#include "ui/base/hit_test.h"
#include "ui/base/ui_base_features.h"
#include "ui/display/types/display_constants.h"
#include "ui/events/base_event_utils.h"
#include "ui/gfx/geometry/insets.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/gfx/native_widget_types.h"
#include "ui/ozone/platform/wayland/host/dump_util.h"
#include "ui/ozone/platform/wayland/host/org_kde_kwin_appmenu.h"
#include "ui/ozone/platform/wayland/host/wayland_bubble.h"
#include "ui/ozone/platform/wayland/host/wayland_buffer_manager_host.h"
#include "ui/ozone/platform/wayland/host/wayland_connection.h"
#include "ui/ozone/platform/wayland/host/wayland_data_drag_controller.h"
#include "ui/ozone/platform/wayland/host/wayland_event_source.h"
#include "ui/ozone/platform/wayland/host/wayland_frame_manager.h"
#include "ui/ozone/platform/wayland/host/wayland_output.h"
#include "ui/ozone/platform/wayland/host/wayland_output_manager.h"
#include "ui/ozone/platform/wayland/host/wayland_popup.h"
#include "ui/ozone/platform/wayland/host/wayland_window.h"
#include "ui/ozone/platform/wayland/host/wayland_window_drag_controller.h"
#include "ui/ozone/platform/wayland/host/wayland_zwp_pointer_constraints.h"
#include "ui/ozone/platform/wayland/host/xdg_activation.h"
#include "ui/ozone/platform/wayland/host/xdg_session.h"
#include "ui/ozone/platform/wayland/host/xdg_surface.h"
#include "ui/ozone/platform/wayland/host/xdg_toplevel.h"
#include "ui/platform_window/common/platform_window_defaults.h"
#include "ui/platform_window/extensions/wayland_extension.h"
#include "ui/platform_window/platform_window_delegate.h"
namespace ui {
namespace {
bool ShouldSetBounds(PlatformWindowState state) {
return state == PlatformWindowState::kNormal;
}
} // namespace
constexpr int kVisibleOnAllWorkspaces = -1;
WaylandToplevelWindow::WaylandToplevelWindow(PlatformWindowDelegate* delegate,
WaylandConnection* connection)
: WaylandWindow(delegate, connection) {
// Set a class property key, which allows |this| to be used for interactive
// events, e.g. move or resize.
SetWmMoveResizeHandler(this, AsWmMoveResizeHandler());
}
WaylandToplevelWindow::~WaylandToplevelWindow() = default;
bool WaylandToplevelWindow::CreateXdgToplevel() {
if (auto xdg_surface = std::make_unique<XdgSurface>(this, connection())) {
if (xdg_surface->Initialize()) {
auto xdg_toplevel = std::make_unique<XdgToplevel>(std::move(xdg_surface));
if (xdg_toplevel && xdg_toplevel->Initialize()) {
xdg_toplevel_ = std::move(xdg_toplevel);
}
}
}
if (!xdg_toplevel_) {
LOG(ERROR) << "Failed to create a XdgToplevel.";
return false;
}
xdg_toplevel_->SetAppId(app_id_);
xdg_toplevel_->SetTitle(window_title_);
SetSizeConstraints();
TriggerStateChanges(GetPlatformWindowState());
SetUpShellIntegration();
OnDecorationModeChanged();
// If session management is supported and session data was passed in at
// construction time, with a valid `restore_id`, restoring this toplevel
// must be done now, before the first wl_surface commit. The remaining
// handling steps are done when the first xdg_surface.configure comes in
// (see HandleToplevelConfigure and UpdateSessionStateIfNeeded).
if (session_ && session_data_->restore_id) {
toplevel_session_ = session_->TrackToplevel(
this, session_data_->restore_id.value(), XdgSession::Action::kRestore);
}
if (!initial_icon_.isNull()) {
SetWindowIcons(gfx::ImageSkia(), initial_icon_);
initial_icon_ = gfx::ImageSkia();
}
// This could be the proper time to update window mask using
// NonClientView::GetWindowMask, since |non_client_view| is not created yet
// during the call to WaylandWindow::Initialize().
UpdateWindowMask();
root_surface()->Commit(true);
return true;
}
void WaylandToplevelWindow::DispatchHostWindowDragMovement(
int hittest,
const gfx::Point& pointer_location_in_px) {
DCHECK(xdg_toplevel_);
if (hittest == HTCAPTION)
xdg_toplevel_->SurfaceMove(connection());
else
xdg_toplevel_->SurfaceResize(connection(), hittest);
connection()->Flush();
// TODO(crbug.com/40917147): Revisit to resolve the correct impl.
connection()->event_source()->ReleasePressedPointerButtons(this,
EventTimeForNow());
}
void WaylandToplevelWindow::Show(bool inactive) {
if (xdg_toplevel_) {
return;
}
if (!CreateXdgToplevel()) {
Close();
return;
}
UpdateWindowScale(false);
if (inactive)
Deactivate();
WaylandWindow::Show(inactive);
}
void WaylandToplevelWindow::Hide() {
if (!xdg_toplevel_) {
return;
}
if (child_popup()) {
child_popup()->Hide();
set_child_popup(nullptr);
}
for (auto bubble : child_bubbles()) {
bubble->Hide();
}
// Note that the xdg_toplevel object should be destroyed before we touch
// anything else in order to provide the compositor a good reference point
// when the window contents can be frozen in case a window closing animation
// needs to be played. Ideally, the xdg_toplevel object should also be
// destroyed before any subsurface is destroyed, otherwise the window may have
// missing contents when the compositor animates it.
//
// The xdg-shell spec provides another way to hide a window: attach a nil
// buffer to the root surface. However, compositors often get it wrong, and it
// makes sense only if the xdg_toplevel object is going to be reused, which is
// not the case here.
xdg_toplevel_.reset();
toplevel_session_.reset();
appmenu_.reset();
WaylandWindow::Hide();
ClearInFlightRequestsSerial();
connection()->Flush();
}
bool WaylandToplevelWindow::IsVisible() const {
// X and Windows return true if the window is minimized. For consistency, do
// the same.
return !!xdg_toplevel_ ||
GetPlatformWindowState() == PlatformWindowState::kMinimized;
}
void WaylandToplevelWindow::SetTitle(const std::u16string& title) {
if (window_title_ == title)
return;
window_title_ = title;
if (xdg_toplevel_) {
xdg_toplevel_->SetTitle(title);
connection()->Flush();
}
}
void WaylandToplevelWindow::SetFullscreen(bool fullscreen,
int64_t target_display_id) {
// TODO(msisov, tonikitoo): add multiscreen support. As the documentation says
// if xdg_toplevel_set_fullscreen() is not provided with wl_output, it's up
// to the compositor to choose which display will be used to map this surface.
// The `target_display_id` must be invalid if not going into fullscreen.
DCHECK(fullscreen || target_display_id == display::kInvalidDisplayId);
if (base::FeatureList::IsEnabled(features::kAsyncFullscreenWindowState)) {
if (fullscreen) {
xdg_toplevel_->SetFullscreen(
GetWaylandOutputForDisplayId(target_display_id));
} else {
xdg_toplevel_->UnSetFullscreen();
}
return;
}
// We must track the previous state to correctly say our state as long as it
// can be the maximized instead of normal one.
PlatformWindowState new_state = PlatformWindowState::kUnknown;
int64_t display_id = display::kInvalidDisplayId;
if (fullscreen) {
new_state = PlatformWindowState::kFullScreen;
display_id = target_display_id;
} else if (previously_maximized_) {
new_state = PlatformWindowState::kMaximized;
} else {
new_state = PlatformWindowState::kNormal;
}
SetWindowState(new_state, display_id);
}
void WaylandToplevelWindow::Maximize() {
SetWindowState(PlatformWindowState::kMaximized, display::kInvalidDisplayId);
}
void WaylandToplevelWindow::Minimize() {
if (!xdg_toplevel_) {
// TODO(crbug.com/40276379): Store `PlatformWindowState::kMinimized` to a
// pending state.
return;
}
fullscreen_display_id_ = display::kInvalidDisplayId;
xdg_toplevel_->SetMinimized();
if (IsSurfaceConfigured()) {
// Wayland standard does not have API to notify client apps about
// window minimized. In this case we update the window state here
// synchronously,
//
// We also need to check if the surface is already configured in case of a
// synchronous minimize because a minimized window cannot ack configure.
// This can happen if a minimized window is restored by a session restore.
//
// TODO(crbug.com/40058672): Verify that the claim about a window
// initialized as a minimized window cannot ack configure. If not
// `IsSurfaceConfigured()` condition can be removed.
//
// TODO(crbug.com/40276379): Use `GetLatestRequestedState().window_state`
// instead once the window state becomes async.
auto previous_state = applied_state().window_state;
previously_maximized_ = previous_state == PlatformWindowState::kMaximized;
ForceApplyWindowStateDoNotUse(PlatformWindowState::kMinimized);
delegate()->OnWindowStateChanged(previous_state,
PlatformWindowState::kMinimized);
}
}
void WaylandToplevelWindow::Restore() {
DCHECK(xdg_toplevel_);
// Differently from other platforms, under Wayland, unmaximizing the dragged
// window before starting the drag loop is not needed as it is assumed to be
// handled at compositor side, just like in xdg_toplevel_surface::move. So
// skip it if there's a window drag session running.
auto* drag_controller = connection()->window_drag_controller();
if (drag_controller && drag_controller->IsDragInProgress()) {
return;
}
SetWindowState(PlatformWindowState::kNormal, display::kInvalidDisplayId);
}
void WaylandToplevelWindow::ShowWindowControlsMenu(const gfx::Point& point) {
if (xdg_toplevel_) {
xdg_toplevel_->ShowWindowMenu(
connection(),
gfx::ScaleToRoundedPoint(point, applied_state().ui_scale));
}
}
void WaylandToplevelWindow::ActivateWithToken(std::string token) {
DCHECK(connection()->xdg_activation());
bool can_activate = IsSurfaceConfigured();
// Stacking the dragged xdg toplevel as the topmost one (and tied to the
// pointer cursor) is reponsibility of the Wayland compositor, so bail out
// if `this` is currently being dragged.
if (auto* drag_controller = connection()->window_drag_controller()) {
can_activate &= !drag_controller->IsDraggingWindow(this);
}
if (can_activate) {
connection()->xdg_activation()->Activate(root_surface()->surface(), token);
}
}
void WaylandToplevelWindow::Activate() {
if (connection()->xdg_activation()) {
if (auto token = base::nix::TakeXdgActivationToken()) {
ActivateWithToken(token.value());
} else {
connection()->xdg_activation()->RequestNewToken(
base::BindOnce(&WaylandToplevelWindow::ActivateWithToken,
weak_ptr_factory_.GetWeakPtr()));
}
connection()->Flush();
}
WaylandWindow::Activate();
}
void WaylandToplevelWindow::SetWindowIcons(const gfx::ImageSkia& window_icon,
const gfx::ImageSkia& app_icon) {
if (!xdg_toplevel_) {
return;
}
// Let the app icon take precedence over the window icon.
if (!app_icon.isNull()) {
xdg_toplevel_->SetIcon(app_icon);
} else if (!window_icon.isNull()) {
xdg_toplevel_->SetIcon(window_icon);
} else {
// Don't reset the icon if a null icon is passed in. There are callers
// that attempt to set a null icon after the initial icon has been set,
// but don't intend to reset the icon. This matches the behavior of the
// X11 backend.
return;
}
}
void WaylandToplevelWindow::SizeConstraintsChanged() {
// Size constraints only make sense for normal windows.
if (!xdg_toplevel_) {
return;
}
SetSizeConstraints();
}
void WaylandToplevelWindow::SetZOrderLevel(ZOrderLevel order) {
// TODO(crbug.com/374244479): Linux/Wayland doesn't support zorder level.
// Consider complete removal of that.
z_order_ = order;
}
ZOrderLevel WaylandToplevelWindow::GetZOrderLevel() const {
return z_order_;
}
std::string WaylandToplevelWindow::GetWindowUniqueId() const {
return app_id_;
}
void WaylandToplevelWindow::SetUseNativeFrame(bool use_native_frame) {
if (use_native_frame_ == use_native_frame)
return;
use_native_frame_ = use_native_frame;
if (xdg_toplevel_) {
OnDecorationModeChanged();
}
UpdateWindowMask();
}
bool WaylandToplevelWindow::ShouldUseNativeFrame() const {
// This depends on availability of xdg-decoration protocol extension.
// Returns false if there is no xdg-decoration protocol extension provided
// even if use_native_frame_ is true.
return use_native_frame_ && connection()->xdg_decoration_manager_v1();
}
bool WaylandToplevelWindow::ShouldUpdateWindowShape() const {
return true;
}
bool WaylandToplevelWindow::CanSetDecorationInsets() const {
return connection()->SupportsSetWindowGeometry();
}
void WaylandToplevelWindow::SetOpaqueRegion(
std::optional<std::vector<gfx::Rect>> region_px) {
opaque_region_px_ = region_px;
root_surface()->set_opaque_region(region_px);
}
void WaylandToplevelWindow::SetInputRegion(
std::optional<std::vector<gfx::Rect>> region_px) {
input_region_px_ = region_px;
root_surface()->set_input_region(region_px);
}
void WaylandToplevelWindow::UpdateWindowScale(bool update_bounds) {
auto old_scale = applied_state().window_scale;
WaylandWindow::UpdateWindowScale(update_bounds);
if (old_scale == applied_state().window_scale) {
return;
}
// Update min/max size in DIP if buffer scale is updated.
SizeConstraintsChanged();
}
WaylandToplevelWindow* WaylandToplevelWindow::AsWaylandToplevelWindow() {
return this;
}
void WaylandToplevelWindow::UpdateActivationState() {
bool prev_is_active = is_active_;
// Determine active state from keyboard focus. If keyboard is unavailable,
// determine it from zwp_text_input_v3::{enter,leave}.
// If neither of those are available, use xdg-shell "activated" state as
// that's the only other hint the compositor provides us on whether our window
// is considered active.
if (connection()->IsKeyboardAvailable()) {
auto* keyboard_focused_window =
connection()->window_manager()->GetCurrentKeyboardFocusedWindow();
is_active_ = keyboard_focused_window &&
keyboard_focused_window->GetRootParentWindow() == this;
} else if (connection()->SupportsTextInputFocus()) {
// Note: Some compositors (sway, niri, cosmic etc.) may not send
// text-input-v3 enter/leave events if an IM framework is not
// installed/running. So text input focus cannot be used always instead of
// keyboard focus above. However, if there is no physical keyboard, there
// should be an IM framework to facilitate inputting text in some way, e.g.
// using a virtual keyboard, and so it should be okay to expect focus to be
// received from text-input in that case if text-input-v3 is available.
auto* text_input_focused_window =
connection()->window_manager()->GetCurrentTextInputFocusedWindow();
is_active_ = text_input_focused_window &&
text_input_focused_window->GetRootParentWindow() == this;
} else {
is_active_ = is_xdg_active_;
}
if (prev_is_active != is_active_) {
if (active_bubble()) {
ActivateBubble(is_active_ ? active_bubble() : nullptr);
} else {
delegate()->OnActivationChanged(is_active_);
}
}
}
void WaylandToplevelWindow::HandleToplevelConfigure(
int32_t width_dip,
int32_t height_dip,
const WindowStates& window_states) {
HandleToplevelConfigureWithOrigin(0, 0, width_dip, height_dip, window_states);
UpdateSessionStateIfNeeded();
}
void WaylandToplevelWindow::HandleToplevelConfigureWithOrigin(
int32_t x,
int32_t y,
int32_t width_dip,
int32_t height_dip,
const WindowStates& window_states) {
// TODO(crbug.com/369952980): Remove once arrays get logged by libwayland.
VLOG(3) << __func__ << " states=[ " << window_states.ToString() << "]";
PlatformWindowState window_state = PlatformWindowState::kUnknown;
if ((GetLatestRequestedState().window_state ==
PlatformWindowState::kMinimized &&
!window_states.is_activated) ||
window_states.is_minimized) {
window_state = PlatformWindowState::kMinimized;
} else if (window_states.is_fullscreen) {
window_state = PlatformWindowState::kFullScreen;
} else if (window_states.is_maximized) {
window_state = PlatformWindowState::kMaximized;
} else {
window_state = PlatformWindowState::kNormal;
}
// No matter what mode we have, the display id doesn't matter at this time
// anymore.
fullscreen_display_id_ = display::kInvalidDisplayId;
// Update state before notifying delegate.
is_xdg_active_ = window_states.is_activated;
bool prev_suspended = is_suspended_;
is_suspended_ = window_states.is_suspended;
// The tiled state affects the window geometry, so apply it here.
// TODO(crbug.com/414831391): Remove this and notify in
// WindowTreeHostPlatform::OnStateUpdate instead like all other state changes.
// The only issue there is when doing that a regression was seen in kwin. See
// the bug description for additional details.
if (window_states.tiled_edges != applied_state().tiled_edges) {
// This configure changes the decoration insets. We should adjust the
// bounds appropriately.
delegate()->OnWindowTiledStateChanged(window_states.tiled_edges);
}
pending_configure_state_.tiled_edges = window_states.tiled_edges;
pending_configure_state_.window_state = window_state;
// Width or height set to 0 means that we should decide on width and height by
// ourselves, but we don't want to set them to anything else. Use restored
// bounds size or the current bounds iff the current state is normal (neither
// maximized nor fullscreen).
//
// Note: if the browser was started with --start-fullscreen and a user exits
// the fullscreen mode, wayland may set the width and height to be 1. Instead,
// explicitly set the bounds to the current desired ones or the previous
// bounds.
gfx::Rect bounds_dip(
pending_configure_state_.bounds_dip.value_or(gfx::Rect()));
if (width_dip > 1 && height_dip > 1) {
bounds_dip.SetRect(x, y, width_dip, height_dip);
const auto& insets = delegate()->CalculateInsetsInDIP(window_state);
if (ShouldSetBounds(window_state) && !insets.IsEmpty()) {
bounds_dip.Inset(-insets);
bounds_dip.set_origin({x, y});
}
// UI Scale must be applied only for size coming from the server. Restored
// and current dip bounds (used below) are already ui-scale'd.
bounds_dip = gfx::ScaleToEnclosingRectIgnoringError(
bounds_dip, 1.f / applied_state().ui_scale);
} else if (ShouldSetBounds(window_state)) {
bounds_dip = !restored_bounds_dip().IsEmpty() ? restored_bounds_dip()
: GetBoundsInDIP();
}
bounds_dip = AdjustBoundsToConstraintsDIP(bounds_dip);
pending_configure_state_.bounds_dip = bounds_dip;
pending_configure_state_.size_px =
delegate()->ConvertRectToPixels(bounds_dip).size();
// Update `restored_bounds_dip_` which is used when the window gets back to
// normal state after it went maximized or fullscreen. It can be client or
// compositor side change, so we must store previous bounds to restore later.
// We reset `restored_bounds_dip_` if the window is normal state, or update it
// to the applied bounds if we don't have any meaningful value stored.
if (ShouldSetBounds(window_state)) {
SetRestoredBoundsInDIP({});
} else if (GetRestoredBoundsInDIP().IsEmpty()) {
SetRestoredBoundsInDIP(GetBoundsInDIP());
}
UpdateActivationState();
if (prev_suspended != is_suspended_) {
frame_manager()->OnWindowSuspensionChanged();
}
}
void WaylandToplevelWindow::SetOrigin(const gfx::Point& origin) {
gfx::Rect new_bounds(origin, GetBoundsInDIP().size());
WaylandWindow::SetBoundsInDIP(new_bounds);
}
void WaylandToplevelWindow::HandleSurfaceConfigure(uint32_t serial) {
ProcessPendingConfigureState(serial);
}
void WaylandToplevelWindow::OnSequencePoint(int64_t seq) {
if (!xdg_toplevel_) {
return;
}
ProcessSequencePoint(seq);
MaybeApplyLatestStateRequest(/*force=*/false);
}
bool WaylandToplevelWindow::OnInitialize(
PlatformWindowInitProperties properties,
PlatformWindowDelegate::State* state) {
// State is kept as "unknown" until the first configure sequence arrives, when
// it's possible to which state it should transition to. That's also when
// xdg_surface.set_window_geometry must be sent for the first time in. See
// WaylandWindow::LatchStateRequest for more details.
CHECK_EQ(state->window_state, PlatformWindowState::kUnknown);
app_id_ = properties.wayland_app_id;
SetWaylandToplevelExtension(this, this);
SetWmMoveLoopHandler(this, static_cast<WmMoveLoopHandler*>(this));
SetWorkspaceExtension(this, static_cast<WorkspaceExtension*>(this));
SetWorkspaceExtensionDelegate(properties.workspace_extension_delegate);
SetZOrderLevel(properties.z_order);
if (!properties.workspace.empty()) {
int workspace;
base::StringToInt(properties.workspace, &workspace);
workspace_ = workspace;
} else if (properties.visible_on_all_workspaces) {
workspace_ = kVisibleOnAllWorkspaces;
}
SetSystemModalExtension(this, static_cast<SystemModalExtension*>(this));
if (properties.icon) {
initial_icon_ = *properties.icon;
}
if (!properties.session_id.empty()) {
session_data_ = PlatformSessionWindowData{
.session_id = properties.session_id,
.window_id = properties.session_window_new_id,
.restore_id = properties.session_window_restore_id,
};
if (auto* session_manager = connection()->session_manager()) {
session_ = session_manager->GetSession(session_data_->session_id);
if (session_) {
session_observer_.Observe(session_);
}
}
}
return true;
}
bool WaylandToplevelWindow::IsActive() const {
return is_active_;
}
bool WaylandToplevelWindow::IsSuspended() const {
return is_suspended_;
}
bool WaylandToplevelWindow::IsSurfaceConfigured() {
return xdg_toplevel() ? xdg_toplevel()->IsConfigured() : false;
}
void WaylandToplevelWindow::SetWindowGeometry(
const PlatformWindowDelegate::State& state) {
DCHECK(connection()->SupportsSetWindowGeometry());
if (!xdg_toplevel_) {
return;
}
gfx::Rect geometry_dip = gfx::ScaleToEnclosingRectIgnoringError(
gfx::Rect(state.bounds_dip.size()), state.ui_scale);
auto insets_dip = delegate()->CalculateInsetsInDIP(state.window_state);
if (!insets_dip.IsEmpty()) {
geometry_dip.Inset(insets_dip);
// Shrinking the bounds by the decoration insets might result in empty
// bounds. For the reasons already explained in WaylandWindow::Initialize(),
// we mustn't request an empty window geometry.
if (geometry_dip.width() == 0) {
geometry_dip.set_width(1);
}
if (geometry_dip.height() == 0) {
geometry_dip.set_height(1);
}
}
xdg_toplevel_->SetWindowGeometry(geometry_dip);
}
void WaylandToplevelWindow::AckConfigure(uint32_t serial) {
// We cannot assume the xdg-toplevel is non-NULL because of a corner case in
// drag n' drop. There could be times when the tab strip change is detected
// while processing a configure event received from the compositor and hence
// destroy the xdg-toplevel before an ACK is sent. See crbug.com/1512046 for
// details.
if (xdg_toplevel()) {
xdg_toplevel()->AckConfigure(serial);
}
}
base::WeakPtr<WaylandWindow> WaylandToplevelWindow::AsWeakPtr() {
return weak_ptr_factory_.GetWeakPtr();
}
bool WaylandToplevelWindow::IsClientControlledWindowMovementSupported() const {
auto* window_drag_controller = connection()->window_drag_controller();
DCHECK(window_drag_controller);
return window_drag_controller->IsWindowDragProtocolAvailable();
}
bool WaylandToplevelWindow::ShouldReleaseCaptureForDrag(
ui::OSExchangeData* data) const {
auto* data_drag_controller = connection()->data_drag_controller();
DCHECK(data_drag_controller);
return data_drag_controller->ShouldReleaseCaptureForDrag(data);
}
bool WaylandToplevelWindow::RunMoveLoop(const gfx::Vector2d& drag_offset) {
DCHECK(connection()->window_drag_controller());
return connection()->window_drag_controller()->Drag(this, drag_offset);
}
void WaylandToplevelWindow::EndMoveLoop() {
DCHECK(connection()->window_drag_controller());
connection()->window_drag_controller()->StopDragging();
}
void WaylandToplevelWindow::StartWindowDraggingSessionIfNeeded(
ui::mojom::DragEventSource event_source,
bool allow_system_drag) {
DCHECK(connection()->window_drag_controller());
// If extended-drag and xdg-toplevel-drag are not available and
// |allow_system_drag| is set, this is no-op and WaylandDataDragController is
// assumed to be used instead. i.e: Fallback to a simpler window drag UX based
// on regular system drag-and-drop.
if (!IsClientControlledWindowMovementSupported() && allow_system_drag) {
return;
}
connection()->window_drag_controller()->StartDragSession(this, event_source);
}
bool WaylandToplevelWindow::SupportsPointerLock() {
return !!connection()->zwp_pointer_constraints() &&
!!connection()->zwp_relative_pointer_manager();
}
void WaylandToplevelWindow::LockPointer(bool enabled) {
auto* pointer_constraints = connection()->zwp_pointer_constraints();
if (enabled)
pointer_constraints->LockPointer(root_surface());
else
pointer_constraints->UnlockPointer();
}
void WaylandToplevelWindow::SetAppmenu(const std::string& service_name,
const std::string& object_path) {
appmenu_service_name_ = service_name;
appmenu_object_path_ = object_path;
if (xdg_toplevel_) {
TryAnnounceAppmenu();
}
}
void WaylandToplevelWindow::UnsetAppmenu() {
appmenu_.reset();
appmenu_service_name_.clear();
appmenu_object_path_.clear();
}
void WaylandToplevelWindow::SetSystemModal(bool modal) {
system_modal_ = modal;
if (xdg_toplevel_) {
xdg_toplevel_->SetSystemModal(modal);
}
}
void WaylandToplevelWindow::DumpState(std::ostream& out) const {
WaylandWindow::DumpState(out);
out << ", title=" << window_title_
<< ", is_active=" << ToBoolString(is_active_)
<< ", system_modal=" << ToBoolString(system_modal_);
}
void WaylandToplevelWindow::OnSessionDestroying() {
toplevel_session_.reset();
session_observer_.Reset();
session_ = nullptr;
}
void WaylandToplevelWindow::UpdateSystemModal() {
if (xdg_toplevel_) {
xdg_toplevel_->SetSystemModal(system_modal_);
}
}
std::string WaylandToplevelWindow::GetWorkspace() const {
return workspace_.has_value() ? base::NumberToString(workspace_.value())
: std::string();
}
void WaylandToplevelWindow::SetVisibleOnAllWorkspaces(bool always_visible) {
// TODO(crbug.com/374244479): remove this.
}
bool WaylandToplevelWindow::IsVisibleOnAllWorkspaces() const {
return workspace_ == kVisibleOnAllWorkspaces;
}
void WaylandToplevelWindow::SetWorkspaceExtensionDelegate(
WorkspaceExtensionDelegate* delegate) {
workspace_extension_delegate_ = delegate;
}
void WaylandToplevelWindow::TriggerStateChanges(
PlatformWindowState window_state) {
if (xdg_toplevel_) {
// Call UnSetMaximized only if current state is normal. Otherwise, if the
// current state is fullscreen and the previous is maximized, calling
// UnSetMaximized may result in wrong restored window position that clients
// are not allowed to know about.
if (window_state == PlatformWindowState::kMinimized) {
LOG(FATAL) << "Should not be called with kMinimized state";
} else if (window_state == PlatformWindowState::kFullScreen) {
xdg_toplevel_->SetFullscreen(
GetWaylandOutputForDisplayId(fullscreen_display_id_));
} else if (GetLatestRequestedState().window_state ==
PlatformWindowState::kFullScreen) {
xdg_toplevel_->UnSetFullscreen();
} else if (window_state == PlatformWindowState::kMaximized) {
xdg_toplevel_->SetMaximized();
} else if (window_state == PlatformWindowState::kNormal) {
xdg_toplevel_->UnSetMaximized();
}
}
// Update the window state of the applied state before calling
// OnWindowStateChanged so it can be used to pick up the new window state. We
// cannot request state here because the bounds is not yet synchronized with
// window state. Requesting the state will trigger SetWindowGeometry with the
// current bounds + insets, so it has a risk to set geometry aligning with the
// client side window state while the server side has not yet configured it.
// This behavior is not necessarily a problem, but it causes the failure on
// weston.
// TODO(crbug.com/40276379): Remove this once this is async.
auto previous_state = applied_state().window_state;
ForceApplyWindowStateDoNotUse(window_state);
delegate()->OnWindowStateChanged(previous_state, window_state);
connection()->Flush();
}
void WaylandToplevelWindow::SetWindowState(PlatformWindowState window_state,
int64_t target_display_id) {
CHECK_NE(window_state, PlatformWindowState::kMinimized);
if (ShouldTriggerStateChange(window_state, target_display_id)) {
// TODO(crbug.com/40276379): Use `GetLatestRequestedState().window_state`
// instead once the window state becomes async.
auto previous_state = applied_state().window_state;
// We want to remember whether it was previously maximized, for cases like
// fullscreening to a different output while already in fullscreen, so we
// can still restore back to the previous non-fullscreen state.
if (previous_state != window_state) {
previously_maximized_ = previous_state == PlatformWindowState::kMaximized;
}
// Remember the display id if we are going to fullscreen - otherwise reset.
fullscreen_display_id_ = (window_state == PlatformWindowState::kFullScreen)
? target_display_id
: display::kInvalidDisplayId;
TriggerStateChanges(window_state);
}
}
bool WaylandToplevelWindow::ShouldTriggerStateChange(
PlatformWindowState window_state,
int64_t target_display_id) const {
// Allow the state transition if the state is different.
//
// The latest requested state from the client is stored as
// `applied_state().window_state` so use it as a previous state.
// TODO(crbug.com/40276379): Use `GetLatestRequestedState().window_state`
// instead once the window state becomes async.
if (applied_state().window_state != window_state) {
return true;
}
// Allow the state transition if the state is fullscreen and the screen has
// changed to something explicit - or different.
if (window_state == PlatformWindowState::kFullScreen &&
target_display_id != display::kInvalidDisplayId &&
target_display_id != fullscreen_display_id_) {
return true;
}
// Otherwise do not allow the transition.
return false;
}
WaylandOutput* WaylandToplevelWindow::GetWaylandOutputForDisplayId(
int64_t display_id) {
auto* output_manager = connection()->wayland_output_manager();
if (auto* screen = output_manager->wayland_screen()) {
return screen->GetWaylandOutputForDisplayId(display_id);
}
return nullptr;
}
WmMoveResizeHandler* WaylandToplevelWindow::AsWmMoveResizeHandler() {
return static_cast<WmMoveResizeHandler*>(this);
}
void WaylandToplevelWindow::SetSizeConstraints() {
DCHECK(delegate());
auto min_size_dip = delegate()->GetMinimumSizeForWindow();
auto max_size_dip = delegate()->GetMaximumSizeForWindow();
if (min_size_dip.has_value())
xdg_toplevel_->SetMinSize(min_size_dip->width(), min_size_dip->height());
if (max_size_dip.has_value())
xdg_toplevel_->SetMaxSize(max_size_dip->width(), max_size_dip->height());
connection()->Flush();
}
void WaylandToplevelWindow::SetUpShellIntegration() {
// This method should be called after the XDG surface is initialized.
DCHECK(xdg_toplevel_);
TryAnnounceAppmenu();
}
void WaylandToplevelWindow::OnDecorationModeChanged() {
DCHECK(xdg_toplevel_);
if (use_native_frame_) {
// Set server-side decoration for windows using a native frame,
// e.g. taskmanager
xdg_toplevel_->SetDecoration(XdgToplevel::DecorationMode::kServerSide);
} else {
xdg_toplevel_->SetDecoration(XdgToplevel::DecorationMode::kClientSide);
}
}
void WaylandToplevelWindow::UpdateWindowMask() {
std::vector<gfx::Rect> region{gfx::Rect({}, latched_state().size_px)};
root_surface()->set_opaque_region(
opaque_region_px_.has_value()
? opaque_region_px_
: (IsOpaqueWindow() ? std::optional<std::vector<gfx::Rect>>(region)
: std::nullopt));
root_surface()->set_input_region(input_region_px_ ? input_region_px_
: region);
}
void WaylandToplevelWindow::UpdateSessionStateIfNeeded() {
CHECK(xdg_toplevel_);
if (!session_) {
return;
}
// If we're handling the first configure sequence and a `toplevel_session_`
// was instantiated at window creation (see CreateXdgToplevel), it must be
// removed now, so the requested `new_id` can be associated to this window.
// Note that IsConfigured returns true only after the first ack_configure.
if (!xdg_toplevel_->IsConfigured()) {
const auto& session_data = session_data_.value();
if (toplevel_session_) {
CHECK(session_data.restore_id.has_value());
toplevel_session_->Remove();
}
if (session_data.window_id) {
toplevel_session_ = session_->TrackToplevel(this, session_data.window_id,
XdgSession::Action::kAdd);
} else {
// Window was just removed from `session_` and no new session window id
// was provided. Notifying about it can result in `this` being destroyed
// when the Wayland compositor supports only experimental version of the
// session management protocol. See comments in XdgSession for details.
// TODO(crbug.com/409099413): Remove when support for the experimental
// session management protocol support gets dropped.
auto alive = weak_ptr_factory_.GetWeakPtr();
connection()->window_manager()->NotifyWindowRemovedFromSession(this);
if (!alive) {
return;
}
}
connection()->Flush();
}
}
void WaylandToplevelWindow::TryAnnounceAppmenu() {
if (auto* appmenu_manager = connection()->org_kde_kwin_appmenu_manager()) {
if (!appmenu_service_name_.empty() && !appmenu_object_path_.empty()) {
appmenu_ = appmenu_manager->Create(root_surface()->surface());
appmenu_->SetAddress(appmenu_service_name_, appmenu_object_path_);
}
}
}
} // namespace ui
|