lg Namespace Reference

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

Typedefs
typedef std::map< std::string, int >	domain_map
typedef std::pair< const std::string, int >	logd

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

Functions
void	timestamps (bool t)
void	precise_timestamps (bool pt)
logger &	err ()
logger &	warn ()
logger &	info ()
logger &	debug ()
log_domain &	general ()
bool	set_log_domain_severity (const std::string &name, int severity)
bool	set_log_domain_severity (const std::string &name, const logger &lg)
bool	get_log_domain_severity (const std::string &name, int &severity)
std::string	list_logdomains (const std::string &filter)
void	set_strict_severity (int severity)
void	set_strict_severity (const logger &lg)
bool	broke_strict ()
std::string	get_timestamp (const std::time_t &t, const std::string &format)
std::string	get_timespan (const std::time_t &t)
static void	print_precise_timestamp (std::ostream &out) noexcept
std::stringstream &	log_to_chat ()
	Use this to show WML errors in the ingame chat. More...
std::string	log_file_path ()
	Returns the path to the current log file. More...
void	early_log_file_setup (bool disable)
	Sets up the initial temporary log file. More...
void	enable_native_console_output ()
	Switches to using a native console instead of log file redirection. More...
bool	using_own_console ()
	Returns true if a console was allocated by the Wesnoth process. More...
void	finish_log_file_setup ()
	Relocates the stdout+stderr log file to the user data directory. More...

Variables
static domain_map *	domains
static int	strict_level_ = -1
static log_domain	dom ("general")
static bool	strict_threw_ = false
static bool	disable_redirect

Typedef Documentation

domain_map

typedef std::map<std::string, int> lg::domain_map

Definition at line 71 of file log.cpp.

logd

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

Definition at line 101 of file log.hpp.

Enumeration Type Documentation

severity

enum lg::severity

Enumerator
LG_ERROR
LG_WARN
LG_INFO
LG_DEBUG

Definition at line 64 of file log.hpp.

Function Documentation

broke_strict()

bool lg::broke_strict

(

)

Definition at line 170 of file log.cpp.

References strict_threw_.

Referenced by handle_validate_command(), game_launcher::pass_victory_or_defeat(), and game_launcher::single_unit_test().

debug()

logger & lg::debug

(

)

Definition at line 95 of file log.cpp.

References dom.

Referenced by BOOST_AUTO_TEST_CASE(), events::chat_handler::change_logging(), campaignd::command_line::command_line(), commandline_options::commandline_options(), lg::scope_logger::do_log_entry(), lg::scope_logger::do_log_exit(), lg::logger::get_name(), ai::ai_default_rca::get_villages_phase::get_villages(), campaignd::server::handle_read_from_fifo(), game_events::event_handlers::log_handlers(), main(), game_events::wml_event_pump::operator()(), commandline_options::parse_log_strictness(), game_events::wml_event_pump::put_wml_message(), wb::move::remove_temp_modifier(), lg::scope_logger::scope_logger(), and gui2::dialogs::log_settings::set_logger().

early_log_file_setup()

void lg::early_log_file_setup

(

bool

disable

)

Sets up the initial temporary log file.

This has to be done on demand (preferably as early as possible) from a function rather than during static initialization, otherwise things go horribly wrong as soon as we try to use the logging facilities internally for debug messages.

Definition at line 481 of file log_windows.cpp.

Referenced by finish_log_file_setup(), and main().

enable_native_console_output()

void lg::enable_native_console_output

(

)

Switches to using a native console instead of log file redirection.

In this mode, the log file is closed (if it was created in the first place) and output is sent directly to an attached or allocated console instead. This is used to implement the –wconsole command line option.

Using a native console instead of a file has the benefit of allowing to see output in real time or redirecting it to a user-specified file.

Definition at line 495 of file log_windows.cpp.

Referenced by filesystem::get_logs_dir(), and main().

err()

logger & lg::err

(

)

Definition at line 77 of file log.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), events::chat_handler::change_logging(), campaignd::command_line::command_line(), commandline_options::commandline_options(), deprecated_message(), gui2::dialogs::mp_join_game::fetch_game_config(), preprocessor_data::get_chunk(), lg::logger::get_name(), vconfig::get_parsed_config(), campaignd::server::handle_read_from_fifo(), server_base::hash_password(), game_lua_kernel::impl_schedule_set(), intf_log(), intf_switch_ai(), persist_file_context::load(), game_config_manager::load_addons_cfg(), main(), commandline_options::parse_log_strictness(), network_asio::connection::poll(), game_events::wml_event_pump::put_wml_message(), savegame::read_save_file(), events::menu_handler::recall(), persist_file_context::save_context(), image::save_image(), gui2::dialogs::log_settings::set_logger(), gui2::show_error_message(), gui2::show_transient_error_message(), and wesnothd_connection::wait_for_handshake().

