lib/freadseek.c

   1 /* Skipping input from a FILE stream.
   2    Copyright (C) 2007-2008 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program 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
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 #include <config.h>
  18
  19 /* Specification.  */
  20 #include "freadseek.h"
  21
  22 #include <stdlib.h>
  23 #include <unistd.h>
  24
  25 #include "freadahead.h"
  26 #include "freadptr.h"
  27
  28 #include "stdio-impl.h"
  29
  30 /* Increment the in-memory pointer.  INCREMENT must be at most the buffer size
  31    returned by freadptr().
  32    This is very cheap (no system calls).  */
  33 static inline void
  34 freadptrinc (FILE *fp, size_t increment)
  35 {
  36   /* Keep this code in sync with freadptr!  */
  37 #if defined _IO_ftrylockfile || __GNU_LIBRARY__ == 1 /* GNU libc, BeOS, Haiku, Linux libc5 */
  38   fp->_IO_read_ptr += increment;
  39 #elif defined __sferror || defined __DragonFly__ /* FreeBSD, NetBSD, OpenBSD, DragonFly, MacOS X, Cygwin */
  40   fp_->_p += increment;
  41   fp_->_r -= increment;
  42 #elif defined __EMX__               /* emx+gcc */
  43   fp->_ptr += increment;
  44   fp->_rcount -= increment;
  45 #elif defined _IOERR                /* AIX, HP-UX, IRIX, OSF/1, Solaris, OpenServer, mingw */
  46   fp_->_ptr += increment;
  47   fp_->_cnt -= increment;
  48 #elif defined __UCLIBC__            /* uClibc */
  49 # ifdef __STDIO_BUFFERS
  50   fp->__bufpos += increment;
  51 # else
  52   abort ();
  53 # endif
  54 #elif defined __QNX__               /* QNX */
  55   fp->_Next += increment;
  56 #elif defined SLOW_BUT_NO_HACKS     /* users can define this */
  57 #else
  58  #error "Please port gnulib freadseek.c to your platform! Look at the definition of getc, getc_unlocked on your system, then report this to bug-gnulib."
  59 #endif
  60 }
  61
  62 int
  63 freadseek (FILE *fp, size_t offset)
  64 {
  65   size_t total_buffered;
  66   int fd;
  67
  68   if (offset == 0)
  69     return 0;
  70
  71   /* Seek over the already read and buffered input as quickly as possible,
  72      without doing any system calls.  */
  73   total_buffered = freadahead (fp);
  74   /* This loop is usually executed at most twice: once for ungetc buffer (if
  75      present) and once for the main buffer.  */
  76   while (total_buffered > 0)
  77     {
  78       size_t buffered;
  79
  80       if (freadptr (fp, &buffered) != NULL && buffered > 0)
  81         {
  82           size_t increment = (buffered < offset ? buffered : offset);
  83
  84           freadptrinc (fp, increment);
  85           offset -= increment;
  86           if (offset == 0)
  87             return 0;
  88           total_buffered -= increment;
  89           if (total_buffered == 0)
  90             break;
  91         }
  92       /* Read one byte.  If we were reading from the ungetc buffer, this
  93          switches the stream back to the main buffer.  */
  94       if (fgetc (fp) == EOF)
  95         goto eof;
  96       offset--;
  97       if (offset == 0)
  98         return 0;
  99       total_buffered--;
 100     }
 101
 102   /* Test whether the stream is seekable or not.  */
 103   fd = fileno (fp);
 104   if (fd >= 0 && lseek (fd, 0, SEEK_CUR) >= 0)
 105     {
 106       /* FP refers to a regular file.  fseek is most efficient in this case.  */
 107       return fseek (fp, offset, SEEK_CUR);
 108     }
 109   else
 110     {
 111       /* FP is a non-seekable stream, possibly not even referring to a file
 112          descriptor.  Read OFFSET bytes explicitly and discard them.  */
 113       char buf[4096];
 114
 115       do
 116         {
 117           size_t count = (sizeof (buf) < offset ? sizeof (buf) : offset);
 118           if (fread (buf, 1, count, fp) < count)
 119             goto eof;
 120           offset -= count;
 121         }
 122       while (offset > 0);
 123
 124       return 0;
 125    }
 126
 127  eof:
 128   /* EOF, or error before or while reading.  */
 129   if (ferror (fp))
 130     return EOF;
 131   else
 132     /* Encountered EOF.  */
 133     return 0;
 134 }