1 /* closeout.c - close standard output
2 Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
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)
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.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software Foundation,
16 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
24 # define _(Text) gettext (Text)
33 # define EXIT_FAILURE 1
47 #include "__fpending.h"
50 static int default_exit_status = EXIT_FAILURE;
51 static const char *file_name;
53 /* Set the value to be used for the exit status when close_stdout is called.
54 This is useful when it is not convenient to call close_stdout_status,
55 e.g., when close_stdout is called via atexit. */
57 close_stdout_set_status (int status)
59 default_exit_status = status;
62 /* Set the file name to be reported in the event an error is detected
63 by close_stdout_status. */
65 close_stdout_set_file_name (const char *file)
70 /* Close standard output, exiting with status STATUS on failure.
71 If a program writes *anything* to stdout, that program should `fflush'
72 stdout and make sure that it succeeds before exiting. Otherwise,
73 suppose that you go to the extreme of checking the return status
74 of every function that does an explicit write to stdout. The last
75 printf can succeed in writing to the internal stream buffer, and yet
76 the fclose(stdout) could still fail (due e.g., to a disk full error)
77 when it tries to write out that buffered data. Thus, you would be
78 left with an incomplete output file and the offending program would
81 FIXME: note the fflush suggested above is implicit in the fclose
82 we actually do below. Consider doing only the fflush and/or using
83 setvbuf to inhibit buffering.
85 Besides, it's wasteful to check the return value from every call
86 that writes to stdout -- just let the internal stream state record
87 the failure. That's what the ferror test is checking below.
89 It's important to detect such failures and exit nonzero because many
90 tools (most notably `make' and other build-management systems) depend
91 on being able to detect failure in other tools via their exit status. */
94 close_stdout_status (int status)
96 int e = ferror (stdout) ? 0 : -1;
99 if (__fpending (stdout) == 0)
103 if (fclose (stdout) != 0)
108 char const *write_error = _("write error");
110 error (status, e, "%s: %s", quotearg_colon (file_name), write_error);
112 error (status, e, "%s", write_error);
116 /* Close standard output, exiting with status EXIT_FAILURE on failure. */
120 close_stdout_status (default_exit_status);