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 "rail_map.h"

    12

#include "road_map.h"

    13

#include "tile.h"

    14

#include "variables.h"

    16

    17

struct Depot {

    18

	TileIndex xy;

    19

	TownID town_index;

    20

	StationID index;

    21

};

    22

    23

extern MemoryPool _depot_pool;

    24

    25

/**

    26

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

    27

 */

    28

static inline Depot *GetDepot(uint index)

    29

{

    30

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

    31

}

    32

    33

/**

    34

 * Get the current size of the DepotPool

    35

 */

    36

static inline uint16 GetDepotPoolSize(void)

    37

{

    38

	return _depot_pool.total_items;

    39

}

    40

    41

static inline bool IsDepotIndex(uint index)

    42

{

    43

	return index < GetDepotPoolSize();

    44

}

    45

    46

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

    47

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

    48

    49

#define MIN_SERVINT_PERCENT  5

    50

#define MAX_SERVINT_PERCENT 90

    51

#define MIN_SERVINT_DAYS    30

    52

#define MAX_SERVINT_DAYS   800

    53

    54

/** Get the service interval domain.

    55

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

    56

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

    57

 * @param index proposed service interval

    58

 */

    59

static inline uint16 GetServiceIntervalClamped(uint index)

    60

{

    61

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

    62

}

    63

    64

    65

/**

    66

 * Check if a depot really exists.

    67

 */

    68

static inline bool IsValidDepot(const Depot* depot)

    69

{

    70

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

    71

}

    72

    73

/**

    74

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

    75

 */

    76

static inline bool IsTileDepotType(TileIndex tile, TransportType type)

    77

{

    78

	switch (type)

    79

	{

    80

		case TRANSPORT_RAIL:

    81

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

    82

    83

		case TRANSPORT_ROAD:

    84

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

    85

    86

		case TRANSPORT_WATER:

    87

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

    88

    89

		default:

    90

			assert(0);

    91

			return false;

    92

	}

    93

}

    94

    95

/**

    96

 * Returns the direction the exit of the depot on the given tile is facing.

    97

 */

    98

static inline DiagDirection GetDepotDirection(TileIndex tile, TransportType type)

    99

{

   100

	assert(IsTileDepotType(tile, type));

   101

   107

	}

   108

}

   109

   110

/**

   111

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

   112

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

   113

	@param tileh The slope of the tile in question

   114

	@return true if the construction is possible

   115

   116

   117

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

   118

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

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

*/

   126

static inline bool CanBuildDepotByTileh(uint32 direction, Slope tileh)

   127

{

   128

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

   129

}

   130

   131

   132

Depot *GetDepotByTile(TileIndex tile);

   133

void InitializeDepot(void);

   134

Depot *AllocateDepot(void);

   135

void DoDeleteDepot(TileIndex tile);

   136

   137

#endif /* DEPOT_H */