Use __PMT instead of __P for function pointer.
[kopensolaris-gnu/glibc.git] / libio / libio.h
1 /* Copyright (C) 1991, 92, 93, 94, 95, 97, 98 Free Software Foundation, Inc.
2    This file is part of the GNU IO Library.
3    Written by Per Bothner <bothner@cygnus.com>.
4
5    This library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU General Public License as
7    published by the Free Software Foundation; either version 2, or (at
8    your option) any later version.
9
10    This library is distributed in the hope that it will be useful, but
11    WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this library; see the file COPYING.  If not, write to
17    the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
18    MA 02111-1307, USA.
19
20    As a special exception, if you link this library with files
21    compiled with a GNU compiler to produce an executable, this does
22    not cause the resulting executable to be covered by the GNU General
23    Public License.  This exception does not however invalidate any
24    other reasons why the executable file might be covered by the GNU
25    General Public License.  */
26
27 #ifndef _IO_STDIO_H
28 #define _IO_STDIO_H
29
30 #include <_G_config.h>
31 #define _IO_pos_t _G_fpos_t /* obsolete */
32 #define _IO_fpos_t _G_fpos_t
33 #define _IO_fpos64_t _G_fpos64_t
34 #define _IO_size_t _G_size_t
35 #define _IO_ssize_t _G_ssize_t
36 #define _IO_off_t _G_off_t
37 #define _IO_off64_t _G_off64_t
38 #define _IO_pid_t _G_pid_t
39 #define _IO_uid_t _G_uid_t
40 #define _IO_HAVE_SYS_WAIT _G_HAVE_SYS_WAIT
41 #define _IO_HAVE_ST_BLKSIZE _G_HAVE_ST_BLKSIZE
42 #define _IO_BUFSIZ _G_BUFSIZ
43 #define _IO_va_list _G_va_list
44
45 #ifdef _G_NEED_STDARG_H
46 /* This define avoids name pollution if we're using GNU stdarg.h */
47 # define __need___va_list
48 # include <stdarg.h>
49 # ifdef __GNUC_VA_LIST
50 #  undef _IO_va_list
51 #  define _IO_va_list __gnuc_va_list
52 # endif /* __GNUC_VA_LIST */
53 #endif
54
55 #ifndef __P
56 # if _G_HAVE_SYS_CDEFS
57 #  include <sys/cdefs.h>
58 # else
59 #  ifdef __STDC__
60 #   define __P(p) p
61 #   define __PMT(p) p
62 #  else
63 #   define __P(p) ()
64 #   define __PMT(p) ()
65 #  endif
66 # endif
67 #endif /*!__P*/
68
69 /* For backward compatibility */
70 #ifndef _PARAMS
71 # define _PARAMS(protos) __P(protos)
72 #endif /*!_PARAMS*/
73
74 #ifndef __STDC__
75 # define const
76 #endif
77 #define _IO_UNIFIED_JUMPTABLES 1
78 #ifndef _G_HAVE_PRINTF_FP
79 # define _IO_USE_DTOA 1
80 #endif
81
82 #ifndef EOF
83 # define EOF (-1)
84 #endif
85 #ifndef NULL
86 # if defined __GNUG__ && \
87     (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
88 #  define NULL (__null)
89 # else
90 #  if !defined(__cplusplus)
91 #   define NULL ((void*)0)
92 #  else
93 #   define NULL (0)
94 #  endif
95 # endif
96 #endif
97
98 #define _IOS_INPUT      1
99 #define _IOS_OUTPUT     2
100 #define _IOS_ATEND      4
101 #define _IOS_APPEND     8
102 #define _IOS_TRUNC      16
103 #define _IOS_NOCREATE   32
104 #define _IOS_NOREPLACE  64
105 #define _IOS_BIN        128
106
107 /* Magic numbers and bits for the _flags field.
108    The magic numbers use the high-order bits of _flags;
109    the remaining bits are available for variable flags.
110    Note: The magic numbers must all be negative if stdio
111    emulation is desired. */
112
113 #define _IO_MAGIC 0xFBAD0000 /* Magic number */
114 #define _OLD_STDIO_MAGIC 0xFABC0000 /* Emulate old stdio. */
115 #define _IO_MAGIC_MASK 0xFFFF0000
116 #define _IO_USER_BUF 1 /* User owns buffer; don't delete it on close. */
117 #define _IO_UNBUFFERED 2
118 #define _IO_NO_READS 4 /* Reading not allowed */
119 #define _IO_NO_WRITES 8 /* Writing not allowd */
120 #define _IO_EOF_SEEN 0x10
121 #define _IO_ERR_SEEN 0x20
122 #define _IO_DELETE_DONT_CLOSE 0x40 /* Don't call close(_fileno) on cleanup. */
123 #define _IO_LINKED 0x80 /* Set if linked (using _chain) to streambuf::_list_all.*/
124 #define _IO_IN_BACKUP 0x100
125 #define _IO_LINE_BUF 0x200
126 #define _IO_TIED_PUT_GET 0x400 /* Set if put and get pointer logicly tied. */
127 #define _IO_CURRENTLY_PUTTING 0x800
128 #define _IO_IS_APPENDING 0x1000
129 #define _IO_IS_FILEBUF 0x2000
130 #define _IO_BAD_SEEN 0x4000
131
132 /* These are "formatting flags" matching the iostream fmtflags enum values. */
133 #define _IO_SKIPWS 01
134 #define _IO_LEFT 02
135 #define _IO_RIGHT 04
136 #define _IO_INTERNAL 010
137 #define _IO_DEC 020
138 #define _IO_OCT 040
139 #define _IO_HEX 0100
140 #define _IO_SHOWBASE 0200
141 #define _IO_SHOWPOINT 0400
142 #define _IO_UPPERCASE 01000
143 #define _IO_SHOWPOS 02000
144 #define _IO_SCIENTIFIC 04000
145 #define _IO_FIXED 010000
146 #define _IO_UNITBUF 020000
147 #define _IO_STDIO 040000
148 #define _IO_DONT_CLOSE 0100000
149 #define _IO_BOOLALPHA 0200000
150
151
152 struct _IO_jump_t;  struct _IO_FILE;
153
154 /* Handle lock.  */
155 #ifdef _IO_MTSAFE_IO
156 # if defined __GLIBC__ && __GLIBC__ >= 2
157 #  include <bits/stdio-lock.h>
158 # else
159 /*# include <comthread.h>*/
160 # endif
161 #else
162 typedef void _IO_lock_t;
163 #endif
164
165
166 /* A streammarker remembers a position in a buffer. */
167
168 struct _IO_marker {
169   struct _IO_marker *_next;
170   struct _IO_FILE *_sbuf;
171   /* If _pos >= 0
172  it points to _buf->Gbase()+_pos. FIXME comment */
173   /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
174   int _pos;
175 #if 0
176     void set_streampos(streampos sp) { _spos = sp; }
177     void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
178   public:
179     streammarker(streambuf *sb);
180     ~streammarker();
181     int saving() { return  _spos == -2; }
182     int delta(streammarker&);
183     int delta();
184 #endif
185 };
186
187 struct _IO_FILE {
188   int _flags;           /* High-order word is _IO_MAGIC; rest is flags. */
189 #define _IO_file_flags _flags
190
191   /* The following pointers correspond to the C++ streambuf protocol. */
192   /* Note:  Tk uses the _IO_read_ptr and _IO_read_end fields directly. */
193   char* _IO_read_ptr;   /* Current read pointer */
194   char* _IO_read_end;   /* End of get area. */
195   char* _IO_read_base;  /* Start of putback+get area. */
196   char* _IO_write_base; /* Start of put area. */
197   char* _IO_write_ptr;  /* Current put pointer. */
198   char* _IO_write_end;  /* End of put area. */
199   char* _IO_buf_base;   /* Start of reserve area. */
200   char* _IO_buf_end;    /* End of reserve area. */
201   /* The following fields are used to support backing up and undo. */
202   char *_IO_save_base; /* Pointer to start of non-current get area. */
203   char *_IO_backup_base;  /* Pointer to first valid character of backup area */
204   char *_IO_save_end; /* Pointer to end of non-current get area. */
205
206   struct _IO_marker *_markers;
207
208   struct _IO_FILE *_chain;
209
210   int _fileno;
211   int _blksize;
212   _IO_off_t _old_offset; /* This used to be _offset but it's too small.  */
213
214 #define __HAVE_COLUMN /* temporary */
215   /* 1+column number of pbase(); 0 is unknown. */
216   unsigned short _cur_column;
217   signed char _vtable_offset;
218   char _shortbuf[1];
219
220   /*  char* _save_gptr;  char* _save_egptr; */
221
222   _IO_lock_t *_lock;
223 #ifdef _IO_USE_OLD_IO_FILE
224 };
225
226 struct _IO_FILE_complete
227 {
228   struct _IO_FILE _file;
229 #endif
230 #if defined _G_IO_IO_FILE_VERSION && _G_IO_IO_FILE_VERSION == 0x20001
231   _IO_off64_t _offset;
232   int _unused2[16];     /* Make sure we don't get into trouble again.  */
233 #endif
234 };
235
236 #ifndef __cplusplus
237 typedef struct _IO_FILE _IO_FILE;
238 #endif
239
240 struct _IO_FILE_plus;
241 extern struct _IO_FILE_plus _IO_2_1_stdin_;
242 extern struct _IO_FILE_plus _IO_2_1_stdout_;
243 extern struct _IO_FILE_plus _IO_2_1_stderr_;
244 #ifndef _LIBC
245 #define _IO_stdin ((_IO_FILE*)(&_IO_2_1_stdin_))
246 #define _IO_stdout ((_IO_FILE*)(&_IO_2_1_stdout_))
247 #define _IO_stderr ((_IO_FILE*)(&_IO_2_1_stderr_))
248 #else
249 extern _IO_FILE *_IO_stdin;
250 extern _IO_FILE *_IO_stdout;
251 extern _IO_FILE *_IO_stderr;
252 #endif
253
254
255 /* Define the user-visible type, with user-friendly member names.  */
256 typedef struct
257 {
258   _IO_ssize_t (*read) __PMT ((struct _IO_FILE *, void *, _IO_ssize_t));
259   _IO_ssize_t (*write) __PMT ((struct _IO_FILE *, const void *, _IO_ssize_t));
260   _IO_fpos_t (*seek) __PMT ((struct _IO_FILE *, _IO_off_t, int));
261   int (*close) __PMT ((struct _IO_FILE *));
262 } _IO_cookie_io_functions_t;
263
264 /* Special file type for fopencookie function.  */
265 struct _IO_cookie_file
266 {
267   struct _IO_FILE file;
268   const void *vtable;
269   void *cookie;
270   _IO_cookie_io_functions_t io_functions;
271 };
272
273
274 #ifdef __cplusplus
275 extern "C" {
276 #endif
277
278 extern int __underflow __P ((_IO_FILE *));
279 extern int __uflow __P ((_IO_FILE *));
280 extern int __overflow __P ((_IO_FILE *, int));
281
282 #define _IO_getc_unlocked(_fp) \
283        ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end ? __uflow (_fp) \
284         : *(unsigned char *) (_fp)->_IO_read_ptr++)
285 #define _IO_peekc_unlocked(_fp) \
286        ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end \
287           && __underflow (_fp) == EOF ? EOF \
288         : *(unsigned char *) (_fp)->_IO_read_ptr)
289
290 #define _IO_putc_unlocked(_ch, _fp) \
291    (((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end) \
292     ? __overflow (_fp, (unsigned char) (_ch)) \
293     : (unsigned char) (*(_fp)->_IO_write_ptr++ = (_ch)))
294
295 #define _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
296 #define _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)
297
298 extern int _IO_getc __P ((_IO_FILE *__fp));
299 extern int _IO_putc __P ((int __c, _IO_FILE *__fp));
300 extern int _IO_feof __P ((_IO_FILE *__fp));
301 extern int _IO_ferror __P ((_IO_FILE *__fp));
302
303 extern int _IO_peekc_locked __P ((_IO_FILE *__fp));
304
305 /* This one is for Emacs. */
306 #define _IO_PENDING_OUTPUT_COUNT(_fp)   \
307         ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
308
309 extern void _IO_flockfile __P ((_IO_FILE *));
310 extern void _IO_funlockfile __P ((_IO_FILE *));
311 extern int _IO_ftrylockfile __P ((_IO_FILE *));
312
313 #ifdef _IO_MTSAFE_IO
314 # define _IO_peekc(_fp) _IO_peekc_locked (_fp)
315 #else
316 # define _IO_peekc(_fp) _IO_peekc_unlocked (_fp)
317 # define _IO_flockfile(_fp) /**/
318 # define _IO_funlockfile(_fp) /**/
319 # define _IO_ftrylockfile(_fp) /**/
320 # define _IO_cleanup_region_start(_fct, _fp) /**/
321 # define _IO_cleanup_region_end(_Doit) /**/
322 #endif /* !_IO_MTSAFE_IO */
323
324 extern int _IO_vfscanf __P ((_IO_FILE *, const char *, _IO_va_list, int *));
325 extern int _IO_vfprintf __P ((_IO_FILE *, const char *, _IO_va_list));
326 extern _IO_ssize_t _IO_padn __P ((_IO_FILE *, int, _IO_ssize_t));
327 extern _IO_size_t _IO_sgetn __P ((_IO_FILE *, void *, _IO_size_t));
328
329 extern _IO_fpos64_t _IO_seekoff __P ((_IO_FILE *, _IO_off64_t, int, int));
330 extern _IO_fpos64_t _IO_seekpos __P ((_IO_FILE *, _IO_fpos64_t, int));
331
332 extern void _IO_free_backup_area __P ((_IO_FILE *));
333
334 #ifdef __cplusplus
335 }
336 #endif
337
338 #endif /* _IO_STDIO_H */