The Battle for Wesnoth  1.17.21+dev
Classes | Namespaces | Macros | Typedefs | Enumerations | Functions | Variables
log.hpp File Reference

Standard logging facilities (interface). More...

#include <iosfwd>
#include <optional>
#include <sstream>
#include <string>
#include <utility>
#include <ctime>
#include <cstdint>
#include "formatter.hpp"
Include dependency graph for log.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.


class  lg::redirect_output_setter
 Helper class to redirect the output of the logger in a certain scope. More...
class  lg::log_domain
class  lg::log_in_progress
class  lg::logger
class  lg::scope_logger




#define log_scope(description)   lg::scope_logger scope_logging_object__(lg::general(), description);
#define log_scope2(domain, description)   lg::scope_logger scope_logging_object__(domain, description);
#define LOG_STREAM(level, domain)   if (lg::level().dont_log(domain)) ; else lg::level()(domain) | formatter()
#define LOG_STREAM_NAMELESS(level, domain)   if (lg::level().dont_log(domain)) ; else lg::level()(domain, false) | formatter()
#define LOG_STREAM_NAMELESS_STREAMING(level, domain)   if (lg::level().dont_log(domain)) ; else lg::level()(domain, false, false, true, true, false) | formatter()
#define LOG_STREAM_INDENT(level, domain)   if (lg::level().dont_log(domain)) ; else lg::level()(domain, true, true) | formatter()
#define FORCE_LOG_TO(logger, domain)   logger(domain) | formatter()
#define PLAIN_LOG   lg::err()(lg::general(), false, false, false, false, true) | formatter()
#define STREAMING_LOG   lg::err()(lg::general(), false, false, false, false, false) | formatter()


typedef std::pair< const std::string, int > lg::logd


enum  lg::severity { lg::LG_ERROR =0 , lg::LG_WARN =1 , lg::LG_INFO =2 , lg::LG_DEBUG =3 }


bool lg::set_log_domain_severity (const std::string &name, int severity)
bool lg::set_log_domain_severity (const std::string &name, const logger &lg)
bool lg::get_log_domain_severity (const std::string &name, int &severity)
std::string lg::list_logdomains (const std::string &filter)
void lg::set_strict_severity (int severity)
void lg::set_strict_severity (const logger &lg)
bool lg::broke_strict ()
void lg::set_log_to_file ()
void lg::check_log_dir_writable ()
std::optional< bool > lg::log_dir_writable ()
bool lg::is_not_log_file (const std::string &fn)
 Helper function for rotate_logs. More...
void lg::rotate_logs (const std::string &log_dir)
 Deletes old log files from the log directory. More...
std::string lg::unique_log_filename ()
 Generates a unique log file name. More...
void lg::timestamps (bool t)
void lg::precise_timestamps (bool pt)
std::string lg::get_timestamp (const std::time_t &t, const std::string &format)
std::string lg::get_timespan (const std::time_t &t)
std::string lg::sanitize_log (const std::string &logstr)
std::string & lg::get_log_file_path ()
void lg::set_log_file_path (const std::string &path)
logger & lg::err ()
logger & lg::warn ()
logger & lg::info ()
logger & lg::debug ()
log_domain & lg::general ()
std::stringstream & lg::log_to_chat ()
 Use this to show WML errors in the ingame chat. More...


const std::string lg::log_file_prefix = "wesnoth-"
const std::string lg::log_file_suffix = ".log"
const unsigned lg::max_logs = 8

Detailed Description

Standard logging facilities (interface).

To use one of the standard log channels, put something like the following at the start of your .cpp file:

static lg::log_domain log_display("display"); #define ERR_DP LOG_STREAM(err, log_display) #define LOG_DP LOG_STREAM(info, log_display)

Then stream logging info to ERR_DP, or LOG_DP, as if it were an ostream like std::cerr. (In general it will actually be std::cerr at runtime when logging is enabled.)

LOG_DP << "Found a window resize event: ...";

Please do not use iomanip features like std::hex directly on the logger. Because of the design of the logger, this will result in all of the loggers (in fact std::cerr) being imbued with std::hex. Please use a formatter instead.

#include "formatter.hpp"

LOG_DP << (formatter() << "The random seed is: '" << std::hex << seed << "'\n").str();

It might be nice if somehow the logger class / macros could support using iomanip things directly, but right now it doesn't, and it seems that it would complicate the design greatly enough that it doesn't seem worth it.

Definition in file log.hpp.

Macro Definition Documentation


#define FORCE_LOG_TO (   logger,
)    logger(domain) | formatter()

Definition at line 257 of file log.hpp.

◆ log_scope

#define log_scope (   description)    lg::scope_logger scope_logging_object__(lg::general(), description);

Definition at line 241 of file log.hpp.

◆ log_scope2

#define log_scope2 (   domain,
)    lg::scope_logger scope_logging_object__(domain, description);

Definition at line 242 of file log.hpp.


#define LOG_STREAM (   level,
)    if (lg::level().dont_log(domain)) ; else lg::level()(domain) | formatter()

Definition at line 244 of file log.hpp.


#define LOG_STREAM_INDENT (   level,
)    if (lg::level().dont_log(domain)) ; else lg::level()(domain, true, true) | formatter()

Definition at line 253 of file log.hpp.


#define LOG_STREAM_NAMELESS (   level,
)    if (lg::level().dont_log(domain)) ; else lg::level()(domain, false) | formatter()

Definition at line 247 of file log.hpp.


)    if (lg::level().dont_log(domain)) ; else lg::level()(domain, false, false, true, true, false) | formatter()

Definition at line 250 of file log.hpp.


#define PLAIN_LOG   lg::err()(lg::general(), false, false, false, false, true) | formatter()

Definition at line 262 of file log.hpp.


#define STREAMING_LOG   lg::err()(lg::general(), false, false, false, false, false) | formatter()

Definition at line 263 of file log.hpp.