atagen

monolith

public
Star0
Watch0
3215aa6779fcb44b5b0bf6c5dc22cea57659a079
1
ssh://brewery@pls.lobotomise.me:33/atagen/monolith.git
crates/layout/src/lib.rsRust1146 lines36.0 KB
1
//! Window organisation without smithay. Tags with per-output views, one
2
//! tiling tree per output filtered by those views, floating windows,
3
//! scratchpads, focus, and restoring windows when an output comes back.
4
5
mod outputs;
6
mod scratchpad;
7
mod tree;
8
9
#[cfg(test)]
10
mod tests;
11
12
pub use monolith_planner::Rect;
13
pub use tree::{Axis, Dir, Tree};
14
15
use outputs::Parked;
16
use slotmap::{SlotMap, new_key_type};
17
use std::collections::HashMap;
18
19
new_key_type! {
20
    pub struct WindowId;
21
    pub struct TagId;
22
    pub struct OutputId;
23
}
24
25
pub const HOMELESS: &str = "homeless";
26
27
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
28
pub enum ExpandScope {
29
    Window,
30
    Container,
31
    All,
32
}
33
34
/// Space taken from an output's edges by bars and other panels.
35
#[derive(Clone, Copy, Debug, PartialEq, Default)]
36
pub struct Insets {
37
    pub top: f64,
38
    pub right: f64,
39
    pub bottom: f64,
40
    pub left: f64,
41
}
42
43
#[derive(Clone, Copy, Debug, PartialEq)]
44
pub struct Gaps {
45
    pub inner: f64,
46
    pub outer: f64,
47
}
48
49
impl Default for Gaps {
50
    fn default() -> Self {
51
        Self {
52
            inner: 8.0,
53
            outer: 8.0,
54
        }
55
    }
56
}
57
58
#[derive(Clone, Debug)]
59
pub struct Window {
60
    pub output: Option<OutputId>,
61
    pub tag: TagId,
62
    pub floating: bool,
63
    pub float_rect: Option<Rect>,
64
    /// `float_rect` is the layout's default, not a size the window or the
65
    /// user chose.
66
    pub float_default: bool,
67
    pub fullscreen: bool,
68
    /// The window this one is a dialog or other transient of.
69
    pub parent: Option<WindowId>,
70
    /// Focus aimed at the parent goes to this window while it is mapped.
71
    pub modal: bool,
72
    pub sticky: bool,
73
    pub scratchpad: Option<usize>,
74
    pub urgent: bool,
75
    /// Its client took the buffer away, as when hiding to a tray. The entry
76
    /// stays for when the client maps it again, but nothing shows or focuses it.
77
    pub hidden: bool,
78
    evicted_from: Option<String>,
79
}
80
81
#[derive(Clone, Debug)]
82
pub struct Tag {
83
    pub name: String,
84
    pub urgent: bool,
85
}
86
87
#[derive(Clone, Debug)]
88
pub struct Output {
89
    pub name: String,
90
    pub area: Rect,
91
    pub reserved: Insets,
92
    pub tree: Tree<WindowId>,
93
    /// Viewed tags besides the homeless tag, which is always viewed.
94
    pub viewed: Vec<TagId>,
95
    /// Floating windows, bottom to top.
96
    pub floating: Vec<WindowId>,
97
}
98
99
impl Output {
100
    /// The area left once bars and panels have taken their edges.
101
    pub fn usable(&self) -> Rect {
102
        let (a, r) = (self.area, self.reserved);
103
        Rect::new(
104
            a.x + r.left,
105
            a.y + r.top,
106
            (a.w - r.left - r.right).max(0.0),
107
            (a.h - r.top - r.bottom).max(0.0),
108
        )
109
    }
110
}
111
112
#[derive(Clone, Debug)]
113
pub struct Scratchpad {
114
    pub name: String,
115
    pub windows: Vec<WindowId>,
116
    pub shown: Option<usize>,
117
    pub output: Option<OutputId>,
118
}
119
120
#[derive(Clone, Debug, Default)]
121
pub struct Arrangement {
122
    /// Every tiled window on the output. Hidden ones are zero-size seeds.
123
    pub tiled: Vec<Placed>,
124
    /// Visible floating windows and shown scratchpads, bottom to top.
125
    pub floating: Vec<(WindowId, Rect)>,
126
    pub fullscreen: Option<WindowId>,
127
    /// Floating transients of the fullscreen window and shown scratchpads,
128
    /// which stay above it.
129
    pub over: Vec<WindowId>,
130
}
131
132
#[derive(Clone, Copy, Debug)]
133
pub struct Placed {
134
    pub window: WindowId,
135
    pub rect: Rect,
136
    pub visible: bool,
137
}
138
139
#[derive(Clone, Debug)]
140
pub struct Layout {
141
    windows: SlotMap<WindowId, Window>,
142
    tags: SlotMap<TagId, Tag>,
143
    tag_order: Vec<TagId>,
144
    homeless: TagId,
145
    outputs: SlotMap<OutputId, Output>,
146
    active: Option<OutputId>,
147
    /// Focus history, most recent last.
148
    history: Vec<WindowId>,
149
    /// How many windows are modal, so focus lookups skip the scan for one.
150
    modals: usize,
151
    scratchpads: Vec<Scratchpad>,
152
    last_scratchpad: Option<usize>,
153
    parked: HashMap<String, Parked>,
154
    pub gaps: Gaps,
155
    pub autotile: bool,
156
}
157
158
impl Default for Layout {
159
    fn default() -> Self {
160
        let mut tags = SlotMap::with_key();
161
        let homeless = tags.insert(Tag {
162
            name: HOMELESS.into(),
163
            urgent: false,
164
        });
165
        Self {
166
            windows: SlotMap::with_key(),
167
            tags,
168
            tag_order: vec![homeless],
169
            homeless,
170
            outputs: SlotMap::with_key(),
171
            active: None,
172
            history: Vec::new(),
173
            modals: 0,
174
            scratchpads: Vec::new(),
175
            last_scratchpad: None,
176
            parked: HashMap::new(),
177
            gaps: Gaps::default(),
178
            autotile: false,
179
        }
180
    }
181
}
182
183
impl Layout {
184
    pub fn homeless(&self) -> TagId {
185
        self.homeless
186
    }
187
188
    /// Looks a tag up by name, creating it at the end of the order.
189
    pub fn tag(&mut self, name: &str) -> TagId {
190
        if let Some(id) = self.tag_id(name) {
191
            return id;
192
        }
193
        let id = self.tags.insert(Tag {
194
            name: name.into(),
195
            urgent: false,
196
        });
197
        self.tag_order.push(id);
198
        id
199
    }
200
201
    pub fn tag_id(&self, name: &str) -> Option<TagId> {
202
        self.tag_order
203
            .iter()
204
            .copied()
205
            .find(|&t| self.tags[t].name == name)
206
    }
207
208
    pub fn tags(&self) -> impl Iterator<Item = (TagId, &Tag)> {
209
        self.tag_order.iter().map(|&t| (t, &self.tags[t]))
210
    }
211
212
    pub fn reorder_tag(&mut self, tag: TagId, index: usize) {
213
        if let Some(i) = self.tag_order.iter().position(|&t| t == tag) {
214
            self.tag_order.remove(i);
215
            let index = index.min(self.tag_order.len());
216
            self.tag_order.insert(index, tag);
217
        }
218
    }
219
220
    pub fn window(&self, w: WindowId) -> Option<&Window> {
221
        self.windows.get(w)
222
    }
223
224
    pub fn windows(&self) -> impl Iterator<Item = (WindowId, &Window)> {
225
        self.windows.iter()
226
    }
227
228
    pub fn output(&self, o: OutputId) -> Option<&Output> {
229
        self.outputs.get(o)
230
    }
231
232
    pub fn outputs(&self) -> impl Iterator<Item = (OutputId, &Output)> {
233
        self.outputs.iter()
234
    }
235
236
    pub fn scratchpads(&self) -> &[Scratchpad] {
237
        &self.scratchpads
238
    }
239
240
    pub fn active_output(&self) -> Option<OutputId> {
241
        self.active
242
    }
243
244
    pub fn set_active_output(&mut self, o: OutputId) {
245
        if self.outputs.contains_key(o) {
246
            self.active = Some(o);
247
        }
248
    }
249
250
    pub fn is_viewed(&self, o: OutputId, tag: TagId) -> bool {
251
        tag == self.homeless
252
            || self
253
                .outputs
254
                .get(o)
255
                .is_some_and(|out| out.viewed.contains(&tag))
256
    }
257
258
    /// Views `tag` alone, besides the homeless tag.
259
    pub fn view(&mut self, o: OutputId, tag: TagId) {
260
        let Some(out) = self.outputs.get_mut(o) else {
261
            return;
262
        };
263
        out.viewed.clear();
264
        if tag != self.homeless {
265
            out.viewed.push(tag);
266
        }
267
        self.tags[tag].urgent = false;
268
    }
269
270
    pub fn toggle_view(&mut self, o: OutputId, tag: TagId) {
271
        if tag == self.homeless {
272
            return;
273
        }
274
        let Some(out) = self.outputs.get_mut(o) else {
275
            return;
276
        };
277
        if let Some(i) = out.viewed.iter().position(|&t| t == tag) {
278
            out.viewed.remove(i);
279
        } else {
280
            out.viewed.push(tag);
281
            self.tags[tag].urgent = false;
282
        }
283
    }
284
285
    /// Brings `w`'s tag into view beside the others when `w` is the only
286
    /// window on it there.
287
    pub fn view_if_alone(&mut self, w: WindowId) {
288
        let Some(win) = self.windows.get(w) else {
289
            return;
290
        };
291
        let (Some(o), tag) = (win.output, win.tag) else {
292
            return;
293
        };
294
        if win.scratchpad.is_some() || self.is_viewed(o, tag) {
295
            return;
296
        }
297
        let alone = !self.windows.iter().any(|(x, v)| {
298
            x != w && v.output == Some(o) && v.tag == tag && v.scratchpad.is_none() && !v.hidden
299
        });
300
        if alone {
301
            self.toggle_view(o, tag);
302
        }
303
    }
304
305
    /// The tag a launch from `o` belongs to, the focused window's tag or else
306
    /// homeless.
307
    pub fn launch_tag(&self, o: OutputId) -> TagId {
308
        self.focused_on(o)
309
            .map(|w| &self.windows[w])
310
            .filter(|w| w.scratchpad.is_none() && !w.sticky)
311
            .map_or(self.homeless, |w| w.tag)
312
    }
313
314
    pub fn view_everywhere(&mut self, tag: TagId) {
315
        for o in self.outputs.keys().collect::<Vec<_>>() {
316
            self.view(o, tag);
317
        }
318
    }
319
320
    pub fn visible(&self, w: WindowId) -> bool {
321
        let Some(win) = self.windows.get(w) else {
322
            return false;
323
        };
324
        let Some(o) = win.output.filter(|_| !win.hidden) else {
325
            return false;
326
        };
327
        match win.scratchpad {
328
            Some(s) => {
329
                let sp = &self.scratchpads[s];
330
                sp.output == Some(o) && sp.shown.map(|i| sp.windows[i]) == Some(w)
331
            }
332
            None => win.sticky || self.is_viewed(o, win.tag),
333
        }
334
    }
335
336
    /// Adds a window on `output` (default the active one) and `tag` (default
337
    /// homeless). A window landing on a tag its output is not viewing marks
338
    /// the tag urgent.
339
    pub fn add_window(
340
        &mut self,
341
        output: Option<OutputId>,
342
        tag: Option<TagId>,
343
        floating: Option<Rect>,
344
    ) -> WindowId {
345
        let output = output
346
            .filter(|&o| self.outputs.contains_key(o))
347
            .or(self.active);
348
        let tag = tag
349
            .filter(|&t| self.tags.contains_key(t))
350
            .unwrap_or(self.homeless);
351
        let w = self.windows.insert(Window {
352
            output,
353
            tag,
354
            floating: floating.is_some(),
355
            float_rect: floating,
356
            float_default: false,
357
            fullscreen: false,
358
            parent: None,
359
            modal: false,
360
            sticky: false,
361
            scratchpad: None,
362
            urgent: false,
363
            hidden: false,
364
            evicted_from: None,
365
        });
366
        if let Some(o) = output {
367
            if !self.is_viewed(o, tag) {
368
                self.tags[tag].urgent = true;
369
            }
370
            self.place(w);
371
        }
372
        w
373
    }
374
375
    pub fn remove_window(&mut self, w: WindowId) {
376
        if !self.windows.contains_key(w) {
377
            return;
378
        }
379
        self.unplace(w);
380
        self.history.retain(|&h| h != w);
381
        self.modals -= usize::from(self.windows[w].modal);
382
        if let Some(s) = self.windows[w].scratchpad {
383
            self.leave_scratchpad(s, w);
384
        }
385
        for win in self.windows.values_mut() {
386
            if win.parent == Some(w) {
387
                win.parent = None;
388
            }
389
        }
390
        self.windows.remove(w);
391
    }
392
393
    /// Puts a window into its output's tree or floating stack. Tiled windows
394
    /// go next to the focused window if both are visible, else next to the
395
    /// latest window of their tag, else into a new row.
396
    fn place(&mut self, w: WindowId) {
397
        let win = &self.windows[w];
398
        let Some(o) = win.output else { return };
399
        if win.scratchpad.is_some() {
400
            return;
401
        }
402
        if win.floating {
403
            let usable = self.outputs[o].usable();
404
            let win = &mut self.windows[w];
405
            match win.float_rect {
406
                Some(rect) => win.float_rect = Some(clamp_float(rect, usable)),
407
                None => {
408
                    win.float_rect = Some(centred(usable, 0.6));
409
                    win.float_default = true;
410
                }
411
            }
412
            self.outputs[o].floating.push(w);
413
            return;
414
        }
415
        let tag = win.tag;
416
        let tree = &self.outputs[o].tree;
417
        let focused = self
418
            .focused()
419
            .filter(|&f| tree.contains(f) && self.is_viewed(o, tag));
420
        let anchor = focused.or_else(|| {
421
            self.history
422
                .iter()
423
                .rev()
424
                .copied()
425
                .find(|&h| tree.contains(h) && self.windows[h].tag == tag)
426
        });
427
        let split = anchor
428
            .filter(|_| self.autotile)
429
            .and_then(|a| self.split_axis(o, a));
430
        let tree = &mut self.outputs[o].tree;
431
        match (anchor, split) {
432
            (Some(a), Some(axis)) => tree.insert_split(w, a, axis),
433
            (Some(a), None) => tree.insert_after(w, a),
434
            (None, _) => tree.insert_row(w),
435
        }
436
    }
437
438
    /// The axis a window opening beside `anchor` should split it along, the
439
    /// way the anchor is laid out right now. Hidden anchors have no shape.
440
    fn split_axis(&self, o: OutputId, anchor: WindowId) -> Option<Axis> {
441
        let rect = self
442
            .arrange(o)
443
            .tiled
444
            .iter()
445
            .find(|p| p.window == anchor && p.visible)?
446
            .rect;
447
        let axis = if rect.w > rect.h {
448
            Axis::Horizontal
449
        } else {
450
            Axis::Vertical
451
        };
452
        (rect.w > 0.0 && rect.h > 0.0).then_some(axis)
453
    }
454
455
    fn unplace(&mut self, w: WindowId) {
456
        let Some(o) = self.windows[w].output else {
457
            return;
458
        };
459
        let out = &mut self.outputs[o];
460
        out.tree.remove(w);
461
        out.floating.retain(|&f| f != w);
462
    }
463
464
    /// Focuses `w`, or the deepest modal dialog over it, which is returned.
465
    /// The windows between stay below it in the history, and a modal dialog
466
    /// focused on its own brings its parent up beneath it, so closing the
467
    /// dialog hands focus back to its parent.
468
    pub fn focus(&mut self, mut w: WindowId) -> Option<WindowId> {
469
        if self.eclipsed(w) {
470
            return None;
471
        }
472
        loop {
473
            let win = self.windows.get(w)?;
474
            self.active = win.output.or(self.active);
475
            if let Some(o) = win.output {
476
                let stack = &mut self.outputs[o].floating;
477
                if let Some(i) = stack.iter().position(|&f| f == w) {
478
                    stack.remove(i);
479
                    stack.push(w);
480
                }
481
            }
482
            let parent = win.parent.filter(|_| win.modal);
483
            self.history.retain(|&h| h != w);
484
            self.history.push(w);
485
            if let Some(p) = parent {
486
                self.history.retain(|&h| h != p);
487
                self.history.insert(self.history.len() - 1, p);
488
            }
489
            self.windows[w].urgent = false;
490
            match self.modal_child(w) {
491
                Some(child) => w = child,
492
                None => return Some(w),
493
            }
494
        }
495
    }
496
497
    /// Marks `w` as a modal dialog of its parent, or not.
498
    pub fn set_modal(&mut self, w: WindowId, modal: bool) {
499
        if let Some(win) = self.windows.get_mut(w)
500
            && std::mem::replace(&mut win.modal, modal) != modal
501
        {
502
            self.modals = if modal {
503
                self.modals + 1
504
            } else {
505
                self.modals - 1
506
            };
507
        }
508
    }
509
510
    /// The visible modal dialog of `w` on its output, the most recently
511
    /// focused if it has several.
512
    pub fn modal_child(&self, w: WindowId) -> Option<WindowId> {
513
        if self.modals == 0 {
514
            return None;
515
        }
516
        let output = self.windows.get(w)?.output;
517
        self.windows
518
            .iter()
519
            .filter(|&(c, win)| {
520
                win.modal && win.parent == Some(w) && win.output == output && self.visible(c)
521
            })
522
            .max_by_key(|&(c, _)| self.history.iter().rposition(|&h| h == c))
523
            .map(|(c, _)| c)
524
    }
525
526
    /// The window that takes focus aimed at `w`, the deepest modal dialog
527
    /// over it or `w` itself.
528
    pub fn modal_leaf(&self, mut w: WindowId) -> WindowId {
529
        while let Some(child) = self.modal_child(w) {
530
            w = child;
531
        }
532
        w
533
    }
534
535
    /// Whether focus aimed at `w` would change nothing.
536
    pub fn is_focused(&self, w: WindowId) -> bool {
537
        self.focused() == Some(self.modal_leaf(w))
538
    }
539
540
    /// The most recently focused visible window on the active output. Focus
541
    /// falling back to another output would leave keybinds acting on one
542
    /// output while the keyboard and pointer sit on another.
543
    pub fn focused(&self) -> Option<WindowId> {
544
        self.focused_on(self.active?)
545
    }
546
547
    /// The most recently focused visible window on `o`.
548
    pub fn focused_on(&self, o: OutputId) -> Option<WindowId> {
549
        self.history
550
            .iter()
551
            .rev()
552
            .copied()
553
            .find(|&w| self.windows[w].output == Some(o) && self.visible(w) && !self.eclipsed(w))
554
            .map(|w| self.modal_leaf(w))
555
    }
556
557
    /// Focuses the nearest visible window in `dir`, crossing to the next
558
    /// output when there is none on this one.
559
    pub fn focus_dir(&mut self, dir: Dir) -> Option<WindowId> {
560
        let o = self.active?;
561
        let current = self.focused_on(o);
562
        let from = current.and_then(|f| self.rect_of(f));
563
        let target = from.and_then(|from| {
564
            let arr = self.arrange(o);
565
            let reachable = |w| {
566
                arr.fullscreen
567
                    .is_none_or(|f| w == f || arr.over.contains(&w))
568
            };
569
            let candidates = arr
570
                .tiled
571
                .iter()
572
                .filter(|p| p.visible && !self.eclipsed(p.window))
573
                .map(|p| (p.window, p.rect))
574
                .chain(arr.floating.iter().copied())
575
                .filter(|&(w, _)| Some(self.modal_leaf(w)) != current && reachable(w));
576
            nearest(from, dir, candidates)
577
        });
578
        if let Some(w) = target {
579
            return self.focus(w);
580
        }
581
        let next = self.output_towards(o, dir)?;
582
        self.active = Some(next);
583
        let w = self.focused_on(next);
584
        if let Some(w) = w {
585
            self.focus(w);
586
        }
587
        w
588
    }
589
590
    pub fn output_towards(&self, from: OutputId, dir: Dir) -> Option<OutputId> {
591
        let here = self.outputs.get(from)?.area;
592
        let others = self
593
            .outputs
594
            .iter()
595
            .filter(|&(id, _)| id != from)
596
            .map(|(id, out)| (id, out.area));
597
        nearest(here, dir, others)
598
    }
599
600
    fn rect_of(&self, w: WindowId) -> Option<Rect> {
601
        let o = self.windows.get(w)?.output?;
602
        let arr = self.arrange(o);
603
        arr.tiled
604
            .iter()
605
            .find(|p| p.window == w)
606
            .map(|p| p.rect)
607
            .or_else(|| arr.floating.iter().find(|f| f.0 == w).map(|f| f.1))
608
    }
609
610
    fn vis_on(&self, o: OutputId) -> impl Fn(WindowId) -> bool + '_ {
611
        move |w| self.windows[w].output == Some(o) && self.visible(w)
612
    }
