rubidium@6643: /* $Id$ */
rubidium@6643: 
rubidium@6643: /** @file group_cmd.cpp Handling of the engine groups */
rubidium@6643: 
rubidium@6643: #include "stdafx.h"
rubidium@6643: #include "openttd.h"
rubidium@6643: #include "functions.h"
rubidium@6643: #include "player.h"
rubidium@6643: #include "table/strings.h"
rubidium@6643: #include "command.h"
rubidium@6643: #include "vehicle.h"
rubidium@6643: #include "saveload.h"
rubidium@6643: #include "debug.h"
rubidium@6643: #include "group.h"
rubidium@6643: #include "train.h"
rubidium@6643: #include "aircraft.h"
rubidium@6643: #include "string.h"
peter1138@6667: #include "window.h"
peter1138@6667: #include "vehicle_gui.h"
rubidium@6643: 
rubidium@6643: /**
rubidium@6643:  * Update the num engines of a groupID. Decrease the old one and increase the new one
rubidium@6643:  * @note called in SetTrainGroupID and UpdateTrainGroupID
rubidium@6643:  * @param i     EngineID we have to update
rubidium@6643:  * @param old_g index of the old group
rubidium@6643:  * @param new_g index of the new group
rubidium@6643:  */
rubidium@6643: static inline void UpdateNumEngineGroup(EngineID i, GroupID old_g, GroupID new_g)
rubidium@6643: {
rubidium@6643: 	if (old_g != new_g) {
rubidium@6643: 		/* Decrease the num engines of EngineID i of the old group if it's not the default one */
rubidium@6643: 		if (!IsDefaultGroupID(old_g) && IsValidGroupID(old_g)) GetGroup(old_g)->num_engines[i]--;
rubidium@6643: 
rubidium@6643: 		/* Increase the num engines of EngineID i of the new group if it's not the new one */
rubidium@6643: 		if (!IsDefaultGroupID(new_g) && IsValidGroupID(new_g)) GetGroup(new_g)->num_engines[i]++;
rubidium@6643: 	}
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: /**
rubidium@6643:  * Called if a new block is added to the group-pool
rubidium@6643:  */
rubidium@6643: static void GroupPoolNewBlock(uint start_item)
rubidium@6643: {
rubidium@6643: 	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.
rubidium@6643: 	 * TODO - This is just a temporary stage, this will be removed. */
rubidium@6643: 	for (Group *g = GetGroup(start_item); g != NULL; g = (g->index + 1U < GetGroupPoolSize()) ? GetGroup(g->index + 1) : NULL) g->index = start_item++;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: DEFINE_OLD_POOL(Group, Group, GroupPoolNewBlock, NULL)
rubidium@6643: 
rubidium@6643: static Group *AllocateGroup(void)
rubidium@6643: {
rubidium@6643: 	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.
rubidium@6643: 	 * TODO - This is just a temporary stage, this will be removed. */
rubidium@6643: 	for (Group *g = GetGroup(0); g != NULL; g = (g->index + 1U < GetGroupPoolSize()) ? GetGroup(g->index + 1) : NULL) {
rubidium@6643: 		if (!IsValidGroup(g)) {
rubidium@6643: 			const GroupID index = g->index;
rubidium@6643: 
rubidium@6643: 			memset(g, 0, sizeof(*g));
rubidium@6643: 			g->index = index;
rubidium@6643: 
rubidium@6643: 			return g;
rubidium@6643: 		}
rubidium@6643: 	}
rubidium@6643: 
rubidium@6643: 	/* Check if we can add a block to the pool */
rubidium@6643: 	return (AddBlockToPool(&_Group_pool)) ? AllocateGroup() : NULL;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: void InitializeGroup(void)
rubidium@6643: {
rubidium@6643: 	CleanPool(&_Group_pool);
rubidium@6643: 	AddBlockToPool(&_Group_pool);
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
peter1138@6667: static WindowClass GetWCForVT(VehicleType vt)
peter1138@6667: {
peter1138@6667: 	switch (vt) {
peter1138@6667: 		default:
peter1138@6667: 		case VEH_TRAIN:    return WC_TRAINS_LIST;
peter1138@6667: 		case VEH_ROAD:     return WC_ROADVEH_LIST;
peter1138@6667: 		case VEH_SHIP:     return WC_SHIPS_LIST;
peter1138@6667: 		case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;
peter1138@6667: 	}
peter1138@6667: }
peter1138@6667: 
peter1138@6667: 
rubidium@6643: /**
rubidium@6643:  * Add a vehicle to a group
rubidium@6643:  * @param tile unused
rubidium@6643:  * @param p1   vehicle type
rubidium@6643:  * @param p2   unused
rubidium@6643:  */
rubidium@6643: int32 CmdCreateGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
rubidium@6643: {
rubidium@6643: 	VehicleType vt = (VehicleType)p1;
rubidium@6643: 	if (!IsPlayerBuildableVehicleType(vt)) return CMD_ERROR;
rubidium@6643: 
rubidium@6643: 	Group *g = AllocateGroup();
rubidium@6643: 	if (g == NULL) return CMD_ERROR;
rubidium@6643: 
rubidium@6643: 	if (flags & DC_EXEC) {
rubidium@6643: 		g->owner = _current_player;
rubidium@6643: 		g->string_id = STR_SV_GROUP_NAME;
rubidium@6643: 		g->replace_protection = false;
rubidium@6643: 		g->vehicle_type = vt;
peter1138@6667: 
peter1138@6667: 		InvalidateWindowData(GetWCForVT(vt), (vt << 11) | VLW_GROUP_LIST | _current_player);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6643: 	return 0;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: /**
rubidium@6643:  * Add a vehicle to a group
rubidium@6643:  * @param tile unused
rubidium@6643:  * @param p1   index of array group
rubidium@6643:  *      - p1 bit 0-15 : GroupID
rubidium@6643:  * @param p2   unused
rubidium@6643:  */
rubidium@6643: int32 CmdDeleteGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
rubidium@6643: {
rubidium@6643: 	if (!IsValidGroupID(p1)) return CMD_ERROR;
rubidium@6643: 
rubidium@6643: 	Group *g = GetGroup(p1);
rubidium@6643: 	if (g->owner != _current_player) return CMD_ERROR;
rubidium@6643: 
rubidium@6643: 	if (flags & DC_EXEC) {
rubidium@6643: 		Vehicle *v;
rubidium@6643: 
rubidium@6643: 		/* Add all vehicles belong to the group to the default group */
rubidium@6643: 		FOR_ALL_VEHICLES(v) {
rubidium@6643: 			if (v->group_id == g->index && v->type == g->vehicle_type) v->group_id = DEFAULT_GROUP;
rubidium@6643: 		}
rubidium@6643: 
rubidium@6643: 		/* If we set an autoreplace for the group we delete, remove it. */
rubidium@6643: 		if (_current_player < MAX_PLAYERS) {
rubidium@6643: 			Player *p;
rubidium@6643: 			EngineRenew *er;
rubidium@6643: 
rubidium@6643: 			p = GetPlayer(_current_player);
rubidium@6643: 			FOR_ALL_ENGINE_RENEWS(er) {
rubidium@6643: 				if (er->group_id == g->index) RemoveEngineReplacementForPlayer(p, er->from, g->index, flags);
rubidium@6643: 			}
rubidium@6643: 		}
rubidium@6643: 
peter1138@6667: 		VehicleType vt = g->vehicle_type;
peter1138@6667: 
rubidium@6643: 		/* Delete the Replace Vehicle Windows */
rubidium@6643: 		DeleteWindowById(WC_REPLACE_VEHICLE, g->vehicle_type);
rubidium@6643: 		DeleteGroup(g);
peter1138@6667: 
peter1138@6667: 		InvalidateWindowData(GetWCForVT(vt), (vt << 11) | VLW_GROUP_LIST | _current_player);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6643: 	return 0;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: /**
rubidium@6643:  * Rename a group
rubidium@6643:  * @param tile unused
rubidium@6643:  * @param p1   index of array group
rubidium@6643:  *   - p1 bit 0-15 : GroupID
rubidium@6643:  * @param p2   unused
rubidium@6643:  */
rubidium@6643: int32 CmdRenameGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
rubidium@6643: {
rubidium@6643: 	if (!IsValidGroupID(p1) || StrEmpty(_cmd_text)) return CMD_ERROR;
rubidium@6643: 
peter1138@6667: 	Group *g = GetGroup(p1);
peter1138@6667: 	if (g->owner != _current_player) return CMD_ERROR;
peter1138@6667: 
rubidium@6643: 	/* Create the name */
rubidium@6643: 	StringID str = AllocateName(_cmd_text, 0);
rubidium@6643: 	if (str == STR_NULL) return CMD_ERROR;
rubidium@6643: 
rubidium@6643: 	if (flags & DC_EXEC) {
rubidium@6643: 		/* Delete the old name */
rubidium@6643: 		DeleteName(g->string_id);
rubidium@6643: 		/* Assign the new one */
rubidium@6643: 		g->string_id = str;
peter1138@6667: 
peter1138@6667: 		InvalidateWindowData(GetWCForVT(g->vehicle_type), (g->vehicle_type << 11) | VLW_GROUP_LIST | _current_player);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6643: 	return 0;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: /**
rubidium@6643:  * Add a vehicle to a group
rubidium@6643:  * @param tile unused
rubidium@6643:  * @param p1   index of array group
rubidium@6643:  *   - p1 bit 0-15 : GroupID
rubidium@6643:  * @param p2   vehicle to add to a group
rubidium@6643:  *   - p2 bit 0-15 : VehicleID
rubidium@6643:  */
rubidium@6643: int32 CmdAddVehicleGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
rubidium@6643: {
rubidium@6643: 	GroupID new_g = p1;
rubidium@6643: 
rubidium@6651: 	if (!IsValidVehicleID(p2) || (!IsValidGroupID(new_g) && !IsDefaultGroupID(new_g))) return CMD_ERROR;
rubidium@6643: 
peter1138@6671: 	if (IsValidGroupID(new_g)) {
peter1138@6671: 		Group *g = GetGroup(new_g);
peter1138@6671: 		if (g->owner != _current_player) return CMD_ERROR;
peter1138@6671: 	}
peter1138@6667: 
rubidium@6643: 	Vehicle *v = GetVehicle(p2);
rubidium@6643: 	if (v->owner != _current_player || (v->type == VEH_TRAIN && !IsFrontEngine(v))) return CMD_ERROR;
rubidium@6643: 
rubidium@6643: 	if (flags & DC_EXEC) {
rubidium@6643: 		DecreaseGroupNumVehicle(v->group_id);
rubidium@6643: 		IncreaseGroupNumVehicle(new_g);
rubidium@6643: 
rubidium@6643: 		switch (v->type) {
rubidium@6643: 			default: NOT_REACHED();
rubidium@6643: 			case VEH_TRAIN:
rubidium@6643: 				SetTrainGroupID(v, new_g);
rubidium@6643: 				break;
rubidium@6643: 			case VEH_ROAD:
rubidium@6643: 			case VEH_SHIP:
rubidium@6643: 			case VEH_AIRCRAFT:
rubidium@6643: 				if (IsEngineCountable(v)) UpdateNumEngineGroup(v->engine_type, v->group_id, new_g);
rubidium@6643: 				v->group_id = new_g;
rubidium@6643: 				break;
rubidium@6643: 		}
rubidium@6643: 
rubidium@6643: 		/* Update the Replace Vehicle Windows */
rubidium@6643: 		InvalidateWindow(WC_REPLACE_VEHICLE, v->type);
peter1138@6667: 		InvalidateWindowData(GetWCForVT(v->type), (v->type << 11) | VLW_GROUP_LIST | _current_player);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6643: 	return 0;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: /**
rubidium@6643:  * Add all shared vehicles of all vehicles from a group
rubidium@6643:  * @param tile unused
rubidium@6643:  * @param p1   index of group array
rubidium@6643:  *  - p1 bit 0-15 : GroupID
rubidium@6643:  * @param p2   type of vehicles
rubidium@6643:  */
rubidium@6643: int32 CmdAddSharedVehicleGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
rubidium@6643: {
rubidium@6643: 	VehicleType type = (VehicleType)p2;
rubidium@6643: 	if (!IsValidGroupID(p1) || !IsPlayerBuildableVehicleType(type)) return CMD_ERROR;
rubidium@6643: 
rubidium@6643: 	if (flags & DC_EXEC) {
rubidium@6643: 		Vehicle *v;
rubidium@6643: 		VehicleType type = (VehicleType)p2;
rubidium@6643: 		GroupID id_g = p1;
rubidium@6643: 		uint subtype = (type == VEH_AIRCRAFT) ? AIR_AIRCRAFT : 0;
rubidium@6643: 
rubidium@6643: 		/* Find the first front engine which belong to the group id_g
rubidium@6643: 		 * then add all shared vehicles of this front engine to the group id_g */
rubidium@6643: 		FOR_ALL_VEHICLES(v) {
rubidium@6643: 			if ((v->type == type) && (
rubidium@6643: 					(type == VEH_TRAIN && IsFrontEngine(v)) ||
rubidium@6643: 					(type != VEH_TRAIN && v->subtype <= subtype))) {
rubidium@6643: 				if (v->group_id != id_g) continue;
rubidium@6643: 
rubidium@6643: 				/* For each shared vehicles add it to the group */
rubidium@6643: 				for (Vehicle *v2 = GetFirstVehicleFromSharedList(v); v2 != NULL; v2 = v2->next_shared) {
rubidium@6643: 					if (v2->group_id != id_g) CmdAddVehicleGroup(tile, flags, id_g, v2->index);
rubidium@6643: 				}
rubidium@6643: 			}
rubidium@6643: 		}
peter1138@6667: 
peter1138@6667: 		InvalidateWindowData(GetWCForVT(type), (type << 11) | VLW_GROUP_LIST | _current_player);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6643: 	return 0;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: /**
rubidium@6643:  * Remove all vehicles from a group
rubidium@6643:  * @param tile unused
rubidium@6643:  * @param p1   index of group array
rubidium@6643:  * - p1 bit 0-15 : GroupID
rubidium@6643:  * @param p2   type of vehicles
rubidium@6643:  */
rubidium@6643: int32 CmdRemoveAllVehiclesGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
rubidium@6643: {
rubidium@6643: 	VehicleType type = (VehicleType)p2;
rubidium@6643: 	if (!IsValidGroupID(p1) || !IsPlayerBuildableVehicleType(type)) return CMD_ERROR;
rubidium@6643: 
peter1138@6667: 	Group *g = GetGroup(p1);
peter1138@6667: 	if (g->owner != _current_player) return CMD_ERROR;
peter1138@6667: 
rubidium@6643: 	if (flags & DC_EXEC) {
rubidium@6643: 		GroupID old_g = p1;
rubidium@6643: 		uint subtype = (type == VEH_AIRCRAFT) ? AIR_AIRCRAFT : 0;
rubidium@6643: 		Vehicle *v;
rubidium@6643: 
rubidium@6643: 		/* Find each Vehicle that belongs to the group old_g and add it to the default group */
rubidium@6643: 		FOR_ALL_VEHICLES(v) {
rubidium@6643: 			if ((v->type == type) && (
rubidium@6643: 					(type == VEH_TRAIN && IsFrontEngine(v)) ||
rubidium@6643: 					(type != VEH_TRAIN && v->subtype <= subtype))) {
rubidium@6643: 				if (v->group_id != old_g) continue;
rubidium@6643: 
rubidium@6643: 				/* Add The Vehicle to the default group */
rubidium@6643: 				CmdAddVehicleGroup(tile, flags, DEFAULT_GROUP, v->index);
rubidium@6643: 			}
rubidium@6643: 		}
peter1138@6667: 
peter1138@6667: 		InvalidateWindowData(GetWCForVT(type), (type << 11) | VLW_GROUP_LIST | _current_player);
peter1138@6667: 	}
peter1138@6667: 
peter1138@6667: 	return 0;
peter1138@6667: }
peter1138@6667: 
peter1138@6667: 
peter1138@6667: /**
peter1138@6667:  * (Un)set global replace protection from a group
peter1138@6667:  * @param tile unused
peter1138@6667:  * @param p1   index of group array
peter1138@6667:  * - p1 bit 0-15 : GroupID
peter1138@6667:  * @param p2
peter1138@6667:  * - p2 bit 0    : 1 to set or 0 to clear protection.
peter1138@6667:  */
peter1138@6667: int32 CmdSetGroupReplaceProtection(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
peter1138@6667: {
peter1138@6667: 	if (!IsValidGroupID(p1)) return CMD_ERROR;
peter1138@6667: 
peter1138@6667: 	Group *g = GetGroup(p1);
peter1138@6667: 	if (g->owner != _current_player) return CMD_ERROR;
peter1138@6667: 
peter1138@6667: 	if (flags & DC_EXEC) {
peter1138@6667: 		g->replace_protection = HASBIT(p2, 0);
peter1138@6667: 
peter1138@6667: 		InvalidateWindowData(GetWCForVT(g->vehicle_type), (g->vehicle_type << 11) | VLW_GROUP_LIST | _current_player);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6643: 	return 0;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: /**
rubidium@6643:  * Decrease the num_vehicle variable before delete an front engine from a group
rubidium@6643:  * @note Called in CmdSellRailWagon and DeleteLasWagon,
rubidium@6643:  * @param v     FrontEngine of the train we want to remove.
rubidium@6643:  */
rubidium@6643: void RemoveVehicleFromGroup(const Vehicle *v)
rubidium@6643: {
rubidium@6643: 	if (!IsValidVehicle(v) || v->type != VEH_TRAIN || !IsFrontEngine(v)) return;
rubidium@6643: 
rubidium@6643: 	if (!IsDefaultGroupID(v->group_id)) DecreaseGroupNumVehicle(v->group_id);
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: /**
rubidium@6643:  * Affect the groupID of a train to new_g.
rubidium@6643:  * @note called in CmdAddVehicleGroup and CmdMoveRailVehicle
rubidium@6643:  * @param v     First vehicle of the chain.
rubidium@6643:  * @param new_g index of array group
rubidium@6643:  */
rubidium@6643: void SetTrainGroupID(Vehicle *v, GroupID new_g)
rubidium@6643: {
rubidium@6643: 	if (!IsValidGroupID(new_g) && !IsDefaultGroupID(new_g)) return;
rubidium@6643: 
rubidium@6643: 	assert(IsValidVehicle(v) && v->type == VEH_TRAIN && IsFrontEngine(v));
rubidium@6643: 
rubidium@6643: 	for (Vehicle *u = v; u != NULL; u = u->next) {
rubidium@6643: 		if (IsEngineCountable(u)) UpdateNumEngineGroup(u->engine_type, u->group_id, new_g);
rubidium@6643: 
rubidium@6643: 		u->group_id = new_g;
rubidium@6643: 	}
rubidium@6643: 
rubidium@6643: 	/* Update the Replace Vehicle Windows */
rubidium@6643: 	InvalidateWindow(WC_REPLACE_VEHICLE, VEH_TRAIN);
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: /**
rubidium@6643:  * Recalculates the groupID of a train. Should be called each time a vehicle is added
rubidium@6643:  * to/removed from the chain,.
rubidium@6643:  * @note this needs to be called too for 'wagon chains' (in the depot, without an engine)
rubidium@6643:  * @note Called in CmdBuildRailVehicle, CmdBuildRailWagon, CmdMoveRailVehicle, CmdSellRailWagon
rubidium@6643:  * @param v First vehicle of the chain.
rubidium@6643:  */
rubidium@6643: void UpdateTrainGroupID(Vehicle *v)
rubidium@6643: {
rubidium@6643: 	assert(IsValidVehicle(v) && v->type == VEH_TRAIN && (IsFrontEngine(v) || IsFreeWagon(v)));
rubidium@6643: 
rubidium@6643: 	GroupID new_g = IsFrontEngine(v) ? v->group_id : (GroupID)DEFAULT_GROUP;
rubidium@6643: 	for (Vehicle *u = v; u != NULL; u = u->next) {
rubidium@6643: 		if (IsEngineCountable(u)) UpdateNumEngineGroup(u->engine_type, u->group_id, new_g);
rubidium@6643: 
rubidium@6643: 		u->group_id = new_g;
rubidium@6643: 	}
rubidium@6643: 
rubidium@6643: 	/* Update the Replace Vehicle Windows */
rubidium@6643: 	InvalidateWindow(WC_REPLACE_VEHICLE, VEH_TRAIN);
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: void RemoveAllGroupsForPlayer(const Player *p)
rubidium@6643: {
rubidium@6643: 	Group *g;
rubidium@6643: 
rubidium@6643: 	FOR_ALL_GROUPS(g) {
rubidium@6643: 		if (p->index == g->owner) DeleteGroup(g);
rubidium@6643: 	}
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: static const SaveLoad _group_desc[] = {
rubidium@6643:   SLE_VAR(Group, string_id,          SLE_UINT16),
rubidium@6643:   SLE_VAR(Group, num_vehicle,        SLE_UINT16),
rubidium@6643:   SLE_VAR(Group, owner,              SLE_UINT8),
rubidium@6643:   SLE_VAR(Group, vehicle_type,       SLE_UINT8),
rubidium@6643:   SLE_VAR(Group, replace_protection, SLE_BOOL),
rubidium@6643:   SLE_END()
rubidium@6643: };
rubidium@6643: 
rubidium@6643: 
rubidium@6643: static void Save_GROUP(void)
rubidium@6643: {
rubidium@6643: 	Group *g;
rubidium@6643: 
rubidium@6643: 	FOR_ALL_GROUPS(g) {
rubidium@6643: 		SlSetArrayIndex(g->index);
rubidium@6643: 		SlObject(g, _group_desc);
rubidium@6643: 	}
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: static void Load_GROUP(void)
rubidium@6643: {
rubidium@6643: 	int index;
rubidium@6643: 
rubidium@6643: 	while ((index = SlIterateArray()) != -1) {
rubidium@6643: 		if (!AddBlockIfNeeded(&_Group_pool, index)) {
rubidium@6643: 			error("Groups: failed loading savegame: too many groups");
rubidium@6643: 		}
rubidium@6643: 
rubidium@6643: 		Group *g = GetGroup(index);
rubidium@6643: 		SlObject(g, _group_desc);
rubidium@6643: 	}
rubidium@6643: }
rubidium@6643: 
rubidium@6643: extern const ChunkHandler _group_chunk_handlers[] = {
rubidium@6643: 	{ 'GRPS', Save_GROUP, Load_GROUP, CH_ARRAY | CH_LAST},
rubidium@6643: };