manual: glob: document the gl_flags field
[jlayton/glibc.git] / libio / iofgets.c
1 /* Copyright (C) 1993-2013 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 Lesser General Public
6    License as published by the Free Software Foundation; either
7    version 2.1 of the 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    Lesser General Public License for more details.
13
14    You should have received a copy of the GNU Lesser General Public
15    License along with the GNU C Library; if not, see
16    <http://www.gnu.org/licenses/>.
17
18    As a special exception, if you link the code in this file with
19    files compiled with a GNU compiler to produce an executable,
20    that does not cause the resulting executable to be covered by
21    the GNU Lesser General Public License.  This exception does not
22    however invalidate any other reasons why the executable file
23    might be covered by the GNU Lesser General Public License.
24    This exception applies to code released by its copyright holders
25    in files containing the exception.  */
26
27 #include "libioP.h"
28 #include <stdio.h>
29
30 char *
31 _IO_fgets (buf, n, fp)
32      char *buf;
33      int n;
34      _IO_FILE *fp;
35 {
36   _IO_size_t count;
37   char *result;
38   int old_error;
39   CHECK_FILE (fp, NULL);
40   if (n <= 0)
41     return NULL;
42   if (__builtin_expect (n == 1, 0))
43     {
44       /* Another irregular case: since we have to store a NUL byte and
45          there is only room for exactly one byte, we don't have to
46          read anything.  */
47       buf[0] = '\0';
48       return buf;
49     }
50   _IO_acquire_lock (fp);
51   /* This is very tricky since a file descriptor may be in the
52      non-blocking mode. The error flag doesn't mean much in this
53      case. We return an error only when there is a new error. */
54   old_error = fp->_IO_file_flags & _IO_ERR_SEEN;
55   fp->_IO_file_flags &= ~_IO_ERR_SEEN;
56   count = _IO_getline (fp, buf, n - 1, '\n', 1);
57   /* If we read in some bytes and errno is EAGAIN, that error will
58      be reported for next read. */
59   if (count == 0 || ((fp->_IO_file_flags & _IO_ERR_SEEN)
60                      && errno != EAGAIN))
61     result = NULL;
62   else
63     {
64       buf[count] = '\0';
65       result = buf;
66     }
67   fp->_IO_file_flags |= old_error;
68   _IO_release_lock (fp);
69   return result;
70 }
71
72 #ifdef weak_alias
73 weak_alias (_IO_fgets, fgets)
74
75 # ifndef _IO_MTSAFE_IO
76 weak_alias (_IO_fgets, fgets_unlocked)
77 libc_hidden_weak (fgets_unlocked)
78 # endif
79 #endif