613
614
    fn focused_tiled(&self) -> Option<(WindowId, OutputId)> {
615
        let w = self.focused()?;
616
        let o = self.windows[w].output?;
617
        self.outputs[o].tree.contains(w).then_some((w, o))
618
    }
619
620
    pub fn move_window(&mut self, dir: Dir) -> bool {
621
        let Some((w, o)) = self.focused_tiled() else {
622
            return false;
623
        };
624
        let mut tree = std::mem::take(&mut self.outputs[o].tree);
625
        let moved = tree.move_window(w, dir, self.vis_on(o));
626
        self.outputs[o].tree = tree;
627
        moved
628
    }
629
630
    pub fn move_container(&mut self, dir: Dir, merge: bool) -> bool {
631
        let Some((w, o)) = self.focused_tiled() else {
632
            return false;
633
        };
634
        let mut tree = std::mem::take(&mut self.outputs[o].tree);
635
        let moved = tree.move_container(w, dir, merge, self.vis_on(o));
636
        self.outputs[o].tree = tree;
637
        moved
638
    }
639
640
    pub fn merge_window(&mut self, dir: Dir) -> bool {
641
        let Some((w, o)) = self.focused_tiled() else {
642
            return false;
643
        };
644
        let mut tree = std::mem::take(&mut self.outputs[o].tree);
645
        let merged = tree.merge_window(w, dir, self.vis_on(o));
646
        self.outputs[o].tree = tree;
647
        merged
648
    }
