Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

brlapi.h

Go to the documentation of this file.
00001 /* Programs/brlapi.h.  Generated by configure.  */
00002 /*
00003  * libbrlapi - A library providing access to braille terminals for applications.
00004  *
00005  * Copyright (C) 2002-2007 by
00006  *   Samuel Thibault <Samuel.Thibault@ens-lyon.org>
00007  *   Sébastien Hinderer <Sebastien.Hinderer@ens-lyon.org>
00008  *
00009  * libbrlapi comes with ABSOLUTELY NO WARRANTY.
00010  *
00011  * This is free software, placed under the terms of the
00012  * GNU Lesser General Public License, as published by the Free Software
00013  * Foundation; either version 2.1 of the License,
00014  * or (at your option) any later version.
00015  * Please see the file COPYING-API for details.
00016  *
00017  * Web Page: http://mielke.cc/brltty/
00018  *
00019  * This software is maintained by Dave Mielke <dave@mielke.cc>.
00020  */
00021 
00026 #ifndef BRLAPI_INCLUDED
00027 #define BRLAPI_INCLUDED
00028 
00029 #ifdef __cplusplus
00030 extern "C" {
00031 #endif /* __cplusplus */
00032 
00033 /* #undef BRLAPI_WIN32 */
00034 
00039 #define BRLAPI_RELEASE "0.5.0"
00040 
00042 #define BRLAPI_MAJOR 0
00043 
00045 #define BRLAPI_MINOR 5
00046 
00048 #define BRLAPI_REVISION 0
00049 
00052 /* Types are defined there */
00053 #include <sys/types.h>
00054 
00055 #ifdef BRLAPI_WIN32
00056 #include <windows.h>
00057 #define BRLAPI_STDCALL __stdcall
00058 #else /* BRLAPI_WIN32 */
00059 #define BRLAPI_STDCALL
00060 #endif /* BRLAPI_WIN32 */
00061 
00062 #ifdef _MSC_VER
00063 typedef __int64 uint64_t;
00064 typedef __int32 uint32_t;
00065 #define UINT64_C(x) (x ## Ui64)
00066 #define PRIx64 "I64x"
00067 typedef signed int ssize_t;
00068 #else /* _MSC_VER */
00069 
00070 /* this is for uint*_t */
00071 #include <stdint.h>
00072 
00073 /* NULL is defined there */
00074 #include <unistd.h>
00075 
00076 #include <inttypes.h> /* For PRIx64 */
00077 #endif /* _MSC_VER */
00078 
00101 typedef struct brlapi_handle_t brlapi_handle_t;
00102 
00104 size_t BRLAPI_STDCALL brlapi_getHandleSize(void);
00105 
00119 #define BRLAPI_SOCKETPORTNUM 4101
00120 #define BRLAPI_SOCKETPORT "4101"
00121 
00123 #ifdef BRLAPI_WIN32
00124 #define BRLAPI_SOCKETPATH "\\\\.\\pipe\\BrlAPI"
00125 #else /* BRLAPI_WIN32 */
00126 #define BRLAPI_SOCKETPATH "/var/lib/BrlAPI/"
00127 #endif /* BRLAPI_WIN32 */
00128 
00133 #define BRLAPI_ETCDIR "/etc"
00134 
00138 #define BRLAPI_AUTHKEYFILE "brlapi.key"
00139 
00141 #define BRLAPI_DEFAUTH BRLAPI_ETCDIR "/" BRLAPI_AUTHKEYFILE
00142 
00143 #ifdef BRLAPI_WIN32
00144 typedef HANDLE brlapi_fileDescriptor;
00145 #else /* BRLAPI_WIN32 */
00146 typedef int brlapi_fileDescriptor;
00147 #endif /* BRLAPI_WIN32 */
00148 
00179 typedef struct {
00187   char *auth;
00188 
00197   char *host;
00198 } brlapi_connectionSettings_t;
00199 
00200 /* BRLAPI_SETTINGS_INITIALIZER */
00203 #define BRLAPI_SETTINGS_INITIALIZER { NULL, NULL }
00204 
00205 /* brlapi_openConnection */
00250 #ifndef BRLAPI_NO_SINGLE_SESSION
00251 brlapi_fileDescriptor BRLAPI_STDCALL brlapi_openConnection(const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings);
00252 #endif /* BRLAPI_NO_SINGLE_SESSION */
00253 brlapi_fileDescriptor BRLAPI_STDCALL brlapi__openConnection(brlapi_handle_t *handle, const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings);
00254 
00255 /* brlapi_closeConnection */
00262 #ifndef BRLAPI_NO_SINGLE_SESSION
00263 void BRLAPI_STDCALL brlapi_closeConnection(void);
00264 #endif /* BRLAPI_NO_SINGLE_SESSION */
00265 void BRLAPI_STDCALL brlapi__closeConnection(brlapi_handle_t *handle);
00266 
00282 #define BRLAPI_MAXNAMELENGTH 31
00283 
00284 /* brlapi_getDriverName */
00296 #ifndef BRLAPI_NO_SINGLE_SESSION
00297 int BRLAPI_STDCALL brlapi_getDriverName(char *buffer, size_t size);
00298 #endif /* BRLAPI_NO_SINGLE_SESSION */
00299 int BRLAPI_STDCALL brlapi__getDriverName(brlapi_handle_t *handle, char *buffer, size_t size);
00300 
00301 /* brlapi_getDisplaySize */
00303 #ifndef BRLAPI_NO_SINGLE_SESSION
00304 int BRLAPI_STDCALL brlapi_getDisplaySize(unsigned int *x, unsigned int *y);
00305 #endif /* BRLAPI_NO_SINGLE_SESSION */
00306 int BRLAPI_STDCALL brlapi__getDisplaySize(brlapi_handle_t *handle, unsigned int *x, unsigned int *y);
00307 
00331 /* brlapi_enterTtyMode */
00358 #ifndef BRLAPI_NO_SINGLE_SESSION
00359 int BRLAPI_STDCALL brlapi_enterTtyMode(int tty, const char *driver);
00360 #endif /* BRLAPI_NO_SINGLE_SESSION */
00361 int BRLAPI_STDCALL brlapi__enterTtyMode(brlapi_handle_t *handle, int tty, const char *driver);
00362 
00372 #define BRLAPI_TTY_DEFAULT -1
00373 
00374 /* brlapi_enterTtyModeWithPath */
00386 #ifndef BRLAPI_NO_SINGLE_SESSION
00387 int BRLAPI_STDCALL brlapi_enterTtyModeWithPath(int *ttys, int count, const char *driver);
00388 #endif /* BRLAPI_NO_SINGLE_SESSION */
00389 int BRLAPI_STDCALL brlapi__enterTtyModeWithPath(brlapi_handle_t *handle, int *ttys, int count, const char *driver);
00390 
00391 /* brlapi_leaveTtyMode */
00398 #ifndef BRLAPI_NO_SINGLE_SESSION
00399 int BRLAPI_STDCALL brlapi_leaveTtyMode(void);
00400 #endif /* BRLAPI_NO_SINGLE_SESSION */
00401 int BRLAPI_STDCALL brlapi__leaveTtyMode(brlapi_handle_t *handle);
00402 
00403 /* brlapi_setFocus */
00414 #ifndef BRLAPI_NO_SINGLE_SESSION
00415 int BRLAPI_STDCALL brlapi_setFocus(int tty);
00416 #endif /* BRLAPI_NO_SINGLE_SESSION */
00417 int BRLAPI_STDCALL brlapi__setFocus(brlapi_handle_t *handle, int tty);
00418 
00438 /* brlapi_writeText */
00453 #ifndef BRLAPI_NO_SINGLE_SESSION
00454 int BRLAPI_STDCALL brlapi_writeText(int cursor, const char *text);
00455 #endif /* BRLAPI_NO_SINGLE_SESSION */
00456 int BRLAPI_STDCALL brlapi__writeText(brlapi_handle_t *handle, int cursor, const char *text);
00457 
00458 /* brlapi_writeDots */
00466 #ifndef BRLAPI_NO_SINGLE_SESSION
00467 int BRLAPI_STDCALL brlapi_writeDots(const unsigned char *dots);
00468 #endif /* BRLAPI_NO_SINGLE_SESSION */
00469 int BRLAPI_STDCALL brlapi__writeDots(brlapi_handle_t *handle, const unsigned char *dots);
00470 
00471 /* brlapi_writeArguments_t */
00473 typedef struct {
00474   int displayNumber ;
00475   unsigned int regionBegin ;
00476   unsigned int regionSize ;
00477   char *text ;
00478   int textSize ;
00479   unsigned char *andMask ;
00480   unsigned char *orMask ;
00481   int cursor ;
00482   char *charset ;
00483 } brlapi_writeArguments_t;
00484 
00489 #define BRLAPI_DISPLAY_DEFAULT -1
00490 
00495 #define BRLAPI_CURSOR_LEAVE -1
00496 
00501 #define BRLAPI_CURSOR_OFF 0
00502 
00503 /* BRLAPI_WRITEARGUMENTS_INITIALIZER */
00513 #define BRLAPI_WRITEARGUMENTS_INITIALIZER { BRLAPI_DISPLAY_DEFAULT, 0, 0, NULL, -1, NULL, NULL, BRLAPI_CURSOR_LEAVE, NULL }
00514 
00515 /* brlapi_write */
00552 #ifndef BRLAPI_NO_SINGLE_SESSION
00553 int BRLAPI_STDCALL brlapi_write(const brlapi_writeArguments_t *arguments);
00554 #endif /* BRLAPI_NO_SINGLE_SESSION */
00555 int BRLAPI_STDCALL brlapi__write(brlapi_handle_t *handle, const brlapi_writeArguments_t *arguments);
00556 
00559 #include "brlapi_keycodes.h"
00560 
00574 /* brlapi_expandedKeyCode_t */
00576 typedef struct {
00577   unsigned int type ;
00578   unsigned int command ;
00579   unsigned int argument ;
00580   unsigned int flags ;
00581 } brlapi_expandedKeyCode_t;
00582 
00583 /* brlapi_expandKeyCode */
00591 int BRLAPI_STDCALL brlapi_expandKeyCode (brlapi_keyCode_t code, brlapi_expandedKeyCode_t *expansion);
00592 
00593 /* brlapi_describedKeyCode_t */
00595 typedef struct {
00596   const char *type ;
00597   const char *command ;
00598   unsigned int argument ;
00599   unsigned int flags ;
00600   const char *flag[64 - BRLAPI_KEY_FLAGS_SHIFT] ;
00601   brlapi_expandedKeyCode_t values ;
00602 } brlapi_describedKeyCode_t;
00603 
00604 /* brlapi_describeKeyCode */
00612 int BRLAPI_STDCALL brlapi_describeKeyCode (brlapi_keyCode_t code, brlapi_describedKeyCode_t *description);
00613 
00615 #define BRLAPI_UC_ROW   0x2800UL
00616 
00620 #define BRLAPI_MAXKEYSETSIZE (BRLAPI_MAXPACKETSIZE / sizeof(brlapi_keyCode_t))
00621 
00622 /* brlapi_readKey */
00687 #ifndef BRLAPI_NO_SINGLE_SESSION
00688 int BRLAPI_STDCALL brlapi_readKey(int wait, brlapi_keyCode_t *code);
00689 #endif /* BRLAPI_NO_SINGLE_SESSION */
00690 int BRLAPI_STDCALL brlapi__readKey(brlapi_handle_t *handle, int wait, brlapi_keyCode_t *code);
00691 
00693 typedef enum {
00694   brlapi_rangeType_all, 
00695   brlapi_rangeType_type,        
00696   brlapi_rangeType_command,     
00697   brlapi_rangeType_key, 
00698   brlapi_rangeType_code,        
00699 } brlapi_rangeType_t;
00700 
00701 /* brlapi_ignoreKeys */
00714 #ifndef BRLAPI_NO_SINGLE_SESSION
00715 int BRLAPI_STDCALL brlapi_ignoreKeys(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
00716 #endif /* BRLAPI_NO_SINGLE_SESSION */
00717 int BRLAPI_STDCALL brlapi__ignoreKeys(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
00718 
00719 /* brlapi_acceptKeys */
00732 #ifndef BRLAPI_NO_SINGLE_SESSION
00733 int BRLAPI_STDCALL brlapi_acceptKeys(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
00734 #endif /* BRLAPI_NO_SINGLE_SESSION */
00735 int BRLAPI_STDCALL brlapi__acceptKeys(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count);
00736 
00737 /* brlapi_ignoreAllKeys */
00743 #ifndef BRLAPI_NO_SINGLE_SESSION
00744 int BRLAPI_STDCALL brlapi_ignoreAllKeys(void);
00745 #define brlapi_ignoreAllKeys() brlapi_ignoreKeys(brlapi_rangeType_all, NULL, 0)
00746 #endif /* BRLAPI_NO_SINGLE_SESSION */
00747 int BRLAPI_STDCALL brlapi__ignoreAllKeys(brlapi_handle_t *handle);
00748 #define brlapi__ignoreAllKeys(handle) brlapi__ignoreKeys(handle, brlapi_rangeType_all, NULL, 0)
00749 
00750 /* brlapi_acceptAllKeys */
00759 #ifndef BRLAPI_NO_SINGLE_SESSION
00760 int BRLAPI_STDCALL brlapi_acceptAllKeys(void);
00761 #define brlapi_acceptAllKeys() brlapi_acceptKeys(brlapi_rangeType_all, NULL, 0)
00762 #endif /* BRLAPI_NO_SINGLE_SESSION */
00763 int BRLAPI_STDCALL brlapi__acceptAllKeys(brlapi_handle_t *handle);
00764 #define brlapi__acceptAllKeys(handle) brlapi__acceptKeys(handle, brlapi_rangeType_all, NULL, 0)
00765 
00770 typedef struct {
00771         brlapi_keyCode_t first;
00772         brlapi_keyCode_t last;
00773 } brlapi_range_t;
00774 
00775 /* brlapi_ignoreKeyRanges */
00786 #ifndef BRLAPI_NO_SINGLE_SESSION
00787 int BRLAPI_STDCALL brlapi_ignoreKeyRanges(brlapi_range_t ranges[], unsigned int count);
00788 #endif /* BRLAPI_NO_SINGLE_SESSION */
00789 int BRLAPI_STDCALL brlapi__ignoreKeyRanges(brlapi_handle_t *handle, brlapi_range_t ranges[], unsigned int count);
00790 
00791 /* brlapi_acceptKeyRanges */
00802 #ifndef BRLAPI_NO_SINGLE_SESSION
00803 int BRLAPI_STDCALL brlapi_acceptKeyRanges(brlapi_range_t ranges[], unsigned int count);
00804 #endif /* BRLAPI_NO_SINGLE_SESSION */
00805 int BRLAPI_STDCALL brlapi__acceptKeyRanges(brlapi_handle_t *handle, brlapi_range_t ranges[], unsigned int count);
00831 /* brlapi_enterRawMode */
00836 #ifndef BRLAPI_NO_SINGLE_SESSION
00837 int BRLAPI_STDCALL brlapi_enterRawMode(const char *driver);
00838 #endif /* BRLAPI_NO_SINGLE_SESSION */
00839 int BRLAPI_STDCALL brlapi__enterRawMode(brlapi_handle_t *handle, const char *driver);
00840 
00841 /* brlapi_leaveRawMode */
00844 #ifndef BRLAPI_NO_SINGLE_SESSION
00845 int BRLAPI_STDCALL brlapi_leaveRawMode(void);
00846 #endif /* BRLAPI_NO_SINGLE_SESSION */
00847 int BRLAPI_STDCALL brlapi__leaveRawMode(brlapi_handle_t *handle);
00848 
00849 /* brlapi_sendRaw */
00855 #ifndef BRLAPI_NO_SINGLE_SESSION
00856 ssize_t BRLAPI_STDCALL brlapi_sendRaw(const void *buffer, size_t size);
00857 #endif /* BRLAPI_NO_SINGLE_SESSION */
00858 ssize_t BRLAPI_STDCALL brlapi__sendRaw(brlapi_handle_t *handle, const void *buffer, size_t size);
00859 
00860 /* brlapi_recvRaw */
00867 #ifndef BRLAPI_NO_SINGLE_SESSION
00868 ssize_t BRLAPI_STDCALL brlapi_recvRaw(void *buffer, size_t size);
00869 #endif /* BRLAPI_NO_SINGLE_SESSION */
00870 ssize_t BRLAPI_STDCALL brlapi__recvRaw(brlapi_handle_t *handle, void *buffer, size_t size);
00871 
00872 /* brlapi_suspendDriver */
00877 #ifndef BRLAPI_NO_SINGLE_SESSION
00878 int BRLAPI_STDCALL brlapi_suspendDriver(const char *driver);
00879 #endif /* BRLAPI_NO_SINGLE_SESSION */
00880 int BRLAPI_STDCALL brlapi__suspendDriver(brlapi_handle_t *handle, const char *driver);
00881 
00882 /* brlapi_resumeDriver */
00886 #ifndef BRLAPI_NO_SINGLE_SESSION
00887 int BRLAPI_STDCALL brlapi_resumeDriver(void);
00888 #endif /* BRLAPI_NO_SINGLE_SESSION */
00889 int BRLAPI_STDCALL brlapi__resumeDriver(brlapi_handle_t *handle);
00913 /* Error codes */
00914 #define BRLAPI_ERROR_SUCCESS               0  
00915 #define BRLAPI_ERROR_NOMEM                 1  
00916 #define BRLAPI_ERROR_TTYBUSY               2  
00917 #define BRLAPI_ERROR_DEVICEBUSY            3  
00918 #define BRLAPI_ERROR_UNKNOWN_INSTRUCTION   4  
00919 #define BRLAPI_ERROR_ILLEGAL_INSTRUCTION   5  
00920 #define BRLAPI_ERROR_INVALID_PARAMETER     6  
00921 #define BRLAPI_ERROR_INVALID_PACKET        7  
00922 #define BRLAPI_ERROR_CONNREFUSED           8  
00923 #define BRLAPI_ERROR_OPNOTSUPP             9  
00924 #define BRLAPI_ERROR_GAIERR               10  
00925 #define BRLAPI_ERROR_LIBCERR              11  
00926 #define BRLAPI_ERROR_UNKNOWNTTY           12  
00927 #define BRLAPI_ERROR_PROTOCOL_VERSION     13  
00928 #define BRLAPI_ERROR_EOF                  14  
00929 #define BRLAPI_ERROR_EMPTYKEY             15  
00930 #define BRLAPI_ERROR_DRIVERERROR          16  
00932 /* brlapi_errlist */
00933 
00937 extern const char *brlapi_errlist[];
00938 
00939 /* brlapi_nerr */
00941 extern const int brlapi_nerr;
00942 
00943 /* brlapi_perror */
00948 void BRLAPI_STDCALL brlapi_perror(const char *s);
00949 
00950 /* brlapi_error_t */
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 /* brlapi_strerror */
01005 const char * BRLAPI_STDCALL brlapi_strerror(const brlapi_error_t *error);
01006 
01008 typedef uint32_t brlapi_packetType_t;
01009 
01010 /* brlapi_getPacketTypeName */
01016 const char * BRLAPI_STDCALL brlapi_getPacketTypeName(brlapi_packetType_t type);
01017 
01018 /* brlapi_exceptionHandler_t */
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 /* BRLAPI_NO_SINGLE_SESSION */
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 /* brlapi_strexception */
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 /* BRLAPI_NO_SINGLE_SESSION */
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 /* brlapi_setExceptionHandler */
01059 #ifndef BRLAPI_NO_SINGLE_SESSION
01060 brlapi_exceptionHandler_t BRLAPI_STDCALL brlapi_setExceptionHandler(brlapi_exceptionHandler_t handler);
01061 #endif /* BRLAPI_NO_SINGLE_SESSION */
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 /* BRLAPI_NO_SINGLE_SESSION */
01067 void BRLAPI_STDCALL brlapi__defaultExceptionHandler(brlapi_handle_t *handle, int error, brlapi_packetType_t type, const void *packet, size_t size);
01068 
01071 /* Windows-specific tricks - don't look at this */
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 /* BRLAPI_NO_SINGLE_SESSION */
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 /* BRLAPI_NO_SINGLE_SESSION */
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 /* BRLAPI_NO_SINGLE_SESSION */
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 /* BRLAPI_NO_SINGLE_SESSION */
01092 #define brlapi__write(handle, s) brlapi__writeWin(handle, s, 1)
01093 
01094 #else /* UNICODE */
01095 
01096 #ifndef BRLAPI_NO_SINGLE_SESSION
01097 #define brlapi_writeText(cursor, str) brlapi_writeTextWin(cursor, str, 0)
01098 #endif /* BRLAPI_NO_SINGLE_SESSION */
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 /* BRLAPI_NO_SINGLE_SESSION */
01104 #define brlapi__write(handle, s) brlapi__writeWin(handle, s, 0)
01105 
01106 #endif /* UNICODE */
01107 #endif /* BRLAPI_WIN32 */
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 /* BRLAPI_NO_SINGLE_SESSION */
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 /* BRLAPI_NO_DEPRECATED */
01177 
01178 #ifdef __cplusplus
01179 }
01180 #endif /* __cplusplus */
01181 
01182 #endif /* BRLAPI_INCLUDED */

Generated on Mon Jun 4 09:52:07 2007 for BrlAPI by  doxygen 1.4.4