log_category.hpp File Reference

#include <boost/preprocessor/tuple/elem.hpp>

Macros
#define	KZ_LOG_CATEGORY_DEBUG
	Use the debug log category for debug messages only. The state of this category is determined by KZ_LOG_CATEGORY_DEBUG_DEFAULT_STATE.
#define	KZ_LOG_CATEGORY_DEBUG_DEFAULT_STATE
	Define this macro to KZ_LOG_ENABLED_CATEGORY or KZ_LOG_DISABLED_CATEGORY to enable or disable KZ_LOG_CATEGORY_DEBUG category.
#define	KZ_LOG_CATEGORY_EGL_EXTRA
	The log category for extra EGL log messages.
#define	KZ_LOG_CATEGORY_GENERIC
	Use the generic log category to log messages that you cannot assign to any other log category.
#define	KZ_LOG_CATEGORY_GENERIC_DEFAULT_STATE
	Define this macro to KZ_LOG_ENABLED_CATEGORY or KZ_LOG_DISABLED_CATEGORY to enable or disable KZ_LOG_CATEGORY_GENERIC category.
#define	KZ_LOG_CATEGORY_GRAPHICS_MESH_EXTRA
	The log category for extra graphics mesh log messages.
#define	KZ_LOG_CREATE_CATEGORY(state, name)
	Use the KZ_LOG_CREATE_CATEGORY macro to create a log category.
#define	KZ_LOG_DISABLED_CATEGORY
	The disabled log category state.
#define	KZ_LOG_ENABLED_CATEGORY
	The enabled log category state.
#define	KZ_LOG_GET_CATEGORY_NAME(category)
	To get the name of the log category, use KZ_LOG_GET_CATEGORY_NAME.
#define	KZ_LOG_GET_CATEGORY_STATE(category)
	To get state of the log category, use KZ_LOG_GET_CATEGORY_STATE macro.
#define	KZ_LOG_IS_CATEGORY_ENABLED(category)
	To check if the log category is enabled, use KZ_LOG_IS_CATEGORY_ENABLED.

Detailed Description

Log category

Use log categories to group log messages that contain information related to the same functionality. You can assign a dedicated log category to each log message group. The log category is a macro that you pass to Logging macros when you write log messages. To define a new log category, use the KZ_LOG_CREATE_CATEGORY macro. You can enable or disable the new log category by passing the KZ_LOG_ENABLED_CATEGORY or KZ_LOG_DISABLED_CATEGORY macro as the first parameter of the KZ_LOG_CREATE_CATEGORY macro. To learn how the state of the log category is used in the log message filtering, see Classifying and filtering log messages.

There are predefined log categories. For example, use KZ_LOG_CATEGORY_GENERIC to log messages that you cannot assign to any other log category. KZ_LOG_CATEGORY_DEBUG is only used internally by the kzLogDebug macro.