649
650
    /// Whether a tiled window is extended over others sharing its container.
651
    pub fn grouped(&self, w: WindowId) -> bool {
652
        let Some(o) = self.windows.get(w).and_then(|w| w.output) else {
653
            return false;
654
        };
655
        self.outputs[o].tree.grouped(w, self.vis_on(o))
656
    }
657
658
    /// Whether another window is extended over the tiled window `w`, which
659
    /// leaves it no room and takes it out of reach of focus.
660
    pub fn eclipsed(&self, w: WindowId) -> bool {
661
        let Some(o) = self
662
            .windows
663
            .get(w)
664
            .filter(|w| !w.fullscreen)
665
            .and_then(|w| w.output)
666
        else {
667
            return false;
668
        };
669
        self.outputs[o].tree.eclipsed(w, self.vis_on(o))
670
    }
671
672
    /// Whether a tiled window fills its output through expansion.
673
    pub fn maximized(&self, w: WindowId) -> bool {
674
        let Some(o) = self.windows.get(w).and_then(|w| w.output) else {
675
            return false;
676
        };
677
        self.outputs[o].tree.maximized(w, self.vis_on(o))
678
    }
679
680
    pub fn resize(&mut self, axis: Axis, delta: f64) -> bool {
681
        let Some((w, o)) = self.focused_tiled() else {
682
            return false;
683
        };
684
        let mut tree = std::mem::take(&mut self.outputs[o].tree);
685
        let done = tree.resize(w, axis, delta, self.vis_on(o));
686
        self.outputs[o].tree = tree;
687
        done
688
    }
