Class to backup a specific variable and restore it later. More...

#include <backup_type.hpp>

Public Member Functions
	Backup (T &original, const std::source_location location=std::source_location::current())
	Backup variable.
template<typename U>
	Backup (T &original, const U &new_value, const std::source_location location=std::source_location::current())
	Backup variable and switch to new value.
	~Backup ()
	Check whether the variable was restored on object destruction.
bool	IsValid () const
	Checks whether the variable was already restored.
const T &	GetOriginalValue () const
	Returns the backupped value.
template<typename U>
void	Change (const U &new_value)
	Change the value of the variable.
void	Revert ()
	Revert the variable to its original value, but do not mark it as restored.
void	Trash ()
	Trash the backup.
void	Restore ()
	Restore the variable.
void	Update ()
	Update the backup.
bool	Verify () const
	Check whether the variable is currently equals the backup.

Private Attributes
T &	original
	Reference to the value we are backing up.
bool	valid
	Whether the original value has been restored.
T	original_value
	The value at the moment of making a backup.
const std::source_location	location
	Call location where the backup was created.

Detailed Description

template<typename T>
struct Backup< T >

Class to backup a specific variable and restore it later.

The variable is not restored automatically, but assertions make sure it is restored. You have to call either Trash() or Restore() exactly once.

Definition at line 21 of file backup_type.hpp.

Constructor & Destructor Documentation

◆ Backup() [1/2]

template<typename T>

Backup< T >::Backup	(	T &	original,
		const std::source_location	location = std::source_location::current() )

inline

Backup variable.

Parameters

original	Variable to backup.
location	Source location for debug output.

Definition at line 27 of file backup_type.hpp.

References location, original, original_value, and valid.

◆ Backup() [2/2]

template<typename T>

template<typename U>

Backup< T >::Backup	(	T &	original,
		const U &	new_value,
		const std::source_location	location = std::source_location::current() )

inline

Backup variable and switch to new value.

Parameters

original	Variable to backup.
new_value	New value for variable.
location	Source location for debug output.

Definition at line 36 of file backup_type.hpp.

References location, original, original_value, and valid.

◆ ~Backup()

template<typename T>

Backup< T >::~Backup ( )

inline

Check whether the variable was restored on object destruction.

Definition at line 45 of file backup_type.hpp.

References Debug, location, Restore(), and valid.

Member Function Documentation

◆ Change()

template<typename T>

template<typename U>

void Backup< T >::Change ( const U & new_value )

inline

Change the value of the variable.

While this does not touch the backup at all, it ensures that the variable is only modified while backupped.

Parameters

new_value New value for variable.

Definition at line 81 of file backup_type.hpp.

References valid.

Referenced by CmdTerraformLand(), AI::GameLoop(), Game::GameLoop(), CommandHelperBase::InternalExecutePrepTest(), and Game::StartNew().

◆ GetOriginalValue()

template<typename T>

const T & Backup< T >::GetOriginalValue ( ) const

inline

Returns the backupped value.

Returns: value from the backup.

Definition at line 69 of file backup_type.hpp.

References original_value, and valid.

Referenced by CmdBuildIndustry().

◆ IsValid()

template<typename T>

bool Backup< T >::IsValid ( ) const

inline

Checks whether the variable was already restored.

Returns: true if variable has already been restored.

Definition at line 60 of file backup_type.hpp.

References valid.

Referenced by _GenerateWorld().

◆ Restore()

template<typename T>

void Backup< T >::Restore ( )

inline

Restore the variable.

Definition at line 109 of file backup_type.hpp.

References Revert(), and Trash().

Referenced by _GenerateWorld(), AfterLoadGame(), AircraftEventHandler_HeliTakeOff(), AircraftEventHandler_Landing(), CanBuildTramTrackOnTile(), ChangeOwnershipOfCompanyItems(), CheckClearTile(), CheckIfCanLevelIndustryPlatform(), CheckIfIndustryTilesAreFree(), CmdBuildIndustry(), CmdFoundTown(), CmdTerraformLand(), CreateRandomTown(), DoDryUp(), DoFloodTile(), DrawSpriteToRgbaBuffer(), FloodHalftile(), AI::GameLoop(), Game::GameLoop(), GenerateDesertArea(), GrowTown(), HandleStationRefit(), CommandHelperBase::InternalExecuteProcessResult(), AI::IsPaused(), NetworkClientsToSpectators(), AI::NewEvent(), Game::NewEvent(), FoundTownWindow::OnQueryTextFinished(), AI::Pause(), PlaceInitialIndustry(), ResetLandscapeConfirmationCallback(), AI::Save(), Game::Save(), AI::StartNew(), Game::StartNew(), StateGameLoop(), AI::Stop(), TileLoop_Town(), TownActionBuildStatue(), Game::Uninitialize(), AI::Unpause(), VehicleEnterDepot(), and ~Backup().

◆ Revert()

template<typename T>

void Backup< T >::Revert ( )

inline

Revert the variable to its original value, but do not mark it as restored.

Definition at line 91 of file backup_type.hpp.

References original_value, and valid.

Referenced by Restore().

◆ Trash()

template<typename T>

void Backup< T >::Trash ( )

inline

Trash the backup.

The variable shall not be restored anymore.

Definition at line 100 of file backup_type.hpp.

References valid.

Referenced by _GenerateWorld(), CommandHelperBase::InternalExecuteProcessResult(), and Restore().

◆ Update()

template<typename T>

void Backup< T >::Update ( )

inline

Update the backup.

That is trash the old value and make the current value of the variable the value to be restored later.

Definition at line 119 of file backup_type.hpp.

References original_value, and valid.

◆ Verify()

template<typename T>

bool Backup< T >::Verify ( ) const

inline

Check whether the variable is currently equals the backup.

Returns: true if equal

Definition at line 129 of file backup_type.hpp.

References original_value, and valid.

Referenced by CommandHelperBase::InternalExecuteProcessResult().

Field Documentation

◆ location

template<typename T>

const std::source_location Backup< T >::location

private

Call location where the backup was created.

Definition at line 140 of file backup_type.hpp.

Referenced by Backup(), Backup(), and ~Backup().

◆ original

template<typename T>

T& Backup< T >::original

private

Reference to the value we are backing up.

Definition at line 136 of file backup_type.hpp.

Referenced by Backup(), and Backup().

◆ original_value

template<typename T>

T Backup< T >::original_value

private

The value at the moment of making a backup.

Definition at line 138 of file backup_type.hpp.

Referenced by Backup(), Backup(), GetOriginalValue(), Revert(), Update(), and Verify().

◆ valid

template<typename T>

bool Backup< T >::valid

private

Whether the original value has been restored.

Definition at line 137 of file backup_type.hpp.

Referenced by Backup(), Backup(), Change(), GetOriginalValue(), IsValid(), Revert(), Trash(), Update(), Verify(), and ~Backup().

The documentation for this struct was generated from the following file:

src/core/backup_type.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Backup() [1/2]

◆ Backup() [2/2]

◆ ~Backup()

Member Function Documentation

◆ Change()

◆ GetOriginalValue()

◆ IsValid()

◆ Restore()

◆ Revert()

◆ Trash()

◆ Update()

◆ Verify()

Field Documentation

◆ location

◆ original

◆ original_value

◆ valid