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
181
182
183
184
185
///! This is a very simple keybinder to functions using xlib.
///! For now it does not support binding same key with different modifiers
///! Callbacks used as simple functions, to execute it in paralell.
extern crate x11;
extern crate fnv;

use std::sync::RwLock;
use std::thread;

use fnv::FnvHashMap;
use x11::xlib;

mod raw;
use raw::next_event;

/// X11 keysyms, used as keycodes
/// Prefer lowercase letters
pub use x11::keysym;

/// Start grabbing keys and executing callbacks
pub fn start(mut storage: CallbackStorage) {
    let mut event = xlib::XEvent { pad: [0; 24] };
    loop {
        unsafe {
            next_event(storage.get_display_mut(), &mut event);
        }
        storage.dispatch(&mut event);
    }
}

/// Start, grabbing keys and executing callbacks in separate thread, returns `JoinHandle` for this thread.
/// Shortcut for `std::thread::spawn(|| bindkey::start())`.
pub fn start_async(storage: CallbackStorage) -> thread::JoinHandle<()> {
    thread::spawn(move || start(storage))
}

#[repr(u32)]
#[derive(Debug, PartialOrd, Ord, PartialEq, Eq, Hash, Clone, Copy)]
pub enum Modifier {
    Shift = xlib::ShiftMask,
    CapsLock = xlib::LockMask,
    Ctrl = xlib::ControlMask,
    Alt = xlib::Mod1Mask,
    NumLock = xlib::Mod2Mask,
    ScrollLock = xlib::Mod3Mask,
    Window = xlib::Mod4Mask,
    Mod5 = xlib::Mod5Mask,
}

#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
pub enum TriggerOn {
    Press,
    Release,
}

#[derive(PartialEq, Eq, Hash, Debug, Clone)]
pub struct HotKey {
    pub key: xlib::KeySym,
    pub modifiers: Vec<Modifier>,
    pub trigger: TriggerOn,
}

impl HotKey {
    pub fn new(key: u32, mut modifiers: Vec<Modifier>, trigger: TriggerOn) -> Self {
        modifiers.sort();
        modifiers.dedup();

        HotKey {
            key: key as xlib::KeySym,
            modifiers: modifiers,
            trigger: trigger,
        }
    }
}


pub type Callback = fn() -> ();
type KeyMapStorage = RwLock<FnvHashMap<xlib::KeySym, Vec<Callback>>>;

#[derive(Debug)]
pub struct CallbackStorage {
    released_storage: KeyMapStorage,
    pressed_storage: KeyMapStorage,
    display: *mut xlib::Display,
    root: xlib::Window,
}

impl Default for CallbackStorage {
    fn default() -> Self {
        Self::new()
    }
}

impl CallbackStorage {
    pub fn new() -> Self {
        unsafe {
            let display = raw::get_display();
            let root = raw::get_root(display);

            CallbackStorage {
                released_storage: RwLock::new(FnvHashMap::default()),
                pressed_storage: RwLock::new(FnvHashMap::default()),
                display: display,
                root: root,
            }
        }
    }

    /// Add callback to execute on new thread when key is pressed.
    pub fn add(&mut self, key: &HotKey, callback: Callback) {
        use std::collections::hash_map::Entry;
        // select storage
        let mut storage = if key.trigger == TriggerOn::Press {
            self.pressed_storage.write().unwrap()
        } else {
            self.released_storage.write().unwrap()
        };

        let entry = storage.entry(key.key);
        if let Entry::Vacant(_) = entry {
            // if first registered callback grab this key.
            unsafe {
                raw::grab(self.display, self.root, key);
            }
        }
        // add callback
        entry.or_insert_with(Vec::new).push(callback);
    }

    /// Remove all callbacks atached to this key.
    pub fn remove_all(&mut self, key: &HotKey) {
        // select storage
        let mut storage = if key.trigger == TriggerOn::Press {
            self.pressed_storage.write().unwrap()
        } else {
            self.released_storage.write().unwrap()
        };

        if storage.remove(&key.key).is_some() {
            // ungrab key if it was present
            raw::ugrab(self.display, self.root, key);
        }
    }

    #[inline]
    fn dispatch(&self, event: &mut xlib::XEvent) {
        let event_type = event.get_type();

        if event_type == xlib::KeyPress {
            self.trigger_press(event);
        } else if event_type == xlib::KeyRelease {
            self.trigger_release(event);
        }
    }

    #[inline]
    fn trigger_press(&self, event: &mut xlib::XEvent) {
        let keysym = raw::get_keysym(event.as_mut());

        if let Some(callbacks) = self.pressed_storage.read().unwrap().get(&keysym) {
            for callback in callbacks {
                let callback = callback.to_owned();
                thread::spawn(move || { callback(); });
            }
        }
    }

    #[inline]
    fn trigger_release(&self, event: &mut xlib::XEvent) {
        let keysym = raw::get_keysym(event.as_mut());

        if let Some(callbacks) = self.released_storage.read().unwrap().get(&keysym) {
            for callback in callbacks {
                let callback = callback.to_owned();
                thread::spawn(move || { callback(); });
            }
        }
    }

    unsafe fn get_display_mut(&mut self) -> *mut xlib::Display {
        self.display
    }
}

unsafe impl Send for CallbackStorage {}