Remove __STDC__ conditionals from installed headers.
[platform/upstream/glibc.git] / libio / libio.h
1 /* Copyright (C) 1991-1995,1997-2007,2009,2011,2012
2    Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4    Written by Per Bothner <bothner@cygnus.com>.
5
6    The GNU C Library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10
11    The GNU C Library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with the GNU C Library; if not, write to the Free
18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19    02111-1307 USA.
20
21    As a special exception, if you link the code in this file with
22    files compiled with a GNU compiler to produce an executable,
23    that does not cause the resulting executable to be covered by
24    the GNU Lesser General Public License.  This exception does not
25    however invalidate any other reasons why the executable file
26    might be covered by the GNU Lesser General Public License.
27    This exception applies to code released by its copyright holders
28    in files containing the exception.  */
29
30 #ifndef _IO_STDIO_H
31 #define _IO_STDIO_H
32
33 #include <_G_config.h>
34 /* ALL of these should be defined in _G_config.h */
35 #define _IO_pos_t _G_fpos_t /* obsolete */
36 #define _IO_fpos_t _G_fpos_t
37 #define _IO_fpos64_t _G_fpos64_t
38 #define _IO_size_t _G_size_t
39 #define _IO_ssize_t _G_ssize_t
40 #define _IO_off_t _G_off_t
41 #define _IO_off64_t _G_off64_t
42 #define _IO_pid_t _G_pid_t
43 #define _IO_uid_t _G_uid_t
44 #define _IO_iconv_t _G_iconv_t
45 #define _IO_HAVE_SYS_WAIT _G_HAVE_SYS_WAIT
46 #define _IO_HAVE_ST_BLKSIZE _G_HAVE_ST_BLKSIZE
47 #define _IO_BUFSIZ _G_BUFSIZ
48 #define _IO_va_list _G_va_list
49 #define _IO_wint_t _G_wint_t
50
51 #ifdef _G_NEED_STDARG_H
52 /* This define avoids name pollution if we're using GNU stdarg.h */
53 # define __need___va_list
54 # include <stdarg.h>
55 # ifdef __GNUC_VA_LIST
56 #  undef _IO_va_list
57 #  define _IO_va_list __gnuc_va_list
58 # endif /* __GNUC_VA_LIST */
59 #endif
60
61 #ifndef __P
62 # if _G_HAVE_SYS_CDEFS
63 #  include <sys/cdefs.h>
64 # else
65 #  define __P(p) p
66 #  define __PMT(p) p
67 # endif
68 #endif /*!__P*/
69
70 /* For backward compatibility */
71 #ifndef _PARAMS
72 # define _PARAMS(protos) __P(protos)
73 #endif /*!_PARAMS*/
74
75 #define _IO_UNIFIED_JUMPTABLES 1
76 #ifndef _G_HAVE_PRINTF_FP
77 # define _IO_USE_DTOA 1
78 #endif
79
80 #ifndef EOF
81 # define EOF (-1)
82 #endif
83 #ifndef NULL
84 # if defined __GNUG__ && \
85     (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
86 #  define NULL (__null)
87 # else
88 #  if !defined(__cplusplus)
89 #   define NULL ((void*)0)
90 #  else
91 #   define NULL (0)
92 #  endif
93 # endif
94 #endif
95
96 #define _IOS_INPUT      1
97 #define _IOS_OUTPUT     2
98 #define _IOS_ATEND      4
99 #define _IOS_APPEND     8
100 #define _IOS_TRUNC      16
101 #define _IOS_NOCREATE   32
102 #define _IOS_NOREPLACE  64
103 #define _IOS_BIN        128
104
105 /* Magic numbers and bits for the _flags field.
106    The magic numbers use the high-order bits of _flags;
107    the remaining bits are available for variable flags.
108    Note: The magic numbers must all be negative if stdio
109    emulation is desired. */
110
111 #define _IO_MAGIC 0xFBAD0000 /* Magic number */
112 #define _OLD_STDIO_MAGIC 0xFABC0000 /* Emulate old stdio. */
113 #define _IO_MAGIC_MASK 0xFFFF0000
114 #define _IO_USER_BUF 1 /* User owns buffer; don't delete it on close. */
115 #define _IO_UNBUFFERED 2
116 #define _IO_NO_READS 4 /* Reading not allowed */
117 #define _IO_NO_WRITES 8 /* Writing not allowd */
118 #define _IO_EOF_SEEN 0x10
119 #define _IO_ERR_SEEN 0x20
120 #define _IO_DELETE_DONT_CLOSE 0x40 /* Don't call close(_fileno) on cleanup. */
121 #define _IO_LINKED 0x80 /* Set if linked (using _chain) to streambuf::_list_all.*/
122 #define _IO_IN_BACKUP 0x100
123 #define _IO_LINE_BUF 0x200
124 #define _IO_TIED_PUT_GET 0x400 /* Set if put and get pointer logicly tied. */
125 #define _IO_CURRENTLY_PUTTING 0x800
126 #define _IO_IS_APPENDING 0x1000
127 #define _IO_IS_FILEBUF 0x2000
128 #define _IO_BAD_SEEN 0x4000
129 #define _IO_USER_LOCK 0x8000
130
131 #define _IO_FLAGS2_MMAP 1
132 #define _IO_FLAGS2_NOTCANCEL 2
133 #ifdef _LIBC
134 # define _IO_FLAGS2_FORTIFY 4
135 #endif
136 #define _IO_FLAGS2_USER_WBUF 8
137 #ifdef _LIBC
138 # define _IO_FLAGS2_SCANF_STD 16
139 # define _IO_FLAGS2_NOCLOSE 32
140 # define _IO_FLAGS2_CLOEXEC 64
141 #endif
142
143 /* These are "formatting flags" matching the iostream fmtflags enum values. */
144 #define _IO_SKIPWS 01
145 #define _IO_LEFT 02
146 #define _IO_RIGHT 04
147 #define _IO_INTERNAL 010
148 #define _IO_DEC 020
149 #define _IO_OCT 040
150 #define _IO_HEX 0100
151 #define _IO_SHOWBASE 0200
152 #define _IO_SHOWPOINT 0400
153 #define _IO_UPPERCASE 01000
154 #define _IO_SHOWPOS 02000
155 #define _IO_SCIENTIFIC 04000
156 #define _IO_FIXED 010000
157 #define _IO_UNITBUF 020000
158 #define _IO_STDIO 040000
159 #define _IO_DONT_CLOSE 0100000
160 #define _IO_BOOLALPHA 0200000
161
162
163 struct _IO_jump_t;  struct _IO_FILE;
164
165 /* Handle lock.  */
166 #ifdef _IO_MTSAFE_IO
167 # if defined __GLIBC__ && __GLIBC__ >= 2
168 #  include <bits/stdio-lock.h>
169 # else
170 /*# include <comthread.h>*/
171 # endif
172 #else
173 typedef void _IO_lock_t;
174 #endif
175
176
177 /* A streammarker remembers a position in a buffer. */
178
179 struct _IO_marker {
180   struct _IO_marker *_next;
181   struct _IO_FILE *_sbuf;
182   /* If _pos >= 0
183  it points to _buf->Gbase()+_pos. FIXME comment */
184   /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
185   int _pos;
186 #if 0
187     void set_streampos(streampos sp) { _spos = sp; }
188     void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
189   public:
190     streammarker(streambuf *sb);
191     ~streammarker();
192     int saving() { return  _spos == -2; }
193     int delta(streammarker&);
194     int delta();
195 #endif
196 };
197
198 /* This is the structure from the libstdc++ codecvt class.  */
199 enum __codecvt_result
200 {
201   __codecvt_ok,
202   __codecvt_partial,
203   __codecvt_error,
204   __codecvt_noconv
205 };
206
207 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
208 /* The order of the elements in the following struct must match the order
209    of the virtual functions in the libstdc++ codecvt class.  */
210 struct _IO_codecvt
211 {
212   void (*__codecvt_destr) (struct _IO_codecvt *);
213   enum __codecvt_result (*__codecvt_do_out) (struct _IO_codecvt *,
214                                              __mbstate_t *,
215                                              const wchar_t *,
216                                              const wchar_t *,
217                                              const wchar_t **, char *,
218                                              char *, char **);
219   enum __codecvt_result (*__codecvt_do_unshift) (struct _IO_codecvt *,
220                                                  __mbstate_t *, char *,
221                                                  char *, char **);
222   enum __codecvt_result (*__codecvt_do_in) (struct _IO_codecvt *,
223                                             __mbstate_t *,
224                                             const char *, const char *,
225                                             const char **, wchar_t *,
226                                             wchar_t *, wchar_t **);
227   int (*__codecvt_do_encoding) (struct _IO_codecvt *);
228   int (*__codecvt_do_always_noconv) (struct _IO_codecvt *);
229   int (*__codecvt_do_length) (struct _IO_codecvt *, __mbstate_t *,
230                               const char *, const char *, _IO_size_t);
231   int (*__codecvt_do_max_length) (struct _IO_codecvt *);
232
233   _IO_iconv_t __cd_in;
234   _IO_iconv_t __cd_out;
235 };
236
237 /* Extra data for wide character streams.  */
238 struct _IO_wide_data
239 {
240   wchar_t *_IO_read_ptr;        /* Current read pointer */
241   wchar_t *_IO_read_end;        /* End of get area. */
242   wchar_t *_IO_read_base;       /* Start of putback+get area. */
243   wchar_t *_IO_write_base;      /* Start of put area. */
244   wchar_t *_IO_write_ptr;       /* Current put pointer. */
245   wchar_t *_IO_write_end;       /* End of put area. */
246   wchar_t *_IO_buf_base;        /* Start of reserve area. */
247   wchar_t *_IO_buf_end;         /* End of reserve area. */
248   /* The following fields are used to support backing up and undo. */
249   wchar_t *_IO_save_base;       /* Pointer to start of non-current get area. */
250   wchar_t *_IO_backup_base;     /* Pointer to first valid character of
251                                    backup area */
252   wchar_t *_IO_save_end;        /* Pointer to end of non-current get area. */
253
254   __mbstate_t _IO_state;
255   __mbstate_t _IO_last_state;
256   struct _IO_codecvt _codecvt;
257
258   wchar_t _shortbuf[1];
259
260   const struct _IO_jump_t *_wide_vtable;
261 };
262 #endif
263
264 struct _IO_FILE {
265   int _flags;           /* High-order word is _IO_MAGIC; rest is flags. */
266 #define _IO_file_flags _flags
267
268   /* The following pointers correspond to the C++ streambuf protocol. */
269   /* Note:  Tk uses the _IO_read_ptr and _IO_read_end fields directly. */
270   char* _IO_read_ptr;   /* Current read pointer */
271   char* _IO_read_end;   /* End of get area. */
272   char* _IO_read_base;  /* Start of putback+get area. */
273   char* _IO_write_base; /* Start of put area. */
274   char* _IO_write_ptr;  /* Current put pointer. */
275   char* _IO_write_end;  /* End of put area. */
276   char* _IO_buf_base;   /* Start of reserve area. */
277   char* _IO_buf_end;    /* End of reserve area. */
278   /* The following fields are used to support backing up and undo. */
279   char *_IO_save_base; /* Pointer to start of non-current get area. */
280   char *_IO_backup_base;  /* Pointer to first valid character of backup area */
281   char *_IO_save_end; /* Pointer to end of non-current get area. */
282
283   struct _IO_marker *_markers;
284
285   struct _IO_FILE *_chain;
286
287   int _fileno;
288 #if 0
289   int _blksize;
290 #else
291   int _flags2;
292 #endif
293   _IO_off_t _old_offset; /* This used to be _offset but it's too small.  */
294
295 #define __HAVE_COLUMN /* temporary */
296   /* 1+column number of pbase(); 0 is unknown. */
297   unsigned short _cur_column;
298   signed char _vtable_offset;
299   char _shortbuf[1];
300
301   /*  char* _save_gptr;  char* _save_egptr; */
302
303   _IO_lock_t *_lock;
304 #ifdef _IO_USE_OLD_IO_FILE
305 };
306
307 struct _IO_FILE_complete
308 {
309   struct _IO_FILE _file;
310 #endif
311 #if defined _G_IO_IO_FILE_VERSION && _G_IO_IO_FILE_VERSION == 0x20001
312   _IO_off64_t _offset;
313 # if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
314   /* Wide character stream stuff.  */
315   struct _IO_codecvt *_codecvt;
316   struct _IO_wide_data *_wide_data;
317   struct _IO_FILE *_freeres_list;
318   void *_freeres_buf;
319   size_t _freeres_size;
320 # else
321   void *__pad1;
322   void *__pad2;
323   void *__pad3;
324   void *__pad4;
325   size_t __pad5;
326 # endif
327   int _mode;
328   /* Make sure we don't get into trouble again.  */
329   char _unused2[15 * sizeof (int) - 4 * sizeof (void *) - sizeof (size_t)];
330 #endif
331 };
332
333 #ifndef __cplusplus
334 typedef struct _IO_FILE _IO_FILE;
335 #endif
336
337 struct _IO_FILE_plus;
338
339 extern struct _IO_FILE_plus _IO_2_1_stdin_;
340 extern struct _IO_FILE_plus _IO_2_1_stdout_;
341 extern struct _IO_FILE_plus _IO_2_1_stderr_;
342 #ifndef _LIBC
343 #define _IO_stdin ((_IO_FILE*)(&_IO_2_1_stdin_))
344 #define _IO_stdout ((_IO_FILE*)(&_IO_2_1_stdout_))
345 #define _IO_stderr ((_IO_FILE*)(&_IO_2_1_stderr_))
346 #else
347 extern _IO_FILE *_IO_stdin attribute_hidden;
348 extern _IO_FILE *_IO_stdout attribute_hidden;
349 extern _IO_FILE *_IO_stderr attribute_hidden;
350 #endif
351
352
353 /* Functions to do I/O and file management for a stream.  */
354
355 /* Read NBYTES bytes from COOKIE into a buffer pointed to by BUF.
356    Return number of bytes read.  */
357 typedef __ssize_t __io_read_fn (void *__cookie, char *__buf, size_t __nbytes);
358
359 /* Write N bytes pointed to by BUF to COOKIE.  Write all N bytes
360    unless there is an error.  Return number of bytes written, or -1 if
361    there is an error without writing anything.  If the file has been
362    opened for append (__mode.__append set), then set the file pointer
363    to the end of the file and then do the write; if not, just write at
364    the current file pointer.  */
365 typedef __ssize_t __io_write_fn (void *__cookie, const char *__buf,
366                                  size_t __n);
367
368 /* Move COOKIE's file position to *POS bytes from the
369    beginning of the file (if W is SEEK_SET),
370    the current position (if W is SEEK_CUR),
371    or the end of the file (if W is SEEK_END).
372    Set *POS to the new file position.
373    Returns zero if successful, nonzero if not.  */
374 typedef int __io_seek_fn (void *__cookie, _IO_off64_t *__pos, int __w);
375
376 /* Close COOKIE.  */
377 typedef int __io_close_fn (void *__cookie);
378
379
380 #ifdef _GNU_SOURCE
381 /* User-visible names for the above.  */
382 typedef __io_read_fn cookie_read_function_t;
383 typedef __io_write_fn cookie_write_function_t;
384 typedef __io_seek_fn cookie_seek_function_t;
385 typedef __io_close_fn cookie_close_function_t;
386
387 /* The structure with the cookie function pointers.  */
388 typedef struct
389 {
390   __io_read_fn *read;           /* Read bytes.  */
391   __io_write_fn *write;         /* Write bytes.  */
392   __io_seek_fn *seek;           /* Seek/tell file position.  */
393   __io_close_fn *close;         /* Close file.  */
394 } _IO_cookie_io_functions_t;
395 typedef _IO_cookie_io_functions_t cookie_io_functions_t;
396
397 struct _IO_cookie_file;
398
399 /* Initialize one of those.  */
400 extern void _IO_cookie_init (struct _IO_cookie_file *__cfile, int __read_write,
401                              void *__cookie, _IO_cookie_io_functions_t __fns);
402 #endif
403
404
405 #ifdef __cplusplus
406 extern "C" {
407 #endif
408
409 extern int __underflow (_IO_FILE *);
410 extern int __uflow (_IO_FILE *);
411 extern int __overflow (_IO_FILE *, int);
412 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
413 extern _IO_wint_t __wunderflow (_IO_FILE *);
414 extern _IO_wint_t __wuflow (_IO_FILE *);
415 extern _IO_wint_t __woverflow (_IO_FILE *, _IO_wint_t);
416 #endif
417
418 #if  __GNUC__ >= 3
419 # define _IO_BE(expr, res) __builtin_expect ((expr), res)
420 #else
421 # define _IO_BE(expr, res) (expr)
422 #endif
423
424 #define _IO_getc_unlocked(_fp) \
425        (_IO_BE ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end, 0) \
426         ? __uflow (_fp) : *(unsigned char *) (_fp)->_IO_read_ptr++)
427 #define _IO_peekc_unlocked(_fp) \
428        (_IO_BE ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end, 0) \
429           && __underflow (_fp) == EOF ? EOF \
430         : *(unsigned char *) (_fp)->_IO_read_ptr)
431 #define _IO_putc_unlocked(_ch, _fp) \
432    (_IO_BE ((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end, 0) \
433     ? __overflow (_fp, (unsigned char) (_ch)) \
434     : (unsigned char) (*(_fp)->_IO_write_ptr++ = (_ch)))
435
436 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
437 # define _IO_getwc_unlocked(_fp) \
438   (_IO_BE ((_fp)->_wide_data == NULL                                    \
439            || ((_fp)->_wide_data->_IO_read_ptr                          \
440                >= (_fp)->_wide_data->_IO_read_end), 0)                  \
441    ? __wuflow (_fp) : (_IO_wint_t) *(_fp)->_wide_data->_IO_read_ptr++)
442 # define _IO_putwc_unlocked(_wch, _fp) \
443   (_IO_BE ((_fp)->_wide_data == NULL                                    \
444            || ((_fp)->_wide_data->_IO_write_ptr                         \
445                >= (_fp)->_wide_data->_IO_write_end), 0)                 \
446    ? __woverflow (_fp, _wch)                                            \
447    : (_IO_wint_t) (*(_fp)->_wide_data->_IO_write_ptr++ = (_wch)))
448 #endif
449
450 #define _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
451 #define _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)
452
453 extern int _IO_getc (_IO_FILE *__fp);
454 extern int _IO_putc (int __c, _IO_FILE *__fp);
455 extern int _IO_feof (_IO_FILE *__fp) __THROW;
456 extern int _IO_ferror (_IO_FILE *__fp) __THROW;
457
458 extern int _IO_peekc_locked (_IO_FILE *__fp);
459
460 /* This one is for Emacs. */
461 #define _IO_PENDING_OUTPUT_COUNT(_fp)   \
462         ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
463
464 extern void _IO_flockfile (_IO_FILE *) __THROW;
465 extern void _IO_funlockfile (_IO_FILE *) __THROW;
466 extern int _IO_ftrylockfile (_IO_FILE *) __THROW;
467
468 #ifdef _IO_MTSAFE_IO
469 # define _IO_peekc(_fp) _IO_peekc_locked (_fp)
470 # define _IO_flockfile(_fp) \
471   if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_flockfile (_fp)
472 # define _IO_funlockfile(_fp) \
473   if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_funlockfile (_fp)
474 #else
475 # define _IO_peekc(_fp) _IO_peekc_unlocked (_fp)
476 # define _IO_flockfile(_fp) /**/
477 # define _IO_funlockfile(_fp) /**/
478 # define _IO_ftrylockfile(_fp) /**/
479 # define _IO_cleanup_region_start(_fct, _fp) /**/
480 # define _IO_cleanup_region_end(_Doit) /**/
481 #endif /* !_IO_MTSAFE_IO */
482
483 extern int _IO_vfscanf (_IO_FILE * __restrict, const char * __restrict,
484                         _IO_va_list, int *__restrict);
485 extern int _IO_vfprintf (_IO_FILE *__restrict, const char *__restrict,
486                          _IO_va_list);
487 extern _IO_ssize_t _IO_padn (_IO_FILE *, int, _IO_ssize_t);
488 extern _IO_size_t _IO_sgetn (_IO_FILE *, void *, _IO_size_t);
489
490 extern _IO_off64_t _IO_seekoff (_IO_FILE *, _IO_off64_t, int, int);
491 extern _IO_off64_t _IO_seekpos (_IO_FILE *, _IO_off64_t, int);
492
493 extern void _IO_free_backup_area (_IO_FILE *) __THROW;
494
495 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
496 extern _IO_wint_t _IO_getwc (_IO_FILE *__fp);
497 extern _IO_wint_t _IO_putwc (wchar_t __wc, _IO_FILE *__fp);
498 extern int _IO_fwide (_IO_FILE *__fp, int __mode) __THROW;
499 # if __GNUC__ >= 2
500 /* While compiling glibc we have to handle compatibility with very old
501    versions.  */
502 #  if defined _LIBC && defined SHARED
503 #   include <shlib-compat.h>
504 #   if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1)
505 #    define _IO_fwide_maybe_incompatible \
506   (__builtin_expect (&_IO_stdin_used == NULL, 0))
507 extern const int _IO_stdin_used;
508 weak_extern (_IO_stdin_used);
509 #   endif
510 #  endif
511 #  ifndef _IO_fwide_maybe_incompatible
512 #   define _IO_fwide_maybe_incompatible (0)
513 #  endif
514 /* A special optimized version of the function above.  It optimizes the
515    case of initializing an unoriented byte stream.  */
516 #  define _IO_fwide(__fp, __mode) \
517   ({ int __result = (__mode);                                                 \
518      if (__result < 0 && ! _IO_fwide_maybe_incompatible)                      \
519        {                                                                      \
520          if ((__fp)->_mode == 0)                                              \
521            /* We know that all we have to do is to set the flag.  */          \
522            (__fp)->_mode = -1;                                                \
523          __result = (__fp)->_mode;                                            \
524        }                                                                      \
525      else if (__builtin_constant_p (__mode) && (__mode) == 0)                 \
526        __result = _IO_fwide_maybe_incompatible ? -1 : (__fp)->_mode;          \
527      else                                                                     \
528        __result = _IO_fwide (__fp, __result);                                 \
529      __result; })
530 # endif
531
532 extern int _IO_vfwscanf (_IO_FILE * __restrict, const wchar_t * __restrict,
533                          _IO_va_list, int *__restrict);
534 extern int _IO_vfwprintf (_IO_FILE *__restrict, const wchar_t *__restrict,
535                           _IO_va_list);
536 extern _IO_ssize_t _IO_wpadn (_IO_FILE *, wint_t, _IO_ssize_t);
537 extern void _IO_free_wbackup_area (_IO_FILE *) __THROW;
538 #endif
539
540 #ifdef __LDBL_COMPAT
541 # include <bits/libio-ldbl.h>
542 #endif
543
544 #ifdef __cplusplus
545 }
546 #endif
547
548 #endif /* _IO_STDIO_H */