alma 0.1.1

A Bevy-native modal text editor with Vim-style navigation.
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

//! Vim mode state.

use bevy::prelude::Resource;

use super::InsertState;

/// High-level editing mode for the Vim controller.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Resource)]
pub enum VimMode {
    /// Normal-mode navigation and command composition.
    #[default]
    Normal,
    /// Insert-mode text entry.
    Insert(InsertState),
    /// Visual-mode selection behavior.
    Visual(VisualMode),
}

impl VimMode {
    /// Returns whether this mode is insert-like.
    #[must_use]
    pub const fn is_insert(self) -> bool {
        matches!(self, Self::Insert(_))
    }
}

/// Supported visual selection variants.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum VisualMode {
    /// Character-wise visual selection.
    Characterwise,
    /// Whole-line visual selection.
    Linewise,
    /// Rectangular visual selection by screen column.
    Blockwise,
}

#[cfg(test)]
mod tests {
    use super::VimMode;
    use crate::vim::{InsertExitPolicy, InsertState};

    #[test]
    fn insert_mode_carries_insert_state() {
        let state = InsertState::new(InsertExitPolicy::KeepCursor);

        assert_eq!(VimMode::Insert(state), VimMode::Insert(state));
        assert!(VimMode::Insert(state).is_insert());
        assert!(!VimMode::Normal.is_insert());
    }
}