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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
//! Utilities for keymap interpretation of keyboard input
//! This module provides an implementation for `wl_keyboard`
//! objects using `libxkbcommon` to interpret the keyboard input
//! given the user keymap.
//!
//! You simply need to provide an implementation to receive the
//! intepreted events, as described by the `Event` enum of this modules.
//!
//! Implementation of you `NewProxy<WlKeyboard>` can be done with the
//! `map_keyboard_auto` or the `map_keyboard_rmlvo` functions depending
//! on whether you wish to use the keymap provided by the server or a
//! specific one.

use std::env;
use std::ffi::CString;
use std::fs::File;
use std::os::raw::c_char;
use std::os::unix::ffi::OsStringExt;
use std::os::unix::io::{FromRawFd, RawFd};
use std::ptr;
use std::sync::{mpsc, Arc, Mutex};
use std::thread;
use std::time::{Duration, Instant};

use memmap::MmapOptions;

pub use wayland_client::protocol::wl_keyboard::KeyState;
use wayland_client::protocol::{wl_keyboard, wl_seat, wl_surface};
use wayland_client::Proxy;

use wayland_client::protocol::wl_seat::RequestsTrait;

use self::ffi::xkb_state_component;
use self::ffi::XKBCOMMON_HANDLE as XKBH;

mod ffi;
pub mod keysyms;

struct KbState {
    xkb_context: *mut ffi::xkb_context,
    xkb_keymap: *mut ffi::xkb_keymap,
    xkb_state: *mut ffi::xkb_state,
    xkb_compose_table: *mut ffi::xkb_compose_table,
    xkb_compose_state: *mut ffi::xkb_compose_state,
    mods_state: ModifiersState,
    locked: bool,
}

/// Represents the current state of the keyboard modifiers
///
/// Each field of this struct represents a modifier and is `true` if this modifier is active.
///
/// For some modifiers, this means that the key is currently pressed, others are toggled
/// (like caps lock).
#[derive(Copy, Clone, Debug, Default)]
pub struct ModifiersState {
    /// The "control" key
    pub ctrl: bool,
    /// The "alt" key
    pub alt: bool,
    /// The "shift" key
    pub shift: bool,
    /// The "Caps lock" key
    pub caps_lock: bool,
    /// The "logo" key
    ///
    /// Also known as the "windows" key on most keyboards
    pub logo: bool,
    /// The "Num lock" key
    pub num_lock: bool,
}

impl ModifiersState {
    fn new() -> ModifiersState {
        ModifiersState::default()
    }

    fn update_with(&mut self, state: *mut ffi::xkb_state) {
        self.ctrl = unsafe {
            (XKBH.xkb_state_mod_name_is_active)(
                state,
                ffi::XKB_MOD_NAME_CTRL.as_ptr() as *const c_char,
                xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
            ) > 0
        };
        self.alt = unsafe {
            (XKBH.xkb_state_mod_name_is_active)(
                state,
                ffi::XKB_MOD_NAME_ALT.as_ptr() as *const c_char,
                xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
            ) > 0
        };
        self.shift = unsafe {
            (XKBH.xkb_state_mod_name_is_active)(
                state,
                ffi::XKB_MOD_NAME_SHIFT.as_ptr() as *const c_char,
                xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
            ) > 0
        };
        self.caps_lock = unsafe {
            (XKBH.xkb_state_mod_name_is_active)(
                state,
                ffi::XKB_MOD_NAME_CAPS.as_ptr() as *const c_char,
                xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
            ) > 0
        };
        self.logo = unsafe {
            (XKBH.xkb_state_mod_name_is_active)(
                state,
                ffi::XKB_MOD_NAME_LOGO.as_ptr() as *const c_char,
                xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
            ) > 0
        };
        self.num_lock = unsafe {
            (XKBH.xkb_state_mod_name_is_active)(
                state,
                ffi::XKB_MOD_NAME_NUM.as_ptr() as *const c_char,
                xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
            ) > 0
        };
    }
}

unsafe impl Send for KbState {}

