monolith

//! Window organisation without smithay. Tags with per-output views, one

//! tiling tree per output filtered by those views, floating windows,

//! scratchpads, focus, and restoring windows when an output comes back.

mod outputs;

mod scratchpad;

mod tree;

#[cfg(test)]

mod tests;

pub use monolith_planner::Rect;

pub use tree::{Axis, Dir, Tree};

use outputs::Parked;

use slotmap::{SlotMap, new_key_type};

use std::collections::HashMap;

new_key_type! {

    pub struct WindowId;

    pub struct TagId;

    pub struct OutputId;

}

pub const HOMELESS: &str = "homeless";

#[derive(Clone, Copy, Debug, PartialEq, Eq)]

pub enum ExpandScope {

    Window,

    Container,

    All,

}

/// Space taken from an output's edges by bars and other panels.

#[derive(Clone, Copy, Debug, PartialEq, Default)]

pub struct Insets {

    pub top: f64,

    pub right: f64,

    pub bottom: f64,

    pub left: f64,

}

#[derive(Clone, Copy, Debug, PartialEq)]

pub struct Gaps {

    pub inner: f64,

    pub outer: f64,

}

impl Default for Gaps {

    fn default() -> Self {

        Self {

            inner: 8.0,

            outer: 8.0,

        }

    }

}

#[derive(Clone, Debug)]

pub struct Window {

    pub output: Option<OutputId>,

    pub tag: TagId,

    pub floating: bool,

    pub float_rect: Option<Rect>,

    /// `float_rect` is the layout's default, not a size the window or the

    /// user chose.

    pub float_default: bool,

    pub fullscreen: bool,

    /// The window this one is a dialog or other transient of.

    pub parent: Option<WindowId>,

    /// Focus aimed at the parent goes to this window while it is mapped.

    pub modal: bool,

    pub sticky: bool,

    pub scratchpad: Option<usize>,

    pub urgent: bool,

    /// Its client took the buffer away, as when hiding to a tray. The entry

    /// stays for when the client maps it again, but nothing shows or focuses it.

    pub hidden: bool,

    evicted_from: Option<String>,

}

#[derive(Clone, Debug)]

pub struct Tag {

    pub name: String,

    pub urgent: bool,

}

#[derive(Clone, Debug)]

pub struct Output {

    pub name: String,

    pub area: Rect,

    pub reserved: Insets,

    pub tree: Tree<WindowId>,

    /// Viewed tags besides the homeless tag, which is always viewed.

    pub viewed: Vec<TagId>,

    /// Floating windows, bottom to top.

    pub floating: Vec<WindowId>,

}

impl Output {

    /// The area left once bars and panels have taken their edges.

    pub fn usable(&self) -> Rect {

        let (a, r) = (self.area, self.reserved);

        Rect::new(

            a.x + r.left,

            a.y + r.top,

            (a.w - r.left - r.right).max(0.0),

            (a.h - r.top - r.bottom).max(0.0),

        )

    }

}

#[derive(Clone, Debug)]

pub struct Scratchpad {

    pub name: String,

    pub windows: Vec<WindowId>,

    pub shown: Option<usize>,

    pub output: Option<OutputId>,

}

#[derive(Clone, Debug, Default)]

pub struct Arrangement {

    /// Every tiled window on the output. Hidden ones are zero-size seeds.

    pub tiled: Vec<Placed>,

    /// Visible floating windows and shown scratchpads, bottom to top.

    pub floating: Vec<(WindowId, Rect)>,

    pub fullscreen: Option<WindowId>,

    /// Floating transients of the fullscreen window and shown scratchpads,

    /// which stay above it.

    pub over: Vec<WindowId>,

}

#[derive(Clone, Copy, Debug)]

pub struct Placed {

    pub window: WindowId,

    pub rect: Rect,

    pub visible: bool,

}

#[derive(Clone, Debug)]

pub struct Layout {

    windows: SlotMap<WindowId, Window>,

    tags: SlotMap<TagId, Tag>,

    tag_order: Vec<TagId>,

    homeless: TagId,

    outputs: SlotMap<OutputId, Output>,

    active: Option<OutputId>,

    /// Focus history, most recent last.

    history: Vec<WindowId>,

    /// How many windows are modal, so focus lookups skip the scan for one.

    modals: usize,

    scratchpads: Vec<Scratchpad>,

    last_scratchpad: Option<usize>,

    parked: HashMap<String, Parked>,

    pub gaps: Gaps,

    pub autotile: bool,

}

impl Default for Layout {

