03b2afdf2810d43efa2dd1d69abeb349febdace7
[kopensolaris-gnu/glibc.git] / libio / libio.h
1 /* Copyright (C) 1991, 92, 93, 94, 95, 97 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 #include <features.h>
30
31 #include <_G_config.h>
32 #define _IO_pos_t _G_fpos_t /* obsolete */
33 #define _IO_fpos_t _G_fpos_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_pid_t _G_pid_t
38 #define _IO_uid_t _G_uid_t
39 #define _IO_HAVE_SYS_WAIT _G_HAVE_SYS_WAIT
40 #define _IO_HAVE_ST_BLKSIZE _G_HAVE_ST_BLKSIZE
41 #define _IO_BUFSIZ _G_BUFSIZ
42 #define _IO_va_list _G_va_list
43
44 #ifdef _G_NEED_STDARG_H
45 /* This define avoids name pollution if we're using GNU stdarg.h */
46 # define __need___va_list
47 # include <stdarg.h>
48 # ifdef __GNUC_VA_LIST
49 #  undef _IO_va_list
50 #  define _IO_va_list __gnuc_va_list
51 # endif /* __GNUC_VA_LIST */
52 #endif
53
54 #ifndef __P
55 # if _G_HAVE_SYS_CDEFS
56 #  include <sys/cdefs.h>
57 # else
58 #  ifdef __STDC__
59 #   define __P(protos) protos
60 #  else
61 #   define __P(protos) ()
62 #  endif
63 # endif
64 #endif /*!__P*/
65
66 /* For backward compatibility */
67 #ifndef _PARAMS
68 # define _PARAMS(protos) __P(protos)
69 #endif /*!_PARAMS*/
70
71 #ifndef __STDC__
72 # define const
73 #endif
74 #define _IO_UNIFIED_JUMPTABLES 1
75
76 #if 0
77 # ifdef _IO_NEED_STDARG_H
78 #  include <stdarg.h>
79 # endif
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 # include <bits/stdio-lock.h>
157 #else
158 typedef void _IO_lock_t;
159 #endif
160
161
162 /* A streammarker remembers a position in a buffer. */
163
164 struct _IO_marker {
165   struct _IO_marker *_next;
166   struct _IO_FILE *_sbuf;
167   /* If _pos >= 0
168  it points to _buf->Gbase()+_pos. FIXME comment */
169   /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
170   int _pos;
171 #if 0
172     void set_streampos(streampos sp) { _spos = sp; }
173     void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
174   public:
175     streammarker(streambuf *sb);
176     ~streammarker();
177     int saving() { return  _spos == -2; }
178     int delta(streammarker&);
179     int delta();
180 #endif
181 };
182
183 struct _IO_FILE {
184   int _flags;           /* High-order word is _IO_MAGIC; rest is flags. */
185 #define _IO_file_flags _flags
186
187   /* The following pointers correspond to the C++ streambuf protocol. */
188   /* Note:  Tk uses the _IO_read_ptr and _IO_read_end fields directly. */
189   char* _IO_read_ptr;   /* Current read pointer */
190   char* _IO_read_end;   /* End of get area. */
191   char* _IO_read_base;  /* Start of putback+get area. */
192   char* _IO_write_base; /* Start of put area. */
193   char* _IO_write_ptr;  /* Current put pointer. */
194   char* _IO_write_end;  /* End of put area. */
195   char* _IO_buf_base;   /* Start of reserve area. */
196   char* _IO_buf_end;    /* End of reserve area. */
197   /* The following fields are used to support backing up and undo. */
198   char *_IO_save_base; /* Pointer to start of non-current get area. */
199   char *_IO_backup_base;  /* Pointer to first valid character of backup area */
200   char *_IO_save_end; /* Pointer to end of non-current get area. */
201
202   struct _IO_marker *_markers;
203
204   struct _IO_FILE *_chain;
205
206   int _fileno;
207   int _blksize;
208   _IO_off_t _offset;
209
210 #define __HAVE_COLUMN /* temporary */
211   /* 1+column number of pbase(); 0 is unknown. */
212   unsigned short _cur_column;
213   char _unused;
214   char _shortbuf[1];
215
216   /*  char* _save_gptr;  char* _save_egptr; */
217
218   _IO_lock_t *_lock;
219 };
220
221 #ifndef __cplusplus
222 typedef struct _IO_FILE _IO_FILE;
223 #endif
224
225 struct _IO_FILE_plus;
226 extern struct _IO_FILE_plus _IO_stdin_, _IO_stdout_, _IO_stderr_;
227 #define _IO_stdin ((_IO_FILE*)(&_IO_stdin_))
228 #define _IO_stdout ((_IO_FILE*)(&_IO_stdout_))
229 #define _IO_stderr ((_IO_FILE*)(&_IO_stderr_))
230
231
232 /* Define the user-visible type, with user-friendly member names.  */
233 typedef struct
234 {
235   _IO_ssize_t (*read) __P ((struct _IO_FILE *, void *, _IO_ssize_t));
236   _IO_ssize_t (*write) __P ((struct _IO_FILE *, const void *, _IO_ssize_t));
237   _IO_fpos_t (*seek) __P ((struct _IO_FILE *, _IO_off_t, int));
238   int (*close) __P ((struct _IO_FILE *));
239 } _IO_cookie_io_functions_t;
240
241 /* Special file type for fopencookie function.  */
242 struct _IO_cookie_file
243 {
244   struct _IO_FILE file;
245   const void *vtable;
246   void *cookie;
247   _IO_cookie_io_functions_t io_functions;
248 };
249
250
251 #ifdef __cplusplus
252 extern "C" {
253 #endif
254
255 extern int __underflow __P ((_IO_FILE *));
256 extern int __uflow __P ((_IO_FILE *));
257 extern int __overflow __P ((_IO_FILE *, int));
258
259 #define _IO_getc_unlocked(_fp) \
260        ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end ? __uflow (_fp) \
261         : *(unsigned char *) (_fp)->_IO_read_ptr++)
262 #define _IO_peekc_unlocked(_fp) \
263        ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end \
264           && __underflow (_fp) == EOF ? EOF \
265         : *(unsigned char *) (_fp)->_IO_read_ptr)
266
267 #define _IO_putc_unlocked(_ch, _fp) \
268    (((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end) \
269     ? __overflow (_fp, (unsigned char) (_ch)) \
270     : (unsigned char) (*(_fp)->_IO_write_ptr++ = (_ch)))
271
272 #define _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
273 #define _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)
274
275 extern int _IO_getc __P ((_IO_FILE *__fp));
276 extern int _IO_putc __P ((int __c, _IO_FILE *__fp));
277 extern int _IO_feof __P ((_IO_FILE *__fp));
278 extern int _IO_ferror __P ((_IO_FILE *__fp));
279
280 extern int _IO_peekc_locked __P ((_IO_FILE *__fp));
281
282 /* This one is for Emacs. */
283 #define _IO_PENDING_OUTPUT_COUNT(_fp)   \
284         ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
285
286 extern void _IO_flockfile __P ((_IO_FILE *));
287 extern void _IO_funlockfile __P ((_IO_FILE *));
288 extern int _IO_ftrylockfile __P ((_IO_FILE *));
289
290 #ifndef _IO_MTSAFE_IO
291 # define _IO_flockfile(_fp) /**/
292 # define _IO_funlockfile(_fp) /**/
293 # define _IO_ftrylockfile(_fp) /**/
294 # define _IO_cleanup_region_start(_fct, _fp) /**/
295 # define _IO_cleanup_region_end(_Doit) /**/
296 #endif /* !_IO_MTSAFE_IO */
297
298 #define _IO_peekc(_fp) _IO_peekc_locked (_fp)
299
300 extern int _IO_vfscanf __P ((_IO_FILE *, const char *, _IO_va_list, int *));
301 extern int _IO_vfprintf __P ((_IO_FILE *, const char *, _IO_va_list));
302 extern _IO_ssize_t _IO_padn __P ((_IO_FILE *, int, _IO_ssize_t));
303 extern _IO_size_t _IO_sgetn __P ((_IO_FILE *, void *, _IO_size_t));
304
305 extern _IO_fpos_t _IO_seekoff __P ((_IO_FILE *, _IO_off_t, int, int));
306 extern _IO_fpos_t _IO_seekpos __P ((_IO_FILE *, _IO_fpos_t, int));
307
308 extern void _IO_free_backup_area __P ((_IO_FILE *));
309
310 #ifdef __cplusplus
311 }
312 #endif
313
314 #endif /* _IO_STDIO_H */