X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Flog.h;h=3bf9840a9fc2833fbe3566010ea3c5cc07d7f984;hp=afe5da893ca2f156a4d4d570f42f7c92b7178a39;hb=98723c4ecdbe06f90c66f3abec27b792c3b38e34;hpb=74eb754abcb49bd8a61b42398ba80d1a895a4604 diff --git a/src/helper/log.h b/src/helper/log.h index afe5da893c..3bf9840a9f 100644 --- a/src/helper/log.h +++ b/src/helper/log.h @@ -2,6 +2,12 @@ * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * + * Copyright (C) 2007,2008 Øyvind Harboe * + * oyvind.harboe@zylin.com * + * * + * Copyright (C) 2008 by Spencer Oliver * + * spen@spen-soft.co.uk * + * * * 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 * @@ -20,17 +26,23 @@ #ifndef ERROR_H #define ERROR_H -#include "replacements.h" #include "command.h" -#include - -/* logging priorities - * LOG_LVL_SILENT - turn off all output. In lieu of try+catch this can be used as a +/* 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 * feeble ersatz. - * LOG_LVL_USER - user messages. Could be anything from information + * 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. + * 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. @@ -47,30 +59,43 @@ 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(); -extern void kept_alive(); - -typedef void (*log_callback_fn)(void *priv, const char *file, int line, +void log_printf(enum log_levels level, const char *file, int 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, int line, + const char *function, const char *format, ...) +__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6))); + +int log_init(struct command_context *cmd_ctx); +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(int ms); +void busy_sleep(int ms); + +/* log entries can be paused and replayed roughly according to the try/catch/rethrow + * concepts in C++ + */ +void log_try(void); +void log_catch(void); +void log_rethrow(void); + + +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, ...); @@ -80,6 +105,7 @@ 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 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) @@ -112,9 +138,9 @@ extern int debug_level; #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 +/* 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 */