lamco-rdp-input 0.1.5

RDP input event translation - keyboard scancodes to evdev keycodes, mouse handling, multi-monitor coordinates, by Lamco Development
Documentation
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
//! Keyboard Event Handling
//!
//! Handles keyboard events with scancode translation, modifier tracking,
//! and keyboard layout support.

use crate::error::Result;
use crate::mapper::ScancodeMapper;
use std::collections::HashSet;
use std::time::Instant;
use tracing::debug;

/// Keyboard modifiers
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub struct KeyModifiers {
    /// Left or right Shift pressed
    pub shift: bool,
    /// Left or right Ctrl pressed
    pub ctrl: bool,
    /// Left or right Alt pressed
    pub alt: bool,
    /// Left or right Meta/Super/Windows key pressed
    pub meta: bool,
    /// Caps Lock active
    pub caps_lock: bool,
    /// Num Lock active
    pub num_lock: bool,
    /// Scroll Lock active
    pub scroll_lock: bool,
}

/// Keyboard event types
#[derive(Debug, Clone)]
pub enum KeyboardEvent {
    /// Key pressed
    KeyDown {
        /// Linux evdev keycode
        keycode: u32,
        /// RDP scancode
        scancode: u16,
        /// Current modifiers
        modifiers: KeyModifiers,
        /// Event timestamp
        timestamp: Instant,
    },

    /// Key released
    KeyUp {
        /// Linux evdev keycode
        keycode: u32,
        /// RDP scancode
        scancode: u16,
        /// Current modifiers
        modifiers: KeyModifiers,
        /// Event timestamp
        timestamp: Instant,
    },

    /// Key repeat
    KeyRepeat {
        /// Linux evdev keycode
        keycode: u32,
        /// RDP scancode
        scancode: u16,
        /// Current modifiers
        modifiers: KeyModifiers,
        /// Event timestamp
        timestamp: Instant,
    },
}

/// Keyboard event handler
pub struct KeyboardHandler {
    /// Scancode mapper
    mapper: ScancodeMapper,

    /// Currently pressed keys
    pressed_keys: HashSet<u32>,

    /// Current modifiers
    modifiers: KeyModifiers,

    /// Last event timestamp for each key (for repeat detection)
    last_key_times: std::collections::HashMap<u32, Instant>,

    /// Key repeat delay (milliseconds)
    repeat_delay_ms: u64,

    /// Key repeat rate (milliseconds between repeats)
    repeat_rate_ms: u64,
}

impl KeyboardHandler {
    /// Create a new keyboard handler
    pub fn new() -> Self {
        Self {
            mapper: ScancodeMapper::new(),
            pressed_keys: HashSet::new(),
            modifiers: KeyModifiers::default(),
            last_key_times: std::collections::HashMap::new(),
            repeat_delay_ms: 500,
            repeat_rate_ms: 33,
        }
    }

    /// Process key down event from RDP
    pub fn handle_key_down(&mut self, scancode: u16, extended: bool, e1_prefix: bool) -> Result<KeyboardEvent> {
        // Translate scancode to keycode
        let keycode = self.mapper.translate_scancode(scancode as u32, extended, e1_prefix)?;

        let timestamp = Instant::now();

        // Check if this is a repeat (key already pressed)
        let is_repeat = self.pressed_keys.contains(&keycode);

        if is_repeat {
            // Check repeat timing
            if let Some(last_time) = self.last_key_times.get(&keycode) {
                let elapsed = timestamp.duration_since(*last_time).as_millis() as u64;
                if elapsed < self.repeat_rate_ms {
                    // Too soon for repeat, return repeat event to maintain state
                    debug!("Key repeat within rate limit: keycode {}", keycode);
                    return Ok(KeyboardEvent::KeyRepeat {
                        keycode,
                        scancode,
                        modifiers: self.modifiers,
                        timestamp,
                    });
                }
            }
        }

        // Update pressed keys
        self.pressed_keys.insert(keycode);
        self.last_key_times.insert(keycode, timestamp);

        // Update modifiers
        self.update_modifiers(keycode, true);

        debug!(
            "Key down: scancode=0x{:04X}, keycode={}, modifiers={:?}",
            scancode, keycode, self.modifiers
        );

        if is_repeat {
            Ok(KeyboardEvent::KeyRepeat {
                keycode,
                scancode,
                modifiers: self.modifiers,
                timestamp,
            })
        } else {
            Ok(KeyboardEvent::KeyDown {
                keycode,
                scancode,
                modifiers: self.modifiers,
                timestamp,
            })
        }
    }

    /// Process key up event from RDP
    pub fn handle_key_up(&mut self, scancode: u16, extended: bool, e1_prefix: bool) -> Result<KeyboardEvent> {
        // Translate scancode to keycode
        let keycode = self.mapper.translate_scancode(scancode as u32, extended, e1_prefix)?;

        let timestamp = Instant::now();

        // Remove from pressed keys
        self.pressed_keys.remove(&keycode);
        self.last_key_times.remove(&keycode);

        // Update modifiers
        self.update_modifiers(keycode, false);

        debug!(
            "Key up: scancode=0x{:04X}, keycode={}, modifiers={:?}",
            scancode, keycode, self.modifiers
        );

        Ok(KeyboardEvent::KeyUp {
            keycode,
            scancode,
            modifiers: self.modifiers,
            timestamp,
        })
    }