689
690
    /// Whether `w` is tiled with a visible window across the split on side `dir`.
691
    pub fn has_split(&self, w: WindowId, dir: Dir) -> bool {
692
        let Some(o) = self.windows.get(w).and_then(|w| w.output) else {
693
            return false;
694
        };
695
        self.outputs[o].tree.has_split(w, dir, self.vis_on(o))
696
    }
697
698
    /// Moves the split on side `dir` of the tiled window `w` by `px`, positive
699
    /// toward the right or bottom.
700
    pub fn move_split(&mut self, w: WindowId, dir: Dir, px: f64) -> bool {
701
        let Some(o) = self.windows.get(w).and_then(|w| w.output) else {
702
            return false;
703
        };
704
        let area = inset(self.outputs[o].usable(), self.gaps.outer);
705
        let mut tree = std::mem::take(&mut self.outputs[o].tree);
706
        let moved = tree.move_split(w, dir, px, area, self.gaps.inner, self.vis_on(o));
707
        self.outputs[o].tree = tree;
708
        moved
709
    }
710
711
    pub fn expand(&mut self, scope: ExpandScope) -> bool {
712
        let Some((w, o)) = self.focused_tiled() else {
713
            return false;
714
        };
715
        let (skip, count) = match scope {
716
            ExpandScope::Window => (0, 1),
717
            ExpandScope::Container => (1, 1),
718
            ExpandScope::All => (0, usize::MAX),
719
        };
720
        let mut tree = std::mem::take(&mut self.outputs[o].tree);
721
        let expanded = tree.toggle_expand(w, skip, count, self.vis_on(o));
722
        self.outputs[o].tree = tree;
723
        expanded
724
    }
