freading has an undefined value after repositioning a read-write stream.
[gnulib.git] / lib / fwriting.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 write-only or
22    append-only, or if the last operation on the stream was a write
23    operation.  Return false if the stream is opened read-only, or if
24    it supports reading and there is no current write operation (such
25    as fputc).
26
27    freading and fwriting will never both be true.  If STREAM supports
28    both reads and writes, then:
29      - both freading and fwriting might be false when the stream is first
30        opened, after read encounters EOF, or after fflush,
31      - freading might be false or true and fwriting might be false
32        after repositioning (such as fseek, fsetpos, or rewind),
33    depending on the underlying implementation.
34
35    STREAM must not be wide-character oriented.  */
36
37 #if HAVE___FWRITING /* glibc >= 2.2, Solaris >= 7 */
38
39 # include <stdio_ext.h>
40 # define fwriting(stream) (__fwriting (stream) != 0)
41
42 #else
43
44 # ifdef __cplusplus
45 extern "C" {
46 # endif
47
48 extern bool fwriting (FILE *stream);
49
50 # ifdef __cplusplus
51 }
52 # endif
53
54 #endif