compiler/clib/fgets.c

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