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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/*!
Enums and structs for getting input from the user.
```rust, no_run
use yacll::{
    input::{
        Event,
        KeyCode,
    },
    Result, Yogurt,
};
use std::{
    time::Duration,
    thread::sleep,
};

fn main() -> Result<()> {
    let mut y = Yogurt::new();
    y.enter_alt()?;

    y.cursor_on(yacll::stylize::CursorAttr::Hidden)?;

    y.mv_print((0, 0), "press the any key to advance.")?;
    y.flush()?;
    y.block_event()?;

    y.mv_print((0, 1), "now press the q key in the next 10 seconds!")?;
    y.flush()?;
    match y.read_event(Duration::from_secs(10))? {
        Some(some) => if let Event::Key(ke) = some {
            if let KeyCode::Char('q') = ke.code {
                y.mv_print((0, 2), "you did it!")?;
            } else {
                y.mv_print((0, 2), "that's not q!")?;
            }
        } else {
            y.mv_print((0, 2), "that event isn't a key event!")?;
        }
        None => y.mv_print((0, 2), "you failed...")?,
    }
    y.flush()?;

    sleep(Duration::from_secs(3));

    y.cursor_off(yacll::stylize::CursorAttr::Hidden)?;

    y.leave_alt()?;
    Ok(())
}
// try running `$ cargo run --example=input` if you have the repository cloned!
```
*/

use crate::{Result, Yarr, Yogurt};
use bitflags::bitflags;
use crossterm::event::read;
pub use crossterm::event::KeyEventKind;
use crossterm::event::{self, poll};
pub use event::MouseEvent;
use std::time::Duration;

/// Functions for getting input from the user.
impl Yogurt {
    /// Read an event. Will error if not in alt-mode. Duration is how long to wait for an event
    /// before returning.
    pub fn read_event(&mut self, dur: Duration) -> Result<Option<Event>> {
        if self.size.is_none() {
            return Err(Yarr::NotInAltMode);
        }
        if poll(dur)? {
            let read = read()?;
            let event = read.try_into()?;
            Ok(Some(event))
        } else {
            Ok(None)
        }
    }
    /// Like [`read_event`](Yogurt::read_event), except instead of exiting with `None` after `dur`
    /// has passed, it blocks the thread.
    pub fn block_event(&mut self) -> Result<Event> {
        if self.size.is_none() {
            return Err(Yarr::NotInAltMode);
        }
        let read = read()?;
        let event = read.try_into()?;
        Ok(event)
    }
}

/// Possible events.
pub enum Event {
    /// The terminal gained focus.
    FocusGained,
    /// The terminal lost focus.
    FocusLost,
    /// A single key event with additional pressed modifiers.
    Key(KeyEvent),
    /// A single mouse event with additional pressed modifiers.
    Mouse(MouseEvent),
    /// A string that was pasted into the terminal. Only emitted if bracketed paste has been
    /// enabled.
    Paste(String),
    /// An resize event with new dimensions after resize (columns, rows).
    /// **Note** that resize events can be occur in batches.
    Resize(u16, u16),
}

impl TryFrom<event::Event> for Event {
    type Error = Yarr;
    fn try_from(value: event::Event) -> Result<Self> {
        match value {
            event::Event::FocusGained => Ok(Event::FocusGained),
            event::Event::FocusLost => Ok(Event::FocusLost),
            event::Event::Key(ke) => Ok(Event::Key(ke.try_into()?)),
            event::Event::Mouse(me) => Ok(Event::Mouse(me)),
            event::Event::Paste(ps) => Ok(Event::Paste(ps)),
            event::Event::Resize(x, y) => Ok(Event::Resize(x, y)),
        }
    }
}

/// A key event.
pub struct KeyEvent {
    /// Key itself.
    pub code: KeyCode,
    /// Kind of event, ie: release, press, or repeat
    pub kind: KeyEventKind,
    /// Key modifiers, ie: shift, control, alt
    pub mods: KeyModifiers,
}

impl From<KeyEvent> for event::KeyEvent {
    fn from(ke: KeyEvent) -> Self {
        event::KeyEvent {
            code: ke.code.into(),
            modifiers: ke.mods.into(),
            kind: ke.kind,
            state: event::KeyEventState::NONE,
        }
    }
}

