log_macros.h File Reference

Unified logging macros for convenient logging across all subsystems. More...

#include "log_functions.h"

Include dependency graph for log_macros.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	KCENON_LOG_ARG_COUNT(...)
	Helper macros for variadic argument dispatch.
#define	KCENON_LOG_ARG_COUNT_IMPL(_1, _2, N, ...)
#define	KCENON_LOG_PASTE(a, b)
#define	KCENON_LOG_PASTE_IMPL(a, b)
#define	KCENON_LOG_DISPATCH(LEVEL, ...)
#define	LOG_TRACE(...)
	Log a trace-level message.
#define	LOG_TRACE_1(msg)
#define	LOG_TRACE_2(logger_name, msg)
#define	LOG_DEBUG(...)
	Log a debug-level message.
#define	LOG_DEBUG_1(msg)
#define	LOG_DEBUG_2(logger_name, msg)
#define	LOG_INFO(...)
	Log an info-level message.
#define	LOG_INFO_1(msg)
#define	LOG_INFO_2(logger_name, msg)
#define	LOG_WARNING(...)
	Log a warning-level message.
#define	LOG_WARNING_1(msg)
#define	LOG_WARNING_2(logger_name, msg)
#define	LOG_ERROR(...)
	Log an error-level message.
#define	LOG_ERROR_1(msg)
#define	LOG_ERROR_2(logger_name, msg)
#define	LOG_CRITICAL(...)
	Log a critical-level message.
#define	LOG_CRITICAL_1(msg)
#define	LOG_CRITICAL_2(logger_name, msg)
#define	LOG_IF(level, msg)
	Log a message only if the specified level is enabled.
#define	LOG_IF_TO(level, logger_name, msg)
	Log a message to a named logger only if the level is enabled.
#define	LOG_FLUSH()
	Flush the default logger's buffer.
#define	LOG_FLUSH_TO(logger_name)
	Flush a named logger's buffer.
#define	LOG_IS_ENABLED(level)
	Check if a log level is enabled for the default logger.
#define	LOG_IS_ENABLED_FOR(level, logger_name)
	Check if a log level is enabled for a named logger.
#define	KCENON_MIN_LOG_LEVEL   0
	Minimum log level at compile time.

Detailed Description

Unified logging macros for convenient logging across all subsystems.

This header provides preprocessor macros that wrap the logging functions from log_functions.h. These macros offer a convenient, concise way to log messages while automatically capturing source location information.

The macros support:

• Standard LOG_* macros for each log level
• Conditional logging based on log level

Thread Safety:

• All macros are thread-safe as they delegate to thread-safe functions.

Usage:

// Basic logging
LOG_INFO("Application started");
LOG_DEBUG("Processing item: " + std::to_string(id));
 
// Conditional logging (avoids message construction when disabled)
LOG_IF(log_level::debug, expensive_to_string(data));

Note

Prefer using LOG_* macros over direct function calls for consistency.

See also

Issue #175 for implementation requirements.

log_functions.h for the underlying function implementations.

Definition in file log_macros.h.

Macro Definition Documentation

KCENON_LOG_ARG_COUNT

#define KCENON_LOG_ARG_COUNT

(

...

)

Value:

    KCENON_LOG_ARG_COUNT_IMPL(__VA_ARGS__, 2, 1)

Helper macros for variadic argument dispatch.

These macros enable LOG_* macros to accept either 1 or 2 arguments:

• LOG_DEBUG(msg) -> logs to default logger
• LOG_DEBUG(logger_name, msg) -> logs to named logger

Implementation uses argument counting and token pasting for dispatch.

Definition at line 55 of file log_macros.h.

#define KCENON_LOG_ARG_COUNT(...) \
    KCENON_LOG_ARG_COUNT_IMPL(__VA_ARGS__, 2, 1)

KCENON_LOG_ARG_COUNT_IMPL

