compiler/stdc/fgets.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     C99 function fgets().
   6 */
   7 #include <proto/dos.h>
   8 #include <errno.h>
   9
  10 #include "__stdio.h"
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15 #include <stdio.h>
  16
  17         char * fgets (
  18
  19 /*  SYNOPSIS */
  20         char * buffer,
  21         int    size,
  22         FILE * stream)
  23
  24 /*  FUNCTION
  25         Read one line of characters from the stream into the buffer.
  26         Reading will stop, when a newline ('\n') is encountered, EOF
  27         or when the buffer is full. If a newline is read, then it is
  28         put into the buffer. The last character in the buffer is always
  29         '\0' (Therefore at most size-1 characters can be read in one go).
  30
  31     INPUTS
  32         buffer - Write characters into this buffer
  33         size - This is the size of the buffer in characters.
  34         stream - Read from this stream
  35
  36     RESULT
  37         buffer or NULL in case of an error or EOF.
  38
  39     NOTES
  40
  41     EXAMPLE
  42         // Read a file line by line
  43         char line[256];
  44
  45         // Read until EOF
  46         while (fgets (line, sizeof (line), fh))
  47         {
  48             // Evaluate the line
  49         }
  50
  51     BUGS
  52
  53     SEE ALSO
  54         fopen(), gets(), fputs(), putc()
  55
  56     INTERNALS
  57
  58 ******************************************************************************/
  59 {
  60     if (!(stream->flags & __STDCIO_STDIO_READ))
  61     {
  62         SetIoErr(ERROR_READ_PROTECTED);
  63         errno = EACCES;
  64         stream->flags |= __STDCIO_STDIO_ERROR;
  65         return NULL;
  66     }
  67
  68     buffer = FGets (stream->fh, buffer, size);
  69
  70     if (!buffer)
  71     {
  72         LONG ioerr = IoErr();
  73
  74         if (ioerr)
  75         {
  76             errno = __stdc_ioerr2errno(ioerr);
  77             stream->flags |= __STDCIO_STDIO_ERROR;
  78         }
  79         else
  80         {
  81             stream->flags |= __STDCIO_STDIO_EOF;
  82         }
  83     }
  84
  85     return buffer;
  86 } /* fgets */