rubidium@6643: /* $Id$ */
rubidium@6643: 
rubidium@6643: /** @file group.h */
rubidium@6643: 
rubidium@6643: #ifndef GROUP_H
rubidium@6643: #define GROUP_H
rubidium@6643: 
rubidium@6643: #include "oldpool.h"
rubidium@6643: 
rubidium@6643: enum {
rubidium@6643: 	DEFAULT_GROUP = 0xFFFE,
rubidium@6643: 	INVALID_GROUP = 0xFFFF,
rubidium@6643: };
rubidium@6643: 
rubidium@6643: struct Group {
rubidium@6643: 	StringID string_id;                     ///< Group Name
rubidium@6643: 
rubidium@6643: 	uint16 num_vehicle;                     ///< Number of vehicles wich belong to the group
rubidium@6643: 	PlayerID owner;                         ///< Group Owner
rubidium@6643: 	GroupID index;                          ///< Array index
rubidium@6643: 	VehicleTypeByte vehicle_type;           ///< Vehicle type of the group
rubidium@6643: 
rubidium@6643: 	bool replace_protection;                ///< If set to true, the global autoreplace have no effect on the group
rubidium@6643: 	uint16 num_engines[TOTAL_NUM_ENGINES];  ///< Caches the number of engines of each type the player owns (no need to save this)
rubidium@6643: };
rubidium@6643: 
rubidium@6643: DECLARE_OLD_POOL(Group, Group, 5, 2047)
rubidium@6643: 
rubidium@6643: 
rubidium@6643: static inline bool IsValidGroup(const Group *g)
rubidium@6643: {
rubidium@6643: 	return g->string_id != STR_NULL;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: static inline void DestroyGroup(Group *g)
rubidium@6643: {
rubidium@6643: 	DeleteName(g->string_id);
rubidium@6643: }
rubidium@6643: 
rubidium@6643: static inline void DeleteGroup(Group *g)
rubidium@6643: {
rubidium@6643: 	DestroyGroup(g);
rubidium@6643: 	g->string_id = STR_NULL;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: static inline bool IsValidGroupID(GroupID index)
rubidium@6643: {
rubidium@6643: 	return index < GetGroupPoolSize() && IsValidGroup(GetGroup(index));
rubidium@6643: }
rubidium@6643: 
rubidium@6643: static inline bool IsDefaultGroupID(GroupID index)
rubidium@6643: {
rubidium@6643: 	return (index == DEFAULT_GROUP);
rubidium@6643: }
rubidium@6643: 
rubidium@6643: static inline StringID GetGroupName(GroupID index)
rubidium@6643: {
rubidium@6643: 	if (!IsValidGroupID(index)) return STR_NULL;
rubidium@6643: 
rubidium@6643: 	return GetGroup(index)->string_id;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: #define FOR_ALL_GROUPS_FROM(g, start) for (g = GetGroup(start); g != NULL; g = (g->index + 1U < GetGroupPoolSize()) ? GetGroup(g->index + 1) : NULL) if (IsValidGroup(g))
rubidium@6643: #define FOR_ALL_GROUPS(g) FOR_ALL_GROUPS_FROM(g, 0)
rubidium@6643: 
rubidium@6643: /**
rubidium@6643:  * Get the current size of the GroupPool
rubidium@6643:  */
rubidium@6643: static inline uint GetGroupArraySize(void)
rubidium@6643: {
rubidium@6643: 	const Group *g;
rubidium@6643: 	uint num = 0;
rubidium@6643: 
rubidium@6643: 	FOR_ALL_GROUPS(g) num++;
rubidium@6643: 
rubidium@6643: 	return num;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: static inline void IncreaseGroupNumVehicle(GroupID id_g)
rubidium@6643: {
rubidium@6643: 	if (IsValidGroupID(id_g)) GetGroup(id_g)->num_vehicle++;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: static inline void DecreaseGroupNumVehicle(GroupID id_g)
rubidium@6643: {
rubidium@6643: 	if (IsValidGroupID(id_g)) GetGroup(id_g)->num_vehicle--;
rubidium@6643: }
rubidium@6643: 
rubidium@6643: 
rubidium@6643: void InitializeGroup();
rubidium@6643: void SetTrainGroupID(Vehicle *v, GroupID grp);
rubidium@6643: void UpdateTrainGroupID(Vehicle *v);
rubidium@6643: void RemoveVehicleFromGroup(const Vehicle *v);
rubidium@6643: void RemoveAllGroupsForPlayer(const Player *p);
rubidium@6643: 
rubidium@6643: #endif /* GROUP_H */