ioutil: make the file compile on MacOS

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

diff --git a/src/helper/log.h b/src/helper/log.h
index c3be0747ad6d44c723cb9ae6e1af457705f505a3..e161a6ea2b00b66d1b36143ea9c711f946a18c2b 100644 (file)
--- a/src/helper/log.h
+++ b/src/helper/log.h
@@ -23,10 +23,20 @@
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
 #ifndef ERROR_H
 #define ERROR_H
 
-#include "command.h"
+#include <helper/command.h>
+
+/* To achieve C99 printf compatibility in MinGW, gnu_printf should be
+ * used for __attribute__((format( ... ))), with GCC v4.4 or later
+ */
+#if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
+#define PRINTF_ATTRIBUTE_FORMAT gnu_printf
+#else
+#define PRINTF_ATTRIBUTE_FORMAT printf
+#endif
 
 /* logging priorities
  * LOG_LVL_SILENT - turn off all output. In lieu of try + catch this can be used as a
@@ -39,8 +49,7 @@
  * LOG_LVL_INFO - state information, etc.
  * LOG_LVL_DEBUG - debug statements, execution trace
  */
-enum log_levels
-{
+enum log_levels {
        LOG_LVL_SILENT = -3,
        LOG_LVL_OUTPUT = -2,
        LOG_LVL_USER = -1,
@@ -50,32 +59,38 @@ enum log_levels
        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_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);
-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);
-extern void alive_sleep(int ms);
-extern void busy_sleep(int ms);
-
-typedef void (*log_callback_fn)(void *priv, const char *file, int line,
+void log_printf(enum log_levels level, const char *file, unsigned line,
+               const char *function, const char *format, ...)
+__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
+void log_printf_lf(enum log_levels level, const char *file, unsigned line,
+               const char *function, const char *format, ...)
+__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
+
+/**
+ * Initialize logging module.  Call during program startup.
+ */
+void log_init(void);
+int set_log_output(struct command_context *cmd_ctx, FILE *output);
+
+int log_register_commands(struct command_context *cmd_ctx);
+
+void keep_alive(void);
+void kept_alive(void);
+
+void alive_sleep(uint64_t ms);
+void busy_sleep(uint64_t ms);
+
+typedef void (*log_callback_fn)(void *priv, const char *file, unsigned line,
                const char *function, const char *string);
 
-typedef struct log_callback_s
-{
+struct log_callback {
        log_callback_fn fn;
        void *priv;
-       struct log_callback_s *next;
-} log_callback_t;
+       struct log_callback *next;
+};
 
-extern int log_add_callback(log_callback_fn fn, void *priv);
-extern int log_remove_callback(log_callback_fn fn, void *priv);
+int log_add_callback(log_callback_fn fn, void *priv);
+int log_remove_callback(log_callback_fn fn, void *priv);
 
 char *alloc_vprintf(const char *fmt, va_list ap);
 char *alloc_printf(const char *fmt, ...);
@@ -88,39 +103,40 @@ extern int debug_level;
 #define LOG_LEVEL_IS(FOO)  ((debug_level) >= (FOO))
 
 #define LOG_DEBUG(expr ...) \
-               ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
+       do { \
+               if (debug_level >= LOG_LVL_DEBUG) \
+                       log_printf_lf(LOG_LVL_DEBUG, \
+                               __FILE__, __LINE__, __func__, \
+                               expr); \
+       } while (0)
 
 #define LOG_INFO(expr ...) \
-               log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
-
-#define LOG_INFO_N(expr ...) \
-               log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf_lf(LOG_LVL_INFO, __FILE__, __LINE__, __func__, expr)
 
 #define LOG_WARNING(expr ...) \
-               log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf_lf(LOG_LVL_WARNING, __FILE__, __LINE__, __func__, expr)
 
 #define LOG_ERROR(expr ...) \
-               log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf_lf(LOG_LVL_ERROR, __FILE__, __LINE__, __func__, expr)
 
 #define LOG_USER(expr ...) \
-               log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf_lf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
 
 #define LOG_USER_N(expr ...) \
-               log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
 
 #define LOG_OUTPUT(expr ...) \
-               log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf(LOG_LVL_OUTPUT, __FILE__, __LINE__, __func__, expr)
 
 /* general failures
  * error codes < 100
  */
-#define ERROR_OK                                       (0)
-#define ERROR_INVALID_ARGUMENTS                ERROR_COMMAND_SYNTAX_ERROR
-#define ERROR_NO_CONFIG_FILE           (-2)
-#define ERROR_BUF_TOO_SMALL                    (-3)
+#define ERROR_OK                                               (0)
+#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)
+#define ERROR_FAIL                                             (-4)
 
-#endif /* LOG_H */
+#endif /* LOG_H */