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

	StationID 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(uint 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

static inline bool IsDepotIndex(uint index)

    39

{

    40

	return index < GetDepotPoolSize();

    41

}

    42

    43

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

    44

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

    45

    46

#define MIN_SERVINT_PERCENT  5

    47

#define MAX_SERVINT_PERCENT 90

    48

#define MIN_SERVINT_DAYS    30

    49

#define MAX_SERVINT_DAYS   800

    50

    51

/** Get the service interval domain.

    52

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

    53

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

    54

 * @param index proposed service interval

    55

 */

    56

static inline uint16 GetServiceIntervalClamped(uint index)

    57

{

    58

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

    59

}

    60

    61

    62

/**

    63

 * Check if a depot really exists.

    64

 */

    65

static inline bool IsValidDepot(const Depot* depot)

    66

{

    67

	return depot->xy != 0; /* XXX: Replace by INVALID_TILE someday */

    68

}

    69

    70

/**

    71

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

    72

 */

    73

static inline bool IsTileDepotType(TileIndex tile, TransportType type)

    74

{

    75

	switch (type) {

    76

		case TRANSPORT_RAIL:

    77

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

    78

    79

		case TRANSPORT_ROAD:

    80

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

    81

    82

		case TRANSPORT_WATER:

    83

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

    84

    85

		default:

    86

			assert(0);

    87

			return false;

    88

	}

    89

}

    90

    91

    92

/**

    93

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

    94

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

    95

	@param tileh The slope of the tile in question

    96

	@return true if the construction is possible

    97

    98

    99

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

   100

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

   101

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

   102

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

   103

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

   104

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

   105

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

   106

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

   107

*/

   108

static inline bool CanBuildDepotByTileh(uint32 direction, Slope tileh)

   109

{

   110

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

   111

}

   112

   113

   114

Depot *GetDepotByTile(TileIndex tile);

   115

void InitializeDepot(void);

   116

Depot *AllocateDepot(void);

   117

void DoDeleteDepot(TileIndex tile);

   118

   119

#endif /* DEPOT_H */