1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
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. *
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. *
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 ***************************************************************************/
23 #include "replacements.h"
29 * LOG_LVL_SILENT - turn off all output. In lieu of try+catch this can be used as a
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
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);
60 typedef void (*log_callback_fn)(void *priv, const char *file, int line,
61 const char *function, const char *string);
63 typedef struct log_callback_s
67 struct log_callback_s *next;
70 extern int log_add_callback(log_callback_fn fn, void *priv);
71 extern int log_remove_callback(log_callback_fn fn, void *priv);
73 char *alloc_vprintf(const char *fmt, va_list ap);
74 char *alloc_printf(const char *fmt, ...);
76 extern int debug_level;
78 /* Avoid fn call and building parameter list if we're not outputting the information.
79 * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
82 #define LOG_DEBUG(expr ...) \
83 ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
85 #define LOG_INFO(expr ...) \
86 log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
88 #define LOG_INFO_N(expr ...) \
89 log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
91 #define LOG_WARNING(expr ...) \
92 log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
94 #define LOG_ERROR(expr ...) \
95 log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
97 #define LOG_USER(expr ...) \
98 log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
100 #define LOG_USER_N(expr ...) \
101 log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
103 #define LOG_OUTPUT(expr ...) \
104 log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
110 #define ERROR_INVALID_ARGUMENTS (-1)
111 #define ERROR_NO_CONFIG_FILE (-2)
112 #define ERROR_BUF_TOO_SMALL (-3)
113 /* see "Error:" message for meaningful message to the user. The caller should
114 * make no assumptions about what went wrong and try to handle the problem.
116 #define ERROR_FAIL (-4)