cosmic-comp/src/shell/workspace.rs

use crate::{
    backend::render::element::AsGlowRenderer,
    shell::layout::{
        floating::{FloatingLayout, MoveSurfaceGrab},
        tiling::TilingLayout,
    },
    state::State,
    utils::prelude::*,
    wayland::{
        handlers::screencopy::{DropableSession, WORKSPACE_OVERVIEW_NAMESPACE},
        protocols::{
            screencopy::{BufferParams, Session as ScreencopySession},
            toplevel_info::ToplevelInfoState,
            workspace::WorkspaceHandle,
        },
    },
    xwayland::XWaylandState,
};

use indexmap::IndexSet;
use smithay::{
    backend::renderer::{
        element::{surface::WaylandSurfaceRenderElement, AsRenderElements, Element, RenderElement},
        ImportAll, ImportMem, Renderer,
    },
    desktop::{layer_map_for_output, space::SpaceElement, LayerSurface},
    input::{pointer::GrabStartData as PointerGrabStartData, Seat},
    output::Output,
    reexports::wayland_server::protocol::wl_surface::WlSurface,
    utils::{Buffer as BufferCoords, IsAlive, Logical, Physical, Point, Rectangle, Scale, Size},
    wayland::{seat::WaylandFocus, shell::wlr_layer::Layer},
    xwayland::X11Surface,
};
use std::collections::HashMap;
use tracing::warn;

use super::{
    element::{window::CosmicWindowRenderElement, CosmicMapped},
    focus::{FocusStack, FocusStackMut},
    grabs::{ResizeEdge, ResizeGrab},
    CosmicMappedRenderElement, CosmicSurface,
};

#[derive(Debug)]
pub struct Workspace {
    pub tiling_layer: TilingLayout,
    pub floating_layer: FloatingLayout,
    pub tiling_enabled: bool,
    pub fullscreen: HashMap<Output, CosmicSurface>,
    pub handle: WorkspaceHandle,
    pub focus_stack: FocusStacks,
    pub pending_buffers: Vec<(ScreencopySession, BufferParams)>,
    pub screencopy_sessions: Vec<DropableSession>,
}

#[derive(Debug, Default)]
pub struct FocusStacks(HashMap<Seat<State>, IndexSet<CosmicMapped>>);

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ManagedState {
    Tiling,
    Floating,
}

impl Workspace {
    pub fn new(handle: WorkspaceHandle, tiling_enabled: bool, gaps: (u8, u8)) -> Workspace {
        Workspace {
            tiling_layer: TilingLayout::new(gaps),
            floating_layer: FloatingLayout::new(),
            tiling_enabled,
            fullscreen: HashMap::new(),
            handle,
            focus_stack: FocusStacks::default(),
            pending_buffers: Vec::new(),
            screencopy_sessions: Vec::new(),
        }
    }

    pub fn refresh(&mut self) {
        #[cfg(feature = "debug")]
        puffin::profile_function!();

        self.fullscreen.retain(|_, w| w.alive());
        self.floating_layer.refresh();
        self.tiling_layer.refresh();
    }

    pub fn commit(&mut self, surface: &WlSurface) {
        if let Some(mapped) = self.element_for_wl_surface(surface) {
            mapped
                .windows()
                .find(|(w, _)| w.wl_surface().as_ref() == Some(surface))
                .unwrap()
                .0
                .on_commit();
        }
    }

    pub fn map_output(&mut self, output: &Output, position: Point<i32, Logical>) {
        self.tiling_layer.map_output(output, position);
        self.floating_layer.map_output(output, position);
    }

    pub fn unmap_output(
        &mut self,
        output: &Output,
        toplevel_info: &mut ToplevelInfoState<State, CosmicSurface>,
    ) {
        if let Some(dead_output_window) = self.fullscreen.remove(output) {
            self.unfullscreen_request(&dead_output_window);
        }
        self.tiling_layer.unmap_output(output, toplevel_info);
        self.floating_layer.unmap_output(output, toplevel_info);
        self.refresh();
    }

