Changeset - r15282:8e9c51163c93
[Not reviewed]
master
0 17 0
frosch - 14 years ago 2010-06-05 12:16:12
frosch@openttd.org
(svn r19931) -Fix (r19914): Convert assertion in Backup<> destructor into DEBUG() output. It was triggered on exceptions, especially when aborting world generation.
17 files changed with 62 insertions and 44 deletions:
0 comments (0 inline, 0 general)
src/ai/ai_core.cpp
Show inline comments
 
@@ -69,7 +69,7 @@
 
	assert(_settings_game.difficulty.competitor_speed <= 4);
 
	if ((AI::frame_counter & ((1 << (4 - _settings_game.difficulty.competitor_speed)) - 1)) != 0) return;
 

	
 
	Backup<CompanyByte> cur_company(_current_company);
 
	Backup<CompanyByte> cur_company(_current_company, FILE_LINE);
 
	const Company *c;
 
	FOR_ALL_COMPANIES(c) {
 
		if (c->is_ai) {
 
@@ -96,7 +96,7 @@
 
{
 
	if (_networking && !_network_server) return;
 

	
 
	Backup<CompanyByte> cur_company(_current_company, company);
 
	Backup<CompanyByte> cur_company(_current_company, company, FILE_LINE);
 
	Company *c = Company::Get(company);
 

	
 
	delete c->ai_instance;
 
@@ -112,7 +112,7 @@
 
{
 
	if (_networking && !_network_server) return;
 

	
 
	Backup<CompanyByte> cur_company(_current_company, company);
 
	Backup<CompanyByte> cur_company(_current_company, company, FILE_LINE);
 
	Company::Get(company)->ai_instance->Suspend();
 

	
 
	cur_company.Restore();
 
@@ -201,7 +201,7 @@
 
	}
 

	
 
	/* Queue the event */
 
	Backup<CompanyByte> cur_company(_current_company, company);
 
	Backup<CompanyByte> cur_company(_current_company, company, FILE_LINE);
 
	AIEventController::InsertEvent(event);
 
	cur_company.Restore();
 

	
 
@@ -247,7 +247,7 @@ void CcAI(const CommandCost &result, Til
 
		Company *c = Company::GetIfValid(company);
 
		assert(c != NULL && c->ai_instance != NULL);
 

	
 
		Backup<CompanyByte> cur_company(_current_company, company);
 
		Backup<CompanyByte> cur_company(_current_company, company, FILE_LINE);
 
		c->ai_instance->Save();
 
		cur_company.Restore();
 
	} else {
 
@@ -261,7 +261,7 @@ void CcAI(const CommandCost &result, Til
 
		Company *c = Company::GetIfValid(company);
 
		assert(c != NULL && c->ai_instance != NULL);
 

	
 
		Backup<CompanyByte> cur_company(_current_company, company);
 
		Backup<CompanyByte> cur_company(_current_company, company, FILE_LINE);
 
		c->ai_instance->Load(version);
 
		cur_company.Restore();
 
	} else {
src/ai/ai_gui.cpp
Show inline comments
 
@@ -820,7 +820,7 @@ struct AIDebugWindow : public QueryStrin
 
			DrawCompanyIcon(i, button->pos_x + button->current_x / 2 - 7 + offset, this->GetWidget<NWidgetBase>(AID_WIDGET_COMPANY_BUTTON_START + i)->pos_y + 2 + offset);
 
		}
 

	
 
		Backup<CompanyByte> cur_company(_current_company, ai_debug_company);
 
		Backup<CompanyByte> cur_company(_current_company, ai_debug_company, FILE_LINE);
 
		AILog::LogData *log = (AILog::LogData *)AIObject::GetLogPointer();
 
		cur_company.Restore();
 

	
 
@@ -875,7 +875,7 @@ struct AIDebugWindow : public QueryStrin
 

	
 
		switch (widget) {
 
			case AID_WIDGET_LOG_PANEL: {
 
				Backup<CompanyByte> cur_company(_current_company, ai_debug_company);
 
				Backup<CompanyByte> cur_company(_current_company, ai_debug_company, FILE_LINE);
 
				AILog::LogData *log = (AILog::LogData *)AIObject::GetLogPointer();
 
				cur_company.Restore();
 
				if (log == NULL) return;
 
@@ -914,7 +914,7 @@ struct AIDebugWindow : public QueryStrin
 
		this->RaiseWidget(ai_debug_company + AID_WIDGET_COMPANY_BUTTON_START);
 
		ai_debug_company = show_ai;
 

	
 
		Backup<CompanyByte> cur_company(_current_company, ai_debug_company);
 
		Backup<CompanyByte> cur_company(_current_company, ai_debug_company, FILE_LINE);
 
		AILog::LogData *log = (AILog::LogData *)AIObject::GetLogPointer();
 
		cur_company.Restore();
 
		this->vscroll.SetCount((log == NULL) ? 0 : log->used);
 
@@ -1009,7 +1009,7 @@ struct AIDebugWindow : public QueryStrin
 
		/* If the log message is related to the active company tab, check the break string */
 
		if (data == ai_debug_company && this->break_check_enabled && !StrEmpty(this->edit_str_buf)) {
 
			/* Get the log instance of the active company */
 
			Backup<CompanyByte> cur_company(_current_company, ai_debug_company);
 
			Backup<CompanyByte> cur_company(_current_company, ai_debug_company, FILE_LINE);
 
			AILog::LogData *log = (AILog::LogData *)AIObject::GetLogPointer();
 

	
 
			if (log != NULL && case_sensitive_break_check?
src/aircraft_cmd.cpp
Show inline comments
 
@@ -1204,7 +1204,7 @@ void HandleMissingAircraftOrders(Aircraf
 
	 */
 
	const Station *st = GetTargetAirportIfValid(v);
 
	if (st == NULL) {
 
		Backup<CompanyByte> cur_company(_current_company, v->owner);
 
		Backup<CompanyByte> cur_company(_current_company, v->owner, FILE_LINE);
 
		CommandCost ret = DoCommand(v->tile, v->index, 0, DC_EXEC, CMD_SEND_AIRCRAFT_TO_HANGAR);
 
		cur_company.Restore();
 

	
 
@@ -1510,7 +1510,7 @@ static void AircraftEventHandler_HeliTak
 

	
 
	/* Send the helicopter to a hangar if needed for replacement */
 
	if (v->NeedsAutomaticServicing()) {
 
		Backup<CompanyByte> cur_company(_current_company, v->owner);
 
		Backup<CompanyByte> cur_company(_current_company, v->owner, FILE_LINE);
 
		DoCommand(v->tile, v->index, DEPOT_SERVICE | DEPOT_LOCATE_HANGAR, DC_EXEC, CMD_SEND_AIRCRAFT_TO_HANGAR);
 
		cur_company.Restore();
 
	}
 
@@ -1562,7 +1562,7 @@ static void AircraftEventHandler_Landing
 

	
 
	/* check if the aircraft needs to be replaced or renewed and send it to a hangar if needed */
 
	if (v->NeedsAutomaticServicing()) {
 
		Backup<CompanyByte> cur_company(_current_company, v->owner);
 
		Backup<CompanyByte> cur_company(_current_company, v->owner, FILE_LINE);
 
		DoCommand(v->tile, v->index, DEPOT_SERVICE, DC_EXEC, CMD_SEND_AIRCRAFT_TO_HANGAR);
 
		cur_company.Restore();
 
	}
src/core/backup_type.hpp
Show inline comments
 
@@ -12,6 +12,8 @@
 
#ifndef BACKUP_TYPE_HPP
 
#define BACKUP_TYPE_HPP
 

	
 
#include "../debug.h"
 

	
 
/**
 
 * Class to backup a specific variable and restore it later.
 
 * The variable is not restored automatically, but assertions make sure it is restored.
 
@@ -22,16 +24,20 @@ struct Backup {
 
	/**
 
	 * Backup variable.
 
	 * @param original Variable to backup.
 
	 * @param file Filename for debug output. Use FILE_LINE macro.
 
	 * @param line Linenumber for debug output. Use FILE_LINE macro.
 
	 */
 
	Backup(T &original) : original(original), valid(true), original_value(original) {}
 
	Backup(T &original, const char * const file, const int line) : original(original), valid(true), original_value(original), file(file), line(line) {}
 

	
 
	/**
 
	 * Backup variable and switch to new value.
 
	 * @param original Variable to backup.
 
	 * @param new_value New value for variable.
 
	 * @param file Filename for debug output. Use FILE_LINE macro.
 
	 * @param line Linenumber for debug output. Use FILE_LINE macro.
 
	 */
 
	template <typename U>
 
	Backup(T &original, const U &new_value) : original(original), valid(true), original_value(original)
 
	Backup(T &original, const U &new_value, const char * const file, const int line) : original(original), valid(true), original_value(original), file(file), line(line)
 
	{
 
		/* Note: We use a separate typename U, so type conversions are handled by assignment operator. */
 
		original = new_value;
 
@@ -43,7 +49,13 @@ struct Backup {
 
	~Backup()
 
	{
 
		/* Check whether restoration was done */
 
		assert(!this->valid);
 
		if (this->valid)
 
		{
 
			/* We cannot assert here, as missing restoration is 'normal' when exceptions are thrown.
 
			 * Exceptions are especially used to abort world generation. */
 
			DEBUG(misc, 0, "%s:%d: Backupped value was not restored!", this->file, this->line);
 
			this->Restore();
 
		}
 
	}
 

	
 
	/**
 
@@ -129,6 +141,9 @@ private:
 
	T &original;
 
	bool valid;
 
	T original_value;
 

	
 
	const char * const file;
 
	const int line;
 
};
 

	
 
#endif /* BACKUP_TYPE_HPP */
src/debug.h
Show inline comments
 
@@ -53,6 +53,9 @@
 
void SetDebugString(const char *s);
 
const char *GetDebugString();
 

	
 
/* Shorter form for passing filename and linenumber */
 
#define FILE_LINE __FILE__, __LINE__
 

	
 
/* Used for profiling
 
 *
 
 * Usage:
src/disaster_cmd.cpp
Show inline comments
 
@@ -73,7 +73,7 @@ static void DisasterClearSquare(TileInde
 
	switch (GetTileType(tile)) {
 
		case MP_RAILWAY:
 
			if (Company::IsHumanID(GetTileOwner(tile))) {
 
				Backup<CompanyByte> cur_company(_current_company, OWNER_WATER);
 
				Backup<CompanyByte> cur_company(_current_company, OWNER_WATER, FILE_LINE);
 
				DoCommand(tile, 0, 0, DC_EXEC, CMD_LANDSCAPE_CLEAR);
 
				cur_company.Restore();
 

	
 
@@ -83,7 +83,7 @@ static void DisasterClearSquare(TileInde
 
			break;
 

	
 
		case MP_HOUSE: {
 
			Backup<CompanyByte> cur_company(_current_company, OWNER_NONE);
 
			Backup<CompanyByte> cur_company(_current_company, OWNER_NONE, FILE_LINE);
 
			DoCommand(tile, 0, 0, DC_EXEC, CMD_LANDSCAPE_CLEAR);
 
			cur_company.Restore();
 
			break;
src/economy.cpp
Show inline comments
 
@@ -305,7 +305,7 @@ void ChangeOwnershipOfCompanyItems(Owner
 
#endif /* ENABLE_NETWORK */
 

	
 
	Town *t;
 
	Backup<CompanyByte> cur_company(_current_company, old_owner);
 
	Backup<CompanyByte> cur_company(_current_company, old_owner, FILE_LINE);
 

	
 
	assert(old_owner != new_owner);
 

	
 
@@ -327,7 +327,7 @@ void ChangeOwnershipOfCompanyItems(Owner
 
		}
 

	
 
		/* Sell all the shares that people have on this company */
 
		Backup<CompanyByte> cur_company2(_current_company);
 
		Backup<CompanyByte> cur_company2(_current_company, FILE_LINE);
 
		c = Company::Get(old_owner);
 
		for (i = 0; i < 4; i++) {
 
			cur_company2.Change(c->share_owners[i]);
 
@@ -553,7 +553,7 @@ static void CompaniesGenStatistics()
 
	Station *st;
 
	Company *c;
 

	
 
	Backup<CompanyByte> cur_company(_current_company);
 
	Backup<CompanyByte> cur_company(_current_company, FILE_LINE);
 
	FOR_ALL_STATIONS(st) {
 
		cur_company.Change(st->owner);
 
		CommandCost cost(EXPENSES_PROPERTY, _price[PR_STATION_VALUE] >> 1);
 
@@ -688,7 +688,7 @@ static void CompaniesPayInterest()
 
{
 
	const Company *c;
 

	
 
	Backup<CompanyByte> cur_company(_current_company);
 
	Backup<CompanyByte> cur_company(_current_company, FILE_LINE);
 
	FOR_ALL_COMPANIES(c) {
 
		cur_company.Change(c->index);
 

	
 
@@ -1027,7 +1027,7 @@ CargoPayment::~CargoPayment()
 

	
 
	if (this->visual_profit == 0) return;
 

	
 
	Backup<CompanyByte> cur_company(_current_company, this->front->owner);
 
	Backup<CompanyByte> cur_company(_current_company, this->front->owner, FILE_LINE);
 

	
 
	SubtractMoneyFromCompany(CommandCost(this->front->GetExpenseType(true), -this->route_profit));
 
	this->front->profit_this_year += this->visual_profit << 8;
 
@@ -1458,7 +1458,7 @@ static void DoAcquireCompany(Company *c)
 
	}
 

	
 
	value = CalculateCompanyValue(c) >> 2;
 
	Backup<CompanyByte> cur_company(_current_company);
 
	Backup<CompanyByte> cur_company(_current_company, FILE_LINE);
 
	for (i = 0; i != 4; i++) {
 
		if (c->share_owners[i] != COMPANY_SPECTATOR) {
 
			cur_company.Change(c->share_owners[i]);
src/industry_cmd.cpp
Show inline comments
 
@@ -1043,7 +1043,7 @@ static bool SearchLumberMillTrees(TileIn
 
	if (IsTileType(tile, MP_TREES) && GetTreeGrowth(tile) > 2) { ///< 3 and up means all fully grown trees
 
		/* found a tree */
 

	
 
		Backup<CompanyByte> cur_company(_current_company, OWNER_NONE);
 
		Backup<CompanyByte> cur_company(_current_company, OWNER_NONE, FILE_LINE);
 

	
 
		_industry_sound_ctr = 1;
 
		_industry_sound_tile = tile;
 
@@ -1372,7 +1372,7 @@ static CommandCost CheckIfIndustryTilesA
 
				}
 

	
 
				/* Clear the tiles as OWNER_TOWN to not affect town rating, and to not clear protected buildings */
 
				Backup<CompanyByte> cur_company(_current_company, OWNER_TOWN);
 
				Backup<CompanyByte> cur_company(_current_company, OWNER_TOWN, FILE_LINE);
 
				CommandCost ret = DoCommand(cur_tile, 0, 0, DC_NONE, CMD_LANDSCAPE_CLEAR);
 
				cur_company.Restore();
 

	
 
@@ -1484,7 +1484,7 @@ static bool CheckIfCanLevelIndustryPlatf
 

	
 
	/* _current_company is OWNER_NONE for randomly generated industries and in editor, or the company who funded or prospected the industry.
 
	 * Perform terraforming as OWNER_TOWN to disable autoslope and town ratings. */
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_TOWN);
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_TOWN, FILE_LINE);
 

	
 
	TILE_LOOP(tile_walk, size_x, size_y, cur_tile) {
 
		curh = TileHeight(tile_walk);
 
@@ -1788,7 +1788,7 @@ CommandCost CmdBuildIndustry(TileIndex t
 
	if (_game_mode != GM_EDITOR && _settings_game.construction.raw_industry_construction == 2 && indspec->IsRawIndustry()) {
 
		if (flags & DC_EXEC) {
 
			/* Prospected industries are build as OWNER_TOWN to not e.g. be build on owned land of the founder */
 
			Backup<CompanyByte> cur_company(_current_company, OWNER_TOWN);
 
			Backup<CompanyByte> cur_company(_current_company, OWNER_TOWN, FILE_LINE);
 
			/* Prospecting has a chance to fail, however we cannot guarantee that something can
 
			 * be built on the map, so the chance gets lower when the map is fuller, but there
 
			 * is nothing we can really do about that. */
 
@@ -1890,7 +1890,7 @@ static const byte _numof_industry_table[
 
 */
 
static void PlaceInitialIndustry(IndustryType type, bool try_hard)
 
{
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_NONE);
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_NONE, FILE_LINE);
 

	
 
	IncreaseGeneratingWorldProgress(GWP_INDUSTRY);
 

	
 
@@ -2414,7 +2414,7 @@ void IndustryDailyLoop()
 
		return;  // Nothing to do? get out
 
	}
 

	
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_NONE);
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_NONE, FILE_LINE);
 

	
 
	/* perform the required industry changes for the day */
 
	for (uint16 j = 0; j < change_loop; j++) {
 
@@ -2439,7 +2439,7 @@ void IndustryDailyLoop()
 
void IndustryMonthlyLoop()
 
{
 
	Industry *i;
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_NONE);
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_NONE, FILE_LINE);
 

	
 
	FOR_ALL_INDUSTRIES(i) {
 
		UpdateIndustryStatistics(i);
src/industry_gui.cpp
Show inline comments
 
@@ -523,7 +523,7 @@ public:
 
				return;
 
			}
 

	
 
			Backup<CompanyByte> cur_company(_current_company, OWNER_NONE);
 
			Backup<CompanyByte> cur_company(_current_company, OWNER_NONE, FILE_LINE);
 
			_generating_world = true;
 
			_ignore_restrictions = true;
 

	
src/misc_cmd.cpp
Show inline comments
 
@@ -230,7 +230,7 @@ CommandCost CmdGiveMoney(TileIndex tile,
 

	
 
	if (flags & DC_EXEC) {
 
		/* Add money to company */
 
		Backup<CompanyByte> cur_company(_current_company, dest_company);
 
		Backup<CompanyByte> cur_company(_current_company, dest_company, FILE_LINE);
 
		SubtractMoneyFromCompany(CommandCost(EXPENSES_OTHER, -amount.GetCost()));
 
		cur_company.Restore();
 
	}
src/openttd.cpp
Show inline comments
 
@@ -1216,7 +1216,7 @@ void StateGameLoop()
 

	
 
		/* All these actions has to be done from OWNER_NONE
 
		 *  for multiplayer compatibility */
 
		Backup<CompanyByte> cur_company(_current_company, OWNER_NONE);
 
		Backup<CompanyByte> cur_company(_current_company, OWNER_NONE, FILE_LINE);
 

	
 
		AnimateAnimatedTiles();
 
		IncreaseDate();
src/rail_cmd.cpp
Show inline comments
 
@@ -642,7 +642,7 @@ bool FloodHalftile(TileIndex t)
 

	
 
		TrackBits to_remove = lower_track & rail_bits;
 
		if (to_remove != 0) {
 
			Backup<CompanyByte> cur_company(_current_company, OWNER_WATER);
 
			Backup<CompanyByte> cur_company(_current_company, OWNER_WATER, FILE_LINE);
 
			flooded = DoCommand(t, 0, FIND_FIRST_BIT(to_remove), DC_EXEC, CMD_REMOVE_SINGLE_RAIL).Succeeded();
 
			cur_company.Restore();
 
			if (!flooded) return flooded; // not yet floodable
src/roadveh_cmd.cpp
Show inline comments
 
@@ -1160,7 +1160,7 @@ static Trackdir FollowPreviousRoadVehicl
 
static bool CanBuildTramTrackOnTile(CompanyID c, TileIndex t, RoadBits r)
 
{
 
	/* The 'current' company is not necessarily the owner of the vehicle. */
 
	Backup<CompanyByte> cur_company(_current_company, c);
 
	Backup<CompanyByte> cur_company(_current_company, c, FILE_LINE);
 

	
 
	CommandCost ret = DoCommand(t, ROADTYPE_TRAM << 4 | r, 0, DC_NONE, CMD_BUILD_ROAD);
 

	
src/saveload/afterload.cpp
Show inline comments
 
@@ -1571,7 +1571,7 @@ bool AfterLoadGame()
 
			if (IsBuoyTile(t) || IsDriveThroughStopTile(t) || IsTileType(t, MP_WATER)) {
 
				Owner o = GetTileOwner(t);
 
				if (o < MAX_COMPANIES && !Company::IsValidID(o)) {
 
					Backup<CompanyByte> cur_company(_current_company, o);
 
					Backup<CompanyByte> cur_company(_current_company, o, FILE_LINE);
 
					ChangeTileOwner(t, o, INVALID_OWNER);
 
					cur_company.Restore();
 
				}
src/town_cmd.cpp
Show inline comments
 
@@ -516,7 +516,7 @@ static void TileLoop_Town(TileIndex tile
 
		}
 
	}
 

	
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_TOWN);
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_TOWN, FILE_LINE);
 

	
 
	if ((hs->building_flags & BUILDING_HAS_1_TILE) &&
 
			HasBit(t->flags, TOWN_IS_FUNDED) &&
 
@@ -1297,7 +1297,7 @@ static bool GrowTown(Town *t)
 
	};
 

	
 
	/* Current "company" is a town */
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_TOWN);
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_TOWN, FILE_LINE);
 

	
 
	TileIndex tile = t->xy; // The tile we are working with ATM
 

	
 
@@ -2383,7 +2383,7 @@ static bool DoBuildStatueOfCompany(TileI
 
		return false;
 
	}
 

	
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_NONE);
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_NONE, FILE_LINE);
 
	CommandCost r = DoCommand(tile, 0, 0, DC_EXEC, CMD_LANDSCAPE_CLEAR);
 
	cur_company.Restore();
 

	
src/vehicle.cpp
Show inline comments
 
@@ -773,7 +773,7 @@ void CallVehicleTicks()
 
		}
 
	}
 

	
 
	Backup<CompanyByte> cur_company(_current_company);
 
	Backup<CompanyByte> cur_company(_current_company, FILE_LINE);
 
	for (AutoreplaceMap::iterator it = _vehicles_to_autoreplace.Begin(); it != _vehicles_to_autoreplace.End(); it++) {
 
		v = it->first;
 
		/* Autoreplace needs the current company set as the vehicle owner */
 
@@ -1112,7 +1112,7 @@ void VehicleEnterDepot(Vehicle *v)
 
		}
 

	
 
		if (t.IsRefit()) {
 
			Backup<CompanyByte> cur_company(_current_company, v->owner);
 
			Backup<CompanyByte> cur_company(_current_company, v->owner, FILE_LINE);
 
			CommandCost cost = DoCommand(v->tile, v->index, t.GetRefitCargo() | t.GetRefitSubtype() << 8, DC_EXEC, GetCmdRefitVeh(v));
 
			cur_company.Restore();
 

	
src/water_cmd.cpp
Show inline comments
 
@@ -882,7 +882,7 @@ void DoFloodTile(TileIndex target)
 

	
 
	bool flooded = false; // Will be set to true if something is changed.
 

	
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_WATER);
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_WATER, FILE_LINE);
 

	
 
	Slope tileh = GetTileSlope(target, NULL);
 
	if (tileh != SLOPE_FLAT) {
 
@@ -942,7 +942,7 @@ void DoFloodTile(TileIndex target)
 
 */
 
static void DoDryUp(TileIndex tile)
 
{
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_WATER);
 
	Backup<CompanyByte> cur_company(_current_company, OWNER_WATER, FILE_LINE);
 

	
 
	switch (GetTileType(tile)) {
 
		case MP_RAILWAY:
0 comments (0 inline, 0 general)