Doxygen file headers for most files
[disorder] / lib / log.h
1 /*
2 * This file is part of DisOrder.
3 * Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18 /** @file lib/log.h
19 * @brief Errors and logging
20 */
21
22 #ifndef LOG_H
23 #define LOG_H
24
25 #include <stdarg.h>
26
27 struct log_output;
28
29 void set_progname(char **argv);
30
31 void elog(int pri, int errno_value, const char *fmt, va_list ap);
32
33 void fatal(int errno_value, const char *msg, ...) attribute((noreturn))
34 attribute((format (printf, 2, 3)));
35 void error(int errno_value, const char *msg, ...)
36 attribute((format (printf, 2, 3)));
37 void info(const char *msg, ...)
38 attribute((format (printf, 1, 2)));
39 void debug(const char *msg, ...)
40 attribute((format (printf, 1, 2)));
41 /* report a message of the given class. @errno_value@ if present an
42 * non-zero is included. @fatal@ terminates the process. */
43
44 extern int debugging;
45 /* set when debugging enabled */
46
47 extern void (*exitfn)(int) attribute((noreturn));
48 /* how to exit the program (for fatal) */
49
50 extern const char *progname;
51 /* program name */
52
53 extern struct log_output log_stderr, log_syslog, *log_default;
54 /* some typical outputs */
55
56 extern const char *debug_filename;
57 extern int debug_lineno;
58
59 #define D(x) do { \
60 if(debugging) { \
61 debug_filename=__FILE__; \
62 debug_lineno=__LINE__; \
63 debug x; \
64 } \
65 } while(0)
66
67 #endif /* LOG_H */
68
69 /*
70 Local Variables:
71 c-basic-offset:2
72 comment-column:40
73 fill-column:79
74 End:
75 */