Formerly stdio/stdio.h.~31~
[kopensolaris-gnu/glibc.git] / stdio / stdio.h
1 /* Copyright (C) 1991, 1992 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
8
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB.  If
16 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
17 Cambridge, MA 02139, USA.  */
18
19 /*
20  *      ANSI Standard: 4.9 INPUT/OUTPUT <stdio.h>
21  */
22
23 #ifndef _STDIO_H
24
25 #if     !defined(__need_FILE)
26 #define _STDIO_H        1
27 #include <features.h>
28
29 #define __need_size_t
30 #define __need_NULL
31 #include <stddef.h>
32
33 #include <gnu/types.h>
34 #endif  /* Don't need FILE.  */
35 #undef  __need_FILE
36
37
38 #ifndef __FILE_defined
39
40 /* The opaque type of streams.  */
41 typedef struct __stdio_file FILE;
42
43 #define __FILE_defined  1
44 #endif  /* FILE not defined.  */
45
46
47 #ifdef  _STDIO_H
48
49 /* The type of the second argument to `fgetpos' and `fsetpos'.  */
50 typedef __off_t fpos_t;
51
52 /* The mode of I/O, as given in the MODE argument to fopen, etc.  */
53 typedef struct
54   {
55     unsigned int __read:1;      /* Open for reading.  */
56     unsigned int __write:1;     /* Open for writing.  */
57     unsigned int __append:1;    /* Open for appending.  */
58     unsigned int __binary:1;    /* Opened binary.  */
59     unsigned int __create:1;    /* Create the file.  */
60     unsigned int __exclusive:1; /* Error if it already exists.  */
61     unsigned int __truncate:1;  /* Truncate the file on opening.  */
62   } __io_mode;
63
64
65 /* Functions to do I/O and file management for a stream.  */
66
67 typedef __ssize_t EXFUN(__io_read, (PTR __cookie, char *__buf,
68                                     size_t __nbytes));
69 typedef __ssize_t EXFUN(__io_write, (PTR __cookie, CONST char *__buf,
70                                      size_t __n));
71 typedef int EXFUN(__io_seek, (PTR __cookie, fpos_t *__pos, int __w));
72 typedef int EXFUN(__io_close, (PTR __cookie));
73
74 /* Low level interface, independent of FILE representation.  */
75 typedef struct
76   {
77     __io_read *__read;          /* Read bytes.  */
78     __io_write *__write;        /* Write bytes.  */
79     __io_seek *__seek;          /* Seek/tell file position.  */
80     __io_close *__close;        /* Close file.  */
81   } __io_functions;
82
83 /* Higher level interface, dependent on FILE representation.  */
84 typedef struct
85   {
86     /* Make room in the input buffer.  */
87     int EXFUN((*__input), (FILE *__stream));
88     /* Make room in the output buffer.  */
89     void EXFUN((*__output), (FILE *__stream, int __c));
90   } __room_functions;
91
92 extern CONST __io_functions __default_io_functions;
93 extern CONST __room_functions __default_room_functions;
94
95
96 /* Default close function.  */
97 extern __io_close __stdio_close;
98 /* Open FILE with mode M, return cookie or NULL to use an int in *DP.  */
99 extern PTR EXFUN(__stdio_open, (CONST char *__file, __io_mode __m, int *__dp));
100 /* Put out an error message for when stdio needs to die.  */
101 extern void EXFUN(__stdio_errmsg, (CONST char *__msg, size_t __len));
102 /* Generate a unique file name.  */
103 extern char *EXFUN(__stdio_gen_tempname, (CONST char *__dir, CONST char *__pfx,
104                                           int __dir_search, size_t *__lenptr));
105
106 #ifndef __NORETURN
107 #ifdef  __GNUC__
108 #define __NORETURN      __volatile
109 #else   /* Not GCC.  */
110 #define __NORETURN
111 #endif  /* GCC.  */
112 #endif  /* __NORETURN not defined.  */
113
114 /* Print out MESSAGE on the error output and abort.  */
115 extern __NORETURN void EXFUN(__libc_fatal, (CONST char *__message));
116
117
118 /* The FILE structure.  */
119 struct __stdio_file
120   {
121     /* Magic number for validation.  Must be negative in open streams
122        for the glue to Unix stdio getc/putc to work.  */
123     int __magic;
124 #define _IOMAGIC        0xfedabeeb      /* Magic number to fill `__magic'.  */
125 #define _GLUEMAGIC      0xfeedbabe      /* Magic for glued Unix streams.  */
126
127     char *__bufp;                       /* Pointer into the buffer.  */
128     char *__get_limit;                  /* Reading limit.  */
129     char *__put_limit;                  /* Writing limit.  */
130     char *__buffer;                     /* Base of buffer.  */
131     size_t __bufsize;                   /* Size of the buffer.  */
132     FILE *__next;                       /* Next FILE in the linked list.  */
133     PTR __cookie;                       /* Magic cookie.  */
134     int __fileno;                       /* System file descriptor.  */
135     unsigned char __pushback;           /* Pushed-back character.  */
136     char *__pushback_bufp;              /* Old bufp if char pushed back.  */
137     unsigned int __pushed_back:1;       /* A char has been pushed back.  */
138     unsigned int __eof:1;               /* End of file encountered.  */
139     unsigned int __error:1;             /* Error encountered.  */
140     unsigned int __userbuf:1;           /* Buffer is from user.  */
141     unsigned int __linebuf:1;           /* Flush on newline.  */
142     unsigned int __seen:1;              /* This stream has been seen.  */
143     unsigned int __ispipe:1;            /* Nonzero if opened by popen.  */
144     __io_mode __mode;                   /* File access mode.  */
145     __io_functions __io_funcs;          /* I/O functions.  */
146     __room_functions __room_funcs;      /* I/O buffer room functions.  */
147     fpos_t __offset;                    /* Current file position.  */
148     fpos_t __target;                    /* Target file position.  */
149   };
150
151
152 /* All macros used internally by other macros here and by stdio functions begin
153    with `__'.  All of these may evaluate their arguments more than once.  */
154
155
156 /* Nonzero if STREAM is a valid stream.  */
157 #define __validfp(stream)                                                     \
158   (stream != NULL && ((stream->__magic == _GLUEMAGIC &&                       \
159                        (stream = (FILE *) &((int *) stream)[1])),             \
160                       (stream->__magic == _IOMAGIC)))                         \
161
162 /* Clear the error and EOF indicators of STREAM.  */
163 #define __clearerr(stream)      ((stream)->__error = (stream)->__eof = 0)
164
165 /* Nuke STREAM, making it unusable but available for reuse.  */
166 extern void EXFUN(__invalidate, (FILE *__stream));
167
168 /* Make sure STREAM->__offset and STREAM->__target are initialized.
169    Returns 0 if successful, or EOF on
170    error (but doesn't set STREAM->__error).  */
171 extern int EXFUN(__stdio_check_offset, (FILE *__stream));
172
173
174 /* The possibilities for the third argument to `setvbuf'.  */
175 #define _IOFBF  0x1     /* Full buffering.  */
176 #define _IOLBF  0x2     /* Line buffering.  */
177 #define _IONBF  0x4     /* No buffering.  */
178
179
180 /* Default buffer size.  */
181 #define BUFSIZ  1024
182
183
184 /* End of file character.
185    Some things throughout the library rely on this being -1.  */
186 #define EOF     (-1)
187
188
189 /* The possibilities for the third argument to `fseek'.
190    These values should not be changed.  */
191 #define SEEK_SET        0       /* Seek from beginning of file.  */
192 #define SEEK_CUR        1       /* Seek from current position.  */
193 #define SEEK_END        2       /* Seek from end of file.  */
194
195
196 #ifdef  __USE_SVID
197 /* Default path prefix for `tempnam' and `tmpnam'.  */
198 #define P_tmpdir        "/usr/tmp"
199 #endif
200
201
202 /* Get the values:
203    L_tmpnam     How long an array of chars must be to be passed to `tmpnam'.
204    TMP_MAX      The minimum number of unique filenames generated by tmpnam
205                 (and tempnam when it uses tmpnam's name space),
206                 or tempnam (the two are separate).
207    L_ctermid    How long an array to pass to `ctermid'.
208    L_cuserid    How long an array to pass to `cuserid'.
209    FOPEN_MAX    Mininum number of files that can be open at once.
210    FILENAME_MAX Maximum length of a filename.  */
211 #include <stdio_lim.h>
212
213
214 /* All the known streams are in a linked list
215    linked by the `next' field of the FILE structure.  */
216 extern FILE *__stdio_head;      /* Head of the list.  */
217
218 /* Standard streams.  */
219 extern FILE *stdin, *stdout, *stderr;
220
221
222 /* Remove file FILENAME.  */
223 extern int EXFUN(remove, (CONST char *__filename));
224 /* Rename file OLD to NEW.  */
225 extern int EXFUN(rename, (CONST char *__old, CONST char *__new));
226
227
228 /* Create a temporary file and open it read/write.  */
229 extern FILE *EXFUN(tmpfile, (NOARGS));
230 /* Generate a temporary filename.  */
231 extern char *EXFUN(tmpnam, (char *__s));
232
233
234 #ifdef  __USE_SVID
235 /* Generate a unique temporary filename using up to five characters of PFX
236    if it is not NULL.  The directory to put this file in is searched for
237    as follows: First the environment variable "TMPDIR" is checked.
238    If it contains the name of a writable directory, that directory is used.
239    If not and if DIR is not NULL, that value is checked.  If that fails,
240    P_tmpdir is tried and finally "/tmp".  The storage for the filename
241    is allocated by `malloc'.  */
242 extern char *EXFUN(tempnam, (CONST char *__dir, CONST char *__pfx));
243 #endif
244
245
246 /* This performs actual output when necessary, flushing
247    STREAM's buffer and optionally writing another character.  */
248 extern int EXFUN(__flshfp, (FILE *__stream, int __c));
249
250
251 /* Close STREAM, or all streams if STREAM is NULL.  */
252 extern int EXFUN(fclose, (FILE *__stream));
253 /* Flush STREAM, or all streams if STREAM is NULL.  */
254 extern int EXFUN(fflush, (FILE *__stream));
255
256
257 /* Open a file and create a new stream for it.  */
258 extern FILE *EXFUN(fopen, (CONST char *__filename, CONST char *__modes));
259 /* Open a file, replacing an existing stream with it. */
260 extern FILE *EXFUN(freopen, (CONST char *__filename,
261                              CONST char *__modes, FILE *__stream));
262
263 /* Return a new, zeroed, stream.
264    You must set its cookie and io_mode.
265    The first operation will give it a buffer unless you do.
266    It will also give it the default functions unless you set the `seen' flag.
267    The offset is set to -1, meaning it will be determined by doing a
268    stationary seek.  You can set it to avoid the initial tell call.
269    The target is set to -1, meaning it will be set to the offset
270    before the target is needed.
271    Returns NULL if a stream can't be created.  */
272 extern FILE *EXFUN(__newstream, (NOARGS));
273
274 #ifdef  __USE_POSIX
275 /* Create a new stream that refers to an existing system file descriptor.  */
276 extern FILE *EXFUN(fdopen, (int __fd, CONST char *__modes));
277 #endif
278
279 #ifdef  __USE_GNU
280 /* Create a new stream that refers to the given magic cookie,
281    and uses the given functions for input and output.  */
282 extern FILE *EXFUN(fopencookie, (PTR __magic_cookie, CONST char *__modes,
283                                  __io_functions __io_functions));
284
285 /* Create a new stream that refers to a memory buffer.  */
286 extern FILE *EXFUN(fmemopen, (PTR __s, size_t __len, CONST char *__modes));
287
288 /* Open a stream that writes into a malloc'd buffer that is expanded as
289    necessary.  *BUFLOC and *SIZELOC are updated with the buffer's location
290    and the number of characters written on fflush or fclose.  */
291 extern FILE *EXFUN(open_memstream, (char **__bufloc, size_t *sizeloc));
292 #endif
293
294
295 /* If BUF is NULL, make STREAM unbuffered.
296    Else make it use buffer BUF, of size BUFSIZ.  */
297 extern void EXFUN(setbuf, (FILE *__stream, char *__buf));
298 /* Make STREAM use buffering mode MODE.
299    If BUF is not NULL, use N bytes of it for buffering;
300    else allocate an internal buffer N bytes long.  */
301 extern int EXFUN(setvbuf, (FILE *__stream, char *__buf,
302                            int __modes, size_t __n));
303
304 #ifdef  __USE_BSD
305 /* If BUF is NULL, make STREAM unbuffered.
306    Else make it use SIZE bytes of BUF for buffering.  */
307 extern void     EXFUN(setbuffer, (FILE *__stream, char *__buf, size_t __size));
308
309 /* Make STREAM line-buffered.  */
310 extern void EXFUN(setlinebuf, (FILE *__stream));
311 #endif
312
313
314 /* Write formatted output to STREAM.  */
315 extern int EXFUN(fprintf, (FILE *__stream, CONST char *__format, ...));
316 /* Write formatted output to stdout.  */
317 extern int EXFUN(printf, (CONST char *__format, ...));
318 /* Write formatted output to S.  */
319 extern int EXFUN(sprintf, (char *__s, CONST char *__format, ...));
320
321 /* Write formatted output to S from argument list ARG.  */
322 extern int EXFUN(vfprintf, (FILE *__s, CONST char *__format, PTR __arg));
323 /* Write formatted output to stdout from argument list ARG.  */
324 extern int EXFUN(vprintf, (CONST char *__format, PTR __arg));
325 /* Write formatted output to S from argument list ARG.  */
326 extern int EXFUN(vsprintf, (char *__s, CONST char *__format, PTR __arg));
327
328 #ifdef  __OPTIMIZE__
329 #define vprintf(fmt, arg)               vfprintf(stdout, (fmt), (arg))
330 #endif  /* Optimizing.  */
331
332 #ifdef  __USE_GNU
333 /* Maximum chars of output to write in MAXLEN.  */
334 extern int EXFUN(snprintf, (char *__s, size_t __maxlen,
335                             CONST char *__format, ...));
336
337 extern int EXFUN(vsnprintf, (char *__s, size_t __maxlen,
338                              CONST char *__format, PTR __arg));
339
340 /* Write formatted output to a string dynamically allocated with `malloc'.
341    Store the address of the string in *PTR.  */
342 extern int EXFUN(vasprintf, (char **__ptr, CONST char *__f, PTR __arg));
343 extern int EXFUN(asprintf, (char **__ptr, CONST char *__fmt, ...));
344
345 /* Write formatted output to a file descriptor.  */
346 extern int EXFUN(vdprintf, (int __fd, CONST char *__fmt, PTR __arg));
347 extern int EXFUN(dprintf, (int __fd, CONST char *__fmt, ...));
348 #endif
349
350
351 /* Read formatted input from STREAM.  */
352 extern int EXFUN(fscanf, (FILE *__stream, CONST char *__format, ...));
353 /* Read formatted input from stdin.  */
354 extern int EXFUN(scanf, (CONST char *__format, ...));
355 /* Read formatted input from S.  */
356 extern int EXFUN(sscanf, (CONST char *__s, CONST char *__format, ...));
357
358 #ifdef  __USE_GNU
359 /* Read formatted input from S into argument list ARG.  */
360 extern int EXFUN(__vfscanf, (FILE *__s, CONST char *__format,
361                              PTR __arg));
362 extern int EXFUN(vfscanf, (FILE *__s, CONST char *__format,
363                            PTR __arg));
364
365 /* Read formatted input from stdin into argument list ARG.  */
366 extern int EXFUN(vscanf, (CONST char *__format, PTR __arg));
367
368 /* Read formatted input from S into argument list ARG.  */
369 extern int EXFUN(__vsscanf, (CONST char *__s, CONST char *__format,
370                              PTR __arg));
371 extern int EXFUN(vsscanf, (CONST char *__s, CONST char *__format,
372                            PTR __arg));
373
374
375 #ifdef  __OPTIMIZE__
376 #define vfscanf(s, format, arg) __vfscanf((s), (format), (arg))
377 #define vscanf(format, arg)     __vfscanf(stdin, (format), (arg))
378 #define vsscanf(s, format, arg) __vsscanf((s), (format), (arg))
379 #endif  /* Optimizing.  */
380 #endif  /* Use GNU.  */
381
382
383 /* This does actual reading when necessary, filling STREAM's
384    buffer and returning the first character in it.  */
385 extern int EXFUN(__fillbf, (FILE *__stream));
386
387
388 /* Read a character from STREAM.  */
389 extern int EXFUN(fgetc, (FILE *__stream));
390 extern int EXFUN(getc, (FILE *__stream));
391
392 /* Read a character from stdin.  */
393 extern int EXFUN(getchar, (NOARGS));
394
395 /* The C standard explicitly says this can
396    re-evaluate its argument, so it does. */
397 #define __getc(stream)                                                        \
398   ((stream)->__bufp < (stream)->__get_limit ?                                 \
399    (int) ((unsigned char) *(stream)->__bufp++) : __fillbf(stream))
400
401 /* The C standard explicitly says this is a macro,
402    so we always do the optimization for it.  */
403 #define getc(stream)    __getc(stream)
404
405 #ifdef  __OPTIMIZE__
406 #define getchar()       __getc(stdin)
407 #endif  /* Optimizing.  */
408
409
410 /* Write a character to STREAM.  */
411 extern int EXFUN(fputc, (int __c, FILE *__stream));
412 extern int EXFUN(putc, (int __c, FILE *__stream));
413
414 /* Write a character to stdout.  */
415 extern int EXFUN(putchar, (int __c));
416
417 /* The C standard explicitly says this can
418    re-evaluate its arguments, so it does.  */
419 #define __putc(c, stream)                                                     \
420   ((stream)->__bufp < (stream)->__put_limit ?                                 \
421    (int) (unsigned char) (*(stream)->__bufp++ = (unsigned char) (c)) :        \
422    ((stream)->__linebuf && (c) != '\n' &&                                     \
423     (stream)->__bufp - (stream)->__buffer < (stream)->__bufsize) ?            \
424    (*(stream)->__bufp++ = (unsigned char) (c)) :                              \
425    __flshfp((stream), (unsigned char) (c)))
426
427 /* The C standard explicitly says this can be a macro,
428    so we always do the optimization for it.  */
429 #define putc(c, stream) __putc((c), (stream))
430
431 #ifdef  __OPTIMIZE__
432 #define putchar(c)      __putc((c), stdout)
433 #endif  /* Optimizing.  */
434
435
436 #if defined(__USE_SVID) || defined(__USE_MISC)
437 /* Get a word (int) from STREAM.  */
438 extern int EXFUN(getw, (FILE *__stream));
439
440 /* Write a word (int) to STREAM.  */
441 extern int EXFUN(putw, (int __w, FILE *__stream));
442 #endif
443
444
445 /* Get a newline-terminated string of finite length from STREAM.  */
446 extern char *EXFUN(fgets, (char *__s, size_t __n, FILE *__stream));
447
448 /* Get a newline-terminated string from stdin, removing the newline.
449    DO NOT USE THIS FUNCTION!!  There is no limit on how much it will read.  */
450 extern char *EXFUN(gets, (char *__s));
451
452
453 #ifdef  __USE_GNU
454 #include <sys/types.h>
455
456 /* Read up to (and including) a DELIMITER from STREAM into *LINEPTR
457    (and null-terminate it). *LINEPTR is a pointer returned from malloc (or
458    NULL), pointing to *N characters of space.  It is realloc'd as
459    necessary.  Returns the number of characters read (not including the
460    null terminator), or -1 on error or EOF.  */
461 ssize_t EXFUN(getdelim, (char **lineptr, size_t *n,
462                          int delimiter, FILE *stream));
463
464 /* Like `getdelim', but reads up to a newline.  */
465 ssize_t EXFUN(getline, (char **lineptr, size_t *n, FILE *stream));
466
467 #ifdef  __OPTIMIZE__
468 #define getline(lineptr, n, stream) getdelim ((lineptr), (n), '\n', (stream))
469 #endif  /* Optimizing.  */
470 #endif
471
472
473 /* Write a string to STREAM.  */
474 extern int EXFUN(fputs, (CONST char *__s, FILE *__stream));
475 /* Write a string, followed by a newline, to stdout.  */
476 extern int EXFUN(puts, (CONST char *__s));
477
478 #ifdef  __OPTIMIZE__
479 #define puts(s) ((fputs((s), stdout) || __putc('\n', stdout) == EOF) ? EOF : 0)
480 #endif  /* Optimizing.  */
481
482
483 /* Push a character back onto the input buffer of STREAM.  */
484 extern int EXFUN(ungetc, (int __c, FILE *__stream));
485
486
487 /* Read chunks of generic data from STREAM.  */
488 extern size_t EXFUN(fread, (PTR __ptr, size_t __size,
489                             size_t __n, FILE *__stream));
490 /* Write chunks of generic data to STREAM.  */
491 extern size_t EXFUN(fwrite, (CONST PTR __ptr, size_t __size,
492                              size_t __n, FILE *__s));
493
494
495 /* Seek to a certain position on STREAM.  */
496 extern int EXFUN(fseek, (FILE *__stream, long int __off, int __whence));
497 /* Return the current position of STREAM.  */
498 extern long int EXFUN(ftell, (FILE *__stream));
499 /* Rewind to the beginning of STREAM.  */
500 extern void EXFUN(rewind, (FILE *__stream));
501
502 /* Get STREAM's position.  */
503 extern int EXFUN(fgetpos, (FILE *__stream, fpos_t *__pos));
504 /* Set STREAM's position.  */
505 extern int EXFUN(fsetpos, (FILE *__stream, CONST fpos_t *__pos));
506
507
508 /* Clear the error and EOF indicators for STREAM.  */
509 extern void EXFUN(clearerr, (FILE *__stream));
510 /* Return the EOF indicator for STREAM.  */
511 extern int EXFUN(feof, (FILE *__stream));
512 /* Return the error indicator for STREAM.  */
513 extern int EXFUN(ferror, (FILE *__stream));
514
515 #ifdef  __OPTIMIZE__
516 #define feof(stream)    ((stream)->__eof != 0)
517 #define ferror(stream)  ((stream)->__error != 0)
518 #endif  /* Optimizing.  */
519
520
521 /* Print a message describing the meaning of the value of errno.  */
522 extern void EXFUN(perror, (CONST char *__s));
523
524 #ifdef  __USE_MISC
525 /* Print a message describing the meaning of the given signal number.  */
526 extern void EXFUN(psignal, (int __sig, CONST char *__s));
527 #endif  /* Non strict ANSI and not POSIX only.  */
528
529
530 #ifdef  __USE_POSIX
531 /* Return the system file descriptor for STREAM.  */
532 extern int EXFUN(fileno, (CONST FILE *__stream));
533
534 #ifdef  __OPTIMIZE__
535 /* The `+ 0' makes this not be an lvalue, so it can't be changed.  */
536 #define fileno(stream)  ((stream)->__fileno + 0)
537 #endif  /* Optimizing.  */
538
539 #endif  /* Use POSIX.  */
540
541
542 #if (defined (__USE_POSIX2) || defined(__USE_SVID) || defined(__USE_BSD) || \
543      defined(__USE_MISC))
544 /* Create a new stream connected to a pipe running the given command.  */
545 extern FILE *EXFUN(popen, (CONST char *__command, CONST char *__modes));
546
547 /* Close a stream opened by popen and return the status of its child.  */
548 extern int EXFUN(pclose, (FILE *__stream));
549 #endif
550
551
552 #ifdef  __USE_POSIX
553 /* Return the name of the controlling terminal.  */
554 extern char *EXFUN(ctermid, (char *__s));
555 /* Return the name of the current user.  */
556 extern char *EXFUN(cuserid, (char *__s));
557 #endif
558
559 #endif  /* <stdio.h> included.  */
560
561 #endif  /* stdio.h  */