1

/* $Id$ */

     2

     3

/** @file follow_track.hpp Template function for track followers */

     4

     5

#ifndef  FOLLOW_TRACK_HPP

     6

#define  FOLLOW_TRACK_HPP

     7

     8

#include "yapf.hpp"

     9

    10

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

    11

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

    12

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

    13

template <TransportType Ttr_type_, bool T90deg_turns_allowed_ = true>

    14

struct CFollowTrackT : public FollowTrack_t

    15

{

    16

	CPerformanceTimer* m_pPerf;

    17

    18

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

    19

	{

    20

		Init(v, pPerf);

    21

	}

    22

    23

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

    24

	{

    25

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

    26

		m_veh = v;

    27

		m_pPerf = pPerf;

    28

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

    29

		m_new_tile = INVALID_TILE;

    30

		m_new_td_bits = TRACKDIR_BIT_NONE;

    31

		m_exitdir = INVALID_DIAGDIR;

    32

		m_is_station = m_is_bridge = m_is_tunnel = false;

    33

		m_tiles_skipped = 0;

    34

	}

    35

    36

	FORCEINLINE static TransportType TT() {return Ttr_type_;}

    37

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

    38

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

    39

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

    40

	FORCEINLINE static bool Allow90degTurns() {return T90deg_turns_allowed_;}

    41

    42

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

    43

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

    44

	FORCEINLINE bool Follow(TileIndex old_tile, Trackdir old_td)

    45

	{

    46

		m_old_tile = old_tile;

    47

		m_old_td = old_td;

    49

		m_exitdir = TrackdirToExitdir(m_old_td);

    50

		if (EnteredDepot()) return true;

    51

		if (!CanExitOldTile()) return false;

    52

		FollowTileExit();

    53

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

    54

		if (!CanEnterNewTile()) return false;

    55

		m_new_td_bits &= DiagdirReachesTrackdirs(m_exitdir);

    56

		if (!Allow90degTurns())

    57

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

    58

		return (m_new_td_bits != TRACKDIR_BIT_NONE);

    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 for bridge ramp in our direction

    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 ramp

    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;

    91

				return;

    92

			}

    93

			assert(ReverseDiagDir(bridge_enterdir) == m_exitdir);

    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 {

   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 unless it's a drive-through stop

   127

		if (IsRoadTT() && IsStandardRoadStopTile(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() && IsStandardRoadStopTile(m_new_tile)) {

   146

			// road stop can be entered from one direction only unless it's a drive-through stop

   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);

   177

			if (!HASBIT(m_veh->u.rail.compatible_railtypes, rail_type)) {

   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() && IsTileType(m_new_tile, MP_TUNNELBRIDGE)) {

   185

			if (IsTunnel(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

			} else if (IsBridge(m_new_tile)) {

   191

				if (!m_is_bridge) {

   192

					DiagDirection ramp_enderdir = GetBridgeRampDirection(m_new_tile);

   193

					if (ramp_enderdir != m_exitdir) return false;

   194

				}

   195

			}

   196

		}

   197

   198

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

   199

		if (IsRailTT() && m_is_station) {

   200

			// entered railway station

   201

			// get platform length

   202

			uint length = GetStationByTile(m_new_tile)->GetPlatformLength(m_new_tile, TrackdirToExitdir(m_old_td));

   203

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

   204

			m_tiles_skipped = length - 1;

   205

			// move to the platform end

   206

			TileIndexDiff diff = TileOffsByDiagDir(m_exitdir);

   207

			diff *= m_tiles_skipped;

   208

			m_new_tile = TILE_ADD(m_new_tile, diff);

   209

			return true;

   210

		}

   211

   212

		return true;

   213

	}

   214

   215

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

   216

	FORCEINLINE bool EnteredDepot()

   217

	{

   218

		// rail and road depots cause reversing

   219

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

   220

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

   221

			if (exitdir != m_exitdir) {

   222

				// reverse

   223

				m_new_tile = m_old_tile;

   224

				m_new_td_bits = TrackdirToTrackdirBits(ReverseTrackdir(m_old_td));

   225

				m_exitdir = exitdir;

   226

				m_tiles_skipped = 0;

   227

				m_is_tunnel = m_is_bridge = m_is_station = false;

   228

				return true;

   229

			}

   230

		}

   231

		return false;

   232

	}

   233

   234

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

   235

	FORCEINLINE bool TryReverse()

   236

	{

   237

		if (IsRoadTT()) {

   238

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

   239

			m_exitdir = ReverseDiagDir(m_exitdir);

   240

			// new tile will be the same as old one

   241

			m_new_tile = m_old_tile;

   242

			// set new trackdir bits to all reachable trackdirs

   243

			QueryNewTileTrackStatus();

   244

			m_new_td_bits &= DiagdirReachesTrackdirs(m_exitdir);

   245

			if (m_new_td_bits != TRACKDIR_BIT_NONE) {

   246

				// we have some trackdirs reachable after reversal

   247

				return true;

   248

			}

   249

		}

   250

		return false;

   251

	}

   252

   253

public:

   254

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

   255

	int GetSpeedLimit(int *pmin_speed = NULL)

   256

	{

   257

		int min_speed = 0;

   258

		int max_speed = INT_MAX; // no limit

   259

   260

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

   261

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

   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

		// if min speed was requested, return it

   268

		if (pmin_speed) *pmin_speed = min_speed;

   269

		return max_speed;

   270

	}

   271

};

   272

   273

typedef CFollowTrackT<TRANSPORT_WATER, true > CFollowTrackWater;

   274

typedef CFollowTrackT<TRANSPORT_ROAD , true > CFollowTrackRoad;

   275

typedef CFollowTrackT<TRANSPORT_RAIL , true > CFollowTrackRail;

   276

   277

typedef CFollowTrackT<TRANSPORT_WATER, false> CFollowTrackWaterNo90;

   278

typedef CFollowTrackT<TRANSPORT_ROAD , false> CFollowTrackRoadNo90;

   279

typedef CFollowTrackT<TRANSPORT_RAIL , false> CFollowTrackRailNo90;

   280

   281

#endif /* FOLLOW_TRACK_HPP */