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

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2004, 2005 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 2 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, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * 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, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18  * USA
  19  */
  20
  21 #ifndef LOG_H
  22 #define LOG_H
  23
  24 /* All messages are initially emitted by one of the four functions below.
  25  * debug() is generally invoked via D() so that mostly you just do a test
  26  * rather than a complete subroutine call.
  27  *
  28  * Messages are dispatched via log_default.  This defaults to log_stderr.
  29  * daemonize() will turn off log_stderr and use log_syslog instead.
  30  *
  31  * fatal() will call exitfn() with a nonzero status.  The default value is
  32  * exit(), but it should be set to _exit() anywhere but the 'main line' of the
  33  * program, to guarantee that exit() gets called at most once.
  34  */
  35
  36 #include <stdarg.h>
  37
  38 struct log_output;
  39
  40 void set_progname(char **argv);
  41 /* set progname from argv[0] */
  42
  43 void elog(int pri, int errno_value, const char *fmt, va_list ap);
  44 /* internals of fatal/error/info/debug */
  45
  46 void fatal(int errno_value, const char *msg, ...) attribute((noreturn))
  47   attribute((format (printf, 2, 3)));
  48 void error(int errno_value, const char *msg, ...)
  49   attribute((format (printf, 2, 3)));
  50 void info(const char *msg, ...)
  51   attribute((format (printf, 1, 2)));
  52 void debug(const char *msg, ...)
  53   attribute((format (printf, 1, 2)));
  54 /* report a message of the given class.  @errno_value@ if present an
  55  * non-zero is included.  @fatal@ terminates the process. */
  56
  57 extern int debugging;
  58 /* set when debugging enabled */
  59
  60 extern void (*exitfn)(int) attribute((noreturn));
  61 /* how to exit the program (for fatal) */
  62
  63 extern const char *progname;
  64 /* program name */
  65
  66 extern struct log_output log_stderr, log_syslog, *log_default;
  67 /* some typical outputs */
  68
  69 extern const char *debug_filename;
  70 extern int debug_lineno;
  71
  72 #define D(x) do {                               \
  73   if(debugging) {                               \
  74     debug_filename=__FILE__;                    \
  75     debug_lineno=__LINE__;                      \
  76     debug x;                                    \
  77   }                                             \
  78 } while(0)
  79
  80 #endif /* LOG_H */
  81
  82 /*
  83 Local Variables:
  84 c-basic-offset:2
  85 comment-column:40
  86 fill-column:79
  87 End:
  88 */