More libstdc++ cleanups. Define _IO_USE_DTOA if _G_HAVE_PRINTF_FP is
[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 #ifndef _G_HAVE_PRINTF_FP
76 # define _IO_USE_DTOA 1
77 #endif
78
79 #if 0
80 # ifdef _IO_NEED_STDARG_H
81 #  include <stdarg.h>
82 # endif
83 #endif
84
85 #ifndef EOF
86 # define EOF (-1)
87 #endif
88 #ifndef NULL
89 # if defined __GNUG__ && \
90     (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
91 #  define NULL (__null)
92 # else
93 #  if !defined(__cplusplus)
94 #   define NULL ((void*)0)
95 #  else
96 #   define NULL (0)
97 #  endif
98 # endif
99 #endif
100
101 #define _IOS_INPUT      1
102 #define _IOS_OUTPUT     2
103 #define _IOS_ATEND      4
104 #define _IOS_APPEND     8
105 #define _IOS_TRUNC      16
106 #define _IOS_NOCREATE   32
107 #define _IOS_NOREPLACE  64
108 #define _IOS_BIN        128
109
110 /* Magic numbers and bits for the _flags field.
111    The magic numbers use the high-order bits of _flags;
112    the remaining bits are available for variable flags.
113    Note: The magic numbers must all be negative if stdio
114    emulation is desired. */
115
116 #define _IO_MAGIC 0xFBAD0000 /* Magic number */
117 #define _OLD_STDIO_MAGIC 0xFABC0000 /* Emulate old stdio. */
118 #define _IO_MAGIC_MASK 0xFFFF0000
119 #define _IO_USER_BUF 1 /* User owns buffer; don't delete it on close. */
120 #define _IO_UNBUFFERED 2
121 #define _IO_NO_READS 4 /* Reading not allowed */
122 #define _IO_NO_WRITES 8 /* Writing not allowd */
123 #define _IO_EOF_SEEN 0x10
124 #define _IO_ERR_SEEN 0x20
125 #define _IO_DELETE_DONT_CLOSE 0x40 /* Don't call close(_fileno) on cleanup. */
126 #define _IO_LINKED 0x80 /* Set if linked (using _chain) to streambuf::_list_all.*/
127 #define _IO_IN_BACKUP 0x100
128 #define _IO_LINE_BUF 0x200
129 #define _IO_TIED_PUT_GET 0x400 /* Set if put and get pointer logicly tied. */
130 #define _IO_CURRENTLY_PUTTING 0x800
131 #define _IO_IS_APPENDING 0x1000
132 #define _IO_IS_FILEBUF 0x2000
133 #define _IO_BAD_SEEN 0x4000
134
135 /* These are "formatting flags" matching the iostream fmtflags enum values. */
136 #define _IO_SKIPWS 01
137 #define _IO_LEFT 02
138 #define _IO_RIGHT 04
139 #define _IO_INTERNAL 010
140 #define _IO_DEC 020
141 #define _IO_OCT 040
142 #define _IO_HEX 0100
143 #define _IO_SHOWBASE 0200
144 #define _IO_SHOWPOINT 0400
145 #define _IO_UPPERCASE 01000
146 #define _IO_SHOWPOS 02000
147 #define _IO_SCIENTIFIC 04000
148 #define _IO_FIXED 010000
149 #define _IO_UNITBUF 020000
150 #define _IO_STDIO 040000
151 #define _IO_DONT_CLOSE 0100000
152 #define _IO_BOOLALPHA 0200000
153
154
155 struct _IO_jump_t;  struct _IO_FILE;
156
157 /* Handle lock.  */
158 #ifdef _IO_MTSAFE_IO
159 # include <bits/stdio-lock.h>
160 #else
161 typedef void _IO_lock_t;
162 #endif
163
164
165 /* A streammarker remembers a position in a buffer. */
166
167 struct _IO_marker {
168   struct _IO_marker *_next;
169   struct _IO_FILE *_sbuf;
170   /* If _pos >= 0
171  it points to _buf->Gbase()+_pos. FIXME comment */
172   /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
173   int _pos;
174 #if 0
175     void set_streampos(streampos sp) { _spos = sp; }
176     void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
177   public:
178     streammarker(streambuf *sb);
179     ~streammarker();
180     int saving() { return  _spos == -2; }
181     int delta(streammarker&);
182     int delta();
183 #endif
184 };
185
186 struct _IO_FILE {
187   int _flags;           /* High-order word is _IO_MAGIC; rest is flags. */
188 #define _IO_file_flags _flags
189
190   /* The following pointers correspond to the C++ streambuf protocol. */
191   /* Note:  Tk uses the _IO_read_ptr and _IO_read_end fields directly. */
192   char* _IO_read_ptr;   /* Current read pointer */
193   char* _IO_read_end;   /* End of get area. */
194   char* _IO_read_base;  /* Start of putback+get area. */
195   char* _IO_write_base; /* Start of put area. */
196   char* _IO_write_ptr;  /* Current put pointer. */
197   char* _IO_write_end;  /* End of put area. */
198   char* _IO_buf_base;   /* Start of reserve area. */
199   char* _IO_buf_end;    /* End of reserve area. */
200   /* The following fields are used to support backing up and undo. */
201   char *_IO_save_base; /* Pointer to start of non-current get area. */
202   char *_IO_backup_base;  /* Pointer to first valid character of backup area */
203   char *_IO_save_end; /* Pointer to end of non-current get area. */
204
205   struct _IO_marker *_markers;
206
207   struct _IO_FILE *_chain;
208
209   int _fileno;
210   int _blksize;
211   _IO_off_t _offset;
212
213 #define __HAVE_COLUMN /* temporary */
214   /* 1+column number of pbase(); 0 is unknown. */
215   unsigned short _cur_column;
216   char _unused;
217   char _shortbuf[1];
218
219   /*  char* _save_gptr;  char* _save_egptr; */
220
221   _IO_lock_t *_lock;
222 };
223
224 #ifndef __cplusplus
225 typedef struct _IO_FILE _IO_FILE;
226 #endif
227
228 struct _IO_FILE_plus;
229 extern struct _IO_FILE_plus _IO_stdin_, _IO_stdout_, _IO_stderr_;
230 #define _IO_stdin ((_IO_FILE*)(&_IO_stdin_))
231 #define _IO_stdout ((_IO_FILE*)(&_IO_stdout_))
232 #define _IO_stderr ((_IO_FILE*)(&_IO_stderr_))
233
234
235 /* Define the user-visible type, with user-friendly member names.  */
236 typedef struct
237 {
238   _IO_ssize_t (*read) __P ((struct _IO_FILE *, void *, _IO_ssize_t));
239   _IO_ssize_t (*write) __P ((struct _IO_FILE *, const void *, _IO_ssize_t));
240   _IO_fpos_t (*seek) __P ((struct _IO_FILE *, _IO_off_t, int));
241   int (*close) __P ((struct _IO_FILE *));
242 } _IO_cookie_io_functions_t;
243
244 /* Special file type for fopencookie function.  */
245 struct _IO_cookie_file
246 {
247   struct _IO_FILE file;
248   const void *vtable;
249   void *cookie;
250   _IO_cookie_io_functions_t io_functions;
251 };
252
253
254 #ifdef __cplusplus
255 extern "C" {
256 #endif
257
258 extern int __underflow __P ((_IO_FILE *));
259 extern int __uflow __P ((_IO_FILE *));
260 extern int __overflow __P ((_IO_FILE *, int));
261
262 #define _IO_getc_unlocked(_fp) \
263        ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end ? __uflow (_fp) \
264         : *(unsigned char *) (_fp)->_IO_read_ptr++)
265 #define _IO_peekc_unlocked(_fp) \
266        ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end \
267           && __underflow (_fp) == EOF ? EOF \
268         : *(unsigned char *) (_fp)->_IO_read_ptr)
269
270 #define _IO_putc_unlocked(_ch, _fp) \
271    (((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end) \
272     ? __overflow (_fp, (unsigned char) (_ch)) \
273     : (unsigned char) (*(_fp)->_IO_write_ptr++ = (_ch)))
274
275 #define _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
276 #define _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)
277
278 extern int _IO_getc __P ((_IO_FILE *__fp));
279 extern int _IO_putc __P ((int __c, _IO_FILE *__fp));
280 extern int _IO_feof __P ((_IO_FILE *__fp));
281 extern int _IO_ferror __P ((_IO_FILE *__fp));
282
283 extern int _IO_peekc_locked __P ((_IO_FILE *__fp));
284
285 /* This one is for Emacs. */
286 #define _IO_PENDING_OUTPUT_COUNT(_fp)   \
287         ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
288
289 extern void _IO_flockfile __P ((_IO_FILE *));
290 extern void _IO_funlockfile __P ((_IO_FILE *));
291 extern int _IO_ftrylockfile __P ((_IO_FILE *));
292
293 #ifndef _IO_MTSAFE_IO
294 # define _IO_flockfile(_fp) /**/
295 # define _IO_funlockfile(_fp) /**/
296 # define _IO_ftrylockfile(_fp) /**/
297 # define _IO_cleanup_region_start(_fct, _fp) /**/
298 # define _IO_cleanup_region_end(_Doit) /**/
299 #endif /* !_IO_MTSAFE_IO */
300
301 #define _IO_peekc(_fp) _IO_peekc_locked (_fp)
302
303 extern int _IO_vfscanf __P ((_IO_FILE *, const char *, _IO_va_list, int *));
304 extern int _IO_vfprintf __P ((_IO_FILE *, const char *, _IO_va_list));
305 extern _IO_ssize_t _IO_padn __P ((_IO_FILE *, int, _IO_ssize_t));
306 extern _IO_size_t _IO_sgetn __P ((_IO_FILE *, void *, _IO_size_t));
307
308 extern _IO_fpos_t _IO_seekoff __P ((_IO_FILE *, _IO_off_t, int, int));
309 extern _IO_fpos_t _IO_seekpos __P ((_IO_FILE *, _IO_fpos_t, int));
310
311 extern void _IO_free_backup_area __P ((_IO_FILE *));
312
313 #ifdef __cplusplus
314 }
315 #endif
316
317 #endif /* _IO_STDIO_H */