impl KbState {
    fn update_modifiers(
        &mut self,
        mods_depressed: u32,
        mods_latched: u32,
        mods_locked: u32,
        group: u32,
    ) {
        if !self.ready() {
            return;
        }
        let mask = unsafe {
            (XKBH.xkb_state_update_mask)(
                self.xkb_state,
                mods_depressed,
                mods_latched,
                mods_locked,
                0,
                0,
                group,
            )
        };
        if mask.contains(xkb_state_component::XKB_STATE_MODS_EFFECTIVE) {
            // effective value of mods have changed, we need to update our state
            self.mods_state.update_with(self.xkb_state);
        }
    }

    fn get_one_sym_raw(&mut self, keycode: u32) -> u32 {
        if !self.ready() {
            return 0;
        }
        unsafe { (XKBH.xkb_state_key_get_one_sym)(self.xkb_state, keycode + 8) }
    }

    fn get_utf8_raw(&mut self, keycode: u32) -> Option<String> {
        if !self.ready() {
            return None;
        }
        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 usize,
            );
        };
        // remove the final `\0`
        buffer.pop();
        // libxkbcommon will always provide valid UTF8
        Some(unsafe { String::from_utf8_unchecked(buffer) })
    }

    fn compose_feed(&mut self, keysym: u32) -> Option<ffi::xkb_compose_feed_result> {
        if !self.ready() || self.xkb_compose_state.is_null() {
            return None;
        }
        Some(unsafe { (XKBH.xkb_compose_state_feed)(self.xkb_compose_state, keysym) })
    }

    fn compose_status(&mut self) -> Option<ffi::xkb_compose_status> {
        if !self.ready() || self.xkb_compose_state.is_null() {
            return None;
        }
        Some(unsafe { (XKBH.xkb_compose_state_get_status)(self.xkb_compose_state) })
    }

    fn compose_get_utf8(&mut self) -> Option<String> {
        if !self.ready() || self.xkb_compose_state.is_null() {
            return None;
        }
        let size = unsafe {
            (XKBH.xkb_compose_state_get_utf8)(self.xkb_compose_state, 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_compose_state_get_utf8)(
                self.xkb_compose_state,
                buffer.as_mut_ptr() as *mut _,
                size as usize,
            );
        };
        // remove the final `\0`
        buffer.pop();
        // libxkbcommon will always provide valid UTF8
        Some(unsafe { String::from_utf8_unchecked(buffer) })
    }

    fn new() -> Result<KbState, Error> {
        let xkbh = match ffi::XKBCOMMON_OPTION.as_ref() {
            Some(h) => h,
            None => return Err(Error::XKBNotFound),
        };
        let xkb_context =
            unsafe { (xkbh.xkb_context_new)(ffi::xkb_context_flags::XKB_CONTEXT_NO_FLAGS) };
        if xkb_context.is_null() {
            return Err(Error::XKBNotFound);
        }

        let mut me = KbState {
            xkb_context,
            xkb_keymap: ptr::null_mut(),
            xkb_state: ptr::null_mut(),
            xkb_compose_table: ptr::null_mut(),
            xkb_compose_state: ptr::null_mut(),
            mods_state: ModifiersState::new(),
            locked: false,
        };

        unsafe {
            me.init_compose();
        }

        Ok(me)
    }

    unsafe fn init_compose(&mut self) {
        let locale = env::var_os("LC_ALL")
            .or_else(|| env::var_os("LC_CTYPE"))
            .or_else(|| env::var_os("LANG"))
            .unwrap_or_else(|| "C".into());
        let locale = CString::new(locale.into_vec()).unwrap();

        let compose_table = (XKBH.xkb_compose_table_new_from_locale)(
            self.xkb_context,
            locale.as_ptr(),
            ffi::xkb_compose_compile_flags::XKB_COMPOSE_COMPILE_NO_FLAGS,
        );

        if compose_table.is_null() {
            // init of compose table failed, continue without compose
            return;
        }

        let compose_state = (XKBH.xkb_compose_state_new)(
            compose_table,
            ffi::xkb_compose_state_flags::XKB_COMPOSE_STATE_NO_FLAGS,
        );

        if compose_state.is_null() {
            // init of compose state failed, continue without compose
            (XKBH.xkb_compose_table_unref)(compose_table);
            return;
        }

        self.xkb_compose_table = compose_table;
        self.xkb_compose_state = compose_state;
    }

    unsafe fn post_init(&mut self, xkb_keymap: *mut ffi::xkb_keymap) {
        let xkb_state = (XKBH.xkb_state_new)(xkb_keymap);
        self.xkb_keymap = xkb_keymap;
        self.xkb_state = xkb_state;
        self.mods_state.update_with(xkb_state);
    }

    unsafe fn de_init(&mut self) {
        (XKBH.xkb_state_unref)(self.xkb_state);
        self.xkb_state = ptr::null_mut();
        (XKBH.xkb_keymap_unref)(self.xkb_keymap);
        self.xkb_keymap = ptr::null_mut();
    }

    unsafe fn init_with_fd(&mut self, fd: RawFd, size: usize) {
        let map = MmapOptions::new()
            .len(size)
            .map(&File::from_raw_fd(fd))
            .unwrap();

        let xkb_keymap = (XKBH.xkb_keymap_new_from_string)(
            self.xkb_context,
            map.as_ptr() 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!("Received invalid keymap from compositor.");
        }

        self.post_init(xkb_keymap);
    }

    unsafe fn init_with_rmlvo(&mut self, names: ffi::xkb_rule_names) -> Result<(), Error> {
        let xkb_keymap = (XKBH.xkb_keymap_new_from_names)(
            self.xkb_context,
            &names,
            ffi::xkb_keymap_compile_flags::XKB_KEYMAP_COMPILE_NO_FLAGS,
        );

        if xkb_keymap.is_null() {
            return Err(Error::BadNames);
        }

        self.post_init(xkb_keymap);

        Ok(())
    }

    unsafe fn key_repeats(&mut self, xkb_keycode_t: ffi::xkb_keycode_t) -> bool {
        (XKBH.xkb_keymap_key_repeats)(self.xkb_keymap, xkb_keycode_t) == 1
    }

    #[inline]
    fn ready(&self) -> bool {
        !self.xkb_state.is_null()
    }
}

