- combine similar functions in telnet_server.c
[openocd.git] / 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_ERROR - fatal errors, that are likely to cause program abort
30 * LOG_WARNING - non-fatal errors, that may be resolved later
31 * LOG_INFO - state information, etc.
32 * LOG_DEBUG - debug statements, execution trace
33 */
34 enum log_levels
35 {
36 LOG_ERROR = 0,
37 LOG_WARNING = 1,
38 LOG_INFO = 2,
39 LOG_DEBUG = 3
40 };
41
42 extern void log_printf(enum log_levels level, const char *file, int line,
43 const char *function, const char *format, ...)
44 __attribute__ ((format (printf, 5, 6)));
45 extern int log_register_commands(struct command_context_s *cmd_ctx);
46 extern int log_init(struct command_context_s *cmd_ctx);
47 extern int set_log_output(struct command_context_s *cmd_ctx, FILE *output);
48
49 typedef void (*logCallback)(void *priv, const char *file, int line,
50 const char *function, const char *format, va_list args);
51
52 extern void log_setCallback(logCallback callback, void *priv);
53
54 extern int debug_level;
55
56 #define DEBUG(expr ...) \
57 do { \
58 log_printf (LOG_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr); \
59 } while(0)
60
61 #define INFO(expr ...) \
62 do { \
63 log_printf (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr); \
64 } while(0)
65
66 #define WARNING(expr ...) \
67 do { \
68 log_printf (LOG_WARNING, __FILE__, __LINE__, __FUNCTION__, expr); \
69 } while(0)
70
71 #define ERROR(expr ...) \
72 do { \
73 log_printf (LOG_ERROR, __FILE__, __LINE__, __FUNCTION__, expr); \
74 } while(0)
75
76 /* general failures
77 * error codes < 100
78 */
79 #define ERROR_OK (0)
80 #define ERROR_INVALID_ARGUMENTS (-1)
81 #define ERROR_NO_CONFIG_FILE (-2)
82 #define ERROR_BUF_TOO_SMALL (-3)
83
84 char *allocPrintf(const char *fmt, va_list ap);
85
86 #endif /* LOG_H */