Pavel Chromy: fix logging syntax error + formatting & removing obsolete comments.

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

diff --git a/src/helper/log.h b/src/helper/log.h
index 48b43d8ec36fb0c671da39bb2a58ace6a6d35f28..37490a8603d2af47bd4bc0cdbda785d785cb8e00 100644 (file)
--- a/src/helper/log.h
+++ b/src/helper/log.h
@@ -26,28 +26,31 @@
 #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, 
        const char *function, const char *format, ...) 
 __attribute__ ((format (printf, 5, 6)));
-extern void log_printfnl(enum log_levels level, const char *file, int line, 
+extern void log_printf_lf(enum log_levels level, const char *file, int line,
        const char *function, const char *format, ...) 
 __attribute__ ((format (printf, 5, 6)));
 extern int log_register_commands(struct command_context_s *cmd_ctx);
@@ -55,19 +58,20 @@ 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 (*log_callback_fn)(void *priv, const char *file, int line,
-               const char *function, const char *format, va_list args);
+               const char *function, const char *string);
 
 typedef struct log_callback_s
 {
-    log_callback_fn fn;
+       log_callback_fn fn;
        void *priv;
-    struct log_callback_s *next;
+       struct log_callback_s *next;
 } log_callback_t;
 
 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,41 +79,29 @@ extern int debug_level;
  * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
 
 
-#define DEBUG(expr ...) \
-       do { if (debug_level >= LOG_DEBUG) \
-               log_printfnl (LOG_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr); \
-       } while(0)
+#define LOG_DEBUG(expr ...) \
+               ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
 
-#define INFO(expr ...) \
-       do { if (debug_level >= LOG_INFO) \
-               log_printfnl (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr); \
-       } while(0)
+#define LOG_INFO(expr ...) \
+               log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
 
-#define WARNING(expr ...) \
-       do { \
-               log_printfnl (LOG_WARNING, __FILE__, __LINE__, __FUNCTION__, expr); \
-       } while(0)
+#define LOG_INFO_N(expr ...) \
+               log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
 
-#define ERROR(expr ...) \
-       do { \
-               log_printfnl (LOG_ERROR, __FILE__, __LINE__, __FUNCTION__, expr); \
-       } while(0)
+#define LOG_WARNING(expr ...) \
+               log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
 
-#define USER(expr ...) \
-       do { \
-               log_printfnl (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr); \
-       } while(0)
+#define LOG_ERROR(expr ...) \
+               log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
 
-#define USER_SAMELINE(expr ...) \
-       do { \
-               log_printf (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr); \
-       } while(0)
+#define LOG_USER(expr ...) \
+               log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
 
-#define OUTPUT(expr ...) \
-       do { \
-               log_printfnl (LOG_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr); \
-       } while(0)
+#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
@@ -118,5 +110,9 @@ extern int debug_level;
 #define ERROR_INVALID_ARGUMENTS                (-1)
 #define ERROR_NO_CONFIG_FILE           (-2)
 #define ERROR_BUF_TOO_SMALL                    (-3)
+/* see "Error:" message 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 */