1

/* $Id$ */

     2

     3

/** @file tunnelbridge_map.h Functions that have tunnels and bridges in common */

     4

     5

#ifndef TUNNELBRIDGE_MAP_H

     6

#define TUNNELBRIDGE_MAP_H

     7

     8

#include "direction_func.h"

     9

#include "core/bitmath_func.hpp"

    10

#include "tile_map.h"

    11

#include "bridge_map.h"

    12

#include "tunnel_map.h"

    13

#include "transport_type.h"

    14

#include "track_func.h"

    15

    16

    17

/**

    18

 * Get the direction pointing to the other end.

    19

 *

    20

 * Tunnel: Get the direction facing into the tunnel

    21

 * Bridge: Get the direction pointing onto the bridge

    22

 * @param t The tile to analyze

    23

 * @pre IsTileType(t, MP_TUNNELBRIDGE)

    24

 * @return the above mentionned direction

    25

 */

    26

static inline DiagDirection GetTunnelBridgeDirection(TileIndex t)

    27

{

    28

	assert(IsTileType(t, MP_TUNNELBRIDGE));

    29

	return (DiagDirection)GB(_m[t].m5, 0, 2);

    30

}

    31

    32

/**

    33

 * Tunnel: Get the transport type of the tunnel (road or rail)

    34

 * Bridge: Get the transport type of the bridge's ramp

    35

 * @param t The tile to analyze

    36

 * @pre IsTileType(t, MP_TUNNELBRIDGE)

    37

 * @return the transport type in the tunnel/bridge

    38

 */

    39

static inline TransportType GetTunnelBridgeTransportType(TileIndex t)

    40

{

    41

	assert(IsTileType(t, MP_TUNNELBRIDGE));

    42

	return (TransportType)GB(_m[t].m5, 2, 2);

    43

}

    44

    45

/**

    46

 * Tunnel: Is this tunnel entrance in a snowy or desert area?

    47

 * Bridge: Does the bridge ramp lie in a snow or desert area?

    48

 * @param t The tile to analyze

    49

 * @pre IsTileType(t, MP_TUNNELBRIDGE)

    50

 * @return true if and only if the tile is in a snowy/desert area

    51

 */

    52

static inline bool HasTunnelBridgeSnowOrDesert(TileIndex t)

    53

{

    54

	assert(IsTileType(t, MP_TUNNELBRIDGE));

    55

	return HasBit(_m[t].m4, 7);

    56

}

    57

    58

/**

    59

 * Tunnel: Places this tunnel entrance in a snowy or desert area, or takes it out of there.

    60

 * Bridge: Sets whether the bridge ramp lies in a snow or desert area.

    61

 * @param t the tunnel entrance / bridge ramp tile

    62

 * @param snow_or_desert is the entrance/ramp in snow or desert (true), when

    63

 *                       not in snow and not in desert false

    64

 * @pre IsTileType(t, MP_TUNNELBRIDGE)

    65

 */

    66

static inline void SetTunnelBridgeSnowOrDesert(TileIndex t, bool snow_or_desert)

    67

{

    68

	assert(IsTileType(t, MP_TUNNELBRIDGE));

    69

	SB(_m[t].m4, 7, 1, snow_or_desert);

    70

}

    71

    72

/**

    73

 * Determines type of the wormhole and returns its other end

    74

 * @param t one end

    75

 * @pre IsTileType(t, MP_TUNNELBRIDGE)

    76

 * @return other end

    77

 */

    78

static inline TileIndex GetOtherTunnelBridgeEnd(TileIndex t)

    79

{

    80

	assert(IsTileType(t, MP_TUNNELBRIDGE));

    81

	return IsTunnel(t) ? GetOtherTunnelEnd(t) : GetOtherBridgeEnd(t);

    82

}

    83

    84

    85

/**

    86

 * Get the reservation state of the rail tunnel/bridge

    87

 * @pre IsTileType(t, MP_TUNNELBRIDGE) && GetTunnelBridgeTransportType(t) == TRANSPORT_RAIL

    88

 * @param t the tile

    89

 * @return reservation state

    90

 */

    91

static inline bool GetTunnelBridgeReservation(TileIndex t)

    92

{

    93

	assert(IsTileType(t, MP_TUNNELBRIDGE));

    94

	assert(GetTunnelBridgeTransportType(t) == TRANSPORT_RAIL);

    95

	return HasBit(_m[t].m5, 4);

    96

}

    97

    98

/**

    99

 * Set the reservation state of the rail tunnel/bridge

   100

 * @pre IsTileType(t, MP_TUNNELBRIDGE) && GetTunnelBridgeTransportType(t) == TRANSPORT_RAIL

   101

 * @param t the tile

   102

 * @param b the reservation state

   103

 */

   104

static inline void SetTunnelBridgeReservation(TileIndex t, bool b)

   105

{

   106

	assert(IsTileType(t, MP_TUNNELBRIDGE));

   107

	assert(GetTunnelBridgeTransportType(t) == TRANSPORT_RAIL);

   108

	SB(_m[t].m5, 4, 1, b ? 1 : 0);

   109

}

   110

   111

/**

   112

 * Get the reserved track bits for a rail tunnel/bridge

   113

 * @pre IsTileType(t, MP_TUNNELBRIDGE) && GetTunnelBridgeTransportType(t) == TRANSPORT_RAIL

   114

 * @param t the tile

   115

 * @return reserved track bits

   116

 */

   117

static inline TrackBits GetRailTunnelBridgeReservation(TileIndex t)

   118

{

   119

	return GetTunnelBridgeReservation(t) ? DiagDirToDiagTrackBits(GetTunnelBridgeDirection(t)) : TRACK_BIT_NONE;

   120

}

   121

   122

#endif /* TUNNELBRIDGE_MAP_H */