impl Drop for KbState {
    fn drop(&mut self) {
        unsafe {
            (XKBH.xkb_compose_state_unref)(self.xkb_compose_state);
            (XKBH.xkb_compose_table_unref)(self.xkb_compose_table);
            (XKBH.xkb_state_unref)(self.xkb_state);
            (XKBH.xkb_keymap_unref)(self.xkb_keymap);
            (XKBH.xkb_context_unref)(self.xkb_context);
        }
    }
}

/// Determines the behavior of key repetition
#[derive(PartialEq)]
pub enum KeyRepeatKind {
    /// keys will be repeated at a set rate and delay
    Fixed {
        /// the number of repetitions per second that should occur
        rate: u64,
        /// delay (in milliseconds) between a key press and the start of repetition
        delay: u64,
    },
    /// keys will be repeated at a rate and delay set by the wayland server
    System,
}

#[derive(Debug)]
/// An error that occurred while trying to initialize a mapped keyboard
pub enum Error {
    /// libxkbcommon is not available
    XKBNotFound,
    /// Provided RMLVO specified a keymap that would not be loaded
    BadNames,
}

/// The RMLVO description of a keymap
///
/// All fields are optional, and the system default
/// will be used if set to `None`.
pub struct RMLVO {
    /// The rules file to use
    pub rules: Option<String>,
    /// The keyboard model by which to interpret keycodes and LEDs
    pub model: Option<String>,
    /// A comma separated list of layouts (languages) to include in the keymap
    pub layout: Option<String>,
    /// A comma separated list of variants, one per layout, which may modify or
    /// augment the respective layout in various ways
    pub variant: Option<String>,
    /// A comma separated list of options, through which the user specifies
    /// non-layout related preferences, like which key combinations are
    /// used for switching layouts, or which key is the Compose key.
    pub options: Option<String>,
}

