Mercurial > hg > octave-nkf > gnulib-hg

annotate lib/closeout.c @ 7292:17785d5bede0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix docstrings
author Sergey Poznyakoff <gray@gnu.org.ua>
date Sun, 10 Sep 2006 11:52:44 +0000
parents 3e074d71e4d1
children 8a1a9361108c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7034
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
1 /* Close standard output, exiting with a diagnostic on error.
5159
a535859efd14 Merge from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4469
diff changeset
2
6627
9e28dc7b0d44 * closeout.c (close_stdout): Don't assume 'bool' converts nonzero
Paul Eggert <eggert@cs.ucla.edu>
parents: 6259
diff changeset
3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004, 2006 Free
9e28dc7b0d44 * closeout.c (close_stdout): Don't assume 'bool' converts nonzero
Paul Eggert <eggert@cs.ucla.edu>
parents: 6259
diff changeset
4 Software Foundation, Inc.
1197
Jim Meyering <jim@meyering.net>
parents:
diff changeset
5
Jim Meyering <jim@meyering.net>
parents:
diff changeset
6 This program is free software; you can redistribute it and/or modify
Jim Meyering <jim@meyering.net>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
Jim Meyering <jim@meyering.net>
parents:
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
Jim Meyering <jim@meyering.net>
parents:
diff changeset
9 any later version.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
10
Jim Meyering <jim@meyering.net>
parents:
diff changeset
11 This program is distributed in the hope that it will be useful,
Jim Meyering <jim@meyering.net>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
Jim Meyering <jim@meyering.net>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Jim Meyering <jim@meyering.net>
parents:
diff changeset
14 GNU General Public License for more details.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
15
Jim Meyering <jim@meyering.net>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
Jim Meyering <jim@meyering.net>
parents:
diff changeset
17 along with this program; if not, write to the Free Software Foundation,
5848
a48fb0e98c8c *** empty log message ***
Paul Eggert <eggert@cs.ucla.edu>
parents: 5445
diff changeset
18 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
1197
Jim Meyering <jim@meyering.net>
parents:
diff changeset
19
6259
96c32553b4c6 Use a consistent style for including <config.h>.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5848
diff changeset
20 #ifdef HAVE_CONFIG_H
1197
Jim Meyering <jim@meyering.net>
parents:
diff changeset
21 # include <config.h>
Jim Meyering <jim@meyering.net>
parents:
diff changeset
22 #endif
Jim Meyering <jim@meyering.net>
parents:
diff changeset
23
4469
df96fe512139 (close_stdout_set_status, close_stdout_status): Remove.
Jim Meyering <jim@meyering.net>
parents: 3966
diff changeset
24 #include "closeout.h"
1197
Jim Meyering <jim@meyering.net>
parents:
diff changeset
25
7034
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
26 #include <errno.h>
2519
53352ce5b0d1 (close_stdout_set_file_name): New function.
Jim Meyering <jim@meyering.net>
parents: 2513
diff changeset
27 #include <stdio.h>
7034
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
28 #include <unistd.h>
1197
Jim Meyering <jim@meyering.net>
parents:
diff changeset
29
3966
22d3032f0239 Include gettext.h instead of <libintl.h> with #ifdefs.
Bruno Haible <bruno@clisp.org>
parents: 3690
diff changeset
30 #include "gettext.h"
22d3032f0239 Include gettext.h instead of <libintl.h> with #ifdefs.
Bruno Haible <bruno@clisp.org>
parents: 3690
diff changeset
31 #define _(msgid) gettext (msgid)
22d3032f0239 Include gettext.h instead of <libintl.h> with #ifdefs.
Bruno Haible <bruno@clisp.org>
parents: 3690
diff changeset
32
7034
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
33 #include "close-stream.h"
1197
Jim Meyering <jim@meyering.net>
parents:
diff changeset
34 #include "error.h"
4469
df96fe512139 (close_stdout_set_status, close_stdout_status): Remove.
Jim Meyering <jim@meyering.net>
parents: 3966
diff changeset
35 #include "exitfail.h"
2522
31ce9e1b6eea <sys/stat.h>, <sys/types.h>, <unistd.h>, (STDOUT_FILENO):
Jim Meyering <jim@meyering.net>
parents: 2519
diff changeset
36 #include "quotearg.h"
5318
7c24a825b51d Remove dependencies on unlocked-io.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5159
diff changeset
37
2522
31ce9e1b6eea <sys/stat.h>, <sys/types.h>, <unistd.h>, (STDOUT_FILENO):
Jim Meyering <jim@meyering.net>
parents: 2519
diff changeset
38 static const char *file_name;
2513
be6bb70a4fea [default_exit_status]: New file-scoped variable.
Jim Meyering <jim@meyering.net>
parents: 1772
diff changeset
39
2519
53352ce5b0d1 (close_stdout_set_file_name): New function.
Jim Meyering <jim@meyering.net>
parents: 2513
diff changeset
40 /* Set the file name to be reported in the event an error is detected
4469
df96fe512139 (close_stdout_set_status, close_stdout_status): Remove.
Jim Meyering <jim@meyering.net>
parents: 3966
diff changeset
41 by close_stdout. */
2519
53352ce5b0d1 (close_stdout_set_file_name): New function.
Jim Meyering <jim@meyering.net>
parents: 2513
diff changeset
42 void
53352ce5b0d1 (close_stdout_set_file_name): New function.
Jim Meyering <jim@meyering.net>
parents: 2513
diff changeset
43 close_stdout_set_file_name (const char *file)
53352ce5b0d1 (close_stdout_set_file_name): New function.
Jim Meyering <jim@meyering.net>
parents: 2513
diff changeset
44 {
53352ce5b0d1 (close_stdout_set_file_name): New function.
Jim Meyering <jim@meyering.net>
parents: 2513
diff changeset
45 file_name = file;
53352ce5b0d1 (close_stdout_set_file_name): New function.
Jim Meyering <jim@meyering.net>
parents: 2513
diff changeset
46 }
53352ce5b0d1 (close_stdout_set_file_name): New function.
Jim Meyering <jim@meyering.net>
parents: 2513
diff changeset
47
7034
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
48 /* Close standard output. On error, issue a diagnostic and _exit
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
49 with status 'exit_failure'.
1662
096732ffc839 Add comments.
Jim Meyering <jim@meyering.net>
parents: 1278
diff changeset
50
7034
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
51 Since close_stdout is commonly registered via 'atexit', POSIX
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
52 and the C standard both say that it should not call 'exit',
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
53 because the behavior is undefined if 'exit' is called more than
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
54 once. So it calls '_exit' instead of 'exit'. If close_stdout
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
55 is registered via atexit before other functions are registered,
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
56 the other functions can act before this _exit is invoked.
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
57
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
58 Applications that use close_stdout should flush any streams
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
59 other than stdout and stderr before exiting, since the call to
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
60 _exit will bypass other buffer flushing. Applications should
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
61 be flushing and closing other streams anyway, to check for I/O
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
62 errors. Also, applications should not use tmpfile, since _exit
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
63 can bypass the removal of these files.
1662
096732ffc839 Add comments.
Jim Meyering <jim@meyering.net>
parents: 1278
diff changeset
64
096732ffc839 Add comments.
Jim Meyering <jim@meyering.net>
parents: 1278
diff changeset
65 It's important to detect such failures and exit nonzero because many
096732ffc839 Add comments.
Jim Meyering <jim@meyering.net>
parents: 1278
diff changeset
66 tools (most notably `make' and other build-management systems) depend
096732ffc839 Add comments.
Jim Meyering <jim@meyering.net>
parents: 1278
diff changeset
67 on being able to detect failure in other tools via their exit status. */
2838
fd547e6c4244 Include "__fpending.h".
Jim Meyering <jim@meyering.net>
parents: 2522
diff changeset
68
1197
Jim Meyering <jim@meyering.net>
parents:
diff changeset
69 void
4469
df96fe512139 (close_stdout_set_status, close_stdout_status): Remove.
Jim Meyering <jim@meyering.net>
parents: 3966
diff changeset
70 close_stdout (void)
1197
Jim Meyering <jim@meyering.net>
parents:
diff changeset
71 {
7034
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
72 if (close_stream (stdout) != 0)
5445
fe44cfd53b9d Include "__fpending.h" once again.
Jim Meyering <jim@meyering.net>
parents: 5404
diff changeset
73 {
7034
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
74 char const *write_error = _("write error");
2519
53352ce5b0d1 (close_stdout_set_file_name): New function.
Jim Meyering <jim@meyering.net>
parents: 2513
diff changeset
75 if (file_name)
7034
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
76 error (0, errno, "%s: %s", quotearg_colon (file_name),
4469
df96fe512139 (close_stdout_set_status, close_stdout_status): Remove.
Jim Meyering <jim@meyering.net>
parents: 3966
diff changeset
77 write_error);
2519
53352ce5b0d1 (close_stdout_set_file_name): New function.
Jim Meyering <jim@meyering.net>
parents: 2513
diff changeset
78 else
7034
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
79 error (0, errno, "%s", write_error);
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
80
3e074d71e4d1 * modules/close-stream: New file.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6627
diff changeset
81 _exit (exit_failure);
2519
53352ce5b0d1 (close_stdout_set_file_name): New function.
Jim Meyering <jim@meyering.net>
parents: 2513
diff changeset
82 }
1197
Jim Meyering <jim@meyering.net>
parents:
diff changeset
83 }