finish_log_file_setup()

void lg::finish_log_file_setup

(

)

Relocates the stdout+stderr log file to the user data directory.

This function exits the process if something goes wrong (including calling it when the user data directory isn't known yet).

Definition at line 510 of file log_windows.cpp.

References early_log_file_setup(), ERR_LS, filesystem::file_exists(), filesystem::get_logs_dir(), and filesystem::make_directory().

Referenced by filesystem::setup_user_data_dir().

general()

log_domain & lg::general

(

)

Definition at line 103 of file log.cpp.

References dom.

Referenced by default_map_generator_job::default_generate_map(), deprecated_message(), lg::logger::get_name(), game_config_manager::init_game_config(), gui2::show_error_message(), and gui2::show_transient_error_message().

get_log_domain_severity()

bool lg::get_log_domain_severity	(	const std::string &	name,
		int &	severity
	)

Definition at line 141 of file log.cpp.

Referenced by gui2::dialogs::log_settings::pre_show(), and game_config::set_debug().

get_timespan()

std::string lg::get_timespan

(

const std::time_t &

t

)

Definition at line 181 of file log.cpp.

Referenced by wesnothd::banned::get_human_time_span(), lg::logger::get_name(), and wesnothd::player_status().

get_timestamp()

std::string lg::get_timestamp	(	const std::time_t &	t,
		const std::string &	format
	)

Definition at line 174 of file log.cpp.

Referenced by preferences::get_chat_timestamp(), wesnothd::banned::get_human_end_time(), wesnothd::banned::get_human_start_time(), lg::logger::get_name(), lg::log_in_progress::operator|(), and wesnothd::server::searchlog_handler().

info()

logger & lg::info

(

)

Definition at line 89 of file log.cpp.

Referenced by ad_hoc_addon_fetch_session(), server_base::async_send_error(), server_base::async_send_warning(), BOOST_AUTO_TEST_CASE(), events::chat_handler::change_logging(), check_error(), campaignd::command_line::command_line(), commandline_options::commandline_options(), addons_client::connect(), deprecated_message(), addon_info::description_translated(), addon_info::display_title_translated(), game_config::dist_channel_id(), addons_client::do_resolve_addon_dependencies(), gui2::dialogs::editor_edit_side::editor_edit_side(), ai::default_recruitment::recruitment::execute(), gui2::dialogs::mp_lobby::game_filter_init(), help::generate_terrain_sections(), get_addon_install_info(), theme::get_basic_theme_info(), ai::default_recruitment::recruitment::get_cheapest_unit_cost_for_leader(), gui2::get_mp_tooltip(), lg::logger::get_name(), gui2::dialogs::addon_manager::get_status_filter_visibility(), wesnothd::server::handle_player_in_game(), campaignd::server::handle_read_from_fifo(), game_lua_kernel::impl_get_terrain_info(), intf_log(), game_config_manager::load_game_config_with_loadscreen(), main(), ng::depcheck::manager::manager(), gui2::dialogs::addon_manager::on_addon_select(), gui2::dialogs::addon_manager::on_selected_version_change(), gui2::dialogs::mp_connect::on_server_add(), help::unit_topic_generator::operator()(), gui2::dialogs::outro::outro(), spirit_po::catalog_metadata::parse_header(), commandline_options::parse_log_strictness(), gui2::dialogs::mp_create_game::pre_show(), gui2::dialogs::mp_lobby::process_network_data(), playmp_controller::process_oos(), events::pump(), game_events::wml_event_pump::put_wml_message(), run_campaignd(), gui2::addon_list::select_addon(), unit_type_data::set_config(), gui2::dialogs::log_settings::set_logger(), editor::map_context::set_needs_terrain_rebuild(), translation::sngettext(), gui2::dialogs::mp_create_game::sync_with_depcheck(), addon_info::translated_info(), unit_moves(), and sdl::window::window().

list_logdomains()

std::string lg::list_logdomains

(

const std::string &

filter

)

Definition at line 150 of file log.cpp.

Referenced by gui2::dialogs::log_settings::log_settings(), process_command_args(), and run_campaignd().

log_file_path()

std::string lg::log_file_path

(

)

Returns the path to the current log file.

An empty string is returned if the log file has not been set up yet or it was disabled (e.g. by –wconsole).

Definition at line 470 of file log_windows.cpp.

Referenced by filesystem::get_logs_dir().

log_to_chat()

std::stringstream & lg::log_to_chat

(

)

Use this to show WML errors in the ingame chat.

After every WML event the errors are shown to the user so they can inform the campaign maintainer.

Definition at line 289 of file log.cpp.

Referenced by game_events::event_handlers::add_event_handler(), attack_type::add_formula_context(), name_generator_factory::add_name_generator_from_config(), events::mouse_handler::attack_enemy(), gui2::implementation::builder_stacked_widget::builder_stacked_widget(), deprecated_message(), ai::default_recruitment::recruitment::execute(), ai::configuration::expand_simplified_aspects(), unit_filter_impl::unit_filter_compound::fill(), cave_map_generator::cave_map_generator_job::generate_chambers(), get_renamed_config_attribute(), game_lua_kernel::intf_log(), luaW_pcall(), pathfind::manager::manager(), side_filter::match_internal(), terrain_filter::match_internal(), matches_simple_filter(), context_free_grammar_generator::print_nonterminal(), game_lua_kernel::run_wml_conditional(), game_events::wml_event_pump::show_wml_errors(), unit_race::unit_race(), game_events::builtin_conditions::variable_matches(), game_events::WML_HANDLER_FUNCTION(), and lg::scope_logger::~scope_logger().

precise_timestamps()

void lg::precise_timestamps

(

bool

pt

)

Definition at line 75 of file log.cpp.

References precise_timestamp.

Referenced by lg::logger::get_name(), campaignd::server::handle_read_from_fifo(), process_command_args(), and run_campaignd().

print_precise_timestamp()

static void lg::print_precise_timestamp ( std::ostream &  out )

staticnoexcept

Definition at line 198 of file log.cpp.

References c.

Referenced by lg::log_in_progress::operator|().

set_log_domain_severity() [1/2]

bool lg::set_log_domain_severity	(	const std::string &	name,
		int	severity
	)

Definition at line 117 of file log.cpp.

References s.

Referenced by BOOST_AUTO_TEST_CASE(), events::chat_handler::change_logging(), campaignd::server::handle_read_from_fifo(), main(), process_command_args(), run_campaignd(), game_config::set_debug(), set_log_domain_severity(), and gui2::dialogs::log_settings::set_logger().

set_log_domain_severity() [2/2]

bool lg::set_log_domain_severity	(	const std::string &	name,
		const logger &	lg
	)

Definition at line 137 of file log.cpp.

References lg::logger::get_severity(), and set_log_domain_severity().

set_strict_severity() [1/2]

void lg::set_strict_severity

(

int

severity

)

Definition at line 160 of file log.cpp.

Referenced by handle_validate_command(), commandline_options::parse_log_strictness(), and set_strict_severity().

set_strict_severity() [2/2]

void lg::set_strict_severity

(

const logger &

lg

)

Definition at line 164 of file log.cpp.

References lg::logger::get_severity(), and set_strict_severity().

timestamps()

void lg::timestamps

(

bool

t

)

Definition at line 74 of file log.cpp.

References t, and timestamp.

Referenced by BOOST_AUTO_TEST_CASE(), lg::logger::get_name(), main(), and run_campaignd().

using_own_console()

bool lg::using_own_console

(

)

Returns true if a console was allocated by the Wesnoth process.

Returns false if no native console or if it was attached from a parent process.

Definition at line 505 of file log_windows.cpp.

Referenced by do_gameloop().

warn()

logger & lg::warn

(

)

Definition at line 83 of file log.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), events::chat_handler::change_logging(), campaignd::command_line::command_line(), commandline_options::commandline_options(), deprecated_message(), lg::logger::get_name(), campaignd::server::handle_read_from_fifo(), intf_log(), main(), commandline_options::parse_log_strictness(), game_events::wml_event_pump::put_wml_message(), and gui2::dialogs::log_settings::set_logger().

Variable Documentation

disable_redirect

bool lg::disable_redirect

static

Definition at line 479 of file log_windows.cpp.

dom

log_domain lg::dom("general")

static

Referenced by debug(), and general().

domains

domain_map* lg::domains

static

Definition at line 72 of file log.cpp.

Referenced by campaignd::command_line::command_line(), and commandline_options::parse_log_domains_().

strict_level_

int lg::strict_level_ = -1

static

Definition at line 73 of file log.cpp.

strict_threw_

bool lg::strict_threw_ = false

static

Definition at line 168 of file log.cpp.

Referenced by broke_strict().