/// Events received from a mapped keyboard
pub enum Event<'a> {
    /// The keyboard focus has entered a surface
    Enter {
        /// serial number of the event
        serial: u32,
        /// surface that was entered
        surface: Proxy<wl_surface::WlSurface>,
        /// raw values of the currently pressed keys
        rawkeys: &'a [u32],
        /// interpreted symbols of the currently pressed keys
        keysyms: &'a [u32],
    },
    /// The keyboard focus has left a surface
    Leave {
        /// serial number of the event
        serial: u32,
        /// surface that was left
        surface: Proxy<wl_surface::WlSurface>,
    },
    /// A key event occurred
    Key {
        /// serial number of the event
        serial: u32,
        /// time at which the keypress occurred
        time: u32,
        /// raw value of the key
        rawkey: u32,
        /// interpreted symbol of the key
        keysym: u32,
        /// new state of the key
        state: KeyState,
        /// utf8 interpretation of the entered text
        ///
        /// will always be `None` on key release events
        utf8: Option<String>,
    },
    /// Repetition information advertising
    RepeatInfo {
        /// rate (in millisecond) at which the repetition should occur
        rate: i32,
        /// delay (in millisecond) between a key press and the start of repetition
        delay: i32,
    },
    /// The key modifiers have changed state
    Modifiers {
        /// current state of the modifiers
        modifiers: ModifiersState,
    },
}

/// An event sent at repeated intervals for certain keys determined by xkb_keymap_key_repeats
pub struct KeyRepeatEvent {
    /// time at which the keypress occurred
    pub time: u32,
    /// raw value of the key
    pub rawkey: u32,
    /// interpreted symbol of the key
    pub keysym: u32,
    /// utf8 interpretation of the entered text
    pub utf8: Option<String>,
}

/// Implement a keyboard to automatically detect the keymap
///
/// This requires you to provide an implementation to receive the events after they
/// have been interpreted with the keymap.
///
/// The keymap information will be loaded from the events sent by the compositor,
/// as such you need to call this method as soon as you have created the keyboard
/// to make sure this event does not get lost.
///
/// Returns an error if xkbcommon could not be initialized.
pub fn map_keyboard_auto<Impl>(
    seat: &Proxy<wl_seat::WlSeat>,
    implementation: Impl,
) -> Result<Proxy<wl_keyboard::WlKeyboard>, Error>
where
    for<'a> Impl: FnMut(Event<'a>, Proxy<wl_keyboard::WlKeyboard>) + Send + 'static,
{
    let state = match KbState::new() {
        Ok(s) => s,
        Err(e) => return Err(e),
    };
    Ok(implement_kbd(
        seat,
        state,
        implementation,
        None::<(_, fn(_, _))>,
    ))
}

/// Implement a keyboard for a predefined keymap
///
/// This requires you to provide an implementation to receive the events after they
/// have been interpreted with the keymap.
///
/// The keymap will be loaded from the provided RMLVO rules. Any keymap provided
/// by the compositor will be ignored.
///
/// Returns an error if xkbcommon could not be initialized or the RMLVO specification
/// contained invalid values.
pub fn map_keyboard_rmlvo<Impl>(
    seat: &Proxy<wl_seat::WlSeat>,
    rmlvo: RMLVO,
    implementation: Impl,
) -> Result<Proxy<wl_keyboard::WlKeyboard>, Error>
where
    for<'a> Impl: FnMut(Event<'a>, Proxy<wl_keyboard::WlKeyboard>) + Send + 'static,
{
    fn to_cstring(s: Option<String>) -> Result<Option<CString>, Error> {
        s.map_or(Ok(None), |s| CString::new(s).map(Option::Some))
            .map_err(|_| Error::BadNames)
    }

    fn init_state(rmlvo: RMLVO) -> Result<KbState, Error> {
        let mut state = KbState::new()?;

        let rules = to_cstring(rmlvo.rules)?;
        let model = to_cstring(rmlvo.model)?;
        let layout = to_cstring(rmlvo.layout)?;
        let variant = to_cstring(rmlvo.variant)?;
        let options = to_cstring(rmlvo.options)?;

        let xkb_names = ffi::xkb_rule_names {
            rules: rules.map_or(ptr::null(), |s| s.as_ptr()),
            model: model.map_or(ptr::null(), |s| s.as_ptr()),
            layout: layout.map_or(ptr::null(), |s| s.as_ptr()),
            variant: variant.map_or(ptr::null(), |s| s.as_ptr()),
            options: options.map_or(ptr::null(), |s| s.as_ptr()),
        };

        unsafe {
            state.init_with_rmlvo(xkb_names)?;
        }

        state.locked = true;
        Ok(state)
    }

    match init_state(rmlvo) {
        Ok(state) => Ok(implement_kbd(
            seat,
            state,
            implementation,
            None::<(_, fn(_, _))>,
        )),
        Err(error) => Err(error),
    }
}

