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_bridge = 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

		m_is_station = m_is_bridge = m_is_tunnel = false;

    64

		m_tiles_skipped = 0;

    65

    66

		// extra handling for tunnels in our direction

    67

		if (IsTunnelTile(m_old_tile)) {

    68

			DiagDirection tunnel_enterdir = GetTunnelDirection(m_old_tile);

    69

			if (tunnel_enterdir == m_exitdir) {

    70

				// we are entering the tunnel

    71

				FindLengthOfTunnelResult flotr = FindLengthOfTunnel(m_old_tile, m_exitdir);

    72

				m_new_tile = flotr.tile;

    73

				m_is_tunnel = true;

    74

				m_tiles_skipped = flotr.length - 1;

    75

				return;

    76

			}

    77

			assert(ReverseDiagDir(tunnel_enterdir) == m_exitdir);

    78

		}

    79

    80

		// extra handling for bridge ramp in our direction

    81

		if (IsBridgeTile(m_old_tile)) {

    82

			DiagDirection bridge_enterdir = GetBridgeRampDirection(m_old_tile);

    83

			if (bridge_enterdir == m_exitdir) {

    84

				// we are entering the bridge ramp

    85

				m_new_tile = GetOtherBridgeEnd(m_old_tile);

    86

				uint32 bridge_length = GetBridgeLength(m_old_tile, m_new_tile);

    87

				m_tiles_skipped = bridge_length;

    88

				m_is_bridge = true;

    89

				return;

    90

			}

    91

			assert(ReverseDiagDir(bridge_enterdir) == m_exitdir);

    92

		}

    93

    94

		// normal or station tile, do one step

    95

		TileIndexDiff diff = TileOffsByDiagDir(m_exitdir);

    96

		m_new_tile = TILE_ADD(m_old_tile, diff);

    97

    98

		// special handling for stations

    99

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

   100

			m_is_station = true;

   101

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

   102

			m_is_station = true;

   103

		} else {

   104

			m_is_station = false;

   105

		}

   106

	}

   107

   108

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

   109

	FORCEINLINE bool QueryNewTileTrackStatus()

   110

	{

   111

		CPerfStart perf(*m_pPerf);

   112

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

   113

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

   114

		} else {

   115

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

   116

			m_new_td_bits = (TrackdirBits)(ts & TRACKDIR_BIT_MASK);

   117

		}

   118

		return (m_new_td_bits != TRACKDIR_BIT_NONE);

   119

	}

   120

   121

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

   122

	FORCEINLINE bool CanExitOldTile()

   123

	{

   124

		// road stop can be left at one direction only

   125

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

   126

			DiagDirection exitdir = GetRoadStopDir(m_old_tile);

   127

			if (exitdir != m_exitdir)

   128

				return false;

   129

		}

   130

   131

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

   132

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

   133

			DiagDirection exitdir = GetRoadDepotDirection(m_old_tile);

   134

			if (exitdir != m_exitdir)

   135

				return false;

   136

		}

   137

		return true;

   138

	}

   139

   140

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

   141

	FORCEINLINE bool CanEnterNewTile()

   142

	{

   143

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

   144

			// road stop can be entered from one direction only

   145

			DiagDirection exitdir = GetRoadStopDir(m_new_tile);

   146

			if (ReverseDiagDir(exitdir) != m_exitdir)

   147

				return false;

   148

		}

   149

   150

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

   151

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

   152

			DiagDirection exitdir = GetRoadDepotDirection(m_new_tile);

   153

			if (ReverseDiagDir(exitdir) != m_exitdir)

   154

				return false;

   155

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

   156

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

   157

				return false;

   158

			}

   159

		}

   160

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

   161

			DiagDirection exitdir = GetRailDepotDirection(m_new_tile);

   162

			if (ReverseDiagDir(exitdir) != m_exitdir)

   163

				return false;

   164

		}

   165

   166

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

   167

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

   168

			// different owner

   169

			return false;

   170

		}

   171

   172

		// rail transport is possible only on compatible rail types

   173

		if (IsRailTT()) {

   174

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

   175

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

   176

				// incompatible rail type

   177

				return false;

   178

			}

   179

		}

   180

   181

		// tunnel holes and bridge ramps can be entered only from proper direction

   182

		if (!IsWaterTT() && IsTileType(m_new_tile, MP_TUNNELBRIDGE)) {

   183

			if (IsTunnel(m_new_tile)) {

   184

				if (!m_is_tunnel) {

   185

					DiagDirection tunnel_enterdir = GetTunnelDirection(m_new_tile);

   186

					if (tunnel_enterdir != m_exitdir) return false;

   187

				}

   188

			} else if (IsBridge(m_new_tile)) {

   189

				if (!m_is_bridge) {

   190

					DiagDirection ramp_enderdir = GetBridgeRampDirection(m_new_tile);

   191

					if (ramp_enderdir != m_exitdir) return false;

   192

				}

   193

			}

   194

		}

   195

   196

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

   197

		if (IsRailTT() && m_is_station) {

   198

			// entered railway station

   199

			// get platform length

   200

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

   201

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

   202

			m_tiles_skipped = length - 1;

   203

			// move to the platform end

   204

			TileIndexDiff diff = TileOffsByDiagDir(m_exitdir);

   205

			diff *= m_tiles_skipped;

   206

			m_new_tile = TILE_ADD(m_new_tile, diff);

   207

			return true;

   208

		}

   209

   210

		return true;

   211

	}

   212

   213

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

   214

	FORCEINLINE bool EnteredDepot()

   215

	{

   216

		// rail and road depots cause reversing

   217

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

   218

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

   219

			if (exitdir != m_exitdir) {

   220

				// reverse

   221

				m_new_tile = m_old_tile;

   222

				m_new_td_bits = TrackdirToTrackdirBits(ReverseTrackdir(m_old_td));

   223

				m_exitdir = exitdir;

   224

				m_tiles_skipped = 0;

   225

				m_is_tunnel = m_is_bridge = m_is_station = false;

   226

				return true;

   227

			}

   228

		}

   229

		return false;

   230

	}

   231

   232

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

   233

	FORCEINLINE bool TryReverse()

   234

	{

   235

		if (IsRoadTT()) {

   236

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

   237

			m_exitdir = ReverseDiagDir(m_exitdir);

   238

			// new tile will be the same as old one

   239

			m_new_tile = m_old_tile;

   240

			// set new trackdir bits to all reachable trackdirs

   241

			QueryNewTileTrackStatus();

   242

			m_new_td_bits &= DiagdirReachesTrackdirs(m_exitdir);

   243

			if (m_new_td_bits != TRACKDIR_BIT_NONE) {

   244

				// we have some trackdirs reachable after reversal

   245

				return true;

   246

			}

   247

		}

   248

		return false;

   249

	}

   250

   251

public:

   252

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

   253

	int GetSpeedLimit(int *pmin_speed = NULL)

   254

	{

   255

		int min_speed = 0;

   256

		int max_speed = INT_MAX; // no limit

   257

   258

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

   259

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

   260

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

   261

			if (IsRoadTT()) spd *= 2;

   262

			if (max_speed > spd) max_speed = spd;

   263

		}

   264

   265

		// if min speed was requested, return it

   266

		if (pmin_speed) *pmin_speed = min_speed;

   267

		return max_speed;

   268

	}

   269

};

   270

   271

typedef CFollowTrackT<TRANSPORT_WATER, true > CFollowTrackWater;

   272

typedef CFollowTrackT<TRANSPORT_ROAD , true > CFollowTrackRoad;

   273

typedef CFollowTrackT<TRANSPORT_RAIL , true > CFollowTrackRail;

   274

   275

typedef CFollowTrackT<TRANSPORT_WATER, false> CFollowTrackWaterNo90;

   276

typedef CFollowTrackT<TRANSPORT_ROAD , false> CFollowTrackRoadNo90;

   277

typedef CFollowTrackT<TRANSPORT_RAIL , false> CFollowTrackRailNo90;

   278

   279

#endif /* FOLLOW_TRACK_HPP */