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

DECLARE_OLD_POOL(Depot, Depot, 3, 8000)

    18

    19

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

    20

	TileIndex xy;

    21

	TownID town_index;

    22

    23

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

    24

	~Depot();

    25

    26

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

    27

};

    28

    29

static inline bool IsValidDepotID(DepotID index)

    30

{

    31

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

    32

}

    33

    34

void ShowDepotWindow(TileIndex tile, VehicleType type);

    35

    36

#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())

    37

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

    38

    39

#define MIN_SERVINT_PERCENT  5

    40

#define MAX_SERVINT_PERCENT 90

    41

#define MIN_SERVINT_DAYS    30

    42

#define MAX_SERVINT_DAYS   800

    43

    44

/**

    45

 * Get the service interval domain.

    46

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

    47

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

    48

 * @param index proposed service interval

    49

 * @return service interval

    50

 */

    51

static inline Date GetServiceIntervalClamped(uint index)

    52

{

    53

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

    54

}

    55

    56

/**

    57

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

    58

 */

    59

static inline bool IsTileDepotType(TileIndex tile, TransportType type)

    60

{

    61

	switch (type) {

    62

		case TRANSPORT_RAIL:

    63

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

    64

    65

		case TRANSPORT_ROAD:

    66

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

    67

    68

		case TRANSPORT_WATER:

    69

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

    70

    71

		default:

    72

			NOT_REACHED();

    73

			return false;

    74

	}

    75

}

    76

    77

    78

/**

    79

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

    80

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

    81

 * @param tileh The slope of the tile in question

    82

 * @return true if the construction is possible

    83

    84

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

    85

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

    86

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

    87

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

    88

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

    89

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

    90

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

    91

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

    92

 */

    93

static inline bool CanBuildDepotByTileh(DiagDirection direction, Slope tileh)

    94

{

    95

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

    96

}

    97

    98

Depot *GetDepotByTile(TileIndex tile);

    99

void InitializeDepots();

   100

   101

void DeleteDepotHighlightOfVehicle(const Vehicle *v);

   102

   103

#endif /* DEPOT_H */