BrlAPI 0.8
brlapi.h
Go to the documentation of this file.
1/* Programs/brlapi.h. Generated from brlapi.h.in by configure. */
2/*
3 * libbrlapi - A library providing access to braille terminals for applications.
4 *
5 * Copyright (C) 2002-2021 by
6 * Samuel Thibault <Samuel.Thibault@ens-lyon.org>
7 * Sébastien Hinderer <Sebastien.Hinderer@ens-lyon.org>
8 *
9 * libbrlapi comes with ABSOLUTELY NO WARRANTY.
10 *
11 * This is free software, placed under the terms of the
12 * GNU Lesser General Public License, as published by the Free Software
13 * Foundation; either version 2.1 of the License, or (at your option) any
14 * later version. Please see the file LICENSE-LGPL for details.
15 *
16 * Web Page: http://brltty.app/
17 *
18 * This software is maintained by Dave Mielke <dave@mielke.cc>.
19 */
20
25#ifndef BRLAPI_INCLUDED
26#define BRLAPI_INCLUDED
27
28#ifdef __cplusplus
29extern "C" {
30#endif /* __cplusplus */
31
32/* #undef BRLAPI_WIN32 */
33
38#define BRLAPI_RELEASE "0.8.3"
39
41#define BRLAPI_MAJOR 0
42
44#define BRLAPI_MINOR 8
45
47#define BRLAPI_REVISION 3
48
50void brlapi_getLibraryVersion(int *major, int *minor, int *revision);
51
54/* Types are defined there */
55#include <sys/types.h>
56
57#ifdef BRLAPI_WIN32
58#include <windows.h>
59#define BRLAPI_STDCALL __stdcall
60#else /* BRLAPI_WIN32 */
61#define BRLAPI_STDCALL
62#endif /* BRLAPI_WIN32 */
63
64#ifdef _MSC_VER
65typedef __int64 uint64_t;
66typedef __int32 uint32_t;
67#define UINT64_C(x) (x ## Ui64)
68#define PRIx64 "I64x"
69typedef signed int ssize_t;
70#else /* _MSC_VER */
71
72/* this is for uint*_t */
73#include <stdint.h>
74
75/* NULL is defined there */
76#include <unistd.h>
77
78#include <inttypes.h> /* For PRIx64 */
79#endif /* _MSC_VER */
80
81#include <wchar.h>
82
106
109
123#define BRLAPI_SOCKETPORTNUM 4101
124#define BRLAPI_SOCKETPORT "4101"
125
127#define BRLAPI_SOCKETPATH "/var/lib/BrlAPI"
128
133#define BRLAPI_ETCDIR "/etc"
134
138#define BRLAPI_AUTHKEYFILE "brlapi.key"
139
141#ifdef BRLAPI_WIN32
142/* No authentication by default on Windows */
143#define BRLAPI_DEFAUTH "none"
144#else /* BRLAPI_WIN32 */
145#define BRLAPI_DEFAUTH_KEYFILE "keyfile:" BRLAPI_ETCDIR "/" BRLAPI_AUTHKEYFILE
146
147#ifdef HAVE_POLKIT
148#define BRLAPI_DEFAUTH_POLKIT "+polkit"
149#else /* HAVE_POLKIT */
150#define BRLAPI_DEFAUTH_POLKIT ""
151#endif /* HAVE_POLKIT */
152
153#define BRLAPI_DEFAUTH BRLAPI_DEFAUTH_KEYFILE BRLAPI_DEFAUTH_POLKIT
154#endif /* BRLAPI_WIN32 */
155
161#ifdef __MINGW32__
162typedef HANDLE brlapi_fileDescriptor;
163#else /* __MINGW32__ */
165#endif /* __MINGW32__ */
166
171#ifdef __MINGW32__
172#define BRLAPI_INVALID_FILE_DESCRIPTOR INVALID_HANDLE_VALUE
173#else /* __MINGW32__ */
174#define BRLAPI_INVALID_FILE_DESCRIPTOR -1
175#endif /* __MINGW32__ */
176
207typedef struct {
215 const char *auth;
216
225 const char *host;
227
228/* BRLAPI_SETTINGS_INITIALIZER */
231#define BRLAPI_SETTINGS_INITIALIZER { NULL, NULL }
232
233/* brlapi_openConnection */
280#ifndef BRLAPI_NO_SINGLE_SESSION
282#endif /* BRLAPI_NO_SINGLE_SESSION */
284
285/* brlapi_fileDescriptor */
293#ifndef BRLAPI_NO_SINGLE_SESSION
295#endif /* BRLAPI_NO_SINGLE_SESSION */
297
298
299/* brlapi_closeConnection */
306#ifndef BRLAPI_NO_SINGLE_SESSION
308#endif /* BRLAPI_NO_SINGLE_SESSION */
310
319/* brlapi__setClientData */
324#ifndef BRLAPI_NO_SINGLE_SESSION
326#endif /* BRLAPI_NO_SINGLE_SESSION */
328
329/* brlapi__getClientData */
334#ifndef BRLAPI_NO_SINGLE_SESSION
336#endif /* BRLAPI_NO_SINGLE_SESSION */
338
354#define BRLAPI_MAXNAMELENGTH 31
355
356/* brlapi_getDriverName */
369#ifndef BRLAPI_NO_SINGLE_SESSION
370int BRLAPI_STDCALL brlapi_getDriverName(char *buffer, size_t size);
371#endif /* BRLAPI_NO_SINGLE_SESSION */
372int BRLAPI_STDCALL brlapi__getDriverName(brlapi_handle_t *handle, char *buffer, size_t size);
373
374/* brlapi_getModelIdentifier */
387#ifndef BRLAPI_NO_SINGLE_SESSION
388int BRLAPI_STDCALL brlapi_getModelIdentifier(char *buffer, size_t size);
389#endif /* BRLAPI_NO_SINGLE_SESSION */
390int BRLAPI_STDCALL brlapi__getModelIdentifier(brlapi_handle_t *handle, char *buffer, size_t size);
391
392/* brlapi_getDisplaySize */
394#ifndef BRLAPI_NO_SINGLE_SESSION
395int BRLAPI_STDCALL brlapi_getDisplaySize(unsigned int *x, unsigned int *y);
396#endif /* BRLAPI_NO_SINGLE_SESSION */
397int BRLAPI_STDCALL brlapi__getDisplaySize(brlapi_handle_t *handle, unsigned int *x, unsigned int *y);
398
422/* brlapi_enterTtyMode */
444#ifndef BRLAPI_NO_SINGLE_SESSION
445int BRLAPI_STDCALL brlapi_enterTtyMode(int tty, const char *driver);
446#endif /* BRLAPI_NO_SINGLE_SESSION */
447int BRLAPI_STDCALL brlapi__enterTtyMode(brlapi_handle_t *handle, int tty, const char *driver);
448
458#define BRLAPI_TTY_DEFAULT -1
459
460/* brlapi_enterTtyModeWithPath */
479#ifndef BRLAPI_NO_SINGLE_SESSION
480int BRLAPI_STDCALL brlapi_enterTtyModeWithPath(const int *ttys, int count, const char *driver);
481#endif /* BRLAPI_NO_SINGLE_SESSION */
482int BRLAPI_STDCALL brlapi__enterTtyModeWithPath(brlapi_handle_t *handle, const int *ttys, int count, const char *driver);
483
484/* brlapi_leaveTtyMode */
491#ifndef BRLAPI_NO_SINGLE_SESSION
493#endif /* BRLAPI_NO_SINGLE_SESSION */
495
496/* brlapi_setFocus */
507#ifndef BRLAPI_NO_SINGLE_SESSION
509#endif /* BRLAPI_NO_SINGLE_SESSION */
511
541/* brlapi_writeText */
556#ifndef BRLAPI_NO_SINGLE_SESSION
557int BRLAPI_STDCALL brlapi_writeText(int cursor, const char *text);
558#endif /* BRLAPI_NO_SINGLE_SESSION */
559int BRLAPI_STDCALL brlapi__writeText(brlapi_handle_t *handle, int cursor, const char *text);
560
561/* brlapi_writeWText */
574#ifndef BRLAPI_NO_SINGLE_SESSION
575int BRLAPI_STDCALL brlapi_writeWText(int cursor, const wchar_t *text);
576#endif /* BRLAPI_NO_SINGLE_SESSION */
577int BRLAPI_STDCALL brlapi__writeWText(brlapi_handle_t *handle, int cursor, const wchar_t *text);
578
579/* brlapi_writeDots */
587#ifndef BRLAPI_NO_SINGLE_SESSION
588int BRLAPI_STDCALL brlapi_writeDots(const unsigned char *dots);
589#endif /* BRLAPI_NO_SINGLE_SESSION */
590int BRLAPI_STDCALL brlapi__writeDots(brlapi_handle_t *handle, const unsigned char *dots);
591
592/* brlapi_writeArguments_t */
594typedef struct {
595 int displayNumber ;
596 unsigned int regionBegin ;
597 int regionSize ;
598 const char *text ;
599 int textSize ;
600 const unsigned char *andMask ;
601 const unsigned char *orMask ;
602 int cursor ;
603 const char *charset ;
605
610#define BRLAPI_DISPLAY_DEFAULT -1
611
616#define BRLAPI_CURSOR_LEAVE -1
617
622#define BRLAPI_CURSOR_OFF 0
623
624/* BRLAPI_WRITEARGUMENTS_INITIALIZER */
634#define BRLAPI_WRITEARGUMENTS_INITIALIZER { \
635 .displayNumber = BRLAPI_DISPLAY_DEFAULT, \
636 .regionBegin = 0, \
637 .regionSize = 0, \
638 .text = NULL, \
639 .textSize = -1, \
640 .andMask = NULL, \
641 .orMask = NULL, \
642 .cursor = BRLAPI_CURSOR_LEAVE, \
643 .charset = NULL \
644}
645
646/* brlapi_write */
682#ifndef BRLAPI_NO_SINGLE_SESSION
684#endif /* BRLAPI_NO_SINGLE_SESSION */
686
689#include "brlapi_keycodes.h"
690
704/* brlapi_expandedKeyCode_t */
706typedef struct {
707 unsigned int type ;
708 unsigned int command ;
709 unsigned int argument ;
710 unsigned int flags ;
712
713/* brlapi_expandKeyCode */
722
723/* brlapi_describedKeyCode_t */
725typedef struct {
726 const char *type ;
727 const char *command ;
728 unsigned int argument ;
729 unsigned int flags ;
730 const char *flag[64 - BRLAPI_KEY_FLAGS_SHIFT] ;
733
734/* brlapi_describeKeyCode */
743
745#define BRLAPI_UC_ROW 0x2800UL
746
747/* brlapi_readKey */
816#ifndef BRLAPI_NO_SINGLE_SESSION
818#endif /* BRLAPI_NO_SINGLE_SESSION */
820
821/* brlapi_readKeyWithTimeout */
842#ifndef BRLAPI_NO_SINGLE_SESSION
844#endif /* BRLAPI_NO_SINGLE_SESSION */
846
848typedef enum {
855
856/* brlapi_ignoreKeys */
868#ifndef BRLAPI_NO_SINGLE_SESSION
869int BRLAPI_STDCALL brlapi_ignoreKeys(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
870#endif /* BRLAPI_NO_SINGLE_SESSION */
871int BRLAPI_STDCALL brlapi__ignoreKeys(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
872
873/* brlapi_acceptKeys */
885#ifndef BRLAPI_NO_SINGLE_SESSION
886int BRLAPI_STDCALL brlapi_acceptKeys(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
887#endif /* BRLAPI_NO_SINGLE_SESSION */
888int BRLAPI_STDCALL brlapi__acceptKeys(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
889
890/* brlapi_ignoreAllKeys */
898#ifndef BRLAPI_NO_SINGLE_SESSION
900#define brlapi_ignoreAllKeys() brlapi_ignoreKeys(brlapi_rangeType_all, NULL, 0)
901#endif /* BRLAPI_NO_SINGLE_SESSION */
903#define brlapi__ignoreAllKeys(handle) brlapi__ignoreKeys(handle, brlapi_rangeType_all, NULL, 0)
904
905/* brlapi_acceptAllKeys */
916#ifndef BRLAPI_NO_SINGLE_SESSION
918#define brlapi_acceptAllKeys() brlapi_acceptKeys(brlapi_rangeType_all, NULL, 0)
919#endif /* BRLAPI_NO_SINGLE_SESSION */
921#define brlapi__acceptAllKeys(handle) brlapi__acceptKeys(handle, brlapi_rangeType_all, NULL, 0)
922
927typedef struct {
931
932/* brlapi_ignoreKeyRanges */
943#ifndef BRLAPI_NO_SINGLE_SESSION
944int BRLAPI_STDCALL brlapi_ignoreKeyRanges(const brlapi_range_t ranges[], unsigned int count);
945#endif /* BRLAPI_NO_SINGLE_SESSION */
946int BRLAPI_STDCALL brlapi__ignoreKeyRanges(brlapi_handle_t *handle, const brlapi_range_t ranges[], unsigned int count);
947
948/* brlapi_acceptKeyRanges */
959#ifndef BRLAPI_NO_SINGLE_SESSION
960int BRLAPI_STDCALL brlapi_acceptKeyRanges(const brlapi_range_t ranges[], unsigned int count);
961#endif /* BRLAPI_NO_SINGLE_SESSION */
962int BRLAPI_STDCALL brlapi__acceptKeyRanges(brlapi_handle_t *handle, const brlapi_range_t ranges[], unsigned int count);
988/* brlapi_enterRawMode */
993#ifndef BRLAPI_NO_SINGLE_SESSION
994int BRLAPI_STDCALL brlapi_enterRawMode(const char *driver);
995#endif /* BRLAPI_NO_SINGLE_SESSION */
996int BRLAPI_STDCALL brlapi__enterRawMode(brlapi_handle_t *handle, const char *driver);
997
998/* brlapi_leaveRawMode */
1001#ifndef BRLAPI_NO_SINGLE_SESSION
1003#endif /* BRLAPI_NO_SINGLE_SESSION */
1005
1006/* brlapi_sendRaw */
1012#ifndef BRLAPI_NO_SINGLE_SESSION
1013ssize_t BRLAPI_STDCALL brlapi_sendRaw(const void *buffer, size_t size);
1014#endif /* BRLAPI_NO_SINGLE_SESSION */
1015ssize_t BRLAPI_STDCALL brlapi__sendRaw(brlapi_handle_t *handle, const void *buffer, size_t size);
1016
1017/* brlapi_recvRaw */
1026#ifndef BRLAPI_NO_SINGLE_SESSION
1027ssize_t BRLAPI_STDCALL brlapi_recvRaw(void *buffer, size_t size);
1028#endif /* BRLAPI_NO_SINGLE_SESSION */
1029ssize_t BRLAPI_STDCALL brlapi__recvRaw(brlapi_handle_t *handle, void *buffer, size_t size);
1030
1031/* brlapi_suspendDriver */
1036#ifndef BRLAPI_NO_SINGLE_SESSION
1037int BRLAPI_STDCALL brlapi_suspendDriver(const char *driver);
1038#endif /* BRLAPI_NO_SINGLE_SESSION */
1040
1041/* brlapi_resumeDriver */
1045#ifndef BRLAPI_NO_SINGLE_SESSION
1047#endif /* BRLAPI_NO_SINGLE_SESSION */
1051#include "brlapi_param.h"
1052
1077typedef uint32_t brlapi_param_flags_t;
1078#define BRLAPI_PARAMF_LOCAL 0X00
1079#define BRLAPI_PARAMF_GLOBAL 0X01
1080#define BRLAPI_PARAMF_SELF 0X02
1082/* brlapi_getParameter */
1095#ifndef BRLAPI_NO_SINGLE_SESSION
1096ssize_t BRLAPI_STDCALL brlapi_getParameter(brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, void* data, size_t len);
1097#endif
1098ssize_t BRLAPI_STDCALL brlapi__getParameter(brlapi_handle_t *handle, brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, void* data, size_t len);
1099
1100/* brlapi_getParameterAlloc */
1113#ifndef BRLAPI_NO_SINGLE_SESSION
1115#endif
1117
1118/* brlapi_setParameter */
1131#ifndef BRLAPI_NO_SINGLE_SESSION
1132int BRLAPI_STDCALL brlapi_setParameter(brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, const void* data, size_t len);
1133#endif
1134int BRLAPI_STDCALL brlapi__setParameter(brlapi_handle_t *handle, brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, const void* data, size_t len);
1135
1136/* brlapi_paramCallback_t */
1151typedef void (*brlapi_paramCallback_t)(brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, void *priv, const void *data, size_t len);
1152
1153/* brlapi_paramCallbackDescriptor_t */
1159
1160/* brlapi_watchParameter */
1183#ifndef BRLAPI_NO_SINGLE_SESSION
1185#endif
1187
1188/* brlapi_unwatchParameter */
1199#ifndef BRLAPI_NO_SINGLE_SESSION
1201#endif
1203
1209/* brlapi_pause */
1216#ifndef BRLAPI_NO_SINGLE_SESSION
1217int BRLAPI_STDCALL brlapi_pause(int timeout_ms);
1218#endif
1219int BRLAPI_STDCALL brlapi__pause(brlapi_handle_t *handle, int timeout_ms);
1220
1221/* brlapi_sync */
1229#ifndef BRLAPI_NO_SINGLE_SESSION
1231#endif
1233
1260#define BRLAPI_ERROR_SUCCESS 0
1262#define BRLAPI_ERROR_NOMEM BRLAPI_ERROR_NOMEM
1264#define BRLAPI_ERROR_TTYBUSY BRLAPI_ERROR_TTYBUSY
1266#define BRLAPI_ERROR_DEVICEBUSY BRLAPI_ERROR_DEVICEBUSY
1268#define BRLAPI_ERROR_UNKNOWN_INSTRUCTION BRLAPI_ERROR_UNKNOWN_INSTRUCTION
1270#define BRLAPI_ERROR_ILLEGAL_INSTRUCTION BRLAPI_ERROR_ILLEGAL_INSTRUCTION
1272#define BRLAPI_ERROR_INVALID_PARAMETER BRLAPI_ERROR_INVALID_PARAMETER
1274#define BRLAPI_ERROR_INVALID_PACKET BRLAPI_ERROR_INVALID_PACKET
1276#define BRLAPI_ERROR_CONNREFUSED BRLAPI_ERROR_CONNREFUSED
1278#define BRLAPI_ERROR_OPNOTSUPP BRLAPI_ERROR_OPNOTSUPP
1280#define BRLAPI_ERROR_GAIERR BRLAPI_ERROR_GAIERR
1282#define BRLAPI_ERROR_LIBCERR BRLAPI_ERROR_LIBCERR
1284#define BRLAPI_ERROR_UNKNOWNTTY BRLAPI_ERROR_UNKNOWNTTY
1286#define BRLAPI_ERROR_PROTOCOL_VERSION BRLAPI_ERROR_PROTOCOL_VERSION
1288#define BRLAPI_ERROR_EOF BRLAPI_ERROR_EOF
1290#define BRLAPI_ERROR_EMPTYKEY BRLAPI_ERROR_EMPTYKEY
1292#define BRLAPI_ERROR_DRIVERERROR BRLAPI_ERROR_DRIVERERROR
1294#define BRLAPI_ERROR_AUTHENTICATION BRLAPI_ERROR_AUTHENTICATION
1296#define BRLAPI_ERROR_READONLY_PARAMETER BRLAPI_ERROR_READONLY_PARAMETER
1297};
1298
1299/* brlapi_errlist */
1304extern const char *brlapi_errlist[];
1305
1306/* brlapi_nerr */
1308extern const int brlapi_nerr;
1309
1310/* brlapi_perror */
1315void BRLAPI_STDCALL brlapi_perror(const char *s);
1316
1317/* brlapi_error_t */
1319typedef struct {
1323 const char *errfun;
1325
1335
1345
1347extern enum brlapi_error brlapi_errno;
1349extern int brlapi_libcerrno;
1351extern int brlapi_gaierrno;
1353extern const char *brlapi_errfun;
1354
1356#define brlapi_error (*brlapi_error_location())
1358#define brlapi_errno (brlapi_error.brlerrno)
1360#define brlapi_libcerrno (brlapi_error.libcerrno)
1362#define brlapi_gaierrno (brlapi_error.gaierrno)
1364#define brlapi_errfun (brlapi_error.errfun)
1365
1366/* brlapi_strerror */
1375
1376/* brlapi_strerror_r */
1393size_t BRLAPI_STDCALL brlapi_strerror_r(const brlapi_error_t *error, char *buf, size_t buflen);
1394
1396typedef uint32_t brlapi_packetType_t;
1397
1398/* brlapi_getPacketTypeName */
1405
1406/* brlapi_exceptionHandler_t */
1418#ifndef BRLAPI_NO_SINGLE_SESSION
1419typedef void (BRLAPI_STDCALL *brlapi_exceptionHandler_t)(int error, brlapi_packetType_t type, const void *packet, size_t size);
1420#endif /* BRLAPI_NO_SINGLE_SESSION */
1421typedef void (BRLAPI_STDCALL *brlapi__exceptionHandler_t)(brlapi_handle_t *handle, int error, brlapi_packetType_t type, const void *packet, size_t size);
1422
1423/* brlapi_strexception */
1433#ifndef BRLAPI_NO_SINGLE_SESSION
1434int BRLAPI_STDCALL brlapi_strexception(char *buffer, size_t bufferSize, int error, brlapi_packetType_t type, const void *packet, size_t packetSize);
1435#endif /* BRLAPI_NO_SINGLE_SESSION */
1436int BRLAPI_STDCALL brlapi__strexception(brlapi_handle_t *handle, char *buffer, size_t bufferSize, int error, brlapi_packetType_t type, const void *packet, size_t packetSize);
1437
1438/* brlapi_setExceptionHandler */
1447#ifndef BRLAPI_NO_SINGLE_SESSION
1449#endif /* BRLAPI_NO_SINGLE_SESSION */
1451
1452#ifndef BRLAPI_NO_SINGLE_SESSION
1453void BRLAPI_STDCALL brlapi_defaultExceptionHandler(int error, brlapi_packetType_t type, const void *packet, size_t size);
1454#endif /* BRLAPI_NO_SINGLE_SESSION */
1455void BRLAPI_STDCALL brlapi__defaultExceptionHandler(brlapi_handle_t *handle, int error, brlapi_packetType_t type, const void *packet, size_t size);
1456
1459/* Windows-specific tricks - don't look at this */
1460#ifdef BRLAPI_WIN32
1461#ifndef BRLAPI_NO_SINGLE_SESSION
1462int BRLAPI_STDCALL brlapi_writeTextWin(int cursor, const void *str, int wide);
1463#endif /* BRLAPI_NO_SINGLE_SESSION */
1464int BRLAPI_STDCALL brlapi__writeTextWin(brlapi_handle_t *handle, int cursor, const void *str, int wide);
1465
1466#ifndef BRLAPI_NO_SINGLE_SESSION
1467int BRLAPI_STDCALL brlapi_writeWin(const brlapi_writeArguments_t *s, int wide);
1468#endif /* BRLAPI_NO_SINGLE_SESSION */
1469int BRLAPI_STDCALL brlapi__writeWin(brlapi_handle_t *handle, const brlapi_writeArguments_t *s, int wide);
1470
1471#ifdef UNICODE
1472#ifndef BRLAPI_NO_SINGLE_SESSION
1473#define brlapi_writeText(cursor, str) brlapi_writeTextWin(cursor, str, 1)
1474#endif /* BRLAPI_NO_SINGLE_SESSION */
1475#define brlapi__writeText(handle, cursor, str) brlapi__writeTextWin(handle, cursor, str, 1)
1476
1477#ifndef BRLAPI_NO_SINGLE_SESSION
1478#define brlapi_write(s) brlapi_writeWin(s, 1)
1479#endif /* BRLAPI_NO_SINGLE_SESSION */
1480#define brlapi__write(handle, s) brlapi__writeWin(handle, s, 1)
1481
1482#else /* UNICODE */
1483
1484#ifndef BRLAPI_NO_SINGLE_SESSION
1485#define brlapi_writeText(cursor, str) brlapi_writeTextWin(cursor, str, 0)
1486#endif /* BRLAPI_NO_SINGLE_SESSION */
1487#define brlapi__writeText(handle, cursor, str) brlapi__writeTextWin(handle, cursor, str, 0)
1488
1489#ifndef BRLAPI_NO_SINGLE_SESSION
1490#define brlapi_write(s) brlapi_writeWin(s, 0)
1491#endif /* BRLAPI_NO_SINGLE_SESSION */
1492#define brlapi__write(handle, s) brlapi__writeWin(handle, s, 0)
1493
1494#endif /* UNICODE */
1495#endif /* BRLAPI_WIN32 */
1496
1497#ifndef BRLAPI_NO_DEPRECATED
1510#define brlapi_settings_t brlapi_connectionSettings_t
1511
1513typedef struct {
1515 unsigned int regionBegin;
1516 unsigned int regionSize;
1517 const char *text;
1519 const unsigned char *attrAnd;
1520 const unsigned char *attrOr;
1522 const char *charset;
1524#define BRLAPI_WRITESTRUCT_INITIALIZER BRLAPI_WRITEARGUMENTS_INITIALIZER
1525
1526#define brl_keycode_t brlapi_keyCode_t
1527#define brl_type_t brlapi_packetType_t
1528
1529#define BRLCOMMANDS NULL
1530#define BRL_KEYCODE_MAX BRLAPI_KEY_MAX
1531
1532#ifndef BRLAPI_NO_SINGLE_SESSION
1533#define brlapi_initializeConnection brlapi_openConnection
1534#define brlapi_getTty brlapi_enterTtyMode
1535#define brlapi_getTtyPath brlapi_enterTtyModeWithPath
1536#define brlapi_leaveTty brlapi_leaveTtyMode
1537#define brlapi_unignoreKeyRange brlapi_acceptKeyRange
1538#define brlapi_unignoreKeySet brlapi_acceptKeySet
1539#define brlapi_getRaw brlapi_enterRawMode
1540#define brlapi_leaveRaw brlapi_leaveRawMode
1541#define brlapi_suspend brlapi_suspendDriver
1542#define brlapi_resume brlapi_resumeDriver
1543#endif /* BRLAPI_NO_SINGLE_SESSION */
1544
1545#define BRLERR_SUCCESS BRLAPI_ERROR_SUCCESS
1546#define BRLERR_NOMEM BRLAPI_ERROR_NOMEM
1547#define BRLERR_TTYBUSY BRLAPI_ERROR_TTYBUSY
1548#define BRLERR_DEVICEBUSY BRLAPI_ERROR_DEVICEBUSY
1549#define BRLERR_UNKNOWN_INSTRUCTION BRLAPI_ERROR_UNKNOWN_INSTRUCTION
1550#define BRLERR_ILLEGAL_INSTRUCTION BRLAPI_ERROR_ILLEGAL_INSTRUCTION
1551#define BRLERR_INVALID_PARAMETER BRLAPI_ERROR_INVALID_PARAMETER
1552#define BRLERR_INVALID_PACKET BRLAPI_ERROR_INVALID_PACKET
1553#define BRLERR_CONNREFUSED BRLAPI_ERROR_CONNREFUSED
1554#define BRLERR_OPNOTSUPP BRLAPI_ERROR_OPNOTSUPP
1555#define BRLERR_GAIERR BRLAPI_ERROR_GAIERR
1556#define BRLERR_LIBCERR BRLAPI_ERROR_LIBCERR
1557#define BRLERR_UNKNOWNTTY BRLAPI_ERROR_UNKNOWNTTY
1558#define BRLERR_PROTOCOL_VERSION BRLAPI_ERROR_PROTOCOL_VERSION
1559#define BRLERR_EOF BRLAPI_ERROR_EOF
1560#define BRLERR_EMPTYKEY BRLAPI_ERROR_EMPTYKEY
1561#define BRLERR_DRIVERERROR BRLAPI_ERROR_DRIVERERROR
1562
1564#endif /* BRLAPI_NO_DEPRECATED */
1565
1566#ifdef __cplusplus
1567}
1568#endif /* __cplusplus */
1569
1570#endif /* BRLAPI_INCLUDED */
#define BRLAPI_ERROR_INVALID_PARAMETER
Definition: brlapi.h:1272
#define BRLAPI_ERROR_DEVICEBUSY
Definition: brlapi.h:1266
#define BRLAPI_ERROR_TTYBUSY
Definition: brlapi.h:1264
#define BRLAPI_ERROR_UNKNOWNTTY
Definition: brlapi.h:1284
#define BRLAPI_ERROR_DRIVERERROR
Definition: brlapi.h:1292
#define BRLAPI_ERROR_AUTHENTICATION
Definition: brlapi.h:1294
#define BRLAPI_ERROR_LIBCERR
Definition: brlapi.h:1282
#define BRLAPI_ERROR_GAIERR
Definition: brlapi.h:1280
#define BRLAPI_ERROR_OPNOTSUPP
Definition: brlapi.h:1278
#define BRLAPI_ERROR_ILLEGAL_INSTRUCTION
Definition: brlapi.h:1270
#define BRLAPI_ERROR_EMPTYKEY
Definition: brlapi.h:1290
#define BRLAPI_ERROR_SUCCESS
Definition: brlapi.h:1260
#define BRLAPI_STDCALL
Definition: brlapi.h:61
#define BRLAPI_ERROR_INVALID_PACKET
Definition: brlapi.h:1274
#define BRLAPI_ERROR_READONLY_PARAMETER
Definition: brlapi.h:1296
#define BRLAPI_ERROR_NOMEM
Definition: brlapi.h:1262
#define BRLAPI_ERROR_EOF
Definition: brlapi.h:1288
#define BRLAPI_ERROR_CONNREFUSED
Definition: brlapi.h:1276
#define BRLAPI_ERROR_PROTOCOL_VERSION
Definition: brlapi.h:1286
#define BRLAPI_ERROR_UNKNOWN_INSTRUCTION
Definition: brlapi.h:1268
uint64_t brlapi_param_subparam_t
Definition: brlapi_param.h:108
void BRLAPI_STDCALL brlapi_setClientData(void *data)
void *BRLAPI_STDCALL brlapi__getClientData(brlapi_handle_t *handle)
void *BRLAPI_STDCALL brlapi_getClientData(void)
void BRLAPI_STDCALL brlapi__setClientData(brlapi_handle_t *handle, void *data)
int brlapi_fileDescriptor
Definition: brlapi.h:164
brlapi_fileDescriptor BRLAPI_STDCALL brlapi__getFileDescriptor(brlapi_handle_t *handle)
void BRLAPI_STDCALL brlapi_closeConnection(void)
void BRLAPI_STDCALL brlapi__closeConnection(brlapi_handle_t *handle)
brlapi_fileDescriptor BRLAPI_STDCALL brlapi__openConnection(brlapi_handle_t *handle, const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings)
brlapi_fileDescriptor BRLAPI_STDCALL brlapi_openConnection(const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings)
brlapi_fileDescriptor BRLAPI_STDCALL brlapi_getFileDescriptor(void)
int BRLAPI_STDCALL brlapi_resumeDriver(void)
int BRLAPI_STDCALL brlapi__leaveRawMode(brlapi_handle_t *handle)
int BRLAPI_STDCALL brlapi__resumeDriver(brlapi_handle_t *handle)
ssize_t BRLAPI_STDCALL brlapi__sendRaw(brlapi_handle_t *handle, const void *buffer, size_t size)
int BRLAPI_STDCALL brlapi__enterRawMode(brlapi_handle_t *handle, const char *driver)
int BRLAPI_STDCALL brlapi__suspendDriver(brlapi_handle_t *handle, const char *driver)
int BRLAPI_STDCALL brlapi_leaveRawMode(void)
ssize_t BRLAPI_STDCALL brlapi_sendRaw(const void *buffer, size_t size)
ssize_t BRLAPI_STDCALL brlapi__recvRaw(brlapi_handle_t *handle, void *buffer, size_t size)
int BRLAPI_STDCALL brlapi_enterRawMode(const char *driver)
int BRLAPI_STDCALL brlapi_suspendDriver(const char *driver)
ssize_t BRLAPI_STDCALL brlapi_recvRaw(void *buffer, size_t size)
void(BRLAPI_STDCALL * brlapi_exceptionHandler_t)(int error, brlapi_packetType_t type, const void *packet, size_t size)
Definition: brlapi.h:1419
int BRLAPI_STDCALL brlapi_strexception(char *buffer, size_t bufferSize, int error, brlapi_packetType_t type, const void *packet, size_t packetSize)
void BRLAPI_STDCALL brlapi__defaultExceptionHandler(brlapi_handle_t *handle, int error, brlapi_packetType_t type, const void *packet, size_t size)
void BRLAPI_STDCALL brlapi_defaultExceptionHandler(int error, brlapi_packetType_t type, const void *packet, size_t size)
size_t BRLAPI_STDCALL brlapi_strerror_r(const brlapi_error_t *error, char *buf, size_t buflen)
#define brlapi_errno
Definition: brlapi.h:1358
const char * brlapi_errlist[]
const char *BRLAPI_STDCALL brlapi_getPacketTypeName(brlapi_packetType_t type)
const int brlapi_nerr
#define brlapi_errfun
Definition: brlapi.h:1364
#define brlapi_error
Definition: brlapi.h:1356
void BRLAPI_STDCALL brlapi_perror(const char *s)
brlapi_error
Definition: brlapi.h:1258
#define brlapi_gaierrno
Definition: brlapi.h:1362
int BRLAPI_STDCALL brlapi__strexception(brlapi_handle_t *handle, char *buffer, size_t bufferSize, int error, brlapi_packetType_t type, const void *packet, size_t packetSize)
#define brlapi_libcerrno
Definition: brlapi.h:1360
brlapi_exceptionHandler_t BRLAPI_STDCALL brlapi_setExceptionHandler(brlapi_exceptionHandler_t handler)
brlapi__exceptionHandler_t BRLAPI_STDCALL brlapi__setExceptionHandler(brlapi_handle_t *handle, brlapi__exceptionHandler_t handler)
const char *BRLAPI_STDCALL brlapi_strerror(const brlapi_error_t *error)
uint32_t brlapi_packetType_t
Definition: brlapi.h:1396
brlapi_error_t *BRLAPI_STDCALL brlapi_error_location(void)
void(BRLAPI_STDCALL * brlapi__exceptionHandler_t)(brlapi_handle_t *handle, int error, brlapi_packetType_t type, const void *packet, size_t size)
Definition: brlapi.h:1421
struct brlapi_handle_t brlapi_handle_t
Definition: brlapi.h:105
size_t BRLAPI_STDCALL brlapi_getHandleSize(void)
int BRLAPI_STDCALL brlapi__getModelIdentifier(brlapi_handle_t *handle, char *buffer, size_t size)
int BRLAPI_STDCALL brlapi__getDriverName(brlapi_handle_t *handle, char *buffer, size_t size)
int BRLAPI_STDCALL brlapi_getDriverName(char *buffer, size_t size)
int BRLAPI_STDCALL brlapi_getDisplaySize(unsigned int *x, unsigned int *y)
int BRLAPI_STDCALL brlapi__getDisplaySize(brlapi_handle_t *handle, unsigned int *x, unsigned int *y)
int BRLAPI_STDCALL brlapi_getModelIdentifier(char *buffer, size_t size)
uint64_t brlapi_keyCode_t
Definition: brlapi_keycodes.h:109
#define BRLAPI_KEY_FLAGS_SHIFT
Definition: brlapi_keycodes.h:130
brlapi_rangeType_t
Definition: brlapi.h:848
int BRLAPI_STDCALL brlapi__acceptKeys(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count)
int BRLAPI_STDCALL brlapi_acceptKeys(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count)
#define brlapi__ignoreAllKeys(handle)
Definition: brlapi.h:903
int BRLAPI_STDCALL brlapi_describeKeyCode(brlapi_keyCode_t code, brlapi_describedKeyCode_t *description)
int BRLAPI_STDCALL brlapi_readKey(int wait, brlapi_keyCode_t *code)
#define brlapi__acceptAllKeys(handle)
Definition: brlapi.h:921
int BRLAPI_STDCALL brlapi__ignoreKeyRanges(brlapi_handle_t *handle, const brlapi_range_t ranges[], unsigned int count)
int BRLAPI_STDCALL brlapi_ignoreKeys(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count)
int BRLAPI_STDCALL brlapi__acceptKeyRanges(brlapi_handle_t *handle, const brlapi_range_t ranges[], unsigned int count)
int BRLAPI_STDCALL brlapi__readKey(brlapi_handle_t *handle, int wait, brlapi_keyCode_t *code)
int BRLAPI_STDCALL brlapi__ignoreKeys(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count)
int BRLAPI_STDCALL brlapi_acceptKeyRanges(const brlapi_range_t ranges[], unsigned int count)
#define brlapi_ignoreAllKeys()
Definition: brlapi.h:900
int BRLAPI_STDCALL brlapi_readKeyWithTimeout(int timeout_ms, brlapi_keyCode_t *code)
int BRLAPI_STDCALL brlapi__readKeyWithTimeout(brlapi_handle_t *handle, int timeout_ms, brlapi_keyCode_t *code)
#define brlapi_acceptAllKeys()
Definition: brlapi.h:918
int BRLAPI_STDCALL brlapi_ignoreKeyRanges(const brlapi_range_t ranges[], unsigned int count)
int BRLAPI_STDCALL brlapi_expandKeyCode(brlapi_keyCode_t code, brlapi_expandedKeyCode_t *expansion)
@ brlapi_rangeType_all
Definition: brlapi.h:849
@ brlapi_rangeType_key
Definition: brlapi.h:852
@ brlapi_rangeType_command
Definition: brlapi.h:851
@ brlapi_rangeType_type
Definition: brlapi.h:850
@ brlapi_rangeType_code
Definition: brlapi.h:853
int BRLAPI_STDCALL brlapi__pause(brlapi_handle_t *handle, int timeout_ms)
int BRLAPI_STDCALL brlapi_pause(int timeout_ms)
int BRLAPI_STDCALL brlapi_sync(void)
int BRLAPI_STDCALL brlapi__sync(brlapi_handle_t *handle)
void * brlapi_paramCallbackDescriptor_t
Definition: brlapi.h:1158
brlapi_paramCallbackDescriptor_t BRLAPI_STDCALL brlapi_watchParameter(brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, brlapi_paramCallback_t func, void *priv, void *data, size_t len)
void *BRLAPI_STDCALL brlapi_getParameterAlloc(brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, size_t *len)
int BRLAPI_STDCALL brlapi_setParameter(brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, const void *data, size_t len)
uint32_t brlapi_param_flags_t
Definition: brlapi.h:1077
brlapi_param_t
Definition: brlapi_param.h:36
ssize_t BRLAPI_STDCALL brlapi_getParameter(brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, void *data, size_t len)
brlapi_paramCallbackDescriptor_t BRLAPI_STDCALL brlapi__watchParameter(brlapi_handle_t *handle, brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, brlapi_paramCallback_t func, void *priv, void *data, size_t len)
int BRLAPI_STDCALL brlapi__setParameter(brlapi_handle_t *handle, brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, const void *data, size_t len)
void *BRLAPI_STDCALL brlapi__getParameterAlloc(brlapi_handle_t *handle, brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, size_t *len)
int BRLAPI_STDCALL brlapi_unwatchParameter(brlapi_paramCallbackDescriptor_t descriptor)
void(* brlapi_paramCallback_t)(brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, void *priv, const void *data, size_t len)
Definition: brlapi.h:1151
int BRLAPI_STDCALL brlapi__unwatchParameter(brlapi_handle_t *handle, brlapi_paramCallbackDescriptor_t descriptor)
ssize_t BRLAPI_STDCALL brlapi__getParameter(brlapi_handle_t *handle, brlapi_param_t parameter, brlapi_param_subparam_t subparam, brlapi_param_flags_t flags, void *data, size_t len)
int BRLAPI_STDCALL brlapi_enterTtyModeWithPath(const int *ttys, int count, const char *driver)
int BRLAPI_STDCALL brlapi_setFocus(int tty)
int BRLAPI_STDCALL brlapi_leaveTtyMode(void)
int BRLAPI_STDCALL brlapi_enterTtyMode(int tty, const char *driver)
int BRLAPI_STDCALL brlapi__enterTtyMode(brlapi_handle_t *handle, int tty, const char *driver)
int BRLAPI_STDCALL brlapi__leaveTtyMode(brlapi_handle_t *handle)
int BRLAPI_STDCALL brlapi__setFocus(brlapi_handle_t *handle, int tty)
int BRLAPI_STDCALL brlapi__enterTtyModeWithPath(brlapi_handle_t *handle, const int *ttys, int count, const char *driver)
void brlapi_getLibraryVersion(int *major, int *minor, int *revision)
int BRLAPI_STDCALL brlapi__writeWText(brlapi_handle_t *handle, int cursor, const wchar_t *text)
int BRLAPI_STDCALL brlapi_write(const brlapi_writeArguments_t *arguments)
int BRLAPI_STDCALL brlapi__writeText(brlapi_handle_t *handle, int cursor, const char *text)
int BRLAPI_STDCALL brlapi_writeWText(int cursor, const wchar_t *text)
int BRLAPI_STDCALL brlapi__writeDots(brlapi_handle_t *handle, const unsigned char *dots)
int BRLAPI_STDCALL brlapi_writeText(int cursor, const char *text)
int BRLAPI_STDCALL brlapi_writeDots(const unsigned char *dots)
int BRLAPI_STDCALL brlapi__write(brlapi_handle_t *handle, const brlapi_writeArguments_t *arguments)
Settings structure for BrlAPI connection.
Definition: brlapi.h:207
const char * host
Definition: brlapi.h:225
const char * auth
Definition: brlapi.h:215
Definition: brlapi.h:725
Definition: brlapi.h:1319
int gaierrno
Definition: brlapi.h:1322
enum brlapi_error brlerrno
Definition: brlapi.h:1320
const char * errfun
Definition: brlapi.h:1323
int libcerrno
Definition: brlapi.h:1321
Definition: brlapi.h:706
Definition: brlapi.h:927
brlapi_keyCode_t last
Definition: brlapi.h:929
brlapi_keyCode_t first
Definition: brlapi.h:928
Definition: brlapi.h:594
Definition: brlapi.h:1513
int displayNumber
Definition: brlapi.h:1514
int cursor
Definition: brlapi.h:1521
unsigned int regionBegin
Definition: brlapi.h:1515
unsigned int regionSize
Definition: brlapi.h:1516
const char * text
Definition: brlapi.h:1517
const unsigned char * attrOr
Definition: brlapi.h:1520
const char * charset
Definition: brlapi.h:1522
const unsigned char * attrAnd
Definition: brlapi.h:1519
int textSize
Definition: brlapi.h:1518