    fn default() -> Self {

        let mut tags = SlotMap::with_key();

        let homeless = tags.insert(Tag {

            name: HOMELESS.into(),

            urgent: false,

        });

        Self {

            windows: SlotMap::with_key(),

            tags,

            tag_order: vec![homeless],

            homeless,

            outputs: SlotMap::with_key(),

            active: None,

            history: Vec::new(),

            modals: 0,

            scratchpads: Vec::new(),

            last_scratchpad: None,

            parked: HashMap::new(),

            gaps: Gaps::default(),

            autotile: false,

        }

    }

}

impl Layout {

    pub fn homeless(&self) -> TagId {

        self.homeless

    }

    /// Looks a tag up by name, creating it at the end of the order.

    pub fn tag(&mut self, name: &str) -> TagId {

        if let Some(id) = self.tag_id(name) {

            return id;

        }

        let id = self.tags.insert(Tag {

            name: name.into(),

            urgent: false,

        });

        self.tag_order.push(id);

        id

    }

    pub fn tag_id(&self, name: &str) -> Option<TagId> {

        self.tag_order

            .iter()

            .copied()

            .find(|&t| self.tags[t].name == name)

    }

    pub fn tags(&self) -> impl Iterator<Item = (TagId, &Tag)> {

        self.tag_order.iter().map(|&t| (t, &self.tags[t]))

    }

    pub fn reorder_tag(&mut self, tag: TagId, index: usize) {

        if let Some(i) = self.tag_order.iter().position(|&t| t == tag) {

            self.tag_order.remove(i);

            let index = index.min(self.tag_order.len());

            self.tag_order.insert(index, tag);

        }

    }

    pub fn window(&self, w: WindowId) -> Option<&Window> {

        self.windows.get(w)

    }

    pub fn windows(&self) -> impl Iterator<Item = (WindowId, &Window)> {

        self.windows.iter()

    }

    pub fn output(&self, o: OutputId) -> Option<&Output> {

        self.outputs.get(o)

    }

    pub fn outputs(&self) -> impl Iterator<Item = (OutputId, &Output)> {

        self.outputs.iter()

    }

    pub fn scratchpads(&self) -> &[Scratchpad] {

        &self.scratchpads

    }

    pub fn active_output(&self) -> Option<OutputId> {

        self.active

    }

    pub fn set_active_output(&mut self, o: OutputId) {

        if self.outputs.contains_key(o) {

            self.active = Some(o);

        }

    }

    pub fn is_viewed(&self, o: OutputId, tag: TagId) -> bool {

        tag == self.homeless

            || self

                .outputs

                .get(o)

                .is_some_and(|out| out.viewed.contains(&tag))

    }

    /// Views `tag` alone, besides the homeless tag.

    pub fn view(&mut self, o: OutputId, tag: TagId) {

        let Some(out) = self.outputs.get_mut(o) else {

            return;

        };

        out.viewed.clear();

        if tag != self.homeless {

            out.viewed.push(tag);

        }

        self.tags[tag].urgent = false;

    }

    pub fn toggle_view(&mut self, o: OutputId, tag: TagId) {

        if tag == self.homeless {

            return;

        }

        let Some(out) = self.outputs.get_mut(o) else {

            return;

        };

        if let Some(i) = out.viewed.iter().position(|&t| t == tag) {

            out.viewed.remove(i);

        } else {

            out.viewed.push(tag);

            self.tags[tag].urgent = false;

        }

    }

    /// Brings `w`'s tag into view beside the others when `w` is the only

    /// window on it there.

    pub fn view_if_alone(&mut self, w: WindowId) {

        let Some(win) = self.windows.get(w) else {

            return;

        };

        let (Some(o), tag) = (win.output, win.tag) else {

            return;

        };

        if win.scratchpad.is_some() || self.is_viewed(o, tag) {

            return;

        }

        let alone = !self.windows.iter().any(|(x, v)| {

            x != w && v.output == Some(o) && v.tag == tag && v.scratchpad.is_none() && !v.hidden

        });

        if alone {

            self.toggle_view(o, tag);

        }

    }

    /// The tag a launch from `o` belongs to. The focused window's tag, else

    /// the first viewed tag, else homeless. Homeless is always on screen, so

    /// focusing one of its windows does not mean the user left their tag.

    pub fn launch_tag(&self, o: OutputId) -> TagId {

        self.focused_on(o)

            .map(|w| &self.windows[w])

            .filter(|w| w.scratchpad.is_none() && !w.sticky && w.tag != self.homeless)

            .map(|w| w.tag)

            .or_else(|| self.outputs.get(o)?.viewed.first().copied())

            .unwrap_or(self.homeless)

    }

    pub fn view_everywhere(&mut self, tag: TagId) {

        for o in self.outputs.keys().collect::<Vec<_>>() {

            self.view(o, tag);

        }

    }

