mdw@git.distorted.org.uk Git - disorder/blob - 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 disorder_fatal(int errno_value, const char *msg, ...) attribute((noreturn))
  34   attribute((format (printf, 2, 3)));
  35 void disorder_error(int errno_value, const char *msg, ...)
  36   attribute((format (printf, 2, 3)));
  37 void disorder_info(const char *msg, ...)
  38   attribute((format (printf, 1, 2)));
  39 void disorder_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 /** @brief Backward-compatibility alias for disorder_fatal() */
  45 #define fatal disorder_fatal
  46
  47 /** @brief Backward-compatibility alias for disorder_error() */
  48 #define error disorder_error
  49
  50 /** @brief Backward-compatibility alias for disorder_info() */
  51 #define info disorder_info
  52
  53 /** @brief Backward-compatibility alias for disorder_debug() */
  54 #define debug disorder_debug
  55
  56 extern int debugging;
  57 /* set when debugging enabled */
  58
  59 extern void (*exitfn)(int) attribute((noreturn));
  60 /* how to exit the program (for fatal) */
  61
  62 extern const char *progname;
  63 /* program name */
  64
  65 extern struct log_output log_stderr, log_syslog, *log_default;
  66 /* some typical outputs */
  67
  68 extern const char *debug_filename;
  69 extern int debug_lineno;
  70 extern int logdate;
  71
  72 /** @brief Issue a debug message if debugging is turned on
  73  * @param x Parenthesized debug arguments
  74  *
  75  * Use in the format: D(("format string", arg, arg, ...));
  76  */
  77 #define D(x) do {                               \
  78   if(debugging) {                               \
  79     debug_filename=__FILE__;                    \
  80     debug_lineno=__LINE__;                      \
  81     debug x;                                    \
  82   }                                             \
  83 } while(0)
  84
  85 #endif /* LOG_H */
  86
  87 /*
  88 Local Variables:
  89 c-basic-offset:2
  90 comment-column:40
  91 fill-column:79
  92 End:
  93 */