    /// Update modifier states based on key event
    fn update_modifiers(&mut self, keycode: u32, pressed: bool) {
        #[allow(clippy::wildcard_imports)]
        use crate::mapper::keycodes::*;

        match keycode {
            KEY_LEFTSHIFT | KEY_RIGHTSHIFT => {
                if pressed {
                    self.modifiers.shift = true;
                } else {
                    // Only clear if neither shift is pressed
                    self.modifiers.shift = self.is_key_pressed(KEY_LEFTSHIFT) || self.is_key_pressed(KEY_RIGHTSHIFT);
                }
            }
            KEY_LEFTCTRL | KEY_RIGHTCTRL => {
                if pressed {
                    self.modifiers.ctrl = true;
                } else {
                    self.modifiers.ctrl = self.is_key_pressed(KEY_LEFTCTRL) || self.is_key_pressed(KEY_RIGHTCTRL);
                }
            }
            KEY_LEFTALT | KEY_RIGHTALT => {
                if pressed {
                    self.modifiers.alt = true;
                } else {
                    self.modifiers.alt = self.is_key_pressed(KEY_LEFTALT) || self.is_key_pressed(KEY_RIGHTALT);
                }
            }
            KEY_LEFTMETA | KEY_RIGHTMETA => {
                if pressed {
                    self.modifiers.meta = true;
                } else {
                    self.modifiers.meta = self.is_key_pressed(KEY_LEFTMETA) || self.is_key_pressed(KEY_RIGHTMETA);
                }
            }
            KEY_CAPSLOCK if pressed => {
                self.modifiers.caps_lock = !self.modifiers.caps_lock;
            }
            KEY_NUMLOCK if pressed => {
                self.modifiers.num_lock = !self.modifiers.num_lock;
            }
            KEY_SCROLLLOCK if pressed => {
                self.modifiers.scroll_lock = !self.modifiers.scroll_lock;
            }
            _ => {}
        }
    }

    /// Check if a key is currently pressed
    pub fn is_key_pressed(&self, keycode: u32) -> bool {
        self.pressed_keys.contains(&keycode)
    }

    /// Get current modifiers
    pub fn modifiers(&self) -> KeyModifiers {
        self.modifiers
    }

    /// Set keyboard layout
    pub fn set_layout(&mut self, layout: &str) {
        self.mapper.set_layout(layout);
        debug!("Keyboard layout changed to: {}", layout);
    }

    /// Get current keyboard layout
    pub fn layout(&self) -> &str {
        self.mapper.layout()
    }

    /// Set key repeat delay
    pub fn set_repeat_delay(&mut self, delay_ms: u64) {
        self.repeat_delay_ms = delay_ms;
    }

    /// Set key repeat rate
    pub fn set_repeat_rate(&mut self, rate_ms: u64) {
        self.repeat_rate_ms = rate_ms;
    }

    /// Reset keyboard state (release all keys)
    pub fn reset(&mut self) {
        self.pressed_keys.clear();
        self.last_key_times.clear();
        self.modifiers = KeyModifiers::default();
        debug!("Keyboard state reset");
    }

    /// Get number of currently pressed keys
    pub fn pressed_key_count(&self) -> usize {
        self.pressed_keys.len()
    }

