/* * meli - ui crate. * * Copyright 2017-2018 Manos Pitsidianakis * * This file is part of meli. * * meli is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * meli is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with meli. If not, see . */ use super::*; use crossbeam::{channel::Receiver, select}; use serde::{Serialize, Serializer}; use termion::event::Event as TermionEvent; use termion::event::Key as TermionKey; use termion::input::TermRead; #[derive(Debug, PartialEq, Eq, Clone)] pub enum Key { /// Backspace. Backspace, /// Left arrow. Left, /// Right arrow. Right, /// Up arrow. Up, /// Down arrow. Down, /// Home key. Home, /// End key. End, /// Page Up key. PageUp, /// Page Down key. PageDown, /// Delete key. Delete, /// Insert key. Insert, /// Function keys. /// /// Only function keys 1 through 12 are supported. F(u8), /// Normal character. Char(char), /// Alt modified character. Alt(char), /// Ctrl modified character. /// /// Note that certain keys may not be modifiable with `ctrl`, due to limitations of terminals. Ctrl(char), /// Null byte. Null, /// Esc key. Esc, Paste(String), } impl fmt::Display for Key { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { use crate::Key::*; match self { F(n) => write!(f, "F{}", n), Char('\t') => write!(f, "Tab"), Char('\n') => write!(f, "Enter"), Char(c) => write!(f, "{}", c), Alt(c) => write!(f, "M-{}", c), Ctrl(c) => write!(f, "C-{}", c), Paste(_) => write!(f, "Pasted buf"), Null => write!(f, "Null byte"), Esc => write!(f, "Esc"), Backspace => write!(f, "Backspace"), Left => write!(f, "Left"), Right => write!(f, "Right"), Up => write!(f, "Up"), Down => write!(f, "Down"), Home => write!(f, "Home"), End => write!(f, "End"), PageUp => write!(f, "PageUp"), PageDown => write!(f, "PageDown"), Delete => write!(f, "Delete"), Insert => write!(f, "Insert"), } } } impl<'a> From<&'a String> for Key { fn from(v: &'a String) -> Self { Key::Paste(v.to_string()) } } impl From for Key { fn from(k: TermionKey) -> Self { match k { TermionKey::Backspace => Key::Backspace, TermionKey::Left => Key::Left, TermionKey::Right => Key::Right, TermionKey::Up => Key::Up, TermionKey::Down => Key::Down, TermionKey::Home => Key::Home, TermionKey::End => Key::End, TermionKey::PageUp => Key::PageUp, TermionKey::PageDown => Key::PageDown, TermionKey::Delete => Key::Delete, TermionKey::Insert => Key::Insert, TermionKey::F(u) => Key::F(u), TermionKey::Char(c) => Key::Char(c), TermionKey::Alt(c) => Key::Alt(c), TermionKey::Ctrl(c) => Key::Ctrl(c), TermionKey::Null => Key::Null, TermionKey::Esc => Key::Esc, _ => Key::Char(' '), } } } impl PartialEq for &Key { fn eq(&self, other: &Key) -> bool { **self == *other } } #[derive(PartialEq)] enum InputMode { Normal, Paste, PasteRaw(Vec), } pub enum InputCommand { Kill, /// Send Raw bytes as well Raw, NoRaw, } use termion::input::TermReadEventsAndRaw; /* * If we fork (for example start $EDITOR) we want the input-thread to stop reading from stdin. The * best way I came up with right now is to send a signal to the thread that is read in the first * input in stdin after the fork, and then the thread kills itself. The parent process spawns a new * input-thread when the child returns. * * The main loop uses try_wait_on_child() to check if child has exited. */ pub fn get_events( mut closure: impl FnMut(Key), closure_raw: impl FnMut((Key, Vec)), rx: &Receiver, ) -> ! { let stdin = std::io::stdin(); let mut input_mode = InputMode::Normal; let mut paste_buf = String::with_capacity(256); for c in stdin.events() { select! { default => {}, recv(rx) -> cmd => { match cmd.unwrap() { InputCommand::Kill => std::process::exit(0), InputCommand::Raw => get_events_raw(closure, closure_raw, rx), InputCommand::NoRaw => unreachable!(), } } }; match c { Ok(TermionEvent::Key(k)) if input_mode == InputMode::Normal => { closure(Key::from(k)); } Ok(TermionEvent::Key(TermionKey::Char(k))) if input_mode == InputMode::Paste => { paste_buf.push(k); } Ok(TermionEvent::Unsupported(ref k)) if k.as_slice() == BRACKET_PASTE_START => { input_mode = InputMode::Paste; } Ok(TermionEvent::Unsupported(ref k)) if k.as_slice() == BRACKET_PASTE_END => { input_mode = InputMode::Normal; let ret = Key::from(&paste_buf); paste_buf.clear(); closure(ret); } _ => {} // Mouse events or errors. } } std::process::exit(0) } pub fn get_events_raw( closure_nonraw: impl FnMut(Key), mut closure: impl FnMut((Key, Vec)), rx: &Receiver, ) -> ! { let stdin = std::io::stdin(); let mut input_mode = InputMode::Normal; let mut paste_buf = String::with_capacity(256); for c in stdin.events_and_raw() { select! { default => {}, recv(rx) -> cmd => { match cmd.unwrap() { InputCommand::Kill => std::process::exit(0), InputCommand::NoRaw => get_events(closure_nonraw, closure, rx), InputCommand::Raw => unreachable!(), } } }; match (c, &mut input_mode) { (Ok((TermionEvent::Key(k), bytes)), InputMode::Normal) => { closure((Key::from(k), bytes)); } ( Ok((TermionEvent::Key(TermionKey::Char(k)), ref mut bytes)), InputMode::PasteRaw(ref mut buf), ) => { paste_buf.push(k); let bytes = std::mem::replace(bytes, Vec::new()); buf.extend(bytes.into_iter()); } (Ok((TermionEvent::Unsupported(ref k), _)), _) if k.as_slice() == BRACKET_PASTE_START => { input_mode = InputMode::PasteRaw(Vec::new()); } (Ok((TermionEvent::Unsupported(ref k), _)), InputMode::PasteRaw(ref mut buf)) if k.as_slice() == BRACKET_PASTE_END => { let buf = std::mem::replace(buf, Vec::new()); input_mode = InputMode::Normal; let ret = Key::from(&paste_buf); paste_buf.clear(); closure((ret, buf)); } _ => {} // Mouse events or errors. } } std::process::exit(0) } const FIELDS: &[&str] = &[]; impl<'de> Deserialize<'de> for Key { fn deserialize(deserializer: D) -> Result where D: Deserializer<'de>, { struct KeyVisitor; impl<'de> Visitor<'de> for KeyVisitor { type Value = Key; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.write_str("`secs` or `nanos`") } fn visit_str(self, value: &str) -> Result where E: de::Error, { match value { "Backspace" => Ok(Key::Backspace), "Left" => Ok(Key::Left), "Right" => Ok(Key::Right), "Up" => Ok(Key::Up), "Down" => Ok(Key::Down), "Home" => Ok(Key::Home), "End" => Ok(Key::End), "PageUp" => Ok(Key::PageUp), "PageDown" => Ok(Key::PageDown), "Delete" => Ok(Key::Delete), "Insert" => Ok(Key::Insert), "Esc" => Ok(Key::Esc), ref s if s.len() == 1 => Ok(Key::Char(s.chars().nth(0).unwrap())), _ => Err(de::Error::unknown_field(value, FIELDS)), } } } deserializer.deserialize_identifier(KeyVisitor) } } impl Serialize for Key { fn serialize(&self, serializer: S) -> Result where S: Serializer, { match self { Key::Backspace => serializer.serialize_str("Backspace"), Key::Left => serializer.serialize_str("Left"), Key::Right => serializer.serialize_str("Right"), Key::Up => serializer.serialize_str("Up"), Key::Down => serializer.serialize_str("Down"), Key::Home => serializer.serialize_str("Home"), Key::End => serializer.serialize_str("End"), Key::PageUp => serializer.serialize_str("PageUp"), Key::PageDown => serializer.serialize_str("PageDown"), Key::Delete => serializer.serialize_str("Delete"), Key::Insert => serializer.serialize_str("Insert"), Key::Esc => serializer.serialize_str("Esc"), Key::Char(c) => serializer.serialize_char(*c), Key::F(n) => serializer.serialize_str(&format!("F{}", n)), Key::Alt(c) => serializer.serialize_str(&format!("M-{}", c)), Key::Ctrl(c) => serializer.serialize_str(&format!("C-{}", c)), v => Err(serde::ser::Error::custom(format!( "`{}` is not a valid key", v ))), } } }