1

/* $Id$ */

     2

     3

/** @file group.h */

     4

     5

#ifndef GROUP_H

     6

#define GROUP_H

     7

     8

#include "oldpool.h"

    12

    13

enum {

    14

	ALL_GROUP     = 0xFFFD,

    15

	DEFAULT_GROUP = 0xFFFE,

    16

	INVALID_GROUP = 0xFFFF,

    17

};

    18

    19

struct Group;

    20

DECLARE_OLD_POOL(Group, Group, 5, 2047)

    21

    22

struct Group : PoolItem<Group, GroupID, &_Group_pool> {

    23

	StringID string_id;                     ///< Group Name

    24

    25

	uint16 num_vehicle;                     ///< Number of vehicles wich belong to the group

    26

	PlayerID owner;                         ///< Group Owner

    27

	VehicleTypeByte vehicle_type;           ///< Vehicle type of the group

    28

    29

	bool replace_protection;                ///< If set to true, the global autoreplace have no effect on the group

    30

	uint16 num_engines[TOTAL_NUM_ENGINES];  ///< Caches the number of engines of each type the player owns (no need to save this)

    31

    32

	Group(PlayerID owner = INVALID_PLAYER);

    33

	virtual ~Group();

    34

    35

	bool IsValid() const;

    36

};

    37

    38

    39

static inline bool IsValidGroupID(GroupID index)

    40

{

    41

	return index < GetGroupPoolSize() && GetGroup(index)->IsValid();

    42

}

    43

    44

static inline bool IsDefaultGroupID(GroupID index)

    45

{

    46

	return index == DEFAULT_GROUP;

    47

}

    48

    49

/**

    50

 * Checks if a GroupID stands for all vehicles of a player

    51

 * @param id_g The GroupID to check

    52

 * @return true is id_g is identical to ALL_GROUP

    53

 */

    54

static inline bool IsAllGroupID(GroupID id_g)

    55

{

    56

	return id_g == ALL_GROUP;

    57

}

    58

    59

#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())

    60

#define FOR_ALL_GROUPS(g) FOR_ALL_GROUPS_FROM(g, 0)

    61

    62

/**

    63

 * Get the current size of the GroupPool

    64

 */

    65

static inline uint GetGroupArraySize(void)

    66

{

    67

	const Group *g;

    68

	uint num = 0;

    69

    70

	FOR_ALL_GROUPS(g) num++;

    71

    72

	return num;

    73

}

    74

    75

/**

    76

 * Get the number of engines with EngineID id_e in the group with GroupID

    77

 * id_g

    78

 * @param id_g The GroupID of the group used

    79

 * @param id_e The EngineID of the engine to count

    80

 * @return The number of engines with EngineID id_e in the group

    81

 */

    82

uint GetGroupNumEngines(PlayerID p, GroupID id_g, EngineID id_e);

    83

    84

static inline void IncreaseGroupNumVehicle(GroupID id_g)

    85

{

    86

	if (IsValidGroupID(id_g)) GetGroup(id_g)->num_vehicle++;

    87

}

    88

    89

static inline void DecreaseGroupNumVehicle(GroupID id_g)

    90

{

    91

	if (IsValidGroupID(id_g)) GetGroup(id_g)->num_vehicle--;

    92

}

    93

    94

    95

void InitializeGroup();

    96

void SetTrainGroupID(Vehicle *v, GroupID grp);

    97

void UpdateTrainGroupID(Vehicle *v);

    98

void RemoveVehicleFromGroup(const Vehicle *v);

    99

void RemoveAllGroupsForPlayer(const PlayerID p);

   100

   101

#endif /* GROUP_H */