panes 0.19.0

Renderer-agnostic layout engine with declarative ergonomics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

use std::sync::Arc;

use crate::builder::LayoutBuilder;
use crate::error::PaneError;
use crate::layout::Layout;
use crate::panel::{fixed, grow};
use crate::preset::{collect_kinds, validate_active, validate_f32_param, validate_kinds};

/// Builder for the scrollable preset layout.
///
/// NIRI-style scrolling: shows two panels side by side, filling the viewport.
/// The `active` index is the focused panel. The window position is derived
/// so that the focused panel is always visible.
pub struct Scrollable {
    kinds: Arc<[Arc<str>]>,
    active: usize,
    gap: f32,
}

impl Scrollable {
    pub(crate) fn new(kinds: impl IntoIterator<Item = impl Into<Arc<str>>>) -> Self {
        Self {
            kinds: collect_kinds(kinds),
            active: 0,
            gap: 0.0,
        }
    }

    crate::macros::builder_setters!(
        /// Set the focused panel index. The visible window is derived from focus.
        active(index: usize);
        /// Set the gap between panels.
        gap(gap: f32)
    );

    /// Consume the builder and produce a [`Layout`].
    pub fn build(&self) -> Result<Layout, PaneError> {
        validate_kinds(&self.kinds)?;
        validate_active(self.active, self.kinds.len())?;
        validate_f32_param("gap", self.gap)?;

        match self.kinds.len() {
            1 => super::build_single(Arc::clone(&self.kinds[0])),
            _ => self.build_scroll(),
        }
    }

    fn build_scroll(&self) -> Result<Layout, PaneError> {
        let mut b = LayoutBuilder::new();
        let window_start = window_start_from_focus(self.active, self.kinds.len(), 2);
        let gap_px = self.gap;
        let kinds = &self.kinds;

        b.row_gap(gap_px, |r| add_scroll_panels(r, kinds, window_start))?;

        b.build()
    }
}

/// Derive the window start so that `focus` is visible in a window of `panel_count` panels.
fn window_start_from_focus(focus: usize, len: usize, panel_count: usize) -> usize {
    let start = (focus + 1).saturating_sub(panel_count);
    start.min(len.saturating_sub(panel_count))
}

/// Show panels at `window` and `window + 1`; hide everything else.
fn add_scroll_panels(ctx: &mut crate::ContainerCtx, kinds: &[Arc<str>], window: usize) {
    for (i, kind) in kinds.iter().enumerate() {
        let visible = i == window || i == window + 1;
        let constraint = match visible {
            true => grow(1.0),
            false => fixed(0.0),
        };
        ctx.panel_with(Arc::clone(kind), constraint);
    }
}

super::impl_preset!(
    Scrollable,
    runtime(kinds, |this| crate::strategy::StrategyKind::Window {
        panel_count: 2,
        gap: this.gap,
    })
);