#define KCENON_LOG_ARG_COUNT_IMPL	(		_1,
			_2,
			N,
			... )

Value:

N

Definition at line 57 of file log_macros.h.

KCENON_LOG_DISPATCH

#define KCENON_LOG_DISPATCH	(		LEVEL,
			... )

Value:

    KCENON_LOG_PASTE(LEVEL##_, KCENON_LOG_ARG_COUNT(__VA_ARGS__))(__VA_ARGS__)

Definition at line 64 of file log_macros.h.

#define KCENON_LOG_DISPATCH(LEVEL, ...) \
    KCENON_LOG_PASTE(LEVEL##_, KCENON_LOG_ARG_COUNT(__VA_ARGS__))(__VA_ARGS__)

KCENON_LOG_PASTE

#define KCENON_LOG_PASTE	(		a,
			b )

Value:

KCENON_LOG_PASTE_IMPL(a, b)

Definition at line 60 of file log_macros.h.

KCENON_LOG_PASTE_IMPL

#define KCENON_LOG_PASTE_IMPL	(		a,
			b )

Value:

a##b

Definition at line 61 of file log_macros.h.

KCENON_MIN_LOG_LEVEL

#define KCENON_MIN_LOG_LEVEL   0

Minimum log level at compile time.

Define this macro before including log_macros.h to disable lower log levels at compile time. This removes the logging calls entirely from the compiled code.

Values:

• 0: trace (default, all levels enabled)
• 1: debug
• 2: info
• 3: warning
• 4: error
• 5: critical
• 6: off (all logging disabled)

Usage:

#define KCENON_MIN_LOG_LEVEL 2  // Disable trace and debug in release
#include <kcenon/common/logging/log_macros.h>

Definition at line 281 of file log_macros.h.

LOG_CRITICAL

#define LOG_CRITICAL

(

...

)

Value:

KCENON_LOG_DISPATCH(LOG_CRITICAL, __VA_ARGS__)

Log a critical-level message.

Supports two forms:

• LOG_CRITICAL(msg) - Log to default logger
• LOG_CRITICAL(logger_name, msg) - Log to named logger

Parameters

msg	The message to log (string or string_view compatible)
logger_name	(optional) The name of the logger

Definition at line 167 of file log_macros.h.

LOG_CRITICAL_1

#define LOG_CRITICAL_1

(

msg

)

Value:

    ::kcenon::common::logging::log_critical(msg)

Definition at line 168 of file log_macros.h.

#define LOG_CRITICAL_1(msg) \
    ::kcenon::common::logging::log_critical(msg)

LOG_CRITICAL_2

#define LOG_CRITICAL_2	(		logger_name,
			msg )

Value:

    ::kcenon::common::logging::log_critical_to(logger_name, msg)

Definition at line 170 of file log_macros.h.

#define LOG_CRITICAL_2(logger_name, msg) \
    ::kcenon::common::logging::log_critical_to(logger_name, msg)

LOG_DEBUG

#define LOG_DEBUG

(

...

)

Value:

KCENON_LOG_DISPATCH(LOG_DEBUG, __VA_ARGS__)

Log a debug-level message.

Supports two forms:

• LOG_DEBUG(msg) - Log to default logger
• LOG_DEBUG(logger_name, msg) - Log to named logger

Parameters

msg	The message to log (string or string_view compatible)
logger_name	(optional) The name of the logger

Definition at line 99 of file log_macros.h.

LOG_DEBUG_1

#define LOG_DEBUG_1

(

msg

)

Value:

    ::kcenon::common::logging::log_debug(msg)

Definition at line 100 of file log_macros.h.

#define LOG_DEBUG_1(msg) \
    ::kcenon::common::logging::log_debug(msg)

LOG_DEBUG_2

#define LOG_DEBUG_2	(		logger_name,
			msg )

Value:

    ::kcenon::common::logging::log_debug_to(logger_name, msg)

