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;

    33

	}

    34

    35

	FORCEINLINE static TransportType TT() {return Ttr_type_;}

    36

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

    37

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

    38

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

    39

	FORCEINLINE static bool Allow90degTurns() {return T90deg_turns_allowed_;}

    40

    41

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

    42

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

    43

	FORCEINLINE bool Follow(TileIndex old_tile, Trackdir old_td)

    44

	{

    45

		m_old_tile = old_tile;

    46

		m_old_td = old_td;

    47

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

    48

		m_exitdir = TrackdirToExitdir(m_old_td);

    49

		if (EnteredDepot()) return true;

    50

		if (!CanExitOldTile()) return false;

    51

		FollowTileExit();

    52

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

    53

		m_new_td_bits &= DiagdirReachesTrackdirs(m_exitdir);

    55

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

    56

		if (m_new_td_bits == TRACKDIR_BIT_NONE) return false;

    57

		if (!CanEnterNewTile()) return false;

    58

		return true;

    59

	}

    60

    61

protected:

    62

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

    63

	FORCEINLINE void FollowTileExit()

    64

	{

    65

		m_is_station = m_is_bridge = m_is_tunnel = false;

    66

		m_tiles_skipped = 0;

    67

    68

		// extra handling for tunnels in our direction

    69

		if (IsTunnelTile(m_old_tile)) {

    70

			DiagDirection tunnel_enterdir = GetTunnelDirection(m_old_tile);

    71

			if (tunnel_enterdir == m_exitdir) {

    72

				// we are entering the tunnel

    73

				FindLengthOfTunnelResult flotr = FindLengthOfTunnel(m_old_tile, m_exitdir);

    74

				m_new_tile = flotr.tile;

    75

				m_is_tunnel = true;

    76

				m_tiles_skipped = flotr.length - 1;

    77

				return;

    78

			}

    79

			assert(ReverseDiagDir(tunnel_enterdir) == m_exitdir);

    80

		}

    81

    82

		// extra handling when leaving bridge ramp and entering the bridge

    83

		if (IsBridgeTile(m_old_tile)) {

    84

			DiagDirection bridge_enterdir = GetBridgeRampDirection(m_old_tile);

    85

			if (bridge_enterdir == m_exitdir) {

    86

				// we are entering the bridge

    87

				m_new_tile = GetOtherBridgeEnd(m_old_tile);

    88

				uint32 bridge_length = GetBridgeLength(m_old_tile, m_new_tile);

    89

				m_tiles_skipped = bridge_length;

    90

				m_is_bridge = true;

    92

				return;

    93

			}

    94

		}

    95

    96

		// normal or station tile, do one step

    97

		TileIndexDiff diff = TileOffsByDiagDir(m_exitdir);

    98

		m_new_tile = TILE_ADD(m_old_tile, diff);

    99

   100

		// special handling for stations

   101

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

   102

			m_is_station = true;

   103

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

   104

			m_is_station = true;

   105

		} else {

   106

			m_is_station = false;

   107

		}

   108

	}

   109

   110

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

   111

	FORCEINLINE bool QueryNewTileTrackStatus()

   112

	{

   113

		CPerfStart perf(*m_pPerf);

   114

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

   115

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

   116

		} else {

   117

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

   118

			m_new_td_bits = (TrackdirBits)(ts & TRACKDIR_BIT_MASK);

   119

		}

   120

		return (m_new_td_bits != TRACKDIR_BIT_NONE);

   121

	}

   122

   123

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

   124

	FORCEINLINE bool CanExitOldTile()

   125

	{

   126

		// road stop can be left at one direction only

   127

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

   128

			DiagDirection exitdir = GetRoadStopDir(m_old_tile);

   129

			if (exitdir != m_exitdir)

   130

				return false;

   131

		}

   132

   133

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

   134

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

   135

			DiagDirection exitdir = GetRoadDepotDirection(m_old_tile);

   136

			if (exitdir != m_exitdir)

   137

				return false;

   138

		}

   139

		return true;

   140

	}

   141

   142

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

   143

	FORCEINLINE bool CanEnterNewTile()

   144

	{

   145

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

   146

			// road stop can be entered from one direction only

   147

			DiagDirection exitdir = GetRoadStopDir(m_new_tile);

   148

			if (ReverseDiagDir(exitdir) != m_exitdir)

   149

				return false;

   150

		}

   151

   152

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

   153

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

   154

			DiagDirection exitdir = GetRoadDepotDirection(m_new_tile);

   155

			if (ReverseDiagDir(exitdir) != m_exitdir)

   156

				return false;

   157

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

   158

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

   159

				return false;

   160

			}

   161

		}

   162

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

   163

			DiagDirection exitdir = GetRailDepotDirection(m_new_tile);

   164

			if (ReverseDiagDir(exitdir) != m_exitdir)

   165

				return false;

   166

		}

   167

   168

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

   169

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

   170

			// different owner

   171

			return false;

   172

		}

   173

   174

		// rail transport is possible only on compatible rail types

   175

		if (IsRailTT()) {

   176

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

   177

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

   178

				// incompatible rail type

   179

				return false;

   180

			}

   181

		}

   182

   183

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

   184

		if (!IsWaterTT()) {

   185

			if (IsTunnelTile(m_new_tile)) {

   186

				if (!m_is_tunnel) {

   187

					DiagDirection tunnel_enterdir = GetTunnelDirection(m_new_tile);

   188

					if (tunnel_enterdir != m_exitdir) return false;

   189

				}

   190

			}

   191

		}

   192

   193

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

   194

		if (IsRailTT() && m_is_station) {

   195

			// entered railway station

   196

			// get platform length

   197

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

   198

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

   199

			m_tiles_skipped = length - 1;

   200

			// move to the platform end

   201

			TileIndexDiff diff = TileOffsByDiagDir(m_exitdir);

   202

			diff *= m_tiles_skipped;

   203

			m_new_tile = TILE_ADD(m_new_tile, diff);

   204

			return true;

   205

		}

   206

   207

		return true;

   208

	}

   209

   210

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

   211

	FORCEINLINE bool EnteredDepot()

   212

	{

   213

		// rail and road depots cause reversing

   214

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

   215

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

   216

			if (exitdir != m_exitdir) {

   217

				// reverse

   218

				m_new_tile = m_old_tile;

   219

				m_new_td_bits = TrackdirToTrackdirBits(ReverseTrackdir(m_old_td));

   220

				m_exitdir = exitdir;

   221

				m_tiles_skipped = 0;

   222

				m_is_tunnel = m_is_bridge = m_is_station = false;

   223

				return true;

   224

			}

   225

		}

   226

		return false;

   227

	}

   228

   229

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

   230

	FORCEINLINE bool TryReverse()

   231

	{

   232

		if (IsRoadTT()) {

   233

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

   234

			m_exitdir = ReverseDiagDir(m_exitdir);

   235

			// new tile will be the same as old one

   236

			m_new_tile = m_old_tile;

   237

			// set new trackdir bits to all reachable trackdirs

   238

			QueryNewTileTrackStatus();

   239

			m_new_td_bits &= DiagdirReachesTrackdirs(m_exitdir);

   240

			if (m_new_td_bits != TRACKDIR_BIT_NONE) {

   241

				// we have some trackdirs reachable after reversal

   242

				return true;

   243

			}

   244

		}

   245

		return false;

   246

	}

   247

   248

public:

   249

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

   250

	int GetSpeedLimit(int *pmin_speed = NULL)

   251

	{

   252

		int min_speed = 0;

   253

		int max_speed = INT_MAX; // no limit

   254

   255

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

   256

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

   257

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

   258

			if (IsRoadTT()) spd *= 2;

   259

			if (max_speed > spd) max_speed = spd;

   260

		}

   261

   262

		// if min speed was requested, return it

   263

		if (pmin_speed) *pmin_speed = min_speed;

   264

		return max_speed;

   265

	}

   266

};

   267

   268

typedef CFollowTrackT<TRANSPORT_WATER, true > CFollowTrackWater;

   269

typedef CFollowTrackT<TRANSPORT_ROAD , true > CFollowTrackRoad;

   270

typedef CFollowTrackT<TRANSPORT_RAIL , true > CFollowTrackRail;

   271

   272

typedef CFollowTrackT<TRANSPORT_WATER, false> CFollowTrackWaterNo90;

   273

typedef CFollowTrackT<TRANSPORT_ROAD , false> CFollowTrackRoadNo90;

   274

typedef CFollowTrackT<TRANSPORT_RAIL , false> CFollowTrackRailNo90;

   275

   276

#endif /* FOLLOW_TRACK_HPP */