fn implement_kbd<Impl, RepeatImpl>(
    seat: &Proxy<wl_seat::WlSeat>,
    state: KbState,
    mut event_impl: Impl,
    repeat: Option<(KeyRepeatKind, RepeatImpl)>,
) -> Proxy<wl_keyboard::WlKeyboard>
where
    for<'a> Impl: FnMut(Event<'a>, Proxy<wl_keyboard::WlKeyboard>) + Send + 'static,
    RepeatImpl: FnMut(KeyRepeatEvent, Proxy<wl_keyboard::WlKeyboard>) + Send + 'static,
{
    let safe_state = Arc::new(Mutex::new(state));
    let (key_repeat_kind, repeat_impl) = {
        if let Some(repeat) = repeat {
            (Some(repeat.0), Some(Arc::new(Mutex::new(repeat.1))))
        } else {
            (None, None)
        }
    };
    let kill_chan = Arc::new(Mutex::new(mpsc::channel::<()>()));
    let state_chan = Arc::new(Mutex::new(mpsc::channel::<()>()));
    let mut key_held: Option<u32> = None;
    let system_repeat_timing: Arc<Mutex<(u64, u64)>> = Arc::new(Mutex::new((30, 500)));

    seat.get_keyboard(|kbd| {
        kbd.implement(
            move |event: wl_keyboard::Event, proxy: Proxy<wl_keyboard::WlKeyboard>| {
                let mut state = safe_state.lock().unwrap();
                match event {
                    wl_keyboard::Event::Keymap { format, fd, size } => {
                        if state.locked {
                            // state is locked, ignore keymap updates
                            return;
                        }
                        if state.ready() {
                            // new keymap, we first deinit to free resources
                            unsafe {
                                state.de_init();
                            }
                        }
                        match format {
                            wl_keyboard::KeymapFormat::XkbV1 => unsafe {
                                state.init_with_fd(fd, size as usize);
                            },
                            wl_keyboard::KeymapFormat::NoKeymap => {
                                // TODO: how to handle this (hopefully never occuring) case?
                            }
                        }
                    }
                    wl_keyboard::Event::Enter {
                        serial,
                        surface,
                        keys,
                    } => {
                        let rawkeys: &[u32] = unsafe {
                            ::std::slice::from_raw_parts(
                                keys.as_ptr() as *const u32,
                                keys.len() / 4,
                            )
                        };
                        let keys: Vec<u32> =
                            rawkeys.iter().map(|k| state.get_one_sym_raw(*k)).collect();
                        event_impl(
                            Event::Enter {
                                serial,
                                surface,
                                rawkeys,
                                keysyms: &keys,
                            },
                            proxy,
                        );
                    }
                    wl_keyboard::Event::Leave { serial, surface } => {
                        if key_held.is_some() {
                            kill_chan.lock().unwrap().0.send(()).unwrap();
                            key_held = None;
                        }
                        event_impl(Event::Leave { serial, surface }, proxy);
                    }
                    wl_keyboard::Event::Key {
                        serial,
                        time,
                        key,
                        state: key_state,
                    } => {
                        // Get the values to generate a key event
                        let sym = state.get_one_sym_raw(key);
                        let utf8 = if key_state == wl_keyboard::KeyState::Pressed {
                            if state.compose_feed(sym)
                                != Some(ffi::xkb_compose_feed_result::XKB_COMPOSE_FEED_ACCEPTED)
                            {
                                None
                            } else if let Some(status) = state.compose_status() {
                                match status {
                                    ffi::xkb_compose_status::XKB_COMPOSE_COMPOSED => {
                                        state.compose_get_utf8()
                                    }
                                    ffi::xkb_compose_status::XKB_COMPOSE_NOTHING => {
                                        state.get_utf8_raw(key)
                                    }
                                    _ => None,
                                }
                            } else {
                                state.get_utf8_raw(key)
                            }
                        } else {
                            None
                        };

                        if key_state == wl_keyboard::KeyState::Pressed {
                            event_impl(
                                Event::Key {
                                    serial,
                                    time,
                                    rawkey: key,
                                    keysym: sym,
                                    state: key_state,
                                    utf8: utf8.clone(),
                                },
                                proxy.clone(),
                            );
                            if let Some(repeat_impl) = repeat_impl.clone() {
                                // Check with xkb if key is repeatable
                                if unsafe { state.key_repeats(key + 8) } {
                                    if key_held.is_some() {
                                        // If a key is being held then kill its repeat thread
                                        kill_chan.lock().unwrap().0.send(()).unwrap();
                                    }
                                    key_held = Some(key);
                                    // Clone variables for the thread
                                    let thread_kill_chan = kill_chan.clone();
                                    let thread_state_chan = state_chan.clone();
                                    let thread_state = safe_state.clone();
                                    let thread_repeat_impl = repeat_impl.clone();
                                    let repeat_timing = match key_repeat_kind {
                                        Some(KeyRepeatKind::Fixed { rate, delay, .. }) => {
                                            (rate, delay)
                                        }
                                        Some(KeyRepeatKind::System { .. }) => {
                                            *system_repeat_timing.lock().unwrap()
                                        }
                                        None => panic!(),
                                    };
                                    // Start thread to send key events
                                    thread::spawn(move || {
                                        let time_tracker = Instant::now();
                                        // Delay
                                        thread::sleep(Duration::from_millis(repeat_timing.1));
                                        match thread_kill_chan.lock().unwrap().1.try_recv() {
                                            Ok(_) | Err(mpsc::TryRecvError::Disconnected) => return,
                                            _ => {}
                                        }
                                        let mut thread_sym = sym;
                                        let mut thread_utf8 = utf8;

                                        loop {
                                            if thread_state_chan
                                                .lock()
                                                .unwrap()
                                                .1
                                                .try_recv()
                                                .is_ok()
                                            {
                                                let mut thread_state = thread_state.lock().unwrap();
                                                thread_sym = thread_state.get_one_sym_raw(key);
                                                thread_utf8 = thread_state.get_utf8_raw(key);
                                            }
                                            let elapsed_time = time_tracker.elapsed();
                                            (&mut *thread_repeat_impl.lock().unwrap())(
                                                KeyRepeatEvent {
                                                    time: time
                                                        + elapsed_time.as_secs() as u32 * 1000
                                                        + elapsed_time.subsec_nanos() / 1_000_000,
                                                    rawkey: key,
                                                    keysym: thread_sym,
                                                    utf8: thread_utf8.clone(),
                                                },
                                                proxy.clone(),
                                            );
                                            // Rate
                                            thread::sleep(
                                                Duration::from_secs(1) / repeat_timing.0 as u32,
                                            );
                                            match thread_kill_chan.lock().unwrap().1.try_recv() {
                                                Ok(_) | Err(mpsc::TryRecvError::Disconnected) => {
                                                    break;
                                                }
                                                _ => {}
                                            }
                                        }
                                    });
                                }
                            }
                        } else {
                            if key_held == Some(key) {
                                kill_chan.lock().unwrap().0.send(()).unwrap();
                                key_held = None;
                            }
                            event_impl(
                                Event::Key {
                                    serial,
                                    time,
                                    rawkey: key,
                                    keysym: sym,
                                    state: key_state,
                                    utf8: utf8.clone(),
                                },
                                proxy.clone(),
                            );
                        }
                    }
                    wl_keyboard::Event::Modifiers {
                        mods_depressed,
                        mods_latched,
                        mods_locked,
                        group,
                        ..
                    } => {
                        state.update_modifiers(mods_depressed, mods_latched, mods_locked, group);
                        event_impl(
                            Event::Modifiers {
                                modifiers: state.mods_state,
                            },
                            proxy,
                        );
                        if key_held.is_some() {
                            state_chan.lock().unwrap().0.send(()).unwrap();
                        }
                    }
                    wl_keyboard::Event::RepeatInfo { rate, delay } => {
                        event_impl(Event::RepeatInfo { rate, delay }, proxy);
                        *system_repeat_timing.lock().unwrap() = (rate as u64, delay as u64);
                    }
                }
            },
            (),
        )
    })
    .unwrap()
}

