chiark - git - mdw - disorder/blob - lib/log.h

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2004, 2005, 2007-9, 2013 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 /** @brief Possible error number spaces */
  32 enum error_class {
  33   /** @brief Invalid number space */
  34   ec_none,
  35
  36   /** @brief @c errno number space */
  37   ec_errno,
  38
  39   /** @brief Windows GetLastError/WSAGetLastError return value */
  40   ec_windows,
  41
  42   /** @brief getaddrinfo() return value */
  43   ec_getaddrinfo,
  44 };
  45
  46 #if _WIN32
  47 # define ec_native ec_windows
  48 # define ec_socket ec_windows
  49 #else
  50 # define ec_native ec_errno
  51 # define ec_socket ec_errno
  52 #endif
  53
  54 void elog(int pri, enum error_class, int errno_value, const char *fmt, va_list ap);
  55
  56 declspec(noreturn)
  57 void disorder_fatal(int errno_value, const char *msg, ...) attribute((noreturn))
  58   attribute((format (printf, 2, 3)));
  59 declspec(noreturn)
  60 void disorder_fatal_ec(enum error_class ec, int errno_value, const char *msg, ...) attribute((noreturn))
  61   attribute((format (printf, 3, 4)));
  62 void disorder_error(int errno_value, const char *msg, ...)
  63   attribute((format (printf, 2, 3)));
  64 void disorder_error_ec(enum error_class ec, int errno_value, const char *msg, ...)
  65   attribute((format (printf, 3, 4)));
  66 void disorder_info(const char *msg, ...)
  67   attribute((format (printf, 1, 2)));
  68 void disorder_debug(const char *msg, ...)
  69   attribute((format (printf, 1, 2)));
  70 /* report a message of the given class.  @errno_value@ if present an
  71  * non-zero is included.  @fatal@ terminates the process. */
  72
  73 const char *format_error(enum error_class ec, int err, char buffer[], size_t bufsize);
  74
  75 extern int debugging;
  76 /* set when debugging enabled */
  77
  78 extern void (*exitfn)(int) attribute((noreturn));
  79 /* how to exit the program (for fatal) */
  80
  81 extern const char *progname;
  82 /* program name */
  83
  84 extern struct log_output log_stderr, *log_default;
  85 #if HAVE_SYSLOG_H
  86 extern struct log_output log_syslog;
  87 #endif
  88 /* some typical outputs */
  89
  90 extern const char *debug_filename;
  91 extern int debug_lineno;
  92 extern int logdate;
  93
  94 /** @brief Issue a debug message if debugging is turned on
  95  * @param x Parenthesized debug arguments
  96  *
  97  * Use in the format: D(("format string", arg, arg, ...));
  98  */
  99 #define D(x) do {                               \
 100   if(debugging) {                               \
 101     debug_filename=__FILE__;                    \
 102     debug_lineno=__LINE__;                      \
 103     disorder_debug x;                           \
 104   }                                             \
 105 } while(0)
 106
 107 #endif /* LOG_H */
 108
 109 /*
 110 Local Variables:
 111 c-basic-offset:2
 112 comment-column:40
 113 fill-column:79
 114 End:
 115 */