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"

    15

    16

struct Depot {

    17

	TileIndex xy;

    18

	TownID town_index;

    19

	StationID index;

    20

};

    21

    22

extern MemoryPool _depot_pool;

    23

    24

/**

    25

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

    26

 */

    27

static inline Depot *GetDepot(uint index)

    28

{

    29

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

    30

}

    31

    32

/**

    33

 * Get the current size of the DepotPool

    34

 */

    35

static inline uint16 GetDepotPoolSize(void)

    36

{

    37

	return _depot_pool.total_items;

    38

}

    39

    40

static inline bool IsDepotIndex(uint index)

    41

{

    42

	return index < GetDepotPoolSize();

    43

}

    44

    45

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

    46

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

    47

    48

#define MIN_SERVINT_PERCENT  5

    49

#define MAX_SERVINT_PERCENT 90

    50

#define MIN_SERVINT_DAYS    30

    51

#define MAX_SERVINT_DAYS   800

    52

    53

/** Get the service interval domain.

    54

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

    55

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

    56

 * @param index proposed service interval

    57

 */

    58

static inline uint16 GetServiceIntervalClamped(uint index)

    59

{

    60

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

    61

}

    62

    63

VARDEF TileIndex _last_built_train_depot_tile;

    64

VARDEF TileIndex _last_built_road_depot_tile;

    65

VARDEF TileIndex _last_built_aircraft_depot_tile;

    66

VARDEF TileIndex _last_built_ship_depot_tile;

    67

    68

/**

    69

 * Check if a depot really exists.

    70

 */

    71

static inline bool IsValidDepot(const Depot* depot)

    72

{

    73

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

    74

}

    75

    76

/**

    77

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

    78

 */

    79

static inline bool IsTileDepotType(TileIndex tile, TransportType type)

    80

{

    81

	switch (type)

    82

	{

    83

		case TRANSPORT_RAIL:

    84

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

    85

    86

		case TRANSPORT_ROAD:

    87

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

    88

    89

		case TRANSPORT_WATER:

    90

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

    91

    92

		default:

    93

			assert(0);

    94

			return false;

    95

	}

    96

}

    97

    98

/**

    99

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

   100

 */

   101

static inline DiagDirection GetDepotDirection(TileIndex tile, TransportType type)

   102

{

   103

	assert(IsTileDepotType(tile, type));

   104

   105

	switch (type)

   106

	{

   107

		case TRANSPORT_RAIL: return GetRailDepotDirection(tile);

   108

		case TRANSPORT_ROAD: return GetRoadDepotDirection(tile);

   109

		case TRANSPORT_WATER:

   110

			/* Water is stubborn, it stores the directions in a different order. */

   111

			switch (GB(_m[tile].m5, 0, 2)) {

   112

				case 0: return DIAGDIR_NE;

   113

				case 1: return DIAGDIR_SW;

   114

				case 2: return DIAGDIR_NW;

   115

				case 3: return DIAGDIR_SE;

   116

			}

   117

		default:

   118

			return INVALID_DIAGDIR; /* Not reached */

   119

	}

   120

}

   121

   122

/**

   123

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

   124

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

   125

	@param tileh The slope of the tile in question

   126

	@return true if the construction is possible

   127

   128

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

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

   137

*/

   138

static inline bool CanBuildDepotByTileh(uint32 direction, uint tileh)

   139

{

   140

	return (0x4C >> direction) & tileh;

   141

}

   142

   143

   144

Depot *GetDepotByTile(TileIndex tile);

   145

void InitializeDepot(void);

   146

Depot *AllocateDepot(void);

   147

void DoDeleteDepot(TileIndex tile);

   148

   149

#endif /* DEPOT_H */