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

#include "station_map.h"

    16

    17

struct Depot;

    18

DECLARE_OLD_POOL(Depot, Depot, 3, 8000)

    19

    20

struct Depot : PoolItem<Depot, DepotID, &_Depot_pool> {

    21

	TileIndex xy;

    22

	TownID town_index;

    23

    24

	Depot(TileIndex xy = 0) : xy(xy) {}

    25

	~Depot();

    26

    27

	inline bool IsValid() const { return this->xy != 0; }

    28

};

    29

    30

static inline bool IsValidDepotID(DepotID index)

    31

{

    32

	return index < GetDepotPoolSize() && GetDepot(index)->IsValid();

    33

}

    34

    35

void ShowDepotWindow(TileIndex tile, VehicleType type);

    36

    37

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

    38

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

    39

    40

#define MIN_SERVINT_PERCENT  5

    41

#define MAX_SERVINT_PERCENT 90

    42

#define MIN_SERVINT_DAYS    30

    43

#define MAX_SERVINT_DAYS   800

    44

    45

/**

    46

 * Get the service interval domain.

    47

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

    48

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

    49

 * @param index proposed service interval

    50

 * @return service interval

    51

 */

    52

static inline Date GetServiceIntervalClamped(uint index)

    53

{

    54

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

    55

}

    56

    57

/**

    58

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

    59

 */

    60

static inline bool IsTileDepotType(TileIndex tile, TransportType type)

    61

{

    62

	switch (type) {

    63

		case TRANSPORT_RAIL:

    64

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

    65

    66

		case TRANSPORT_ROAD:

    67

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

    68

    69

		case TRANSPORT_WATER:

    70

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

    71

    72

		default:

    73

			NOT_REACHED();

    74

			return false;

    75

	}

    76

}

    77

    78

/**

    79

 * Is the given tile a tile with a depot on it?

    80

 * @param tile the tile to check

    81

 * @return true if and only if there is a depot on the tile.

    82

 */

    83

static inline bool IsDepotTile(TileIndex tile)

    84

{

    85

	switch (GetTileType(tile)) {

    86

		case MP_ROAD:    return GetRoadTileType(tile)  == ROAD_TILE_DEPOT;

    87

		case MP_WATER:   return GetWaterTileType(tile) == WATER_TILE_DEPOT;

    88

		case MP_RAILWAY: return GetRailTileType(tile)  == RAIL_TILE_DEPOT;

    89

		case MP_STATION: return IsHangar(tile);

    90

		default:         return false;

    91

	}

    92

}

    93

    94

/**

    95

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

    96

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

    97

 * @param tileh The slope of the tile in question

    98

 * @return true if the construction is possible

    99

   100

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

   101

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

   102

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

   103

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

   104

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

   105

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

   106

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

   107

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

   108

 */

   109

static inline bool CanBuildDepotByTileh(DiagDirection direction, Slope tileh)

   110

{

   111

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

   112

}

   113

   114

Depot *GetDepotByTile(TileIndex tile);

   115

void InitializeDepots();

   116

   117

void DeleteDepotHighlightOfVehicle(const Vehicle *v);

   118

   119

#endif /* DEPOT_H */