725
726
    pub fn flip(&mut self, o: OutputId) {
727
        if let Some(out) = self.outputs.get_mut(o) {
728
            out.tree.flip();
729
        }
730
    }
731
732
    /// Retags a window along with the windows it is extended over. They keep
733
    /// their slots and disappear if the new tag is not viewed.
734
    pub fn set_tag(&mut self, w: WindowId, tag: TagId) {
735
        let Some(win) = self.windows.get(w) else {
736
            return;
737
        };
738
        if !self.tags.contains_key(tag) {
739
            return;
740
        }
741
        let group = match win.output {
742
            Some(o) => self.outputs[o].tree.group_windows(w, self.vis_on(o)),
743
            None => vec![w],
744
        };
745
        for g in group {
746
            self.windows[g].tag = tag;
747
        }
748
    }
749
750
    /// Moves a window to `tag` on `o`, marking the tag urgent when the window
751
    /// ends up out of sight.
752
    pub fn relocate(&mut self, w: WindowId, o: Option<OutputId>, tag: TagId) {
753
        if let Some(o) = o {
754
            self.send_to_output(w, o);
755
        }
756
        self.set_tag(w, tag);
757
        self.mark_urgent(w);
758
    }
759
760
    /// Flags a window that wants attention unless it already has the focus,
