/*! State of the emulated keyboard and keys. * Regards the keyboard as if it was composed of switches. */ use std::collections::HashMap; use std::fmt; use std::io; use std::string::FromUtf8Error; use ::action::Action; use std::io::Write; use std::iter::{ FromIterator, IntoIterator }; use ::util::CloneOwned; /// Gathers stuff defined in C or called by C pub mod c { use super::*; use ::util::c; pub type CKeyState = c::Wrapped; // The following defined in Rust. TODO: wrap naked pointers to Rust data inside RefCells to prevent multiple writers #[no_mangle] pub extern "C" fn squeek_key_is_pressed(key: CKeyState) -> u32 { //let key = unsafe { Rc::from_raw(key.0) }; return key.clone_owned().pressed as u32; } #[no_mangle] pub extern "C" fn squeek_key_is_locked(key: CKeyState) -> u32 { return key.clone_owned().locked as u32; } } #[derive(Debug, Clone, Copy)] pub enum PressType { Released = 0, Pressed = 1, } #[derive(Debug, Clone)] pub struct KeyState { pub pressed: PressType, pub locked: bool, /// A cache of raw keycodes derived from Action::Sumbit given a keymap pub keycodes: Vec, /// Static description of what the key does when pressed or released pub action: Action, } /// Generates a mapping where each key gets a keycode, starting from 8 pub fn generate_keycodes<'a, C: IntoIterator>( key_names: C ) -> HashMap { HashMap::from_iter( key_names.into_iter() .map(|name| String::from(name)) .zip(8..) ) } #[derive(Debug)] pub enum FormattingError { Utf(FromUtf8Error), Format(io::Error), } impl fmt::Display for FormattingError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { FormattingError::Utf(e) => write!(f, "UTF: {}", e), FormattingError::Format(e) => write!(f, "Format: {}", e), } } } impl From for FormattingError { fn from(e: io::Error) -> Self { FormattingError::Format(e) } } /// Generates a de-facto single level keymap. TODO: actually drop second level pub fn generate_keymap( keystates: &HashMap:: ) -> Result { let mut buf: Vec = Vec::new(); writeln!( buf, "xkb_keymap {{ xkb_keycodes \"squeekboard\" {{ minimum = 8; maximum = 255;" )?; for (name, state) in keystates.iter() { if let Action::Submit { text: _, keys } = &state.action { if let 0 = keys.len() { eprintln!("Key {} has no keysyms", name); }; for (named_keysym, keycode) in keys.iter().zip(&state.keycodes) { write!( buf, " <{}> = {};", named_keysym.0, keycode, )?; } } } writeln!( buf, " }}; xkb_symbols \"squeekboard\" {{ name[Group1] = \"Letters\"; name[Group2] = \"Numbers/Symbols\";" )?; for (name, state) in keystates.iter() { if let Action::Submit { text: _, keys } = &state.action { for keysym in keys.iter() { write!( buf, " key <{}> {{ [ {0} ] }};", keysym.0, )?; } } } writeln!( buf, " }}; xkb_types \"squeekboard\" {{ type \"TWO_LEVEL\" {{ modifiers = Shift; map[Shift] = Level2; level_name[Level1] = \"Base\"; level_name[Level2] = \"Shift\"; }}; }}; xkb_compatibility \"squeekboard\" {{ }}; }};" )?; //println!("{}", String::from_utf8(buf.clone()).unwrap()); String::from_utf8(buf).map_err(FormattingError::Utf) } #[cfg(test)] mod tests { use super::*; use xkbcommon::xkb; use ::action::KeySym; #[test] fn test_keymap_multi() { let context = xkb::Context::new(xkb::CONTEXT_NO_FLAGS); let keymap_str = generate_keymap(&hashmap!{ "ac".into() => KeyState { action: Action::Submit { text: None, keys: vec!(KeySym("a".into()), KeySym("c".into())), }, keycodes: vec!(9, 10), locked: false, pressed: PressType::Released, }, }).unwrap(); let keymap = xkb::Keymap::new_from_string( &context, keymap_str.clone(), xkb::KEYMAP_FORMAT_TEXT_V1, xkb::KEYMAP_COMPILE_NO_FLAGS, ).expect("Failed to create keymap"); let state = xkb::State::new(&keymap); assert_eq!(state.key_get_one_sym(9), xkb::KEY_a); assert_eq!(state.key_get_one_sym(10), xkb::KEY_c); } }