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

Standard logging facilities (interface). More...

#include "global.hpp"
#include <iostream>
#include <sstream>
#include <string>
#include <utility>
#include <boost/date_time/posix_time/posix_time_types.hpp>
Include dependency graph for log.hpp:

Go to the source code of this file.

Classes

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::logger
 
class  lg::scope_logger
 

Namespaces

 lg
 

Macros

#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)
 
#define LOG_STREAM_INDENT(level, domain)   if (lg::level().dont_log(domain)) ; else lg::level()(domain, true, true)
 

Typedefs

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

Functions

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::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)
 
logger & lg::err ()
 
logger & lg::warn ()
 
logger & lg::info ()
 
logger & lg::debug ()
 
log_domain & lg::general ()
 
std::stringstream & lg::wml_error ()
 Use this logger to send errors due to deprecated WML. More...
 

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: ...\n";

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

◆ log_scope

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

◆ log_scope2

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

◆ LOG_STREAM

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

◆ LOG_STREAM_INDENT

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

Definition at line 192 of file log.hpp.