1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>brlapi.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center>
<hr><h1>brlapi.h</h1><a href="brlapi_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/* Programs/brlapi.h. Generated by configure. */</span>
00002 <span class="comment">/*</span>
00003 <span class="comment"> * BRLTTY - A background process providing access to the Linux console (when in</span>
00004 <span class="comment"> * text mode) for a blind person using a refreshable braille display.</span>
00005 <span class="comment"> *</span>
00006 <span class="comment"> * Copyright (C) 1995-2003 by The BRLTTY Team. All rights reserved.</span>
00007 <span class="comment"> *</span>
00008 <span class="comment"> * BRLTTY comes with ABSOLUTELY NO WARRANTY.</span>
00009 <span class="comment"> *</span>
00010 <span class="comment"> * This is free software, placed under the terms of the</span>
00011 <span class="comment"> * GNU General Public License, as published by the Free Software</span>
00012 <span class="comment"> * Foundation. Please see the file COPYING for details.</span>
00013 <span class="comment"> *</span>
00014 <span class="comment"> * Web Page: http://mielke.cc/brltty/</span>
00015 <span class="comment"> *</span>
00016 <span class="comment"> * This software is maintained by Dave Mielke <dave@mielke.cc>.</span>
00017 <span class="comment"> */</span>
00018
00023 <span class="preprocessor">#ifndef _BRLAPI_H</span>
00024 <span class="preprocessor"></span><span class="preprocessor">#define _BRLAPI_H</span>
00025 <span class="preprocessor"></span>
00026 <span class="preprocessor">#ifdef __cplusplus</span>
00027 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
00028 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
00029
00030 <span class="comment">/* Define this to be a string containing the library version. */</span>
00031 <span class="preprocessor">#define BRLAPI_RELEASE "0.1.1"</span>
00032 <span class="preprocessor"></span>
00033 <span class="comment">/* this is for UINT32_MAX */</span>
00034 <span class="preprocessor">#include <inttypes.h></span>
00035 <span class="preprocessor">#ifndef UINT32_MAX</span>
00036 <span class="preprocessor"></span><span class="preprocessor">#define UINT32_MAX (4294967295U)</span>
00037 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* UINT32_MAX */</span>
00038
00039 <span class="comment">/* The type size_t is defined there! */</span>
00040 <span class="preprocessor">#include <unistd.h></span>
00041
<a name="l00053"></a><a class="code" href="group__brlapi__connection.html#a4">00053</a> <span class="preprocessor">#define BRLAPI_SOCKETPORT "35751"</span>
00054 <span class="preprocessor"></span>
<a name="l00059"></a><a class="code" href="group__brlapi__connection.html#a5">00059</a> <span class="preprocessor">#define BRLAPI_ETCDIR "/etc"</span>
00060 <span class="preprocessor"></span>
<a name="l00064"></a><a class="code" href="group__brlapi__connection.html#a6">00064</a> <span class="preprocessor">#define BRLAPI_AUTHFILE "brlapi.key"</span>
00065 <span class="preprocessor"></span>
<a name="l00067"></a><a class="code" href="group__brlapi__connection.html#a7">00067</a> <span class="preprocessor">#define BRLAPI_AUTHNAME BRLAPI_ETCDIR "/" BRLAPI_AUTHFILE</span>
00068 <span class="preprocessor"></span>
<a name="l00099"></a><a class="code" href="structbrlapi__settings__t.html">00099</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
00100 <span class="keyword"></span>{
<a name="l00107"></a><a class="code" href="structbrlapi__settings__t.html#m0">00107</a> <span class="keywordtype">char</span> *authKey;
00108
<a name="l00117"></a><a class="code" href="structbrlapi__settings__t.html#m1">00117</a> <span class="keywordtype">char</span> *hostName;
00118 } <a class="code" href="structbrlapi__settings__t.html">brlapi_settings_t</a>;
00119
00120 <span class="comment">/* brlapi_initializeConnection */</span>
00161 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__connection.html#a0">brlapi_initializeConnection</a>(<span class="keyword">const</span> <a class="code" href="structbrlapi__settings__t.html">brlapi_settings_t</a> *clientSettings, <a class="code" href="structbrlapi__settings__t.html">brlapi_settings_t</a> *usedSettings);
00162
00163 <span class="comment">/* brlapi_closeConnection */</span>
00171 <span class="keywordtype">void</span> <a class="code" href="group__brlapi__connection.html#a1">brlapi_closeConnection</a>(<span class="keywordtype">void</span>);
00172
00173 <span class="comment">/* brlapi_loadAuthKey */</span>
00186 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__connection.html#a2">brlapi_loadAuthKey</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, <span class="keywordtype">int</span> *authlength, <span class="keywordtype">void</span> *auth);
00187
00188 <span class="comment">/* brlapi_getControllingTty */</span>
00210 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__connection.html#a3">brlapi_getControllingTty</a>(<span class="keywordtype">void</span>);
00211
00225 <span class="comment">/* brlapi_getDriverId */</span>
00232 <span class="keywordtype">char</span> *<a class="code" href="group__brlapi__info.html#a0">brlapi_getDriverId</a>(<span class="keywordtype">void</span>);
00233
00234 <span class="comment">/* brlapi_getDriverName */</span>
00241 <span class="keywordtype">char</span> *<a class="code" href="group__brlapi__info.html#a1">brlapi_getDriverName</a>(<span class="keywordtype">void</span>);
00242
00243 <span class="comment">/* brlapi_getDisplaySize */</span>
00245 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__info.html#a2">brlapi_getDisplaySize</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *x, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *y);
00246
<a name="l00257"></a><a class="code" href="structbrlapi__keybinding__t.html">00257</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
00258 <span class="keyword"></span>{
<a name="l00263"></a><a class="code" href="structbrlapi__keybinding__t.html#m0">00263</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *client;
00264 } <a class="code" href="structbrlapi__keybinding__t.html">brlapi_keybinding_t</a>;
00265
00288 <span class="comment">/* brlapi_getTty */</span>
00304 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__tty.html#a0">brlapi_getTty</a>(uint32_t tty, uint32_t how, <a class="code" href="structbrlapi__keybinding__t.html">brlapi_keybinding_t</a> *keybinding);
00305
<a name="l00307"></a><a class="code" href="group__brlapi__tty.html#a2">00307</a> <span class="preprocessor">#define BRLKEYCODES ((uint32_t) 1)</span>
00308 <span class="preprocessor"></span>
<a name="l00309"></a><a class="code" href="group__brlapi__tty.html#a3">00309</a> <span class="preprocessor">#define BRLCOMMANDS ((uint32_t) 2)</span>
00310 <span class="preprocessor"></span>
00311 <span class="comment">/* brlapi_leaveTty */</span>
00316 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__tty.html#a1">brlapi_leaveTty</a>(<span class="keywordtype">void</span>);
00317
00332 <span class="comment">/* brlapi_writeBrl */</span>
00343 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__write.html#a0">brlapi_writeBrl</a>(uint32_t cursor, <span class="keyword">const</span> <span class="keywordtype">char</span> *str);
00344
00345 <span class="comment">/* brlapi_writeBrlDots */</span>
00353 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__write.html#a1">brlapi_writeBrlDots</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *dots);
00354
<a name="l00377"></a><a class="code" href="group__brlapi__keys.html#a6">00377</a> <span class="preprocessor">#define BRL_KEYBUF_SIZE 256</span>
00378 <span class="preprocessor"></span>
<a name="l00383"></a><a class="code" href="group__brlapi__keys.html#a0">00383</a> <span class="keyword">typedef</span> uint32_t <a class="code" href="group__brlapi__keys.html#a0">brl_keycode_t</a>;
00384
<a name="l00388"></a><a class="code" href="group__brlapi__keys.html#a7">00388</a> <span class="preprocessor">#define BRL_KEYCODE_MAX ((brl_keycode_t) (UINT32_MAX))</span>
00389 <span class="preprocessor"></span>
00390 <span class="comment">/* brlapi_readKey */</span>
00414 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__keys.html#a1">brlapi_readKey</a>(<span class="keywordtype">int</span> block, <a class="code" href="group__brlapi__keys.html#a0">brl_keycode_t</a> *code);
00415
00416 <span class="comment">/* brlapi_readCommand */</span>
00438 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__keys.html#a2">brlapi_readCommand</a>(<span class="keywordtype">int</span> block, <a class="code" href="group__brlapi__keys.html#a0">brl_keycode_t</a> *code);
00439
<a name="l00444"></a><a class="code" href="group__brlapi__keys.html#a8">00444</a> <span class="preprocessor">#define BRLAPI_HOMEKEYDIR ".brlkeys"</span>
00445 <span class="preprocessor"></span>
<a name="l00448"></a><a class="code" href="group__brlapi__keys.html#a9">00448</a> <span class="preprocessor">#define BRLAPI_HOMEKEYEXT ".kbd"</span>
00449 <span class="preprocessor"></span>
<a name="l00455"></a><a class="code" href="group__brlapi__keys.html#a10">00455</a> <span class="preprocessor">#define BRLAPI_ETCKEYFILE "brlkeys"</span>
00456 <span class="preprocessor"></span>
00457 <span class="comment">/* brlapi_readBinding */</span>
00475 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__keys.html#a3">brlapi_readBinding</a>(<span class="keywordtype">int</span> block, <span class="keyword">const</span> <span class="keywordtype">char</span> **code);
00476
00477 <span class="comment">/* brlapi_ignoreKeys */</span>
00486 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__keys.html#a4">brlapi_ignoreKeys</a>(<a class="code" href="group__brlapi__keys.html#a0">brl_keycode_t</a> x, <a class="code" href="group__brlapi__keys.html#a0">brl_keycode_t</a> y);
00487
00488 <span class="comment">/* brlapi_unignoreKeys */</span>
00499 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__keys.html#a5">brlapi_unignoreKeys</a>(<a class="code" href="group__brlapi__keys.html#a0">brl_keycode_t</a> x, <a class="code" href="group__brlapi__keys.html#a0">brl_keycode_t</a> y);
00500
00521 <span class="comment">/* brlapi_getRaw */</span>
00524 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__raw.html#a0">brlapi_getRaw</a>(<span class="keywordtype">void</span>);
00525
00526 <span class="comment">/* brlapi_leaveRaw */</span>
00529 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__raw.html#a1">brlapi_leaveRaw</a>(<span class="keywordtype">void</span>);
00530
00531 <span class="comment">/* brlapi_sendRaw */</span>
00537 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__raw.html#a2">brlapi_sendRaw</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf, size_t size);
00538
00539 <span class="comment">/* brlapi_recvRaw */</span>
00546 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__raw.html#a3">brlapi_recvRaw</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf, size_t size);
00547
00555 <span class="comment">/* Error codes */</span>
<a name="l00556"></a><a class="code" href="group__brlapi__error.html#a5">00556</a> <span class="preprocessor">#define BRLERR_SUCCESS 0 </span>
<a name="l00557"></a><a class="code" href="group__brlapi__error.html#a6">00557</a> <span class="preprocessor">#define BRLERR_NOMEM 1 </span>
<a name="l00558"></a><a class="code" href="group__brlapi__error.html#a7">00558</a> <span class="preprocessor">#define BRLERR_TTYBUSY 2 </span>
<a name="l00559"></a><a class="code" href="group__brlapi__error.html#a8">00559</a> <span class="preprocessor">#define BRLERR_UNKNOWN_INSTRUCTION 3 </span>
<a name="l00560"></a><a class="code" href="group__brlapi__error.html#a9">00560</a> <span class="preprocessor">#define BRLERR_ILLEGAL_INSTRUCTION 4 </span>
<a name="l00561"></a><a class="code" href="group__brlapi__error.html#a10">00561</a> <span class="preprocessor">#define BRLERR_INVALID_PARAMETER 5 </span>
<a name="l00562"></a><a class="code" href="group__brlapi__error.html#a11">00562</a> <span class="preprocessor">#define BRLERR_INVALID_PACKET 6 </span>
<a name="l00563"></a><a class="code" href="group__brlapi__error.html#a12">00563</a> <span class="preprocessor">#define BRLERR_RAWNOTSUPP 7 </span>
<a name="l00564"></a><a class="code" href="group__brlapi__error.html#a13">00564</a> <span class="preprocessor">#define BRLERR_KEYSNOTSUPP 8 </span>
<a name="l00565"></a><a class="code" href="group__brlapi__error.html#a14">00565</a> <span class="preprocessor">#define BRLERR_CONNREFUSED 9 </span>
<a name="l00566"></a><a class="code" href="group__brlapi__error.html#a15">00566</a> <span class="preprocessor">#define BRLERR_OPNOTSUPP 10 </span>
<a name="l00567"></a><a class="code" href="group__brlapi__error.html#a16">00567</a> <span class="preprocessor">#define BRLERR_GAIERR 11 </span>
<a name="l00568"></a><a class="code" href="group__brlapi__error.html#a17">00568</a> <span class="preprocessor">#define BRLERR_LIBCERR 12 </span>
<a name="l00569"></a><a class="code" href="group__brlapi__error.html#a18">00569</a> <span class="preprocessor">#define BRLERR_UNKNOWNTTY 13 </span>
00571 <span class="preprocessor"></span><span class="comment">/* brlapi_errlist */</span>
00572
<a name="l00576"></a><a class="code" href="group__brlapi__error.html#a0">00576</a> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__brlapi__error.html#a0">brlapi_errlist</a>[];
00577
00578 <span class="comment">/* brlapi_nerr */</span>
<a name="l00580"></a><a class="code" href="group__brlapi__error.html#a1">00580</a> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="group__brlapi__error.html#a1">brlapi_nerr</a>;
00581
00582 <span class="comment">/* brlapi_perror */</span>
00587 <span class="keywordtype">void</span> <a class="code" href="group__brlapi__error.html#a3">brlapi_perror</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *s);
00588
00597 <span class="keywordtype">int</span> *<a class="code" href="group__brlapi__error.html#a4">brlapi_errno_location</a>(<span class="keywordtype">void</span>);
00598
<a name="l00604"></a><a class="code" href="group__brlapi__error.html#a2">00604</a> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__brlapi__error.html#a27">brlapi_errno</a>;
<a name="l00606"></a><a class="code" href="group__brlapi__error.html#a27">00606</a> <span class="preprocessor">#define brlapi_errno (*brlapi_errno_location ())</span>
00607 <span class="preprocessor"></span>
<a name="l00622"></a><a class="code" href="group__brlapi__protocol.html#a4">00622</a> <span class="preprocessor">#define BRLAPI_MAXPACKETSIZE 512</span>
00623 <span class="preprocessor"></span>
<a name="l00625"></a><a class="code" href="group__brlapi__protocol.html#a0">00625</a> <span class="keyword">typedef</span> uint32_t <a class="code" href="group__brlapi__protocol.html#a0">brl_type_t</a>;
00626
<a name="l00627"></a><a class="code" href="group__brlapi__protocol.html#a5">00627</a> <span class="preprocessor">#define BRLPACKET_AUTHKEY 'K' </span>
<a name="l00628"></a><a class="code" href="group__brlapi__protocol.html#a6">00628</a> <span class="preprocessor">#define BRLPACKET_BYE 'B' </span>
<a name="l00629"></a><a class="code" href="group__brlapi__protocol.html#a7">00629</a> <span class="preprocessor">#define BRLPACKET_GETDRIVERID 'd' </span>
<a name="l00630"></a><a class="code" href="group__brlapi__protocol.html#a8">00630</a> <span class="preprocessor">#define BRLPACKET_GETDRIVERNAME 'n' </span>
<a name="l00631"></a><a class="code" href="group__brlapi__protocol.html#a9">00631</a> <span class="preprocessor">#define BRLPACKET_GETDISPLAYSIZE 's' </span>
<a name="l00632"></a><a class="code" href="group__brlapi__protocol.html#a10">00632</a> <span class="preprocessor">#define BRLPACKET_GETTTY 't' </span>
<a name="l00633"></a><a class="code" href="group__brlapi__protocol.html#a11">00633</a> <span class="preprocessor">#define BRLPACKET_LEAVETTY 'L' </span>
<a name="l00634"></a><a class="code" href="group__brlapi__protocol.html#a12">00634</a> <span class="preprocessor">#define BRLPACKET_KEY 'k' </span>
<a name="l00635"></a><a class="code" href="group__brlapi__protocol.html#a13">00635</a> <span class="preprocessor">#define BRLPACKET_COMMAND 'c' </span>
<a name="l00636"></a><a class="code" href="group__brlapi__protocol.html#a14">00636</a> <span class="preprocessor">#define BRLPACKET_MASKKEYS 'm' </span>
<a name="l00637"></a><a class="code" href="group__brlapi__protocol.html#a15">00637</a> <span class="preprocessor">#define BRLPACKET_UNMASKKEYS 'u' </span>
<a name="l00638"></a><a class="code" href="group__brlapi__protocol.html#a16">00638</a> <span class="preprocessor">#define BRLPACKET_WRITE 'W' </span>
<a name="l00639"></a><a class="code" href="group__brlapi__protocol.html#a17">00639</a> <span class="preprocessor">#define BRLPACKET_WRITEDOTS 'D' </span>
<a name="l00640"></a><a class="code" href="group__brlapi__protocol.html#a18">00640</a> <span class="preprocessor">#define BRLPACKET_STATWRITE 'S' </span>
<a name="l00641"></a><a class="code" href="group__brlapi__protocol.html#a19">00641</a> <span class="preprocessor">#define BRLPACKET_GETRAW '*' </span>
<a name="l00642"></a><a class="code" href="group__brlapi__protocol.html#a20">00642</a> <span class="preprocessor">#define BRLPACKET_LEAVERAW '#' </span>
<a name="l00643"></a><a class="code" href="group__brlapi__protocol.html#a21">00643</a> <span class="preprocessor">#define BRLPACKET_PACKET 'p' </span>
<a name="l00644"></a><a class="code" href="group__brlapi__protocol.html#a22">00644</a> <span class="preprocessor">#define BRLPACKET_ACK 'A' </span>
<a name="l00645"></a><a class="code" href="group__brlapi__protocol.html#a23">00645</a> <span class="preprocessor">#define BRLPACKET_ERROR 'E' </span>
<a name="l00648"></a><a class="code" href="group__brlapi__protocol.html#a24">00648</a> <span class="preprocessor">#define BRLRAW_MAGIC (0xdeadbeefL)</span>
00649 <span class="preprocessor"></span>
00650 <span class="comment">/* brlapi_writePacket */</span>
00661 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__protocol.html#a2">brlapi_writePacket</a>(<span class="keywordtype">int</span> fd, <a class="code" href="group__brlapi__protocol.html#a0">brl_type_t</a> type, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, size_t size);
00662
00663 <span class="comment">/* brlapi_readPacket */</span>
00676 <span class="keywordtype">int</span> <a class="code" href="group__brlapi__protocol.html#a3">brlapi_readPacket</a>(<span class="keywordtype">int</span> fd, <a class="code" href="group__brlapi__protocol.html#a0">brl_type_t</a> *type, <span class="keywordtype">void</span> *buf, size_t size);
00677
00678 <span class="preprocessor">#include <pthread.h></span>
00679
00680 <span class="comment">/* brlapi_fd_mutex */</span>
<a name="l00706"></a><a class="code" href="group__brlapi__protocol.html#a1">00706</a> <span class="keyword">extern</span> pthread_mutex_t <a class="code" href="group__brlapi__protocol.html#a1">brlapi_fd_mutex</a>;
00707
00710 <span class="preprocessor">#ifdef __cplusplus</span>
00711 <span class="preprocessor"></span>}
00712 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
00713
00714 <span class="preprocessor">#endif </span><span class="comment">/* _BRLAPI_H */</span>
</pre></div><hr><address style="align: right;"><small>Generated on Thu Jan 15 13:21:27 2004 for BrlAPI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>
|
