summaryrefslogtreecommitdiffstats
path: root/src/input/src/event.rs
blob: 9b57e10e3144802709be47bda8f210343fd6061e (plain)
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
use crossterm::event::{KeyCode, MouseEvent};

use crate::{KeyEvent, StandardEvent};

/// An event, either from an input device, system change or action event.
#[derive(Debug, PartialOrd, PartialEq, Eq, Clone, Copy)]
#[allow(clippy::exhaustive_enums)]
pub enum Event<CustomEvent: crate::CustomEvent> {
	/// A keyboard event.
	Key(KeyEvent),
	/// An action event.
	Standard(StandardEvent),
	/// A mouse event.
	Mouse(MouseEvent),
	/// An empty event.
	None,
	/// A terminal resize event.
	Resize(u16, u16),
	/// Custom application defined events
	MetaEvent(CustomEvent),
}

impl<CustomEvent: crate::CustomEvent> From<crossterm::event::Event> for Event<CustomEvent> {
	#[inline]
	fn from(event: crossterm::event::Event) -> Self {
		match event {
			crossterm::event::Event::Key(evt) => Self::Key(KeyEvent::from(evt)),
			crossterm::event::Event::Mouse(evt) => Self::Mouse(evt),
			crossterm::event::Event::Resize(width, height) => Self::Resize(width, height),
			// ignore these events for now, as we don't need them
			crossterm::event::Event::FocusGained
			| crossterm::event::Event::FocusLost
			| crossterm::event::Event::Paste(_) => Self::None,
		}
	}
}

impl<CustomEvent: crate::CustomEvent> From<KeyEvent> for Event<CustomEvent> {
	#[inline]
	fn from(key_event: KeyEvent) -> Self {
		Self::Key(key_event)
	}
}

impl<CustomEvent: crate::CustomEvent> From<MouseEvent> for Event<CustomEvent> {
	#[inline]
	fn from(mouse_event: MouseEvent) -> Self {
		Self::Mouse(mouse_event)
	}
}

impl<CustomEvent: crate::CustomEvent> From<StandardEvent> for Event<CustomEvent> {
	#[inline]
	fn from(event: StandardEvent) -> Self {
		Self::Standard(event)
	}
}

impl<CustomEvent: crate::CustomEvent> From<KeyCode> for Event<CustomEvent> {
	#[inline]
	fn from(code: KeyCode) -> Self {
		Self::Key(KeyEvent::from(code))
	}
}

impl<CustomEvent: crate::CustomEvent> From<char> for Event<CustomEvent> {
	#[inline]
	fn from(c: char) -> Self {
		Self::Key(KeyEvent::from(KeyCode::Char(c)))
	}
}

#[cfg(test)]
mod tests {
	use crossterm::{
		event as ct_event,
		event::{KeyModifiers, MouseEventKind},
	};

	use super::*;
	use crate::testutil::local::Event;

	#[test]
	fn from_crossterm_key_event() {
		let event = Event::from(ct_event::Event::Key(ct_event::KeyEvent::new(
			KeyCode::Null,
			KeyModifiers::empty(),
		)));
		assert_eq!(event, Event::Key(KeyEvent::new(KeyCode::Null, KeyModifiers::empty())));
	}

	#[test]
	fn from_crossterm_key_event_char_with_modifier() {
		let event = Event::from(ct_event::Event::Key(ct_event::KeyEvent::new(
			KeyCode::Char('?'),
			KeyModifiers::SHIFT,
		)));

		assert_eq!(
			event,
			Event::Key(KeyEvent::new(KeyCode::Char('?'), KeyModifiers::SHIFT))
		);
	}

	#[test]
	fn from_crossterm_mouse_event() {
		let mouse_event = MouseEvent {
			kind: MouseEventKind::Moved,
			column: 0,
			row: 0,
			modifiers: KeyModifiers::empty(),
		};
		let event = Event::from(crossterm::event::Event::Mouse(mouse_event));
		assert_eq!(event, Event::Mouse(mouse_event));
	}

	#[test]
	fn from_crossterm_resize_event() {
		let event = Event::from(crossterm::event::Event::Resize(100, 100));
		assert_eq!(event, Event::Resize(100, 100));
	}

	#[test]
	fn from_crossterm_focused_gained_event() {
		let event = Event::from(crossterm::event::Event::FocusGained);
		assert_eq!(event, Event::None);
	}

	#[test]
	fn from_crossterm_focused_lost_event() {
		let event = Event::from(crossterm::event::Event::FocusLost);
		assert_eq!(event, Event::None);
	}

	#[test]
	fn from_crossterm_paste_event() {
		let event = Event::from(crossterm::event::Event::Paste(String::from("test")));
		assert_eq!(event, Event::None);
	}

	#[test]
	fn from_meta_event() {
		let event = Event::from(StandardEvent::Kill);
		assert_eq!(event, Event::Standard(StandardEvent::Kill));
	}

	#[test]
	fn from_key_code() {
		let event = Event::from(KeyCode::Null);
		assert_eq!(event, Event::Key(KeyEvent::new(KeyCode::Null, KeyModifiers::empty())));
	}

	#[test]
	fn from_mouse_event() {
		let event = Event::from(MouseEvent {
			kind: MouseEventKind::Moved,
			column: 0,
			row: 0,
			modifiers: KeyModifiers::empty(),
		});
		assert_eq!(
			event,
			Event::Mouse(MouseEvent {
				kind: MouseEventKind::Moved,
				column: 0,
				row: 0,
				modifiers: KeyModifiers::empty(),
			})
		);
	}

	#[test]
	fn from_char() {
		let event = Event::from('a');
		assert_eq!(
			event,
			Event::Key(KeyEvent::new(KeyCode::Char('a'), KeyModifiers::empty()))
		);
	}
}