624aa29cee1404dee1bfc21419441f6d44be8211
[mw/openocd-lm32.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_USER - user messages. Could be anything from information 
30  *            to progress messags. These messages do not represent
31  *            incorrect or unexpected behaviour, just normal execution. 
32  * LOG_ERROR - fatal errors, that are likely to cause program abort
33  * LOG_WARNING - non-fatal errors, that may be resolved later
34  * LOG_INFO - state information, etc.
35  * LOG_DEBUG - debug statements, execution trace
36  */
37 enum log_levels
38 {
39         LOG_OUTPUT = -2,
40         LOG_USER = -1,
41         LOG_ERROR = 0,
42         LOG_WARNING = 1,
43         LOG_INFO = 2,
44         LOG_DEBUG = 3
45 };
46
47 extern void log_printf(enum log_levels level, const char *file, int line, 
48         const char *function, const char *format, ...) 
49 __attribute__ ((format (printf, 5, 6)));
50 extern void log_printfnl(enum log_levels level, const char *file, int line, 
51         const char *function, const char *format, ...) 
52 __attribute__ ((format (printf, 5, 6)));
53 extern int log_register_commands(struct command_context_s *cmd_ctx);
54 extern int log_init(struct command_context_s *cmd_ctx);
55 extern int set_log_output(struct command_context_s *cmd_ctx, FILE *output);
56
57 typedef void (*log_callback_fn)(void *priv, const char *file, int line,
58                 const char *function, const char *format, va_list args);
59
60 typedef struct log_callback_s
61 {
62     log_callback_fn fn;
63         void *priv;
64     struct log_callback_s *next;
65 } log_callback_t;
66
67 extern int log_add_callback(log_callback_fn fn, void *priv);
68 extern int log_remove_callback(log_callback_fn fn, void *priv);
69
70 char *alloc_printf(const char *fmt, va_list ap);
71
72 extern int debug_level;
73
74 /* Avoid fn call and building parameter list if we're not outputting the information.
75  * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
76
77
78 #define DEBUG(expr ...) \
79         do { if (debug_level >= LOG_DEBUG) \
80                 log_printfnl (LOG_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr); \
81         } while(0)
82
83 #define INFO(expr ...) \
84         do { if (debug_level >= LOG_INFO) \
85                 log_printfnl (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr); \
86         } while(0)
87
88 #define INFO_SAMELINE(expr ...) \
89         do { if (debug_level >= LOG_INFO) \
90                 log_printf (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr); \
91         } while(0)
92
93 #define WARNING(expr ...) \
94         do { \
95                 log_printfnl (LOG_WARNING, __FILE__, __LINE__, __FUNCTION__, expr); \
96         } while(0)
97
98 #define ERROR(expr ...) \
99         do { \
100                 log_printfnl (LOG_ERROR, __FILE__, __LINE__, __FUNCTION__, expr); \
101         } while(0)
102
103 #define USER(expr ...) \
104         do { \
105                 log_printfnl (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr); \
106         } while(0)
107
108 #define USER_SAMELINE(expr ...) \
109         do { \
110                 log_printf (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr); \
111         } while(0)
112
113 #define OUTPUT(expr ...) \
114         do { \
115                 log_printfnl (LOG_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr); \
116         } while(0)
117
118
119 /* general failures
120  * error codes < 100
121  */
122 #define ERROR_OK                                        (0)
123 #define ERROR_INVALID_ARGUMENTS         (-1)
124 #define ERROR_NO_CONFIG_FILE            (-2)
125 #define ERROR_BUF_TOO_SMALL                     (-3)
126
127 #endif /* LOG_H */