glx@9624: /* $Id$ */
glx@9624: 
glx@9624: /** @file group.h */
glx@9624: 
glx@9624: #ifndef GROUP_H
glx@9624: #define GROUP_H
glx@9624: 
glx@9624: #include "oldpool.h"
glx@9624: 
glx@9624: enum {
rubidium@9686: 	ALL_GROUP     = 0xFFFD,
glx@9624: 	DEFAULT_GROUP = 0xFFFE,
glx@9624: 	INVALID_GROUP = 0xFFFF,
glx@9624: };
glx@9624: 
rubidium@9694: struct Group;
rubidium@9694: DECLARE_OLD_POOL(Group, Group, 5, 2047)
rubidium@9694: 
rubidium@9694: struct Group : PoolItem<Group, GroupID, &_Group_pool> {
glx@9624: 	StringID string_id;                     ///< Group Name
glx@9624: 
glx@9624: 	uint16 num_vehicle;                     ///< Number of vehicles wich belong to the group
glx@9624: 	PlayerID owner;                         ///< Group Owner
glx@9624: 	VehicleTypeByte vehicle_type;           ///< Vehicle type of the group
glx@9624: 
glx@9624: 	bool replace_protection;                ///< If set to true, the global autoreplace have no effect on the group
glx@9624: 	uint16 num_engines[TOTAL_NUM_ENGINES];  ///< Caches the number of engines of each type the player owns (no need to save this)
rubidium@9694: 
rubidium@9694: 	Group(StringID str = STR_NULL);
rubidium@9694: 	virtual ~Group();
rubidium@9694: 
rubidium@9694: 	void QuickFree();
rubidium@9694: 
rubidium@9694: 	bool IsValid() const;
glx@9624: };
glx@9624: 
glx@9624: 
glx@9624: static inline bool IsValidGroupID(GroupID index)
glx@9624: {
rubidium@9694: 	return index < GetGroupPoolSize() && GetGroup(index)->IsValid();
glx@9624: }
glx@9624: 
glx@9624: static inline bool IsDefaultGroupID(GroupID index)
glx@9624: {
rubidium@9686: 	return index == DEFAULT_GROUP;
rubidium@9686: }
rubidium@9686: 
rubidium@9686: /**
rubidium@9686:  * Checks if a GroupID stands for all vehicles of a player
rubidium@9686:  * @param id_g The GroupID to check
rubidium@9686:  * @return true is id_g is identical to ALL_GROUP
rubidium@9686:  */
rubidium@9686: static inline bool IsAllGroupID(GroupID id_g)
rubidium@9686: {
rubidium@9686: 	return id_g == ALL_GROUP;
glx@9624: }
glx@9624: 
rubidium@9694: #define FOR_ALL_GROUPS_FROM(g, start) for (g = GetGroup(start); g != NULL; g = (g->index + 1U < GetGroupPoolSize()) ? GetGroup(g->index + 1) : NULL) if (g->IsValid())
glx@9624: #define FOR_ALL_GROUPS(g) FOR_ALL_GROUPS_FROM(g, 0)
glx@9624: 
glx@9624: /**
glx@9624:  * Get the current size of the GroupPool
glx@9624:  */
glx@9624: static inline uint GetGroupArraySize(void)
glx@9624: {
glx@9624: 	const Group *g;
glx@9624: 	uint num = 0;
glx@9624: 
glx@9624: 	FOR_ALL_GROUPS(g) num++;
glx@9624: 
glx@9624: 	return num;
glx@9624: }
glx@9624: 
rubidium@9686: /**
rubidium@9686:  * Get the number of engines with EngineID id_e in the group with GroupID
rubidium@9686:  * id_g
rubidium@9686:  * @param id_g The GroupID of the group used
rubidium@9686:  * @param id_e The EngineID of the engine to count
rubidium@9686:  * @return The number of engines with EngineID id_e in the group
rubidium@9686:  */
rubidium@9686: static inline uint GetGroupNumEngines(GroupID id_g, EngineID id_e)
rubidium@9686: {
rubidium@9686: 	if (IsValidGroupID(id_g)) return GetGroup(id_g)->num_engines[id_e];
rubidium@9686: 
rubidium@9686: 	uint num = GetPlayer(_local_player)->num_engines[id_e];
rubidium@9686: 	if (!IsDefaultGroupID(id_g)) return num;
rubidium@9686: 
rubidium@9686: 	const Group *g;
rubidium@9686: 	FOR_ALL_GROUPS(g) num -= g->num_engines[id_e];
rubidium@9686: 	return num;
rubidium@9686: }
rubidium@9686: 
glx@9624: static inline void IncreaseGroupNumVehicle(GroupID id_g)
glx@9624: {
glx@9624: 	if (IsValidGroupID(id_g)) GetGroup(id_g)->num_vehicle++;
glx@9624: }
glx@9624: 
glx@9624: static inline void DecreaseGroupNumVehicle(GroupID id_g)
glx@9624: {
glx@9624: 	if (IsValidGroupID(id_g)) GetGroup(id_g)->num_vehicle--;
glx@9624: }
glx@9624: 
glx@9624: 
glx@9624: void InitializeGroup();
glx@9624: void SetTrainGroupID(Vehicle *v, GroupID grp);
glx@9624: void UpdateTrainGroupID(Vehicle *v);
glx@9624: void RemoveVehicleFromGroup(const Vehicle *v);
glx@9624: void RemoveAllGroupsForPlayer(const Player *p);
glx@9624: 
glx@9624: #endif /* GROUP_H */