761
    /// and its tag too when the window is out of sight.
762
    pub fn mark_urgent(&mut self, w: WindowId) {
763
        if self.windows.get(w).is_none_or(|win| win.hidden) {
764
            return;
765
        }
766
        if self.focused() != Some(w) {
767
            self.windows[w].urgent = true;
768
        }
769
        if !self.visible(w) {
770
            let tag = self.windows[w].tag;
771
            self.tags[tag].urgent = true;
772
        }
773
    }
774
775
    /// Drops the flag of the window holding the focus, which can reach it
776
    /// without `focus`, when the window before it closes or its tag is viewed.
777
    pub fn clear_focused_urgent(&mut self) {
778
        if let Some(w) = self.focused() {
779
            self.windows[w].urgent = false;
780
        }
781
    }
782
783
    pub fn send_to_output(&mut self, w: WindowId, o: OutputId) {
784
        let Some(win) = self.windows.get(w) else {
785
            return;
786
        };
787
        if !self.outputs.contains_key(o) || win.output == Some(o) || win.scratchpad.is_some() {
788
            return;
789
        }
790
        let from = win.output.map(|f| self.outputs[f].usable());
791
        self.unplace(w);
792
        let win = &mut self.windows[w];
793
        if let (Some(from), Some(rect)) = (from, win.float_rect) {
794
            win.float_rect = Some(translate(rect, from, self.outputs[o].usable()));
795
        }
796
        win.output = Some(o);
797
        win.evicted_from = None;
798
        self.place(w);
799
    }
800
801
    /// Switches a window between tiled and floating. A scratchpad window
802
    /// leaves its scratchpad and tiles on the tag being viewed, since its own
803
    /// tag may well be hidden.
804
    pub fn toggle_floating(&mut self, w: WindowId) {
805
        let Some(win) = self.windows.get(w) else {
806
            return;
807
        };
808
        if let Some(s) = win.scratchpad {
809
            let o = win.output.or(self.active);
810
            let tag = o
811
                .and_then(|o| self.outputs.get(o)?.viewed.first().copied())
812
                .unwrap_or(self.homeless);
813
            self.leave_scratchpad(s, w);
814
            let win = &mut self.windows[w];
815
            win.output = o;
816
            win.tag = tag;
817
            win.floating = false;
818
            self.place(w);
819
            return;
820
        }
821
        self.unplace(w);
822
        let win = &mut self.windows[w];
823
        win.floating = !win.floating;
824
        self.place(w);
825
    }
826
827
    pub fn set_float_rect(&mut self, w: WindowId, rect: Rect) {
828
        if let Some(win) = self.windows.get_mut(w) {
829
            win.float_rect = Some(rect);
830
            win.float_default = false;
831
        }
832
    }
833
834
    /// Places a float without settling its size, so a window still deciding
835
    /// on one is asked again after being tiled.
836
    pub fn hold_float_rect(&mut self, w: WindowId, rect: Rect) {
837
        if let Some(win) = self.windows.get_mut(w) {
838
            win.float_rect = Some(rect);
839
        }
840
    }
841
842
    pub fn toggle_fullscreen(&mut self, w: WindowId) {
843
        if let Some(win) = self.windows.get_mut(w) {
844
            win.fullscreen = !win.fullscreen;
845
        }
846
    }
847
848
    pub fn toggle_sticky(&mut self, w: WindowId) {
849
        if let Some(win) = self.windows.get_mut(w) {
850
            win.sticky = !win.sticky;
851
        }
852
    }
853
854
    /// Hides `w` or shows it again, keeping everything else about it.
855
    pub fn set_hidden(&mut self, w: WindowId, hidden: bool) {
856
        if let Some(win) = self.windows.get_mut(w) {
857
            win.hidden = hidden;
858
            win.urgent &= !hidden;
859
        }
860
    }
861
862
    /// Target geometry for everything on `o`, in output-local logical
863
    /// coordinates offset by the output's area.
864
    pub fn arrange(&self, o: OutputId) -> Arrangement {
865
        self.arrange_hiding(o, &[])
866
    }
867
868
    /// Like `arrange` with `hide` treated as hidden, which places them on the
869
    /// seeds they would grow from.
870
    pub fn arrange_hiding(&self, o: OutputId, hide: &[WindowId]) -> Arrangement {
871
        let Some(out) = self.outputs.get(o) else {
872
            return Arrangement::default();
873
        };
874
        let area = inset(out.usable(), self.gaps.outer);
875
        let shown = self.vis_on(o);
876
        let vis = &|w: WindowId| shown(w) && !hide.contains(&w);
877
        let tiled = out
878
            .tree
879
            .arrange(area, self.gaps.inner, vis)
880
            .into_iter()
881
            .map(|(window, rect)| Placed {
882
                window,
883
                rect,
884
                visible: vis(window),
885
            })
886
            .collect();
887
        let floating = self.floating_on(o, out, vis);
888
        let fullscreen = self.fullscreen_in(vis);
889
        let over = fullscreen.map_or_else(Vec::new, |f| self.above_fullscreen(f, &floating));
890
        Arrangement {
891
            tiled,
892
            floating,
893
            fullscreen,
894
            over,
895
        }
896
    }
