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

    11

#include "tile.h"

    12

#include "variables.h"

    13

    14

struct Depot {

    15

	TileIndex xy;

    16

	TownID town_index;

    17

	StationID index;

    18

};

    19

    20

extern MemoryPool _depot_pool;

    21

    22

/**

    23

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

    24

 */

    25

static inline Depot *GetDepot(uint index)

    26

{

    27

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

    28

}

    29

    30

/**

    31

 * Get the current size of the DepotPool

    32

 */

    33

static inline uint16 GetDepotPoolSize(void)

    34

{

    35

	return _depot_pool.total_items;

    36

}

    37

    38

static inline bool IsDepotIndex(uint index)

    39

{

    40

	return index < GetDepotPoolSize();

    41

}

    42

    43

/**

    44

 * Check if a depot really exists.

    45

 */

    46

static inline bool IsValidDepot(const Depot* depot)

    47

{

    48

	return depot->xy != 0;

    49

}

    50

    51

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

    52

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

    53

    54

#define MIN_SERVINT_PERCENT  5

    55

#define MAX_SERVINT_PERCENT 90

    56

#define MIN_SERVINT_DAYS    30

    57

#define MAX_SERVINT_DAYS   800

    58

    59

/** Get the service interval domain.

    60

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

    61

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

    62

 * @param index proposed service interval

    63

 */

    64

static inline Date GetServiceIntervalClamped(uint index)

    65

{

    66

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

    67

}

    68

    69

/**

    70

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

    71

 */

    72

static inline bool IsTileDepotType(TileIndex tile, TransportType type)

    73

{

    74

	switch (type) {

    75

		case TRANSPORT_RAIL:

    76

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

    77

    78

		case TRANSPORT_ROAD:

    79

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

    80

    81

		case TRANSPORT_WATER:

    82

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

    83

    84

		default:

    85

			assert(0);

    86

			return false;

    87

	}

    88

}

    89

    90

    91

/**

    92

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

    93

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

    94

 * @param tileh The slope of the tile in question

    95

 * @return true if the construction is possible

    96

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

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

   105

 */

   106

static inline bool CanBuildDepotByTileh(uint32 direction, Slope tileh)

   107

{

   108

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

   109

}

   110

   111

   112

Depot *GetDepotByTile(TileIndex tile);

   114

Depot *AllocateDepot(void);

   115

void DoDeleteDepot(TileIndex tile);

   116

   117

#endif /* DEPOT_H */