    pub fn unmap(&mut self, mapped: &CosmicMapped) -> Option<ManagedState> {
        let was_floating = self.floating_layer.unmap(&mapped);
        let was_tiling = self.tiling_layer.unmap(&mapped).is_some();
        if was_floating || was_tiling {
            assert!(was_floating != was_tiling);
        }

        if mapped.is_maximized() || mapped.is_fullscreen() {
            self.unmaximize_request(&mapped.active_window());
        }

        self.focus_stack
            .0
            .values_mut()
            .for_each(|set| set.retain(|m| m != mapped));
        if was_floating {
            Some(ManagedState::Floating)
        } else if was_tiling {
            Some(ManagedState::Tiling)
        } else {
            None
        }
    }

    pub fn element_for_surface(&self, surface: &CosmicSurface) -> Option<&CosmicMapped> {
        self.floating_layer
            .mapped()
            .chain(self.tiling_layer.mapped().map(|(_, w, _)| w))
            .find(|e| e.windows().any(|(w, _)| &w == surface))
    }

    pub fn element_for_wl_surface(&self, surface: &WlSurface) -> Option<&CosmicMapped> {
        self.floating_layer
            .mapped()
            .chain(self.tiling_layer.mapped().map(|(_, w, _)| w))
            .find(|e| {
                e.windows()
                    .any(|(w, _)| w.wl_surface().as_ref() == Some(surface))
            })
    }

    pub fn outputs_for_element(&self, elem: &CosmicMapped) -> impl Iterator<Item = Output> {
        self.floating_layer
            .space
            .outputs_for_element(elem)
            .into_iter()
            .chain(self.tiling_layer.output_for_element(elem).cloned())
    }

    pub fn output_under(&self, point: Point<i32, Logical>) -> Option<&Output> {
        let space = &self.floating_layer.space;
        space.outputs().find(|o| {
            let internal_output_geo = space.output_geometry(o).unwrap();
            let external_output_geo = o.geometry();
            internal_output_geo.contains(point - external_output_geo.loc + internal_output_geo.loc)
        })
    }

    pub fn element_under(
        &self,
        location: Point<f64, Logical>,
    ) -> Option<(&CosmicMapped, Point<i32, Logical>)> {
        self.floating_layer
            .space
            .element_under(location)
            .or_else(|| {
                self.tiling_layer.mapped().find_map(|(_, mapped, loc)| {
                    let test_point = location - loc.to_f64() + mapped.geometry().loc.to_f64();
                    mapped
                        .is_in_input_region(&test_point)
                        .then_some((mapped, loc - mapped.geometry().loc))
                })
            })
    }

    pub fn element_geometry(&self, elem: &CosmicMapped) -> Option<Rectangle<i32, Logical>> {
        let space = &self.floating_layer.space;
        let outputs = space.outputs().collect::<Vec<_>>();
        let offset = if outputs.len() == 1
            && space.output_geometry(&outputs[0]).unwrap().loc == Point::from((0, 0))
        {
            outputs[0].geometry().loc
        } else {
            (0, 0).into()
        };

        self.floating_layer
            .space
            .element_geometry(elem)
            .or_else(|| self.tiling_layer.element_geometry(elem))
            .map(|mut geo| {
                geo.loc += offset;
                geo
            })
    }

    pub fn maximize_request(&mut self, window: &CosmicSurface, output: &Output) {
        if self.fullscreen.contains_key(output) {
            return;
        }

        self.floating_layer.maximize_request(window);

        window.set_fullscreen(false);
        window.set_maximized(true);
        self.set_fullscreen(window, output)
    }
    pub fn unmaximize_request(&mut self, window: &CosmicSurface) -> Option<Size<i32, Logical>> {
        if self.fullscreen.values().any(|w| w == window) {
            self.unfullscreen_request(window);
            self.floating_layer.unmaximize_request(window)
        } else {
            None
        }
    }

    pub fn fullscreen_request(&mut self, window: &CosmicSurface, output: &Output) {
        if self.fullscreen.contains_key(output) {
            return;
        }

        window.set_maximized(false);
        window.set_fullscreen(true);
        self.set_fullscreen(window, output)
    }

