debug Namespace Reference

Debugging functions and classes. More...

Namespaces
	console
	Debug console.

Classes
class	cli
	Minimal command-line interpreter. More...
struct	message_logged_event
	Event generated when a message has been logged. More...
class	logger
	Generates an event each time a message logged. More...
struct	log_message
	Self-formatting message that logs itself to the default logger on construction. More...

Debug logging
enum class	log_message_severity : std::uint8_t {   trace = ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_TRACE , debug = ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_DEBUG , info = ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_INFO , warning = ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_WARNING ,   error = ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_ERROR , fatal = ANTKEEPER_DEBUG_LOG_MESSAGE_SEVERITY_FATAL }
	Log message severity levels. More...
template<class... Args>
using	log_trace = log_message< log_message_severity::trace, Args... >
	Formats and logs a trace message. More...
template<class... Args>
using	log_debug = log_message< log_message_severity::debug, Args... >
	Formats and logs a debug message. More...
template<class... Args>
using	log_info = log_message< log_message_severity::info, Args... >
	Formats and logs an info message. More...
template<class... Args>
using	log_warning = log_message< log_message_severity::warning, Args... >
	Formats and logs a warning message. More...
template<class... Args>
using	log_error = log_message< log_message_severity::error, Args... >
	Formats and logs an error message. More...
template<class... Args>
using	log_fatal = log_message< log_message_severity::fatal, Args... >
	Formats and logs a fatal error message. More...
logger &	default_logger () noexcept
	Returns the default logger. More...
template<log_message_severity Severity, class... Args>
	log_message (std::string_view, Args &&...) -> log_message< Severity, Args... >
	Formats and logs a trace message. More...

Detailed Description

Debugging functions and classes.

Typedef Documentation

log_debug

template<class... Args>

using debug::log_debug = typedef log_message<log_message_severity::debug, Args...>

Formats and logs a debug message.

Template Parameters

Args	Types of arguments to be formatted.

Definition at line 102 of file log.hpp.

log_error

template<class... Args>

using debug::log_error = typedef log_message<log_message_severity::error, Args...>

Formats and logs an error message.

Template Parameters

Args	Types of arguments to be formatted.

Definition at line 144 of file log.hpp.

log_fatal

template<class... Args>

using debug::log_fatal = typedef log_message<log_message_severity::fatal, Args...>

Formats and logs a fatal error message.

Template Parameters

Args	Types of arguments to be formatted.

Definition at line 158 of file log.hpp.

log_info

template<class... Args>

using debug::log_info = typedef log_message<log_message_severity::info, Args...>

Formats and logs an info message.

Template Parameters

Args	Types of arguments to be formatted.

Definition at line 116 of file log.hpp.

log_trace

template<class... Args>

using debug::log_trace = typedef log_message<log_message_severity::trace, Args...>

Formats and logs a trace message.

Template Parameters

Args	Types of arguments to be formatted.

Definition at line 88 of file log.hpp.

log_warning

template<class... Args>

using debug::log_warning = typedef log_message<log_message_severity::warning, Args...>

Formats and logs a warning message.

Template Parameters

Args	Types of arguments to be formatted.

Definition at line 130 of file log.hpp.

Enumeration Type Documentation

log_message_severity

enum debug::log_message_severity : std::uint8_t

strong

Log message severity levels.

Enumerator
trace	Trace message severity.
debug	Debug message severity.
info	Info message severity.
warning	Warning message severity.
error	Error message severity.
fatal	Fatal error message severity.

Definition at line 49 of file log-message-severity.hpp.

Function Documentation

default_logger()

logger & debug::default_logger ( )

noexcept

Returns the default logger.

Definition at line 24 of file log.cpp.

log_message()

template<log_message_severity Severity, class... Args>

debug::log_message	(	std::string_view	,
		Args &&	...
	)		-> log_message< Severity, Args... >

Formats and logs a trace message.

Template Parameters

Args	Types of arguments to be formatted.