impl TryFrom<event::KeyEvent> for KeyEvent {
    type Error = Yarr;
    fn try_from(ke: event::KeyEvent) -> Result<Self> {
        let code = ke.code.try_into()?;
        Ok(KeyEvent {
            code,
            kind: ke.kind,
            mods: ke.modifiers.into(),
        })
    }
}

/// Represents possible keys.
pub enum KeyCode {
    /// Backspace key.
    Backspace,
    /// Enter key.
    Enter,
    /// Left arrow key.
    Left,
    /// Right arrow key.
    Right,
    /// Up arrow key.
    Up,
    /// Down arrow key.
    Down,
    /// Home key.
    Home,
    /// End key.
    End,
    /// Page up key.
    PageUp,
    /// Page down key.
    PageDown,
    /// Tab key.
    Tab,
    /// Shift + Tab key.
    Backtab,
    /// Delete key.
    Delete,
    /// Insert key.
    Insert,
    /// F key.
    ///
    /// `KeyCode::F(1)` represents F1 key, etc.
    F(u8),
    /// A character.
    ///
    /// `KeyCode::Char('c')` represents `c` character, etc.
    Char(char),
    /// Null.
    Null,
    /// Escape key.
    Esc,
}

impl From<KeyCode> for event::KeyCode {
    fn from(kc: KeyCode) -> Self {
        use KeyCode::*;
        match kc {
            Backspace => event::KeyCode::Backspace,
            Enter => event::KeyCode::Enter,
            Left => event::KeyCode::Left,
            Right => event::KeyCode::Right,
            Up => event::KeyCode::Up,
            Down => event::KeyCode::Down,
            Home => event::KeyCode::Home,
            End => event::KeyCode::End,
            PageUp => event::KeyCode::PageUp,
            PageDown => event::KeyCode::PageDown,
            Tab => event::KeyCode::Tab,
            Backtab => event::KeyCode::BackTab,
            Delete => event::KeyCode::Delete,
            Insert => event::KeyCode::Insert,
            F(f) => event::KeyCode::F(f),
            Char(ch) => event::KeyCode::Char(ch),
            Null => event::KeyCode::Null,
            Esc => event::KeyCode::Esc,
        }
    }
}

impl TryFrom<event::KeyCode> for KeyCode {
    type Error = Yarr;
    fn try_from(kc: event::KeyCode) -> Result<KeyCode> {
        use KeyCode::*;
        match kc {
            event::KeyCode::Backspace => Ok(Backspace),
            event::KeyCode::Enter => Ok(Enter),
            event::KeyCode::Left => Ok(Left),
            event::KeyCode::Right => Ok(Right),
            event::KeyCode::Up => Ok(Up),
            event::KeyCode::Down => Ok(Down),
            event::KeyCode::Home => Ok(Home),
            event::KeyCode::End => Ok(End),
            event::KeyCode::PageUp => Ok(PageUp),
            event::KeyCode::PageDown => Ok(PageDown),
            event::KeyCode::Tab => Ok(Tab),
            event::KeyCode::BackTab => Ok(Backtab),
            event::KeyCode::Delete => Ok(Delete),
            event::KeyCode::Insert => Ok(Insert),
            event::KeyCode::F(f) => Ok(F(f)),
            event::KeyCode::Char(ch) => Ok(Char(ch)),
            event::KeyCode::Null => Ok(Null),
            event::KeyCode::Esc => Ok(Esc),
            _ => Err(Yarr::FromCrossKeyCodeError),
        }
    }
}

bitflags! {
    /// Possible key modifiers.
    pub struct KeyModifiers: u8 {
        /// Shift key.
        const SHIFT = 0b0000_0001;
        /// Control key.
        const CONTROL = 0b0000_0010;
        /// Alt key.
        const ALT = 0b0000_0100;
        /// Super key. More commonly known as the code key, or the meta key.
        const SUPER = 0b0000_1000;
        /// No keys.
        const NONE = 0b0000_0000;
    }
}

impl From<KeyModifiers> for event::KeyModifiers {
    fn from(km: KeyModifiers) -> Self {
        event::KeyModifiers::from_bits(km.bits()).unwrap()
    }
}

impl From<event::KeyModifiers> for KeyModifiers {
    fn from(km: event::KeyModifiers) -> Self {
        KeyModifiers::from_bits(km.bits()).unwrap()
    }
}