//! The state of the window, which is shared with the event-loop. use std::mem::ManuallyDrop; use std::num::NonZeroU32; use std::sync::{Arc, Weak}; use log::warn; use sctk::reexports::client::protocol::wl_seat::WlSeat; use sctk::reexports::client::protocol::wl_shm::WlShm; use sctk::reexports::client::protocol::wl_surface::WlSurface; use sctk::reexports::client::{Connection, Proxy, QueueHandle}; use sctk::reexports::protocols::wp::fractional_scale::v1::client::wp_fractional_scale_v1::WpFractionalScaleV1; use sctk::reexports::protocols::wp::text_input::zv3::client::zwp_text_input_v3::ZwpTextInputV3; use sctk::reexports::protocols::wp::viewporter::client::wp_viewport::WpViewport; use sctk::reexports::protocols::xdg::shell::client::xdg_toplevel::ResizeEdge; use sctk::compositor::{CompositorState, Region, SurfaceData}; use sctk::seat::pointer::ThemedPointer; use sctk::shell::xdg::frame::{DecorationsFrame, FrameAction, FrameClick}; use sctk::shell::xdg::window::{DecorationMode, Window, WindowConfigure}; use sctk::shell::xdg::XdgSurface; use sctk::shell::WaylandSurface; use sctk::shm::Shm; use sctk::subcompositor::SubcompositorState; use crate::dpi::{LogicalPosition, LogicalSize}; use crate::error::{ExternalError, NotSupportedError}; use crate::platform_impl::WindowId; use crate::window::{CursorGrabMode, CursorIcon, ImePurpose, ResizeDirection, Theme}; use crate::platform_impl::wayland::seat::{ PointerConstraintsState, WinitPointerData, WinitPointerDataExt, ZwpTextInputV3Ext, }; use crate::platform_impl::wayland::state::{WindowCompositorUpdate, WinitState}; #[cfg(feature = "sctk-adwaita")] pub type WinitFrame = sctk_adwaita::AdwaitaFrame; #[cfg(not(feature = "sctk-adwaita"))] pub type WinitFrame = sctk::shell::xdg::frame::fallback_frame::FallbackFrame; // Minimum window inner size. const MIN_WINDOW_SIZE: LogicalSize = LogicalSize::new(2, 1); /// The state of the window which is being updated from the [`WinitState`]. pub struct WindowState { /// The connection to Wayland server. pub connection: Connection, /// The underlying SCTK window. pub window: ManuallyDrop, /// The window frame, which is created from the configure request. frame: Option, /// The `Shm` to set cursor. pub shm: WlShm, /// The last received configure. pub last_configure: Option, /// The pointers observed on the window. pub pointers: Vec>>, /// Cursor icon. pub cursor_icon: CursorIcon, /// Wether the cursor is visible. pub cursor_visible: bool, /// Pointer constraints to lock/confine pointer. pub pointer_constraints: Option>, /// Queue handle. pub queue_handle: QueueHandle, /// Theme varaint. theme: Option, /// The current window title. title: String, /// Whether the frame is resizable. resizable: bool, /// Whether the window has focus. has_focus: bool, /// The scale factor of the window. scale_factor: f64, /// Whether the window is transparent. transparent: bool, /// The state of the compositor to create WlRegions. compositor: Arc, /// The current cursor grabbing mode. cursor_grab_mode: GrabState, /// Whether the IME input is allowed for that window. ime_allowed: bool, /// The current IME purpose. ime_purpose: ImePurpose, /// The text inputs observed on the window. text_inputs: Vec, /// The inner size of the window, as in without client side decorations. size: LogicalSize, /// Whether the CSD fail to create, so we don't try to create them on each iteration. csd_fails: bool, /// Min size. min_inner_size: LogicalSize, max_inner_size: Option>, /// The size of the window when no states were applied to it. The primary use for it /// is to fallback to original window size, before it was maximized, if the compositor /// sends `None` for the new size in the configure. stateless_size: LogicalSize, viewport: Option, fractional_scale: Option, } /// The state of the cursor grabs. #[derive(Clone, Copy)] struct GrabState { /// The grab mode requested by the user. user_grab_mode: CursorGrabMode, /// The current grab mode. current_grab_mode: CursorGrabMode, } impl GrabState { fn new() -> Self { Self { user_grab_mode: CursorGrabMode::None, current_grab_mode: CursorGrabMode::None, } } } impl WindowState { /// Apply closure on the given pointer. fn apply_on_poiner, &WinitPointerData)>( &self, callback: F, ) { self.pointers .iter() .filter_map(Weak::upgrade) .for_each(|pointer| { let data = pointer.pointer().winit_data(); callback(pointer.as_ref(), data); }) } pub fn configure( &mut self, configure: WindowConfigure, shm: &Shm, subcompositor: &Arc, ) -> LogicalSize { if configure.decoration_mode == DecorationMode::Client && self.frame.is_none() && !self.csd_fails { match WinitFrame::new( &*self.window, shm, subcompositor.clone(), self.queue_handle.clone(), #[cfg(feature = "sctk-adwaita")] into_sctk_adwaita_config(self.theme), ) { Ok(mut frame) => { frame.set_title(&self.title); // Ensure that the frame is not hidden. frame.set_hidden(false); self.frame = Some(frame); } Err(err) => { warn!("Failed to create client side decorations frame: {err}"); self.csd_fails = true; } } } else if configure.decoration_mode == DecorationMode::Server { // Drop the frame for server side decorations to save resources. self.frame = None; } let stateless = Self::is_stateless(&configure); let new_size = if let Some(frame) = self.frame.as_mut() { // Configure the window states. frame.update_state(configure.state); match configure.new_size { (Some(width), Some(height)) => { let (width, height) = frame.subtract_borders(width, height); ( width.map(|w| w.get()).unwrap_or(1), height.map(|h| h.get()).unwrap_or(1), ) .into() } (_, _) if stateless => self.stateless_size, _ => self.size, } } else { match configure.new_size { (Some(width), Some(height)) => (width.get(), height.get()).into(), _ if stateless => self.stateless_size, _ => self.size, } }; // XXX Set the configure before doing a resize. self.last_configure = Some(configure); // XXX Update the new size right away. self.resize(new_size); new_size } #[inline] fn is_stateless(configure: &WindowConfigure) -> bool { !(configure.is_maximized() || configure.is_fullscreen() || configure.is_tiled()) } /// Start interacting drag resize. pub fn drag_resize_window(&self, direction: ResizeDirection) -> Result<(), ExternalError> { let xdg_toplevel = self.window.xdg_toplevel(); // TODO(kchibisov) handle touch serials. self.apply_on_poiner(|_, data| { let serial = data.latest_button_serial(); let seat = data.seat(); xdg_toplevel.resize(seat, serial, direction.into()); }); Ok(()) } /// Start the window drag. pub fn drag_window(&self) -> Result<(), ExternalError> { let xdg_toplevel = self.window.xdg_toplevel(); // TODO(kchibisov) handle touch serials. self.apply_on_poiner(|_, data| { let serial = data.latest_button_serial(); let seat = data.seat(); xdg_toplevel._move(seat, serial); }); Ok(()) } /// Tells whether the window should be closed. pub fn frame_click( &mut self, click: FrameClick, pressed: bool, seat: &WlSeat, serial: u32, window_id: WindowId, updates: &mut Vec, ) -> Option { match self.frame.as_mut()?.on_click(click, pressed)? { FrameAction::Minimize => self.window.set_minimized(), FrameAction::Maximize => self.window.set_maximized(), FrameAction::UnMaximize => self.window.unset_maximized(), FrameAction::Close => WinitState::queue_close(updates, window_id), FrameAction::Move => self.window.move_(seat, serial), FrameAction::Resize(edge) => self.window.resize(seat, serial, edge), FrameAction::ShowMenu(x, y) => self.window.show_window_menu(seat, serial, (x, y)), }; Some(false) } pub fn frame_point_left(&mut self) { if let Some(frame) = self.frame.as_mut() { frame.click_point_left(); } } // Move the point over decorations. pub fn frame_point_moved(&mut self, surface: &WlSurface, x: f64, y: f64) -> Option<&str> { if let Some(frame) = self.frame.as_mut() { frame.click_point_moved(surface, x, y) } else { None } } /// Get the stored resizable state. #[inline] pub fn resizable(&self) -> bool { self.resizable } /// Set the resizable state on the window. #[inline] pub fn set_resizable(&mut self, resizable: bool) { if self.resizable == resizable { return; } self.resizable = resizable; if resizable { // Restore min/max sizes of the window. self.reload_min_max_hints(); } else { self.set_min_inner_size(Some(self.size)); self.set_max_inner_size(Some(self.size)); } // Reload the state on the frame as well. if let Some(frame) = self.frame.as_mut() { frame.set_resizable(resizable); } } /// Whether the window is focused. #[inline] pub fn has_focus(&self) -> bool { self.has_focus } /// Whether the IME is allowed. #[inline] pub fn ime_allowed(&self) -> bool { self.ime_allowed } /// Get the size of the window. #[inline] pub fn inner_size(&self) -> LogicalSize { self.size } /// Whether the window received initial configure event from the compositor. #[inline] pub fn is_configured(&self) -> bool { self.last_configure.is_some() } #[inline] pub fn is_decorated(&mut self) -> bool { let csd = self .last_configure .as_ref() .map(|configure| configure.decoration_mode == DecorationMode::Client) .unwrap_or(false); if let Some(frame) = csd.then_some(self.frame.as_ref()).flatten() { frame.is_hidden() } else { // Server side decorations. true } } /// Create new window state. pub fn new( connection: Connection, queue_handle: &QueueHandle, winit_state: &WinitState, size: LogicalSize, window: Window, theme: Option, ) -> Self { let compositor = winit_state.compositor_state.clone(); let pointer_constraints = winit_state.pointer_constraints.clone(); let viewport = winit_state .viewporter_state .as_ref() .map(|state| state.get_viewport(window.wl_surface(), queue_handle)); let fractional_scale = winit_state .fractional_scaling_manager .as_ref() .map(|fsm| fsm.fractional_scaling(window.wl_surface(), queue_handle)); Self { compositor, connection, theme, csd_fails: false, cursor_grab_mode: GrabState::new(), cursor_icon: CursorIcon::Default, cursor_visible: true, fractional_scale, frame: None, has_focus: false, ime_allowed: false, ime_purpose: ImePurpose::Normal, last_configure: None, max_inner_size: None, min_inner_size: MIN_WINDOW_SIZE, pointer_constraints, pointers: Default::default(), queue_handle: queue_handle.clone(), scale_factor: 1., shm: winit_state.shm.wl_shm().clone(), size, stateless_size: size, text_inputs: Vec::new(), title: String::default(), transparent: false, resizable: true, viewport, window: ManuallyDrop::new(window), } } /// Get the outer size of the window. #[inline] pub fn outer_size(&self) -> LogicalSize { self.frame .as_ref() .map(|frame| frame.add_borders(self.size.width, self.size.height).into()) .unwrap_or(self.size) } /// Register pointer on the top-level. pub fn pointer_entered(&mut self, added: Weak>) { self.pointers.push(added); self.reload_cursor_style(); let mode = self.cursor_grab_mode.user_grab_mode; let _ = self.set_cursor_grab_inner(mode); } /// Pointer has left the top-level. pub fn pointer_left(&mut self, removed: Weak>) { let mut new_pointers = Vec::new(); for pointer in self.pointers.drain(..) { if let Some(pointer) = pointer.upgrade() { if pointer.pointer() != removed.upgrade().unwrap().pointer() { new_pointers.push(Arc::downgrade(&pointer)); } } } self.pointers = new_pointers; } /// Refresh the decorations frame if it's present returning whether the client should redraw. pub fn refresh_frame(&mut self) -> bool { if let Some(frame) = self.frame.as_mut() { let dirty = frame.is_dirty(); if dirty { frame.draw(); } dirty } else { false } } /// Reload the cursor style on the given window. pub fn reload_cursor_style(&mut self) { if self.cursor_visible { self.set_cursor(self.cursor_icon); } else { self.set_cursor_visible(self.cursor_visible); } } /// Reissue the transparency hint to the compositor. pub fn reload_transparency_hint(&self) { let surface = self.window.wl_surface(); if self.transparent { surface.set_opaque_region(None); } else if let Ok(region) = Region::new(&*self.compositor) { region.add(0, 0, i32::MAX, i32::MAX); surface.set_opaque_region(Some(region.wl_region())); } else { warn!("Failed to mark window opaque."); } } /// Resize the window to the new inner size. pub fn resize(&mut self, inner_size: LogicalSize) { self.size = inner_size; // Update the stateless size. if Some(true) == self.last_configure.as_ref().map(Self::is_stateless) { self.stateless_size = inner_size; } // Update the inner frame. let ((x, y), outer_size) = if let Some(frame) = self.frame.as_mut() { // Resize only visible frame. if !frame.is_hidden() { frame.resize( NonZeroU32::new(self.size.width).unwrap(), NonZeroU32::new(self.size.height).unwrap(), ); } ( frame.location(), frame.add_borders(self.size.width, self.size.height).into(), ) } else { ((0, 0), self.size) }; // Reload the hint. self.reload_transparency_hint(); // Set the window geometry. self.window.xdg_surface().set_window_geometry( x, y, outer_size.width as i32, outer_size.height as i32, ); // Update the target viewport, this is used if and only if fractional scaling is in use. if let Some(viewport) = self.viewport.as_ref() { // Set inner size without the borders. viewport.set_destination(self.size.width as _, self.size.height as _); } } /// Get the scale factor of the window. #[inline] pub fn scale_factor(&self) -> f64 { self.scale_factor } /// Set the cursor icon. /// /// Providing `None` will hide the cursor. pub fn set_cursor(&mut self, cursor_icon: CursorIcon) { self.cursor_icon = cursor_icon; if !self.cursor_visible { return; } self.apply_on_poiner(|pointer, data| { let surface = data.cursor_surface(); let scale_factor = surface.data::().unwrap().scale_factor(); if pointer .set_cursor( &self.connection, cursor_icon.name(), &self.shm, surface, scale_factor, ) .is_err() { warn!("Failed to set cursor to {:?}", cursor_icon); } }) } /// Set maximum inner window size. pub fn set_min_inner_size(&mut self, size: Option>) { // Ensure that the window has the right minimum size. let mut size = size.unwrap_or(MIN_WINDOW_SIZE); size.width = size.width.max(MIN_WINDOW_SIZE.width); size.height = size.height.max(MIN_WINDOW_SIZE.height); // Add the borders. let size = self .frame .as_ref() .map(|frame| frame.add_borders(size.width, size.height).into()) .unwrap_or(size); self.min_inner_size = size; self.window.set_min_size(Some(size.into())); } /// Set maximum inner window size. pub fn set_max_inner_size(&mut self, size: Option>) { let size = size.map(|size| { self.frame .as_ref() .map(|frame| frame.add_borders(size.width, size.height).into()) .unwrap_or(size) }); self.max_inner_size = size; self.window.set_max_size(size.map(Into::into)); } /// Set the CSD theme. pub fn set_theme(&mut self, theme: Option) { self.theme = theme; #[cfg(feature = "sctk-adwaita")] if let Some(frame) = self.frame.as_mut() { frame.set_config(into_sctk_adwaita_config(theme)) } } /// The current theme for CSD decorations. #[inline] pub fn theme(&self) -> Option { self.theme } /// Set the cursor grabbing state on the top-level. pub fn set_cursor_grab(&mut self, mode: CursorGrabMode) -> Result<(), ExternalError> { // Replace the user grabbing mode. self.cursor_grab_mode.user_grab_mode = mode; self.set_cursor_grab_inner(mode) } /// Reload the hints for minimum and maximum sizes. pub fn reload_min_max_hints(&mut self) { self.set_min_inner_size(Some(self.min_inner_size)); self.set_max_inner_size(self.max_inner_size); } /// Set the grabbing state on the surface. fn set_cursor_grab_inner(&mut self, mode: CursorGrabMode) -> Result<(), ExternalError> { let pointer_constraints = match self.pointer_constraints.as_ref() { Some(pointer_constraints) => pointer_constraints, None if mode == CursorGrabMode::None => return Ok(()), None => return Err(ExternalError::NotSupported(NotSupportedError::new())), }; // Replace the current mode. let old_mode = std::mem::replace(&mut self.cursor_grab_mode.current_grab_mode, mode); match old_mode { CursorGrabMode::None => (), CursorGrabMode::Confined => self.apply_on_poiner(|_, data| { data.unconfine_pointer(); }), CursorGrabMode::Locked => { self.apply_on_poiner(|_, data| data.unlock_pointer()); } } let surface = self.window.wl_surface(); match mode { CursorGrabMode::Locked => self.apply_on_poiner(|pointer, data| { let pointer = pointer.pointer(); data.lock_pointer(pointer_constraints, surface, pointer, &self.queue_handle) }), CursorGrabMode::Confined => self.apply_on_poiner(|pointer, data| { let pointer = pointer.pointer(); data.confine_pointer(pointer_constraints, surface, pointer, &self.queue_handle) }), CursorGrabMode::None => { // Current lock/confine was already removed. } } Ok(()) } /// Set the position of the cursor. pub fn set_cursor_position(&self, position: LogicalPosition) -> Result<(), ExternalError> { if self.pointer_constraints.is_none() { return Err(ExternalError::NotSupported(NotSupportedError::new())); } // Positon can be set only for locked cursor. if self.cursor_grab_mode.current_grab_mode != CursorGrabMode::Locked { return Err(ExternalError::Os(os_error!( crate::platform_impl::OsError::WaylandMisc( "cursor position can be set only for locked cursor." ) ))); } self.apply_on_poiner(|_, data| { data.set_locked_cursor_position(position.x, position.y); }); Ok(()) } /// Set the visibility state of the cursor. pub fn set_cursor_visible(&mut self, cursor_visible: bool) { self.cursor_visible = cursor_visible; if self.cursor_visible { self.set_cursor(self.cursor_icon); } else { for pointer in self.pointers.iter().filter_map(|pointer| pointer.upgrade()) { let latest_enter_serial = pointer.pointer().winit_data().latest_enter_serial(); pointer .pointer() .set_cursor(latest_enter_serial, None, 0, 0); } } } /// Whether show or hide client side decorations. #[inline] pub fn set_decorate(&mut self, decorate: bool) { if let Some(frame) = self.frame.as_mut() { frame.set_hidden(!decorate); // Force the resize. self.resize(self.size); } } /// Mark that the window has focus. /// /// Should be used from routine that sends focused event. #[inline] pub fn set_has_focus(&mut self, has_focus: bool) { self.has_focus = has_focus; } /// Returns `true` if the requested state was applied. pub fn set_ime_allowed(&mut self, allowed: bool) -> bool { self.ime_allowed = allowed; let mut applied = false; for text_input in &self.text_inputs { applied = true; if allowed { text_input.enable(); text_input.set_content_type_by_purpose(self.ime_purpose); } else { text_input.disable(); } text_input.commit(); } applied } /// Set the IME position. pub fn set_ime_position(&self, position: LogicalPosition) { // XXX This won't fly unless user will have a way to request IME window per seat, since // the ime windows will be overlapping, but winit doesn't expose API to specify for // which seat we're setting IME position. let (x, y) = (position.x as i32, position.y as i32); for text_input in self.text_inputs.iter() { text_input.set_cursor_rectangle(x, y, 0, 0); text_input.commit(); } } /// Set the IME purpose. pub fn set_ime_purpose(&mut self, purpose: ImePurpose) { self.ime_purpose = purpose; for text_input in &self.text_inputs { text_input.set_content_type_by_purpose(purpose); text_input.commit(); } } /// Get the IME purpose. pub fn ime_purpose(&self) -> ImePurpose { self.ime_purpose } /// Set the scale factor for the given window. #[inline] pub fn set_scale_factor(&mut self, scale_factor: f64) { self.scale_factor = scale_factor; // XXX when fractional scaling is not used update the buffer scale. if self.fractional_scale.is_none() { let _ = self.window.set_buffer_scale(self.scale_factor as _); } } /// Set the window title to a new value. /// /// This will autmatically truncate the title to something meaningfull. pub fn set_title(&mut self, mut title: String) { // Truncate the title to at most 1024 bytes, so that it does not blow up the protocol // messages if title.len() > 1024 { let mut new_len = 1024; while !title.is_char_boundary(new_len) { new_len -= 1; } title.truncate(new_len); } // Update the CSD title. if let Some(frame) = self.frame.as_mut() { frame.set_title(&title); } self.window.set_title(&title); self.title = title; } /// Mark the window as transparent. #[inline] pub fn set_transparent(&mut self, transparent: bool) { self.transparent = transparent; self.reload_transparency_hint(); } /// Register text input on the top-level. #[inline] pub fn text_input_entered(&mut self, text_input: &ZwpTextInputV3) { if !self.text_inputs.iter().any(|t| t == text_input) { self.text_inputs.push(text_input.clone()); } } /// The text input left the top-level. #[inline] pub fn text_input_left(&mut self, text_input: &ZwpTextInputV3) { if let Some(position) = self.text_inputs.iter().position(|t| t == text_input) { self.text_inputs.remove(position); } } /// Get the cached title. #[inline] pub fn title(&self) -> &str { &self.title } } impl Drop for WindowState { fn drop(&mut self) { let surface = self.window.wl_surface().clone(); unsafe { ManuallyDrop::drop(&mut self.window); } surface.destroy(); } } impl From for ResizeEdge { fn from(value: ResizeDirection) -> Self { match value { ResizeDirection::North => ResizeEdge::Top, ResizeDirection::West => ResizeEdge::Left, ResizeDirection::NorthWest => ResizeEdge::TopLeft, ResizeDirection::NorthEast => ResizeEdge::TopRight, ResizeDirection::East => ResizeEdge::Right, ResizeDirection::SouthWest => ResizeEdge::BottomLeft, ResizeDirection::SouthEast => ResizeEdge::BottomRight, ResizeDirection::South => ResizeEdge::Bottom, } } } // XXX rust doesn't allow from `Option`. #[cfg(feature = "sctk-adwaita")] fn into_sctk_adwaita_config(theme: Option) -> sctk_adwaita::FrameConfig { match theme { Some(Theme::Light) => sctk_adwaita::FrameConfig::light(), Some(Theme::Dark) => sctk_adwaita::FrameConfig::dark(), None => sctk_adwaita::FrameConfig::auto(), } }