Add EventsAndRaw iter and implement it for Read
- In addition to Events it preserves the byte sequence that created an event. This is useful, e.g., for implementing a terminal multiplexer where the raw input should in some cases be passed on to another tty. - In order to ensure backwards compatibility, the function that creates the trait is implemented in a separate extension trait.
This commit is contained in:
parent
e07cae2a14
commit
2f97c69a5c
76
src/input.rs
76
src/input.rs
|
@ -28,14 +28,27 @@ impl<R: Read> Iterator for Keys<R> {
|
||||||
|
|
||||||
/// An iterator over input events.
|
/// An iterator over input events.
|
||||||
pub struct Events<R> {
|
pub struct Events<R> {
|
||||||
source: R,
|
inner: EventsAndRaw<R>
|
||||||
leftover: Option<u8>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<R: Read> Iterator for Events<R> {
|
impl<R: Read> Iterator for Events<R> {
|
||||||
type Item = Result<Event, io::Error>;
|
type Item = Result<Event, io::Error>;
|
||||||
|
|
||||||
fn next(&mut self) -> Option<Result<Event, io::Error>> {
|
fn next(&mut self) -> Option<Result<Event, io::Error>> {
|
||||||
|
self.inner.next().map(|tuple| tuple.map(|(event, _raw)| event))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// An iterator over input events and the bytes that define them.
|
||||||
|
pub struct EventsAndRaw<R> {
|
||||||
|
source: R,
|
||||||
|
leftover: Option<u8>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<R: Read> Iterator for EventsAndRaw<R> {
|
||||||
|
type Item = Result<(Event, Vec<u8>), io::Error>;
|
||||||
|
|
||||||
|
fn next(&mut self) -> Option<Result<(Event, Vec<u8>), io::Error>> {
|
||||||
let mut source = &mut self.source;
|
let mut source = &mut self.source;
|
||||||
|
|
||||||
if let Some(c) = self.leftover {
|
if let Some(c) = self.leftover {
|
||||||
|
@ -53,7 +66,7 @@ impl<R: Read> Iterator for Events<R> {
|
||||||
Ok(0) => return None,
|
Ok(0) => return None,
|
||||||
Ok(1) => {
|
Ok(1) => {
|
||||||
match buf[0] {
|
match buf[0] {
|
||||||
b'\x1B' => Ok(Event::Key(Key::Esc)),
|
b'\x1B' => Ok((Event::Key(Key::Esc), vec![b'\x1B'])),
|
||||||
c => parse_event(c, &mut source.bytes()),
|
c => parse_event(c, &mut source.bytes()),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -75,7 +88,7 @@ impl<R: Read> Iterator for Events<R> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn parse_event<I>(item: u8, iter: &mut I) -> Result<Event, io::Error>
|
fn parse_event<I>(item: u8, iter: &mut I) -> Result<(Event, Vec<u8>), io::Error>
|
||||||
where I: Iterator<Item = Result<u8, io::Error>>
|
where I: Iterator<Item = Result<u8, io::Error>>
|
||||||
{
|
{
|
||||||
let mut buf = vec![item];
|
let mut buf = vec![item];
|
||||||
|
@ -85,7 +98,7 @@ fn parse_event<I>(item: u8, iter: &mut I) -> Result<Event, io::Error>
|
||||||
});
|
});
|
||||||
event::parse_event(item, &mut iter)
|
event::parse_event(item, &mut iter)
|
||||||
};
|
};
|
||||||
result.or(Ok(Event::Unsupported(buf)))
|
result.or(Ok(Event::Unsupported(buf.clone()))).map(|e| (e, buf))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ -113,11 +126,11 @@ pub trait TermRead {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<R: Read> TermRead for R {
|
|
||||||
|
impl<R: Read + TermReadEventsAndRaw> TermRead for R {
|
||||||
fn events(self) -> Events<Self> {
|
fn events(self) -> Events<Self> {
|
||||||
Events {
|
Events {
|
||||||
source: self,
|
inner: self.events_and_raw()
|
||||||
leftover: None,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
fn keys(self) -> Keys<Self> {
|
fn keys(self) -> Keys<Self> {
|
||||||
|
@ -145,6 +158,21 @@ impl<R: Read> TermRead for R {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Extension to `TermRead` trait. A separate trait in order to maintain backwards compatibility.
|
||||||
|
pub trait TermReadEventsAndRaw {
|
||||||
|
/// An iterator over input events and the bytes that define them.
|
||||||
|
fn events_and_raw(self) -> EventsAndRaw<Self> where Self: Sized;
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<R: Read> TermReadEventsAndRaw for R {
|
||||||
|
fn events_and_raw(self) -> EventsAndRaw<Self> {
|
||||||
|
EventsAndRaw {
|
||||||
|
source: self,
|
||||||
|
leftover: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// A sequence of escape codes to enable terminal mouse support.
|
/// A sequence of escape codes to enable terminal mouse support.
|
||||||
const ENTER_MOUSE_SEQUENCE: &'static str = csi!("?1000h\x1b[?1002h\x1b[?1015h\x1b[?1006h");
|
const ENTER_MOUSE_SEQUENCE: &'static str = csi!("?1000h\x1b[?1002h\x1b[?1015h\x1b[?1006h");
|
||||||
|
|
||||||
|
@ -241,6 +269,38 @@ mod test {
|
||||||
assert!(i.next().is_none());
|
assert!(i.next().is_none());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_events_and_raw() {
|
||||||
|
let input = b"\x1B[\x00bc\x7F\x1B[D\
|
||||||
|
\x1B[M\x00\x22\x24\x1B[<0;2;4;M\x1B[32;2;4M\x1B[<0;2;4;m\x1B[35;2;4Mb";
|
||||||
|
let mut output = Vec::<u8>::new();
|
||||||
|
{
|
||||||
|
let mut i = input.events_and_raw().map(|res| res.unwrap())
|
||||||
|
.inspect(|&(_, ref raw)| { output.extend(raw); }).map(|(event, _)| event);
|
||||||
|
|
||||||
|
assert_eq!(i.next().unwrap(),
|
||||||
|
Event::Unsupported(vec![0x1B, b'[', 0x00]));
|
||||||
|
assert_eq!(i.next().unwrap(), Event::Key(Key::Char('b')));
|
||||||
|
assert_eq!(i.next().unwrap(), Event::Key(Key::Char('c')));
|
||||||
|
assert_eq!(i.next().unwrap(), Event::Key(Key::Backspace));
|
||||||
|
assert_eq!(i.next().unwrap(), Event::Key(Key::Left));
|
||||||
|
assert_eq!(i.next().unwrap(),
|
||||||
|
Event::Mouse(MouseEvent::Press(MouseButton::WheelUp, 2, 4)));
|
||||||
|
assert_eq!(i.next().unwrap(),
|
||||||
|
Event::Mouse(MouseEvent::Press(MouseButton::Left, 2, 4)));
|
||||||
|
assert_eq!(i.next().unwrap(),
|
||||||
|
Event::Mouse(MouseEvent::Press(MouseButton::Left, 2, 4)));
|
||||||
|
assert_eq!(i.next().unwrap(),
|
||||||
|
Event::Mouse(MouseEvent::Release(2, 4)));
|
||||||
|
assert_eq!(i.next().unwrap(),
|
||||||
|
Event::Mouse(MouseEvent::Release(2, 4)));
|
||||||
|
assert_eq!(i.next().unwrap(), Event::Key(Key::Char('b')));
|
||||||
|
assert!(i.next().is_none());
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_eq!(input.iter().map(|b| *b).collect::<Vec<u8>>(), output)
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_function_keys() {
|
fn test_function_keys() {
|
||||||
let mut st = b"\x1BOP\x1BOQ\x1BOR\x1BOS".keys();
|
let mut st = b"\x1BOP\x1BOQ\x1BOR\x1BOS".keys();
|
||||||
|
|
Loading…
Reference in New Issue