Definition at line 102 of file log_macros.h.

#define LOG_DEBUG_2(logger_name, msg) \
    ::kcenon::common::logging::log_debug_to(logger_name, msg)

LOG_ERROR

#define LOG_ERROR

(

...

)

Value:

KCENON_LOG_DISPATCH(LOG_ERROR, __VA_ARGS__)

Log an error-level message.

Supports two forms:

• LOG_ERROR(msg) - Log to default logger
• LOG_ERROR(logger_name, msg) - Log to named logger

Parameters

msg	The message to log (string or string_view compatible)
logger_name	(optional) The name of the logger

Definition at line 150 of file log_macros.h.

LOG_ERROR_1

#define LOG_ERROR_1

(

msg

)

Value:

    ::kcenon::common::logging::log_error(msg)

Definition at line 151 of file log_macros.h.

#define LOG_ERROR_1(msg) \
    ::kcenon::common::logging::log_error(msg)

LOG_ERROR_2

#define LOG_ERROR_2	(		logger_name,
			msg )

Value:

    ::kcenon::common::logging::log_error_to(logger_name, msg)

Definition at line 153 of file log_macros.h.

#define LOG_ERROR_2(logger_name, msg) \
    ::kcenon::common::logging::log_error_to(logger_name, msg)

LOG_FLUSH

#define LOG_FLUSH

(

)

Value:

    ::kcenon::common::logging::flush()

Flush the default logger's buffer.

Definition at line 223 of file log_macros.h.

#define LOG_FLUSH() \
    ::kcenon::common::logging::flush()

LOG_FLUSH_TO

#define LOG_FLUSH_TO

(

logger_name

)

Value:

    ::kcenon::common::logging::flush(logger_name)

Flush a named logger's buffer.

Parameters

logger_name

The name of the logger

Definition at line 231 of file log_macros.h.

#define LOG_FLUSH_TO(logger_name) \
    ::kcenon::common::logging::flush(logger_name)

LOG_IF

#define LOG_IF	(		level,
			msg )

Value:

    do { \
        if (::kcenon::common::logging::is_enabled(level)) { \
            ::kcenon::common::logging::log(level, msg); \
        } \
    } while (0)

Log a message only if the specified level is enabled.

This macro checks if the log level is enabled before evaluating the message expression, which is useful for avoiding expensive message construction when logging is disabled.

Parameters

level	Log level (e.g., log_level::debug)
msg	The message to log

Usage:

LOG_IF(log_level::debug, "Expensive data: " + expensive_to_string(data));

Definition at line 193 of file log_macros.h.

#define LOG_IF(level, msg) \
    do { \
        if (::kcenon::common::logging::is_enabled(level)) { \
            ::kcenon::common::logging::log(level, msg); \
        } \
    } while (0)

LOG_IF_TO

#define LOG_IF_TO	(		level,
			logger_name,
			msg )

Value:

    do { \
        if (::kcenon::common::logging::is_enabled(level, logger_name)) { \
            ::kcenon::common::logging::log(level, msg, logger_name); \
        } \
    } while (0)

Log a message to a named logger only if the level is enabled.

Parameters

level	Log level (e.g., log_level::debug)
logger_name	The name of the logger
msg	The message to log

Definition at line 208 of file log_macros.h.

#define LOG_IF_TO(level, logger_name, msg) \
    do { \
        if (::kcenon::common::logging::is_enabled(level, logger_name)) { \
            ::kcenon::common::logging::log(level, msg, logger_name); \
        } \
    } while (0)

LOG_INFO

#define LOG_INFO

(

...

)

Value:

KCENON_LOG_DISPATCH(LOG_INFO, __VA_ARGS__)

Log an info-level message.

Supports two forms:

• LOG_INFO(msg) - Log to default logger
• LOG_INFO(logger_name, msg) - Log to named logger

Parameters