897
898
    fn floating_on(
899
        &self,
900
        o: OutputId,
901
        out: &Output,
902
        vis: &dyn Fn(WindowId) -> bool,
903
    ) -> Vec<(WindowId, Rect)> {
904
        let mut floating: Vec<(WindowId, Rect)> = out
905
            .floating
906
            .iter()
907
            .copied()
908
            .filter(|&w| vis(w))
909
            .filter_map(|w| Some((w, self.windows[w].float_rect?)))
910
            .collect();
911
        for sp in &self.scratchpads {
912
            if let Some(i) = sp.shown
913
                && sp.output == Some(o)
914
                && !self.windows[sp.windows[i]].hidden
915
                && let Some(r) = self.windows[sp.windows[i]].float_rect
916
            {
917
                floating.push((sp.windows[i], centre_in(out.usable(), r.w, r.h)));
918
            }
919
        }
920
        floating
921
    }
922
923
    fn fullscreen_in(&self, vis: &dyn Fn(WindowId) -> bool) -> Option<WindowId> {
924
        let is_fullscreen = |w: WindowId| self.windows[w].fullscreen && vis(w);
925
        self.history
926
            .iter()
927
            .rev()
928
            .copied()
929
            .find(|&w| is_fullscreen(w))
930
            .or_else(|| self.windows.keys().find(|&w| is_fullscreen(w)))
931
    }
932
933
    fn above_fullscreen(&self, f: WindowId, floating: &[(WindowId, Rect)]) -> Vec<WindowId> {
934
        floating
935
            .iter()
936
            .map(|&(w, _)| w)
937
            .filter(|&w| w != f && (self.descends(w, f) || self.windows[w].scratchpad.is_some()))
938
            .collect()
939
    }
940
941
    /// The fullscreen window of the output under (x, y), with the floating
942
    /// transients that stay above it. Cheaper than arranging the output.
943
    pub fn fullscreen_at(&self, x: f64, y: f64) -> Option<(WindowId, Vec<WindowId>)> {
944
        let (o, out) = self
945
            .outputs
946
            .iter()
947
            .find(|(_, out)| out.area.contains(x, y))?;
948
        let vis = self.vis_on(o);
949
        let f = self.fullscreen_in(&vis)?;
950
        Some((f, self.above_fullscreen(f, &self.floating_on(o, out, &vis))))
951
    }
952
953
    /// Records that `w` is a transient of `parent`.
954
    pub fn set_parent(&mut self, w: WindowId, parent: Option<WindowId>) {
955
        if parent.is_some_and(|p| p == w || self.descends(p, w)) {
956
            return;
957
        }
958
        if let Some(win) = self.windows.get_mut(w) {
959
            win.parent = parent;
960
        }
961
    }
962
963
    fn descends(&self, mut w: WindowId, of: WindowId) -> bool {
964
        for _ in 0..self.windows.len() {
965
            match self.windows.get(w).and_then(|x| x.parent) {
966
                Some(p) if p == of => return true,
967
                Some(p) => w = p,
968
                None => return false,
969
            }
970
        }
971
        false
972
    }
973
974
    /// Moves focus to a fullscreen `w` when it covers the focused window,
975
    /// unless that is one of its own transients.
976
    pub fn focus_if_covering(&mut self, w: WindowId) {
977
        let Some(win) = self.windows.get(w).filter(|win| win.fullscreen) else {
978
            return;
979
        };
980
        let covers = self.focused().is_some_and(|f| {
981
            f != w && self.windows[f].output == win.output && !self.descends(f, w)
982
        });
983
        if covers && self.visible(w) {
984
            self.focus(w);
985
        }
986
    }
987
988
    /// Focuses `w` unless it is out of sight or a fullscreen window hides it,
989
    /// flagging it urgent then. Returns whether it took the focus.
990
    pub fn focus_unless_covered(&mut self, w: WindowId) -> bool {
991
        if self.visible(w) && !self.covered(w) {
992
            self.focus(w);
993
            return true;
994
        }
995
        self.mark_urgent(w);
996
        false
997
    }
998
999
    /// Whether a fullscreen or extended window on `w`'s output hides it. The
1000
    /// fullscreen window's transients and shown scratchpads are not hidden,
1001
    /// and a window that is itself fullscreen takes over.
1002
    pub fn covered(&self, w: WindowId) -> bool {
1003
        if self.eclipsed(w) {
1004
            return true;
1005
        }
1006
        let Some(win) = self.windows.get(w) else {
1007
            return false;
1008
        };
1009
        let Some(o) = win.output else {
1010
            return false;
1011
        };
1012
        let arr = self.arrange(o);
1013
        !win.fullscreen && arr.fullscreen.is_some_and(|f| f != w) && !arr.over.contains(&w)
1014
    }
1015
1016
    #[cfg(test)]