    pub(super) fn set_fullscreen<'a>(
        &mut self,
        window: impl Into<Option<&'a CosmicSurface>>,
        output: &Output,
    ) {
        match window.into() {
            Some(window) => {
                if let Some(mapped) = self
                    .mapped()
                    .find(|m| m.windows().any(|(w, _)| &w == window))
                {
                    mapped.set_active(window);
                }

                window.set_geometry(output.geometry());
                window.send_configure();
                self.fullscreen.insert(output.clone(), window.clone());
            }
            None => {
                if let Some(surface) = self.fullscreen.get(output).cloned() {
                    self.unfullscreen_request(&surface);
                }
            }
        }
    }

    pub fn unfullscreen_request(&mut self, window: &CosmicSurface) {
        if self.fullscreen.values().any(|w| w == window) {
            window.set_maximized(false);
            window.set_fullscreen(false);
            self.floating_layer.refresh();
            self.tiling_layer.refresh();
            window.send_configure();
            self.fullscreen.retain(|_, w| w != window);
        }
    }

    pub fn maximize_toggle(&mut self, window: &CosmicSurface, output: &Output) {
        if self.fullscreen.contains_key(output) {
            self.unmaximize_request(window);
        } else {
            self.maximize_request(window, output);
        }
    }

    pub fn get_fullscreen(&self, output: &Output) -> Option<&CosmicSurface> {
        self.fullscreen.get(output).filter(|w| w.alive())
    }

    pub fn resize_request(
        &mut self,
        mapped: &CosmicMapped,
        seat: &Seat<State>,
        start_data: PointerGrabStartData<State>,
        edges: ResizeEdge,
    ) -> Option<ResizeGrab> {
        if mapped.is_fullscreen() || mapped.is_maximized() {
            return None;
        }

        if self.floating_layer.mapped().any(|m| m == mapped) {
            self.floating_layer
                .resize_request(mapped, seat, start_data.clone(), edges)
                .map(Into::into)
        } else if self.tiling_layer.mapped().any(|(_, m, _)| m == mapped) {
            self.tiling_layer
                .resize_request(mapped, seat, start_data, edges)
                .map(Into::into)
        } else {
            None
        }
    }

    pub fn move_request(
        &mut self,
        window: &CosmicSurface,
        seat: &Seat<State>,
        output: &Output,
        start_data: PointerGrabStartData<State>,
        indicator_thickness: u8,
    ) -> Option<MoveSurfaceGrab> {
        let pointer = seat.get_pointer().unwrap();
        let pos = pointer.current_location();

        let mapped = self.element_for_surface(&window)?.clone();
        let mut initial_window_location = self.element_geometry(&mapped).unwrap().loc;

        if mapped.is_fullscreen() || mapped.is_maximized() {
            // If surface is maximized then unmaximize it
            let new_size = self.unmaximize_request(window);
            let ratio = pos.x / output.geometry().size.w as f64;

            initial_window_location = new_size
                .map(|size| (pos.x - (size.w as f64 * ratio), pos.y).into())
                .unwrap_or_else(|| pos)
                .to_i32_round();
        }

        let was_floating = self.floating_layer.unmap(&mapped);
        //let was_tiled = self.tiling_layer.unmap(&mapped);
        //assert!(was_floating != was_tiled);

        if was_floating {
            Some(MoveSurfaceGrab::new(
                start_data,
                mapped,
                seat,
                pos,
                initial_window_location,
                indicator_thickness,
            ))
        } else {
            None // TODO
        }
    }

    pub fn toggle_tiling(&mut self, seat: &Seat<State>) {
        if self.tiling_enabled {
            for window in self
                .tiling_layer
                .mapped()
                .map(|(_, m, _)| m.clone())
                .collect::<Vec<_>>()
                .into_iter()
            {
                self.tiling_layer.unmap(&window);
                self.floating_layer.map(window, seat, None);
            }
            self.tiling_enabled = false;
        } else {
            let focus_stack = self.focus_stack.get(seat);
            for window in self
                .floating_layer
                .mapped()
                .cloned()
                .collect::<Vec<_>>()
                .into_iter()
            {
                self.floating_layer.unmap(&window);
                self.tiling_layer.map(window, seat, focus_stack.iter())
            }
            self.tiling_enabled = true;
        }
    }

    pub fn toggle_floating_window(&mut self, seat: &Seat<State>) {
        if self.tiling_enabled {
            if let Some(window) = self.focus_stack.get(seat).iter().next().cloned() {
                if self.tiling_layer.mapped().any(|(_, m, _)| m == &window) {
                    self.tiling_layer.unmap(&window);
                    self.floating_layer.map(window, seat, None);
                } else if self.floating_layer.mapped().any(|w| w == &window) {
                    let focus_stack = self.focus_stack.get(seat);
                    self.floating_layer.unmap(&window);
                    self.tiling_layer.map(window, seat, focus_stack.iter())
                }
            }
        }
    }

    pub fn mapped(&self) -> impl Iterator<Item = &CosmicMapped> {
        self.floating_layer
            .mapped()
            .chain(self.tiling_layer.mapped().map(|(_, w, _)| w))
    }

    pub fn windows(&self) -> impl Iterator<Item = CosmicSurface> + '_ {
        self.floating_layer
            .windows()
            .chain(self.tiling_layer.windows().map(|(_, w, _)| w))
    }

    pub fn is_fullscreen(&self, mapped: &CosmicMapped) -> bool {
        self.fullscreen
            .values()
            .any(|s| s == &mapped.active_window())
    }

    pub fn is_floating(&self, mapped: &CosmicMapped) -> bool {
        !self
            .fullscreen
            .values()
            .any(|s| s == &mapped.active_window())
            && self.floating_layer.mapped().any(|m| m == mapped)
    }

    pub fn is_tiled(&self, mapped: &CosmicMapped) -> bool {
        !self
            .fullscreen
            .values()
            .any(|s| s == &mapped.active_window())
            && self.tiling_layer.mapped().any(|(_, m, _)| m == mapped)
    }

    pub fn render_output<'a, R>(
        &self,
        renderer: &mut R,
        output: &Output,
        override_redirect_windows: &[X11Surface],
        xwm_state: Option<&'a mut XWaylandState>,
        draw_focus_indicator: Option<&Seat<State>>,
        indicator_thickness: u8,
        exclude_workspace_overview: bool,
    ) -> Result<Vec<WorkspaceRenderElement<R>>, OutputNotMapped>
    where
        R: Renderer + ImportAll + ImportMem + AsGlowRenderer,
        <R as Renderer>::TextureId: 'static,
        CosmicMappedRenderElement<R>: RenderElement<R>,
        CosmicWindowRenderElement<R>: RenderElement<R>,
    {
        #[cfg(feature = "debug")]
        puffin::profile_function!();

        let mut render_elements = Vec::new();

        let output_scale = output.current_scale().fractional_scale();
        let layer_map = layer_map_for_output(output);

        if let Some(fullscreen) = self.fullscreen.get(output) {
            // overlay layer surfaces
            render_elements.extend(
                layer_map
                    .layers()
                    .rev()
                    .filter(|s| {
                        s.layer() == Layer::Overlay
                            && !(exclude_workspace_overview
                                && s.namespace() == WORKSPACE_OVERVIEW_NAMESPACE)
                    })
                    .filter_map(|surface| {
                        layer_map
                            .layer_geometry(surface)
                            .map(|geo| (geo.loc, surface))
                    })
                    .flat_map(|(loc, surface)| {
                        AsRenderElements::<R>::render_elements::<WorkspaceRenderElement<R>>(
                            surface,
                            renderer,
                            loc.to_physical_precise_round(output_scale),
                            Scale::from(output_scale),
                        )
                    }),
            );

            render_elements.extend(
                override_redirect_windows
                    .iter()
                    .filter(|or| or.geometry().intersection(output.geometry()).is_some())
                    .flat_map(|or| {
                        AsRenderElements::<R>::render_elements::<WorkspaceRenderElement<R>>(
                            or,
                            renderer,
                            (or.geometry().loc - output.geometry().loc)
                                .to_physical_precise_round(output_scale),
                            Scale::from(output_scale),
                        )
                    }),
            );

            // fullscreen window
            render_elements.extend(AsRenderElements::<R>::render_elements::<
                WorkspaceRenderElement<R>,
            >(
                fullscreen, renderer, (0, 0).into(), output_scale.into()
            ));

            if let Some(xwm) = xwm_state.and_then(|state| state.xwm.as_mut()) {
                if let Err(err) =
                    xwm.update_stacking_order_upwards(render_elements.iter().rev().map(|e| e.id()))
                {
                    warn!(
                        wm_id = ?xwm.id(),
                        ?err,
                        "Failed to update Xwm stacking order.",
                    );
                }
            }
        } else {
            // TODO: Handle modes like
            // - keyboard window swapping
            // - resizing / moving in tiling

            // overlay and top layer surfaces
            let lower = {
                let (lower, upper): (Vec<&LayerSurface>, Vec<&LayerSurface>) = layer_map
                    .layers()
                    .rev()
                    .filter(|s| {
                        !(exclude_workspace_overview
                            && s.namespace() == "cosmic-workspace-overview")
                    })
                    .partition(|s| matches!(s.layer(), Layer::Background | Layer::Bottom));

                render_elements.extend(
                    upper
                        .into_iter()
                        .filter_map(|surface| {
                            layer_map
                                .layer_geometry(surface)
                                .map(|geo| (geo.loc, surface))
                        })
                        .flat_map(|(loc, surface)| {
                            AsRenderElements::<R>::render_elements::<WorkspaceRenderElement<R>>(
                                surface,
                                renderer,
                                loc.to_physical_precise_round(output_scale),
                                Scale::from(output_scale),
                            )
                        }),
                );

                lower
            };

            // OR windows above all
            render_elements.extend(
                override_redirect_windows
                    .iter()
                    .filter(|or| or.geometry().intersection(output.geometry()).is_some())
                    .flat_map(|or| {
                        AsRenderElements::<R>::render_elements::<WorkspaceRenderElement<R>>(
                            or,
                            renderer,
                            (or.geometry().loc - output.geometry().loc)
                                .to_physical_precise_round(output_scale),
                            Scale::from(output_scale),
                        )
                    }),
            );

            let focused =
                draw_focus_indicator.and_then(|seat| self.focus_stack.get(seat).last().cloned());
            // floating surfaces
            render_elements.extend(
                self.floating_layer
                    .render_output::<R>(renderer, output, focused.as_ref(), indicator_thickness)
                    .into_iter()
                    .map(WorkspaceRenderElement::from),
            );

            //tiling surfaces
            render_elements.extend(
                self.tiling_layer
                    .render_output::<R>(renderer, output, focused.as_ref(), indicator_thickness)?
                    .into_iter()
                    .map(WorkspaceRenderElement::from),
            );

            if let Some(xwm) = xwm_state.and_then(|state| state.xwm.as_mut()) {
                if let Err(err) =
                    xwm.update_stacking_order_upwards(render_elements.iter().rev().map(|e| e.id()))
                {
                    warn!(
                        wm_id = ?xwm.id(),
                        ?err,
                        "Failed to update Xwm stacking order.",
                    );
                }
            }

            // bottom and background layer surfaces
            {
                render_elements.extend(
                    lower
                        .into_iter()
                        .filter_map(|surface| {
                            layer_map
                                .layer_geometry(surface)
                                .map(|geo| (geo.loc, surface))
                        })
                        .flat_map(|(loc, surface)| {
                            AsRenderElements::<R>::render_elements::<WorkspaceRenderElement<R>>(
                                surface,
                                renderer,
                                loc.to_physical_precise_round(output_scale),
                                Scale::from(output_scale),
                            )
                        }),
                );
            }
        }

        Ok(render_elements)
    }
}

