1

/* $Id$ */

     2

     3

/** @file group.h */

     4

     5

#ifndef GROUP_H

     6

#define GROUP_H

     7

     8

#include "oldpool.h"

     9

    10

enum {

    11

	ALL_GROUP     = 0xFFFD,

    12

	DEFAULT_GROUP = 0xFFFE,

    13

	INVALID_GROUP = 0xFFFF,

    14

};

    15

    16

struct Group;

    17

DECLARE_OLD_POOL(Group, Group, 5, 2047)

    18

    19

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

    20

	StringID string_id;                     ///< Group Name

    21

    22

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

    23

	PlayerID owner;                         ///< Group Owner

    24

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

    25

    26

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

    27

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

    28

    29

	Group(StringID str = STR_NULL);

    30

	virtual ~Group();

    31

    32

	void QuickFree();

    33

    34

	bool IsValid() const;

    35

};

    36

    37

    38

static inline bool IsValidGroupID(GroupID index)

    39

{

    40

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

    41

}

    42

    43

static inline bool IsDefaultGroupID(GroupID index)

    44

{

    45

	return index == DEFAULT_GROUP;

    46

}

    47

    48

/**

    49

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

    50

 * @param id_g The GroupID to check

    51

 * @return true is id_g is identical to ALL_GROUP

    52

 */

    53

static inline bool IsAllGroupID(GroupID id_g)

    54

{

    55

	return id_g == ALL_GROUP;

    56

}

    57

    58

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

    59

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

    60

    61

/**

    62

 * Get the current size of the GroupPool

    63

 */

    64

static inline uint GetGroupArraySize(void)

    65

{

    66

	const Group *g;

    67

	uint num = 0;

    68

    69

	FOR_ALL_GROUPS(g) num++;

    70

    71

	return num;

    72

}

    73

    74

/**

    75

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

    76

 * id_g

    77

 * @param id_g The GroupID of the group used

    78

 * @param id_e The EngineID of the engine to count

    79

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

    80

 */

    81

static inline uint GetGroupNumEngines(GroupID id_g, EngineID id_e)

    82

{

    83

	if (IsValidGroupID(id_g)) return GetGroup(id_g)->num_engines[id_e];

    84

    85

	uint num = GetPlayer(_local_player)->num_engines[id_e];

    86

	if (!IsDefaultGroupID(id_g)) return num;

    87

    88

	const Group *g;

    89

	FOR_ALL_GROUPS(g) num -= g->num_engines[id_e];

    90

	return num;

    91

}

    92

    93

static inline void IncreaseGroupNumVehicle(GroupID id_g)

    94

{

    95

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

    96

}

    97

    98

static inline void DecreaseGroupNumVehicle(GroupID id_g)

    99

{

   100

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

   101

}

   102

   103

   104

void InitializeGroup();

   105

void SetTrainGroupID(Vehicle *v, GroupID grp);

   106

void UpdateTrainGroupID(Vehicle *v);

   107

void RemoveVehicleFromGroup(const Vehicle *v);

   108

void RemoveAllGroupsForPlayer(const Player *p);

   109

   110

#endif /* GROUP_H */