Import upstream version 1.28
[debian/tar] / gnu / error.h
1 /* -*- buffer-read-only: t -*- vi: set ro: */
2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
3 /* Declaration for error-reporting function
4    Copyright (C) 1995-1997, 2003, 2006, 2008-2014 Free Software Foundation,
5    Inc.
6    This file is part of the GNU C Library.
7
8    This program is free software: you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
20
21 #ifndef _ERROR_H
22 #define _ERROR_H 1
23
24 /* The __attribute__ feature is available in gcc versions 2.5 and later.
25    The __-protected variants of the attributes 'format' and 'printf' are
26    accepted by gcc versions 2.6.4 (effectively 2.7) and later.
27    We enable _GL_ATTRIBUTE_FORMAT only if these are supported too, because
28    gnulib and libintl do '#define printf __printf__' when they override
29    the 'printf' function.  */
30 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)
31 # define _GL_ATTRIBUTE_FORMAT(spec) __attribute__ ((__format__ spec))
32 #else
33 # define _GL_ATTRIBUTE_FORMAT(spec) /* empty */
34 #endif
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 /* Print a message with 'fprintf (stderr, FORMAT, ...)';
41    if ERRNUM is nonzero, follow it with ": " and strerror (ERRNUM).
42    If STATUS is nonzero, terminate the program with 'exit (STATUS)'.  */
43
44 extern void error (int __status, int __errnum, const char *__format, ...)
45      _GL_ATTRIBUTE_FORMAT ((__printf__, 3, 4));
46
47 extern void error_at_line (int __status, int __errnum, const char *__fname,
48                            unsigned int __lineno, const char *__format, ...)
49      _GL_ATTRIBUTE_FORMAT ((__printf__, 5, 6));
50
51 /* If NULL, error will flush stdout, then print on stderr the program
52    name, a colon and a space.  Otherwise, error will call this
53    function without parameters instead.  */
54 extern void (*error_print_progname) (void);
55
56 /* This variable is incremented each time 'error' is called.  */
57 extern unsigned int error_message_count;
58
59 /* Sometimes we want to have at most one error per line.  This
60    variable controls whether this mode is selected or not.  */
61 extern int error_one_per_line;
62
63 #ifdef __cplusplus
64 }
65 #endif
66
67 #endif /* error.h */