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"
peter1138@7097: #include "variables.h"
rubidium@8116: #include "command_func.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"
peter1138@6667: #include "vehicle_gui.h"
rubidium@8114: #include "strings_func.h"
rubidium@8131: #include "functions.h"
rubidium@8131: #include "window_func.h"
rubidium@8144: #include "vehicle_func.h"
rubidium@8212: #include "autoreplace_base.h"
rubidium@8212: #include "autoreplace_func.h"
rubidium@8214: #include "string_func.h"
rubidium@10208: #include "company_func.h"
rubidium@8784: #include "order_func.h"
smatz@8847: #include "oldpool_func.h"
peter1138@9070: #include "core/alloc_func.hpp"
rubidium@6643: 
rubidium@8264: #include "table/strings.h"
rubidium@8264: 
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@8939: 		/* Increase the num engines of EngineID i of the new group if it's not the default 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@7382: DEFINE_OLD_POOL_GENERIC(Group, Group)
rubidium@7382: 
rubidium@7382: 
rubidium@10207: Group::Group(Owner owner)
rubidium@6643: {
peter1138@8253: 	this->owner = owner;
rubidium@9700: 
rubidium@9700: 	if (this->IsValid()) this->num_engines = CallocT<uint16>(GetEnginePoolSize());
rubidium@6643: }
rubidium@6643: 
rubidium@7382: Group::~Group()
rubidium@6643: {
peter1138@8258: 	free(this->name);
rubidium@10207: 	this->owner = INVALID_OWNER;
peter1138@9070: 	free(this->num_engines);
rubidium@7382: }
rubidium@6643: 
rubidium@7382: bool Group::IsValid() const
rubidium@7382: {
rubidium@10207: 	return this->owner != INVALID_OWNER;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: void InitializeGroup(void)
rubidium@6643: {
rubidium@7382: 	_Group_pool.CleanPool();
rubidium@7382: 	_Group_pool.AddBlockToPool();
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: /**
rubidium@7197:  * Create a new vehicle group.
rubidium@6643:  * @param tile unused
rubidium@6643:  * @param p1   vehicle type
rubidium@6643:  * @param p2   unused
rubidium@6643:  */
rubidium@6943: CommandCost CmdCreateGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
rubidium@6643: {
rubidium@6643: 	VehicleType vt = (VehicleType)p1;
rubidium@10207: 	if (!IsCompanyBuildableVehicleType(vt)) return CMD_ERROR;
rubidium@6643: 
rubidium@9036: 	if (!Group::CanAllocateItem()) return CMD_ERROR;
rubidium@7382: 
rubidium@6643: 	if (flags & DC_EXEC) {
rubidium@10207: 		Group *g = new Group(_current_company);
rubidium@6643: 		g->replace_protection = false;
rubidium@6643: 		g->vehicle_type = vt;
peter1138@6667: 
rubidium@10207: 		InvalidateWindowData(GetWindowClassForVehicleType(vt), (vt << 11) | VLW_GROUP_LIST | _current_company);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6950: 	return CommandCost();
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: /**
rubidium@7197:  * Add all vehicles in the given group to the default group and then deletes the 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@6943: CommandCost 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@10207: 	if (g->owner != _current_company) 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: 
glx@8650: 		/* Update backupped orders if needed */
glx@8650: 		if (_backup_orders_data.group == g->index) _backup_orders_data.group = DEFAULT_GROUP;
glx@8650: 
rubidium@6643: 		/* If we set an autoreplace for the group we delete, remove it. */
rubidium@10207: 		if (_current_company < MAX_COMPANIES) {
rubidium@10207: 			Company *c;
rubidium@6643: 			EngineRenew *er;
rubidium@6643: 
rubidium@10207: 			c = GetCompany(_current_company);
rubidium@6643: 			FOR_ALL_ENGINE_RENEWS(er) {
rubidium@10207: 				if (er->group_id == g->index) RemoveEngineReplacementForCompany(c, 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@7382: 		delete g;
peter1138@6667: 
rubidium@10207: 		InvalidateWindowData(GetWindowClassForVehicleType(vt), (vt << 11) | VLW_GROUP_LIST | _current_company);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6950: 	return CommandCost();
rubidium@6643: }
rubidium@6643: 
peter1138@7097: static bool IsUniqueGroupName(const char *name)
peter1138@7097: {
peter1138@7097: 	const Group *g;
peter1138@7097: 	char buf[512];
peter1138@7097: 
peter1138@7097: 	FOR_ALL_GROUPS(g) {
peter1138@7097: 		SetDParam(0, g->index);
peter1138@7097: 		GetString(buf, STR_GROUP_NAME, lastof(buf));
peter1138@7097: 		if (strcmp(buf, name) == 0) return false;
peter1138@7097: 	}
peter1138@7097: 
peter1138@7097: 	return true;
peter1138@7097: }
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@6943: CommandCost CmdRenameGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
rubidium@6643: {
rubidium@9914: 	if (!IsValidGroupID(p1)) return CMD_ERROR;
rubidium@6643: 
peter1138@6667: 	Group *g = GetGroup(p1);
rubidium@10207: 	if (g->owner != _current_company) return CMD_ERROR;
peter1138@6667: 
smatz@10148: 	bool reset = StrEmpty(_cmd_text);
smatz@10148: 
smatz@10148: 	if (!reset) {
smatz@10148: 		if (strlen(_cmd_text) >= MAX_LENGTH_GROUP_NAME_BYTES) return CMD_ERROR;
smatz@10148: 		if (!IsUniqueGroupName(_cmd_text)) return_cmd_error(STR_NAME_MUST_BE_UNIQUE);
smatz@10148: 	}
peter1138@7097: 
rubidium@6643: 	if (flags & DC_EXEC) {
rubidium@6643: 		/* Delete the old name */
peter1138@8258: 		free(g->name);
rubidium@6643: 		/* Assign the new one */
smatz@10148: 		g->name = reset ? NULL : strdup(_cmd_text);
peter1138@6667: 
rubidium@10207: 		InvalidateWindowData(GetWindowClassForVehicleType(g->vehicle_type), (g->vehicle_type << 11) | VLW_GROUP_LIST | _current_company);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6950: 	return CommandCost();
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@6943: CommandCost 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: 
rubidium@7504: 	Vehicle *v = GetVehicle(p2);
rubidium@7504: 
peter1138@6671: 	if (IsValidGroupID(new_g)) {
peter1138@6671: 		Group *g = GetGroup(new_g);
rubidium@10207: 		if (g->owner != _current_company || g->vehicle_type != v->type) return CMD_ERROR;
peter1138@6671: 	}
peter1138@6667: 
rubidium@10207: 	if (v->owner != _current_company || !v->IsPrimaryVehicle()) 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);
rubidium@10207: 		InvalidateWindowData(GetWindowClassForVehicleType(v->type), (v->type << 11) | VLW_GROUP_LIST | _current_company);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6950: 	return CommandCost();
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@6943: CommandCost CmdAddSharedVehicleGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
rubidium@6643: {
rubidium@6643: 	VehicleType type = (VehicleType)p2;
rubidium@10207: 	if (!IsValidGroupID(p1) || !IsCompanyBuildableVehicleType(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: 
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) {
maedhros@6773: 			if (v->type == type && v->IsPrimaryVehicle()) {
rubidium@6643: 				if (v->group_id != id_g) continue;
rubidium@6643: 
rubidium@6643: 				/* For each shared vehicles add it to the group */
rubidium@9941: 				for (Vehicle *v2 = v->FirstShared(); v2 != NULL; v2 = v2->NextShared()) {
rubidium@6643: 					if (v2->group_id != id_g) CmdAddVehicleGroup(tile, flags, id_g, v2->index);
rubidium@6643: 				}
rubidium@6643: 			}
rubidium@6643: 		}
peter1138@6667: 
rubidium@10207: 		InvalidateWindowData(GetWindowClassForVehicleType(type), (type << 11) | VLW_GROUP_LIST | _current_company);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6950: 	return CommandCost();
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@6943: CommandCost CmdRemoveAllVehiclesGroup(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
rubidium@6643: {
rubidium@6643: 	VehicleType type = (VehicleType)p2;
rubidium@10207: 	if (!IsValidGroupID(p1) || !IsCompanyBuildableVehicleType(type)) return CMD_ERROR;
rubidium@6643: 
peter1138@6667: 	Group *g = GetGroup(p1);
rubidium@10207: 	if (g->owner != _current_company) return CMD_ERROR;
peter1138@6667: 
rubidium@6643: 	if (flags & DC_EXEC) {
rubidium@6643: 		GroupID old_g = p1;
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) {
maedhros@6773: 			if (v->type == type && v->IsPrimaryVehicle()) {
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: 
rubidium@10207: 		InvalidateWindowData(GetWindowClassForVehicleType(type), (type << 11) | VLW_GROUP_LIST | _current_company);
peter1138@6667: 	}
peter1138@6667: 
rubidium@6950: 	return CommandCost();
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:  */
rubidium@6943: CommandCost 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);
rubidium@10207: 	if (g->owner != _current_company) return CMD_ERROR;
peter1138@6667: 
peter1138@6667: 	if (flags & DC_EXEC) {
skidd13@7928: 		g->replace_protection = HasBit(p2, 0);
peter1138@6667: 
rubidium@10207: 		InvalidateWindowData(GetWindowClassForVehicleType(g->vehicle_type), (g->vehicle_type << 11) | VLW_GROUP_LIST | _current_company);
frosch@10392: 		InvalidateWindowData(WC_REPLACE_VEHICLE, g->vehicle_type);
rubidium@6643: 	}
rubidium@6643: 
rubidium@6950: 	return CommandCost();
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@7548: 	if (!v->IsValid() || !v->IsPrimaryVehicle()) 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@7387: 	assert(v->IsValid() && v->type == VEH_TRAIN && IsFrontEngine(v));
rubidium@6643: 
rubidium@7492: 	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@7387: 	assert(v->IsValid() && v->type == VEH_TRAIN && (IsFrontEngine(v) || IsFreeWagon(v)));
rubidium@6643: 
rubidium@6643: 	GroupID new_g = IsFrontEngine(v) ? v->group_id : (GroupID)DEFAULT_GROUP;
rubidium@7492: 	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@10207: uint GetGroupNumEngines(CompanyID company, GroupID id_g, EngineID id_e)
rubidium@8237: {
rubidium@8237: 	if (IsValidGroupID(id_g)) return GetGroup(id_g)->num_engines[id_e];
rubidium@6643: 
rubidium@10207: 	uint num = GetCompany(company)->num_engines[id_e];
rubidium@8237: 	if (!IsDefaultGroupID(id_g)) return num;
rubidium@8237: 
rubidium@8237: 	const Group *g;
rubidium@8237: 	FOR_ALL_GROUPS(g) {
rubidium@10207: 		if (g->owner == company) num -= g->num_engines[id_e];
rubidium@8237: 	}
rubidium@8237: 	return num;
rubidium@8237: }
rubidium@8237: 
rubidium@10207: void RemoveAllGroupsForCompany(const CompanyID company)
rubidium@6643: {
rubidium@6643: 	Group *g;
rubidium@6643: 
rubidium@6643: 	FOR_ALL_GROUPS(g) {
rubidium@10207: 		if (company == g->owner) delete g;
rubidium@6643: 	}
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: static const SaveLoad _group_desc[] = {
peter1138@8258:   SLE_CONDVAR(Group, name,           SLE_NAME,    0, 83),
peter1138@8258:   SLE_CONDSTR(Group, name,           SLE_STR, 0, 84, SL_MAX_VERSION),
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@7382: 		Group *g = new (index) Group();
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: };