/// Implement a keyboard to automatically detect the keymap and send KeyRepeatEvents
/// at set intervals
///
/// This requires you to provide an implementation to receive the events after they
/// have been interpreted with the keymap. You must also provide an implementation to be called
/// when KeyRepeatEvents are sent at intervals set by the KeyRepeatKind argument, this
/// implementation can be called at anytime, independent of the dispatching of wayland events.
/// The dispatching of KeyRepeatEvents is handled with the spawning of threads.
///
/// The keymap information will be loaded from the events sent by the compositor,
/// as such you need to call this method as soon as you have created the keyboard
/// to make sure this event does not get lost.
///
/// Returns an error if xkbcommon could not be initialized.
pub fn map_keyboard_auto_with_repeat<Impl, RepeatImpl>(
    seat: &Proxy<wl_seat::WlSeat>,
    key_repeat_kind: KeyRepeatKind,
    implementation: Impl,
    repeat_implementation: RepeatImpl,
) -> Result<Proxy<wl_keyboard::WlKeyboard>, Error>
where
    for<'a> Impl: FnMut(Event<'a>, Proxy<wl_keyboard::WlKeyboard>) + Send + 'static,
    RepeatImpl: FnMut(KeyRepeatEvent, Proxy<wl_keyboard::WlKeyboard>) + Send + 'static,
{
    let state = match KbState::new() {
        Ok(s) => s,
        Err(e) => return Err(e),
    };
    Ok(implement_kbd(
        seat,
        state,
        implementation,
        Some((key_repeat_kind, repeat_implementation)),
    ))
}

