pintos-os.org Git - pspp/blob - lib/freadptr.h

   1 /* Retrieve information about 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 <stddef.h>
  18 #include <stdio.h>
  19
  20 #ifdef __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 /* Assuming the stream STREAM is open for reading:
  25    Return a pointer to the input buffer of STREAM.
  26    If freadahead (STREAM) > 0, the result is either a pointer to
  27    freadahead (STREAM) bytes, or NULL.  The latter case can happen after
  28    use of 'ungetc (..., STREAM)'.
  29    If freadahead (STREAM) == 0, the result is not usable; it may be NULL.
  30    In this case, you should use getc (STREAM), fgetc (STREAM), or
  31    fread (..., STREAM) to access the input from STREAM.
  32
  33    The resulting pointer becomes invalid upon any operation on STREAM.
  34
  35    STREAM must not be wide-character oriented.  */
  36
  37 extern const char * freadptr (FILE *stream);
  38
  39 #ifdef __cplusplus
  40 }
  41 #endif