Type definitions for logging utilities. More...

#include <cstdlib>
#include <functional>
#include <string>
#include <string_view>

Typedefs
using	celeritas::LogHandler = std::function< void(LogProvenance, LogLevel, std::string)>
	Type for handling a log message.

Enumerations
enum class	celeritas::LogLevel { debug , diagnostic , status , info , warning , error , critical , size_ }
	Enumeration for how important a log message is. More...

Functions
char const *	celeritas::to_cstring (LogLevel lev)
	Get the plain text equivalent of the LogLevel enum.

char const *	celeritas::to_ansi_color (LogLevel lev)
	Get an ANSI color code appropriate to each log level.

LogLevel	celeritas::getenv_loglevel (std::string const &level_env, LogLevel default_lev)
	Get the log level from an environment variable.

Detailed Description

Type definitions for logging utilities.

Enumeration Type Documentation

strong

Enumeration for how important a log message is.

Enumerator
debug	Debugging messages.
diagnostic	Diagnostics about current program execution.
status	Program execution status (what stage is beginning)
info	Important informational messages.
warning	Warnings about unusual events.
error	Something went wrong, but execution can continue.
critical	Something went terribly wrong, should probably abort.
size_	Sentinel value for looping over log levels.

LogLevel celeritas::getenv_loglevel	(	std::string const &	level_env,
		LogLevel	default_lev
	)

Get the log level from an environment variable.

Exceptions

RuntimeError if string is invalid