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
|
/**
* mds — A micro-display server
* Copyright © 2014, 2015, 2016 Mattias Andrée (maandree@member.fsf.org)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MDS_MDS_KKBD_H
#define MDS_MDS_KKBD_H
#include "mds-base.h"
/**
* The keyboard listener thread's main function
*
* @param data Input data
* @return Output data
*/
void* keyboard_loop(void* data);
/**
* Handle the received message
*
* @return Zero on success, -1 on error
*/
int handle_message(void);
/**
* Handle the received message after it has been
* identified to contain `Command: enumerate-keyboards`
*
* @param recv_client_id The value of the `Client ID`-header, "0:0" if omitted
* @param recv_message_id The value of the `Message ID`-header
* @param recv_modify_id The value of the `Modify ID`-header, `NULL` if omitted
* @return Zero on success, -1 on error
*/
__attribute__((nonnull(1, 2)))
int handle_enumerate_keyboards(const char* recv_client_id, const char* recv_message_id,
const char* recv_modify_id);
/**
* Handle the received message after it has been
* identified to contain `Command: keyboard-enumeration`
*
* @param recv_modify_id The value of the `Modify ID`-header, `NULL` if omitted
* @return Zero on success, -1 on error
*/
int handle_keyboard_enumeration(const char* recv_modify_id);
/**
* Handle the received message after it has been
* identified to contain `Command: set-keyboard-leds`
*
* @param recv_active The value of the `Active`-header, `NULL` if omitted
* @param recv_mask The value of the `Mask`-header, `NULL` if omitted
* @param recv_keyboard The value of the `Keyboard`-header, `NULL` if omitted
* @return Zero on success, -1 on error
*/
int handle_set_keyboard_leds(const char* recv_active, const char* recv_mask, const char* recv_keyboard);
/**
* Handle the received message after it has been
* identified to contain `Command: get-keyboard-leds`
*
* @param recv_client_id The value of the `Client ID`-header, "0:0" if omitted
* @param recv_message_id The value of the `Message ID`-header
* @param recv_keyboard The value of the `Keyboard`-header, `NULL` if omitted
* @return Zero on success, -1 on error
*/
__attribute__((nonnull(1, 2)))
int handle_get_keyboard_leds(const char* recv_client_id, const char* recv_message_id, const char* recv_keyboard);
/**
* Handle the received message after it has been
* identified to contain `Command: map-keyboard-leds`
*
* @param recv_keyboard The value of the `Keyboard`-header, `NULL` if omitted
* @return Zero on success, -1 on error
*/
int handle_map_keyboard_leds(const char* recv_keyboard);
/**
* Handle the received message after it has been
* identified to contain `Command: keycode-map`
*
* @param recv_client_id The value of the `Client ID`-header, "0:0" if omitted
* @param recv_message_id The value of the `Message ID`-header
* @param recv_action The value of the `Action`-header, `NULL` if omitted
* @param recv_keyboard The value of the `Keyboard`-header, `NULL` if omitted
* @return Zero on success, -1 on error
*/
__attribute__((nonnull(1, 2)))
int handle_keycode_map(const char* recv_client_id, const char* recv_message_id,
const char* recv_action, const char* recv_keyboard);
/**
* Remap a LED, from the command line
*
* @param arg The name of the LED to remap, the new position of the LED,
* either zero-based index or name of the original LED with
* that position; delimited by an equals-sign
* @return Zero on success, -1 on error
*/
__attribute__((nonnull))
int remap_led_cmdline(char* arg);
/**
* Acquire access of the keyboard's LED:s
*
* @return Zero on success, -1 on error
*/
int open_leds(void);
/**
* Release access of the keyboard's LED:s
*/
void close_leds(void);
/**
* Get active LED:s on the keyboard
*
* @return Active LED:s, -1 on error
*/
int get_leds(void);
/**
* Set active LED:s on the keyboard
*
* @param leds Active LED:s
* @return Zero on success, -1 on error
*/
int set_leds(int leds);
/**
* Acquire access of keyboard input
*
* @return Zero on success, -1 on error
*/
int open_input(void);
/**
* Release access of keyboard input
*/
void close_input(void);
/**
* Broadcast a keyboard input event
*
* @param scancode The scancode
* @param trio Whether the scancode has three integers rather than one
* @return Zero on success, -1 on error
*/
__attribute__((nonnull))
int send_key(int* restrict scancode, int trio);
/**
* Fetch and broadcast keys until interrupted
*
* @return Zero on success, -1 on error
*/
int fetch_keys(void);
/**
* Send a response with an error number
*
* @param error The error number
* @param recv_client_id The client's ID
* @param recv_message_id The message ID of the message the client sent
* @return Zero on success, -1 on error
*/
__attribute__((nonnull))
int send_errno(int error, const char* recv_client_id, const char* recv_message_id);
/**
* Attempt to shrink `mapping`
*/
void shrink_map(void);
#endif
|
