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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
use wayland::core::Serial;
use wayland::core::compositor::SurfaceId;
use wayland::core::seat::{Keyboard, KeyState, KeyboardId};

use libc::size_t;

use std::ptr;
use std::sync::{Arc, Mutex};

use mmap::{MemoryMap, MapOption};

use ffi;
use ffi::XKBCOMMON_HANDLE as XKBH;

pub struct KbState {
    xkb_contex: *mut ffi::xkb_context,
    xkb_keymap: *mut ffi::xkb_keymap,
    xkb_state: *mut ffi::xkb_state
}

#[doc(hidden)]
unsafe impl Send for KbState {}

impl KbState {
    fn update_modifiers(&mut self, mods_depressed: u32, mods_latched: u32, mods_locked: u32, group: u32) {
        unsafe {
            (XKBH.xkb_state_update_mask)(
                self.xkb_state, mods_depressed, mods_latched, mods_locked, 0, 0, group);
        }
    }

    /// Tries to match this keycode as a key symbol according to current keyboard state.
    ///
    /// Returns 0 if not possible (meaning that this keycode maps to more than one key symbol).
    pub fn get_one_sym(&self, keycode: u32) -> u32 {
        unsafe { 
            (XKBH.xkb_state_key_get_one_sym)(
                self.xkb_state, keycode + 8)
        }
    }

    /// Tries to retrieve the generated keycode as an UTF8 sequence
    pub fn get_utf8(&self, keycode: u32) -> Option<String> {
        let size = unsafe {
            (XKBH.xkb_state_key_get_utf8)(self.xkb_state, keycode + 8, ptr::null_mut(), 0)
        } + 1;
        if size <= 1 { return None };
        let mut buffer = Vec::with_capacity(size as usize);
        unsafe {
            buffer.set_len(size as usize);
            (XKBH.xkb_state_key_get_utf8)(
                self.xkb_state, keycode + 8, buffer.as_mut_ptr() as *mut _, size as size_t);
        };
        // remove the final `\0`
        buffer.pop();
        // libxkbcommon will always provide valid UTF8
        Some(String::from_utf8(buffer).unwrap())
    }
}

impl Drop for KbState {
    fn drop(&mut self) {
        unsafe {
            (XKBH.xkb_state_unref)(self.xkb_state);
            (XKBH.xkb_keymap_unref)(self.xkb_keymap);
            (XKBH.xkb_context_unref)(self.xkb_contex);
        }
    }
}

/// A wayland keyboard mapped to its keymap
pub struct MappedKeyboard {
    wkb: Keyboard,
    _state: Arc<Mutex<KbState>>,
    keyaction: Arc<Mutex<Box<Fn(&KbState, Serial, KeyboardId, u32, u32, KeyState) + Send + Sync + 'static>>>
}

impl MappedKeyboard {
    /// Creates a mapped keyboard from a regular wayland keyboard.
    ///
    /// Make sure the initialization phase of the keyboard is finished
    /// (with `Display::sync_roundtrip()` for example), otherwise the
    /// keymap won't be available.
    ///
    /// Will return Err() and hand back the untouched keyboard if 
    /// `libxkbcommon.so` is not available or the keyboard had no
    /// associated keymap.
    pub fn new(mut keyboard: Keyboard) -> Result<MappedKeyboard, Keyboard> {
        let xkbh = match ffi::XKBCOMMON_OPTION.as_ref() {
            Some(h) => h,
            None => return Err(keyboard)
        };
        let xkb_context = unsafe {
            (xkbh.xkb_context_new)(ffi::xkb_context_flags::XKB_CONTEXT_NO_FLAGS)
        };
        if xkb_context.is_null() { return Err(keyboard) }
        let (fd, size) = match keyboard.keymap_fd() {
            Some((fd, size)) => (fd, size),
            None => return Err(keyboard)
        };

        let map = MemoryMap::new(
            size as usize,
            &[MapOption::MapReadable, MapOption::MapFd(fd)]
        ).unwrap();

        let xkb_keymap = {
            unsafe {
                (xkbh.xkb_keymap_new_from_string)(
                    xkb_context,
                    map.data() as *const _,
                    ffi::xkb_keymap_format::XKB_KEYMAP_FORMAT_TEXT_V1,
                    ffi::xkb_keymap_compile_flags::XKB_KEYMAP_COMPILE_NO_FLAGS
                )
            }
        };

        if xkb_keymap.is_null() {
            panic!("Failed to load keymap!");
        }

        let xkb_state = unsafe {
            (xkbh.xkb_state_new)(xkb_keymap)
        };

        let state = Arc::new(Mutex::new(KbState {
            xkb_contex: xkb_context,
            xkb_keymap : xkb_keymap,
            xkb_state: xkb_state
        }));

        let sma_state = state.clone();
        keyboard.set_modifiers_action(move |_, _, mods_d, mods_la, mods_lo, group| {
            sma_state.lock().unwrap().update_modifiers(mods_d, mods_la, mods_lo, group)
        });

        let keyaction = Arc::new(Mutex::new(
            Box::new(move |_: &_, _, _, _, _, _|{}) as Box<Fn(&KbState, Serial, KeyboardId, u32, u32, KeyState) + Send + Sync + 'static>
        ));
        let ska_action = keyaction.clone();
        let ska_state  = state.clone();
        keyboard.set_key_action(move |kbid, serial, time, keycode, keystate| {
            let state = ska_state.lock().unwrap();
            let action = ska_action.lock().unwrap();
            action(&*state, serial, kbid, time, keycode, keystate);
        });

        Ok(MappedKeyboard {
            wkb: keyboard,
            _state: state,
            keyaction: keyaction
        })
    }

    /// Releases the keyboard from this MappedKeyboard and returns it.
    pub fn release(mut self) -> Keyboard {
        self.wkb.set_key_action(move |_, _, _, _, _| {});
        self.wkb.set_modifiers_action(move |_, _, _, _, _, _| {});
        self.wkb
    }

    /// Sets the action to perform when a key is pressed or released.
    ///
    /// The closure is given an handle to a `KbState` that will allow to
    /// translate the keycode into a key symbol or an UTF8 sequence.
    ///
    /// arguments are:
    ///
    /// - KbState handle
    /// - KeyboardId of the event
    /// - time of the event
    /// - raw keycode
    /// - new KeyState
    pub fn set_key_action<F>(&self, f: F)
        where F: Fn(&KbState, Serial, KeyboardId, u32, u32, KeyState) + Send + Sync + 'static
    {
        let mut action = self.keyaction.lock().unwrap();
        *action = Box::new(f);
    }

    /// Defines the action to be executed when a surface gains keyboard focus.
    ///
    /// Arguments are:
    ///
    /// - Id of the keyboard
    /// - Id of the surface
    /// - a slice of the keycodes of the currenlty pressed keys
    pub fn set_enter_action<F>(&mut self, f: F)
        where F: Fn(KeyboardId, Serial, SurfaceId, &[u32]) + 'static + Send + Sync
    {
        self.wkb.set_enter_action(f);
    }

    /// Defines the action to be executed when a surface loses keyboard focus.
    ///
    /// This event is generated *before* the `enter` event is generated for the new
    /// surface the focus goes to.
    ///
    /// Arguments are:
    ///
    /// - Id of the keyboard
    /// - Id of the surface
    pub fn set_leave_action<F>(&mut self, f: F)
        where F: Fn(KeyboardId, Serial, SurfaceId) + 'static + Send + Sync
    {
        self.wkb.set_leave_action(f);
    }

}