ladybird/Userland/Services/WindowServer/Window.cpp
Andreas Kling 432ab47053 WindowServer: Allow partial repaints in window frame & menubars
Before this change, invalidating any rect in a WindowFrame would cause
the entire window (including frame & drop shadow) to get invalidated,
leading to copious amounts of overdraw when mousing over menubars,
titlebars, and window buttons.

We now simply allow the partial frame invalidations through to the
window's dirty rects collection and the compositor takes care of it.
2021-07-08 01:17:06 +02:00

1291 lines
43 KiB
C++

/*
* Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include "Window.h"
#include "Animation.h"
#include "AppletManager.h"
#include "ClientConnection.h"
#include "Compositor.h"
#include "Event.h"
#include "EventLoop.h"
#include "Screen.h"
#include "WindowManager.h"
#include <AK/Badge.h>
#include <AK/CharacterTypes.h>
#include <AK/Debug.h>
#include <WindowServer/WindowClientEndpoint.h>
namespace WindowServer {
const static Gfx::IntSize s_default_normal_minimum_size = { 50, 50 };
static String default_window_icon_path()
{
return "/res/icons/16x16/window.png";
}
static Gfx::Bitmap& default_window_icon()
{
static Gfx::Bitmap* s_icon;
if (!s_icon)
s_icon = Gfx::Bitmap::load_from_file(default_window_icon_path()).leak_ref();
return *s_icon;
}
static Gfx::Bitmap& minimize_icon()
{
static Gfx::Bitmap* s_icon;
if (!s_icon)
s_icon = Gfx::Bitmap::load_from_file("/res/icons/16x16/downward-triangle.png").leak_ref();
return *s_icon;
}
static Gfx::Bitmap& maximize_icon()
{
static Gfx::Bitmap* s_icon;
if (!s_icon)
s_icon = Gfx::Bitmap::load_from_file("/res/icons/16x16/upward-triangle.png").leak_ref();
return *s_icon;
}
static Gfx::Bitmap& restore_icon()
{
static Gfx::Bitmap* s_icon;
if (!s_icon)
s_icon = Gfx::Bitmap::load_from_file("/res/icons/16x16/window-restore.png").leak_ref();
return *s_icon;
}
static Gfx::Bitmap& close_icon()
{
static Gfx::Bitmap* s_icon;
if (!s_icon)
s_icon = Gfx::Bitmap::load_from_file("/res/icons/16x16/window-close.png").leak_ref();
return *s_icon;
}
static Gfx::Bitmap& pin_icon()
{
static Gfx::Bitmap* s_icon;
if (!s_icon)
s_icon = Gfx::Bitmap::load_from_file("/res/icons/16x16/window-pin.png").leak_ref();
return *s_icon;
}
Window::Window(Core::Object& parent, WindowType type)
: Core::Object(&parent)
, m_type(type)
, m_icon(default_window_icon())
, m_frame(*this)
{
// Set default minimum size for Normal windows
if (m_type == WindowType::Normal)
m_minimum_size = s_default_normal_minimum_size;
WindowManager::the().add_window(*this);
}
Window::Window(ClientConnection& client, WindowType window_type, int window_id, bool modal, bool minimizable, bool frameless, bool resizable, bool fullscreen, bool accessory, Window* parent_window)
: Core::Object(&client)
, m_client(&client)
, m_type(window_type)
, m_modal(modal)
, m_minimizable(minimizable)
, m_frameless(frameless)
, m_resizable(resizable)
, m_fullscreen(fullscreen)
, m_accessory(accessory)
, m_window_id(window_id)
, m_client_id(client.client_id())
, m_icon(default_window_icon())
, m_frame(*this)
{
// Set default minimum size for Normal windows
if (m_type == WindowType::Normal)
m_minimum_size = s_default_normal_minimum_size;
if (parent_window)
set_parent_window(*parent_window);
WindowManager::the().add_window(*this);
}
Window::~Window()
{
// Detach from client at the start of teardown since we don't want
// to confuse things by trying to send messages to it.
m_client = nullptr;
WindowManager::the().remove_window(*this);
}
void Window::destroy()
{
m_destroyed = true;
set_visible(false);
}
void Window::set_title(const String& title)
{
if (m_title == title)
return;
m_title = title;
frame().invalidate_titlebar();
WindowManager::the().notify_title_changed(*this);
}
void Window::set_rect(const Gfx::IntRect& rect)
{
if (m_rect == rect)
return;
auto old_rect = m_rect;
m_rect = rect;
if (rect.is_empty()) {
m_backing_store = nullptr;
} else if (!m_client && (!m_backing_store || old_rect.size() != rect.size())) {
m_backing_store = Gfx::Bitmap::create(Gfx::BitmapFormat::BGRx8888, m_rect.size());
}
invalidate(true, old_rect.size() != rect.size());
m_frame.window_rect_changed(old_rect, rect);
invalidate_last_rendered_screen_rects();
}
void Window::set_rect_without_repaint(const Gfx::IntRect& rect)
{
VERIFY(!rect.is_empty());
if (m_rect == rect)
return;
auto old_rect = m_rect;
m_rect = rect;
if (old_rect.size() == m_rect.size()) {
auto delta = m_rect.location() - old_rect.location();
for (auto& child_window : m_child_windows) {
if (child_window)
child_window->move_by(delta);
}
}
invalidate(true, old_rect.size() != rect.size());
m_frame.window_rect_changed(old_rect, rect);
invalidate_last_rendered_screen_rects();
}
bool Window::apply_minimum_size(Gfx::IntRect& rect)
{
int new_width = max(m_minimum_size.width(), rect.width());
int new_height = max(m_minimum_size.height(), rect.height());
bool did_size_clamp = new_width != rect.width() || new_height != rect.height();
rect.set_width(new_width);
rect.set_height(new_height);
return did_size_clamp;
}
void Window::nudge_into_desktop(Screen* target_screen, bool force_titlebar_visible)
{
if (!target_screen) {
// If no explicit target screen was supplied,
// guess based on the current frame rectangle
target_screen = &Screen::closest_to_rect(rect());
}
Gfx::IntRect arena = WindowManager::the().arena_rect_for_type(*target_screen, type());
auto min_visible = 1;
switch (type()) {
case WindowType::Normal:
min_visible = 30;
break;
case WindowType::Desktop:
set_rect(arena);
return;
default:
break;
}
// Push the frame around such that at least `min_visible` pixels of the *frame* are in the desktop rect.
auto old_frame_rect = frame().rect();
Gfx::IntRect new_frame_rect = {
clamp(old_frame_rect.x(), arena.left() + min_visible - width(), arena.right() - min_visible),
clamp(old_frame_rect.y(), arena.top() + min_visible - height(), arena.bottom() - min_visible),
old_frame_rect.width(),
old_frame_rect.height(),
};
// Make sure that at least half of the titlebar is visible.
auto min_frame_y = arena.top() - (y() - old_frame_rect.y()) / 2;
if (force_titlebar_visible && new_frame_rect.y() < min_frame_y) {
new_frame_rect.set_y(min_frame_y);
}
// Deduce new window rect:
Gfx::IntRect new_window_rect = {
x() + new_frame_rect.x() - old_frame_rect.x(),
y() + new_frame_rect.y() - old_frame_rect.y(),
width(),
height(),
};
set_rect(new_window_rect);
}
void Window::set_minimum_size(const Gfx::IntSize& size)
{
if (size.is_null())
return;
if (m_minimum_size == size)
return;
// Disallow setting minimum zero widths or heights.
if (size.width() == 0 || size.height() == 0)
return;
m_minimum_size = size;
}
void Window::handle_mouse_event(const MouseEvent& event)
{
set_automatic_cursor_tracking_enabled(event.buttons() != 0);
switch (event.type()) {
case Event::MouseMove:
m_client->async_mouse_move(m_window_id, event.position(), (u32)event.button(), event.buttons(), event.modifiers(), event.wheel_delta(), event.is_drag(), event.mime_types());
break;
case Event::MouseDown:
m_client->async_mouse_down(m_window_id, event.position(), (u32)event.button(), event.buttons(), event.modifiers(), event.wheel_delta());
break;
case Event::MouseDoubleClick:
m_client->async_mouse_double_click(m_window_id, event.position(), (u32)event.button(), event.buttons(), event.modifiers(), event.wheel_delta());
break;
case Event::MouseUp:
m_client->async_mouse_up(m_window_id, event.position(), (u32)event.button(), event.buttons(), event.modifiers(), event.wheel_delta());
break;
case Event::MouseWheel:
m_client->async_mouse_wheel(m_window_id, event.position(), (u32)event.button(), event.buttons(), event.modifiers(), event.wheel_delta());
break;
default:
VERIFY_NOT_REACHED();
}
}
void Window::update_window_menu_items()
{
if (!m_window_menu)
return;
m_window_menu_minimize_item->set_text(m_minimized_state != WindowMinimizedState::None ? "&Unminimize" : "Mi&nimize");
m_window_menu_minimize_item->set_enabled(m_minimizable);
m_window_menu_maximize_item->set_text(m_maximized ? "&Restore" : "Ma&ximize");
m_window_menu_maximize_item->set_enabled(m_resizable);
m_window_menu_move_item->set_enabled(m_minimized_state == WindowMinimizedState::None && !m_maximized && !m_fullscreen);
if (m_window_menu_pin_item)
m_window_menu_pin_item->set_text(m_pinned ? "Un-&Pin Window" : "&Pin Window");
}
void Window::set_minimized(bool minimized)
{
if ((m_minimized_state != WindowMinimizedState::None) == minimized)
return;
if (minimized && !m_minimizable)
return;
m_minimized_state = minimized ? WindowMinimizedState::Minimized : WindowMinimizedState::None;
update_window_menu_items();
if (!blocking_modal_window())
start_minimize_animation();
if (!minimized)
request_update({ {}, size() });
// Since a minimized window won't be visible we need to invalidate the last rendered
// rectangles before the next occlusion calculation
invalidate_last_rendered_screen_rects_now();
WindowManager::the().notify_minimization_state_changed(*this);
}
void Window::set_hidden(bool hidden)
{
if ((m_minimized_state != WindowMinimizedState::None) == hidden)
return;
if (hidden && !m_minimizable)
return;
m_minimized_state = hidden ? WindowMinimizedState::Hidden : WindowMinimizedState::None;
update_window_menu_items();
Compositor::the().invalidate_occlusions();
Compositor::the().invalidate_screen(frame().render_rect());
if (!blocking_modal_window())
start_minimize_animation();
if (!hidden)
request_update({ {}, size() });
WindowManager::the().notify_minimization_state_changed(*this);
}
void Window::set_minimizable(bool minimizable)
{
if (m_minimizable == minimizable)
return;
m_minimizable = minimizable;
update_window_menu_items();
// TODO: Hide/show (or alternatively change enabled state of) window minimize button dynamically depending on value of m_minimizable
}
void Window::set_taskbar_rect(const Gfx::IntRect& rect)
{
m_taskbar_rect = rect;
m_have_taskbar_rect = !m_taskbar_rect.is_empty();
}
static Gfx::IntRect interpolate_rect(Gfx::IntRect const& from_rect, Gfx::IntRect const& to_rect, float progress)
{
auto dx = to_rect.x() - from_rect.x();
auto dy = to_rect.y() - from_rect.y();
auto dw = to_rect.width() - from_rect.width();
auto dh = to_rect.height() - from_rect.height();
return Gfx::IntRect {
from_rect.x() + ((float)dx * progress),
from_rect.y() + ((float)dy * progress),
from_rect.width() + ((float)dw * progress),
from_rect.height() + ((float)dh * progress),
};
}
void Window::start_minimize_animation()
{
if (&window_stack() != &WindowManager::the().current_window_stack())
return;
if (!m_have_taskbar_rect) {
// If this is a modal window, it may not have its own taskbar
// button, so there is no rectangle. In that case, walk the
// modal stack until we find a window that may have one
WindowManager::the().for_each_window_in_modal_stack(*this, [&](Window& w, bool) {
if (w.has_taskbar_rect()) {
// We purposely do NOT set m_have_taskbar_rect to true here
// because we want to only copy the rectangle from the
// window that has it, but since this window wouldn't receive
// any updates down the road we want to query it again
// next time we want to start the animation
m_taskbar_rect = w.taskbar_rect();
VERIFY(!m_have_taskbar_rect); // should remain unset!
return IterationDecision::Break;
};
return IterationDecision::Continue;
});
}
m_animation = Animation::create();
m_animation->set_duration(150);
m_animation->on_update = [this](float progress, Gfx::Painter& painter, Screen& screen, Gfx::DisjointRectSet& flush_rects) {
Gfx::PainterStateSaver saver(painter);
painter.set_draw_op(Gfx::Painter::DrawOp::Invert);
auto from_rect = is_minimized() ? frame().rect() : taskbar_rect();
auto to_rect = is_minimized() ? taskbar_rect() : frame().rect();
auto rect = interpolate_rect(from_rect, to_rect, progress);
painter.draw_rect(rect, Color::Transparent); // Color doesn't matter, we draw inverted
flush_rects.add(rect.intersected(screen.rect()));
Compositor::the().invalidate_screen(rect);
};
m_animation->on_stop = [this] {
m_animation = nullptr;
};
m_animation->start();
}
void Window::start_launch_animation(Gfx::IntRect const& launch_origin_rect)
{
if (&window_stack() != &WindowManager::the().current_window_stack())
return;
m_animation = Animation::create();
m_animation->set_duration(150);
m_animation->on_update = [this, launch_origin_rect](float progress, Gfx::Painter& painter, Screen& screen, Gfx::DisjointRectSet& flush_rects) {
Gfx::PainterStateSaver saver(painter);
painter.set_draw_op(Gfx::Painter::DrawOp::Invert);
auto rect = interpolate_rect(launch_origin_rect, frame().rect(), progress);
painter.draw_rect(rect, Color::Transparent); // Color doesn't matter, we draw inverted
flush_rects.add(rect.intersected(screen.rect()));
Compositor::the().invalidate_screen(rect);
};
m_animation->on_stop = [this] {
m_animation = nullptr;
};
m_animation->start();
}
void Window::set_opacity(float opacity)
{
if (m_opacity == opacity)
return;
bool was_opaque = is_opaque();
m_opacity = opacity;
if (was_opaque != is_opaque())
Compositor::the().invalidate_occlusions();
invalidate(false);
WindowManager::the().notify_opacity_changed(*this);
}
void Window::set_has_alpha_channel(bool value)
{
if (m_has_alpha_channel == value)
return;
m_has_alpha_channel = value;
Compositor::the().invalidate_occlusions();
}
void Window::set_occluded(bool occluded)
{
if (m_occluded == occluded)
return;
m_occluded = occluded;
WindowManager::the().notify_occlusion_state_changed(*this);
}
void Window::set_maximized(bool maximized, Optional<Gfx::IntPoint> fixed_point)
{
if (m_maximized == maximized)
return;
if (maximized && (!is_resizable() || resize_aspect_ratio().has_value()))
return;
m_tiled = WindowTileType::None;
m_maximized = maximized;
update_window_menu_items();
if (maximized) {
m_unmaximized_rect = m_rect;
set_rect(WindowManager::the().maximized_window_rect(*this));
} else {
if (fixed_point.has_value()) {
auto new_rect = Gfx::IntRect(m_rect);
new_rect.set_size_around(m_unmaximized_rect.size(), fixed_point.value());
set_rect(new_rect);
} else {
set_rect(m_unmaximized_rect);
}
}
m_frame.did_set_maximized({}, maximized);
Core::EventLoop::current().post_event(*this, make<ResizeEvent>(m_rect));
set_default_positioned(false);
}
void Window::set_pinned(bool pinned)
{
if (m_pinned == pinned)
return;
m_pinned = pinned;
update_window_menu_items();
window_stack().move_pinned_windows_to_front();
}
void Window::set_vertically_maximized()
{
if (m_maximized)
return;
if (!is_resizable() || resize_aspect_ratio().has_value())
return;
auto max_rect = WindowManager::the().maximized_window_rect(*this);
auto new_rect = Gfx::IntRect(
Gfx::IntPoint(rect().x(), max_rect.y()),
Gfx::IntSize(rect().width(), max_rect.height()));
set_rect(new_rect);
Core::EventLoop::current().post_event(*this, make<ResizeEvent>(new_rect));
}
void Window::set_resizable(bool resizable)
{
if (m_resizable == resizable)
return;
m_resizable = resizable;
update_window_menu_items();
// TODO: Hide/show (or alternatively change enabled state of) window maximize button dynamically depending on value of is_resizable()
}
void Window::event(Core::Event& event)
{
if (!m_client) {
VERIFY(parent());
event.ignore();
return;
}
if (blocking_modal_window()) {
// We still want to handle the WindowDeactivated event below when a new modal is
// created to notify its parent window, despite it being "blocked by modal window".
if (event.type() != Event::WindowDeactivated)
return;
}
if (static_cast<Event&>(event).is_mouse_event())
return handle_mouse_event(static_cast<const MouseEvent&>(event));
switch (event.type()) {
case Event::WindowEntered:
m_client->async_window_entered(m_window_id);
break;
case Event::WindowLeft:
m_client->async_window_left(m_window_id);
break;
case Event::KeyDown:
handle_keydown_event(static_cast<const KeyEvent&>(event));
break;
case Event::KeyUp:
m_client->async_key_up(m_window_id,
(u32) static_cast<const KeyEvent&>(event).code_point(),
(u32) static_cast<const KeyEvent&>(event).key(),
static_cast<const KeyEvent&>(event).modifiers(),
(u32) static_cast<const KeyEvent&>(event).scancode());
break;
case Event::WindowActivated:
m_client->async_window_activated(m_window_id);
break;
case Event::WindowDeactivated:
m_client->async_window_deactivated(m_window_id);
break;
case Event::WindowInputEntered:
m_client->async_window_input_entered(m_window_id);
break;
case Event::WindowInputLeft:
m_client->async_window_input_left(m_window_id);
break;
case Event::WindowCloseRequest:
m_client->async_window_close_request(m_window_id);
break;
case Event::WindowResized:
m_client->async_window_resized(m_window_id, static_cast<const ResizeEvent&>(event).rect());
break;
default:
break;
}
}
void Window::handle_keydown_event(const KeyEvent& event)
{
if (event.modifiers() == Mod_Alt && event.key() == Key_Space && type() == WindowType::Normal && !is_frameless()) {
auto position = frame().titlebar_rect().bottom_left().translated(frame().rect().location());
popup_window_menu(position, WindowMenuDefaultAction::Close);
return;
}
if (event.modifiers() == Mod_Alt && event.code_point() && menubar()) {
Menu* menu_to_open = nullptr;
menubar()->for_each_menu([&](Menu& menu) {
if (to_ascii_lowercase(menu.alt_shortcut_character()) == to_ascii_lowercase(event.code_point())) {
menu_to_open = &menu;
return IterationDecision::Break;
}
return IterationDecision::Continue;
});
if (menu_to_open) {
frame().open_menubar_menu(*menu_to_open);
if (!menu_to_open->is_empty())
menu_to_open->set_hovered_index(0);
return;
}
}
m_client->async_key_down(m_window_id, (u32)event.code_point(), (u32)event.key(), event.modifiers(), (u32)event.scancode());
}
void Window::set_global_cursor_tracking_enabled(bool enabled)
{
m_global_cursor_tracking_enabled = enabled;
}
void Window::set_visible(bool b)
{
if (m_visible == b)
return;
m_visible = b;
if (!m_visible)
WindowManager::the().check_hide_geometry_overlay(*this);
Compositor::the().invalidate_occlusions();
if (m_visible) {
invalidate(true);
} else {
// Since the window won't be visible we need to invalidate the last rendered
// rectangles before the next occlusion calculation
invalidate_last_rendered_screen_rects_now();
}
}
void Window::set_frameless(bool frameless)
{
if (m_frameless == frameless)
return;
m_frameless = frameless;
if (m_visible) {
Compositor::the().invalidate_occlusions();
invalidate(true, true);
invalidate_last_rendered_screen_rects();
}
}
void Window::invalidate(bool invalidate_frame, bool re_render_frame)
{
m_invalidated = true;
m_invalidated_all = true;
if (invalidate_frame && !m_invalidated_frame) {
m_invalidated_frame = true;
}
if (re_render_frame)
frame().set_dirty(true);
m_dirty_rects.clear();
Compositor::the().invalidate_window();
}
void Window::invalidate(Gfx::IntRect const& rect)
{
if (type() == WindowType::Applet) {
AppletManager::the().invalidate_applet(*this, rect);
return;
}
if (invalidate_no_notify(rect))
Compositor::the().invalidate_window();
}
bool Window::invalidate_no_notify(const Gfx::IntRect& rect, bool with_frame)
{
if (rect.is_empty())
return false;
if (m_invalidated_all) {
if (with_frame)
m_invalidated_frame |= true;
return false;
}
auto outer_rect = frame().render_rect();
auto inner_rect = rect;
inner_rect.translate_by(position());
// FIXME: This seems slightly wrong; the inner rect shouldn't intersect the border part of the outer rect.
inner_rect.intersect(outer_rect);
if (inner_rect.is_empty())
return false;
m_invalidated = true;
if (with_frame)
m_invalidated_frame |= true;
m_dirty_rects.add(inner_rect.translated(-outer_rect.location()));
return true;
}
void Window::invalidate_last_rendered_screen_rects()
{
m_invalidate_last_render_rects = true;
Compositor::the().invalidate_occlusions();
}
void Window::invalidate_last_rendered_screen_rects_now()
{
// We can't wait for the next occlusion computation because the window will either no longer
// be around or won't be visible anymore. So we need to invalidate the last rendered rects now.
if (!m_opaque_rects.is_empty())
Compositor::the().invalidate_screen(m_opaque_rects);
if (!m_transparency_rects.is_empty())
Compositor::the().invalidate_screen(m_transparency_rects);
m_invalidate_last_render_rects = false;
Compositor::the().invalidate_occlusions();
}
void Window::refresh_client_size()
{
client()->async_window_resized(m_window_id, m_rect);
}
void Window::prepare_dirty_rects()
{
if (m_invalidated_all) {
if (m_invalidated_frame)
m_dirty_rects = frame().render_rect();
else
m_dirty_rects = rect();
} else {
m_dirty_rects.move_by(frame().render_rect().location());
if (m_invalidated_frame) {
if (m_invalidated) {
m_dirty_rects.add(frame().render_rect());
} else {
for (auto& rects : frame().render_rect().shatter(rect()))
m_dirty_rects.add(rects);
}
}
}
}
void Window::clear_dirty_rects()
{
m_invalidated_all = false;
m_invalidated_frame = false;
m_invalidated = false;
m_dirty_rects.clear_with_capacity();
}
bool Window::is_active() const
{
VERIFY(m_window_stack);
return m_window_stack->active_window() == this;
}
Window* Window::blocking_modal_window()
{
// A window is blocked if any immediate child, or any child further
// down the chain is modal
for (auto& window : m_child_windows) {
if (window && !window->is_destroyed()) {
if (window->is_modal())
return window;
if (auto* blocking_window = window->blocking_modal_window())
return blocking_window;
}
}
return nullptr;
}
void Window::set_default_icon()
{
m_icon = default_window_icon();
}
void Window::request_update(const Gfx::IntRect& rect, bool ignore_occlusion)
{
if (rect.is_empty())
return;
if (m_pending_paint_rects.is_empty()) {
deferred_invoke([this, ignore_occlusion](auto&) {
client()->post_paint_message(*this, ignore_occlusion);
});
}
m_pending_paint_rects.add(rect);
}
void Window::ensure_window_menu()
{
if (!m_window_menu) {
m_window_menu = Menu::construct(nullptr, -1, "(Window Menu)");
m_window_menu->set_window_menu_of(*this);
auto minimize_item = make<MenuItem>(*m_window_menu, (unsigned)WindowMenuAction::MinimizeOrUnminimize, "");
m_window_menu_minimize_item = minimize_item.ptr();
m_window_menu->add_item(move(minimize_item));
auto maximize_item = make<MenuItem>(*m_window_menu, (unsigned)WindowMenuAction::MaximizeOrRestore, "");
m_window_menu_maximize_item = maximize_item.ptr();
m_window_menu->add_item(move(maximize_item));
auto move_item = make<MenuItem>(*m_window_menu, (unsigned)WindowMenuAction::Move, "&Move");
m_window_menu_move_item = move_item.ptr();
m_window_menu->add_item(move(move_item));
m_window_menu->add_item(make<MenuItem>(*m_window_menu, MenuItem::Type::Separator));
auto menubar_visibility_item = make<MenuItem>(*m_window_menu, (unsigned)WindowMenuAction::ToggleMenubarVisibility, "Menu &Bar");
m_window_menu_menubar_visibility_item = menubar_visibility_item.ptr();
menubar_visibility_item->set_checkable(true);
m_window_menu->add_item(move(menubar_visibility_item));
m_window_menu->add_item(make<MenuItem>(*m_window_menu, MenuItem::Type::Separator));
if (!m_modal) {
auto pin_item = make<MenuItem>(*m_window_menu, (unsigned)WindowMenuAction::TogglePinned, "&Pin Window");
m_window_menu_pin_item = pin_item.ptr();
m_window_menu_pin_item->set_icon(&pin_icon());
m_window_menu_pin_item->set_checkable(true);
m_window_menu->add_item(move(pin_item));
}
m_window_menu->add_item(make<MenuItem>(*m_window_menu, MenuItem::Type::Separator));
auto close_item = make<MenuItem>(*m_window_menu, (unsigned)WindowMenuAction::Close, "&Close");
m_window_menu_close_item = close_item.ptr();
m_window_menu_close_item->set_icon(&close_icon());
m_window_menu_close_item->set_default(true);
m_window_menu->add_item(move(close_item));
m_window_menu->on_item_activation = [&](auto& item) {
handle_window_menu_action(static_cast<WindowMenuAction>(item.identifier()));
};
update_window_menu_items();
}
}
void Window::handle_window_menu_action(WindowMenuAction action)
{
switch (action) {
case WindowMenuAction::MinimizeOrUnminimize:
WindowManager::the().minimize_windows(*this, m_minimized_state == WindowMinimizedState::None);
if (m_minimized_state == WindowMinimizedState::None)
WindowManager::the().move_to_front_and_make_active(*this);
break;
case WindowMenuAction::MaximizeOrRestore:
WindowManager::the().maximize_windows(*this, !m_maximized);
WindowManager::the().move_to_front_and_make_active(*this);
break;
case WindowMenuAction::Move:
WindowManager::the().start_window_move(*this, ScreenInput::the().cursor_location());
break;
case WindowMenuAction::Close:
request_close();
break;
case WindowMenuAction::ToggleMenubarVisibility: {
auto& item = *m_window_menu->item_by_identifier((unsigned)action);
frame().invalidate();
item.set_checked(!item.is_checked());
m_should_show_menubar = item.is_checked();
frame().invalidate();
recalculate_rect();
invalidate_last_rendered_screen_rects();
break;
}
case WindowMenuAction::TogglePinned: {
auto& item = *m_window_menu->item_by_identifier((unsigned)action);
auto new_is_checked = !item.is_checked();
item.set_checked(new_is_checked);
WindowManager::the().set_pinned(*this, new_is_checked);
break;
}
}
}
void Window::popup_window_menu(const Gfx::IntPoint& position, WindowMenuDefaultAction default_action)
{
ensure_window_menu();
if (default_action == WindowMenuDefaultAction::BasedOnWindowState) {
// When clicked on the task bar, determine the default action
if (!is_active() && !is_minimized())
default_action = WindowMenuDefaultAction::None;
else if (is_minimized())
default_action = WindowMenuDefaultAction::Unminimize;
else
default_action = WindowMenuDefaultAction::Minimize;
}
m_window_menu_minimize_item->set_default(default_action == WindowMenuDefaultAction::Minimize || default_action == WindowMenuDefaultAction::Unminimize);
m_window_menu_minimize_item->set_icon(m_minimized_state != WindowMinimizedState::None ? nullptr : &minimize_icon());
m_window_menu_maximize_item->set_default(default_action == WindowMenuDefaultAction::Maximize || default_action == WindowMenuDefaultAction::Restore);
m_window_menu_maximize_item->set_icon(m_maximized ? &restore_icon() : &maximize_icon());
m_window_menu_close_item->set_default(default_action == WindowMenuDefaultAction::Close);
m_window_menu_menubar_visibility_item->set_enabled(menubar());
m_window_menu_menubar_visibility_item->set_checked(menubar() && m_should_show_menubar);
m_window_menu->popup(position);
}
void Window::window_menu_activate_default()
{
ensure_window_menu();
m_window_menu->activate_default();
}
void Window::request_close()
{
Event close_request(Event::WindowCloseRequest);
event(close_request);
}
void Window::set_fullscreen(bool fullscreen)
{
if (m_fullscreen == fullscreen)
return;
m_fullscreen = fullscreen;
Gfx::IntRect new_window_rect = m_rect;
if (m_fullscreen) {
m_saved_nonfullscreen_rect = m_rect;
new_window_rect = Screen::main().rect(); // TODO: We should support fullscreen on any screen
} else if (!m_saved_nonfullscreen_rect.is_empty()) {
new_window_rect = m_saved_nonfullscreen_rect;
}
Core::EventLoop::current().post_event(*this, make<ResizeEvent>(new_window_rect));
set_rect(new_window_rect);
}
Gfx::IntRect Window::tiled_rect(Screen* target_screen, WindowTileType tiled) const
{
if (!target_screen) {
// If no explicit target screen was supplied,
// guess based on the current frame rectangle
target_screen = &Screen::closest_to_rect(frame().rect());
}
VERIFY(tiled != WindowTileType::None);
int frame_width = (m_frame.rect().width() - m_rect.width()) / 2;
int titlebar_height = m_frame.titlebar_rect().height();
auto maximized_rect_relative_to_window_screen = WindowManager::the().maximized_window_rect(*this, true);
int menu_height = maximized_rect_relative_to_window_screen.y();
int max_height = maximized_rect_relative_to_window_screen.height();
auto& screen = *target_screen;
auto screen_location = screen.rect().location();
switch (tiled) {
case WindowTileType::Left:
return Gfx::IntRect(0,
menu_height,
screen.width() / 2 - frame_width,
max_height)
.translated(screen_location);
case WindowTileType::Right: {
Gfx::IntPoint location {
screen.width() / 2 + frame_width,
menu_height
};
return Gfx::IntRect(
location,
{ screen.width() - location.x(), max_height })
.translated(screen_location);
}
case WindowTileType::Top:
return Gfx::IntRect(0,
menu_height,
screen.width(),
(max_height - titlebar_height) / 2 - frame_width)
.translated(screen_location);
case WindowTileType::Bottom: {
Gfx::IntPoint location {
0,
menu_height + (titlebar_height + max_height) / 2 + frame_width
};
return Gfx::IntRect(
location,
{ screen.width(), screen.height() - location.y() })
.translated(screen_location);
}
case WindowTileType::TopLeft:
return Gfx::IntRect(0,
menu_height,
screen.width() / 2 - frame_width,
(max_height - titlebar_height) / 2 - frame_width)
.translated(screen_location);
case WindowTileType::TopRight: {
Gfx::IntPoint location {
screen.width() / 2 + frame_width,
menu_height
};
return Gfx::IntRect(
location,
{ screen.width() - location.x(), (max_height - titlebar_height) / 2 - frame_width })
.translated(screen_location);
}
case WindowTileType::BottomLeft: {
Gfx::IntPoint location {
0,
menu_height + (titlebar_height + max_height) / 2 + frame_width
};
return Gfx::IntRect(
location,
{ screen.width() / 2 - frame_width, screen.height() - location.y() })
.translated(screen_location);
}
case WindowTileType::BottomRight: {
Gfx::IntPoint location {
screen.width() / 2 + frame_width,
menu_height + (titlebar_height + max_height) / 2 + frame_width
};
return Gfx::IntRect(
location,
{ screen.width() - location.x(), screen.height() - location.y() })
.translated(screen_location);
}
default:
VERIFY_NOT_REACHED();
}
}
WindowTileType Window::tile_type_based_on_rect(Gfx::IntRect const& rect) const
{
auto& window_screen = Screen::closest_to_rect(this->rect()); // based on currently used rect
auto tile_type = WindowTileType::None;
if (window_screen.rect().contains(rect)) {
auto current_tiled = tiled();
bool tiling_to_top = current_tiled == WindowTileType::Top || current_tiled == WindowTileType::TopLeft || current_tiled == WindowTileType::TopRight;
bool tiling_to_bottom = current_tiled == WindowTileType::Bottom || current_tiled == WindowTileType::BottomLeft || current_tiled == WindowTileType::BottomRight;
bool tiling_to_left = current_tiled == WindowTileType::Left || current_tiled == WindowTileType::TopLeft || current_tiled == WindowTileType::BottomLeft;
bool tiling_to_right = current_tiled == WindowTileType::Right || current_tiled == WindowTileType::TopRight || current_tiled == WindowTileType::BottomRight;
auto ideal_tiled_rect = tiled_rect(&window_screen, current_tiled);
bool same_top = ideal_tiled_rect.top() == rect.top();
bool same_left = ideal_tiled_rect.left() == rect.left();
bool same_right = ideal_tiled_rect.right() == rect.right();
bool same_bottom = ideal_tiled_rect.bottom() == rect.bottom();
// Try to find the most suitable tile type. For example, if a window is currently tiled to the BottomRight and
// the window is resized upwards as to where it perfectly touches the screen's top border, then the more suitable
// tile type would be Right, as three sides are lined up perfectly.
if (tiling_to_top && same_top && same_left && same_right)
return WindowTileType::Top;
else if ((tiling_to_top || tiling_to_left) && same_top && same_left)
return rect.bottom() == tiled_rect(&window_screen, WindowTileType::Bottom).bottom() ? WindowTileType::Left : WindowTileType::TopLeft;
else if ((tiling_to_top || tiling_to_right) && same_top && same_right)
return rect.bottom() == tiled_rect(&window_screen, WindowTileType::Bottom).bottom() ? WindowTileType::Right : WindowTileType::TopRight;
else if (tiling_to_left && same_left && same_top && same_bottom)
return WindowTileType::Left;
else if (tiling_to_right && same_right && same_top && same_bottom)
return WindowTileType::Right;
else if (tiling_to_bottom && same_bottom && same_left && same_right)
return WindowTileType::Bottom;
else if ((tiling_to_bottom || tiling_to_left) && same_bottom && same_left)
return rect.top() == tiled_rect(&window_screen, WindowTileType::Left).top() ? WindowTileType::Left : WindowTileType::BottomLeft;
else if ((tiling_to_bottom || tiling_to_right) && same_bottom && same_right)
return rect.top() == tiled_rect(&window_screen, WindowTileType::Right).top() ? WindowTileType::Right : WindowTileType::BottomRight;
}
return tile_type;
}
void Window::check_untile_due_to_resize(Gfx::IntRect const& new_rect)
{
auto new_tile_type = tile_type_based_on_rect(new_rect);
if constexpr (RESIZE_DEBUG) {
if (new_tile_type == WindowTileType::None) {
auto current_rect = rect();
auto& window_screen = Screen::closest_to_rect(current_rect);
if (!(window_screen.rect().contains(new_rect)))
dbgln("Untiling because new rect {} does not fit into screen #{} rect {}", new_rect, window_screen.index(), window_screen.rect());
else
dbgln("Untiling because new rect {} does not touch screen #{} rect {}", new_rect, window_screen.index(), window_screen.rect());
} else if (new_tile_type != m_tiled)
dbgln("Changing tile type from {} to {}", (int)m_tiled, (int)new_tile_type);
}
m_tiled = new_tile_type;
}
bool Window::set_untiled(Optional<Gfx::IntPoint> fixed_point)
{
if (m_tiled == WindowTileType::None)
return false;
VERIFY(!resize_aspect_ratio().has_value());
m_tiled = WindowTileType::None;
if (fixed_point.has_value()) {
auto new_rect = Gfx::IntRect(m_rect);
new_rect.set_size_around(m_untiled_rect.size(), fixed_point.value());
set_rect(new_rect);
} else {
set_rect(m_untiled_rect);
}
Core::EventLoop::current().post_event(*this, make<ResizeEvent>(m_rect));
return true;
}
void Window::set_tiled(Screen* screen, WindowTileType tiled)
{
VERIFY(tiled != WindowTileType::None);
if (m_tiled == tiled)
return;
if (resize_aspect_ratio().has_value())
return;
if (m_tiled == WindowTileType::None)
m_untiled_rect = m_rect;
m_tiled = tiled;
set_rect(tiled_rect(screen, tiled));
Core::EventLoop::current().post_event(*this, make<ResizeEvent>(m_rect));
}
void Window::detach_client(Badge<ClientConnection>)
{
m_client = nullptr;
}
void Window::recalculate_rect()
{
if (!is_resizable())
return;
bool send_event = true;
if (m_tiled != WindowTileType::None) {
set_rect(tiled_rect(nullptr, m_tiled));
} else if (is_maximized()) {
set_rect(WindowManager::the().maximized_window_rect(*this));
} else if (type() == WindowType::Desktop) {
set_rect(WindowManager::the().arena_rect_for_type(Screen::main(), WindowType::Desktop));
} else {
send_event = false;
}
if (send_event) {
Core::EventLoop::current().post_event(*this, make<ResizeEvent>(m_rect));
}
}
void Window::add_child_window(Window& child_window)
{
m_child_windows.append(child_window);
}
void Window::add_accessory_window(Window& accessory_window)
{
m_accessory_windows.append(accessory_window);
}
void Window::set_parent_window(Window& parent_window)
{
VERIFY(!m_parent_window);
m_parent_window = parent_window;
if (m_accessory)
parent_window.add_accessory_window(*this);
else
parent_window.add_child_window(*this);
}
bool Window::is_accessory() const
{
if (!m_accessory)
return false;
if (parent_window() != nullptr)
return true;
// If accessory window was unparented, convert to a regular window
const_cast<Window*>(this)->set_accessory(false);
return false;
}
bool Window::is_accessory_of(Window& window) const
{
if (!is_accessory())
return false;
return parent_window() == &window;
}
void Window::modal_unparented()
{
m_modal = false;
WindowManager::the().notify_modal_unparented(*this);
}
bool Window::is_modal() const
{
if (!m_modal)
return false;
if (!m_parent_window) {
const_cast<Window*>(this)->modal_unparented();
return false;
}
return true;
}
void Window::set_progress(Optional<int> progress)
{
if (m_progress == progress)
return;
m_progress = progress;
WindowManager::the().notify_progress_changed(*this);
}
bool Window::is_descendant_of(Window& window) const
{
for (auto* parent = parent_window(); parent; parent = parent->parent_window()) {
if (parent == &window)
return true;
for (auto& accessory : parent->accessory_windows()) {
if (accessory == &window)
return true;
}
}
return false;
}
Optional<HitTestResult> Window::hit_test(Gfx::IntPoint const& position, bool include_frame)
{
if (!m_hit_testing_enabled)
return {};
// We need to check the (possibly constrained) render rect to make sure
// we don't hit-test on a window that is constrained to a screen, but somehow
// (partially) moved into another screen where it's not rendered
if (!frame().rect().intersected(frame().render_rect()).contains(position))
return {};
if (!rect().contains(position)) {
if (include_frame)
return frame().hit_test(position);
return {};
}
bool hit = false;
u8 threshold = alpha_hit_threshold() * 255;
if (threshold == 0 || !m_backing_store || !m_backing_store->has_alpha_channel()) {
hit = true;
} else {
auto relative_point = position.translated(-rect().location()) * m_backing_store->scale();
u8 alpha = 0xff;
if (m_backing_store->rect().contains(relative_point))
alpha = m_backing_store->get_pixel(relative_point).alpha();
hit = alpha >= threshold;
}
if (!hit)
return {};
return HitTestResult {
.window = *this,
.screen_position = position,
.window_relative_position = position.translated(-rect().location()),
.is_frame_hit = false,
};
}
void Window::set_menubar(Menubar* menubar)
{
if (m_menubar == menubar)
return;
m_menubar = menubar;
if (m_menubar) {
// FIXME: Maybe move this to the theming system?
static constexpr auto menubar_menu_margin = 14;
auto& wm = WindowManager::the();
Gfx::IntPoint next_menu_location { 0, 0 };
auto menubar_rect = Gfx::WindowTheme::current().menubar_rect(Gfx::WindowTheme::WindowType::Normal, rect(), wm.palette(), 1);
m_menubar->for_each_menu([&](Menu& menu) {
int text_width = wm.font().width(Gfx::parse_ampersand_string(menu.name()));
menu.set_rect_in_window_menubar({ next_menu_location.x(), 0, text_width + menubar_menu_margin, menubar_rect.height() });
next_menu_location.translate_by(menu.rect_in_window_menubar().width(), 0);
return IterationDecision::Continue;
});
}
Compositor::the().invalidate_occlusions();
frame().invalidate();
}
void Window::invalidate_menubar()
{
if (!m_should_show_menubar || !menubar())
return;
frame().invalidate_menubar();
}
void Window::set_modified(bool modified)
{
if (m_modified == modified)
return;
m_modified = modified;
WindowManager::the().notify_modified_changed(*this);
frame().set_button_icons();
frame().invalidate_titlebar();
}
String Window::computed_title() const
{
String title = m_title;
title.replace("[*]", is_modified() ? " (*)" : "");
if (client() && client()->is_unresponsive())
return String::formatted("{} (Not responding)", title);
return title;
}
}