edtui 0.11.3

A TUI based vim inspired editor
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
100
101
102
103
104
105
106

mod key;
#[cfg(feature = "mouse-support")]
pub(crate) mod mouse;
pub(crate) mod paste;

#[allow(deprecated)]
pub use key::deprecated::KeyEvent;
pub use key::{input::KeyInput, KeyEventHandler, KeyEventRegister, KeyInputSequence};

#[cfg(feature = "mouse-support")]
pub use mouse::{MouseEvent, MouseEventHandler};

use crate::{events::paste::PasteEventHandler, EditorState};
use crossterm::event::Event as CTEvent;

/// Handles key and mouse events.
#[derive(Clone)]
pub struct EditorEventHandler {
    pub key_handler: KeyEventHandler,
}

impl Default for EditorEventHandler {
    fn default() -> Self {
        Self::vim_mode()
    }
}

impl EditorEventHandler {
    /// Creates a new `EditorEvent` handler with the given key handler.
    #[must_use]
    pub fn new(key_handler: KeyEventHandler) -> Self {
        Self { key_handler }
    }

    /// Creates a new `EditorEvent` handler with vim-style keybindings.
    #[must_use]
    pub fn vim_mode() -> Self {
        Self {
            key_handler: KeyEventHandler::vim_mode(),
        }
    }

    /// Creates a new `EditorEvent` handler with emacs-style keybindings.
    #[must_use]
    pub fn emacs_mode() -> Self {
        Self {
            key_handler: KeyEventHandler::emacs_mode(),
        }
    }

    /// Handles key and mouse events.
    pub fn on_event<T>(&mut self, event: T, state: &mut EditorState)
    where
        T: Into<Event>,
    {
        match event.into() {
            Event::Key(event) => self.on_key_event(event, state),
            #[cfg(feature = "mouse-support")]
            Event::Mouse(event) => self.on_mouse_event(event, state),
            Event::Paste(text) => self.on_paste_event(text, state),
            Event::None => (),
        }
    }

    /// Handles key events.
    pub fn on_key_event<T>(&mut self, event: T, state: &mut EditorState)
    where
        T: Into<KeyInput>,
    {
        self.key_handler.on_event(event.into(), state);
    }

    #[cfg(feature = "mouse-support")]
    /// Handles mouse events.
    pub fn on_mouse_event<T>(&self, event: T, state: &mut EditorState)
    where
        T: Into<MouseEvent>,
    {
        MouseEventHandler::on_event(event.into(), state);
    }

    /// Handles paste events.
    pub fn on_paste_event(&self, text: String, state: &mut EditorState) {
        PasteEventHandler::on_event(text, state);
    }
}

pub enum Event {
    Key(KeyInput),
    #[cfg(feature = "mouse-support")]
    Mouse(MouseEvent),
    Paste(String),
    None,
}

impl From<CTEvent> for Event {
    fn from(value: CTEvent) -> Self {
        match value {
            CTEvent::Key(event) => Self::Key(event.into()),
            #[cfg(feature = "mouse-support")]
            CTEvent::Mouse(event) => Self::Mouse(event.into()),
            CTEvent::Paste(text) => Self::Paste(text),
            _ => Self::None,
        }
    }
}