lib/freadptr.h

   1 /* Retrieve information about a FILE stream.
   2    Copyright (C) 2007-2021 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 <https://www.gnu.org/licenses/>.  */
  16
  17 #include <stddef.h>
  18 #include <stdio.h>
  19
  20 /* Assuming the stream STREAM is open for reading:
  21    Return a pointer to the input buffer of STREAM, or NULL.
  22    If the returned pointer is non-NULL, *SIZEP is set to the (positive) size
  23    of the input buffer.
  24    If the returned pointer is NULL, you should use getc (STREAM),
  25    fgetc (STREAM), or fread (..., STREAM) to access the input from STREAM.
  26
  27    The resulting pointer becomes invalid upon any operation on STREAM.
  28
  29    STREAM must not be wide-character oriented.  */
  30
  31 #if HAVE___FREADPTR /* musl libc */
  32
  33 # include <stdio_ext.h>
  34 # define freadptr(stream,sizep) __freadptr (stream, sizep)
  35
  36 #else
  37
  38 # ifdef __cplusplus
  39 extern "C" {
  40 # endif
  41
  42 extern const char * freadptr (FILE *stream, size_t *sizep);
  43
  44 # ifdef __cplusplus
  45 }
  46 # endif
  47
  48 #endif