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

    10

#include "tile.h"

    11

#include "variables.h"

    12

    13

struct Depot {

    14

	TileIndex xy;

    15

	uint16 town_index;

    16

	uint16 index;

    17

};

    18

    19

extern MemoryPool _depot_pool;

    20

    21

/**

    22

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

    23

 */

    24

static inline Depot *GetDepot(uint index)

    25

{

    26

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

    27

}

    28

    29

/**

    30

 * Get the current size of the DepotPool

    31

 */

    32

static inline uint16 GetDepotPoolSize(void)

    33

{

    34

	return _depot_pool.total_items;

    35

}

    36

    37

static inline bool IsDepotIndex(uint index)

    38

{

    39

	return index < GetDepotPoolSize();

    40

}

    41

    42

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

    43

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

    44

    45

#define MIN_SERVINT_PERCENT  5

    46

#define MAX_SERVINT_PERCENT 90

    47

#define MIN_SERVINT_DAYS    30

    48

#define MAX_SERVINT_DAYS   800

    49

    50

/** Get the service interval domain.

    51

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

    52

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

    53

 * @param index proposed service interval

    54

 */

    55

static inline uint16 GetServiceIntervalClamped(uint index)

    56

{

    57

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

    58

}

    59

    60

VARDEF TileIndex _last_built_train_depot_tile;

    61

VARDEF TileIndex _last_built_road_depot_tile;

    62

VARDEF TileIndex _last_built_aircraft_depot_tile;

    63

VARDEF TileIndex _last_built_ship_depot_tile;

    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

   102

	switch (type)

   103

	{

   104

		case TRANSPORT_RAIL:

   105

		case TRANSPORT_ROAD:

   106

			/* Rail and road store a diagonal direction in bits 0 and 1 */

   108

		case TRANSPORT_WATER:

   109

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

   111

				case 0: return DIAGDIR_NE;

   112

				case 1: return DIAGDIR_SW;

   113

				case 2: return DIAGDIR_NW;

   114

				case 3: return DIAGDIR_SE;

   115

			}

   116

		default:

   117

			return INVALID_DIAGDIR; /* Not reached */

   118

	}

   119

}

   120

   121

/**

   122

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

   123

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

   124

	@param tileh The slope of the tile in question

   125

	@return true if the construction is possible

   126

   127

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

*/

   137

static inline bool CanBuildDepotByTileh(uint32 direction, uint tileh)

   138

{

   139

	return (0x4C >> direction) & tileh;

   140

}

   141

   142

   143

Depot *GetDepotByTile(TileIndex tile);

   144

void InitializeDepot(void);

   145

Depot *AllocateDepot(void);

   146

void DoDeleteDepot(TileIndex tile);

   147

   148

#endif /* DEPOT_H */