frosch@10127: /* $Id$ */
frosch@10127: 
frosch@10127: /** @file autoreplace.cpp Management of replacement lists. */
frosch@10127: 
frosch@10127: #include "stdafx.h"
frosch@10127: #include "openttd.h"
frosch@10127: #include "debug.h"
frosch@10127: #include "command_func.h"
frosch@10127: #include "saveload.h"
frosch@10127: #include "group.h"
frosch@10127: #include "autoreplace_base.h"
frosch@10127: #include "oldpool_func.h"
frosch@10127: 
frosch@10127: DEFINE_OLD_POOL_GENERIC(EngineRenew, EngineRenew)
frosch@10127: 
frosch@10127: /**
frosch@10127:  * Retrieves the EngineRenew that specifies the replacement of the given
frosch@10127:  * engine type from the given renewlist */
frosch@10127: static EngineRenew *GetEngineReplacement(EngineRenewList erl, EngineID engine, GroupID group)
frosch@10127: {
frosch@10127: 	EngineRenew *er = (EngineRenew *)erl;
frosch@10127: 
frosch@10127: 	while (er) {
frosch@10127: 		if (er->from == engine && er->group_id == group) return er;
frosch@10127: 		er = er->next;
frosch@10127: 	}
frosch@10127: 	return NULL;
frosch@10127: }
frosch@10127: 
frosch@10127: void RemoveAllEngineReplacement(EngineRenewList *erl)
frosch@10127: {
frosch@10127: 	EngineRenew *er = (EngineRenew *)(*erl);
frosch@10127: 	EngineRenew *next;
frosch@10127: 
frosch@10127: 	while (er != NULL) {
frosch@10127: 		next = er->next;
frosch@10127: 		delete er;
frosch@10127: 		er = next;
frosch@10127: 	}
frosch@10127: 	*erl = NULL; // Empty list
frosch@10127: }
frosch@10127: 
frosch@10127: EngineID EngineReplacement(EngineRenewList erl, EngineID engine, GroupID group)
frosch@10127: {
frosch@10127: 	const EngineRenew *er = GetEngineReplacement(erl, engine, group);
frosch@10127: 	if (er == NULL && (group == DEFAULT_GROUP || (IsValidGroupID(group) && !GetGroup(group)->replace_protection))) {
frosch@10127: 		/* We didn't find anything useful in the vehicle's own group so we will try ALL_GROUP */
frosch@10127: 		er = GetEngineReplacement(erl, engine, ALL_GROUP);
frosch@10127: 	}
frosch@10127: 	return er == NULL ? INVALID_ENGINE : er->to;
frosch@10127: }
frosch@10127: 
frosch@10127: CommandCost AddEngineReplacement(EngineRenewList *erl, EngineID old_engine, EngineID new_engine, GroupID group, uint32 flags)
frosch@10127: {
frosch@10127: 	EngineRenew *er;
frosch@10127: 
frosch@10127: 	/* Check if the old vehicle is already in the list */
frosch@10127: 	er = GetEngineReplacement(*erl, old_engine, group);
frosch@10127: 	if (er != NULL) {
frosch@10127: 		if (flags & DC_EXEC) er->to = new_engine;
frosch@10127: 		return CommandCost();
frosch@10127: 	}
frosch@10127: 
frosch@10127: 	if (!EngineRenew::CanAllocateItem()) return CMD_ERROR;
frosch@10127: 
frosch@10127: 	if (flags & DC_EXEC) {
frosch@10127: 		er = new EngineRenew(old_engine, new_engine);
frosch@10127: 		er->group_id = group;
frosch@10127: 
frosch@10127: 		/* Insert before the first element */
frosch@10127: 		er->next = (EngineRenew *)(*erl);
frosch@10127: 		*erl = (EngineRenewList)er;
frosch@10127: 	}
frosch@10127: 
frosch@10127: 	return CommandCost();
frosch@10127: }
frosch@10127: 
frosch@10127: CommandCost RemoveEngineReplacement(EngineRenewList *erl, EngineID engine, GroupID group, uint32 flags)
frosch@10127: {
frosch@10127: 	EngineRenew *er = (EngineRenew *)(*erl);
frosch@10127: 	EngineRenew *prev = NULL;
frosch@10127: 
frosch@10127: 	while (er)
frosch@10127: 	{
frosch@10127: 		if (er->from == engine && er->group_id == group) {
frosch@10127: 			if (flags & DC_EXEC) {
frosch@10127: 				if (prev == NULL) { // First element
frosch@10127: 					/* The second becomes the new first element */
frosch@10127: 					*erl = (EngineRenewList)er->next;
frosch@10127: 				} else {
frosch@10127: 					/* Cut this element out */
frosch@10127: 					prev->next = er->next;
frosch@10127: 				}
frosch@10127: 				delete er;
frosch@10127: 			}
frosch@10127: 			return CommandCost();
frosch@10127: 		}
frosch@10127: 		prev = er;
frosch@10127: 		er = er->next;
frosch@10127: 	}
frosch@10127: 
frosch@10127: 	return CMD_ERROR;
frosch@10127: }
frosch@10127: 
frosch@10127: static const SaveLoad _engine_renew_desc[] = {
frosch@10127: 	    SLE_VAR(EngineRenew, from,     SLE_UINT16),
frosch@10127: 	    SLE_VAR(EngineRenew, to,       SLE_UINT16),
frosch@10127: 
frosch@10127: 	    SLE_REF(EngineRenew, next,     REF_ENGINE_RENEWS),
frosch@10127: 	SLE_CONDVAR(EngineRenew, group_id, SLE_UINT16, 60, SL_MAX_VERSION),
frosch@10127: 	SLE_END()
frosch@10127: };
frosch@10127: 
frosch@10127: static void Save_ERNW()
frosch@10127: {
frosch@10127: 	EngineRenew *er;
frosch@10127: 
frosch@10127: 	FOR_ALL_ENGINE_RENEWS(er) {
frosch@10127: 		SlSetArrayIndex(er->index);
frosch@10127: 		SlObject(er, _engine_renew_desc);
frosch@10127: 	}
frosch@10127: }
frosch@10127: 
frosch@10127: static void Load_ERNW()
frosch@10127: {
frosch@10127: 	int index;
frosch@10127: 
frosch@10127: 	while ((index = SlIterateArray()) != -1) {
frosch@10127: 		EngineRenew *er = new (index) EngineRenew();
frosch@10127: 		SlObject(er, _engine_renew_desc);
frosch@10127: 
frosch@10127: 		/* Advanced vehicle lists, ungrouped vehicles got added */
frosch@10127: 		if (CheckSavegameVersion(60)) {
frosch@10127: 			er->group_id = ALL_GROUP;
frosch@10127: 		} else if (CheckSavegameVersion(71)) {
frosch@10127: 			if (er->group_id == DEFAULT_GROUP) er->group_id = ALL_GROUP;
frosch@10127: 		}
frosch@10127: 	}
frosch@10127: }
frosch@10127: 
frosch@10127: extern const ChunkHandler _autoreplace_chunk_handlers[] = {
frosch@10127: 	{ 'ERNW', Save_ERNW,     Load_ERNW,     CH_ARRAY | CH_LAST},
frosch@10127: };
frosch@10127: 
frosch@10127: void InitializeEngineRenews()
frosch@10127: {
frosch@10127: 	/* Clean the engine renew pool and create 1 block in it */
frosch@10127: 	_EngineRenew_pool.CleanPool();
frosch@10127: 	_EngineRenew_pool.AddBlockToPool();
frosch@10127: }