The base class for all savegame stuff. More...

#include <savegame.hpp>

Inheritance diagram for savegame::savegame:

Public Member Functions
virtual	~savegame ()

bool	save_game_automatic (CVideo &video, bool ask_for_overwrite=false, const std::string &filename="")
	Saves a game without user interaction, unless the file exists and it should be asked to overwrite it. More...

bool	save_game_interactive (CVideo &video, const std::string &message, gui::DIALOG_TYPE dialog_type)
	Save a game interactively through the savegame dialog. More...

const std::string &	filename () const

Protected Member Functions
	savegame (saved_game &gamestate, const compression::format compress_saves, const std::string &title="Save")
	The only constructor of savegame. More...

bool	save_game (CVideo *video=nullptr, const std::string &filename="")
	Save a game without any further user interaction. More...

void	set_filename (std::string filename)
	Sets the filename and removes invalid characters. More...

bool	check_filename (const std::string &filename, CVideo &video)
	Check, if the filename contains illegal constructs like ".gz". More...

void	set_error_message (const std::string &error_message)
	Customize the standard error message. More...

const std::string &	title ()

const saved_game &	gamestate ()

void	before_save ()
	If there needs to be some data fiddling before saving the game, this is the place to go. More...

virtual void	write_game (config_writer &out)
	Writing the savegame config to a file. More...

Private Member Functions
virtual void	create_filename ()
	Build the filename according to the specific savegame's needs. More...

virtual int	show_save_dialog (CVideo &video, const std::string &message, const gui::DIALOG_TYPE dialog_type)
	Display the save game dialog. More...

bool	check_overwrite (CVideo &video)
	Ask the user if an existing file should be overwritten. More...

void	write_game_to_disk (const std::string &filename)
	The actual method for saving the game to disk. More...

void	finish_save_game (const config_writer &out)
	Update the save_index. More...

filesystem::scoped_ostream	open_save_game (const std::string &label)
	Throws game::save_game_failed. More...

Static Private Member Functions
static bool	is_illegal_file_char (char c)
	Checks if a certain character is allowed in a savefile name. More...

Private Attributes
saved_game &	gamestate_

std::string	filename_
	Filename of the savegame file on disk. More...

const std::string	title_

std::string	error_message_
	Title of the savegame dialog. More...

bool	show_confirmation_
	Error message to be displayed if the savefile could not be generated. More...

compression::format	compress_saves_
	Determines if a confirmation of successful saving the game is shown. More...

Friends
class	save_info

Detailed Description

The base class for all savegame stuff.

This should not be used directly, as it does not directly produce usable saves. Instead, use one of the derived classes.

Definition at line 101 of file savegame.hpp.

Constructor & Destructor Documentation

savegame::savegame::savegame	(	saved_game &	gamestate,
		const compression::format	compress_saves,
		const std::string &	title = `"Save"`
	)

protected

The only constructor of savegame.

The title parameter is only necessary if you intend to do interactive saves.

Definition at line 341 of file savegame.cpp.

virtual savegame::savegame::~savegame ( )

inlinevirtual

Definition at line 109 of file savegame.hpp.

Member Function Documentation

void savegame::savegame::before_save ( )

protected

If there needs to be some data fiddling before saving the game, this is the place to go.

Definition at line 449 of file savegame.cpp.

bool savegame::savegame::check_filename	(	const std::string &	filename,
		CVideo &	video
	)

protected

Check, if the filename contains illegal constructs like ".gz".

Definition at line 422 of file savegame.cpp.

References _(), filesystem::is_compressed_file(), and gui2::show_error_message().

Referenced by savegame::oos_savegame::show_save_dialog().

bool savegame::savegame::check_overwrite ( CVideo & video )

private

Ask the user if an existing file should be overwritten.

Definition at line 409 of file savegame.cpp.

References _(), filename_, gui2::twindow::OK, savegame::save_game_exists(), gui2::show_message(), and gui2::tmessage::yes_no_buttons.

virtual void savegame::savegame::create_filename ( )

inlineprivatevirtual

Build the filename according to the specific savegame's needs.

Subclasses will have to override this to take effect.

Reimplemented in savegame::autosave_savegame, savegame::replay_savegame, and savegame::ingame_savegame.

Definition at line 157 of file savegame.hpp.

const std::string& savegame::savegame::filename ( ) const

inline

Definition at line 123 of file savegame.hpp.

References filename_.

Referenced by savegame::autosave_savegame::create_filename(), and savegame::oos_savegame::show_save_dialog().

void savegame::savegame::finish_save_game ( const config_writer & out )

private

Update the save_index.

Definition at line 522 of file savegame.cpp.

References _(), e, config_writer::good(), savegame::save_index_class::remove(), savegame::save_index_manager, and game::error::what().

const saved_game& savegame::savegame::gamestate ( )

inlineprotected

Definition at line 143 of file savegame.hpp.

Referenced by savegame::ingame_savegame::create_filename(), savegame::replay_savegame::create_filename(), savegame::autosave_savegame::create_filename(), savegame::ingame_savegame::write_game(), savegame::replay_savegame::write_game(), and savegame::scenariostart_savegame::write_game().

bool savegame::savegame::is_illegal_file_char ( char c )

staticprivate

Checks if a certain character is allowed in a savefile name.

Definition at line 433 of file savegame.cpp.

filesystem::scoped_ostream savegame::savegame::open_save_game ( const std::string & label )

private

Throws game::save_game_failed.

Definition at line 535 of file savegame.cpp.

References e, filesystem::get_saves_dir(), filesystem::ostream_file(), replace_space2underbar(), and game::error::what().

bool savegame::savegame::save_game	(	CVideo *	video = `nullptr`,
		const std::string &	filename = `""`
	)

protected

Save a game without any further user interaction.

If you want notifying messages or error messages to appear, you have to provide the gui parameter. The return value denotes, if the save was successful or not.

Definition at line 453 of file savegame.cpp.

References _(), e, persist_manager::end_transaction(), ERR_SAVE, filename_, LOG_SAVE, game::error::message, resources::persist, gui2::show_error_message(), gui2::show_transient_message(), and persist_manager::start_transaction().

bool savegame::savegame::save_game_automatic	(	CVideo &	video,
		bool	ask_for_overwrite = `false`,
		const std::string &	filename = `""`
	)

Saves a game without user interaction, unless the file exists and it should be asked to overwrite it.

The return value denotes, if the save was successful or not. This is used by automatically generated replays, start-of-scenario saves, autosaves, and saves from the console (e.g. ":w").

Definition at line 350 of file savegame.cpp.

References filename_, and gui::OK_CANCEL.

Referenced by savegame::autosave_savegame::autosave(), play_controller::do_consolesave(), campaign_controller::play_game(), play_controller::save_game_auto(), play_controller::save_replay_auto(), and game_launcher::unit_test().