freading has an undefined value after repositioning a read-write stream.
[gnulib.git] / lib / freading.h
1 /* Retrieve information about a FILE stream.
2    Copyright (C) 2007 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 2, or (at your option)
7    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 along
15    with this program; if not, write to the Free Software Foundation,
16    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
17
18 #include <stdbool.h>
19 #include <stdio.h>
20
21 /* Return true if the stream STREAM is opened read-only, or if the
22    last operation on the stream was a read operation.  Return false if
23    the stream is opened write-only or append-only, or if it supports
24    writing and there is no current read operation (such as fputc).
25
26    freading and fwriting will never both be true.  If STREAM supports
27    both reads and writes, then:
28      - both freading and fwriting might be false when the stream is first
29        opened, after read encounters EOF, or after fflush,
30      - freading might be false or true and fwriting might be false
31        after repositioning (such as fseek, fsetpos, or rewind),
32    depending on the underlying implementation.
33
34    STREAM must not be wide-character oriented.  */
35
36 #if HAVE___FREADING && !defined __GLIBC__ /* Solaris >= 7, not glibc >= 2.2  */
37
38 # include <stdio_ext.h>
39 # define freading(stream) (__freading (stream) != 0)
40
41 #else
42
43 # ifdef __cplusplus
44 extern "C" {
45 # endif
46
47 extern bool freading (FILE *stream);
48
49 # ifdef __cplusplus
50 }
51 # endif
52
53 #endif