reovim-client-model 0.14.4

Common client model for Reovim (platform-agnostic abstractions)
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

//! Focus management traits.
//!
//! These types and traits manage which UI element (panel or overlay)
//! has keyboard focus.

/// Current focus target.
///
/// Focus can be on either a panel (editor window) or an overlay
/// (popup like completion menu).
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Focus {
    /// Focus is on a panel (viewport).
    Panel(u64),
    /// Focus is on an overlay.
    Overlay(String),
}

impl Focus {
    /// Create a panel focus.
    #[must_use]
    pub const fn panel(viewport_id: u64) -> Self {
        Self::Panel(viewport_id)
    }

    /// Create an overlay focus.
    #[must_use]
    pub fn overlay(overlay_id: impl Into<String>) -> Self {
        Self::Overlay(overlay_id.into())
    }

    /// Check if focus is on a panel.
    #[must_use]
    pub const fn is_panel(&self) -> bool {
        matches!(self, Self::Panel(_))
    }

    /// Check if focus is on an overlay.
    #[must_use]
    pub const fn is_overlay(&self) -> bool {
        matches!(self, Self::Overlay(_))
    }

    /// Get the focused viewport ID, if any.
    #[must_use]
    pub const fn viewport_id(&self) -> Option<u64> {
        match self {
            Self::Panel(id) => Some(*id),
            Self::Overlay(_) => None,
        }
    }

    /// Get the focused overlay ID, if any.
    #[must_use]
    pub fn overlay_id(&self) -> Option<&str> {
        match self {
            Self::Panel(_) => None,
            Self::Overlay(id) => Some(id),
        }
    }
}

/// Trait for managing focus between panels and overlays.
///
/// The focus manager tracks what has keyboard focus and handles
/// transitions between panels and overlays.
pub trait FocusManager {
    /// Get the current focus.
    fn current(&self) -> &Focus;

    /// Focus a specific panel (viewport).
    fn focus_panel(&mut self, viewport_id: u64);

    /// Focus a specific overlay.
    fn focus_overlay(&mut self, overlay_id: &str);

    /// Return focus to the last focused panel.
    ///
    /// Called when an overlay is dismissed.
    fn return_to_panel(&mut self);

    /// Check if the given panel has focus.
    fn is_panel_focused(&self, viewport_id: u64) -> bool {
        matches!(self.current(), Focus::Panel(id) if *id == viewport_id)
    }

    /// Check if the given overlay has focus.
    fn is_overlay_focused(&self, overlay_id: &str) -> bool {
        matches!(self.current(), Focus::Overlay(id) if id == overlay_id)
    }

    /// Check if any overlay has focus.
    fn has_overlay_focus(&self) -> bool {
        self.current().is_overlay()
    }
}

#[cfg(test)]
#[path = "focus_tests.rs"]
mod tests;