BrlAPI  0.8
brlapi_param.h
Go to the documentation of this file.
1 /*
2  * libbrlapi - A library providing access to braille terminals for applications.
3  *
4  * Copyright (C) 2002-2021 by
5  * Samuel Thibault <Samuel.Thibault@ens-lyon.org>
6  * Sébastien Hinderer <Sebastien.Hinderer@ens-lyon.org>
7  *
8  * libbrlapi comes with ABSOLUTELY NO WARRANTY.
9  *
10  * This is free software, placed under the terms of the
11  * GNU Lesser General Public License, as published by the Free Software
12  * Foundation; either version 2.1 of the License, or (at your option) any
13  * later version. Please see the file LICENSE-LGPL for details.
14  *
15  * Web Page: http://brltty.app/
16  *
17  * This software is maintained by Dave Mielke <dave@mielke.cc>.
18  */
19 
23 #ifndef BRLAPI_INCLUDED_PARAM
24 #define BRLAPI_INCLUDED_PARAM
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif /* __cplusplus */
29 
30 #include "brlapi_keycodes.h"
31 
36 typedef enum {
37 //Connection Parameters
41 //Device Parameters
51 /* TODO: status area */
52 
53 //Input Parameters
56 //Braille Rendering Parameters
64 //Navigation Parameters
68 //Clipboard Parameters
71 //TTY Mode Parameters
89 //Braille Translation Parameters
99 /* TODO: dot-to-unicode as well */
100 
101  /* TODO: help strings */
102 
103  BRLAPI_PARAM_COUNT = 32
105 
106 /* brlapi_param_subparam_t */
108 typedef uint64_t brlapi_param_subparam_t;
109 
110 /* brlapi_param_bool_t */
112 typedef uint8_t brlapi_param_bool_t;
113 
114 /* brlapi_param_serverVersion_t */
117 
118 /* brlapi_param_clientPriority_t */
121 
122 /* BRLAPI_PARAM_CLIENT_PRIORITY_DEFAULT */
124 #define BRLAPI_PARAM_CLIENT_PRIORITY_DEFAULT 50
125 
126 /* brlapi_param_driverName_t */
129 
130 /* brlapi_param_driverCode_t */
133 
134 /* brlapi_param_driverVersion_t */
137 
138 /* brlapi_param_deviceModel_t */
141 
142 /* brlapi_param_deviceCellSize_t */
145 
146 /* brlapi_param_displaySize_t */
148 typedef struct {
149  uint32_t columns;
150  uint32_t rows;
152 
153 /* brlapi_param_deviceIdentifier_t */
156 
157 /* brlapi_param_deviceSpeed_t */
159 typedef uint32_t brlapi_param_deviceSpeed_t;
160 
161 /* brlapi_param_deviceOnline_t */
164 
165 /* brlapi_param_retainDots_t */
168 
169 /* brlapi_param_computerBrailleCellSize_t */
172 
173 /* brlapi_param_literaryBraille_t */
176 
177 /* brlapi_param_cursorDots_t */
180 
181 /* brlapi_param_cursorBlinkPeriod_t */
184 
185 /* brlapi_param_cursorBlinkPercentage_t */
188 
189 /* brlapi_param_renderedCells_t */
192 
193 /* brlapi_param_skipIdenticalLines_t */
196 
197 /* brlapi_param_audibleAlerts_t */
200 
201 /* brlapi_param_clipboardContent_t */
204 
205 /* brlapi_param_commandKeycode_t */
208 
209 /* brlapi_param_commandKeycodeName_t */
212 
213 /* brlapi_param_commandKeycodeSummary_t */
216 
217 /* brlapi_param_driverKeycode_t */
220 
221 /* brlapi_param_driverKeycodeName_t */
224 
225 /* brlapi_param_driverKeycodeSummary_t */
228 
229 /* brlapi_param_computerBrailleRowsMask_t */
232 
233 /* brlapi_param_computerBrailleRowCells_t */
235 typedef struct {
236  uint8_t cells[0X100];
237  uint8_t defined[0X100 / 8];
239 
240 /* brlapi_param_computerBrailleTable_t */
243 
244 /* brlapi_param_literaryBrailleTable_t */
247 
248 /* brlapi_param_messageLocale_t */
251 
253 #define BRLAPI_PARAM_BOUND_COMMAND_CODES BRLAPI_PARAM_BOUND_COMMAND_KEYCODES
256 
258 #define BRLAPI_PARAM_COMMAND_SHORT_NAME BRLAPI_PARAM_COMMAND_KEYCODE_NAME
261 
263 #define BRLAPI_PARAM_COMMAND_LONG_NAME BRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY
266 
268 #define BRLAPI_PARAM_DEVICE_KEY_CODES BRLAPI_PARAM_DEFINED_DRIVER_KEYCODES
271 
273 #define BRLAPI_PARAM_KEY_SHORT_NAME BRLAPI_PARAM_DRIVER_KEYCODE_NAME
276 
278 #define BRLAPI_PARAM_KEY_LONG_NAME BRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY
281 
283 typedef enum {
292 
294 typedef struct {
296  uint16_t count;
297  uint8_t isArray;
298  uint8_t hasSubparam;
300 
302 /* brlapi_getParameterProperties */
310 
313 #ifdef __cplusplus
314 }
315 #endif /* __cplusplus */
316 
317 #endif /* BRLAPI_INCLUDED_PARAM */
char * brlapi_param_deviceIdentifier_t
Definition: brlapi_param.h:155
char * brlapi_param_driverKeycodeName_t
Definition: brlapi_param.h:223
uint8_t * brlapi_param_renderedCells_t
Definition: brlapi_param.h:191
brlapi_param_bool_t brlapi_param_skipIdenticalLines_t
Definition: brlapi_param.h:195
uint8_t brlapi_param_deviceCellSize_t
Definition: brlapi_param.h:144
brlapi_param_driverKeycodeName_t brlapi_param_keyShortName_t
Definition: brlapi_param.h:275
char * brlapi_param_commandKeycodeSummary_t
Definition: brlapi_param.h:215
char * brlapi_param_driverVersion_t
Definition: brlapi_param.h:136
brlapi_param_driverKeycodeSummary_t brlapi_param_keyLongName_t
Definition: brlapi_param.h:280
const brlapi_param_properties_t * brlapi_getParameterProperties(brlapi_param_t parameter)
uint32_t brlapi_param_clientPriority_t
Definition: brlapi_param.h:120
brlapi_param_driverKeycode_t brlapi_param_keyCode_t
Definition: brlapi_param.h:270
uint32_t brlapi_param_serverVersion_t
Definition: brlapi_param.h:116
uint32_t brlapi_param_deviceSpeed_t
Definition: brlapi_param.h:159
char * brlapi_param_clipboardContent_t
Definition: brlapi_param.h:203
char * brlapi_param_messageLocale_t
Definition: brlapi_param.h:250
uint32_t brlapi_param_cursorBlinkPeriod_t
Definition: brlapi_param.h:183
char * brlapi_param_computerBrailleTable_t
Definition: brlapi_param.h:242
char * brlapi_param_driverName_t
Definition: brlapi_param.h:128
brlapi_param_commandKeycodeSummary_t brlapi_param_commandLongName_t
Definition: brlapi_param.h:265
char * brlapi_param_driverKeycodeSummary_t
Definition: brlapi_param.h:227
uint8_t brlapi_param_computerBrailleCellSize_t
Definition: brlapi_param.h:171
uint8_t brlapi_param_cursorDots_t
Definition: brlapi_param.h:179
brlapi_param_commandKeycode_t brlapi_param_commandCode_t
Definition: brlapi_param.h:255
brlapi_param_bool_t brlapi_param_deviceOnline_t
Definition: brlapi_param.h:163
brlapi_param_type_t
Definition: brlapi_param.h:283
@ BRLAPI_PARAM_TYPE_KEYCODE
Definition: brlapi_param.h:290
@ BRLAPI_PARAM_TYPE_UINT64
Definition: brlapi_param.h:289
@ BRLAPI_PARAM_TYPE_UINT16
Definition: brlapi_param.h:287
@ BRLAPI_PARAM_TYPE_UINT8
Definition: brlapi_param.h:286
@ BRLAPI_PARAM_TYPE_BOOLEAN
Definition: brlapi_param.h:285
@ BRLAPI_PARAM_TYPE_STRING
Definition: brlapi_param.h:284
@ BRLAPI_PARAM_TYPE_UINT32
Definition: brlapi_param.h:288
brlapi_keyCode_t brlapi_param_driverKeycode_t
Definition: brlapi_param.h:219
char * brlapi_param_deviceModel_t
Definition: brlapi_param.h:140
char * brlapi_param_commandKeycodeName_t
Definition: brlapi_param.h:211
uint64_t brlapi_param_subparam_t
Definition: brlapi_param.h:108
brlapi_param_bool_t brlapi_param_literaryBraille_t
Definition: brlapi_param.h:175
uint8_t brlapi_param_cursorBlinkPercentage_t
Definition: brlapi_param.h:187
uint8_t brlapi_param_computerBrailleRowsMask_t[544]
Definition: brlapi_param.h:231
brlapi_param_commandKeycodeName_t brlapi_param_commandShortName_t
Definition: brlapi_param.h:260
brlapi_param_bool_t brlapi_param_audibleAlerts_t
Definition: brlapi_param.h:199
brlapi_param_bool_t brlapi_param_retainDots_t
Definition: brlapi_param.h:167
uint8_t brlapi_param_bool_t
Definition: brlapi_param.h:112
char * brlapi_param_driverCode_t
Definition: brlapi_param.h:132
char * brlapi_param_literaryBrailleTable_t
Definition: brlapi_param.h:246
brlapi_keyCode_t brlapi_param_commandKeycode_t
Definition: brlapi_param.h:207
uint64_t brlapi_keyCode_t
Definition: brlapi_keycodes.h:90
brlapi_param_t
Definition: brlapi_param.h:36
@ BRLAPI_PARAM_SKIP_IDENTICAL_LINES
Definition: brlapi_param.h:65
@ BRLAPI_PARAM_SERVER_VERSION
Definition: brlapi_param.h:38
@ BRLAPI_PARAM_DISPLAY_SIZE
Definition: brlapi_param.h:47
@ BRLAPI_PARAM_BOUND_COMMAND_KEYCODES
Definition: brlapi_param.h:72
@ BRLAPI_PARAM_DRIVER_NAME
Definition: brlapi_param.h:42
@ BRLAPI_PARAM_LITERARY_BRAILLE
Definition: brlapi_param.h:58
@ BRLAPI_PARAM_COMMAND_KEYCODE_NAME
Definition: brlapi_param.h:74
@ BRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY
Definition: brlapi_param.h:85
@ BRLAPI_PARAM_COUNT
Definition: brlapi_param.h:103
@ BRLAPI_PARAM_DEVICE_CELL_SIZE
Definition: brlapi_param.h:46
@ BRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY
Definition: brlapi_param.h:77
@ BRLAPI_PARAM_DEVICE_IDENTIFIER
Definition: brlapi_param.h:48
@ BRLAPI_PARAM_DRIVER_VERSION
Definition: brlapi_param.h:44
@ BRLAPI_PARAM_AUDIBLE_ALERTS
Definition: brlapi_param.h:66
@ BRLAPI_PARAM_DRIVER_KEYCODE_NAME
Definition: brlapi_param.h:82
@ BRLAPI_PARAM_CLIENT_PRIORITY
Definition: brlapi_param.h:39
@ BRLAPI_PARAM_COMPUTER_BRAILLE_ROWS_MASK
Definition: brlapi_param.h:90
@ BRLAPI_PARAM_COMPUTER_BRAILLE_ROW_CELLS
Definition: brlapi_param.h:93
@ BRLAPI_PARAM_DEVICE_ONLINE
Definition: brlapi_param.h:50
@ BRLAPI_PARAM_CLIPBOARD_CONTENT
Definition: brlapi_param.h:69
@ BRLAPI_PARAM_CURSOR_BLINK_PERCENTAGE
Definition: brlapi_param.h:61
@ BRLAPI_PARAM_LITERARY_BRAILLE_TABLE
Definition: brlapi_param.h:97
@ BRLAPI_PARAM_RENDERED_CELLS
Definition: brlapi_param.h:62
@ BRLAPI_PARAM_CURSOR_BLINK_PERIOD
Definition: brlapi_param.h:60
@ BRLAPI_PARAM_RETAIN_DOTS
Definition: brlapi_param.h:54
@ BRLAPI_PARAM_DEVICE_SPEED
Definition: brlapi_param.h:49
@ BRLAPI_PARAM_COMPUTER_BRAILLE_TABLE
Definition: brlapi_param.h:96
@ BRLAPI_PARAM_DEVICE_MODEL
Definition: brlapi_param.h:45
@ BRLAPI_PARAM_MESSAGE_LOCALE
Definition: brlapi_param.h:98
@ BRLAPI_PARAM_CURSOR_DOTS
Definition: brlapi_param.h:59
@ BRLAPI_PARAM_COMPUTER_BRAILLE_CELL_SIZE
Definition: brlapi_param.h:57
@ BRLAPI_PARAM_DRIVER_CODE
Definition: brlapi_param.h:43
@ BRLAPI_PARAM_DEFINED_DRIVER_KEYCODES
Definition: brlapi_param.h:80
Definition: brlapi_param.h:235
Definition: brlapi_param.h:148
uint32_t columns
Definition: brlapi_param.h:149
uint32_t rows
Definition: brlapi_param.h:150
Definition: brlapi_param.h:294
brlapi_param_type_t type
Definition: brlapi_param.h:295
uint16_t count
Definition: brlapi_param.h:296
uint8_t hasSubparam
Definition: brlapi_param.h:298
uint8_t isArray
Definition: brlapi_param.h:297