hc
2024-10-22 8ac6c7a54ed1b98d142dce24b11c6de6a1e239a5
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
=================
Keyboard notifier
=================
 
One can use register_keyboard_notifier to get called back on keyboard
events (see kbd_keycode() function for details).  The passed structure is
keyboard_notifier_param:
 
- 'vc' always provide the VC for which the keyboard event applies;
- 'down' is 1 for a key press event, 0 for a key release;
- 'shift' is the current modifier state, mask bit indexes are KG_*;
- 'value' depends on the type of event.
 
- KBD_KEYCODE events are always sent before other events, value is the keycode.
- KBD_UNBOUND_KEYCODE events are sent if the keycode is not bound to a keysym.
  value is the keycode.
- KBD_UNICODE events are sent if the keycode -> keysym translation produced a
  unicode character. value is the unicode value.
- KBD_KEYSYM events are sent if the keycode -> keysym translation produced a
  non-unicode character. value is the keysym.
- KBD_POST_KEYSYM events are sent after the treatment of non-unicode keysyms.
  That permits one to inspect the resulting LEDs for instance.
 
For each kind of event but the last, the callback may return NOTIFY_STOP in
order to "eat" the event: the notify loop is stopped and the keyboard event is
dropped.
 
In a rough C snippet, we have::
 
    kbd_keycode(keycode) {
   ...
   params.value = keycode;
   if (notifier_call_chain(KBD_KEYCODE,&params) == NOTIFY_STOP)
       || !bound) {
       notifier_call_chain(KBD_UNBOUND_KEYCODE,&params);
       return;
   }
 
   if (unicode) {
       param.value = unicode;
       if (notifier_call_chain(KBD_UNICODE,&params) == NOTIFY_STOP)
           return;
       emit unicode;
       return;
   }
 
   params.value = keysym;
   if (notifier_call_chain(KBD_KEYSYM,&params) == NOTIFY_STOP)
       return;
   apply keysym;
   notifier_call_chain(KBD_POST_KEYSYM,&params);
    }
 
.. note:: This notifier is usually called from interrupt context.