BrlAPI: brlapi.h Source File

BrlAPI 0.6

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

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-2018 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.com/
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
29 extern "C" {
30 #endif /* __cplusplus */
31
32 /* #undef BRLAPI_WIN32 */
33
38 #define BRLAPI_RELEASE "0.6.7"
39
41 #define BRLAPI_MAJOR 0
42
44 #define BRLAPI_MINOR 6
45
47 #define BRLAPI_REVISION 7
48
51 /* Types are defined there */
52 #include <sys/types.h>
53
54 #ifdef BRLAPI_WIN32
55 #include <windows.h>
56 #define BRLAPI_STDCALL __stdcall
57 #else /* BRLAPI_WIN32 */
58 #define BRLAPI_STDCALL
59 #endif /* BRLAPI_WIN32 */
60
61 #ifdef _MSC_VER
62 typedef __int64 uint64_t;
63 typedef __int32 uint32_t;
64 #define UINT64_C(x) (x ## Ui64)
65 #define PRIx64 "I64x"
66 typedef signed int ssize_t;
67 #else /* _MSC_VER */
68
69 /* this is for uint*_t */
70 #include <stdint.h>
71
72 /* NULL is defined there */
73 #include <unistd.h>
74
75 #include <inttypes.h> /* For PRIx64 */
76 #endif /* _MSC_VER */
77
78 #include <wchar.h>
79
102 typedef struct brlapi_handle_t brlapi_handle_t;
103
105 size_t BRLAPI_STDCALL brlapi_getHandleSize(void);
106
120 #define BRLAPI_SOCKETPORTNUM 4101
121 #define BRLAPI_SOCKETPORT "4101"
122
124 #define BRLAPI_SOCKETPATH "/var/lib/BrlAPI"
125
130 #define BRLAPI_ETCDIR "/etc"
131
135 #define BRLAPI_AUTHKEYFILE "brlapi.key"
136
138 #ifdef BRLAPI_WIN32
139 /* No authentication by default on Windows */
140 #define BRLAPI_DEFAUTH "none"
141 #else /* BRLAPI_WIN32 */
142 #define BRLAPI_DEFAUTH_KEYFILE "keyfile:" BRLAPI_ETCDIR "/" BRLAPI_AUTHKEYFILE
143
144 #ifdef USE_POLKIT
145 #define BRLAPI_DEFAUTH_POLKIT "+polkit"
146 #else /* USE_POLKIT */
147 #define BRLAPI_DEFAUTH_POLKIT ""
148 #endif /* USE_POLKIT */
149
150 #define BRLAPI_DEFAUTH BRLAPI_DEFAUTH_KEYFILE BRLAPI_DEFAUTH_POLKIT
151 #endif /* BRLAPI_WIN32 */
152
153 #ifdef __MINGW32__
154 typedef HANDLE brlapi_fileDescriptor;
155 #else /* __MINGW32__ */
156 typedef int brlapi_fileDescriptor;
157 #endif /* __MINGW32__ */
158
189 typedef struct {
197 char *auth;
198
207 char *host;
208 } brlapi_connectionSettings_t;
209
210 /* BRLAPI_SETTINGS_INITIALIZER */
213 #define BRLAPI_SETTINGS_INITIALIZER { NULL, NULL }
214
215 /* brlapi_openConnection */
260 #ifndef BRLAPI_NO_SINGLE_SESSION
261 brlapi_fileDescriptor BRLAPI_STDCALL brlapi_openConnection(const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings);
262 #endif /* BRLAPI_NO_SINGLE_SESSION */
263 brlapi_fileDescriptor BRLAPI_STDCALL brlapi__openConnection(brlapi_handle_t *handle, const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings);
264
265 /* brlapi_closeConnection */
272 #ifndef BRLAPI_NO_SINGLE_SESSION
273 void BRLAPI_STDCALL brlapi_closeConnection(void);
274 #endif /* BRLAPI_NO_SINGLE_SESSION */
275 void BRLAPI_STDCALL brlapi__closeConnection(brlapi_handle_t *handle);
276
292 #define BRLAPI_MAXNAMELENGTH 31
293
294 /* brlapi_getDriverName */
306 #ifndef BRLAPI_NO_SINGLE_SESSION
307 int BRLAPI_STDCALL brlapi_getDriverName(char *buffer, size_t size);
308 #endif /* BRLAPI_NO_SINGLE_SESSION */
309 int BRLAPI_STDCALL brlapi__getDriverName(brlapi_handle_t *handle, char *buffer, size_t size);
310
311 /* brlapi_getModelIdentifier */
323 #ifndef BRLAPI_NO_SINGLE_SESSION
324 int BRLAPI_STDCALL brlapi_getModelIdentifier(char *buffer, size_t size);
325 #endif /* BRLAPI_NO_SINGLE_SESSION */
326 int BRLAPI_STDCALL brlapi__getModelIdentifier(brlapi_handle_t *handle, char *buffer, size_t size);
327
328 /* brlapi_getDisplaySize */
330 #ifndef BRLAPI_NO_SINGLE_SESSION
331 int BRLAPI_STDCALL brlapi_getDisplaySize(unsigned int *x, unsigned int *y);
332 #endif /* BRLAPI_NO_SINGLE_SESSION */
333 int BRLAPI_STDCALL brlapi__getDisplaySize(brlapi_handle_t *handle, unsigned int *x, unsigned int *y);
334
358 /* brlapi_enterTtyMode */
378 #ifndef BRLAPI_NO_SINGLE_SESSION
379 int BRLAPI_STDCALL brlapi_enterTtyMode(int tty, const char *driver);
380 #endif /* BRLAPI_NO_SINGLE_SESSION */
381 int BRLAPI_STDCALL brlapi__enterTtyMode(brlapi_handle_t *handle, int tty, const char *driver);
382
392 #define BRLAPI_TTY_DEFAULT -1
393
394 /* brlapi_enterTtyModeWithPath */
406 #ifndef BRLAPI_NO_SINGLE_SESSION
407 int BRLAPI_STDCALL brlapi_enterTtyModeWithPath(int *ttys, int count, const char *driver);
408 #endif /* BRLAPI_NO_SINGLE_SESSION */
409 int BRLAPI_STDCALL brlapi__enterTtyModeWithPath(brlapi_handle_t *handle, int *ttys, int count, const char *driver);
410
411 /* brlapi_leaveTtyMode */
418 #ifndef BRLAPI_NO_SINGLE_SESSION
419 int BRLAPI_STDCALL brlapi_leaveTtyMode(void);
420 #endif /* BRLAPI_NO_SINGLE_SESSION */
421 int BRLAPI_STDCALL brlapi__leaveTtyMode(brlapi_handle_t *handle);
422
423 /* brlapi_setFocus */
434 #ifndef BRLAPI_NO_SINGLE_SESSION
435 int BRLAPI_STDCALL brlapi_setFocus(int tty);
436 #endif /* BRLAPI_NO_SINGLE_SESSION */
437 int BRLAPI_STDCALL brlapi__setFocus(brlapi_handle_t *handle, int tty);
438
468 /* brlapi_writeText */
483 #ifndef BRLAPI_NO_SINGLE_SESSION
484 int BRLAPI_STDCALL brlapi_writeText(int cursor, const char *text);
485 #endif /* BRLAPI_NO_SINGLE_SESSION */
486 int BRLAPI_STDCALL brlapi__writeText(brlapi_handle_t *handle, int cursor, const char *text);
487
488 /* brlapi_writeWText */
501 #ifndef BRLAPI_NO_SINGLE_SESSION
502 int BRLAPI_STDCALL brlapi_writeWText(int cursor, const wchar_t *text);
503 #endif /* BRLAPI_NO_SINGLE_SESSION */
504 int BRLAPI_STDCALL brlapi__writeWText(brlapi_handle_t *handle, int cursor, const wchar_t *text);
505
506 /* brlapi_writeDots */
514 #ifndef BRLAPI_NO_SINGLE_SESSION
515 int BRLAPI_STDCALL brlapi_writeDots(const unsigned char *dots);
516 #endif /* BRLAPI_NO_SINGLE_SESSION */
517 int BRLAPI_STDCALL brlapi__writeDots(brlapi_handle_t *handle, const unsigned char *dots);
518
519 /* brlapi_writeArguments_t */
521 typedef struct {
522 int displayNumber ;
523 unsigned int regionBegin ;
524 unsigned int regionSize ;
525 char *text ;
526 int textSize ;
527 unsigned char *andMask ;
528 unsigned char *orMask ;
529 int cursor ;
530 char *charset ;
531 } brlapi_writeArguments_t;
532
537 #define BRLAPI_DISPLAY_DEFAULT -1
538
543 #define BRLAPI_CURSOR_LEAVE -1
544
549 #define BRLAPI_CURSOR_OFF 0
550
551 /* BRLAPI_WRITEARGUMENTS_INITIALIZER */
561 #define BRLAPI_WRITEARGUMENTS_INITIALIZER { \
562 .displayNumber = BRLAPI_DISPLAY_DEFAULT, \
563 .regionBegin = 0, \
564 .regionSize = 0, \
565 .text = NULL, \
566 .textSize = -1, \
567 .andMask = NULL, \
568 .orMask = NULL, \
569 .cursor = BRLAPI_CURSOR_LEAVE, \
570 .charset = NULL \
571 }
572
573 /* brlapi_write */
609 #ifndef BRLAPI_NO_SINGLE_SESSION
610 int BRLAPI_STDCALL brlapi_write(const brlapi_writeArguments_t *arguments);
611 #endif /* BRLAPI_NO_SINGLE_SESSION */
612 int BRLAPI_STDCALL brlapi__write(brlapi_handle_t *handle, const brlapi_writeArguments_t *arguments);
613
616 #include "brlapi_keycodes.h"
617
631 /* brlapi_expandedKeyCode_t */
633 typedef struct {
634 unsigned int type ;
635 unsigned int command ;
636 unsigned int argument ;
637 unsigned int flags ;
638 } brlapi_expandedKeyCode_t;
639
640 /* brlapi_expandKeyCode */
648 int BRLAPI_STDCALL brlapi_expandKeyCode (brlapi_keyCode_t code, brlapi_expandedKeyCode_t *expansion);
649
650 /* brlapi_describedKeyCode_t */
652 typedef struct {
653 const char *type ;
654 const char *command ;
655 unsigned int argument ;
656 unsigned int flags ;
657 const char *flag[64 - BRLAPI_KEY_FLAGS_SHIFT] ;
658 brlapi_expandedKeyCode_t values ;
659 } brlapi_describedKeyCode_t;
660
661 /* brlapi_describeKeyCode */
669 int BRLAPI_STDCALL brlapi_describeKeyCode (brlapi_keyCode_t code, brlapi_describedKeyCode_t *description);
670
672 #define BRLAPI_UC_ROW 0x2800UL
673
674 /* brlapi_readKey */
741 #ifndef BRLAPI_NO_SINGLE_SESSION
742 int BRLAPI_STDCALL brlapi_readKey(int wait, brlapi_keyCode_t *code);
743 #endif /* BRLAPI_NO_SINGLE_SESSION */
744 int BRLAPI_STDCALL brlapi__readKey(brlapi_handle_t *handle, int wait, brlapi_keyCode_t *code);
745
747 typedef enum {
748 brlapi_rangeType_all,
749 brlapi_rangeType_type,
750 brlapi_rangeType_command,
751 brlapi_rangeType_key,
752 brlapi_rangeType_code,
753 } brlapi_rangeType_t;
754
755 /* brlapi_ignoreKeys */
768 #ifndef BRLAPI_NO_SINGLE_SESSION
769 int BRLAPI_STDCALL brlapi_ignoreKeys(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
770 #endif /* BRLAPI_NO_SINGLE_SESSION */
771 int BRLAPI_STDCALL brlapi__ignoreKeys(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
772
773 /* brlapi_acceptKeys */
786 #ifndef BRLAPI_NO_SINGLE_SESSION
787 int BRLAPI_STDCALL brlapi_acceptKeys(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
788 #endif /* BRLAPI_NO_SINGLE_SESSION */
789 int BRLAPI_STDCALL brlapi__acceptKeys(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
790
791 /* brlapi_ignoreAllKeys */
797 #ifndef BRLAPI_NO_SINGLE_SESSION
798 int BRLAPI_STDCALL brlapi_ignoreAllKeys(void);
799 #define brlapi_ignoreAllKeys() brlapi_ignoreKeys(brlapi_rangeType_all, NULL, 0)
800 #endif /* BRLAPI_NO_SINGLE_SESSION */
801 int BRLAPI_STDCALL brlapi__ignoreAllKeys(brlapi_handle_t *handle);
802 #define brlapi__ignoreAllKeys(handle) brlapi__ignoreKeys(handle, brlapi_rangeType_all, NULL, 0)
803
804 /* brlapi_acceptAllKeys */
813 #ifndef BRLAPI_NO_SINGLE_SESSION
814 int BRLAPI_STDCALL brlapi_acceptAllKeys(void);
815 #define brlapi_acceptAllKeys() brlapi_acceptKeys(brlapi_rangeType_all, NULL, 0)
816 #endif /* BRLAPI_NO_SINGLE_SESSION */
817 int BRLAPI_STDCALL brlapi__acceptAllKeys(brlapi_handle_t *handle);
818 #define brlapi__acceptAllKeys(handle) brlapi__acceptKeys(handle, brlapi_rangeType_all, NULL, 0)
819
824 typedef struct {
825 brlapi_keyCode_t first;
826 brlapi_keyCode_t last;
827 } brlapi_range_t;
828
829 /* brlapi_ignoreKeyRanges */
840 #ifndef BRLAPI_NO_SINGLE_SESSION
841 int BRLAPI_STDCALL brlapi_ignoreKeyRanges(const brlapi_range_t ranges[], unsigned int count);
842 #endif /* BRLAPI_NO_SINGLE_SESSION */
843 int BRLAPI_STDCALL brlapi__ignoreKeyRanges(brlapi_handle_t *handle, const brlapi_range_t ranges[], unsigned int count);
844
845 /* brlapi_acceptKeyRanges */
856 #ifndef BRLAPI_NO_SINGLE_SESSION
857 int BRLAPI_STDCALL brlapi_acceptKeyRanges(const brlapi_range_t ranges[], unsigned int count);
858 #endif /* BRLAPI_NO_SINGLE_SESSION */
859 int BRLAPI_STDCALL brlapi__acceptKeyRanges(brlapi_handle_t *handle, const brlapi_range_t ranges[], unsigned int count);
885 /* brlapi_enterRawMode */
890 #ifndef BRLAPI_NO_SINGLE_SESSION
891 int BRLAPI_STDCALL brlapi_enterRawMode(const char *driver);
892 #endif /* BRLAPI_NO_SINGLE_SESSION */
893 int BRLAPI_STDCALL brlapi__enterRawMode(brlapi_handle_t *handle, const char *driver);
894
895 /* brlapi_leaveRawMode */
898 #ifndef BRLAPI_NO_SINGLE_SESSION
899 int BRLAPI_STDCALL brlapi_leaveRawMode(void);
900 #endif /* BRLAPI_NO_SINGLE_SESSION */
901 int BRLAPI_STDCALL brlapi__leaveRawMode(brlapi_handle_t *handle);
902
903 /* brlapi_sendRaw */
909 #ifndef BRLAPI_NO_SINGLE_SESSION
910 ssize_t BRLAPI_STDCALL brlapi_sendRaw(const void *buffer, size_t size);
911 #endif /* BRLAPI_NO_SINGLE_SESSION */
912 ssize_t BRLAPI_STDCALL brlapi__sendRaw(brlapi_handle_t *handle, const void *buffer, size_t size);
913
914 /* brlapi_recvRaw */
921 #ifndef BRLAPI_NO_SINGLE_SESSION
922 ssize_t BRLAPI_STDCALL brlapi_recvRaw(void *buffer, size_t size);
923 #endif /* BRLAPI_NO_SINGLE_SESSION */
924 ssize_t BRLAPI_STDCALL brlapi__recvRaw(brlapi_handle_t *handle, void *buffer, size_t size);
925
926 /* brlapi_suspendDriver */
931 #ifndef BRLAPI_NO_SINGLE_SESSION
932 int BRLAPI_STDCALL brlapi_suspendDriver(const char *driver);
933 #endif /* BRLAPI_NO_SINGLE_SESSION */
934 int BRLAPI_STDCALL brlapi__suspendDriver(brlapi_handle_t *handle, const char *driver);
935
936 /* brlapi_resumeDriver */
940 #ifndef BRLAPI_NO_SINGLE_SESSION
941 int BRLAPI_STDCALL brlapi_resumeDriver(void);
942 #endif /* BRLAPI_NO_SINGLE_SESSION */
943 int BRLAPI_STDCALL brlapi__resumeDriver(brlapi_handle_t *handle);
967 /* Error codes */
968 #define BRLAPI_ERROR_SUCCESS 0
969 #define BRLAPI_ERROR_NOMEM 1
970 #define BRLAPI_ERROR_TTYBUSY 2
971 #define BRLAPI_ERROR_DEVICEBUSY 3
972 #define BRLAPI_ERROR_UNKNOWN_INSTRUCTION 4
973 #define BRLAPI_ERROR_ILLEGAL_INSTRUCTION 5
974 #define BRLAPI_ERROR_INVALID_PARAMETER 6
975 #define BRLAPI_ERROR_INVALID_PACKET 7
976 #define BRLAPI_ERROR_CONNREFUSED 8
977 #define BRLAPI_ERROR_OPNOTSUPP 9
978 #define BRLAPI_ERROR_GAIERR 10
979 #define BRLAPI_ERROR_LIBCERR 11
980 #define BRLAPI_ERROR_UNKNOWNTTY 12
981 #define BRLAPI_ERROR_PROTOCOL_VERSION 13
982 #define BRLAPI_ERROR_EOF 14
983 #define BRLAPI_ERROR_EMPTYKEY 15
984 #define BRLAPI_ERROR_DRIVERERROR 16
985 #define BRLAPI_ERROR_AUTHENTICATION 17
987 /* brlapi_errlist */
988
992 extern const char *brlapi_errlist[];
993
994 /* brlapi_nerr */
996 extern const int brlapi_nerr;
997
998 /* brlapi_perror */
1003 void BRLAPI_STDCALL brlapi_perror(const char *s);
1004
1005 /* brlapi_error_t */
1007 typedef struct {
1008 int brlerrno;
1009 int libcerrno;
1010 int gaierrno;
1011 const char *errfun;
1012 } brlapi_error_t;
1013
1022 brlapi_error_t * BRLAPI_STDCALL brlapi_error_location(void);
1023
1032 extern brlapi_error_t brlapi_error;
1033
1035 extern int brlapi_errno;
1037 extern int brlapi_libcerrno;
1039 extern int brlapi_gaierrno;
1041 extern const char *brlapi_errfun;
1042
1044 #define brlapi_error (*brlapi_error_location())
1045
1046 #define brlapi_errno (brlapi_error.brlerrno)
1047
1048 #define brlapi_libcerrno (brlapi_error.libcerrno)
1049
1050 #define brlapi_gaierrno (brlapi_error.gaierrno)
1051
1052 #define brlapi_errfun (brlapi_error.errfun)
1053
1054 /* brlapi_strerror */
1060 const char * BRLAPI_STDCALL brlapi_strerror(const brlapi_error_t *error);
1061
1063 typedef uint32_t brlapi_packetType_t;
1064
1065 /* brlapi_getPacketTypeName */
1071 const char * BRLAPI_STDCALL brlapi_getPacketTypeName(brlapi_packetType_t type);
1072
1073 /* brlapi_exceptionHandler_t */
1085 #ifndef BRLAPI_NO_SINGLE_SESSION
1086 typedef void (BRLAPI_STDCALL *brlapi_exceptionHandler_t)(int error, brlapi_packetType_t type, const void *packet, size_t size);
1087 #endif /* BRLAPI_NO_SINGLE_SESSION */
1088 typedef void (BRLAPI_STDCALL *brlapi__exceptionHandler_t)(brlapi_handle_t *handle, int error, brlapi_packetType_t type, const void *packet, size_t size);
1089
1090 /* brlapi_strexception */
1100 #ifndef BRLAPI_NO_SINGLE_SESSION
1101 int BRLAPI_STDCALL brlapi_strexception(char *buffer, size_t bufferSize, int error, brlapi_packetType_t type, const void *packet, size_t packetSize);
1102 #endif /* BRLAPI_NO_SINGLE_SESSION */
1103 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);
1104
1105 /* brlapi_setExceptionHandler */
1114 #ifndef BRLAPI_NO_SINGLE_SESSION
1115 brlapi_exceptionHandler_t BRLAPI_STDCALL brlapi_setExceptionHandler(brlapi_exceptionHandler_t handler);
1116 #endif /* BRLAPI_NO_SINGLE_SESSION */
1117 brlapi__exceptionHandler_t BRLAPI_STDCALL brlapi__setExceptionHandler(brlapi_handle_t *handle, brlapi__exceptionHandler_t handler);
1118
1119 #ifndef BRLAPI_NO_SINGLE_SESSION
1120 void BRLAPI_STDCALL brlapi_defaultExceptionHandler(int error, brlapi_packetType_t type, const void *packet, size_t size);
1121 #endif /* BRLAPI_NO_SINGLE_SESSION */
1122 void BRLAPI_STDCALL brlapi__defaultExceptionHandler(brlapi_handle_t *handle, int error, brlapi_packetType_t type, const void *packet, size_t size);
1123
1126 /* Windows-specific tricks - don't look at this */
1127 #ifdef BRLAPI_WIN32
1128 #ifndef BRLAPI_NO_SINGLE_SESSION
1129 int BRLAPI_STDCALL brlapi_writeTextWin(int cursor, const void *str, int wide);
1130 #endif /* BRLAPI_NO_SINGLE_SESSION */
1131 int BRLAPI_STDCALL brlapi__writeTextWin(brlapi_handle_t *handle, int cursor, const void *str, int wide);
1132
1133 #ifndef BRLAPI_NO_SINGLE_SESSION
1134 int BRLAPI_STDCALL brlapi_writeWin(const brlapi_writeArguments_t *s, int wide);
1135 #endif /* BRLAPI_NO_SINGLE_SESSION */
1136 int BRLAPI_STDCALL brlapi__writeWin(brlapi_handle_t *handle, const brlapi_writeArguments_t *s, int wide);
1137
1138 #ifdef UNICODE
1139 #ifndef BRLAPI_NO_SINGLE_SESSION
1140 #define brlapi_writeText(cursor, str) brlapi_writeTextWin(cursor, str, 1)
1141 #endif /* BRLAPI_NO_SINGLE_SESSION */
1142 #define brlapi__writeText(handle, cursor, str) brlapi__writeTextWin(handle, cursor, str, 1)
1143
1144 #ifndef BRLAPI_NO_SINGLE_SESSION
1145 #define brlapi_write(s) brlapi_writeWin(s, 1)
1146 #endif /* BRLAPI_NO_SINGLE_SESSION */
1147 #define brlapi__write(handle, s) brlapi__writeWin(handle, s, 1)
1148
1149 #else /* UNICODE */
1150
1151 #ifndef BRLAPI_NO_SINGLE_SESSION
1152 #define brlapi_writeText(cursor, str) brlapi_writeTextWin(cursor, str, 0)
1153 #endif /* BRLAPI_NO_SINGLE_SESSION */
1154 #define brlapi__writeText(handle, cursor, str) brlapi__writeTextWin(handle, cursor, str, 0)
1155
1156 #ifndef BRLAPI_NO_SINGLE_SESSION
1157 #define brlapi_write(s) brlapi_writeWin(s, 0)
1158 #endif /* BRLAPI_NO_SINGLE_SESSION */
1159 #define brlapi__write(handle, s) brlapi__writeWin(handle, s, 0)
1160
1161 #endif /* UNICODE */
1162 #endif /* BRLAPI_WIN32 */
1163
1164 #ifndef BRLAPI_NO_DEPRECATED
1165
1177 #define brlapi_settings_t brlapi_connectionSettings_t
1178
1180 typedef struct {
1181 int displayNumber;
1182 unsigned int regionBegin;
1183 unsigned int regionSize;
1184 char *text;
1185 int textSize;
1186 unsigned char *attrAnd;
1187 unsigned char *attrOr;
1188 int cursor;
1189 char *charset;
1190 } brlapi_writeStruct;
1191 #define BRLAPI_WRITESTRUCT_INITIALIZER BRLAPI_WRITEARGUMENTS_INITIALIZER
1192
1193 #define brl_keycode_t brlapi_keyCode_t
1194 #define brl_type_t brlapi_packetType_t
1195
1196 #define BRLCOMMANDS NULL
1197 #define BRL_KEYCODE_MAX BRLAPI_KEY_MAX
1198
1199 #ifndef BRLAPI_NO_SINGLE_SESSION
1200 #define brlapi_initializeConnection brlapi_openConnection
1201 #define brlapi_getTty brlapi_enterTtyMode
1202 #define brlapi_getTtyPath brlapi_enterTtyModeWithPath
1203 #define brlapi_leaveTty brlapi_leaveTtyMode
1204 #define brlapi_unignoreKeyRange brlapi_acceptKeyRange
1205 #define brlapi_unignoreKeySet brlapi_acceptKeySet
1206 #define brlapi_getRaw brlapi_enterRawMode
1207 #define brlapi_leaveRaw brlapi_leaveRawMode
1208 #define brlapi_suspend brlapi_suspendDriver
1209 #define brlapi_resume brlapi_resumeDriver
1210 #endif /* BRLAPI_NO_SINGLE_SESSION */
1211
1212 #define BRLERR_SUCCESS BRLAPI_ERROR_SUCCESS
1213 #define BRLERR_NOMEM BRLAPI_ERROR_NOMEM
1214 #define BRLERR_TTYBUSY BRLAPI_ERROR_TTYBUSY
1215 #define BRLERR_DEVICEBUSY BRLAPI_ERROR_DEVICEBUSY
1216 #define BRLERR_UNKNOWN_INSTRUCTION BRLAPI_ERROR_UNKNOWN_INSTRUCTION
1217 #define BRLERR_ILLEGAL_INSTRUCTION BRLAPI_ERROR_ILLEGAL_INSTRUCTION
1218 #define BRLERR_INVALID_PARAMETER BRLAPI_ERROR_INVALID_PARAMETER
1219 #define BRLERR_INVALID_PACKET BRLAPI_ERROR_INVALID_PACKET
1220 #define BRLERR_CONNREFUSED BRLAPI_ERROR_CONNREFUSED
1221 #define BRLERR_OPNOTSUPP BRLAPI_ERROR_OPNOTSUPP
1222 #define BRLERR_GAIERR BRLAPI_ERROR_GAIERR
1223 #define BRLERR_LIBCERR BRLAPI_ERROR_LIBCERR
1224 #define BRLERR_UNKNOWNTTY BRLAPI_ERROR_UNKNOWNTTY
1225 #define BRLERR_PROTOCOL_VERSION BRLAPI_ERROR_PROTOCOL_VERSION
1226 #define BRLERR_EOF BRLAPI_ERROR_EOF
1227 #define BRLERR_EMPTYKEY BRLAPI_ERROR_EMPTYKEY
1228 #define BRLERR_DRIVERERROR BRLAPI_ERROR_DRIVERERROR
1229
1231 #endif /* BRLAPI_NO_DEPRECATED */
1232
1233 #ifdef __cplusplus
1234 }
1235 #endif /* __cplusplus */
1236
1237 #endif /* BRLAPI_INCLUDED */