1

/* $Id$ */

     2

     3

#ifndef DEPOT_H

     4

#define DEPOT_H

     5

     6

/** @file depot.h Header files for depots (not hangars)

     7

  * @see depot.c */

     8

     9

#include "direction.h"

    10

#include "pool.h"

    11

#include "tile.h"

    12

#include "variables.h"

    13

    14

struct Depot {

    15

	TileIndex xy;

    16

	TownID town_index;

    17

	DepotID index;

    18

};

    19

    20

extern MemoryPool _depot_pool;

    21

    22

/**

    23

 * Get the pointer to the depot with index 'index'

    24

 */

    25

static inline Depot *GetDepot(DepotID index)

    26

{

    27

	return (Depot*)GetItemFromPool(&_depot_pool, index);

    28

}

    29

    30

/**

    31

 * Get the current size of the DepotPool

    32

 */

    33

static inline uint16 GetDepotPoolSize(void)

    34

{

    35

	return _depot_pool.total_items;

    36

}

    37

    38

/**

    39

 * Check if a depot really exists.

    40

 */

    41

static inline bool IsValidDepot(const Depot *depot)

    42

{

    43

	return depot != NULL && depot->xy != 0;

    44

}

    45

    46

static inline bool IsValidDepotID(uint index)

    47

{

    48

	return index < GetDepotPoolSize() && IsValidDepot(GetDepot(index));

    49

}

    50

    51

void DestroyDepot(Depot *depot);

    52

    53

static inline void DeleteDepot(Depot *depot)

    54

{

    55

	DestroyDepot(depot);

    56

	depot->xy = 0;

    57

}

    58

    59

#define FOR_ALL_DEPOTS_FROM(d, start) for (d = GetDepot(start); d != NULL; d = (d->index + 1 < GetDepotPoolSize()) ? GetDepot(d->index + 1) : NULL) if (IsValidDepot(d))

    60

#define FOR_ALL_DEPOTS(d) FOR_ALL_DEPOTS_FROM(d, 0)

    61

    62

#define MIN_SERVINT_PERCENT  5

    63

#define MAX_SERVINT_PERCENT 90

    64

#define MIN_SERVINT_DAYS    30

    65

#define MAX_SERVINT_DAYS   800

    66

    67

/**

    68

 * Get the service interval domain.

    69

 * Get the new proposed service interval for the vehicle is indeed, clamped

    70

 * within the given bounds. @see MIN_SERVINT_PERCENT ,etc.

    71

 * @param index proposed service interval

    72

 */

    73

static inline Date GetServiceIntervalClamped(uint index)

    74

{

    75

	return (_patches.servint_ispercent) ? clamp(index, MIN_SERVINT_PERCENT, MAX_SERVINT_PERCENT) : clamp(index, MIN_SERVINT_DAYS, MAX_SERVINT_DAYS);

    76

}

    77

    78

/**

    79

 * Check if a tile is a depot of the given type.

    80

 */

    81

static inline bool IsTileDepotType(TileIndex tile, TransportType type)

    82

{

    83

	switch (type) {

    84

		case TRANSPORT_RAIL:

    85

			return IsTileType(tile, MP_RAILWAY) && (_m[tile].m5 & 0xFC) == 0xC0;

    86

    87

		case TRANSPORT_ROAD:

    88

			return IsTileType(tile, MP_STREET) && (_m[tile].m5 & 0xF0) == 0x20;

    89

    90

		case TRANSPORT_WATER:

    91

			return IsTileType(tile, MP_WATER) && (_m[tile].m5 & ~3) == 0x80;

    92

    93

		default:

    94

			assert(0);

    95

			return false;

    96

	}

    97

}

    98

    99

   100

/**

   101

 * Find out if the slope of the tile is suitable to build a depot of given direction

   102

 * @param direction The direction in which the depot's exit points. Starts with 0 as NE and goes Clockwise

   103

 * @param tileh The slope of the tile in question

   104

 * @return true if the construction is possible

   105

   106

 * This is checked by the ugly 0x4C >> direction magic, which does the following:

   107

 * 0x4C is 0100 1100 and tileh has only bits 0..3 set (steep tiles are ruled out)

   108

 * So: for direction (only the significant bits are shown)<p>

   109

 * 00 (exit towards NE) we need either bit 2 or 3 set in tileh: 0x4C >> 0 = 1100<p>

   110

 * 01 (exit towards SE) we need either bit 1 or 2 set in tileh: 0x4C >> 1 = 0110<p>

   111

 * 02 (exit towards SW) we need either bit 0 or 1 set in tileh: 0x4C >> 2 = 0011<p>

   112

 * 03 (exit towards NW) we need either bit 0 or 4 set in tileh: 0x4C >> 3 = 1001<p>

   113

 * So ((0x4C >> direction) & tileh) determines whether the depot can be built on the current tileh

   114

 */

   115

static inline bool CanBuildDepotByTileh(uint32 direction, Slope tileh)

   116

{

   117

	return ((0x4C >> direction) & tileh) != 0;

   118

}

   119

   120

Depot *GetDepotByTile(TileIndex tile);

   121

void InitializeDepots(void);

   122

Depot *AllocateDepot(void);

   123

   124

#endif /* DEPOT_H */