1

/* $Id$ */

     2

     3

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

     4

     5

#ifndef DEPOT_H

     6

#define DEPOT_H

     7

     8

#include "direction.h"

     9

#include "oldpool.h"

    10

#include "tile.h"

    11

#include "variables.h"

    12

#include "road_map.h"

    13

#include "rail_map.h"

    14

#include "water_map.h"

    15

    16

struct Depot {

    17

	TileIndex xy;

    18

	TownID town_index;

    19

	DepotID index;

    20

};

    21

    22

DECLARE_OLD_POOL(Depot, Depot, 3, 8000)

    23

    24

/**

    25

 * Check if a depot really exists.

    26

 */

    27

static inline bool IsValidDepot(const Depot *depot)

    28

{

    29

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

    30

}

    31

    32

static inline bool IsValidDepotID(uint index)

    33

{

    34

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

    35

}

    36

    37

void DestroyDepot(Depot *depot);

    38

    39

static inline void DeleteDepot(Depot *depot)

    40

{

    41

	DestroyDepot(depot);

    42

	depot->xy = 0;

    43

}

    44

    45

void ShowDepotWindow(TileIndex tile, byte type);

    46

    47

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

    48

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

    49

    50

#define MIN_SERVINT_PERCENT  5

    51

#define MAX_SERVINT_PERCENT 90

    52

#define MIN_SERVINT_DAYS    30

    53

#define MAX_SERVINT_DAYS   800

    54

    55

/**

    56

 * Get the service interval domain.

    57

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

    58

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

    59

 * @param index proposed service interval

    60

 * @return service interval

    61

 */

    62

static inline Date GetServiceIntervalClamped(uint index)

    63

{

    64

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

    65

}

    66

    67

/**

    68

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

    69

 */

    70

static inline bool IsTileDepotType(TileIndex tile, TransportType type)

    71

{

    72

	switch (type) {

    73

		case TRANSPORT_RAIL:

    74

			return IsTileType(tile, MP_RAILWAY) && GetRailTileType(tile)  == RAIL_TILE_DEPOT;

    75

    76

		case TRANSPORT_ROAD:

    77

			return IsTileType(tile, MP_STREET)  && GetRoadTileType(tile)  == ROAD_TILE_DEPOT;

    78

    79

		case TRANSPORT_WATER:

    80

			return IsTileType(tile, MP_WATER)   && GetWaterTileType(tile) == WATER_TILE_DEPOT;

    81

    82

		default:

    83

			NOT_REACHED();

    84

			return false;

    85

	}

    86

}

    87

    88

    89

/**

    90

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

    91

 * @param direction The direction in which the depot's exit points

    92

 * @param tileh The slope of the tile in question

    93

 * @return true if the construction is possible

    94

    95

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

    96

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

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

 */

   104

static inline bool CanBuildDepotByTileh(DiagDirection direction, Slope tileh)

   105

{

   106

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

   107

}

   108

   109

Depot *GetDepotByTile(TileIndex tile);

   110

void InitializeDepots();

   111

Depot *AllocateDepot();

   112

   113

void DeleteDepotHighlightOfVehicle(const Vehicle *v);

   114

   115

#endif /* DEPOT_H */