1017
    pub(crate) fn check(&self) {
1018
        for (o, out) in &self.outputs {
1019
            out.tree.check();
1020
            for w in out.tree.windows() {
1021
                let win = &self.windows[w];
1022
                assert_eq!(win.output, Some(o));
1023
                assert!(!win.floating && win.scratchpad.is_none());
1024
            }
1025
            for &w in &out.floating {
1026
                assert_eq!(self.windows[w].output, Some(o));
1027
                assert!(self.windows[w].floating);
1028
            }
1029
        }
1030
        for (w, win) in &self.windows {
1031
            let homes = self
1032
                .outputs
1033
                .values()
1034
                .filter(|out| out.tree.contains(w) || out.floating.contains(&w))
1035
                .count();
1036
            let expected = usize::from(win.output.is_some() && win.scratchpad.is_none());
1037
            assert_eq!(homes, expected, "window placed {homes} times");
1038
        }
1039
    }
1040
}
1041
1042
fn nearest<K: Copy>(
1043
    from: Rect,
1044
    dir: Dir,
1045
    candidates: impl Iterator<Item = (K, Rect)>,
1046
) -> Option<K> {
1047
    const TOL: f64 = 0.5;
1048
    let score = |r: Rect| -> Option<(bool, f64, f64)> {
1049
        let (gap, overlap, offset) = match dir {
1050
            Dir::Right => (
1051
                r.x - from.right(),
1052
                span_overlap(from.y, from.h, r.y, r.h),
1053
                r.center_y() - from.center_y(),
1054
            ),
1055
            Dir::Left => (
1056
                from.x - r.right(),
1057
                span_overlap(from.y, from.h, r.y, r.h),
1058
                r.center_y() - from.center_y(),
1059
            ),
1060
            Dir::Down => (
1061
                r.y - from.bottom(),
1062
                span_overlap(from.x, from.w, r.x, r.w),
1063
                r.center_x() - from.center_x(),
1064
            ),
1065
            Dir::Up => (
1066
                from.y - r.bottom(),
1067
                span_overlap(from.x, from.w, r.x, r.w),
1068
                r.center_x() - from.center_x(),
1069
            ),
1070
        };
1071
        (gap > -TOL).then_some((overlap <= 0.0, gap.max(0.0), offset.abs()))
1072
    };
1073
    candidates
1074
        .filter_map(|(k, r)| score(r).map(|s| (k, s)))
1075
        .min_by(|a, b| a.1.partial_cmp(&b.1).unwrap_or(std::cmp::Ordering::Equal))
1076
        .map(|(k, _)| k)
1077
}
1078
1079
fn span_overlap(a: f64, al: f64, b: f64, bl: f64) -> f64 {
1080
    (a + al).min(b + bl) - a.max(b)
1081
}
1082
1083
fn inset(r: Rect, by: f64) -> Rect {
1084
    Rect::new(
1085
        r.x + by,
1086
        r.y + by,
1087
        (r.w - 2.0 * by).max(0.0),
1088
        (r.h - 2.0 * by).max(0.0),
1089
    )
1090
}
1091
1092
fn centred(area: Rect, frac: f64) -> Rect {
1093
    centre_in(area, area.w * frac, area.h * frac)
1094
}
1095
1096
/// A w by h rect centred in area, shrunk to fit it.
1097
pub(crate) fn centre_in(area: Rect, w: f64, h: f64) -> Rect {
1098
    let (w, h) = (w.min(area.w), h.min(area.h));
1099
    Rect::new(
1100
        area.x + (area.w - w) / 2.0,
1101
        area.y + (area.h - h) / 2.0,
1102
        w,
1103
        h,
1104
    )
1105
}
1106
1107
/// The smallest a floating window gets when dragged or rescaled.
1108
pub const MIN_FLOAT_SIZE: f64 = 32.0;
1109
1110
/// How much of a floating window stays reachable when it is larger than
1111
/// the area it lives in.
1112
const STRIP: f64 = 64.0;
1113
1114
/// Moves a floating rect to keep it reachable inside bounds. A window that
1115
/// fits stays whole inside, a larger one keeps its top edge and a strip.
1116
pub fn clamp_float(r: Rect, bounds: Rect) -> Rect {
1117
    let x = if r.w <= bounds.w {
1118
        r.x.clamp(bounds.x, bounds.right() - r.w)
1119
    } else {
1120
        let strip = STRIP.min(bounds.w);
1121
        r.x.clamp(bounds.x + strip - r.w, bounds.right() - strip)
1122
    };
1123
    let y = if r.h <= bounds.h {
1124
        r.y.clamp(bounds.y, bounds.bottom() - r.h)
1125
    } else {
1126
        r.y.clamp(bounds.y, bounds.bottom() - STRIP.min(bounds.h))
1127
    };
1128
    Rect::new(x, y, r.w, r.h)
1129
}
1130
1131
/// Keeps a floating rect at the same relative spot and size when the area
1132
/// it lives in changes.
1133
fn translate(r: Rect, from: Rect, to: Rect) -> Rect {
1134
    if to.w <= 0.0 || to.h <= 0.0 {
1135
        return r;
1136
    }
1137
    let sx = if from.w > 0.0 { to.w / from.w } else { 1.0 };
1138
    let sy = if from.h > 0.0 { to.h / from.h } else { 1.0 };
1139
    let scaled = Rect::new(
1140
        to.x + (r.x - from.x) * sx,
1141
        to.y + (r.y - from.y) * sy,
1142
        (r.w * sx).max(MIN_FLOAT_SIZE),
1143
        (r.h * sy).max(MIN_FLOAT_SIZE),
1144
    );
1145
    clamp_float(scaled, to)
1146
}