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