Mon Jun 24 19:57:01 1996 Roland McGrath <roland@delasyd.gnu.ai.mit.edu>
[kopensolaris-gnu/glibc.git] / libio / libio.h
1 /*
2 Copyright (C) 1991, 1992, 1993, 1994, 1995 Free Software Foundation
3
4 This file is part of the GNU IO Library.  This library is free
5 software; you can redistribute it and/or modify it under the
6 terms of the GNU General Public License as published by the
7 Free Software Foundation; either version 2, or (at your option)
8 any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 GNU 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 the Free
17 Software Foundation, 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 As a special exception, if you link this library with files
20 compiled with a GNU compiler to produce an executable, this does not cause
21 the resulting executable to be covered by the GNU General Public License.
22 This exception does not however invalidate any other reasons why
23 the executable file might be covered by the GNU General Public License. */
24
25 /* This is part of the iostream library.  Written by Per Bothner. */
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_size_t _G_size_t
34 #define _IO_ssize_t _G_ssize_t
35 #define _IO_off_t _G_off_t
36 #define _IO_pid_t _G_pid_t
37 #define _IO_uid_t _G_uid_t
38 #define _IO_HAVE_SYS_WAIT _G_HAVE_SYS_WAIT
39 #define _IO_HAVE_ST_BLKSIZE _G_HAVE_ST_BLKSIZE
40 #define _IO_BUFSIZ _G_BUFSIZ
41 #define _IO_va_list _G_va_list
42
43 #ifdef _G_NEED_STDARG_H
44 /* This define avoids name pollution if we're using GNU stdarg.h */
45 #define __need___va_list
46 #include <stdarg.h>
47 #ifdef __GNUC_VA_LIST
48 #undef _IO_va_list
49 #define _IO_va_list __gnuc_va_list
50 #endif /* __GNUC_VA_LIST */
51 #endif
52
53 #ifndef __P
54 #ifdef __STDC__
55 #define __P(protos) protos
56 #else
57 #define __P(protos) ()
58 #endif
59 #endif /*!__P*/
60
61 /* For backward compatibility */
62 #ifndef _PARAMS
63 #define _PARAMS(protos) __P(protos)
64 #endif /*!_PARAMS*/
65
66 #ifndef __STDC__
67 #define const
68 #endif
69 #define _IO_UNIFIED_JUMPTABLES 1
70
71 #if 0
72 #ifdef _IO_NEED_STDARG_H
73 #include <stdarg.h>
74 #endif
75 #endif
76
77 #ifndef EOF
78 #define EOF (-1)
79 #endif
80 #ifndef NULL
81 #if !defined(__cplusplus) || defined(__GNUC__)
82 #define NULL ((void*)0)
83 #else
84 #define NULL (0)
85 #endif
86 #endif
87
88 #define _IOS_INPUT      1
89 #define _IOS_OUTPUT     2
90 #define _IOS_ATEND      4
91 #define _IOS_APPEND     8
92 #define _IOS_TRUNC      16
93 #define _IOS_NOCREATE   32
94 #define _IOS_NOREPLACE  64
95 #define _IOS_BIN        128
96
97 /* Magic numbers and bits for the _flags field.
98    The magic numbers use the high-order bits of _flags;
99    the remaining bits are abailable for variable flags.
100    Note: The magic numbers must all be negative if stdio
101    emulation is desired. */
102
103 #define _IO_MAGIC 0xFBAD0000 /* Magic number */
104 #define _OLD_STDIO_MAGIC 0xFABC0000 /* Emulate old stdio. */
105 #define _IO_MAGIC_MASK 0xFFFF0000
106 #define _IO_USER_BUF 1 /* User owns buffer; don't delete it on close. */
107 #define _IO_UNBUFFERED 2
108 #define _IO_NO_READS 4 /* Reading not allowed */
109 #define _IO_NO_WRITES 8 /* Writing not allowd */
110 #define _IO_EOF_SEEN 0x10
111 #define _IO_ERR_SEEN 0x20
112 #define _IO_DELETE_DONT_CLOSE 0x40 /* Don't call close(_fileno) on cleanup. */
113 #define _IO_LINKED 0x80 /* Set if linked (using _chain) to streambuf::_list_all.*/
114 #define _IO_IN_BACKUP 0x100
115 #define _IO_LINE_BUF 0x200
116 #define _IO_TIED_PUT_GET 0x400 /* Set if put and get pointer logicly tied. */
117 #define _IO_CURRENTLY_PUTTING 0x800
118 #define _IO_IS_APPENDING 0x1000
119 #define _IO_IS_FILEBUF 0x2000
120
121 /* These are "formatting flags" matching the iostream fmtflags enum values. */
122 #define _IO_SKIPWS 01
123 #define _IO_LEFT 02
124 #define _IO_RIGHT 04
125 #define _IO_INTERNAL 010
126 #define _IO_DEC 020
127 #define _IO_OCT 040
128 #define _IO_HEX 0100
129 #define _IO_SHOWBASE 0200
130 #define _IO_SHOWPOINT 0400
131 #define _IO_UPPERCASE 01000
132 #define _IO_SHOWPOS 02000
133 #define _IO_SCIENTIFIC 04000
134 #define _IO_FIXED 010000
135 #define _IO_UNITBUF 020000
136 #define _IO_STDIO 040000
137 #define _IO_DONT_CLOSE 0100000
138
139
140 struct _IO_jump_t;  struct _IO_FILE;
141
142 /* Define the user-visible type, with user-friendly member names.  */
143 typedef struct
144 {
145   _IO_ssize_t (*read) __P ((struct _IO_FILE *, void *, _IO_ssize_t));
146   _IO_ssize_t (*write) __P ((struct _IO_FILE *, const void *, _IO_ssize_t));
147   _IO_fpos_t (*seek) __P ((struct _IO_FILE *, _IO_off_t, int));
148   int (*close) __P ((struct _IO_FILE *));
149 } _IO_cookie_io_functions_t;
150
151 /* Handle lock.  */
152 #ifdef _IO_MTSAFE_IO
153 typedef pthread_mutex_t _IO_lock_t;
154 #else
155 typedef void _IO_lock_t;
156 #endif
157
158
159 /* A streammarker remembers a position in a buffer. */
160
161 struct _IO_marker {
162   struct _IO_marker *_next;
163   struct _IO_FILE *_sbuf;
164   /* If _pos >= 0
165  it points to _buf->Gbase()+_pos. FIXME comment */
166   /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
167   int _pos;
168 #if 0
169     void set_streampos(streampos sp) { _spos = sp; }
170     void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
171   public:
172     streammarker(streambuf *sb);
173     ~streammarker();
174     int saving() { return  _spos == -2; }
175     int delta(streammarker&);
176     int delta();
177 #endif
178 };
179
180 struct _IO_FILE {
181   int _flags;           /* High-order word is _IO_MAGIC; rest is flags. */
182 #define _IO_file_flags _flags
183
184   /* The following pointers correspond to the C++ streambuf protocol. */
185   char* _IO_read_ptr;   /* Current read pointer */
186   char* _IO_read_end;   /* End of get area. */
187   char* _IO_read_base;  /* Start of putback+get area. */
188   char* _IO_write_base; /* Start of put area. */
189   char* _IO_write_ptr;  /* Current put pointer. */
190   char* _IO_write_end;  /* End of put area. */
191   char* _IO_buf_base;   /* Start of reserve area. */
192   char* _IO_buf_end;    /* End of reserve area. */
193   /* The following fields are used to support backing up and undo. */
194   char *_IO_save_base; /* Pointer to start of non-current get area. */
195   char *_IO_backup_base;  /* Pointer to first valid character of backup area */
196   char *_IO_save_end; /* Pointer to end of non-current get area. */
197
198   struct _IO_marker *_markers;
199
200   struct _IO_FILE *_chain;
201
202 #if  !_IO_UNIFIED_JUMPTABLES
203   struct _IO_jump_t *_jumps; /* Jump table */
204 #endif
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 /* Special file type for fopencookie function.  */
233 struct _IO_cookie_file {
234   struct _IO_FILE file;
235   const void *vtable;
236   void *cookie;
237   _IO_cookie_io_functions_t io_functions;
238 };
239
240
241 #ifdef __cplusplus
242 extern "C" {
243 #endif
244
245 extern int __underflow __P((_IO_FILE*));
246 extern int __uflow __P((_IO_FILE*));
247 extern int __overflow __P((_IO_FILE*, int));
248
249 #define _IO_getc_unlocked(_fp) \
250        ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end ? __uflow(_fp) \
251         : *(unsigned char*)(_fp)->_IO_read_ptr++)
252 #define _IO_peekc_unlocked(_fp) \
253        ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end \
254           && __underflow(_fp) == EOF ? EOF \
255         : *(unsigned char*)(_fp)->_IO_read_ptr)
256
257 #define _IO_putc_unlocked(_ch, _fp) \
258    (((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end) \
259     ? __overflow(_fp, (unsigned char)(_ch)) \
260     : (unsigned char)(*(_fp)->_IO_write_ptr++ = (_ch)))
261
262 #define _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
263 #define _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)
264
265 /* This one is for Emacs. */
266 #define _IO_PENDING_OUTPUT_COUNT(_fp)   \
267         ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
268
269 extern int _IO_getc_locked __P ((_IO_FILE *));
270 extern int _IO_putc_locked __P ((int, _IO_FILE *));
271
272 extern void _IO_flockfile __P ((_IO_FILE *));
273 extern void _IO_funlockfile __P ((_IO_FILE *));
274
275 #if !defined(_REENTRANT) && !defined(_THREAD_SAFE)
276 # define _IO_flockfile(FILE) /**/
277 # define _IO_funlockfile(FILE) /**/
278 #endif /* _REENTRANT || _THREAD_SAFE */
279
280
281 extern int _IO_vfscanf __P((_IO_FILE*, const char*, _IO_va_list, int*));
282 extern int _IO_vfprintf __P((_IO_FILE*, const char*, _IO_va_list));
283 extern _IO_ssize_t _IO_padn __P((_IO_FILE *, int, _IO_ssize_t));
284 extern _IO_size_t _IO_sgetn __P((_IO_FILE *, void*, _IO_size_t));
285
286 extern void _IO_free_backup_area __P((_IO_FILE*));
287
288 #ifdef __cplusplus
289 }
290 #endif
291
292 #endif /* _IO_STDIO_H */