annotate lib/close-stream.c @ 17363:5a51fb7777a9

sys_select, sys_time: port 2013-01-30 Solaris 2.6 fix to Cygwin Problem reported by Marco Atzeri in <http://lists.gnu.org/archive/html/bug-gnulib/2013-03/msg00000.html>. * lib/sys_select.in.h [HAVE_SYS_SELECT_H && _CYGWIN_SYS_TIME_H]: Simply delegate to the system <sys/select.h> in this case too. Also, pay attention to _GL_SYS_SELECT_H_REDIRECT_FROM_SYS_TIME_H only if OSF/1, since otherwise Cygwin breaks, and it doesn't seem to be needed on Solaris either. * lib/sys_time.in.h [_CYGWIN_SYS_TIME_H]: Simply delgate to the system <sys/time.h> in this case.
author Paul Eggert <eggert@cs.ucla.edu>
date Tue, 19 Mar 2013 09:08:47 -0700
parents e542fd46ad6f
children 344018b6e5d7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
1 /* Close a stream, with nicer error checking than fclose's.
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
2
17249
e542fd46ad6f maint: update all copyright year number ranges
Eric Blake <eblake@redhat.com>
parents: 16235
diff changeset
3 Copyright (C) 1998-2002, 2004, 2006-2013 Free Software Foundation, Inc.
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
4
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9183
diff changeset
5 This program is free software: you can redistribute it and/or modify
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
6 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: 9183
diff changeset
7 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: 9183
diff changeset
8 (at your option) any later version.
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
9
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
13 GNU General Public License for more details.
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
14
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9183
diff changeset
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
17
7302
8a1a9361108c * _fpending.c: Include <config.h> unconditionally, since we no
Paul Eggert <eggert@cs.ucla.edu>
parents: 7035
diff changeset
18 #include <config.h>
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
19
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
20 #include "close-stream.h"
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
21
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
22 #include <errno.h>
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
23 #include <stdbool.h>
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
24
9183
cc316ffcb4fc Rename __fpending.c -> fpending.c and __fpending.h -> fpending.h
Jim Meyering <jim@meyering.net>
parents: 7302
diff changeset
25 #include "fpending.h"
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
26
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
27 #if USE_UNLOCKED_IO
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
28 # include "unlocked-io.h"
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
29 #endif
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
30
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
31 /* Close STREAM. Return 0 if successful, EOF (setting errno)
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
32 otherwise. A failure might set errno to 0 if the error number
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
33 cannot be determined.
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
34
10595
37b949ffd096 Add an option for ignoring EPIPE during close_stdout.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
35 A failure with errno set to EPIPE may or may not indicate an error
37b949ffd096 Add an option for ignoring EPIPE during close_stdout.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
36 situation worth signaling to the user. See the documentation of the
37b949ffd096 Add an option for ignoring EPIPE during close_stdout.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
37 close_stdout_set_ignore_EPIPE function for details.
37b949ffd096 Add an option for ignoring EPIPE during close_stdout.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
38
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
39 If a program writes *anything* to STREAM, that program should close
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
40 STREAM and make sure that it succeeds before exiting. Otherwise,
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
41 suppose that you go to the extreme of checking the return status
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
42 of every function that does an explicit write to STREAM. The last
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
43 printf can succeed in writing to the internal stream buffer, and yet
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
44 the fclose(STREAM) could still fail (due e.g., to a disk full error)
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
45 when it tries to write out that buffered data. Thus, you would be
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
46 left with an incomplete output file and the offending program would
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
47 exit successfully. Even calling fflush is not always sufficient,
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
48 since some file systems (NFS and CODA) buffer written/flushed data
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
49 until an actual close call.
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
50
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
51 Besides, it's wasteful to check the return value from every call
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
52 that writes to STREAM -- just let the internal stream state record
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
53 the failure. That's what the ferror test is checking below. */
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
54
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
55 int
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
56 close_stream (FILE *stream)
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
57 {
13212
d724e1ff61cd close-stream: declare local scalars to be "const"
James Youngman <jay@gnu.org>
parents: 12559
diff changeset
58 const bool some_pending = (__fpending (stream) != 0);
d724e1ff61cd close-stream: declare local scalars to be "const"
James Youngman <jay@gnu.org>
parents: 12559
diff changeset
59 const bool prev_fail = (ferror (stream) != 0);
d724e1ff61cd close-stream: declare local scalars to be "const"
James Youngman <jay@gnu.org>
parents: 12559
diff changeset
60 const bool fclose_fail = (fclose (stream) != 0);
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
61
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
62 /* Return an error indication if there was a previous failure or if
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
63 fclose failed, with one exception: ignore an fclose failure if
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
64 there was no previous error, no data remains to be flushed, and
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
65 fclose failed with EBADF. That can happen when a program like cp
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
66 is invoked like this 'cp a b >&-' (i.e., with standard output
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
67 closed) and doesn't generate any output (hence no previous error
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
68 and nothing to be flushed). */
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
69
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
70 if (prev_fail || (fclose_fail && (some_pending || errno != EBADF)))
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
71 {
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
72 if (! fclose_fail)
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 10595
diff changeset
73 errno = 0;
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
74 return EOF;
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
75 }
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
76
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
77 return 0;
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
78 }