impl FocusStacks {
    pub fn get<'a>(&'a self, seat: &Seat<State>) -> FocusStack<'a> {
        FocusStack(self.0.get(seat))
    }

    pub fn get_mut<'a>(&'a mut self, seat: &Seat<State>) -> FocusStackMut<'a> {
        FocusStackMut(self.0.entry(seat.clone()).or_default())
    }
}

pub struct OutputNotMapped;

pub enum WorkspaceRenderElement<R>
where
    R: Renderer + ImportAll + ImportMem + AsGlowRenderer,
    <R as Renderer>::TextureId: 'static,
{
    Wayland(WaylandSurfaceRenderElement<R>),
    Window(CosmicMappedRenderElement<R>),
}

impl<R> Element for WorkspaceRenderElement<R>
where
    R: Renderer + ImportAll + ImportMem + AsGlowRenderer,
    <R as Renderer>::TextureId: 'static,
{
    fn id(&self) -> &smithay::backend::renderer::element::Id {
        match self {
            WorkspaceRenderElement::Wayland(elem) => elem.id(),
            WorkspaceRenderElement::Window(elem) => elem.id(),
        }
    }

    fn current_commit(&self) -> smithay::backend::renderer::utils::CommitCounter {
        match self {
            WorkspaceRenderElement::Wayland(elem) => elem.current_commit(),
            WorkspaceRenderElement::Window(elem) => elem.current_commit(),
        }
    }

    fn src(&self) -> Rectangle<f64, smithay::utils::Buffer> {
        match self {
            WorkspaceRenderElement::Wayland(elem) => elem.src(),
            WorkspaceRenderElement::Window(elem) => elem.src(),
        }
    }

    fn geometry(&self, scale: Scale<f64>) -> Rectangle<i32, smithay::utils::Physical> {
        match self {
            WorkspaceRenderElement::Wayland(elem) => elem.geometry(scale),
            WorkspaceRenderElement::Window(elem) => elem.geometry(scale),
        }
    }

    fn location(&self, scale: Scale<f64>) -> Point<i32, smithay::utils::Physical> {
        match self {
            WorkspaceRenderElement::Wayland(elem) => elem.location(scale),
            WorkspaceRenderElement::Window(elem) => elem.location(scale),
        }
    }

    fn transform(&self) -> smithay::utils::Transform {
        match self {
            WorkspaceRenderElement::Wayland(elem) => elem.transform(),
            WorkspaceRenderElement::Window(elem) => elem.transform(),
        }
    }

    fn damage_since(
        &self,
        scale: Scale<f64>,
        commit: Option<smithay::backend::renderer::utils::CommitCounter>,
    ) -> Vec<Rectangle<i32, smithay::utils::Physical>> {
        match self {
            WorkspaceRenderElement::Wayland(elem) => elem.damage_since(scale, commit),
            WorkspaceRenderElement::Window(elem) => elem.damage_since(scale, commit),
        }
    }

    fn opaque_regions(&self, scale: Scale<f64>) -> Vec<Rectangle<i32, smithay::utils::Physical>> {
        match self {
            WorkspaceRenderElement::Wayland(elem) => elem.opaque_regions(scale),
            WorkspaceRenderElement::Window(elem) => elem.opaque_regions(scale),
        }
    }
}