msg	The message to log (string or string_view compatible)
logger_name	(optional) The name of the logger

Definition at line 116 of file log_macros.h.

LOG_INFO_1

#define LOG_INFO_1

(

msg

)

Value:

    ::kcenon::common::logging::log_info(msg)

Definition at line 117 of file log_macros.h.

#define LOG_INFO_1(msg) \
    ::kcenon::common::logging::log_info(msg)

LOG_INFO_2

#define LOG_INFO_2	(		logger_name,
			msg )

Value:

    ::kcenon::common::logging::log_info_to(logger_name, msg)

Definition at line 119 of file log_macros.h.

#define LOG_INFO_2(logger_name, msg) \
    ::kcenon::common::logging::log_info_to(logger_name, msg)

LOG_IS_ENABLED

#define LOG_IS_ENABLED

(

level

)

Value:

    ::kcenon::common::logging::is_enabled(level)

Check if a log level is enabled for the default logger.

Parameters

level

Log level to check

Returns

true if the level is enabled

Definition at line 240 of file log_macros.h.

#define LOG_IS_ENABLED(level) \
    ::kcenon::common::logging::is_enabled(level)

LOG_IS_ENABLED_FOR

#define LOG_IS_ENABLED_FOR	(		level,
			logger_name )

Value:

    ::kcenon::common::logging::is_enabled(level, logger_name)

Check if a log level is enabled for a named logger.

Parameters

level	Log level to check
logger_name	The name of the logger

Returns

true if the level is enabled

Definition at line 250 of file log_macros.h.

#define LOG_IS_ENABLED_FOR(level, logger_name) \
    ::kcenon::common::logging::is_enabled(level, logger_name)

LOG_TRACE

#define LOG_TRACE

(

...

)

Value:

KCENON_LOG_DISPATCH(LOG_TRACE, __VA_ARGS__)

Log a trace-level message.

Supports two forms:

• LOG_TRACE(msg) - Log to default logger
• LOG_TRACE(logger_name, msg) - Log to named logger

Parameters

msg	The message to log (string or string_view compatible)
logger_name	(optional) The name of the logger

Definition at line 82 of file log_macros.h.

LOG_TRACE_1

#define LOG_TRACE_1

(

msg

)

Value:

    ::kcenon::common::logging::log_trace(msg)

Definition at line 83 of file log_macros.h.

#define LOG_TRACE_1(msg) \
    ::kcenon::common::logging::log_trace(msg)

LOG_TRACE_2

#define LOG_TRACE_2	(		logger_name,
			msg )

Value:

    ::kcenon::common::logging::log_trace_to(logger_name, msg)

Definition at line 85 of file log_macros.h.

#define LOG_TRACE_2(logger_name, msg) \
    ::kcenon::common::logging::log_trace_to(logger_name, msg)

LOG_WARNING

#define LOG_WARNING

(

...

)

Value:

KCENON_LOG_DISPATCH(LOG_WARNING, __VA_ARGS__)

Log a warning-level message.

Supports two forms:

• LOG_WARNING(msg) - Log to default logger
• LOG_WARNING(logger_name, msg) - Log to named logger

Parameters

msg	The message to log (string or string_view compatible)
logger_name	(optional) The name of the logger

Definition at line 133 of file log_macros.h.

LOG_WARNING_1

#define LOG_WARNING_1

(

msg

)

Value:

    ::kcenon::common::logging::log_warning(msg)

Definition at line 134 of file log_macros.h.

#define LOG_WARNING_1(msg) \
    ::kcenon::common::logging::log_warning(msg)

LOG_WARNING_2

#define LOG_WARNING_2	(		logger_name,
			msg )

Value:

    ::kcenon::common::logging::log_warning_to(logger_name, msg)

Definition at line 136 of file log_macros.h.

#define LOG_WARNING_2(logger_name, msg) \
    ::kcenon::common::logging::log_warning_to(logger_name, msg)