00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00025 #ifndef BRLAPI_INCLUDED
00026 #define BRLAPI_INCLUDED
00027
00028 #ifdef __cplusplus
00029 extern "C" {
00030 #endif
00031
00032
00033
00038 #define BRLAPI_RELEASE "0.5.3"
00039
00041 #define BRLAPI_MAJOR 0
00042
00044 #define BRLAPI_MINOR 5
00045
00047 #define BRLAPI_REVISION 3
00048
00051
00052 #include <sys/types.h>
00053
00054 #ifdef BRLAPI_WIN32
00055 #include <windows.h>
00056 #define BRLAPI_STDCALL __stdcall
00057 #else
00058 #define BRLAPI_STDCALL
00059 #endif
00060
00061 #ifdef _MSC_VER
00062 typedef __int64 uint64_t;
00063 typedef __int32 uint32_t;
00064 #define UINT64_C(x) (x ## Ui64)
00065 #define PRIx64 "I64x"
00066 typedef signed int ssize_t;
00067 #else
00068
00069
00070 #include <stdint.h>
00071
00072
00073 #include <unistd.h>
00074
00075 #include <inttypes.h>
00076 #endif
00077
00100 typedef struct brlapi_handle_t brlapi_handle_t;
00101
00103 size_t BRLAPI_STDCALL brlapi_getHandleSize(void);
00104
00118 #define BRLAPI_SOCKETPORTNUM 4101
00119 #define BRLAPI_SOCKETPORT "4101"
00120
00122 #define BRLAPI_SOCKETPATH "/var/lib/BrlAPI"
00123
00128 #define BRLAPI_ETCDIR "/etc"
00129
00133 #define BRLAPI_AUTHKEYFILE "brlapi.key"
00134
00136 #define BRLAPI_DEFAUTH BRLAPI_ETCDIR "/" BRLAPI_AUTHKEYFILE
00137
00138 #ifdef __MINGW32__
00139 typedef HANDLE brlapi_fileDescriptor;
00140 #else
00141 typedef int brlapi_fileDescriptor;
00142 #endif
00143
00174 typedef struct {
00182 char *auth;
00183
00192 char *host;
00193 } brlapi_connectionSettings_t;
00194
00195
00198 #define BRLAPI_SETTINGS_INITIALIZER { NULL, NULL }
00199
00200
00245 #ifndef BRLAPI_NO_SINGLE_SESSION
00246 brlapi_fileDescriptor BRLAPI_STDCALL brlapi_openConnection(const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings);
00247 #endif
00248 brlapi_fileDescriptor BRLAPI_STDCALL brlapi__openConnection(brlapi_handle_t *handle, const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings);
00249
00250
00257 #ifndef BRLAPI_NO_SINGLE_SESSION
00258 void BRLAPI_STDCALL brlapi_closeConnection(void);
00259 #endif
00260 void BRLAPI_STDCALL brlapi__closeConnection(brlapi_handle_t *handle);
00261
00277 #define BRLAPI_MAXNAMELENGTH 31
00278
00279
00291 #ifndef BRLAPI_NO_SINGLE_SESSION
00292 int BRLAPI_STDCALL brlapi_getDriverName(char *buffer, size_t size);
00293 #endif
00294 int BRLAPI_STDCALL brlapi__getDriverName(brlapi_handle_t *handle, char *buffer, size_t size);
00295
00296
00298 #ifndef BRLAPI_NO_SINGLE_SESSION
00299 int BRLAPI_STDCALL brlapi_getDisplaySize(unsigned int *x, unsigned int *y);
00300 #endif
00301 int BRLAPI_STDCALL brlapi__getDisplaySize(brlapi_handle_t *handle, unsigned int *x, unsigned int *y);
00302
00326
00346 #ifndef BRLAPI_NO_SINGLE_SESSION
00347 int BRLAPI_STDCALL brlapi_enterTtyMode(int tty, const char *driver);
00348 #endif
00349 int BRLAPI_STDCALL brlapi__enterTtyMode(brlapi_handle_t *handle, int tty, const char *driver);
00350
00360 #define BRLAPI_TTY_DEFAULT -1
00361
00362
00374 #ifndef BRLAPI_NO_SINGLE_SESSION
00375 int BRLAPI_STDCALL brlapi_enterTtyModeWithPath(int *ttys, int count, const char *driver);
00376 #endif
00377 int BRLAPI_STDCALL brlapi__enterTtyModeWithPath(brlapi_handle_t *handle, int *ttys, int count, const char *driver);
00378
00379
00386 #ifndef BRLAPI_NO_SINGLE_SESSION
00387 int BRLAPI_STDCALL brlapi_leaveTtyMode(void);
00388 #endif
00389 int BRLAPI_STDCALL brlapi__leaveTtyMode(brlapi_handle_t *handle);
00390
00391
00402 #ifndef BRLAPI_NO_SINGLE_SESSION
00403 int BRLAPI_STDCALL brlapi_setFocus(int tty);
00404 #endif
00405 int BRLAPI_STDCALL brlapi__setFocus(brlapi_handle_t *handle, int tty);
00406
00436
00451 #ifndef BRLAPI_NO_SINGLE_SESSION
00452 int BRLAPI_STDCALL brlapi_writeText(int cursor, const char *text);
00453 #endif
00454 int BRLAPI_STDCALL brlapi__writeText(brlapi_handle_t *handle, int cursor, const char *text);
00455
00456
00464 #ifndef BRLAPI_NO_SINGLE_SESSION
00465 int BRLAPI_STDCALL brlapi_writeDots(const unsigned char *dots);
00466 #endif
00467 int BRLAPI_STDCALL brlapi__writeDots(brlapi_handle_t *handle, const unsigned char *dots);
00468
00469
00471 typedef struct {
00472 int displayNumber ;
00473 unsigned int regionBegin ;
00474 unsigned int regionSize ;
00475 char *text ;
00476 int textSize ;
00477 unsigned char *andMask ;
00478 unsigned char *orMask ;
00479 int cursor ;
00480 char *charset ;
00481 } brlapi_writeArguments_t;
00482
00487 #define BRLAPI_DISPLAY_DEFAULT -1
00488
00493 #define BRLAPI_CURSOR_LEAVE -1
00494
00499 #define BRLAPI_CURSOR_OFF 0
00500
00501
00511 #define BRLAPI_WRITEARGUMENTS_INITIALIZER { BRLAPI_DISPLAY_DEFAULT, 0, 0, NULL, -1, NULL, NULL, BRLAPI_CURSOR_LEAVE, NULL }
00512
00513
00549 #ifndef BRLAPI_NO_SINGLE_SESSION
00550 int BRLAPI_STDCALL brlapi_write(const brlapi_writeArguments_t *arguments);
00551 #endif
00552 int BRLAPI_STDCALL brlapi__write(brlapi_handle_t *handle, const brlapi_writeArguments_t *arguments);
00553
00556 #include "brlapi_keycodes.h"
00557
00571
00573 typedef struct {
00574 unsigned int type ;
00575 unsigned int command ;
00576 unsigned int argument ;
00577 unsigned int flags ;
00578 } brlapi_expandedKeyCode_t;
00579
00580
00588 int BRLAPI_STDCALL brlapi_expandKeyCode (brlapi_keyCode_t code, brlapi_expandedKeyCode_t *expansion);
00589
00590
00592 typedef struct {
00593 const char *type ;
00594 const char *command ;
00595 unsigned int argument ;
00596 unsigned int flags ;
00597 const char *flag[64 - BRLAPI_KEY_FLAGS_SHIFT] ;
00598 brlapi_expandedKeyCode_t values ;
00599 } brlapi_describedKeyCode_t;
00600
00601
00609 int BRLAPI_STDCALL brlapi_describeKeyCode (brlapi_keyCode_t code, brlapi_describedKeyCode_t *description);
00610
00612 #define BRLAPI_UC_ROW 0x2800UL
00613
00617 #define BRLAPI_MAXKEYSETSIZE (BRLAPI_MAXPACKETSIZE / sizeof(brlapi_keyCode_t))
00618
00619
00686 #ifndef BRLAPI_NO_SINGLE_SESSION
00687 int BRLAPI_STDCALL brlapi_readKey(int wait, brlapi_keyCode_t *code);
00688 #endif
00689 int BRLAPI_STDCALL brlapi__readKey(brlapi_handle_t *handle, int wait, brlapi_keyCode_t *code);
00690
00692 typedef enum {
00693 brlapi_rangeType_all,
00694 brlapi_rangeType_type,
00695 brlapi_rangeType_command,
00696 brlapi_rangeType_key,
00697 brlapi_rangeType_code,
00698 } brlapi_rangeType_t;
00699
00700
00713 #ifndef BRLAPI_NO_SINGLE_SESSION
00714 int BRLAPI_STDCALL brlapi_ignoreKeys(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
00715 #endif
00716 int BRLAPI_STDCALL brlapi__ignoreKeys(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
00717
00718
00731 #ifndef BRLAPI_NO_SINGLE_SESSION
00732 int BRLAPI_STDCALL brlapi_acceptKeys(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
00733 #endif
00734 int BRLAPI_STDCALL brlapi__acceptKeys(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
00735
00736
00742 #ifndef BRLAPI_NO_SINGLE_SESSION
00743 int BRLAPI_STDCALL brlapi_ignoreAllKeys(void);
00744 #define brlapi_ignoreAllKeys() brlapi_ignoreKeys(brlapi_rangeType_all, NULL, 0)
00745 #endif
00746 int BRLAPI_STDCALL brlapi__ignoreAllKeys(brlapi_handle_t *handle);
00747 #define brlapi__ignoreAllKeys(handle) brlapi__ignoreKeys(handle, brlapi_rangeType_all, NULL, 0)
00748
00749
00758 #ifndef BRLAPI_NO_SINGLE_SESSION
00759 int BRLAPI_STDCALL brlapi_acceptAllKeys(void);
00760 #define brlapi_acceptAllKeys() brlapi_acceptKeys(brlapi_rangeType_all, NULL, 0)
00761 #endif
00762 int BRLAPI_STDCALL brlapi__acceptAllKeys(brlapi_handle_t *handle);
00763 #define brlapi__acceptAllKeys(handle) brlapi__acceptKeys(handle, brlapi_rangeType_all, NULL, 0)
00764
00769 typedef struct {
00770 brlapi_keyCode_t first;
00771 brlapi_keyCode_t last;
00772 } brlapi_range_t;
00773
00774
00785 #ifndef BRLAPI_NO_SINGLE_SESSION
00786 int BRLAPI_STDCALL brlapi_ignoreKeyRanges(brlapi_range_t ranges[], unsigned int count);
00787 #endif
00788 int BRLAPI_STDCALL brlapi__ignoreKeyRanges(brlapi_handle_t *handle, brlapi_range_t ranges[], unsigned int count);
00789
00790
00801 #ifndef BRLAPI_NO_SINGLE_SESSION
00802 int BRLAPI_STDCALL brlapi_acceptKeyRanges(brlapi_range_t ranges[], unsigned int count);
00803 #endif
00804 int BRLAPI_STDCALL brlapi__acceptKeyRanges(brlapi_handle_t *handle, brlapi_range_t ranges[], unsigned int count);
00830
00835 #ifndef BRLAPI_NO_SINGLE_SESSION
00836 int BRLAPI_STDCALL brlapi_enterRawMode(const char *driver);
00837 #endif
00838 int BRLAPI_STDCALL brlapi__enterRawMode(brlapi_handle_t *handle, const char *driver);
00839
00840
00843 #ifndef BRLAPI_NO_SINGLE_SESSION
00844 int BRLAPI_STDCALL brlapi_leaveRawMode(void);
00845 #endif
00846 int BRLAPI_STDCALL brlapi__leaveRawMode(brlapi_handle_t *handle);
00847
00848
00854 #ifndef BRLAPI_NO_SINGLE_SESSION
00855 ssize_t BRLAPI_STDCALL brlapi_sendRaw(const void *buffer, size_t size);
00856 #endif
00857 ssize_t BRLAPI_STDCALL brlapi__sendRaw(brlapi_handle_t *handle, const void *buffer, size_t size);
00858
00859
00866 #ifndef BRLAPI_NO_SINGLE_SESSION
00867 ssize_t BRLAPI_STDCALL brlapi_recvRaw(void *buffer, size_t size);
00868 #endif
00869 ssize_t BRLAPI_STDCALL brlapi__recvRaw(brlapi_handle_t *handle, void *buffer, size_t size);
00870
00871
00876 #ifndef BRLAPI_NO_SINGLE_SESSION
00877 int BRLAPI_STDCALL brlapi_suspendDriver(const char *driver);
00878 #endif
00879 int BRLAPI_STDCALL brlapi__suspendDriver(brlapi_handle_t *handle, const char *driver);
00880
00881
00885 #ifndef BRLAPI_NO_SINGLE_SESSION
00886 int BRLAPI_STDCALL brlapi_resumeDriver(void);
00887 #endif
00888 int BRLAPI_STDCALL brlapi__resumeDriver(brlapi_handle_t *handle);
00912
00913 #define BRLAPI_ERROR_SUCCESS 0
00914 #define BRLAPI_ERROR_NOMEM 1
00915 #define BRLAPI_ERROR_TTYBUSY 2
00916 #define BRLAPI_ERROR_DEVICEBUSY 3
00917 #define BRLAPI_ERROR_UNKNOWN_INSTRUCTION 4
00918 #define BRLAPI_ERROR_ILLEGAL_INSTRUCTION 5
00919 #define BRLAPI_ERROR_INVALID_PARAMETER 6
00920 #define BRLAPI_ERROR_INVALID_PACKET 7
00921 #define BRLAPI_ERROR_CONNREFUSED 8
00922 #define BRLAPI_ERROR_OPNOTSUPP 9
00923 #define BRLAPI_ERROR_GAIERR 10
00924 #define BRLAPI_ERROR_LIBCERR 11
00925 #define BRLAPI_ERROR_UNKNOWNTTY 12
00926 #define BRLAPI_ERROR_PROTOCOL_VERSION 13
00927 #define BRLAPI_ERROR_EOF 14
00928 #define BRLAPI_ERROR_EMPTYKEY 15
00929 #define BRLAPI_ERROR_DRIVERERROR 16
00930 #define BRLAPI_ERROR_AUTHENTICATION 17
00932
00933
00937 extern const char *brlapi_errlist[];
00938
00939
00941 extern const int brlapi_nerr;
00942
00943
00948 void BRLAPI_STDCALL brlapi_perror(const char *s);
00949
00950
00952 typedef struct {
00953 int brlerrno;
00954 int libcerrno;
00955 int gaierrno;
00956 const char *errfun;
00957 } brlapi_error_t;
00958
00967 brlapi_error_t * BRLAPI_STDCALL brlapi_error_location(void);
00968
00977 extern brlapi_error_t brlapi_error;
00978
00980 extern int brlapi_errno;
00982 extern int brlapi_libcerrno;
00984 extern int brlapi_gaierrno;
00986 extern const char *brlapi_errfun;
00987
00989 #define brlapi_error (*brlapi_error_location())
00990
00991 #define brlapi_errno (brlapi_error.brlerrno)
00992
00993 #define brlapi_libcerrno (brlapi_error.libcerrno)
00994
00995 #define brlapi_gaierrno (brlapi_error.gaierrno)
00996
00997 #define brlapi_errfun (brlapi_error.errfun)
00998
00999
01005 const char * BRLAPI_STDCALL brlapi_strerror(const brlapi_error_t *error);
01006
01008 typedef uint32_t brlapi_packetType_t;
01009
01010
01016 const char * BRLAPI_STDCALL brlapi_getPacketTypeName(brlapi_packetType_t type);
01017
01018
01030 #ifndef BRLAPI_NO_SINGLE_SESSION
01031 typedef void (BRLAPI_STDCALL *brlapi_exceptionHandler_t)(int error, brlapi_packetType_t type, const void *packet, size_t size);
01032 #endif
01033 typedef void (BRLAPI_STDCALL *brlapi__exceptionHandler_t)(brlapi_handle_t *handle, int error, brlapi_packetType_t type, const void *packet, size_t size);
01034
01035
01045 #ifndef BRLAPI_NO_SINGLE_SESSION
01046 int BRLAPI_STDCALL brlapi_strexception(char *buffer, size_t bufferSize, int error, brlapi_packetType_t type, const void *packet, size_t packetSize);
01047 #endif
01048 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);
01049
01050
01059 #ifndef BRLAPI_NO_SINGLE_SESSION
01060 brlapi_exceptionHandler_t BRLAPI_STDCALL brlapi_setExceptionHandler(brlapi_exceptionHandler_t handler);
01061 #endif
01062 brlapi__exceptionHandler_t BRLAPI_STDCALL brlapi__setExceptionHandler(brlapi_handle_t *handle, brlapi__exceptionHandler_t handler);
01063
01064 #ifndef BRLAPI_NO_SINGLE_SESSION
01065 void BRLAPI_STDCALL brlapi_defaultExceptionHandler(int error, brlapi_packetType_t type, const void *packet, size_t size);
01066 #endif
01067 void BRLAPI_STDCALL brlapi__defaultExceptionHandler(brlapi_handle_t *handle, int error, brlapi_packetType_t type, const void *packet, size_t size);
01068
01071
01072 #ifdef BRLAPI_WIN32
01073 #ifndef BRLAPI_NO_SINGLE_SESSION
01074 int BRLAPI_STDCALL brlapi_writeTextWin(int cursor, const void *str, int wide);
01075 #endif
01076 int BRLAPI_STDCALL brlapi__writeTextWin(brlapi_handle_t *handle, int cursor, const void *str, int wide);
01077
01078 #ifndef BRLAPI_NO_SINGLE_SESSION
01079 int BRLAPI_STDCALL brlapi_writeWin(const brlapi_writeArguments_t *s, int wide);
01080 #endif
01081 int BRLAPI_STDCALL brlapi__writeWin(brlapi_handle_t *handle, const brlapi_writeArguments_t *s, int wide);
01082
01083 #ifdef UNICODE
01084 #ifndef BRLAPI_NO_SINGLE_SESSION
01085 #define brlapi_writeText(cursor, str) brlapi_writeTextWin(cursor, str, 1)
01086 #endif
01087 #define brlapi__writeText(handle, cursor, str) brlapi__writeTextWin(handle, cursor, str, 1)
01088
01089 #ifndef BRLAPI_NO_SINGLE_SESSION
01090 #define brlapi_write(s) brlapi_writeWin(s, 1)
01091 #endif
01092 #define brlapi__write(handle, s) brlapi__writeWin(handle, s, 1)
01093
01094 #else
01095
01096 #ifndef BRLAPI_NO_SINGLE_SESSION
01097 #define brlapi_writeText(cursor, str) brlapi_writeTextWin(cursor, str, 0)
01098 #endif
01099 #define brlapi__writeText(handle, cursor, str) brlapi__writeTextWin(handle, cursor, str, 0)
01100
01101 #ifndef BRLAPI_NO_SINGLE_SESSION
01102 #define brlapi_write(s) brlapi_writeWin(s, 0)
01103 #endif
01104 #define brlapi__write(handle, s) brlapi__writeWin(handle, s, 0)
01105
01106 #endif
01107 #endif
01108
01109 #ifndef BRLAPI_NO_DEPRECATED
01110
01122 #define brlapi_settings_t brlapi_connectionSettings_t
01123
01125 typedef struct {
01126 int displayNumber;
01127 unsigned int regionBegin;
01128 unsigned int regionSize;
01129 char *text;
01130 int textSize;
01131 unsigned char *attrAnd;
01132 unsigned char *attrOr;
01133 int cursor;
01134 char *charset;
01135 } brlapi_writeStruct;
01136 #define BRLAPI_WRITESTRUCT_INITIALIZER BRLAPI_WRITEARGUMENTS_INITIALIZER
01137
01138 #define brl_keycode_t brlapi_keyCode_t
01139 #define brl_type_t brlapi_packetType_t
01140
01141 #define BRLCOMMANDS NULL
01142 #define BRL_KEYCODE_MAX BRLAPI_KEY_MAX
01143
01144 #ifndef BRLAPI_NO_SINGLE_SESSION
01145 #define brlapi_initializeConnection brlapi_openConnection
01146 #define brlapi_getTty brlapi_enterTtyMode
01147 #define brlapi_getTtyPath brlapi_enterTtyModeWithPath
01148 #define brlapi_leaveTty brlapi_leaveTtyMode
01149 #define brlapi_unignoreKeyRange brlapi_acceptKeyRange
01150 #define brlapi_unignoreKeySet brlapi_acceptKeySet
01151 #define brlapi_getRaw brlapi_enterRawMode
01152 #define brlapi_leaveRaw brlapi_leaveRawMode
01153 #define brlapi_suspend brlapi_suspendDriver
01154 #define brlapi_resume brlapi_resumeDriver
01155 #endif
01156
01157 #define BRLERR_SUCCESS BRLAPI_ERROR_SUCCESS
01158 #define BRLERR_NOMEM BRLAPI_ERROR_NOMEM
01159 #define BRLERR_TTYBUSY BRLAPI_ERROR_TTYBUSY
01160 #define BRLERR_DEVICEBUSY BRLAPI_ERROR_DEVICEBUSY
01161 #define BRLERR_UNKNOWN_INSTRUCTION BRLAPI_ERROR_UNKNOWN_INSTRUCTION
01162 #define BRLERR_ILLEGAL_INSTRUCTION BRLAPI_ERROR_ILLEGAL_INSTRUCTION
01163 #define BRLERR_INVALID_PARAMETER BRLAPI_ERROR_INVALID_PARAMETER
01164 #define BRLERR_INVALID_PACKET BRLAPI_ERROR_INVALID_PACKET
01165 #define BRLERR_CONNREFUSED BRLAPI_ERROR_CONNREFUSED
01166 #define BRLERR_OPNOTSUPP BRLAPI_ERROR_OPNOTSUPP
01167 #define BRLERR_GAIERR BRLAPI_ERROR_GAIERR
01168 #define BRLERR_LIBCERR BRLAPI_ERROR_LIBCERR
01169 #define BRLERR_UNKNOWNTTY BRLAPI_ERROR_UNKNOWNTTY
01170 #define BRLERR_PROTOCOL_VERSION BRLAPI_ERROR_PROTOCOL_VERSION
01171 #define BRLERR_EOF BRLAPI_ERROR_EOF
01172 #define BRLERR_EMPTYKEY BRLAPI_ERROR_EMPTYKEY
01173 #define BRLERR_DRIVERERROR BRLAPI_ERROR_DRIVERERROR
01174
01176 #endif
01177
01178 #ifdef __cplusplus
01179 }
01180 #endif
01181
01182 #endif