qsk 0.2.0

Software keyboard remapper inspired by QMK.
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

use async_std::channel::unbounded;
use async_std::channel::Receiver;
use async_std::channel::Sender;
use async_std::prelude::FutureExt;
use async_std::prelude::StreamExt;
use async_std::task;
use log::debug;
use log::error;
use log::trace;

use qsk_types::control_code::ControlCode;
use qsk_types::layer_composer::InputTransformer;
use crate::events::EventCode;
use crate::events::InputEvent;
use crate::device::traits::InputEventSink;
use crate::device::traits::InputEventSource;

pub struct QSKEngine {
    input_transformer: Box<dyn InputTransformer + Send>,
}

impl QSKEngine {
    pub fn new(it: Box<dyn InputTransformer + Send>) -> Self {
        QSKEngine {
            input_transformer: it,
        }
    }

    pub async fn handle(mut self, mut r: Receiver<InputEvent>, s: Sender<InputEvent>) {
        while let Some(e) = r.next().await {
            match e.code {
                EventCode::SynCode(_) => trace!("recv: {:?} {:?}", e.code, e.state),
                _ => debug!("recv: {:?} {:?}", e.code, e.state),
            };
            if let Some(e_vec) = self.input_transformer.transform(e) {
                for cc in e_vec.iter() {
                    match cc {
                        ControlCode::InputEvent(v) => {
                            if let Err(e) = s.send(v.clone()).await {
                                error!("error sending: {:?}", e);
                                return;
                            }
                            match e.code {
                                EventCode::SynCode(_) => trace!("recv: {:?} {:?}", v.code, v.state),
                                _ => debug!("send: {:?} {:?}", v.code, v.state),
                            };
                        }
                        ControlCode::Exit => return,
                        _ => continue,
                    }
                }
            }
        }
    }

    pub async fn run(
        self,
        mut src: Box<dyn InputEventSource>,
        mut snk: Box<dyn InputEventSink>,
    ) -> std::result::Result<(), Box<dyn std::error::Error>> {
        let (input_sender, handler_receiver) = unbounded();
        let (handler_sender, mut output_receiver) = unbounded();

        trace!("creating handler task");
        let handler_task = task::Builder::new()
            .name("handler".to_string())
            .spawn(self.handle(handler_receiver, handler_sender))?;

        trace!("creating input task");
        let input_task = task::Builder::new()
            .name("input".to_string())
            .spawn(async move {
                loop {
                    let t = src.recv();
                    trace!("received InputEvent from keyboard");
                    match t {
                        Ok(a) => match input_sender.send(a).await {
                            Err(async_std::channel::SendError(msg)) => {
                                debug!("channel closed, failed to send: {:?}", msg);
                                break;
                            }
                            _ => (),
                        },
                        Err(err) => {
                            error!("error reading from keyboard device: {:?}", err)
                        }
                    }
                    trace!("sent InputEvent to handler");
                }
            })?;

        trace!("creating output task");
        let output_task = task::Builder::new()
            .name("output".to_string())
            .spawn(async move {
                while let Some(e) = output_receiver.next().await {
                    trace!("received InputEvent from handler");
                    match snk.send(e) {
                        Ok(_) => (),
                        Err(err) => error!("error writing to keyboard device: {:?}", err),
                    }
                    trace!("sent InputEvent to virtual keyboard");
                }
            })?;

        input_task.race(output_task).race(handler_task).await;
        Ok(())
    }
}