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

//! Raw editor input messages.

use crate::{ecs::components::buffer::ViewEntity, vim::KeyToken};
use bevy::prelude::Message;

pub use super::error::VimInputRejectionReason;

/// Input normalized away from Bevy platform details.
#[derive(Clone, Debug, Eq, Message, PartialEq)]
pub enum EditorInputEvent {
    /// A key token intended for modal editor interpretation.
    Key(KeyInputEvent),
    /// Printable text intended for prompt or insertion contexts.
    Text(TextInputEvent),
}

impl EditorInputEvent {
    /// Returns whether this event is a synthetic held-key repeat.
    #[must_use]
    pub const fn is_repeated_key(&self) -> bool {
        matches!(self, Self::Key(key) if key.repeated)
    }
}

/// Normalized keyboard input.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct KeyInputEvent {
    /// Layout-independent Vim-facing key token.
    pub token: KeyToken,
    /// Whether this key was synthesized by held-key repeat handling.
    pub repeated: bool,
}

/// Printable text input.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct TextInputEvent {
    /// Text produced by the active input method.
    pub text: String,
}

/// Notification that Vim input could not be interpreted at the adapter boundary.
#[derive(Clone, Copy, Debug, Eq, Message, PartialEq)]
pub struct VimInputRejected {
    /// Focused view whose input was rejected.
    pub target: ViewEntity,
    /// Boundary reason that prevented interpretation.
    pub reason: VimInputRejectionReason,
}