corrective fix for MinGW GNU C99 printf compliance
[openocd.git] / src / helper / log.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifndef ERROR_H
27 #define ERROR_H
28
29 #include "command.h"
30
31 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
32 * used for __attribute__((format( ... ))), with GCC v4.4 or later
33 */
34 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
35 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
36 #else
37 #define PRINTF_ATTRIBUTE_FORMAT printf
38 #endif
39
40 /* logging priorities
41 * LOG_LVL_SILENT - turn off all output. In lieu of try + catch this can be used as a
42 * feeble ersatz.
43 * LOG_LVL_USER - user messages. Could be anything from information
44 * to progress messags. These messages do not represent
45 * incorrect or unexpected behaviour, just normal execution.
46 * LOG_LVL_ERROR - fatal errors, that are likely to cause program abort
47 * LOG_LVL_WARNING - non-fatal errors, that may be resolved later
48 * LOG_LVL_INFO - state information, etc.
49 * LOG_LVL_DEBUG - debug statements, execution trace
50 */
51 enum log_levels
52 {
53 LOG_LVL_SILENT = -3,
54 LOG_LVL_OUTPUT = -2,
55 LOG_LVL_USER = -1,
56 LOG_LVL_ERROR = 0,
57 LOG_LVL_WARNING = 1,
58 LOG_LVL_INFO = 2,
59 LOG_LVL_DEBUG = 3
60 };
61
62 extern void log_printf(enum log_levels level, const char *file, int line,
63 const char *function, const char *format, ...)
64 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
65 extern void log_printf_lf(enum log_levels level, const char *file, int line,
66 const char *function, const char *format, ...)
67 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
68 extern int log_register_commands(struct command_context_s *cmd_ctx);
69 extern int log_init(struct command_context_s *cmd_ctx);
70 extern int set_log_output(struct command_context_s *cmd_ctx, FILE *output);
71 extern void keep_alive(void);
72 extern void kept_alive(void);
73 extern void alive_sleep(int ms);
74 extern void busy_sleep(int ms);
75
76
77 /* log entries can be paused and replayed roughly according to the try/catch/rethrow
78 * concepts in C++
79 */
80 void log_try(void);
81 void log_catch(void);
82 void log_rethrow(void);
83
84
85 typedef void (*log_callback_fn)(void *priv, const char *file, int line,
86 const char *function, const char *string);
87
88 typedef struct log_callback_s
89 {
90 log_callback_fn fn;
91 void *priv;
92 struct log_callback_s *next;
93 } log_callback_t;
94
95 extern int log_add_callback(log_callback_fn fn, void *priv);
96 extern int log_remove_callback(log_callback_fn fn, void *priv);
97
98 char *alloc_vprintf(const char *fmt, va_list ap);
99 char *alloc_printf(const char *fmt, ...);
100
101 extern int debug_level;
102
103 /* Avoid fn call and building parameter list if we're not outputting the information.
104 * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
105
106 #define LOG_LEVEL_IS(FOO) ((debug_level) >= (FOO))
107
108 #define LOG_DEBUG(expr ...) \
109 ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
110
111 #define LOG_INFO(expr ...) \
112 log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
113
114 #define LOG_INFO_N(expr ...) \
115 log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
116
117 #define LOG_WARNING(expr ...) \
118 log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
119
120 #define LOG_ERROR(expr ...) \
121 log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
122
123 #define LOG_USER(expr ...) \
124 log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
125
126 #define LOG_USER_N(expr ...) \
127 log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
128
129 #define LOG_OUTPUT(expr ...) \
130 log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
131
132 /* general failures
133 * error codes < 100
134 */
135 #define ERROR_OK (0)
136 #define ERROR_INVALID_ARGUMENTS ERROR_COMMAND_SYNTAX_ERROR
137 #define ERROR_NO_CONFIG_FILE (-2)
138 #define ERROR_BUF_TOO_SMALL (-3)
139 /* see "Error:" log entry for meaningful message to the user. The caller should
140 * make no assumptions about what went wrong and try to handle the problem.
141 */
142 #define ERROR_FAIL (-4)
143
144 #endif /* LOG_H */