Final tweaks before release

Author: moparisthebest

Cargo.toml

@@ -3,7 +3,7 @@ name    = "rusty-keys"
 version = "0.0.1"
 
 authors = ["moparisthebest <admin@moparisthebest.com>"]
-license = "AGPLv3"
+license = "AGPL-3.0"
 
 description = "Linux keyboard mapper"
 repository  = "https://code.moparisthebest.com/moparisthebest/rusty-keys"

LICENSE.md

@@ -1,39 +1,54 @@
-uinput
+rusty-keys
 ======
-`/dev/uinput` high level wrapper.
+uinput level keyboard mapper for linux, with advanced caps lock and shift swapping behavior
+
+This is the only keymapper I am aware of capable of implementing this layout:  
+![Unix Programmer's Dvorak](https://www.moparisthebest.com/kbs/programmer-dvorak-NoSecondary-NumpadStandard-NoSwap-StandardNums-SwapAt-SwapPipe.svg)
+
+The Problem
+-----------
+If you ever have mapped keys on linux, you know that there is the console keymap (loadkeys) and the X keymap (setxkbmap)
+also things like SDL and Virtualbox grab the input directly and respect no maps.  Lastly I want to revert to QWERTY when
+holding ctrl so ctrl+c works just like normal, without remapping all programs to ctrl+j.  Linux keymaps cannot do this either.
+
+The Solution
+------------
+1. Grab a keyboard device directly so only we can read events from it.
+2. Create a new keyboard input device with uinput, this is identical to any other keyboard device to anything running on the box.
+3. Read input_events from real device, map them, send them to our created device.
+
+This solution is what rusty-keys implements, it works in ttys, in X, in virtualbox even running windows or whatever,
+on SDL games, it will work literally everywhere, because rusty-keys just creates a regular keyboard.
+
+How to run
+----------
+
+When ran, it will read a keymap.toml file from your current working directory, refer to example and tweak to suit.
 
-Example
--------
-The following example writes `hello world`.
-
-```rust
-extern crate uinput;
-use uinput::event::keyboard;
-
-use std::thread;
-use std::time::Duration;
-
-fn main() {
-	let mut device = uinput::default().unwrap()
-		.name("test").unwrap()
-		.event(uinput::event::Keyboard::All).unwrap()
-		.create().unwrap();
-
-	thread::sleep(Duration::from_secs(1));
-
-	device.click(&keyboard::Key::H).unwrap();
-	device.click(&keyboard::Key::E).unwrap();
-	device.click(&keyboard::Key::L).unwrap();
-	device.click(&keyboard::Key::L).unwrap();
-	device.click(&keyboard::Key::O).unwrap();
-	device.click(&keyboard::Key::Space).unwrap();
-	device.click(&keyboard::Key::W).unwrap();
-	device.click(&keyboard::Key::O).unwrap();
-	device.click(&keyboard::Key::R).unwrap();
-	device.click(&keyboard::Key::L).unwrap();
-	device.click(&keyboard::Key::D).unwrap();
-	device.click(&keyboard::Key::Enter).unwrap();
-
-	device.synchronize().unwrap();
-}
 ```
+Usage: rusty-keys [options]
+
+Options:
+    -h, --help          prints this help message
+    -v, --version       prints the version
+    -d, --device DEVICE specify the keyboard input device file
+    -c, --config FILE   specify the keymap config file to use
+```
+
+with only one keyboard attached:  
+`rusty-keys`
+
+with multiple keyboards, currently you must specify one:  
+`rusty-keys -d /dev/input/event0`
+
+find all eligible keyboard devices like:  
+`grep -E 'Handlers|EV' /proc/bus/input/devices | grep -B1 120013 | grep -Eo event[0-9]+`
+
+License
+-------
+AGPLv3 for now, message me if you have a problem with this
+
+Notes
+-----
+Technically this is a re-implementation of a [previous](https://code.moparisthebest.com/moparisthebest/uinput-mapper/src/master/uinputmapper/keymapper.py) [python](https://code.moparisthebest.com/moparisthebest/uinput-mapper/src/master/keymaps/dvorak.py) [program](https://code.moparisthebest.com/moparisthebest/uinput-mapper/src/master/input-read#L151)
+I had been using for 3 years previously.

README.md

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+
 # pressing all of these keys along with a number key representing the index of keymaps changes the layout
 # ie, in this case pressing both and 0 would go QWERTY, while both and 1 would go dvorak
 switch_layout_keys = ['LEFTSHIFT','RIGHTSHIFT']
@@ -9,18 +9,9 @@ revert_default_key = 'LEFTCTRL'
 revert_keymap_index = 0
 
 # this is the default index to use when the program first starts
-# in this case, 2 means modified Progammer Dvorak
+# in this case, 2 means Unix Programmer Dvorak
 default_keymap_index = 2
 
-# these are keys that caps_lock doesn't modify by default, but that you would like it to, affects all keymaps
-caps_lock_modify = """
-    GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC,                             PSLS,PAST,PMNS,
-                                                           LBRC,RBRC,BSLS,                        P7,  P8,  P9,
-                                                      SCLN,QUOT,                                  P4,  P5,  P6,  PPLS,
-                                            COMM,DOT, SLSH,                                       P1,  P2,  P3,
-                                                                                                  P0,       PDOT
-    """
-
 # these are the keymaps available, you can add as many as you want or re-order them, just be aware the mapping is
 # always done from the first one to all subsequent ones, so you probably want to leave QWERTY or similar up top
 keymaps = [
@@ -43,7 +34,7 @@ keymaps = [
     LSFT,SCLN,Q,   J,   K,   X,   B,   M,   W,   V,   Z,             RSFT,          UP,           P1,  P2,  P3,
     LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, RCTL,     LEFT,DOWN,RGHT,    P0,       PDOT,PENT
     """,
-    # Unix Dvorak Programmer Dvorak - for unix developers who are switching from dvorak
+    # Unix Programmer Dvorak - for unix developers who are switching from dvorak
     # https://www.moparisthebest.com/kbs/programmer-dvorak-NoSecondary-NumpadStandard-NoSwap-StandardNums-SwapAt-SwapPipe.svg
     """
     ESC,      F1,    F2,     F3,      F4,      F5,   F6,    F7,   F8,   F9,     F10,    F11,   F12,                 PSCR,SLCK,BRK,

keymap.toml

@@ -79,7 +79,7 @@ impl KeyMaps {
             panic!("default_keymap_index ({}) and revert_keymap_index ({}) must be less than keymaps length ({}),", config.default_keymap_index, config.revert_keymap_index, config.keymaps.len());
         }
         let base_keymap = parse_keymap_numeric(key_map, &config.keymaps[0]);
-        println!("base_keymap      : {:?}", base_keymap);
+        //println!("base_keymap      : {:?}", base_keymap);
         let mut keymaps: Vec<Box<KeyMapper>> = vec!(Box::new(NOOP)); // todo: can we share the box?
         let mut keymap_index_keys: HashMap<u16, usize> = HashMap::new();
         for (x, v) in config.keymaps.iter().enumerate() {
@@ -363,7 +363,6 @@ pub struct KeymapConfig {
     revert_default_key: String,
     revert_keymap_index: usize,
     default_keymap_index: usize,
-    caps_lock_modify: String,
     keymaps: Vec<String>
 }
 

src/keymapper.rs

@@ -11,8 +11,8 @@ use rusty_keys::KeyMaps;
 use ffi::*;
 use libc::{c_int, input_event};
 
-use std::thread;
-use std::time::Duration;
+//use std::thread;
+//use std::time::Duration;
 
 use std::process::{exit, Command};
 use std::fs::File;
@@ -30,18 +30,17 @@ const EV_KEY_U16: u16 = EV_KEY as u16;
 #[derive(Debug)]
 struct Config {
     device_file: String,
-    log_file: String
+    config_file: String
 }
 
 impl Config {
-    fn new(device_file: String, log_file: String) -> Self {
-        Config { device_file: device_file, log_file: log_file }
+    fn new(device_file: String, config_file: String) -> Self {
+        Config { device_file: device_file, config_file: config_file }
     }
 }
 
 fn main() {
     let key_map = KeyMaps::key_map();
-
     //println!("key_map: {:?}", key_map);
 
     let device = rusty_keys::default().expect("1")
@@ -50,23 +49,17 @@ fn main() {
         //.event(uinput::event::Keyboard::All).unwrap()
         .create().expect("4");
 
-    let mut key_map = KeyMaps::from_cfg(&key_map, "keymap.toml");
-    //println!("keymaps: {:?}", keymaps);
-
-    //let mut key_map = KeyMap::new();
-    //key_map.map(KEY_A, KEY_B);
-
-    thread::sleep(Duration::from_secs(1));
-
-    //device.click(EV_KEY, KEY_H).unwrap();
-    //device.synchronize().unwrap();
+    //thread::sleep(Duration::from_secs(1));
 
     let config = parse_args();
-    println!("Config: {:?}", config);
+    //println!("Config: {:?}", config);
 
     let mut input_device = InputDevice::open(&config.device_file);
     input_device.grab();
 
+    let mut key_map = KeyMaps::from_cfg(&key_map, config.config_file);
+    //println!("keymaps: {:?}", keymaps);
+
     loop {
         let event = input_device.read_event();
         if event.type_ == EV_KEY_U16 {
@@ -94,8 +87,8 @@ fn parse_args() -> Config {
     let mut opts = Options::new();
     opts.optflag("h", "help", "prints this help message");
     opts.optflag("v", "version", "prints the version");
-    opts.optopt("d", "device", "specify the device file", "DEVICE");
-    opts.optopt("f", "file", "specify the file to log to", "FILE");
+    opts.optopt("d", "device", "specify the keyboard input device file", "DEVICE");
+    opts.optopt("c", "config", "specify the keymap config file to use", "FILE");
 
     let matches = opts.parse(&args[1..]).unwrap_or_else(|e| panic!("{}", e));
     if matches.opt_present("h") {
@@ -104,14 +97,14 @@ fn parse_args() -> Config {
     }
 
     if matches.opt_present("v") {
-        println!("{}", VERSION);
+        println!("rusty-keys {}", VERSION);
         exit(0);
     }
 
     let device_file = matches.opt_str("d").unwrap_or_else(|| get_default_device());
-    let log_file = matches.opt_str("f").unwrap_or("keys.log".to_owned());
+    let config_file = matches.opt_str("c").unwrap_or("keymap.toml".to_owned());
 
-    Config::new(device_file, log_file)
+    Config::new(device_file, config_file)
 }
 
 fn get_default_device() -> String {