src/helper/log.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   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,       *
  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, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #ifndef ERROR_H
  21 #define ERROR_H
  22
  23 #include "replacements.h"
  24 #include "command.h"
  25
  26 #include <stdarg.h>
  27
  28 /* logging priorities
  29  * LOG_LVL_SILENT - turn off all output. In lieu of try+catch this can be used as a
  30  *                  feeble ersatz.
  31  * LOG_LVL_USER - user messages. Could be anything from information
  32  *                to progress messags. These messages do not represent
  33  *                incorrect or unexpected behaviour, just normal execution.
  34  * LOG_LVL_ERROR - fatal errors, that are likely to cause program abort
  35  * LOG_LVL_WARNING - non-fatal errors, that may be resolved later
  36  * LOG_LVL_INFO - state information, etc.
  37  * LOG_LVL_DEBUG - debug statements, execution trace
  38  */
  39 enum log_levels
  40 {
  41         LOG_LVL_SILENT = -3,
  42         LOG_LVL_OUTPUT = -2,
  43         LOG_LVL_USER = -1,
  44         LOG_LVL_ERROR = 0,
  45         LOG_LVL_WARNING = 1,
  46         LOG_LVL_INFO = 2,
  47         LOG_LVL_DEBUG = 3
  48 };
  49
  50 extern void log_printf(enum log_levels level, const char *file, int line,
  51         const char *function, const char *format, ...)
  52 __attribute__ ((format (printf, 5, 6)));
  53 extern void log_printf_lf(enum log_levels level, const char *file, int line,
  54         const char *function, const char *format, ...)
  55 __attribute__ ((format (printf, 5, 6)));
  56 extern int log_register_commands(struct command_context_s *cmd_ctx);
  57 extern int log_init(struct command_context_s *cmd_ctx);
  58 extern int set_log_output(struct command_context_s *cmd_ctx, FILE *output);
  59 extern void keep_alive();
  60 extern void kept_alive();
  61
  62 typedef void (*log_callback_fn)(void *priv, const char *file, int line,
  63                 const char *function, const char *string);
  64
  65 typedef struct log_callback_s
  66 {
  67         log_callback_fn fn;
  68         void *priv;
  69         struct log_callback_s *next;
  70 } log_callback_t;
  71
  72 extern int log_add_callback(log_callback_fn fn, void *priv);
  73 extern int log_remove_callback(log_callback_fn fn, void *priv);
  74
  75 char *alloc_vprintf(const char *fmt, va_list ap);
  76 char *alloc_printf(const char *fmt, ...);
  77
  78 extern int debug_level;
  79
  80 /* Avoid fn call and building parameter list if we're not outputting the information.
  81  * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
  82
  83
  84 #define LOG_DEBUG(expr ...) \
  85                 ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
  86
  87 #define LOG_INFO(expr ...) \
  88                 log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
  89
  90 #define LOG_INFO_N(expr ...) \
  91                 log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
  92
  93 #define LOG_WARNING(expr ...) \
  94                 log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
  95
  96 #define LOG_ERROR(expr ...) \
  97                 log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
  98
  99 #define LOG_USER(expr ...) \
 100                 log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
 101
 102 #define LOG_USER_N(expr ...) \
 103                 log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
 104
 105 #define LOG_OUTPUT(expr ...) \
 106                 log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
 107
 108 /* general failures
 109  * error codes < 100
 110  */
 111 #define ERROR_OK                                        (0)
 112 #define ERROR_INVALID_ARGUMENTS         ERROR_COMMAND_SYNTAX_ERROR
 113 #define ERROR_NO_CONFIG_FILE            (-2)
 114 #define ERROR_BUF_TOO_SMALL                     (-3)
 115 /* see "Error:" log entry for meaningful message to the user. The caller should
 116  * make no assumptions about what went wrong and try to handle the problem.
 117  */
 118 #define ERROR_FAIL                              (-4)
 119
 120 #endif /* LOG_H */