- Added a "User:" debug level. These are messages that are intended for the user...

[openocd.git] / src / helper / log.h

diff --git a/src/helper/log.h b/src/helper/log.h
index c495524cb8abb6e3787b1df633cc66aeecc94f41..ab32760a96b3c7e2190d8856d7874d76b24deae6 100644 (file)
--- a/src/helper/log.h
+++ b/src/helper/log.h
@@ -20,11 +20,15 @@
 #ifndef ERROR_H
 #define ERROR_H
 
+#include "replacements.h"
 #include "command.h"
 
 #include <stdarg.h>
 
 /* logging priorities 
+ * LOG_USER - user messages. Could be anything from information 
+ *            to progress messags. These messages do not represent
+ *            incorrect or unexpected behaviour, just normal execution. 
  * LOG_ERROR - fatal errors, that are likely to cause program abort
  * LOG_WARNING - non-fatal errors, that may be resolved later
  * LOG_INFO - state information, etc.
@@ -32,6 +36,7 @@
  */
 enum log_levels
 {
+       LOG_USER = -1,
        LOG_ERROR = 0,
        LOG_WARNING = 1,
        LOG_INFO = 2,
@@ -39,19 +44,29 @@ enum log_levels
 };
 
 extern void log_printf(enum log_levels level, const char *file, int line, 
-       const char *function, const char *format, ...);
+       const char *function, const char *format, ...) 
+       __attribute__ ((format (printf, 5, 6)));
 extern int log_register_commands(struct command_context_s *cmd_ctx);
 extern int log_init(struct command_context_s *cmd_ctx);
+extern int set_log_output(struct command_context_s *cmd_ctx, FILE *output);
+
+typedef void (*logCallback)(void *priv, const char *file, int line, 
+               const char *function, const char *format, va_list args);
+
+extern void log_setCallback(logCallback callback, void *priv);         
 
 extern int debug_level;
 
+/* Avoid fn call and building parameter list if we're not outputting the information.
+ * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
+
 #define DEBUG(expr ...) \
-       do { \
+       do { if (debug_level >= LOG_DEBUG) \
                log_printf (LOG_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr); \
        } while(0)
 
 #define INFO(expr ...) \
-       do { \
+       do { if (debug_level >= LOG_INFO) \
                log_printf (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr); \
        } while(0)
 
@@ -65,25 +80,11 @@ extern int debug_level;
                log_printf (LOG_ERROR, __FILE__, __LINE__, __FUNCTION__, expr); \
        } while(0)
 
-#define SDEBUG(expr ...) \
-       do { \
-               short_log_printf (LOG_DEBUG, expr); \
-       } while(0)
-
-#define SINFO(expr ...) \
+#define USER(expr ...) \
        do { \
-               short_log_printf (LOG_INFO, expr); \
+               log_printf (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr); \
        } while(0)
 
-#define SWARNING(expr ...) \
-       do { \
-               short_log_printf (LOG_WARNING, expr); \
-       } while(0)
-
-#define SERROR(expr ...) \
-       do { \
-               short_log_printf (LOG_ERROR, expr); \
-       } while(0)
 
 /* general failures
  * error codes < 100
@@ -93,4 +94,6 @@ extern int debug_level;
 #define ERROR_NO_CONFIG_FILE           (-2)
 #define ERROR_BUF_TOO_SMALL                    (-3)
 
-#endif /* ERROR_H */
+char *allocPrintf(const char *fmt, va_list ap);
+
+#endif /* LOG_H */