X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Flog.h;h=c329fb5881d6a478cef52315a2aa9a504812c3b4;hp=c40784474e3120f0f8cc94d41258aa1c7ac30ba9;hb=f370d70670bd5e30befe6fbfbc8d472e760f032b;hpb=67e0aea25850b8286f750e6458e5de741e6cb3b5

diff --git a/src/helper/log.h b/src/helper/log.h
index c40784474e..c329fb5881 100644
--- a/src/helper/log.h
+++ b/src/helper/log.h
@@ -2,6 +2,9 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                      *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
@@ -26,22 +29,25 @@
 #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.
- * LOG_DEBUG - debug statements, execution trace
+ * LOG_LVL_SILENT - turn off all output. In lieu of try+catch this can be used as a 
+ *                  feeble ersatz.
+ * LOG_LVL_USER - user messages. Could be anything from information 
+ *                to progress messags. These messages do not represent
+ *                incorrect or unexpected behaviour, just normal execution. 
+ * LOG_LVL_ERROR - fatal errors, that are likely to cause program abort
+ * LOG_LVL_WARNING - non-fatal errors, that may be resolved later
+ * LOG_LVL_INFO - state information, etc.
+ * LOG_LVL_DEBUG - debug statements, execution trace
  */
 enum log_levels
 {
-	LOG_OUTPUT = -2,
-	LOG_USER = -1,
-	LOG_ERROR = 0,
-	LOG_WARNING = 1,
-	LOG_INFO = 2,
-	LOG_DEBUG = 3
+	LOG_LVL_SILENT = -3,
+	LOG_LVL_OUTPUT = -2,
+	LOG_LVL_USER = -1,
+	LOG_LVL_ERROR = 0,
+	LOG_LVL_WARNING = 1,
+	LOG_LVL_INFO = 2,
+	LOG_LVL_DEBUG = 3
 };
 
 extern void log_printf(enum log_levels level, const char *file, int line, 
@@ -53,6 +59,8 @@ __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);
+extern void keep_alive(void);
+extern void kept_alive(void);
 
 typedef void (*log_callback_fn)(void *priv, const char *file, int line,
 		const char *function, const char *string);
@@ -67,7 +75,8 @@ typedef struct log_callback_s
 extern int log_add_callback(log_callback_fn fn, void *priv);
 extern int log_remove_callback(log_callback_fn fn, void *priv);
 
-char *alloc_printf(const char *fmt, va_list ap);
+char *alloc_vprintf(const char *fmt, va_list ap);
+char *alloc_printf(const char *fmt, ...);
 
 extern int debug_level;
 
@@ -75,37 +84,40 @@ extern int debug_level;
  * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
 
 
-#define DEBUG(expr ...) \
-		log_printf_lf (LOG_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr)
-
-#define INFO(expr ...) \
-		log_printf_lf (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
+#define LOG_DEBUG(expr ...) \
+		((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
 
-#define INFO_N(expr ...) \
-		log_printf (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
+#define LOG_INFO(expr ...) \
+		log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
 
-#define WARNING(expr ...) \
-		log_printf_lf (LOG_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
+#define LOG_INFO_N(expr ...) \
+		log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
 
-#define ERROR(expr ...) \
-		log_printf_lf (LOG_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
+#define LOG_WARNING(expr ...) \
+		log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
 
-#define USER(expr ...) \
-		log_printf_lf (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr)
+#define LOG_ERROR(expr ...) \
+		log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
 
-#define USER_N(expr ...) \
-		log_printf (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr)
+#define LOG_USER(expr ...) \
+		log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
 
-#define OUTPUT(expr ...) \
-		log_printf (LOG_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
+#define LOG_USER_N(expr ...) \
+		log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
 
+#define LOG_OUTPUT(expr ...) \
+		log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
 
 /* general failures
  * error codes < 100
  */
 #define ERROR_OK					(0)
-#define ERROR_INVALID_ARGUMENTS		(-1)
+#define ERROR_INVALID_ARGUMENTS		ERROR_COMMAND_SYNTAX_ERROR
 #define ERROR_NO_CONFIG_FILE		(-2)
 #define ERROR_BUF_TOO_SMALL			(-3)
+/* see "Error:" log entry for meaningful message to the user. The caller should 
+ * make no assumptions about what went wrong and try to handle the problem.
+ */
+#define ERROR_FAIL       			(-4)
 
 #endif /* LOG_H */