log.h File Reference

#include <a_util/base/delegate.h>
#include <a_util/base/types.h>
#include <a_util/preprocessor/to_string.h>
#include <a_util/strings/strings_format.h>
#include <a_util/strings/strings_functions.h>

Include dependency graph for log.h:

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

Go to the source code of this file.

Classes
struct	a_util::logging::LogEntry
	A log entry. More...

Namespaces
namespace	a_util
	Serves as the root component, with common functionality documented in core functionality.
namespace	a_util::logging
	Serves as component for basic logging functionality.

Macros
#define	LOG_ADD_ENTRY(__level, ...)
#define	LOG_DUMP(...)
#define	LOG_INFO(...)
	Log a message with LogLevel Info.
#define	LOG_WARNING(...)
#define	LOG_ERROR(...)

Typedefs
typedef experimental::UnaryDelegate< void, const LogEntry & >	a_util::logging::Logger

Enumerations
enum	a_util::logging::LogLevel {   a_util::logging::None = 0 , a_util::logging::Error = 10 , a_util::logging::Warning = 20 , a_util::logging::Info = 30 ,   a_util::logging::Dump = 40 , a_util::logging::Debug = Dump , a_util::logging::All = 0xFF }

Functions
void	a_util::logging::addEntry (const LogEntry &entry)
void	a_util::logging::addEntry (std::uint8_t log_level, const std::string &message=a_util::strings::empty_string, const std::string &source=a_util::strings::empty_string)
void	a_util::logging::setLogger (Logger log)
Logger	a_util::logging::getLogger ()
std::string	a_util::logging::defaultFormat (const LogEntry &entry)
void	a_util::logging::defaultLogger (const LogEntry &entry)

Detailed Description

Public API for Logger type, functions and macros

Copyright

Copyright 2025 Digitalwerk GmbH.

This Source Code Form is subject to the terms of the Mozilla
Public License, v. 2.0. If a copy of the MPL was not distributed
with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

Macro Definition Documentation

LOG_ADD_ENTRY

#define LOG_ADD_ENTRY	(		__level,
			... )

Value:

    a_util::logging::addEntry(__level,                                                             \
                              a_util::strings::format(__VA_ARGS__),                                \
                              __FILE__ "(" A_UTIL_TO_STRING(__LINE__) ")")

Add a log entry to the current logger, including current filename and line number

Parameters

[in]	__level	The log level
[in]	...	Arguments forwarded to printf()-like formatting

LOG_DUMP

#define LOG_DUMP

(

...

)

Log a message with LogLevel Dump (only in Debug mode)

LOG_ERROR

#define LOG_ERROR

(

...

)

Value:

LOG_ADD_ENTRY(a_util::logging::Error, __VA_ARGS__)

Log a message with LogLevel Error

LOG_INFO

#define LOG_INFO

(

...

)

Value:

LOG_ADD_ENTRY(a_util::logging::Info, __VA_ARGS__)

Log a message with LogLevel Info.

LOG_WARNING

#define LOG_WARNING

(

...

)

Value:

LOG_ADD_ENTRY(a_util::logging::Warning, __VA_ARGS__)

Log a message with LogLevel Warning