    /// Get all currently pressed keys
    pub fn get_pressed_keys(&self) -> Vec<u32> {
        self.pressed_keys.iter().copied().collect()
    }
}

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

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_keyboard_handler_creation() {
        let handler = KeyboardHandler::new();
        assert_eq!(handler.pressed_key_count(), 0);
        assert!(!handler.modifiers().shift);
    }

    #[test]
    fn test_key_press_release() {
        let mut handler = KeyboardHandler::new();

        // Press A key (scancode 0x1E)
        let event = handler.handle_key_down(0x1E, false, false).unwrap();

        match event {
            KeyboardEvent::KeyDown { keycode, .. } => {
                assert!(keycode > 0);
                assert!(handler.is_key_pressed(keycode));
            }
            _ => panic!("Expected KeyDown event"),
        }

        assert_eq!(handler.pressed_key_count(), 1);

        // Release A key
        let event = handler.handle_key_up(0x1E, false, false).unwrap();

        match event {
            KeyboardEvent::KeyUp { keycode, .. } => {
                assert!(!handler.is_key_pressed(keycode));
            }
            _ => panic!("Expected KeyUp event"),
        }

        assert_eq!(handler.pressed_key_count(), 0);
    }

    #[test]
    fn test_modifier_tracking() {
        let mut handler = KeyboardHandler::new();

        // Press left shift (scancode 0x2A)
        handler.handle_key_down(0x2A, false, false).unwrap();
        assert!(handler.modifiers().shift);

        // Press left ctrl (scancode 0x1D)
        handler.handle_key_down(0x1D, false, false).unwrap();
        assert!(handler.modifiers().ctrl);

        // Release left shift
        handler.handle_key_up(0x2A, false, false).unwrap();
        assert!(!handler.modifiers().shift);
        assert!(handler.modifiers().ctrl);

        // Release left ctrl
        handler.handle_key_up(0x1D, false, false).unwrap();
        assert!(!handler.modifiers().ctrl);
    }

    #[test]
    fn test_caps_lock_toggle() {
        let mut handler = KeyboardHandler::new();

        assert!(!handler.modifiers().caps_lock);

        // Press Caps Lock (scancode 0x3A)
        handler.handle_key_down(0x3A, false, false).unwrap();
        assert!(handler.modifiers().caps_lock);

        // Release Caps Lock
        handler.handle_key_up(0x3A, false, false).unwrap();
        assert!(handler.modifiers().caps_lock); // Should stay on

        // Press again to toggle off
        handler.handle_key_down(0x3A, false, false).unwrap();
        assert!(!handler.modifiers().caps_lock);
    }

    #[test]
    fn test_multiple_modifiers() {
        let mut handler = KeyboardHandler::new();

        // Press Shift + Ctrl + Alt
        handler.handle_key_down(0x2A, false, false).unwrap(); // Left Shift
        handler.handle_key_down(0x1D, false, false).unwrap(); // Left Ctrl
        handler.handle_key_down(0x38, false, false).unwrap(); // Left Alt

        let mods = handler.modifiers();
        assert!(mods.shift);
        assert!(mods.ctrl);
        assert!(mods.alt);
    }

    #[test]
    fn test_both_shifts() {
        let mut handler = KeyboardHandler::new();

        // Press left shift
        handler.handle_key_down(0x2A, false, false).unwrap();
        assert!(handler.modifiers().shift);

        // Press right shift too
        handler.handle_key_down(0x36, false, false).unwrap();
        assert!(handler.modifiers().shift);

        // Release left shift
        handler.handle_key_up(0x2A, false, false).unwrap();
        assert!(handler.modifiers().shift); // Should still be on (right shift still pressed)

        // Release right shift
        handler.handle_key_up(0x36, false, false).unwrap();
        assert!(!handler.modifiers().shift);
    }

    #[test]
    fn test_extended_key() {
        let mut handler = KeyboardHandler::new();

        // Press right ctrl (extended scancode 0xE01D)
        let event = handler.handle_key_down(0x1D, true, false).unwrap();

        match event {
            KeyboardEvent::KeyDown { keycode, .. } => {
                assert!(keycode > 0);
            }
            _ => panic!("Expected KeyDown event"),
        }

        assert!(handler.modifiers().ctrl);
    }

    #[test]
    fn test_layout_change() {
        let mut handler = KeyboardHandler::new();

        assert_eq!(handler.layout(), "us");

        handler.set_layout("de");
        assert_eq!(handler.layout(), "de");
    }

    #[test]
    fn test_reset() {
        let mut handler = KeyboardHandler::new();

        // Press several keys
        handler.handle_key_down(0x1E, false, false).unwrap(); // A
        handler.handle_key_down(0x2A, false, false).unwrap(); // Shift
        handler.handle_key_down(0x1D, false, false).unwrap(); // Ctrl

        assert!(handler.pressed_key_count() > 0);
        assert!(handler.modifiers().shift);

        // Reset
        handler.reset();

        assert_eq!(handler.pressed_key_count(), 0);
        assert!(!handler.modifiers().shift);
        assert!(!handler.modifiers().ctrl);
    }

    #[test]
    fn test_get_pressed_keys() {
        let mut handler = KeyboardHandler::new();

        handler.handle_key_down(0x1E, false, false).unwrap(); // A
        handler.handle_key_down(0x1F, false, false).unwrap(); // S

        let pressed = handler.get_pressed_keys();
        assert_eq!(pressed.len(), 2);
    }

    #[test]
    fn test_repeat_rate() {
        let mut handler = KeyboardHandler::new();

        handler.set_repeat_delay(100);
        handler.set_repeat_rate(50);

        assert_eq!(handler.repeat_delay_ms, 100);
        assert_eq!(handler.repeat_rate_ms, 50);
    }

    #[test]
    fn test_unknown_scancode() {
        let mut handler = KeyboardHandler::new();

        // Try invalid scancode
        let result = handler.handle_key_down(0xFF, false, false);
        assert!(result.is_err());
    }

    #[test]
    fn test_function_keys() {
        let mut handler = KeyboardHandler::new();

        // F1 (scancode 0x3B)
        let event = handler.handle_key_down(0x3B, false, false).unwrap();
        match event {
            KeyboardEvent::KeyDown { keycode, .. } => {
                assert!(keycode > 0);
            }
            _ => panic!("Expected KeyDown event"),
        }

        // F12 (scancode 0x58)
        let event = handler.handle_key_down(0x58, false, false).unwrap();
        match event {
            KeyboardEvent::KeyDown { keycode, .. } => {
                assert!(keycode > 0);
            }
            _ => panic!("Expected KeyDown event"),
        }
    }
}