use super::{draw_window, Window}; use crate::{ backend::renderer::{utils::SurfaceState, Frame, ImportAll, Renderer, Transform}, desktop::{layer::*, output::*}, utils::{Logical, Point, Rectangle}, wayland::{ compositor::{ get_parent, is_sync_subsurface, with_surface_tree_downward, SubsurfaceCachedState, TraversalAction, }, output::Output, shell::wlr_layer::Layer as WlrLayer, }, }; use indexmap::{IndexMap, IndexSet}; use std::{ cell::{RefCell, RefMut}, collections::{HashMap, HashSet, VecDeque}, sync::{ atomic::{AtomicUsize, Ordering}, Mutex, }, }; use wayland_server::protocol::wl_surface::WlSurface; static SPACE_ID: AtomicUsize = AtomicUsize::new(0); lazy_static::lazy_static! { static ref SPACE_IDS: Mutex> = Mutex::new(HashSet::new()); } fn next_space_id() -> usize { let mut ids = SPACE_IDS.lock().unwrap(); if ids.len() == usize::MAX { // Theoretically the code below wraps around correctly, // but that is hard to detect and might deadlock. // Maybe make this a debug_assert instead? panic!("Out of space ids"); } let mut id = SPACE_ID.fetch_add(1, Ordering::SeqCst); while ids.iter().any(|k| *k == id) { id = SPACE_ID.fetch_add(1, Ordering::SeqCst); } ids.insert(id); id } #[derive(Default)] struct WindowState { location: Point, drawn: bool, } type WindowUserdata = RefCell>; fn window_state(space: usize, w: &Window) -> RefMut<'_, WindowState> { let userdata = w.user_data(); userdata.insert_if_missing(WindowUserdata::default); RefMut::map(userdata.get::().unwrap().borrow_mut(), |m| { m.entry(space).or_default() }) } #[derive(Default)] struct LayerState { drawn: bool, } type LayerUserdata = RefCell>; fn layer_state(space: usize, l: &LayerSurface) -> RefMut<'_, LayerState> { let userdata = l.user_data(); userdata.insert_if_missing(LayerUserdata::default); RefMut::map(userdata.get::().unwrap().borrow_mut(), |m| { m.entry(space).or_default() }) } // TODO: Maybe replace UnmanagedResource if nothing else comes up? #[derive(Debug, thiserror::Error)] pub enum SpaceError { #[error("Window is not mapped to this space")] UnknownWindow, } #[derive(Debug)] pub struct Space { pub(super) id: usize, // in z-order, back to front windows: IndexSet, outputs: Vec, // TODO: //layers: Vec, logger: ::slog::Logger, } impl Drop for Space { fn drop(&mut self) { SPACE_IDS.lock().unwrap().remove(&self.id); } } impl Space { pub fn new(log: L) -> Space where L: Into>, { Space { id: next_space_id(), windows: IndexSet::new(), outputs: Vec::new(), logger: crate::slog_or_fallback(log), } } /// Map window and moves it to top of the stack /// /// This can safely be called on an already mapped window pub fn map_window>>(&mut self, window: &Window, location: P) { self.insert_window(window); window_state(self.id, window).location = location.into(); } pub fn raise_window(&mut self, window: &Window) { if self.windows.shift_remove(window) { self.insert_window(window); } } fn insert_window(&mut self, window: &Window) { self.windows.insert(window.clone()); // TODO: should this be handled by us? window.set_activated(true); for w in self.windows.iter() { if w != window { w.set_activated(false); } } } /// Unmap a window from this space by its id pub fn unmap_window(&mut self, window: &Window) { if let Some(map) = window.user_data().get::() { map.borrow_mut().remove(&self.id); } self.windows.shift_remove(window); } /// Iterate window in z-order back to front pub fn windows(&self) -> impl DoubleEndedIterator { self.windows.iter() } /// Get a reference to the window under a given point, if any pub fn window_under>>(&self, point: P) -> Option<&Window> { let point = point.into(); self.windows.iter().rev().find(|w| { let bbox = window_rect(w, &self.id); bbox.to_f64().contains(point) }) } /// Get a reference to the output under a given point, if any pub fn output_under>>(&self, point: P) -> Option<&Output> { let point = point.into(); self.outputs.iter().rev().find(|o| { let bbox = self.output_geometry(o); bbox.map(|bbox| bbox.to_f64().contains(point)).unwrap_or(false) }) } pub fn window_for_surface(&self, surface: &WlSurface) -> Option<&Window> { if !surface.as_ref().is_alive() { return None; } self.windows .iter() .find(|w| w.toplevel().get_surface().map(|x| x == surface).unwrap_or(false)) } pub fn layer_for_surface(&self, surface: &WlSurface) -> Option { if !surface.as_ref().is_alive() { return None; } self.outputs.iter().find_map(|o| { let map = layer_map_for_output(o); map.layer_for_surface(surface).cloned() }) } pub fn window_geometry(&self, w: &Window) -> Option> { if !self.windows.contains(w) { return None; } Some(window_geo(w, &self.id)) } pub fn window_bbox(&self, w: &Window) -> Option> { if !self.windows.contains(w) { return None; } Some(window_rect(w, &self.id)) } pub fn map_output>>(&mut self, output: &Output, scale: f64, location: P) { let mut state = output_state(self.id, output); *state = OutputState { location: location.into(), render_scale: scale, ..Default::default() }; if !self.outputs.contains(output) { self.outputs.push(output.clone()); } } pub fn outputs(&self) -> impl Iterator { self.outputs.iter() } pub fn unmap_output(&mut self, output: &Output) { if let Some(map) = output.user_data().get::() { map.borrow_mut().remove(&self.id); } self.outputs.retain(|o| o != output); } pub fn output_geometry(&self, o: &Output) -> Option> { if !self.outputs.contains(o) { return None; } let state = output_state(self.id, o); o.current_mode().map(|mode| { Rectangle::from_loc_and_size( state.location, mode.size.to_f64().to_logical(state.render_scale).to_i32_round(), ) }) } pub fn output_scale(&self, o: &Output) -> Option { if !self.outputs.contains(o) { return None; } let state = output_state(self.id, o); Some(state.render_scale) } pub fn outputs_for_window(&self, w: &Window) -> Vec { if !self.windows.contains(w) { return Vec::new(); } let w_geo = window_rect(w, &self.id); let mut outputs = self .outputs .iter() .cloned() .filter(|o| { let o_geo = self.output_geometry(o).unwrap(); w_geo.overlaps(o_geo) }) .collect::>(); outputs.sort_by(|o1, o2| { let overlap = |rect1: Rectangle, rect2: Rectangle| -> i32 { // x overlap std::cmp::max(0, std::cmp::min(rect1.loc.x + rect1.size.w, rect2.loc.x + rect2.size.w) - std::cmp::max(rect1.loc.x, rect2.loc.x)) // y overlap * std::cmp::max(0, std::cmp::min(rect1.loc.y + rect1.size.h, rect2.loc.y + rect2.size.h) - std::cmp::max(rect1.loc.y, rect2.loc.y)) }; let o1_area = overlap(self.output_geometry(o1).unwrap(), w_geo); let o2_area = overlap(self.output_geometry(o2).unwrap(), w_geo); o1_area.cmp(&o2_area) }); outputs } pub fn refresh(&mut self) { self.windows.retain(|w| w.toplevel().alive()); for output in &mut self.outputs { output_state(self.id, output) .surfaces .retain(|s| s.as_ref().is_alive()); } for window in &self.windows { let bbox = window_rect(window, &self.id); let kind = window.toplevel(); for output in &self.outputs { let output_geometry = self .output_geometry(output) .unwrap_or_else(|| Rectangle::from_loc_and_size((0, 0), (0, 0))); let mut output_state = output_state(self.id, output); // Check if the bounding box of the toplevel intersects with // the output, if not no surface in the tree can intersect with // the output. if !output_geometry.overlaps(bbox) { if let Some(surface) = kind.get_surface() { with_surface_tree_downward( surface, (), |_, _, _| TraversalAction::DoChildren(()), |wl_surface, _, _| { if output_state.surfaces.contains(wl_surface) { slog::trace!( self.logger, "surface ({:?}) leaving output {:?}", wl_surface, output.name() ); output.leave(wl_surface); output_state.surfaces.retain(|s| s != wl_surface); } }, |_, _, _| true, ) } continue; } if let Some(surface) = kind.get_surface() { with_surface_tree_downward( surface, window_loc(window, &self.id), |_, states, location| { let mut location = *location; let data = states.data_map.get::>(); if data.is_some() { if states.role == Some("subsurface") { let current = states.cached_state.current::(); location += current.location; } TraversalAction::DoChildren(location) } else { // If the parent surface is unmapped, then the child surfaces are hidden as // well, no need to consider them here. TraversalAction::SkipChildren } }, |wl_surface, states, &loc| { let data = states.data_map.get::>(); if let Some(size) = data.and_then(|d| d.borrow().size()) { let surface_rectangle = Rectangle { loc, size }; if output_geometry.overlaps(surface_rectangle) { // We found a matching output, check if we already sent enter if !output_state.surfaces.contains(wl_surface) { slog::trace!( self.logger, "surface ({:?}) entering output {:?}", wl_surface, output.name() ); output.enter(wl_surface); output_state.surfaces.push(wl_surface.clone()); } } else { // Surface does not match output, if we sent enter earlier // we should now send leave if output_state.surfaces.contains(wl_surface) { slog::trace!( self.logger, "surface ({:?}) leaving output {:?}", wl_surface, output.name() ); output.leave(wl_surface); output_state.surfaces.retain(|s| s != wl_surface); } } } else { // Maybe the the surface got unmapped, send leave on output if output_state.surfaces.contains(wl_surface) { slog::trace!( self.logger, "surface ({:?}) leaving output {:?}", wl_surface, output.name() ); output.leave(wl_surface); output_state.surfaces.retain(|s| s != wl_surface); } } }, |_, _, _| true, ) } } } } /// Automatically calls `Window::refresh` for the window that belongs to the given surface, /// if managed by this space. pub fn commit(&self, surface: &WlSurface) { if is_sync_subsurface(surface) { return; } let mut root = surface.clone(); while let Some(parent) = get_parent(&root) { root = parent; } if let Some(window) = self.windows().find(|w| w.toplevel().get_surface() == Some(&root)) { window.refresh(); } } pub fn render_output( &mut self, renderer: &mut R, output: &Output, age: usize, clear_color: [f32; 4], ) -> Result> where R: Renderer + ImportAll, R::TextureId: 'static, { let mut state = output_state(self.id, output); let output_size = output .current_mode() .ok_or(RenderError::OutputNoMode)? .size .to_f64() .to_logical(state.render_scale) .to_i32_round(); let output_geo = Rectangle::from_loc_and_size(state.location, output_size); let layer_map = layer_map_for_output(output); // This will hold all the damage we need for this rendering step let mut damage = Vec::>::new(); // First add damage for windows gone for old_window in state .last_state .iter() .filter_map(|(id, w)| { if !self.windows.iter().any(|w| ToplevelId::Xdg(w.0.id) == *id) && !layer_map.layers().any(|l| ToplevelId::Layer(l.0.id) == *id) { Some(*w) } else { None } }) .collect::>>() { slog::trace!(self.logger, "Removing toplevel at: {:?}", old_window); damage.push(old_window); } // lets iterate front to back and figure out, what new windows or unmoved windows we have for window in self.windows.iter() { let geo = window_rect_with_popups(window, &self.id); let old_geo = state.last_state.get(&ToplevelId::Xdg(window.0.id)).cloned(); // window was moved or resized if old_geo.map(|old_geo| old_geo != geo).unwrap_or(false) { // Add damage for the old position of the window damage.push(old_geo.unwrap()); damage.push(geo); } else { // window stayed at its place let loc = window_loc(window, &self.id); damage.extend( window .accumulated_damage(Some((self, output))) .into_iter() .map(|mut rect| { rect.loc += loc; rect }), ); } } for layer in layer_map.layers() { let geo = layer_map.layer_geometry(layer); let old_geo = state.last_state.get(&ToplevelId::Layer(layer.0.id)).cloned(); // layer moved or resized if old_geo.map(|old_geo| old_geo != geo).unwrap_or(false) { // Add damage for the old position of the layer damage.push(old_geo.unwrap()); damage.push(geo); } else { let location = geo.loc; damage.extend( layer .accumulated_damage(Some((self, output))) .into_iter() .map(|mut rect| { rect.loc += location; rect }), ); } } // That is all completely new damage, which we need to store for subsequent renders let new_damage = damage.clone(); // We now add old damage states, if we have an age value if age > 0 && state.old_damage.len() >= age { // We do not need older states anymore state.old_damage.truncate(age); damage.extend(state.old_damage.iter().flatten().copied()); } else { // just damage everything, if we have no damage damage = vec![output_geo]; } // Optimize the damage for rendering damage.dedup(); damage.retain(|rect| rect.overlaps(output_geo)); damage.retain(|rect| rect.size.h > 0 && rect.size.w > 0); for rect in damage.clone().iter() { // if this rect was already removed, because it was smaller as another one, // there is no reason to evaluate this. if damage.contains(rect) { // remove every rectangle that is contained in this rectangle damage.retain(|other| !rect.contains_rect(*other)); } } damage = damage.into_iter().fold(Vec::new(), |mut new_damage, rect| { if let Some(existing) = new_damage.iter_mut().find(|other| rect.overlaps(**other)) { *existing = existing.merge(rect); } else { new_damage.push(rect); } new_damage }); if damage.is_empty() { return Ok(false); } let output_transform: Transform = output.current_transform().into(); if let Err(err) = renderer.render( output_transform .transform_size(output_size) .to_f64() .to_physical(state.render_scale) .to_i32_round(), output_transform, |renderer, frame| { // First clear all damaged regions slog::trace!(self.logger, "Clearing at {:#?}", damage); frame.clear( clear_color, &damage .iter() .map(|geo| geo.to_f64().to_physical(state.render_scale).to_i32_round()) .collect::>(), )?; // Then re-draw all windows & layers overlapping with a damage rect. for layer in layer_map .layers_on(WlrLayer::Background) .chain(layer_map.layers_on(WlrLayer::Bottom)) { let lgeo = layer_map.layer_geometry(layer); if damage.iter().any(|geo| lgeo.overlaps(*geo)) { let layer_damage = damage .iter() .flat_map(|geo| geo.intersection(lgeo)) .map(|geo| Rectangle::from_loc_and_size(geo.loc - lgeo.loc, geo.size)) .collect::>(); slog::trace!( self.logger, "Rendering layer at {:?} with damage {:#?}", lgeo, damage ); draw_layer( renderer, frame, layer, state.render_scale, lgeo.loc, &layer_damage, &self.logger, )?; layer_state(self.id, layer).drawn = true; } } for window in self.windows.iter() { let wgeo = window_rect_with_popups(window, &self.id); let mut loc = window_loc(window, &self.id); if damage.iter().any(|geo| wgeo.overlaps(*geo)) { loc -= output_geo.loc; let win_damage = damage .iter() .flat_map(|geo| geo.intersection(wgeo)) .map(|geo| Rectangle::from_loc_and_size(geo.loc - loc, geo.size)) .collect::>(); slog::trace!( self.logger, "Rendering window at {:?} with damage {:#?}", wgeo, damage ); draw_window( renderer, frame, window, state.render_scale, loc, &win_damage, &self.logger, )?; window_state(self.id, window).drawn = true; } } for layer in layer_map .layers_on(WlrLayer::Top) .chain(layer_map.layers_on(WlrLayer::Overlay)) { let lgeo = layer_map.layer_geometry(layer); if damage.iter().any(|geo| lgeo.overlaps(*geo)) { let layer_damage = damage .iter() .flat_map(|geo| geo.intersection(lgeo)) .map(|geo| Rectangle::from_loc_and_size(geo.loc - lgeo.loc, geo.size)) .collect::>(); slog::trace!( self.logger, "Rendering layer at {:?} with damage {:#?}", lgeo, damage ); draw_layer( renderer, frame, layer, state.render_scale, lgeo.loc, &layer_damage, &self.logger, )?; layer_state(self.id, layer).drawn = true; } } Result::<(), R::Error>::Ok(()) }, ) { // if the rendering errors on us, we need to be prepared, that this whole buffer was partially updated and thus now unusable. // thus clean our old states before returning state.old_damage = VecDeque::new(); state.last_state = IndexMap::new(); return Err(RenderError::Rendering(err)); } // If rendering was successful capture the state and add the damage state.last_state = self .windows .iter() .map(|window| { let wgeo = window_rect_with_popups(window, &self.id); (ToplevelId::Xdg(window.0.id), wgeo) }) .chain(layer_map.layers().map(|layer| { let lgeo = layer_map.layer_geometry(layer); (ToplevelId::Layer(layer.0.id), lgeo) })) .collect(); state.old_damage.push_front(new_damage); Ok(true) } pub fn send_frames(&self, all: bool, time: u32) { for window in self.windows.iter().filter(|w| { all || { let mut state = window_state(self.id, w); std::mem::replace(&mut state.drawn, false) } }) { window.send_frame(time); } for output in self.outputs.iter() { let map = layer_map_for_output(output); for layer in map.layers().filter(|l| { all || { let mut state = layer_state(self.id, l); std::mem::replace(&mut state.drawn, false) } }) { layer.send_frame(time); } } } } #[derive(Debug, thiserror::Error)] pub enum RenderError { #[error(transparent)] Rendering(R::Error), #[error("Output has no active mode")] OutputNoMode, } fn window_geo(window: &Window, space_id: &usize) -> Rectangle { let loc = window_loc(window, space_id); let mut wgeo = window.geometry(); wgeo.loc = loc; wgeo } fn window_rect(window: &Window, space_id: &usize) -> Rectangle { let loc = window_loc(window, space_id); let mut wgeo = window.bbox(); wgeo.loc += loc; wgeo } fn window_rect_with_popups(window: &Window, space_id: &usize) -> Rectangle { let loc = window_loc(window, space_id); let mut wgeo = window.bbox_with_popups(); wgeo.loc += loc; wgeo } fn window_loc(window: &Window, space_id: &usize) -> Point { window .user_data() .get::>>() .unwrap() .borrow() .get(space_id) .unwrap() .location }