    pub fn visible(&self, w: WindowId) -> bool {

        let Some(win) = self.windows.get(w) else {

            return false;

        };

        let Some(o) = win.output.filter(|_| !win.hidden) else {

            return false;

        };

        match win.scratchpad {

            Some(s) => {

                let sp = &self.scratchpads[s];

                sp.output == Some(o) && sp.shown.map(|i| sp.windows[i]) == Some(w)

            }

            None => win.sticky || self.is_viewed(o, win.tag),

        }

    }

    /// Adds a window on `output` (default the active one) and `tag` (default

    /// homeless). A window landing on a tag its output is not viewing marks

    /// the tag urgent.

    pub fn add_window(

        &mut self,

        output: Option<OutputId>,

        tag: Option<TagId>,

        floating: Option<Rect>,

    ) -> WindowId {

        let output = output

            .filter(|&o| self.outputs.contains_key(o))

            .or(self.active);

        let tag = tag

            .filter(|&t| self.tags.contains_key(t))

            .unwrap_or(self.homeless);

        let w = self.windows.insert(Window {

            output,

            tag,

            floating: floating.is_some(),

            float_rect: floating,

            float_default: false,

            fullscreen: false,

            parent: None,

            modal: false,

            sticky: false,

            scratchpad: None,

            urgent: false,

            hidden: false,

            evicted_from: None,

        });

        if let Some(o) = output {

            if !self.is_viewed(o, tag) {

                self.tags[tag].urgent = true;

            }

            self.place(w);

        }

        w

    }

    pub fn remove_window(&mut self, w: WindowId) {

        if !self.windows.contains_key(w) {

            return;

        }

        self.unplace(w);

        self.history.retain(|&h| h != w);

        self.modals -= usize::from(self.windows[w].modal);

        if let Some(s) = self.windows[w].scratchpad {

            self.leave_scratchpad(s, w);

        }

        for win in self.windows.values_mut() {

            if win.parent == Some(w) {

                win.parent = None;

            }

        }

        self.windows.remove(w);

    }

    /// Puts a window into its output's tree or floating stack. Tiled windows

    /// go next to the focused window if both are visible, else next to the

    /// latest window of their tag, else into a new row.

    fn place(&mut self, w: WindowId) {

        let win = &self.windows[w];

        let Some(o) = win.output else { return };

        if win.scratchpad.is_some() {

            return;

        }

        if win.floating {

            let usable = self.outputs[o].usable();

            let win = &mut self.windows[w];

            match win.float_rect {

                Some(rect) => win.float_rect = Some(clamp_float(rect, usable)),

                None => {

                    win.float_rect = Some(centred(usable, 0.6));

                    win.float_default = true;

                }

            }

            self.outputs[o].floating.push(w);

            return;

        }

        let tag = win.tag;

        let tree = &self.outputs[o].tree;

        let focused = self

            .focused()

            .filter(|&f| tree.contains(f) && self.is_viewed(o, tag));

        let anchor = focused.or_else(|| {

            self.history

                .iter()

                .rev()

                .copied()

                .find(|&h| tree.contains(h) && self.windows[h].tag == tag)

        });

        let split = anchor

            .filter(|_| self.autotile)

            .and_then(|a| self.split_axis(o, a));

        let tree = &mut self.outputs[o].tree;

        match (anchor, split) {

            (Some(a), Some(axis)) => tree.insert_split(w, a, axis),

            (Some(a), None) => tree.insert_after(w, a),

            (None, _) => tree.insert_row(w),

        }

    }

    /// The axis a window opening beside `anchor` should split it along, the

    /// way the anchor is laid out right now. Hidden anchors have no shape.

    fn split_axis(&self, o: OutputId, anchor: WindowId) -> Option<Axis> {

        let rect = self

            .arrange(o)

            .tiled

            .iter()

            .find(|p| p.window == anchor && p.visible)?

            .rect;

        let axis = if rect.w > rect.h {

            Axis::Horizontal

        } else {

            Axis::Vertical

        };

        (rect.w > 0.0 && rect.h > 0.0).then_some(axis)

    }

    fn unplace(&mut self, w: WindowId) {

        let Some(o) = self.windows[w].output else {

            return;

        };

        let out = &mut self.outputs[o];

        out.tree.remove(w);

        out.floating.retain(|&f| f != w);

    }

    /// Focuses `w`, or the deepest modal dialog over it, which is returned.

    /// The windows between stay below it in the history, and a modal dialog

    /// focused on its own brings its parent up beneath it, so closing the

    /// dialog hands focus back to its parent.

    pub fn focus(&mut self, mut w: WindowId) -> Option<WindowId> {

        loop {

            let win = self.windows.get(w)?;

            self.active = win.output.or(self.active);

            if let Some(o) = win.output {

                let stack = &mut self.outputs[o].floating;

                if let Some(i) = stack.iter().position(|&f| f == w) {

                    stack.remove(i);