Update.
[glibc.git] / libio / libioP.h
bloba9577cec74f36ec08f29730e3d6c2c285e7f26da
1 /* Copyright (C) 1993, 1997, 1998 Free Software Foundation, Inc.
2 This file is part of the GNU IO Library.
4 This library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License as
6 published by the Free Software Foundation; either version 2, or (at
7 your option) any later version.
9 This library is distributed in the hope that it will be useful, but
10 WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this library; see the file COPYING. If not, write to
16 the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
17 MA 02111-1307, USA.
19 As a special exception, if you link this library with files
20 compiled with a GNU compiler to produce an executable, this does
21 not cause the resulting executable to be covered by the GNU General
22 Public License. This exception does not however invalidate any
23 other reasons why the executable file might be covered by the GNU
24 General Public License. */
26 #include <errno.h>
27 #ifndef __set_errno
28 # define __set_errno(Val) errno = (Val)
29 #endif
30 #if defined __GLIBC__ && __GLIBC__ >= 2
31 # include <bits/libc-lock.h>
32 #else
33 /*# include <comthread.h>*/
34 #endif
36 #include "iolibio.h"
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
42 #define _IO_seek_set 0
43 #define _IO_seek_cur 1
44 #define _IO_seek_end 2
46 /* THE JUMPTABLE FUNCTIONS.
48 * The _IO_FILE type is used to implement the FILE type in GNU libc,
49 * as well as the streambuf class in GNU iostreams for C++.
50 * These are all the same, just used differently.
51 * An _IO_FILE (or FILE) object is allows followed by a pointer to
52 * a jump table (of pointers to functions). The pointer is accessed
53 * with the _IO_JUMPS macro. The jump table has a eccentric format,
54 * so as to be compatible with the layout of a C++ virtual function table.
55 * (as implemented by g++). When a pointer to a streambuf object is
56 * coerced to an (_IO_FILE*), then _IO_JUMPS on the result just
57 * happens to point to the virtual function table of the streambuf.
58 * Thus the _IO_JUMPS function table used for C stdio/libio does
59 * double duty as the virtual function table for C++ streambuf.
61 * The entries in the _IO_JUMPS function table (and hence also the
62 * virtual functions of a streambuf) are described below.
63 * The first parameter of each function entry is the _IO_FILE/streambuf
64 * object being acted on (i.e. the 'this' parameter).
67 #if (!defined _IO_USE_OLD_IO_FILE \
68 && (!defined _G_IO_NO_BACKWARD_COMPAT || _G_IO_NO_BACKWARD_COMPAT == 0))
69 # define _IO_JUMPS_OFFSET 1
70 #endif
72 #define _IO_JUMPS(THIS) ((struct _IO_FILE_plus *) (THIS))->vtable
73 #if _IO_JUMPS_OFFSET
74 # define _IO_JUMPS_FUNC(THIS) \
75 (*(struct _IO_jump_t **) ((void *) &((struct _IO_FILE_plus *) (THIS))->vtable\
76 + (THIS)->_vtable_offset))
77 #else
78 # define _IO_JUMPS_FUNC(THIS) _IO_JUMPS(THIS)
79 #endif
80 #ifdef _G_USING_THUNKS
81 # define JUMP_FIELD(TYPE, NAME) TYPE NAME
82 # define JUMP0(FUNC, THIS) _IO_JUMPS_FUNC(THIS)->FUNC (THIS)
83 # define JUMP1(FUNC, THIS, X1) _IO_JUMPS_FUNC(THIS)->FUNC (THIS, X1)
84 # define JUMP2(FUNC, THIS, X1, X2) _IO_JUMPS_FUNC(THIS)->FUNC (THIS, X1, X2)
85 # define JUMP3(FUNC, THIS, X1,X2,X3) _IO_JUMPS_FUNC(THIS)->FUNC (THIS, X1,X2, X3)
86 # define JUMP_INIT(NAME, VALUE) VALUE
87 # define JUMP_INIT_DUMMY JUMP_INIT(dummy, 0), JUMP_INIT (dummy2, 0)
88 #else
89 /* These macros will change when we re-implement vtables to use "thunks"! */
90 # define JUMP_FIELD(TYPE, NAME) struct { short delta1, delta2; TYPE pfn; } NAME
91 # define JUMP0(FUNC, THIS) _IO_JUMPS_FUNC(THIS)->FUNC.pfn (THIS)
92 # define JUMP1(FUNC, THIS, X1) _IO_JUMPS_FUNC(THIS)->FUNC.pfn (THIS, X1)
93 # define JUMP2(FUNC, THIS, X1, X2) _IO_JUMPS_FUNC(THIS)->FUNC.pfn (THIS, X1, X2)
94 # define JUMP3(FUNC, THIS, X1,X2,X3) _IO_JUMPS_FUNC(THIS)->FUNC.pfn (THIS, X1,X2,X3)
95 # define JUMP_INIT(NAME, VALUE) {0, 0, VALUE}
96 # define JUMP_INIT_DUMMY JUMP_INIT(dummy, 0)
97 #endif
99 /* The 'finish' function does any final cleaning up of an _IO_FILE object.
100 It does not delete (free) it, but does everything else to finalize it/
101 It matches the streambuf::~streambuf virtual destructor. */
102 typedef void (*_IO_finish_t) __PMT ((_IO_FILE *, int)); /* finalize */
103 #define _IO_FINISH(FP) JUMP1 (__finish, FP, 0)
105 /* The 'overflow' hook flushes the buffer.
106 The second argument is a character, or EOF.
107 It matches the streambuf::overflow virtual function. */
108 typedef int (*_IO_overflow_t) __PMT ((_IO_FILE *, int));
109 #define _IO_OVERFLOW(FP, CH) JUMP1 (__overflow, FP, CH)
111 /* The 'underflow' hook tries to fills the get buffer.
112 It returns the next character (as an unsigned char) or EOF. The next
113 character remains in the get buffer, and the get position is not changed.
114 It matches the streambuf::underflow virtual function. */
115 typedef int (*_IO_underflow_t) __PMT ((_IO_FILE *));
116 #define _IO_UNDERFLOW(FP) JUMP0 (__underflow, FP)
118 /* The 'uflow' hook returns the next character in the input stream
119 (cast to unsigned char), and increments the read position;
120 EOF is returned on failure.
121 It matches the streambuf::uflow virtual function, which is not in the
122 cfront implementation, but was added to C++ by the ANSI/ISO committee. */
123 #define _IO_UFLOW(FP) JUMP0 (__uflow, FP)
125 /* The 'pbackfail' hook handles backing up.
126 It matches the streambuf::pbackfail virtual function. */
127 typedef int (*_IO_pbackfail_t) __PMT ((_IO_FILE *, int));
128 #define _IO_PBACKFAIL(FP, CH) JUMP1 (__pbackfail, FP, CH)
130 /* The 'xsputn' hook writes upto N characters from buffer DATA.
131 Returns the number of character actually written.
132 It matches the streambuf::xsputn virtual function. */
133 typedef _IO_size_t (*_IO_xsputn_t) __PMT ((_IO_FILE *FP, const void *DATA,
134 _IO_size_t N));
135 #define _IO_XSPUTN(FP, DATA, N) JUMP2 (__xsputn, FP, DATA, N)
137 /* The 'xsgetn' hook reads upto N characters into buffer DATA.
138 Returns the number of character actually read.
139 It matches the streambuf::xsgetn virtual function. */
140 typedef _IO_size_t (*_IO_xsgetn_t) __PMT ((_IO_FILE *FP, void *DATA,
141 _IO_size_t N));
142 #define _IO_XSGETN(FP, DATA, N) JUMP2 (__xsgetn, FP, DATA, N)
144 /* The 'seekoff' hook moves the stream position to a new position
145 relative to the start of the file (if DIR==0), the current position
146 (MODE==1), or the end of the file (MODE==2).
147 It matches the streambuf::seekoff virtual function.
148 It is also used for the ANSI fseek function. */
149 typedef _IO_fpos64_t (*_IO_seekoff_t) __PMT ((_IO_FILE *FP, _IO_off64_t OFF,
150 int DIR, int MODE));
151 #define _IO_SEEKOFF(FP, OFF, DIR, MODE) JUMP3 (__seekoff, FP, OFF, DIR, MODE)
153 /* The 'seekpos' hook also moves the stream position,
154 but to an absolute position given by a fpos64_t (seekpos).
155 It matches the streambuf::seekpos virtual function.
156 It is also used for the ANSI fgetpos and fsetpos functions. */
157 /* The _IO_seek_cur and _IO_seek_end options are not allowed. */
158 typedef _IO_fpos64_t (*_IO_seekpos_t) __PMT ((_IO_FILE *, _IO_fpos64_t, int));
159 #define _IO_SEEKPOS(FP, POS, FLAGS) JUMP2 (__seekpos, FP, POS, FLAGS)
161 /* The 'setbuf' hook gives a buffer to the file.
162 It matches the streambuf::setbuf virtual function. */
163 typedef _IO_FILE* (*_IO_setbuf_t) __PMT ((_IO_FILE *, char *, _IO_ssize_t));
164 #define _IO_SETBUF(FP, BUFFER, LENGTH) JUMP2 (__setbuf, FP, BUFFER, LENGTH)
166 /* The 'sync' hook attempts to synchronize the internal data structures
167 of the file with the external state.
168 It matches the streambuf::sync virtual function. */
169 typedef int (*_IO_sync_t) __PMT ((_IO_FILE *));
170 #define _IO_SYNC(FP) JUMP0 (__sync, FP)
172 /* The 'doallocate' hook is used to tell the file to allocate a buffer.
173 It matches the streambuf::doallocate virtual function, which is not
174 in the ANSI/ISO C++ standard, but is part traditional implementations. */
175 typedef int (*_IO_doallocate_t) __PMT ((_IO_FILE *));
176 #define _IO_DOALLOCATE(FP) JUMP0 (__doallocate, FP)
178 /* The following four hooks (sysread, syswrite, sysclose, sysseek, and
179 sysstat) are low-level hooks specific to this implementation.
180 There is no correspondence in the ANSI/ISO C++ standard library.
181 The hooks basically correspond to the Unix system functions
182 (read, write, close, lseek, and stat) except that a _IO_FILE*
183 parameter is used instead of a integer file descriptor; the default
184 implementation used for normal files just calls those functions.
185 The advantage of overriding these functions instead of the higher-level
186 ones (underflow, overflow etc) is that you can leave all the buffering
187 higher-level functions. */
189 /* The 'sysread' hook is used to read data from the external file into
190 an existing buffer. It generalizes the Unix read(2) function.
191 It matches the streambuf::sys_read virtual function, which is
192 specific to this implementation. */
193 typedef _IO_ssize_t (*_IO_read_t) __PMT ((_IO_FILE *, void *, _IO_ssize_t));
194 #define _IO_SYSREAD(FP, DATA, LEN) JUMP2 (__read, FP, DATA, LEN)
196 /* The 'syswrite' hook is used to write data from an existing buffer
197 to an external file. It generalizes the Unix write(2) function.
198 It matches the streambuf::sys_write virtual function, which is
199 specific to this implementation. */
200 typedef _IO_ssize_t (*_IO_write_t) __PMT ((_IO_FILE *, const void *,
201 _IO_ssize_t));
202 #define _IO_SYSWRITE(FP, DATA, LEN) JUMP2 (__write, FP, DATA, LEN)
204 /* The 'sysseek' hook is used to re-position an external file.
205 It generalizes the Unix lseek(2) function.
206 It matches the streambuf::sys_seek virtual function, which is
207 specific to this implementation. */
208 typedef _IO_fpos64_t (*_IO_seek_t) __PMT ((_IO_FILE *, _IO_off64_t, int));
209 #define _IO_SYSSEEK(FP, OFFSET, MODE) JUMP2 (__seek, FP, OFFSET, MODE)
211 /* The 'sysclose' hook is used to finalize (close, finish up) an
212 external file. It generalizes the Unix close(2) function.
213 It matches the streambuf::sys_close virtual function, which is
214 specific to this implementation. */
215 typedef int (*_IO_close_t) __PMT ((_IO_FILE *)); /* finalize */
216 #define _IO_SYSCLOSE(FP) JUMP0 (__close, FP)
218 /* The 'sysstat' hook is used to get information about an external file
219 into a struct stat buffer. It generalizes the Unix fstat(2) call.
220 It matches the streambuf::sys_stat virtual function, which is
221 specific to this implementation. */
222 typedef int (*_IO_stat_t) __PMT ((_IO_FILE *, void *));
223 #define _IO_SYSSTAT(FP, BUF) JUMP1 (__stat, FP, BUF)
225 /* The 'showmany' hook can be used to get an image how much input is
226 available. In many cases the answer will be 0 which means unknown
227 but some cases one can provide real information. */
228 typedef int (*_IO_showmanyc_t) __PMT ((_IO_FILE *));
229 #define _IO_SHOWMANYC(FP) JUMP0 (__showmanyc, FP)
231 /* The 'imbue' hook is used to get information about the currently
232 installed locales. */
233 typedef void (*_IO_imbue_t) __PMT ((_IO_FILE *, void *));
234 #define _IO_IMBUE(FP, LOCALE) JUMP1 (__imbue, FP, LOCALE)
237 #define _IO_CHAR_TYPE char /* unsigned char ? */
238 #define _IO_INT_TYPE int
240 struct _IO_jump_t
242 JUMP_FIELD(_G_size_t, __dummy);
243 #ifdef _G_USING_THUNKS
244 JUMP_FIELD(_G_size_t, __dummy2);
245 #endif
246 JUMP_FIELD(_IO_finish_t, __finish);
247 JUMP_FIELD(_IO_overflow_t, __overflow);
248 JUMP_FIELD(_IO_underflow_t, __underflow);
249 JUMP_FIELD(_IO_underflow_t, __uflow);
250 JUMP_FIELD(_IO_pbackfail_t, __pbackfail);
251 /* showmany */
252 JUMP_FIELD(_IO_xsputn_t, __xsputn);
253 JUMP_FIELD(_IO_xsgetn_t, __xsgetn);
254 JUMP_FIELD(_IO_seekoff_t, __seekoff);
255 JUMP_FIELD(_IO_seekpos_t, __seekpos);
256 JUMP_FIELD(_IO_setbuf_t, __setbuf);
257 JUMP_FIELD(_IO_sync_t, __sync);
258 JUMP_FIELD(_IO_doallocate_t, __doallocate);
259 JUMP_FIELD(_IO_read_t, __read);
260 JUMP_FIELD(_IO_write_t, __write);
261 JUMP_FIELD(_IO_seek_t, __seek);
262 JUMP_FIELD(_IO_close_t, __close);
263 JUMP_FIELD(_IO_stat_t, __stat);
264 JUMP_FIELD(_IO_showmanyc_t, __showmanyc);
265 JUMP_FIELD(_IO_imbue_t, __imbue);
266 #if 0
267 get_column;
268 set_column;
269 #endif
272 /* We always allocate an extra word following an _IO_FILE.
273 This contains a pointer to the function jump table used.
274 This is for compatibility with C++ streambuf; the word can
275 be used to smash to a pointer to a virtual function table. */
277 struct _IO_FILE_plus
279 _IO_FILE file;
280 const struct _IO_jump_t *vtable;
283 /* Generic functions */
285 extern _IO_fpos64_t _IO_seekoff __P ((_IO_FILE *, _IO_off64_t, int, int));
286 extern _IO_fpos64_t _IO_seekpos __P ((_IO_FILE *, _IO_fpos64_t, int));
288 extern void _IO_switch_to_main_get_area __P ((_IO_FILE *));
289 extern void _IO_switch_to_backup_area __P ((_IO_FILE *));
290 extern int _IO_switch_to_get_mode __P ((_IO_FILE *));
291 extern void _IO_init __P ((_IO_FILE *, int));
292 extern int _IO_sputbackc __P ((_IO_FILE *, int));
293 extern int _IO_sungetc __P ((_IO_FILE *));
294 extern void _IO_un_link __P ((_IO_FILE *));
295 extern void _IO_link_in __P ((_IO_FILE *));
296 extern void _IO_doallocbuf __P ((_IO_FILE *));
297 extern void _IO_unsave_markers __P ((_IO_FILE *));
298 extern void _IO_setb __P ((_IO_FILE *, char *, char *, int));
299 extern unsigned _IO_adjust_column __P ((unsigned, const char *, int));
300 #define _IO_sputn(__fp, __s, __n) _IO_XSPUTN (__fp, __s, __n)
302 /* Marker-related function. */
304 extern void _IO_init_marker __P ((struct _IO_marker *, _IO_FILE *));
305 extern void _IO_remove_marker __P ((struct _IO_marker *));
306 extern int _IO_marker_difference __P ((struct _IO_marker *,
307 struct _IO_marker *));
308 extern int _IO_marker_delta __P ((struct _IO_marker *));
309 extern int _IO_seekmark __P ((_IO_FILE *, struct _IO_marker *, int));
311 /* Default jumptable functions. */
313 extern int _IO_default_underflow __P ((_IO_FILE *));
314 extern int _IO_default_uflow __P ((_IO_FILE *));
315 extern int _IO_default_doallocate __P ((_IO_FILE *));
316 extern void _IO_default_finish __P ((_IO_FILE *, int));
317 extern int _IO_default_pbackfail __P ((_IO_FILE *, int));
318 extern _IO_FILE* _IO_default_setbuf __P ((_IO_FILE *, char *, _IO_ssize_t));
319 extern _IO_size_t _IO_default_xsputn __P ((_IO_FILE *, const void *,
320 _IO_size_t));
321 extern _IO_size_t _IO_default_xsgetn __P ((_IO_FILE *, void *, _IO_size_t));
322 extern _IO_fpos64_t _IO_default_seekoff __P ((_IO_FILE *,
323 _IO_off64_t, int, int));
324 extern _IO_fpos64_t _IO_default_seekpos __P ((_IO_FILE *,
325 _IO_fpos64_t, int));
326 extern _IO_ssize_t _IO_default_write __P ((_IO_FILE *, const void *,
327 _IO_ssize_t));
328 extern _IO_ssize_t _IO_default_read __P ((_IO_FILE *, void *, _IO_ssize_t));
329 extern int _IO_default_stat __P ((_IO_FILE *, void *));
330 extern _IO_fpos64_t _IO_default_seek __P ((_IO_FILE *, _IO_off64_t, int));
331 extern int _IO_default_sync __P ((_IO_FILE *));
332 #define _IO_default_close ((_IO_close_t) _IO_default_sync)
333 extern int _IO_default_showmanyc __P ((_IO_FILE *));
334 extern void _IO_default_imbue __P ((_IO_FILE *, void *));
336 extern struct _IO_jump_t _IO_file_jumps;
337 extern struct _IO_jump_t _IO_old_file_jumps;
338 extern struct _IO_jump_t _IO_streambuf_jumps;
339 extern struct _IO_jump_t _IO_proc_jumps;
340 extern struct _IO_jump_t _IO_old_proc_jumps;
341 extern struct _IO_jump_t _IO_str_jumps;
342 extern int _IO_do_write __P ((_IO_FILE *, const char *, _IO_size_t));
343 extern int _IO_new_do_write __P ((_IO_FILE *, const char *, _IO_size_t));
344 extern int _IO_old_do_write __P ((_IO_FILE *, const char *, _IO_size_t));
345 extern int _IO_flush_all __P ((void));
346 extern int _IO_cleanup __P ((void));
347 extern void _IO_flush_all_linebuffered __P ((void));
349 #define _IO_do_flush(_f) \
350 _IO_do_write(_f, (_f)->_IO_write_base, \
351 (_f)->_IO_write_ptr-(_f)->_IO_write_base)
352 #define _IO_old_do_flush(_f) \
353 _IO_old_do_write(_f, (_f)->_IO_write_base, \
354 (_f)->_IO_write_ptr-(_f)->_IO_write_base)
355 #define _IO_in_put_mode(_fp) ((_fp)->_flags & _IO_CURRENTLY_PUTTING)
356 #define _IO_mask_flags(fp, f, mask) \
357 ((fp)->_flags = ((fp)->_flags & ~(mask)) | ((f) & (mask)))
358 #define _IO_setg(fp, eb, g, eg) ((fp)->_IO_read_base = (eb),\
359 (fp)->_IO_read_ptr = (g), (fp)->_IO_read_end = (eg))
360 #define _IO_setp(__fp, __p, __ep) \
361 ((__fp)->_IO_write_base = (__fp)->_IO_write_ptr = __p, (__fp)->_IO_write_end = (__ep))
362 #define _IO_have_backup(fp) ((fp)->_IO_save_base != NULL)
363 #define _IO_in_backup(fp) ((fp)->_flags & _IO_IN_BACKUP)
364 #define _IO_have_markers(fp) ((fp)->_markers != NULL)
365 #define _IO_blen(fp) ((fp)->_IO_buf_end - (fp)->_IO_buf_base)
367 /* Jumptable functions for files. */
369 extern int _IO_file_doallocate __P ((_IO_FILE *));
370 extern _IO_FILE* _IO_file_setbuf __P ((_IO_FILE *, char *, _IO_ssize_t));
371 extern _IO_fpos64_t _IO_file_seekoff __P ((_IO_FILE *, _IO_off64_t, int, int));
372 extern _IO_size_t _IO_file_xsputn __P ((_IO_FILE *, const void *, _IO_size_t));
373 extern _IO_size_t _IO_file_xsgetn __P ((_IO_FILE *, void *, _IO_size_t));
374 extern int _IO_file_stat __P ((_IO_FILE *, void *));
375 extern int _IO_file_close __P ((_IO_FILE *));
376 extern int _IO_file_underflow __P ((_IO_FILE *));
377 extern int _IO_file_overflow __P ((_IO_FILE *, int));
378 #define _IO_file_is_open(__fp) ((__fp)->_fileno >= 0)
379 extern void _IO_file_init __P ((_IO_FILE *));
380 extern _IO_FILE* _IO_file_attach __P ((_IO_FILE *, int));
381 extern _IO_FILE* _IO_file_open __P ((_IO_FILE *, const char *, int, int,
382 int, int));
383 extern _IO_FILE* _IO_file_fopen __P ((_IO_FILE *, const char *, const char *,
384 int));
385 extern _IO_ssize_t _IO_file_write __P ((_IO_FILE *, const void *,
386 _IO_ssize_t));
387 extern _IO_ssize_t _IO_file_read __P ((_IO_FILE *, void *, _IO_ssize_t));
388 extern int _IO_file_sync __P ((_IO_FILE *));
389 extern int _IO_file_close_it __P ((_IO_FILE *));
390 extern _IO_fpos64_t _IO_file_seek __P ((_IO_FILE *, _IO_off64_t, int));
391 extern void _IO_file_finish __P ((_IO_FILE *, int));
393 extern _IO_FILE* _IO_new_file_attach __P ((_IO_FILE *, int));
394 extern int _IO_new_file_close_it __P ((_IO_FILE *));
395 extern void _IO_new_file_finish __P ((_IO_FILE *, int));
396 extern _IO_FILE* _IO_new_file_fopen __P ((_IO_FILE *, const char *, const char *,
397 int));
398 extern void _IO_new_file_init __P ((_IO_FILE *));
399 extern _IO_FILE* _IO_new_file_setbuf __P ((_IO_FILE *, char *, _IO_ssize_t));
400 extern int _IO_new_file_sync __P ((_IO_FILE *));
401 extern int _IO_new_file_underflow __P ((_IO_FILE *));
402 extern int _IO_new_file_overflow __P ((_IO_FILE *, int));
403 extern _IO_fpos64_t _IO_new_file_seekoff __P ((_IO_FILE *, _IO_off64_t, int, int));
404 extern _IO_ssize_t _IO_new_file_write __P ((_IO_FILE *, const void *,
405 _IO_ssize_t));
406 extern _IO_size_t _IO_new_file_xsputn __P ((_IO_FILE *, const void *, _IO_size_t));
408 extern _IO_FILE* _IO_old_file_setbuf __P ((_IO_FILE *, char *, _IO_ssize_t));
409 extern _IO_fpos64_t _IO_old_file_seekoff __P ((_IO_FILE *, _IO_off64_t, int,
410 int));
411 extern _IO_size_t _IO_old_file_xsputn __P ((_IO_FILE *, const void *,
412 _IO_size_t));
413 extern int _IO_old_file_underflow __P ((_IO_FILE *));
414 extern int _IO_old_file_overflow __P ((_IO_FILE *, int));
415 extern void _IO_old_file_init __P ((_IO_FILE *));
416 extern _IO_FILE* _IO_old_file_attach __P ((_IO_FILE *, int));
417 extern _IO_FILE* _IO_old_file_fopen __P ((_IO_FILE *, const char *,
418 const char *));
419 extern _IO_ssize_t _IO_old_file_write __P ((_IO_FILE *, const void *,
420 _IO_ssize_t));
421 extern int _IO_old_file_sync __P ((_IO_FILE *));
422 extern int _IO_old_file_close_it __P ((_IO_FILE *));
423 extern void _IO_old_file_finish __P ((_IO_FILE *, int));
425 /* Jumptable functions for proc_files. */
426 extern _IO_FILE* _IO_proc_open __P ((_IO_FILE *, const char *, const char *));
427 extern _IO_FILE* _IO_new_proc_open __P ((_IO_FILE *, const char *, const char *));
428 extern _IO_FILE* _IO_old_proc_open __P ((_IO_FILE *, const char *, const char *));
429 extern int _IO_proc_close __P ((_IO_FILE *));
430 extern int _IO_new_proc_close __P ((_IO_FILE *));
431 extern int _IO_old_proc_close __P ((_IO_FILE *));
433 /* Jumptable functions for strfiles. */
434 extern int _IO_str_underflow __P ((_IO_FILE *));
435 extern int _IO_str_overflow __P ((_IO_FILE *, int));
436 extern int _IO_str_pbackfail __P ((_IO_FILE *, int));
437 extern _IO_fpos64_t _IO_str_seekoff __P ((_IO_FILE *, _IO_off64_t, int, int));
438 extern void _IO_str_finish __P ((_IO_FILE *, int));
440 /* Other strfile functions */
441 extern void _IO_str_init_static __P ((_IO_FILE *, char *, int, char *));
442 extern void _IO_str_init_readonly __P ((_IO_FILE *, const char *, int));
443 extern _IO_ssize_t _IO_str_count __P ((_IO_FILE *));
445 extern int _IO_vasprintf __P ((char **result_ptr, __const char *format,
446 _IO_va_list args));
447 extern int _IO_vdprintf __P ((int d, __const char *format, _IO_va_list arg));
448 extern int _IO_vsnprintf __P ((char *string, _IO_size_t maxlen,
449 __const char *format, _IO_va_list args));
452 extern _IO_size_t _IO_getline __P ((_IO_FILE *,char *, _IO_size_t, int, int));
453 extern _IO_size_t _IO_getline_info __P ((_IO_FILE *,char *, _IO_size_t,
454 int, int, int *));
455 extern _IO_ssize_t _IO_getdelim __P ((char **, _IO_size_t *, int, _IO_FILE *));
456 extern double _IO_strtod __P ((const char *, char **));
457 extern char *_IO_dtoa __P ((double __d, int __mode, int __ndigits,
458 int *__decpt, int *__sign, char **__rve));
459 extern int _IO_outfloat __P ((double __value, _IO_FILE *__sb, int __type,
460 int __width, int __precision, int __flags,
461 int __sign_mode, int __fill));
463 extern _IO_FILE *_IO_list_all;
464 extern void (*_IO_cleanup_registration_needed) __PMT ((void));
466 #ifndef EOF
467 # define EOF (-1)
468 #endif
469 #ifndef NULL
470 # if defined __GNUG__ && \
471 (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
472 # define NULL (__null)
473 # else
474 # if !defined(__cplusplus)
475 # define NULL ((void*)0)
476 # else
477 # define NULL (0)
478 # endif
479 # endif
480 #endif
482 #if _G_HAVE_MMAP
484 # include <unistd.h>
485 # include <fcntl.h>
486 # include <sys/mman.h>
487 # include <sys/param.h>
489 # if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
490 # define MAP_ANONYMOUS MAP_ANON
491 # endif
493 # if !defined(MAP_ANONYMOUS) || !defined(EXEC_PAGESIZE)
494 # undef _G_HAVE_MMAP
495 # define _G_HAVE_MMAP 0
496 # endif
498 #endif /* _G_HAVE_MMAP */
500 #if _G_HAVE_MMAP
502 # ifdef _LIBC
503 /* When using this code in the GNU libc we must not pollute the name space. */
504 # define mmap __mmap
505 # define munmap __munmap
506 # define ftruncate __ftruncate
507 # endif
509 # define ROUND_TO_PAGE(_S) \
510 (((_S) + EXEC_PAGESIZE - 1) & ~(EXEC_PAGESIZE - 1))
512 # define FREE_BUF(_B, _S) \
513 munmap ((_B), ROUND_TO_PAGE (_S))
514 # define ALLOC_BUF(_B, _S, _R) \
515 do { \
516 (_B) = (char *) mmap (0, ROUND_TO_PAGE (_S), \
517 PROT_READ | PROT_WRITE, \
518 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0); \
519 if ((_B) == (char *) -1) \
520 return (_R); \
521 } while (0)
523 #else /* _G_HAVE_MMAP */
525 # define FREE_BUF(_B, _S) \
526 free(_B)
527 # define ALLOC_BUF(_B, _S, _R) \
528 do { \
529 (_B) = (char*)malloc(_S); \
530 if ((_B) == NULL) \
531 return (_R); \
532 } while (0)
534 #endif /* _G_HAVE_MMAP */
536 #ifndef OS_FSTAT
537 # define OS_FSTAT fstat
538 #endif
539 struct stat;
540 extern _IO_ssize_t _IO_read __P ((int, void *, _IO_size_t));
541 extern _IO_ssize_t _IO_write __P ((int, const void *, _IO_size_t));
542 extern _IO_off64_t _IO_lseek __P ((int, _IO_off64_t, int));
543 extern int _IO_close __P ((int));
544 extern int _IO_fstat __P ((int, struct stat *));
545 extern int _IO_vscanf __P ((const char *, _IO_va_list));
547 /* Operations on _IO_fpos64_t.
548 Normally, these are trivial, but we provide hooks for configurations
549 where an _IO_fpos64_t is a struct.
550 Note that _IO_off64_t must be an integral type. */
552 /* _IO_pos_BAD is an _IO_fpos64_t value indicating error, unknown, or EOF. */
553 #ifndef _IO_pos_BAD
554 # define _IO_pos_BAD ((_IO_fpos64_t) -1)
555 #endif
556 /* _IO_pos_as_off converts an _IO_fpos64_t value to an _IO_off64_t value. */
557 #ifndef _IO_pos_as_off
558 # define _IO_pos_as_off(__pos) ((_IO_off64_t) (__pos))
559 #endif
560 /* _IO_pos_adjust adjust an _IO_fpos64_t by some number of bytes. */
561 #ifndef _IO_pos_adjust
562 # define _IO_pos_adjust(__pos, __delta) ((__pos) += (__delta))
563 #endif
564 /* _IO_pos_0 is an _IO_fpos64_t value indicating beginning of file. */
565 #ifndef _IO_pos_0
566 # define _IO_pos_0 ((_IO_fpos64_t) 0)
567 #endif
569 #ifdef __cplusplus
571 #endif
573 #ifdef _IO_MTSAFE_IO
574 /* check following! */
575 # ifdef _IO_USE_OLD_IO_FILE
576 # define FILEBUF_LITERAL(CHAIN, FLAGS, FD) \
577 { _IO_MAGIC+_IO_LINKED+_IO_IS_FILEBUF+FLAGS, \
578 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, CHAIN, FD, \
579 0, _IO_pos_BAD, 0, 0, { 0 }, &_IO_stdfile_##FD##_lock }
580 # else
581 # define FILEBUF_LITERAL(CHAIN, FLAGS, FD) \
582 { _IO_MAGIC+_IO_LINKED+_IO_IS_FILEBUF+FLAGS, \
583 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, CHAIN, FD, \
584 0, _IO_pos_BAD, 0, 0, { 0 }, &_IO_stdfile_##FD##_lock, _IO_pos_BAD }
585 # endif
586 #else
587 # ifdef _IO_USE_OLD_IO_FILE
588 # define FILEBUF_LITERAL(CHAIN, FLAGS, FD) \
589 { _IO_MAGIC+_IO_LINKED+_IO_IS_FILEBUF+FLAGS, \
590 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, CHAIN, FD, 0, _IO_pos_BAD }
591 # else
592 # define FILEBUF_LITERAL(CHAIN, FLAGS, FD) \
593 { _IO_MAGIC+_IO_LINKED+_IO_IS_FILEBUF+FLAGS, \
594 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, CHAIN, FD, \
595 0, _IO_pos_BAD, 0, 0, { 0 }, 0, _IO_pos_BAD }
596 # endif
597 #endif
599 /* VTABLE_LABEL defines NAME as of the CLASS class.
600 CNLENGTH is strlen(#CLASS). */
601 #ifdef __GNUC__
602 # if _G_VTABLE_LABEL_HAS_LENGTH
603 # define VTABLE_LABEL(NAME, CLASS, CNLENGTH) \
604 extern char NAME[] asm (_G_VTABLE_LABEL_PREFIX #CNLENGTH #CLASS);
605 # else
606 # define VTABLE_LABEL(NAME, CLASS, CNLENGTH) \
607 extern char NAME[] asm (_G_VTABLE_LABEL_PREFIX #CLASS);
608 # endif
609 #endif /* __GNUC__ */
611 #if !defined(builtinbuf_vtable) && defined(__cplusplus)
612 # ifdef __GNUC__
613 VTABLE_LABEL(builtinbuf_vtable, builtinbuf, 10)
614 # else
615 # if _G_VTABLE_LABEL_HAS_LENGTH
616 # define builtinbuf_vtable _G_VTABLE_LABEL_PREFIX_ID##10builtinbuf
617 # else
618 # define builtinbuf_vtable _G_VTABLE_LABEL_PREFIX_ID##builtinbuf
619 # endif
620 # endif
621 #endif /* !defined(builtinbuf_vtable) && defined(__cplusplus) */
623 #if defined(__STDC__) || defined(__cplusplus)
624 # define _IO_va_start(args, last) va_start(args, last)
625 #else
626 # define _IO_va_start(args, last) va_start(args)
627 #endif
629 extern struct _IO_fake_stdiobuf _IO_stdin_buf, _IO_stdout_buf, _IO_stderr_buf;
631 #if 1
632 # define COERCE_FILE(FILE) /* Nothing */
633 #else
634 /* This is part of the kludge for binary compatibility with old stdio. */
635 # define COERCE_FILE(FILE) \
636 (((FILE)->_IO_file_flags & _IO_MAGIC_MASK) == _OLD_MAGIC_MASK \
637 && (FILE) = *(FILE**)&((int*)fp)[1])
638 #endif
640 #ifdef EINVAL
641 # define MAYBE_SET_EINVAL __set_errno (EINVAL)
642 #else
643 # define MAYBE_SET_EINVAL /* nothing */
644 #endif
646 #ifdef IO_DEBUG
647 # define CHECK_FILE(FILE, RET) \
648 if ((FILE) == NULL) { MAYBE_SET_EINVAL; return RET; } \
649 else { COERCE_FILE(FILE); \
650 if (((FILE)->_IO_file_flags & _IO_MAGIC_MASK) != _IO_MAGIC) \
651 { MAYBE_SET_EINVAL; return RET; }}
652 #else
653 # define CHECK_FILE(FILE, RET) COERCE_FILE (FILE)
654 #endif