/// Implement a keyboard for a predefined keymap and send KeyRepeatEvents at set
/// intervals
///
/// This requires you to provide an implementation to receive the events after they
/// have been interpreted with the keymap. You must also provide an implementation to be called
/// when KeyRepeatEvents are sent at intervals set by the KeyRepeatKind argument, this
/// implementation can be called at anytime, independent of the dispatching of wayland events.
/// The dispatching of KeyRepeatEvents is handled with the spawning of threads.
///
/// The keymap will be loaded from the provided RMLVO rules. Any keymap provided
/// by the compositor will be ignored.
///
/// Returns an error if xkbcommon could not be initialized or the RMLVO specification
/// contained invalid values.
pub fn map_keyboard_rmlvo_with_repeat<Impl, RepeatImpl>(
    seat: &Proxy<wl_seat::WlSeat>,
    rmlvo: RMLVO,
    key_repeat_kind: KeyRepeatKind,
    implementation: Impl,
    repeat_implementation: RepeatImpl,
) -> Result<Proxy<wl_keyboard::WlKeyboard>, Error>
where
    for<'a> Impl: FnMut(Event<'a>, Proxy<wl_keyboard::WlKeyboard>) + Send + 'static,
    RepeatImpl: FnMut(KeyRepeatEvent, Proxy<wl_keyboard::WlKeyboard>) + Send + 'static,
{
    fn to_cstring(s: Option<String>) -> Result<Option<CString>, Error> {
        s.map_or(Ok(None), |s| CString::new(s).map(Option::Some))
            .map_err(|_| Error::BadNames)
    }

    fn init_state(rmlvo: RMLVO) -> Result<KbState, Error> {
        let mut state = KbState::new()?;

        let rules = to_cstring(rmlvo.rules)?;
        let model = to_cstring(rmlvo.model)?;
        let layout = to_cstring(rmlvo.layout)?;
        let variant = to_cstring(rmlvo.variant)?;
        let options = to_cstring(rmlvo.options)?;

        let xkb_names = ffi::xkb_rule_names {
            rules: rules.map_or(ptr::null(), |s| s.as_ptr()),
            model: model.map_or(ptr::null(), |s| s.as_ptr()),
            layout: layout.map_or(ptr::null(), |s| s.as_ptr()),
            variant: variant.map_or(ptr::null(), |s| s.as_ptr()),
            options: options.map_or(ptr::null(), |s| s.as_ptr()),
        };

        unsafe {
            state.init_with_rmlvo(xkb_names)?;
        }

        state.locked = true;
        Ok(state)
    }

    match init_state(rmlvo) {
        Ok(state) => Ok(implement_kbd(
            seat,
            state,
            implementation,
            Some((key_repeat_kind, repeat_implementation)),
        )),
        Err(error) => Err(error),
    }
}