/* log - a generic logging facility in the spirit of log4j */
-/* Authors: Martin Quinson */
-/* Copyright (C) 2003, 2004 Martin Quinson. */
+/* Copyright (c) 2003, 2004 Martin Quinson. 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. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
/* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic
printf function. Useful to debug the logging facilities themselves */
#include "xbt/sysdep.h"
-/**
- * e_xbt_log_priority_t:
- * @xbt_log_priority_none: used internally (don't poke with)
- * @xbt_log_priority_debug: crufty output
- * @xbt_log_priority_verbose: verbose output for the user wanting more
- * @xbt_log_priority_info: output about the regular functionning
- * @xbt_log_priority_warning: minor issue encountered
- * @xbt_log_priority_error: issue encountered
- * @xbt_log_priority_critical: major issue encountered
- * @xbt_log_priority_infinite: value for XBT_LOG_STATIC_THRESHOLD to not log
- * @xbt_log_priority_uninitialized: used internally (don't poke with)
+/**\brief Log priorities
+ * \ingroup XBT_log
*
* The different existing priorities.
- */
+*/
typedef enum {
- xbt_log_priority_none = 0,
+ xbt_log_priority_none = 0, /**< used internally (don't poke with) */
xbt_log_priority_trace = 1,
- xbt_log_priority_debug = 2,
- xbt_log_priority_verbose = 3,
- xbt_log_priority_info = 4,
- xbt_log_priority_warning = 5,
- xbt_log_priority_error = 6,
- xbt_log_priority_critical = 7,
+ 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_warning = 5, /**< minor issue encountered */
+ xbt_log_priority_error = 6, /**< issue encountered */
+ xbt_log_priority_critical = 7, /**< major issue encountered */
- xbt_log_priority_infinite = 8,
+ xbt_log_priority_infinite = 8, /**< value for XBT_LOG_STATIC_THRESHOLD to not log */
- xbt_log_priority_uninitialized = -1
+ xbt_log_priority_uninitialized = -1 /**< used internally (don't poke with) */
} e_xbt_log_priority_t;
-/**
- * NLOG:
- *
- * All logging facilities are disabled at compilation time
+/*
+ * define NLOG to disable at compilation time any logging request
+ * define NDEBUG to disable at compilation time any logging request of priority below INFO
*/
/**
- * XBT_LOG_STATIC_THRESHOLD:
+ * \def XBT_LOG_STATIC_THRESHOLD:
+ * \ingroup XBT_log
*
- * All logging with priority < XBT_LOG_STATIC_THRESHOLD is disabled at
+ * All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at
* compile time, i.e., compiled out.
*/
#ifdef NLOG
#define XBT_LOG_ROOT_CAT root
/**
- * XBT_LOG_NEW_SUBCATEGORY:
- * @catName: name of new category
- * @parent: father of the new category in the tree
- * @desc: string describing the purpose of this category
+ * \ingroup XBT_log
+ * \param catName name of new category
+ * \param parent father of the new category in the tree
+ * \param desc string describing the purpose of this category
*
* Defines a new subcategory of the parent.
*/
}
/**
- * XBT_LOG_NEW_CATEGORY:
- * @catName: name of new category
- * @desc: string describing the purpose of this category
+ * \ingroup XBT_log
+ * \param catName name of new category
+ * \param desc string describing the purpose of this category
*
* Creates a new subcategory of the root category.
*/
#define XBT_LOG_NEW_CATEGORY(catName,desc) XBT_LOG_NEW_SUBCATEGORY(catName, XBT_LOG_ROOT_CAT, desc)
/**
- * XBT_LOG_DEFAULT_CATEGORY:
- * @cname: name of the cat
+ * \ingroup XBT_log
+ * \param cname name of the cat
*
* Indicates which category is the default one.
*/
#endif
/**
- * XBT_LOG_NEW_DEFAULT_CATEGORY:
- * @cname: name of the cat
- * @desc: string describing the purpose of this category
+ * \ingroup XBT_log
+ * \param cname name of the cat
+ * \param desc string describing the purpose of this category
*
* Creates a new subcategory of the root category and makes it the default
* (used by macros that don't explicitly specify a category).
XBT_LOG_DEFAULT_CATEGORY(cname)
/**
- * XBT_LOG_NEW_DEFAULT_SUBCATEGORY:
- * @cname: name of the cat
- * @parent: name of the parent
- * @desc: string describing the purpose of this category
+ * \ingroup XBT_log
+ * \param cname name of the cat
+ * \param parent name of the parent
+ * \param desc string describing the purpose of this category
*
* Creates a new subcategory of the parent category and makes it the default
* (used by macros that don't explicitly specify a category).
XBT_LOG_DEFAULT_CATEGORY(cname)
/**
- * XBT_LOG_EXTERNAL_CATEGORY:
- * @cname: name of the cat
+ * \ingroup XBT_log
+ * \param cname name of the cat
*
* Indicates that a category you'll use in this file (to get subcategories of it,
* for example) really lives in another file.
typedef struct xbt_log_event_s s_xbt_log_event_t, *xbt_log_event_t;
typedef struct xbt_log_category_s s_xbt_log_category_t,*xbt_log_category_t;
-/**
+/*
* Do NOT access any members of this structure directly. FIXME: move to private?
*/
struct xbt_log_category_s {
};
/**
- * xbt_log_threshold_set:
- * @cat: the category (not only its name, but the variable)
- * @thresholdPriority: the priority
+ * \ingroup XBT_log_implem
+ * \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).
*/
e_xbt_log_priority_t thresholdPriority);
/**
- * xbt_log_parent_set:
- * @cat: the category (not only its name, but the variable)
- * @parent: the parent cat
+ * \ingroup XBT_log_implem
+ * \param cat the category (not only its name, but the variable)
+ * \param parent the parent cat
*
* Programatically alter a category's parent (don't use).
*/
xbt_log_category_t parent);
/**
- * xbt_log_appender_set:
- * @cat: the category (not only its name, but the variable)
- * @app: the appender
+ * \ingroup XBT_log_implem
+ * \param cat the category (not only its name, but the variable)
+ * \param app the appender
*
* Programatically sets the category's appender (don't use).
*/
extern xbt_log_appender_t xbt_log_default_appender;
/**
- * XBT_LOG_ISENABLED:
- * @catName: name of the category
- * @priority: minimal priority to be enabled to return true
+ * \ingroup XBT_log
+ * \param catName name of the category
+ * \param priority minimal priority to be enabled to return true
*
* Returns true if the given priority is enabled for the category.
* If you have expensive expressions that are computed outside of the log
#define CERROR5(c, f,a1,a2,a3,a4,a5) CLOG5(c, xbt_log_priority_error, f,a1,a2,a3,a4,a5)
#define CERROR6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_error, f,a1,a2,a3,a4,a5,a6)
-/**
- * CCRITICAL6:
- * @c: the category to log into
- * @f: the format string
- * @a1: first argument of the format
- * @a2: second argument of the format
- * @a3: third argument of the format
- * @a4: fourth argument of the format
- * @a5: fifth argument of the format
- * @a6: sixth argument of the format
- *
- * Log something to the current default category under the warning priority.
- *
- * The macros CCRITICAL0 ... CCRITICAL5 naturally also exist, but are not listed here
- * for sake of clarity. They just differ in the number of arguments passed
- * along with the format string.
- */
-
#define CCRITICAL0(c, f) CLOG0(c, xbt_log_priority_critical, f)
#define CCRITICAL1(c, f,a1) CLOG1(c, xbt_log_priority_critical, f,a1)
#define CCRITICAL2(c, f,a1,a2) CLOG2(c, xbt_log_priority_critical, f,a1,a2)
# define LOG8(p, f,a1,a2,a3,a4,a5,a6,a7,a8) _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1,a2,a3,a4,a5,a6,a7,a8 _XBT_LOG_POST
#endif
-/**
- * DEBUG6:
- * @f: the format string
- * @a1: first argument of the format
- * @a2: second argument of the format
- * @a3: third argument of the format
- * @a4: fourth argument of the format
- * @a5: fifth argument of the format
- * @a6: sixth argument of the format
- *
+/** \name DEBUG
+ * \ingroup XBT_log
* Log something to the current default category under the debug priority.
+ * \param f the format string
+ * \param a1 first argument of the format
+ * \param a2 second argument of the format
+ * \param a3 third argument of the format
+ * \param a4 fourth argument of the format
+ * \param a5 fifth argument of the format
+ * \param a6 sixth argument of the format
*
* The macros DEBUG0 ... DEBUG5 naturally also exist, but are not listed here
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
-
+/*@{*/
#define DEBUG0(f) LOG0(xbt_log_priority_debug, f)
#define DEBUG1(f,a1) LOG1(xbt_log_priority_debug, f,a1)
#define DEBUG2(f,a1,a2) LOG2(xbt_log_priority_debug, f,a1,a2)
#define DEBUG6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6)
#define DEBUG7(f,a1,a2,a3,a4,a5,a6,a7) LOG7(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7)
#define DEBUG8(f,a1,a2,a3,a4,a5,a6,a7,a8) LOG8(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7,a8)
+/*@}*/
-/**
- * VERB6:
- * @f: the format string
- * @a1: first argument of the format
- * @a2: second argument of the format
- * @a3: third argument of the format
- * @a4: fourth argument of the format
- * @a5: fifth argument of the format
- * @a6: sixth argument of the format
- *
+/** \name VERB
+ * \ingroup XBT_log
* Log something to the current default category under the verbose priority.
+ * \param f the format string
+ * \param a1 first argument of the format
+ * \param a2 second argument of the format
+ * \param a3 third argument of the format
+ * \param a4 fourth argument of the format
+ * \param a5 fifth argument of the format
+ * \param a6 sixth argument of the format
*
* The macros VERB0 ... VERB5 naturally also exist, but are not listed here
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
-
+/*@{*/
#define VERB0(f) LOG0(xbt_log_priority_verbose, f)
#define VERB1(f,a1) LOG1(xbt_log_priority_verbose, f,a1)
#define VERB2(f,a1,a2) LOG2(xbt_log_priority_verbose, f,a1,a2)
#define VERB4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_verbose, f,a1,a2,a3,a4)
#define VERB5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_verbose, f,a1,a2,a3,a4,a5)
#define VERB6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_verbose, f,a1,a2,a3,a4,a5,a6)
+/*@}*/
-/**
- * INFO6:
- * @f: the format string
- * @a1: first argument of the format
- * @a2: second argument of the format
- * @a3: third argument of the format
- * @a4: fourth argument of the format
- * @a5: fifth argument of the format
- * @a6: sixth argument of the format
- *
+/** \name INFO
+ * \ingroup XBT_log
* Log something to the current default category under the info priority.
+ * \param f the format string
+ * \param a1 first argument of the format
+ * \param a2 second argument of the format
+ * \param a3 third argument of the format
+ * \param a4 fourth argument of the format
+ * \param a5 fifth argument of the format
+ * \param a6 sixth argument of the format
*
* The macros INFO0 ... INFO5 naturally also exist, but are not listed here
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
-
+/*@{*/
#define INFO0(f) LOG0(xbt_log_priority_info, f)
#define INFO1(f,a1) LOG1(xbt_log_priority_info, f,a1)
#define INFO2(f,a1,a2) LOG2(xbt_log_priority_info, f,a1,a2)
#define INFO4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_info, f,a1,a2,a3,a4)
#define INFO5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_info, f,a1,a2,a3,a4,a5)
#define INFO6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6)
+/*@}*/
-/**
- * WARN6:
- * @f: the format string
- * @a1: first argument of the format
- * @a2: second argument of the format
- * @a3: third argument of the format
- * @a4: fourth argument of the format
- * @a5: fifth argument of the format
- * @a6: sixth argument of the format
- *
+/** \name WARN
+ * \ingroup XBT_log
* Log something to the current default category under the warning priority.
+ * \param f the format string
+ * \param a1 first argument of the format
+ * \param a2 second argument of the format
+ * \param a3 third argument of the format
+ * \param a4 fourth argument of the format
+ * \param a5 fifth argument of the format
+ * \param a6 sixth argument of the format
*
* The macros WARN0 ... WARN5 naturally also exist, but are not listed here
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
-
+/*@{*/
#define WARN0(f) LOG0(xbt_log_priority_warning, f)
#define WARN1(f,a1) LOG1(xbt_log_priority_warning, f,a1)
#define WARN2(f,a1,a2) LOG2(xbt_log_priority_warning, f,a1,a2)
#define WARN4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_warning, f,a1,a2,a3,a4)
#define WARN5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_warning, f,a1,a2,a3,a4,a5)
#define WARN6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_warning, f,a1,a2,a3,a4,a5,a6)
+/*@}*/
-/**
- * ERROR6:
- * @f: the format string
- * @a1: first argument of the format
- * @a2: second argument of the format
- * @a3: third argument of the format
- * @a4: fourth argument of the format
- * @a5: fifth argument of the format
- * @a6: sixth argument of the format
- *
+/** \name ERROR
+ * \ingroup XBT_log
* Log something to the current default category under the error priority.
+ * \param f the format string
+ * \param a1 first argument of the format
+ * \param a2 second argument of the format
+ * \param a3 third argument of the format
+ * \param a4 fourth argument of the format
+ * \param a5 fifth argument of the format
+ * \param a6 sixth argument of the format
*
* The macros ERROR0 ... ERROR5 naturally also exist, but are not listed here
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
-
+/*@{*/
#define ERROR0(f) LOG0(xbt_log_priority_error, f)
#define ERROR1(f,a1) LOG1(xbt_log_priority_error, f,a1)
#define ERROR2(f,a1,a2) LOG2(xbt_log_priority_error, f,a1,a2)
#define ERROR4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_error, f,a1,a2,a3,a4)
#define ERROR5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_error, f,a1,a2,a3,a4,a5)
#define ERROR6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_error, f,a1,a2,a3,a4,a5,a6)
+/*@}*/
-/**
- * CRITICAL6:
- * @f: the format string
- * @a1: first argument of the format
- * @a2: second argument of the format
- * @a3: third argument of the format
- * @a4: fourth argument of the format
- * @a5: fifth argument of the format
- * @a6: sixth argument of the format
- *
+/** \name CRITICAL
+ * \ingroup XBT_log
* Log something to the current default category under the critical priority.
+ * \param f the format string
+ * \param a1 first argument of the format
+ * \param a2 second argument of the format
+ * \param a3 third argument of the format
+ * \param a4 fourth argument of the format
+ * \param a5 fifth argument of the format
+ * \param a6 sixth argument of the format
*
* The macros CRITICAL0 ... CRITICAL5 naturally also exist, but are not listed here
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
+/*@{*/
#define CRITICAL0(f) LOG0(xbt_log_priority_critical, f)
#define CRITICAL1(f,a1) LOG1(xbt_log_priority_critical, f,a1)
#define CRITICAL2(f,a1,a2) LOG2(xbt_log_priority_critical, f,a1,a2)
#define CRITICAL4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_critical, f,a1,a2,a3,a4)
#define CRITICAL5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_critical, f,a1,a2,a3,a4,a5)
#define CRITICAL6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_critical, f,a1,a2,a3,a4,a5,a6)
+/*@}*/
#define XBT_IN LOG1(xbt_log_priority_trace, ">> begin of %s", _XBT_GNUC_FUNCTION)
#define XBT_IN1(fmt,a) LOG2(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a)
#define XBT_IN3(fmt,a,b,c) LOG4(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a,b,c)
#define XBT_IN4(fmt,a,b,c,d) LOG5(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a,b,c,d)
#define XBT_OUT LOG1(xbt_log_priority_trace, "<< end of %s", _XBT_GNUC_FUNCTION)
+#define XBT_HERE LOG0(xbt_log_priority_trace, "-- was here")
#endif /* ! _XBT_LOG_H_ */
