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

    11

#include "tile.h"

    12

#include "variables.h"

    14

    15

struct Depot {

    16

	TileIndex xy;

    17

	TownID town_index;

    18

	DepotID index;

    19

};

    20

    21

DECLARE_OLD_POOL(Depot, Depot, 3, 8000)

    22

    23

/**

    24

 * Check if a depot really exists.

    25

 */

    26

static inline bool IsValidDepot(const Depot *depot)

    27

{

    28

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

    29

}

    30

    31

static inline bool IsValidDepotID(uint index)

    32

{

    33

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

    34

}

    35

    36

void DestroyDepot(Depot *depot);

    37

    38

static inline void DeleteDepot(Depot *depot)

    39

{

    40

	DestroyDepot(depot);

    41

	depot->xy = 0;

    42

}

    43

    44

void ShowDepotWindow(TileIndex tile, byte type);

    45

    46

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

    47

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

    48

    49

#define MIN_SERVINT_PERCENT  5

    50

#define MAX_SERVINT_PERCENT 90

    51

#define MIN_SERVINT_DAYS    30

    52

#define MAX_SERVINT_DAYS   800

    53

    54

/**

    55

 * Get the service interval domain.

    56

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

    57

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

    58

 * @param index proposed service interval

    59

 */

    60

static inline Date GetServiceIntervalClamped(uint index)

    61

{

    62

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

    63

}

    64

    65

/**

    66

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

    67

 */

    68

static inline bool IsTileDepotType(TileIndex tile, TransportType type)

    69

{

    70

	switch (type) {

    71

		case TRANSPORT_RAIL:

    72

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

    73

    74

		case TRANSPORT_ROAD:

    75

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

    76

    77

		case TRANSPORT_WATER:

    78

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

    79

    80

		default:

    81

			assert(0);

    82

			return false;

    83

	}

    84

}

    85

   101

   102

/**

   103

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

   104

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

   105

 * @param tileh The slope of the tile in question

   106

 * @return true if the construction is possible

   107

   108

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

   109

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

   110

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

   111

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

   112

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

   113

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

   114

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

   115

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

   116

 */

   117

static inline bool CanBuildDepotByTileh(uint32 direction, Slope tileh)

   118

{

   119

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

   120

}

   121

   122

Depot *GetDepotByTile(TileIndex tile);

   123

void InitializeDepots(void);

   124

Depot *AllocateDepot(void);

   125

   126

void DeleteDepotHighlightOfVehicle(const Vehicle *v);

   127

   128

#endif /* DEPOT_H */