annotate lib/verror.c @ 7292:17785d5bede0

Fix docstrings
author Sergey Poznyakoff <gray@gnu.org.ua>
date Sun, 10 Sep 2006 11:52:44 +0000
parents c645fbe36091
children 8e5e6419e8f9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7092
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
1 /* va_list error handler for noninteractive utilities
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
2 Copyright (C) 2006 Free Software Foundation, Inc.
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
3
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
4 This program is free software; you can redistribute it and/or modify
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
6 the Free Software Foundation; either version 2, or (at your option)
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
7 any later version.
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
8
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
12 GNU General Public License for more details.
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
13
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
14 You should have received a copy of the GNU General Public License along
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
15 with this program; if not, write to the Free Software Foundation,
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
16 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
17
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
18 /* Written by Eric Blake. */
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
19
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
20 #ifdef HAVE_CONFIG_H
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
21 # include <config.h>
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
22 #endif
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
23
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
24 #include "verror.h"
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
25 #include "xvasprintf.h"
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
26
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
27 #include <errno.h>
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
28 #include <stdarg.h>
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
29 #include <stdlib.h>
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
30
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
31 #if ENABLE_NLS
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
32 # include "gettext.h"
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
33 #endif
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
34
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
35 #ifndef _
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
36 # define _(String) String
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
37 #endif
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
38
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
39 /* Print a message with `vfprintf (stderr, FORMAT, ARGS)';
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
40 if ERRNUM is nonzero, follow it with ": " and strerror (ERRNUM).
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
41 If STATUS is nonzero, terminate the program with `exit (STATUS)'.
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
42 Use the globals error_print_progname and error_message_count similarly
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
43 to error(). */
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
44 void
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
45 verror (int status, int errnum, const char *format, va_list args)
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
46 {
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
47 verror_at_line (status, errnum, NULL, 0, format, args);
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
48 }
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
49
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
50 /* Print a message with `vfprintf (stderr, FORMAT, ARGS)';
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
51 if ERRNUM is nonzero, follow it with ": " and strerror (ERRNUM).
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
52 If STATUS is nonzero, terminate the program with `exit (STATUS)'.
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
53 If FNAME is not NULL, prepend the message with `FNAME:LINENO:'.
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
54 Use the globals error_print_progname, error_message_count, and
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
55 error_one_per_line similarly to error_at_line(). */
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
56 void
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
57 verror_at_line (int status, int errnum, const char *file,
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
58 unsigned int line_number, const char *format, va_list args)
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
59 {
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
60 char *message = xvasprintf (format, args);
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
61 if (message)
7095
c645fbe36091 * verror.c (verror_at_line): Work around glibc bug 2997, so that
Eric Blake <ebb9@byu.net>
parents: 7092
diff changeset
62 {
c645fbe36091 * verror.c (verror_at_line): Work around glibc bug 2997, so that
Eric Blake <ebb9@byu.net>
parents: 7092
diff changeset
63 /* Until http://sourceware.org/bugzilla/show_bug.cgi?id=2997 is fixed,
c645fbe36091 * verror.c (verror_at_line): Work around glibc bug 2997, so that
Eric Blake <ebb9@byu.net>
parents: 7092
diff changeset
64 glibc violates GNU Coding Standards when the file argument to
c645fbe36091 * verror.c (verror_at_line): Work around glibc bug 2997, so that
Eric Blake <ebb9@byu.net>
parents: 7092
diff changeset
65 error_at_line is NULL. */
c645fbe36091 * verror.c (verror_at_line): Work around glibc bug 2997, so that
Eric Blake <ebb9@byu.net>
parents: 7092
diff changeset
66 if (file)
c645fbe36091 * verror.c (verror_at_line): Work around glibc bug 2997, so that
Eric Blake <ebb9@byu.net>
parents: 7092
diff changeset
67 error_at_line (status, errnum, file, line_number, "%s", message);
c645fbe36091 * verror.c (verror_at_line): Work around glibc bug 2997, so that
Eric Blake <ebb9@byu.net>
parents: 7092
diff changeset
68 else
c645fbe36091 * verror.c (verror_at_line): Work around glibc bug 2997, so that
Eric Blake <ebb9@byu.net>
parents: 7092
diff changeset
69 error (status, errnum, "%s", message);
c645fbe36091 * verror.c (verror_at_line): Work around glibc bug 2997, so that
Eric Blake <ebb9@byu.net>
parents: 7092
diff changeset
70 }
7092
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
71 else
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
72 {
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
73 /* EOVERFLOW, EINVAL, and EILSEQ from xvasprintf are signs of
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
74 serious programmer errors. */
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
75 error (0, errno, _("unable to display error message"));
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
76 abort ();
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
77 }
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
78 free (message);
9b8b4dc0faa2 * verror.h, verror.c: New files.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
79 }