annotate lib/fwriting.h @ 17249:e542fd46ad6f

maint: update all copyright year number ranges Run "make update-copyright". Compare to commit 1602f0a from last year. Signed-off-by: Eric Blake <eblake@redhat.com>
author Eric Blake <eblake@redhat.com>
date Tue, 01 Jan 2013 00:50:58 +0000
parents 3d02d25fa13d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8720
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
1 /* Retrieve information about a FILE stream.
17249
e542fd46ad6f maint: update all copyright year number ranges
Eric Blake <eblake@redhat.com>
parents: 16916
diff changeset
2 Copyright (C) 2007, 2009-2013 Free Software Foundation, Inc.
8720
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
3
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 8753
diff changeset
4 This program is free software: you can redistribute it and/or modify
8720
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 8753
diff changeset
6 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 8753
diff changeset
7 (at your option) any later version.
8720
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
8
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
12 GNU General Public License for more details.
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
13
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 8753
diff changeset
14 You should have received a copy of the GNU General Public License
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 8753
diff changeset
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
8720
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
16
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
17 #include <stdbool.h>
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
18 #include <stdio.h>
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
19
8731
2e1ecfc17762 * lib/freading.h: Improve comments.
Eric Blake <ebb9@byu.net>
parents: 8720
diff changeset
20 /* Return true if the stream STREAM is opened write-only or
2e1ecfc17762 * lib/freading.h: Improve comments.
Eric Blake <ebb9@byu.net>
parents: 8720
diff changeset
21 append-only, or if the last operation on the stream was a write
2e1ecfc17762 * lib/freading.h: Improve comments.
Eric Blake <ebb9@byu.net>
parents: 8720
diff changeset
22 operation. Return false if the stream is opened read-only, or if
2e1ecfc17762 * lib/freading.h: Improve comments.
Eric Blake <ebb9@byu.net>
parents: 8720
diff changeset
23 it supports reading and there is no current write operation (such
2e1ecfc17762 * lib/freading.h: Improve comments.
Eric Blake <ebb9@byu.net>
parents: 8720
diff changeset
24 as fputc).
2e1ecfc17762 * lib/freading.h: Improve comments.
Eric Blake <ebb9@byu.net>
parents: 8720
diff changeset
25
2e1ecfc17762 * lib/freading.h: Improve comments.
Eric Blake <ebb9@byu.net>
parents: 8720
diff changeset
26 freading and fwriting will never both be true. If STREAM supports
8753
10d7922803f5 freading has an undefined value after repositioning a read-write stream.
Bruno Haible <bruno@clisp.org>
parents: 8731
diff changeset
27 both reads and writes, then:
10d7922803f5 freading has an undefined value after repositioning a read-write stream.
Bruno Haible <bruno@clisp.org>
parents: 8731
diff changeset
28 - both freading and fwriting might be false when the stream is first
10d7922803f5 freading has an undefined value after repositioning a read-write stream.
Bruno Haible <bruno@clisp.org>
parents: 8731
diff changeset
29 opened, after read encounters EOF, or after fflush,
10d7922803f5 freading has an undefined value after repositioning a read-write stream.
Bruno Haible <bruno@clisp.org>
parents: 8731
diff changeset
30 - freading might be false or true and fwriting might be false
10d7922803f5 freading has an undefined value after repositioning a read-write stream.
Bruno Haible <bruno@clisp.org>
parents: 8731
diff changeset
31 after repositioning (such as fseek, fsetpos, or rewind),
10d7922803f5 freading has an undefined value after repositioning a read-write stream.
Bruno Haible <bruno@clisp.org>
parents: 8731
diff changeset
32 depending on the underlying implementation.
8731
2e1ecfc17762 * lib/freading.h: Improve comments.
Eric Blake <ebb9@byu.net>
parents: 8720
diff changeset
33
8720
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
34 STREAM must not be wide-character oriented. */
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
35
16916
3d02d25fa13d stdioext: Add support for musl libc.
Bruno Haible <bruno@clisp.org>
parents: 16201
diff changeset
36 #if HAVE___FWRITING /* glibc >= 2.2, Solaris >= 7, musl libc */
8720
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
37
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
38 # include <stdio_ext.h>
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
39 # define fwriting(stream) (__fwriting (stream) != 0)
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
40
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
41 #else
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
42
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
43 # ifdef __cplusplus
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
44 extern "C" {
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
45 # endif
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
46
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
47 extern bool fwriting (FILE *stream);
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
48
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
49 # ifdef __cplusplus
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
50 }
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
51 # endif
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
52
367787d55c9c Implement freading and fwriting.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
53 #endif