annotate lib/close-stream.c @ 9268:a553c18c572d

Rename sys_time_.h to sys_time.in.h.
author Bruno Haible <bruno@clisp.org>
date Tue, 02 Oct 2007 00:37:40 +0200
parents cc316ffcb4fc
children bbbbbf4cd1c5
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
9183
cc316ffcb4fc Rename __fpending.c -> fpending.c and __fpending.h -> fpending.h
Jim Meyering <jim@meyering.net>
parents: 7302
diff changeset
3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004, 2006, 2007 Free
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
4 Software Foundation, Inc.
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
5
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
6 This program is free software; you can redistribute it and/or modify
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
9 any later version.
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
10
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
11 This program is distributed in the hope that it will be useful,
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
14 GNU General Public License for more details.
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
15
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
17 along with this program; if not, write to the Free Software Foundation,
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
18 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
19
7302
8a1a9361108c * _fpending.c: Include <config.h> unconditionally, since we no
Paul Eggert <eggert@cs.ucla.edu>
parents: 7035
diff changeset
20 #include <config.h>
7035
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 "close-stream.h"
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
23
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
24 #include <errno.h>
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
25 #include <stdbool.h>
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
26
9183
cc316ffcb4fc Rename __fpending.c -> fpending.c and __fpending.h -> fpending.h
Jim Meyering <jim@meyering.net>
parents: 7302
diff changeset
27 #include "fpending.h"
7035
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
28
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
29 #if USE_UNLOCKED_IO
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
30 # include "unlocked-io.h"
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
31 #endif
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
32
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
33 /* Close STREAM. Return 0 if successful, EOF (setting errno)
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
34 otherwise. A failure might set errno to 0 if the error number
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
35 cannot be determined.
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
36
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
37 If a program writes *anything* to STREAM, that program should close
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
38 STREAM and make sure that it succeeds before exiting. Otherwise,
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
39 suppose that you go to the extreme of checking the return status
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
40 of every function that does an explicit write to STREAM. The last
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
41 printf can succeed in writing to the internal stream buffer, and yet
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
42 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
43 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
44 left with an incomplete output file and the offending program would
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
45 exit successfully. Even calling fflush is not always sufficient,
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
46 since some file systems (NFS and CODA) buffer written/flushed data
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
47 until an actual close call.
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
48
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
49 Besides, it's wasteful to check the return value from every call
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
50 that writes to STREAM -- just let the internal stream state record
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
51 the failure. That's what the ferror test is checking below. */
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
52
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
53 int
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
54 close_stream (FILE *stream)
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
55 {
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
56 bool some_pending = (__fpending (stream) != 0);
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
57 bool prev_fail = (ferror (stream) != 0);
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
58 bool fclose_fail = (fclose (stream) != 0);
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
59
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
60 /* Return an error indication if there was a previous failure or if
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
61 fclose failed, with one exception: ignore an fclose failure if
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
62 there was no previous error, no data remains to be flushed, and
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
63 fclose failed with EBADF. That can happen when a program like cp
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
64 is invoked like this `cp a b >&-' (i.e., with standard output
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
65 closed) and doesn't generate any output (hence no previous error
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
66 and nothing to be flushed). */
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
67
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
68 if (prev_fail || (fclose_fail && (some_pending || errno != EBADF)))
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 (! fclose_fail)
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
71 errno = 0;
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
72 return EOF;
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
73 }
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
74
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
75 return 0;
264f42792bc8 Initial revision.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
76 }