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

    16

	FORCEINLINE CFollowTrackT(const Vehicle* v = NULL, CPerformanceTimer* pPerf = NULL)

    17

	{

    18

		Init(v, pPerf);

    19

	}

    20

    21

	FORCEINLINE void Init(const Vehicle* v, CPerformanceTimer* pPerf)

    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_station = m_is_tunnel = false;

    31

		m_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 (EnteredDepot()) return true;

    49

		if (!CanExitOldTile()) return false;

    50

		FollowTileExit();

    51

		if (!QueryNewTileTrackStatus()) return TryReverse();

    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_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_tiles_skipped = flotr.length - 1;

    72

				return;

    73

			}

    74

			assert(ReverseDiagDir(tunnel_enterdir) == m_exitdir);

    75

		}

    76

		// not a tunnel or station

    77

		m_is_tunnel = false;

    78

		m_tiles_skipped = 0;

    79

    80

		// normal or station tile

    81

		TileIndexDiff diff = TileOffsByDiagDir(m_exitdir);

    82

		m_new_tile = TILE_ADD(m_old_tile, diff);

    83

    84

		// special handling for stations

    85

		if (IsRailTT() && IsRailwayStationTile(m_new_tile)) {

    86

			m_is_station = true;

    87

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

    88

			m_is_station = true;

    89

		} else {

    90

			m_is_station = false;

    91

		}

    92

	}

    93

    94

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

    95

	FORCEINLINE bool QueryNewTileTrackStatus()

    96

	{

    97

		CPerfStart perf(*m_pPerf);

    98

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

    99

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

   100

		} else {

   101

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

   102

			m_new_td_bits = (TrackdirBits)(ts & TRACKDIR_BIT_MASK);

   103

		}

   104

		return (m_new_td_bits != TRACKDIR_BIT_NONE);

   105

	}

   106

   107

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

   108

	FORCEINLINE bool CanExitOldTile()

   109

	{

   110

		// road stop can be left at one direction only

   111

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

   112

			DiagDirection exitdir = GetRoadStopDir(m_old_tile);

   113

			if (exitdir != m_exitdir)

   114

				return false;

   115

		}

   116

   117

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

   118

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

   119

			DiagDirection exitdir = GetRoadDepotDirection(m_old_tile);

   120

			if (exitdir != m_exitdir)

   121

				return false;

   122

		}

   123

		return true;

   124

	}

   125

   126

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

   127

	FORCEINLINE bool CanEnterNewTile()

   128

	{

   129

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

   130

			// road stop can be entered from one direction only

   131

			DiagDirection exitdir = GetRoadStopDir(m_new_tile);

   132

			if (ReverseDiagDir(exitdir) != m_exitdir)

   133

				return false;

   134

		}

   135

   136

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

   137

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

   138

			DiagDirection exitdir = GetRoadDepotDirection(m_new_tile);

   139

			if (ReverseDiagDir(exitdir) != m_exitdir)

   140

				return false;

   141

			// don't try to enter other player's depots

   142

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

   143

				return false;

   144

			}

   145

		}

   146

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

   147

			DiagDirection exitdir = GetRailDepotDirection(m_new_tile);

   148

			if (ReverseDiagDir(exitdir) != m_exitdir)

   149

				return false;

   150

		}

   151

   152

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

   153

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

   154

			// different owner

   155

			if (IsBridgeTile(m_new_tile)) {

   156

				if (IsBridgeMiddle(m_new_tile)) {

   157

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

   158

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

   159

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

   160

						return false;

   161

					}

   162

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

   163

				} else {

   164

					// different owner, on the bridge ramp

   165

					return false;

   166

				}

   167

			} else {

   168

				// different owner, not a bridge

   169

				return false;

   170

			}

   171

		}

   172

   173

		// rail transport is possible only on compatible rail types

   174

		if (IsRailTT()) {

   175

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

   176

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

   177

				// incompatible rail type

   178

				return false;

   179

			}

   180

		}

   181

   182

		// tunnel tiles can be entered only from proper direction

   183

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

   184

			DiagDirection tunnel_enterdir = GetTunnelDirection(m_new_tile);

   185

			if (tunnel_enterdir != m_exitdir)

   186

				return false;

   187

		}

   188

   189

		// special handling for rail stations - get to the end of platform

   190

		if (IsRailTT() && m_is_station) {

   191

			// entered railway station

   192

			// get platform length

   193

			uint length = GetPlatformLength(m_new_tile, TrackdirToExitdir(m_old_td));

   194

			// how big step we must do to get to the last platform tile;

   195

			m_tiles_skipped = length - 1;

   196

			// move to the platform end

   197

			TileIndexDiff diff = TileOffsByDiagDir(m_exitdir);

   198

			diff *= m_tiles_skipped;

   199

			m_new_tile = TILE_ADD(m_new_tile, diff);

   200

			return true;

   201

		}

   202

   203

		return true;

   204

	}

   205

   206

	/** return true if we entered depot and reversed inside */

   207

	FORCEINLINE bool EnteredDepot()

   208

	{

   209

		// rail and road depots cause reversing

   210

		if (!IsWaterTT() && IsTileDepotType(m_old_tile, TT())) {

   211

			DiagDirection exitdir = IsRailTT() ? GetRailDepotDirection(m_old_tile) : GetRoadDepotDirection(m_old_tile);

   212

			if (exitdir != m_exitdir) {

   213

				// reverse

   214

				m_new_tile = m_old_tile;

   215

				m_new_td_bits = TrackdirToTrackdirBits(ReverseTrackdir(m_old_td));

   216

				m_exitdir = exitdir;

   217

				m_tiles_skipped = 0;

   218

				m_is_tunnel = m_is_station = false;

   219

				return true;

   220

			}

   221

		}

   222

		return false;

   223

	}

   224

   225

	/** return true if we successfully reversed at end of road/track */

   226

	FORCEINLINE bool TryReverse()

   227

	{

   228

		if (IsRoadTT()) {

   229

			// if we reached the end of road, we can reverse the RV and continue moving

   230

			m_exitdir = ReverseDiagDir(m_exitdir);

   231

			// new tile will be the same as old one

   232

			m_new_tile = m_old_tile;

   233

			// set new trackdir bits to all reachable trackdirs

   234

			QueryNewTileTrackStatus();

   235

			m_new_td_bits &= DiagdirReachesTrackdirs(m_exitdir);

   236

			if (m_new_td_bits != TRACKDIR_BIT_NONE) {

   237

				// we have some trackdirs reachable after reversal

   238

				return true;

   239

			}

   240

		}

   241

		return false;

   242

	}

   243

   244

