echomap::Logger Class Reference

A portable (native and browser) and thread-safe logger implementation for formatted messages. More...

#include <Logger.hpp>

Public Types
enum class	Level { Debug , Info , Warning , Error }
	Indicates the level of importance of a logged message. More...

Static Public Member Functions
static void	log (Level level, std::string_view message, std::source_location location=std::source_location::current())
	Log an unformatted message to the backend.
template<typename... Args>
static void	log_f (const Level level, const std::source_location location, std::format_string< Args... > fmt, Args &&... args)
	Log a formatted message to the backend with a specific source location.

Static Private Member Functions
static std::string_view	level_to_string (Level level)
	Get a human-readable string corresponding to the given log level.

Detailed Description

A portable (native and browser) and thread-safe logger implementation for formatted messages.

If compiled for a native backend, the standard C++20 synchronised IO stream is used. If compiled for WebAssembly, the JavaScript API is used to produce log messages in the browser console.

Definition at line 24 of file Logger.hpp.

Member Enumeration Documentation

Level

enum class echomap::Logger::Level

strong

Indicates the level of importance of a logged message.

Definition at line 30 of file Logger.hpp.

    {
        Debug,
        Info,
        Warning,
        Error
    };

Member Function Documentation

level_to_string()

std::string_view echomap::Logger::level_to_string ( Level level )

staticprivate

Get a human-readable string corresponding to the given log level.

Parameters

level

Relevant log level.

Returns

Human-readable string for the log level.

Definition at line 59 of file Logger.cpp.

{
    switch (level) {
    case Level::Debug:
        return "Debug";
    case Level::Error:
        return "Error";
    case Level::Info:
        return "Info";
    case Level::Warning:
        return "Warning";
    }
 
    return "Unknown";
}

log()

void echomap::Logger::log ( Level level, std::string_view message, std::source_location location = std::source_location::current() )

static

Log an unformatted message to the backend.

Parameters

level	The level of the message.
message	The unformatted message (string literal).
location	The optional origin of the message.

Definition at line 22 of file Logger.cpp.

{
    const auto line = std::format(
            "[{} ({})] {}:{} says: {}",
            level_to_string(level),
            std::this_thread::get_id(),
            location.file_name(),
            location.line(),
            message
    );
 
#if defined(__EMSCRIPTEN__) || defined(__DOXYGEN__)
    switch (level) {
    case Level::Error:
        emscripten_console_error(line.c_str());
        break;
    case Level::Info:
        emscripten_console_log(line.c_str());
        break;
    case Level::Warning:
        emscripten_console_warn(line.c_str());
        break;
    case Level::Debug:
        // Do not use console.trace, since Chrome DevTools expands it.
        emscripten_console_log(line.c_str());
        break;
    }
#else
    auto stream = std::osyncstream(level == Level::Error ? std::cerr : std::cout);
    stream << line << '\n';
#endif
}

log_f()

template<typename... Args>

void echomap::Logger::log_f ( const Level level, const std::source_location location, std::format_string< Args... > fmt, Args &&... args )

inlinestatic

Log a formatted message to the backend with a specific source location.

Template Parameters

Args	Types of variadic arguments for the formatter.

Parameters

level	The level of the message.
location	The origin of the message.
fmt	The printf-style format string of the message.
args	The values for the format string.

Definition at line 61 of file Logger.hpp.

    {
        log(level, std::format(fmt, std::forward<Args>(args)...), location);
    }

---

The documentation for this class was generated from the following files:

• src/utility/Logger.hpp
• src/utility/Logger.cpp