1

/* $Id$ */

     2

     3

#ifndef  FOLLOW_TRACK_HPP

     4

#define  FOLLOW_TRACK_HPP

     5

     6

#include "yapf.hpp"

     7

     8

/** Track follower helper template class (can serve pathfinders and vehicle

     9

    controllers). See 6 different typedefs below for 3 different transport

    10

    types w/ of w/o 90-deg turns allowed */

    11

template <TransportType Ttr_type_, bool T90deg_turns_allowed_ = true>

    12

struct CFollowTrackT : public FollowTrack_t

    13

{

    14

	CPerformanceTimer* m_pPerf;

    15

    17

	{

    18

		Init(v, pPerf);

    19

	}

    20

    22

	{

    23

		assert(!IsRailTT() || (v != NULL && v->type == VEH_Train));

    24

		m_veh = v;

    25

		m_pPerf = pPerf;

    26

		// don't worry, all is inlined so compiler should remove unnecessary initializations

    27

		m_new_tile = INVALID_TILE;

    28

		m_new_td_bits = TRACKDIR_BIT_NONE;

    29

		m_exitdir = INVALID_DIAGDIR;

    30

		m_is_tunnel = false;

    31

		m_tunnel_tiles_skipped = 0;

    32

	}

    33

    34

	FORCEINLINE static TransportType TT() {return Ttr_type_;}

    35

	FORCEINLINE static bool IsWaterTT() {return TT() == TRANSPORT_WATER;}

    36

	FORCEINLINE static bool IsRailTT() {return TT() == TRANSPORT_RAIL;}

    37

	FORCEINLINE static bool IsRoadTT() {return TT() == TRANSPORT_ROAD;}

    38

	FORCEINLINE static bool Allow90degTurns() {return T90deg_turns_allowed_;}

    39

    40

	/** main follower routine. Fills all members and return true on success.

    41

	    Otherwise returns false if track can't be followed. */

    42

	FORCEINLINE bool Follow(TileIndex old_tile, Trackdir old_td)

    43

	{

    44

		m_old_tile = old_tile;

    45

		m_old_td = old_td;

    46

		assert((GetTileTrackStatus(m_old_tile, TT()) & TrackdirToTrackdirBits(m_old_td)) != 0);

    47

		m_exitdir = TrackdirToExitdir(m_old_td);

    48

		if (EnteredRailDepot()) return true;

    49

		if (!CanExitOldTile()) return false;

    50

		FollowTileExit();

    51

		if (!QueryNewTileTrackStatus()) return false;

    52

		if (!CanEnterNewTile()) return false;

    53

		m_new_td_bits &= DiagdirReachesTrackdirs(m_exitdir);

    54

		if (!Allow90degTurns())

    55

			m_new_td_bits &= (TrackdirBits)~(int)TrackdirCrossesTrackdirs(m_old_td);

    56

		return (m_new_td_bits != TRACKDIR_BIT_NONE);

    57

	}

    58

    59

protected:

    60

	/** Follow the m_exitdir from m_old_tile and fill m_new_tile and m_tunnel_tiles_skipped */

    61

	FORCEINLINE void FollowTileExit()

    62

	{

    63

		// extra handling for tunnels in our direction

    64

		if (IsTunnelTile(m_old_tile)) {

    65

			DiagDirection tunnel_enterdir = GetTunnelDirection(m_old_tile);

    66

			if (tunnel_enterdir == m_exitdir) {

    67

				// we are entering the tunnel

    68

				FindLengthOfTunnelResult flotr = FindLengthOfTunnel(m_old_tile, m_exitdir);

    69

				m_new_tile = flotr.tile;

    70

				m_is_tunnel = true;

    71

				m_tunnel_tiles_skipped = flotr.length - 1;

    72

				return;

    73

			}

    74

			assert(ReverseDiagDir(tunnel_enterdir) == m_exitdir);

    75

		}

    76

		// not a tunnel

    77

		m_is_tunnel = false;

    78

		m_tunnel_tiles_skipped = 0;

    79

		// normal tile

    80

		TileIndexDiff diff = TileOffsByDir(m_exitdir);

    81

		m_new_tile = TILE_ADD(m_old_tile, diff);

    82

	}

    83

    84

	/** stores track status (available trackdirs) for the new tile into m_new_td_bits */

    85

	FORCEINLINE bool QueryNewTileTrackStatus()

    86

	{

    87

		CPerfStart perf(*m_pPerf);

    88

		if (IsRailTT() && GetTileType(m_new_tile) == MP_RAILWAY && IsPlainRailTile(m_new_tile)) {

    89

			m_new_td_bits = (TrackdirBits)(GetTrackBits(m_new_tile) * 0x101);

    90

		} else {

    91

			uint32 ts = GetTileTrackStatus(m_new_tile, TT());

    92

			m_new_td_bits = (TrackdirBits)(ts & TRACKDIR_BIT_MASK);

    93

		}

    94

		return (m_new_td_bits != TRACKDIR_BIT_NONE);

    95

	}

    96

    97

	/** return true if we can leave m_old_tile in m_exitdir */

    98

	FORCEINLINE bool CanExitOldTile()

    99

	{

   100

		// road stop can be left at one direction only

   101

		if (IsRoadTT() && IsRoadStopTile(m_old_tile)) {

   102

			DiagDirection exitdir = GetRoadStopDir(m_old_tile);

   103

			if (exitdir != m_exitdir)

   104

				return false;

   105

		}

   106

   107

		// road depots can be also left in one direction only

   108

		if (IsRoadTT() && IsTileDepotType(m_old_tile, TT())) {

   109

			DiagDirection exitdir = GetRoadDepotDirection(m_old_tile);

   110

			if (exitdir != m_exitdir)

   111

				return false;

   112

		}

   113

		return true;

   114

	}

   115

   116

	/** return true if we can enter m_new_tile from m_exitdir */

   117

	FORCEINLINE bool CanEnterNewTile()

   118

	{

   119

		if (IsRoadTT() && IsRoadStopTile(m_new_tile)) {

   120

			// road stop can be entered from one direction only

   121

			DiagDirection exitdir = GetRoadStopDir(m_new_tile);

   122

			if (ReverseDiagDir(exitdir) != m_exitdir)

   123

				return false;

   124

		}

   125

   126

		// road and rail depots can also be entered from one direction only

   127

		if (IsRoadTT() && IsTileDepotType(m_new_tile, TT())) {

   128

			DiagDirection exitdir = GetRoadDepotDirection(m_new_tile);

   129

			if (ReverseDiagDir(exitdir) != m_exitdir)

   130

				return false;

   131

		}

   132

		if (IsRailTT() && IsTileDepotType(m_new_tile, TT())) {

   133

			DiagDirection exitdir = GetRailDepotDirection(m_new_tile);

   134

			if (ReverseDiagDir(exitdir) != m_exitdir)

   135

				return false;

   136

		}

   137

   138

		// rail transport is possible only on tiles with the same owner as vehicle

   139

		if (IsRailTT() && GetTileOwner(m_new_tile) != m_veh->owner) {

   140

			// different owner

   141

			if (IsBridgeTile(m_new_tile)) {

   142

				if (IsBridgeMiddle(m_new_tile)) {

   143

						// bridge middle has no owner - tile is owned by the owner of the under-bridge track

   144

					if (GetBridgeAxis(m_new_tile) != DiagDirToAxis(m_exitdir)) {

   145

						// so it must be under bridge track (and wrong owner)

   146

						return false;

   147

					}

   148

					// in the middle of the bridge - when we came here, it should be ok

   149

				} else {

   150

					// different owner, on the bridge ramp

   151

					return false;

   152

				}

   153

			} else {

   154

				// different owner, not a bridge

   155

				return false;

   156

			}

   157

		}

   158

   159

		// rail transport is possible only on compatible rail types

   160

		if (IsRailTT()) {

   161

			RailType rail_type = GetTileRailType(m_new_tile, DiagdirToDiagTrackdir(m_exitdir));

   162

			if (((1 << rail_type) & m_veh->u.rail.compatible_railtypes) == 0) {

   163

				// incompatible rail type

   164

				return false;

   165

			}

   166

		}

   167

   168

		// tunnel tiles can be entered only from proper direction

   169

		if (!IsWaterTT() && !m_is_tunnel && IsTunnelTile(m_new_tile)) {

   170

			DiagDirection tunnel_enterdir = GetTunnelDirection(m_new_tile);

   171

			if (tunnel_enterdir != m_exitdir)

   172

				return false;

   173

		}

   174

		return true;

   175

	}

   176

   177

	FORCEINLINE bool EnteredRailDepot()

   178

	{

   179

		// rail depots cause reversing

   180

		if (IsRailTT() && IsTileDepotType(m_old_tile, TT())) {

   181

			DiagDirection exitdir = GetRailDepotDirection(m_old_tile);

   182

			if (exitdir != m_exitdir) {

   183

				// reverse

   184

				m_new_tile = m_old_tile;

   185

				m_new_td_bits = TrackdirToTrackdirBits(ReverseTrackdir(m_old_td));

   186

				m_exitdir = exitdir;

   187

				m_tunnel_tiles_skipped = 0;

   188

				m_is_tunnel = false;

   189

				return true;

   190

			}

   191

		}

   192

		return false;

   193

	}

   194

public:

   195

	/** Helper for pathfinders - get min/max speed on the m_old_tile/m_old_td */

   196

	int GetSpeedLimit(int *pmin_speed = NULL)

   197

	{

   198

		int min_speed = 0;

   199

		int max_speed = INT_MAX; // no limit

   200

   201

		// for now we handle only on-bridge speed limit

   202

		if (IsBridgeTile(m_old_tile) && !IsWaterTT() && IsDiagonalTrackdir(m_old_td)) {

   203

			bool is_on_bridge = true;

   204

			if (IsBridgeMiddle(m_old_tile)) {

   205

				// get track axis

   206

				Axis track_axis = DiagDirToAxis(TrackdirToExitdir(m_old_td));

   207

				// get under-bridge axis

   208

				Axis bridge_axis =  GetBridgeAxis(m_old_tile);

   209

				if (track_axis != bridge_axis) is_on_bridge = false;

   210

			}

   211

			if (is_on_bridge) {

   212

				int spd = _bridge[GetBridgeType(m_old_tile)].speed;

   213

				if (IsRoadTT()) spd *= 2;

   214

				if (max_speed > spd) max_speed = spd;

   215

			}

   216

		}

   217

   218

		// if min speed was requested, return it

   219

		if (pmin_speed) *pmin_speed = min_speed;

   220

		return max_speed;

   221

	}

   222

};

   223

   224

typedef CFollowTrackT<TRANSPORT_WATER, true > CFollowTrackWater;

   225

typedef CFollowTrackT<TRANSPORT_ROAD , true > CFollowTrackRoad;

   226

typedef CFollowTrackT<TRANSPORT_RAIL , true > CFollowTrackRail;

   227

   228

typedef CFollowTrackT<TRANSPORT_WATER, false> CFollowTrackWaterNo90;

   229

typedef CFollowTrackT<TRANSPORT_ROAD , false> CFollowTrackRoadNo90;

   230

typedef CFollowTrackT<TRANSPORT_RAIL , false> CFollowTrackRailNo90;

   231

   232

#endif /* FOLLOW_TRACK_HPP */