- prepare OpenOCD for branching, created ./trunk/
[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 "command.h"
24
25 #include <stdarg.h>
26
27 /* logging priorities
28 * LOG_ERROR - fatal errors, that are likely to cause program abort
29 * LOG_WARNING - non-fatal errors, that may be resolved later
30 * LOG_INFO - state information, etc.
31 * LOG_DEBUG - debug statements, execution trace
32 */
33 enum log_levels
34 {
35 LOG_ERROR = 0,
36 LOG_WARNING = 1,
37 LOG_INFO = 2,
38 LOG_DEBUG = 3
39 };
40
41 extern void log_printf(enum log_levels level, const char *file, int line,
42 const char *function, const char *format, ...);
43 extern int log_register_commands(struct command_context_s *cmd_ctx);
44 extern int log_init(struct command_context_s *cmd_ctx);
45
46 extern int debug_level;
47
48 #define DEBUG(expr ...) \
49 do { \
50 log_printf (LOG_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr); \
51 } while(0)
52
53 #define INFO(expr ...) \
54 do { \
55 log_printf (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr); \
56 } while(0)
57
58 #define WARNING(expr ...) \
59 do { \
60 log_printf (LOG_WARNING, __FILE__, __LINE__, __FUNCTION__, expr); \
61 } while(0)
62
63 #define ERROR(expr ...) \
64 do { \
65 log_printf (LOG_ERROR, __FILE__, __LINE__, __FUNCTION__, expr); \
66 } while(0)
67
68 #define SDEBUG(expr ...) \
69 do { \
70 short_log_printf (LOG_DEBUG, expr); \
71 } while(0)
72
73 #define SINFO(expr ...) \
74 do { \
75 short_log_printf (LOG_INFO, expr); \
76 } while(0)
77
78 #define SWARNING(expr ...) \
79 do { \
80 short_log_printf (LOG_WARNING, expr); \
81 } while(0)
82
83 #define SERROR(expr ...) \
84 do { \
85 short_log_printf (LOG_ERROR, expr); \
86 } while(0)
87
88 /* general failures
89 * error codes < 100
90 */
91 #define ERROR_OK (0)
92 #define ERROR_INVALID_ARGUMENTS (-1)
93 #define ERROR_NO_CONFIG_FILE (-2)
94 #define ERROR_BUF_TOO_SMALL (-3)
95
96 #endif /* ERROR_H */