X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2ea79162b045f519a573e82448ee6c5df68d84ae..5fda94ac3d246037758dab959b3dfc9a071ccc26:/include/xbt/log.h diff --git a/include/xbt/log.h b/include/xbt/log.h index 361472f628..6264c59aa5 100644 --- a/include/xbt/log.h +++ b/include/xbt/log.h @@ -1,6 +1,6 @@ /* log - a generic logging facility in the spirit of log4j */ -/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -33,7 +33,7 @@ #include /* NULL */ #include /* FILE */ #include -SG_BEGIN_DECL() +SG_BEGIN_DECL /**@brief Log priorities * @ingroup XBT_log * @@ -46,7 +46,7 @@ typedef enum { xbt_log_priority_trace = 1, /**< enter and return of some functions */ xbt_log_priority_debug = 2, /**< crufty output */ xbt_log_priority_verbose = 3, /**< verbose output for the user wanting more */ - xbt_log_priority_info = 4, /**< output about the regular functionning */ + xbt_log_priority_info = 4, /**< output about the regular functioning */ xbt_log_priority_warning = 5, /**< minor issue encountered */ xbt_log_priority_error = 6, /**< issue encountered */ xbt_log_priority_critical = 7, /**< major issue encountered */ @@ -84,10 +84,8 @@ typedef enum { #endif /* !defined(NLOG) */ /* Transforms a category name to a global variable name. */ -#define _XBT_LOGV(cat) _XBT_LOG_CONCAT(_simgrid_log_category__, cat) -#define _XBT_LOGV_CTOR(cat) _XBT_LOG_CONCAT2(_XBT_LOGV(cat), __constructor__) -#define _XBT_LOG_CONCAT(x, y) x ## y -#define _XBT_LOG_CONCAT2(x, y) _XBT_LOG_CONCAT(x, y) +#define _XBT_LOGV(cat) _XBT_CONCAT(_simgrid_log_category__, cat) +#define _XBT_LOGV_CTOR(cat) _XBT_CONCAT2(_XBT_LOGV(cat), __constructor__) /* The root of the category hierarchy. */ #define XBT_LOG_ROOT_CAT root @@ -104,8 +102,9 @@ typedef enum { * Implementation of XBT_LOG_NEW_SUBCATEGORY, which must declare "extern parent" in addition to avoid an extra * declaration of root when XBT_LOG_NEW_SUBCATEGORY is called by XBT_LOG_NEW_CATEGORY */ #define XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \ - SG_BEGIN_DECL() \ + SG_BEGIN_DECL \ extern void _XBT_LOGV_CTOR(catName)(void) XBT_ATTRIB_CONSTRUCTOR(600); \ + SG_END_DECL \ void _XBT_LOGV_CTOR(catName)(void) \ { \ XBT_LOG_EXTERNAL_CATEGORY(catName); \ @@ -113,13 +112,12 @@ typedef enum { _xbt_log_cat_init(&_XBT_LOGV(catName), xbt_log_priority_uninitialized); \ } \ } \ - SG_END_DECL() \ XBT_EXPORT_NO_IMPORT s_xbt_log_category_t _XBT_LOGV(catName) = { \ &_XBT_LOGV(parent), \ NULL /* firstChild */, \ NULL /* nextSibling */, \ - #catName, \ - desc, \ + _XBT_STRINGIFY(catName), \ + (desc), \ 0 /*initialized */, \ xbt_log_priority_uninitialized /* threshold */, \ 1 /* isThreshInherited */, \ @@ -137,9 +135,9 @@ typedef enum { * * Defines a new subcategory of the parent. */ -#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc) \ - XBT_LOG_EXTERNAL_CATEGORY(parent); \ - XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) +#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc) \ + XBT_LOG_EXTERNAL_CATEGORY(parent); \ + XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, (desc)) /** * @ingroup XBT_log @@ -149,8 +147,7 @@ typedef enum { * * Creates a new subcategory of the root category. */ -# define XBT_LOG_NEW_CATEGORY(catName,desc) \ - XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc) +#define XBT_LOG_NEW_CATEGORY(catName, desc) XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, (desc)) /** * @ingroup XBT_log @@ -176,9 +173,9 @@ typedef enum { * Creates a new subcategory of the root category and makes it the default (used by macros that don't explicitly * specify a category). */ -# define XBT_LOG_NEW_DEFAULT_CATEGORY(cname,desc) \ - XBT_LOG_NEW_CATEGORY(cname,desc); \ - XBT_LOG_DEFAULT_CATEGORY(cname) +#define XBT_LOG_NEW_DEFAULT_CATEGORY(cname, desc) \ + XBT_LOG_NEW_CATEGORY(cname, (desc)); \ + XBT_LOG_DEFAULT_CATEGORY(cname) /** * @ingroup XBT_log @@ -190,9 +187,9 @@ typedef enum { * Creates a new subcategory of the parent category and makes it the default * (used by macros that don't explicitly specify a category). */ -#define XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cname, parent, desc) \ - XBT_LOG_NEW_SUBCATEGORY(cname, parent, desc); \ - XBT_LOG_DEFAULT_CATEGORY(cname) +#define XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cname, parent, desc) \ + XBT_LOG_NEW_SUBCATEGORY(cname, parent, (desc)); \ + XBT_LOG_DEFAULT_CATEGORY(cname) /** * @ingroup XBT_log @@ -263,7 +260,7 @@ struct xbt_log_event_s { * @param cat the category (not only its name, but the variable) * @param thresholdPriority the priority * - * Programatically alters a category's threshold priority (don't use). + * Programmatically alters a category's threshold priority (don't use). */ XBT_PUBLIC void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t thresholdPriority); @@ -272,7 +269,7 @@ XBT_PUBLIC void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority * @param cat the category (not only its name, but the variable) * @param app the appender * - * Programatically sets the category's appender. (the preferred interface is through xbt_log_control_set()) + * Programmatically sets the category's appender. (the preferred interface is through xbt_log_control_set()) */ XBT_PUBLIC void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app); /** @@ -280,7 +277,7 @@ XBT_PUBLIC void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t * @param cat the category (not only its name, but the variable) * @param lay the layout * - * Programatically sets the category's layout. (the preferred interface is through xbt_log_control_set()) + * Programmatically sets the category's layout. (the preferred interface is through xbt_log_control_set()) */ XBT_PUBLIC void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay); @@ -289,7 +286,7 @@ XBT_PUBLIC void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay) * @param cat the category (not only its name, but the variable) * @param additivity whether logging actions must be passed to parent. * - * Programatically sets whether the logging actions must be passed to the parent category. + * Programmatically sets whether the logging actions must be passed to the parent category. * (the preferred interface is through xbt_log_control_set()) */ XBT_PUBLIC void xbt_log_additivity_set(xbt_log_category_t cat, int additivity); @@ -338,8 +335,7 @@ extern xbt_log_layout_t xbt_log_default_layout; * If you have expensive expressions that are computed outside of the log command and used only within it, you should * make its evaluation conditional using this macro. */ -#define XBT_LOG_ISENABLED(catName, priority) \ - _XBT_LOG_ISENABLEDV(_XBT_LOGV(catName), priority) +#define XBT_LOG_ISENABLED(catName, priority) _XBT_LOG_ISENABLEDV(_XBT_LOGV(catName), (priority)) /* * Helper function that implements XBT_LOG_ISENABLED. @@ -348,10 +344,9 @@ extern xbt_log_layout_t xbt_log_default_layout; * First part is a compile-time constant. * Call to xbt_log_cat_init only happens once. */ -#define _XBT_LOG_ISENABLEDV(catv, priority) \ - (priority >= XBT_LOG_STATIC_THRESHOLD \ - && ((catv).initialized || _xbt_log_cat_init(&(catv), priority)) \ - && priority >= (catv).threshold) +#define _XBT_LOG_ISENABLEDV(catv, priority) \ + ((priority) >= XBT_LOG_STATIC_THRESHOLD && ((catv).initialized || _xbt_log_cat_init(&(catv), (priority))) && \ + (priority) >= (catv).threshold) /* * Internal Macros @@ -378,7 +373,7 @@ extern xbt_log_layout_t xbt_log_default_layout; #define XBT_CLOG(category, prio, ...) \ do { \ - if (_XBT_LOG_ISENABLEDV((category), prio)) { \ + if (_XBT_LOG_ISENABLEDV((category), (prio))) { \ s_xbt_log_event_t _log_ev; \ _log_ev.cat = &(category); \ _log_ev.priority = (prio); \ @@ -389,7 +384,7 @@ extern xbt_log_layout_t xbt_log_default_layout; } \ } while (0) -#define XBT_LOG(prio, ...) XBT_CLOG(*_simgrid_log_category__default, prio, __VA_ARGS__) +#define XBT_LOG(prio, ...) XBT_CLOG(*_simgrid_log_category__default, (prio), __VA_ARGS__) #endif @@ -470,10 +465,8 @@ extern xbt_log_layout_t xbt_log_default_layout; #define _XBT_IN_OUT(...) \ _XBT_IF_ONE_ARG(_XBT_IN_OUT_ARG1, _XBT_IN_OUT_ARGN, __VA_ARGS__)(__VA_ARGS__) -#define _XBT_IN_OUT_ARG1(fmt) \ - XBT_LOG(xbt_log_priority_trace, fmt, __func__) -#define _XBT_IN_OUT_ARGN(fmt, ...) \ - XBT_LOG(xbt_log_priority_trace, fmt, __func__, __VA_ARGS__) +#define _XBT_IN_OUT_ARG1(fmt) XBT_LOG(xbt_log_priority_trace, (fmt), __func__) +#define _XBT_IN_OUT_ARGN(fmt, ...) XBT_LOG(xbt_log_priority_trace, (fmt), __func__, __VA_ARGS__) /** @ingroup XBT_log * @hideinitializer @@ -499,5 +492,5 @@ extern xbt_log_layout_t xbt_log_default_layout; */ #define XBT_HELP(...) XBT_CINFO(xbt_help, __VA_ARGS__) -SG_END_DECL() -#endif /* ! _XBT_LOG_H_ */ +SG_END_DECL +#endif /* XBT_LOG_H */