public:

   245

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

   246

	int GetSpeedLimit(int *pmin_speed = NULL)

   247

	{

   248

		int min_speed = 0;

   249

		int max_speed = INT_MAX; // no limit

   250

   251

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

   252

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

   253

			bool is_on_bridge = true;

   254

			if (IsBridgeMiddle(m_old_tile)) {

   255

				// get track axis

   256

				Axis track_axis = DiagDirToAxis(TrackdirToExitdir(m_old_td));

   257

				// get under-bridge axis

   258

				Axis bridge_axis =  GetBridgeAxis(m_old_tile);

   259

				if (track_axis != bridge_axis) is_on_bridge = false;

   260

			}

   261

			if (is_on_bridge) {

   262

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

   263

				if (IsRoadTT()) spd *= 2;

   264

				if (max_speed > spd) max_speed = spd;

   265

			}

   266

		}

   267

   268

		// if min speed was requested, return it

   269

		if (pmin_speed) *pmin_speed = min_speed;

   270

		return max_speed;

   271

	}

   272

};

   273

   274

typedef CFollowTrackT<TRANSPORT_WATER, true > CFollowTrackWater;

   275

typedef CFollowTrackT<TRANSPORT_ROAD , true > CFollowTrackRoad;

   276

typedef CFollowTrackT<TRANSPORT_RAIL , true > CFollowTrackRail;

   277

   278

typedef CFollowTrackT<TRANSPORT_WATER, false> CFollowTrackWaterNo90;

   279

typedef CFollowTrackT<TRANSPORT_ROAD , false> CFollowTrackRoadNo90;

   280

typedef CFollowTrackT<TRANSPORT_RAIL , false> CFollowTrackRailNo90;

   281

   282

#endif /* FOLLOW_TRACK_HPP */