X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fcfg%2Flog.h;h=9318697de97e81ad19eac2c3b7cd5f7fce23efe0;hb=37efb5bdc0504ab6df2e8db0635c9c6f7477e23e;hp=063f16252fddc01c2d917d86f93030c4450813a8;hpb=bae32100e6d844c07afdbfcddb616f508fb1b978;p=bertos.git diff --git a/bertos/cfg/log.h b/bertos/cfg/log.h index 063f1625..9318697d 100644 --- a/bertos/cfg/log.h +++ b/bertos/cfg/log.h @@ -27,7 +27,7 @@ * the GNU General Public License. * * Copyright 2008 Develer S.r.l. (http://www.develer.com/) - * All Rights Reserved. + * * --> * * \brief Logging system module. @@ -35,9 +35,9 @@ * This module implement a simple interface to use the multi level logging system. * The log message have the priority order, like this: * - * - error message (most hight) - * - warning message - * - info message (most low) + * - error message (highest) + * - warning message + * - info message (lowest) * * With this priority system we can log only the message that have egual or major * priority than log level that you has been configurate. Further you can have a @@ -50,56 +50,43 @@ * To use logging system you should include this module in your drive and use * a LOG_ERROR, LOG_WARNING and LOG_INFO macros to set the level log of the message. * Then you should define a LOG_LEVEL and LOG_VERBOSE costant in your - * cfg/cfg_.h using the follow police: + * \c cfg/cfg_\.h using the follow policy: * - * - in your file cfg/cfg_.h, you define the logging + * - in your file \c cfg/cfg_\.h, you define the logging * level and verbosity mode for your specific module: * * \code + * /// Module logging level. + * #define _LOG_LEVEL LOG_LVL_INFO * - * ** - * * Logging level definition. - * * - * * Use 0 to log only the error messages - * * Use 1 to log the error and warning messages - * * Use 2 to log all messages - * * - * #define _LOG_LEVEL 2 - * - * ** - * * Set logging verbosity. - * * - * * If verbose is zero print short log messages. - * * - * #define _LOG_VERBOSE 1 - * + * /// Module logging format. + * #define _LOG_FORMAT LOG_FMT_VERBOSE * \endcode * * - then, in the module that you use a logging macros you should define - * a LOG_LEVEL and LOG_VERBOSE using the previous value that you have define - * in cfg_.h header. After this you should include the cfg/log.h + * a LOG_LEVEL and LOG_FORMAT using the previous value that you have define + * in cfg_.h header. After this you should include the cfg/log.h * module: * * \code - * - * // Define logging setting (for cfg/log.h module). - * #define LOG_LEVEL _LOG_LEVEL - * #define LOG_VERBOSE _LOG_VERBOSE + * // Define log settings for cfg/log.h. + * #define LOG_LEVEL _LOG_LEVEL + * #define LOG_FORMAT _LOG_FORMAT * #include - * * \endcode * * if you include a log.h module without define the LOG_LEVEL and LOG_VERBOSE * macros, the module use the default setting (see below). * * WARNING: when use the log.h module, and you want to set a your log level - * make sure to include this module after a cfg_.h, because the - * LOG_LEVEL and LOG_VERBOSE macros must be define before to include log module, + * make sure to include this module after a \c cfg_.h, because the + * LOG_LEVEL and LOG_VERBOSE macros must be defined before to include log module, * otherwise the log module use a default settings. * * \version $Id$ - * * \author Daniele Basile + * + * $WIZ$ */ #ifndef CFG_LOG_H @@ -108,73 +95,69 @@ #include -// Use a default setting if nobody have define a log level +// Use a default setting if nobody defined a log level #ifndef LOG_LEVEL #define LOG_LEVEL LOG_LVL_ERR #endif -// Use a default setting if nobody have define a log verbosity -#ifndef LOG_VERBOSITY -#define LOG_VERBOSITY LOG_SILENT +// Use a default setting if nobody defined a log format +#ifndef LOG_FORMAT +#define LOG_FORMAT LOG_FMT_TERSE #endif /** -* Multi level logging system. -* -* You can use these macro directy or using the cfg/log.h module -* that provide a simple interface for using the logging multilevel system. -* The priority level is order form error messages (hight priority) to info messages -* (low priority), so if you choose a low level log message you can see also all message -* that have a hight priority. -* -* \{ -*/ -/// Logging level definition -#define LOG_LVL_ERR 0 -#define LOG_LVL_WARN 1 -#define LOG_LVL_INFO 2 - -/// Logging verbose mode -#define LOG_VERBOSE 1 -#define LOG_SILENT 0 - - -#if LOG_VERBOSITY == LOG_VERBOSE - #define LOG_PRINT(str_level, str,...) kprintf("%s(%s():%d): "str, str_level, __func__, __LINE__, ## __VA_ARGS__) - -#elif LOG_VERBOSITY == LOG_SILENT - #define LOG_PRINT(str_level, str,...) kprintf("%s: "str, str_level, ## __VA_ARGS__) - -#else - #error No log verbosity defined - -#endif - -/** - * Log message level select. + * \name Logging level definition + * * When you choose a log level messages you choose * also which print function are linked. * If you choose a low level of log you link all log function (error, warning and info), * but if choose a hight level you link only that have the priority egual or hight. - * The priority level go from error (most hight) to info (most low) (see cfg/debug.h + * The priority level go from error (highest) to info (lowest) (see cfg/debug.h * for more detail). * + * $WIZ$ log_level = "LOG_LVL_NONE", "LOG_LVL_ERR", "LOG_LVL_WARN", "LOG_LVL_INFO" + * } */ -#define LOG_ERR(str,...) LOG_PRINT("ERR", str, ## __VA_ARGS__) +#define LOG_LVL_NONE 0 +#define LOG_LVL_ERR 1 +#define LOG_LVL_WARN 2 +#define LOG_LVL_INFO 3 -#if (LOG_LEVEL <= LOG_LVL_INFO) - #define LOG_WARN(str,...) LOG_PRINT("WARN", str, ## __VA_ARGS__) - #define LOG_INFO(str,...) LOG_PRINT("INFO", str, ## __VA_ARGS__) +/** + * \name Logging format + * + * There are two logging format: terse and verbose. The latter prepends + * function names and line number information to each log entry. + * + * $WIZ$ log_format = "LOG_FMT_VERBOSE", "LOG_FMT_TERSE" + */ +#define LOG_FMT_VERBOSE 1 +#define LOG_FMT_TERSE 0 -#elif (LOG_LEVEL <= LOG_LVL_WARN) - #define LOG_WARN(str,...) LOG_PRINT("WARN", str, ## __VA_ARGS__) - #define LOG_INFO(str,...) /* Nothing */ +#if LOG_FORMAT == LOG_FMT_VERBOSE + #define LOG_PRINT(str_level, str,...) kprintf("%s():%d:%s: " str, __func__, __LINE__, str_level, ## __VA_ARGS__) +#elif LOG_FORMAT == LOG_FMT_TERSE + #define LOG_PRINT(str_level, str,...) kprintf("%s: " str, str_level, ## __VA_ARGS__) +#else + #error No LOG_FORMAT defined +#endif + +#if LOG_LEVEL >= LOG_LVL_ERR + #define LOG_ERR(str,...) LOG_PRINT("ERR", str, ## __VA_ARGS__) +#else + #define LOG_ERR(str,...) /* Nothing */ +#endif -#else /* LOG_LEVEL <= LOG_LVL_ERR */ +#if LOG_LEVEL >= LOG_LVL_WARN + #define LOG_WARN(str,...) LOG_PRINT("WARN", str, ## __VA_ARGS__) +#else #define LOG_WARN(str,...) /* Nothing */ - #define LOG_INFO(str,...) /* Nothing */ +#endif +#if LOG_LEVEL >= LOG_LVL_INFO + #define LOG_INFO(str,...) LOG_PRINT("INFO", str, ## __VA_ARGS__) +#else + #define LOG_INFO(str,...) /* Nothing */ #endif #endif /* CFG_LOG_H */ -