impl<R> RenderElement<R> for WorkspaceRenderElement<R>
where
    R: Renderer + ImportAll + ImportMem + AsGlowRenderer,
    <R as Renderer>::TextureId: 'static,
    CosmicMappedRenderElement<R>: RenderElement<R>,
{
    fn draw<'frame>(
        &self,
        frame: &mut <R as Renderer>::Frame<'frame>,
        src: Rectangle<f64, BufferCoords>,
        dst: Rectangle<i32, Physical>,
        damage: &[Rectangle<i32, smithay::utils::Physical>],
    ) -> Result<(), <R as Renderer>::Error> {
        match self {
            WorkspaceRenderElement::Wayland(elem) => elem.draw(frame, src, dst, damage),
            WorkspaceRenderElement::Window(elem) => elem.draw(frame, src, dst, damage),
        }
    }

    fn underlying_storage(
        &self,
        renderer: &mut R,
    ) -> Option<smithay::backend::renderer::element::UnderlyingStorage> {
        match self {
            WorkspaceRenderElement::Wayland(elem) => elem.underlying_storage(renderer),
            WorkspaceRenderElement::Window(elem) => elem.underlying_storage(renderer),
        }
    }
}

impl<R> From<WaylandSurfaceRenderElement<R>> for WorkspaceRenderElement<R>
where
    R: Renderer + ImportAll + ImportMem + AsGlowRenderer,
    <R as Renderer>::TextureId: 'static,
    CosmicMappedRenderElement<R>: RenderElement<R>,
{
    fn from(elem: WaylandSurfaceRenderElement<R>) -> Self {
        WorkspaceRenderElement::Wayland(elem)
    }
}

impl<R> From<CosmicMappedRenderElement<R>> for WorkspaceRenderElement<R>
where
    R: Renderer + ImportAll + ImportMem + AsGlowRenderer,
    <R as Renderer>::TextureId: 'static,
    CosmicMappedRenderElement<R>: RenderElement<R>,
{
    fn from(elem: CosmicMappedRenderElement<R>) -> Self {
        WorkspaceRenderElement::Window(elem)
    }
}