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

		m_err = EC_NONE;

    35

	}

    36

    37

	FORCEINLINE static TransportType TT() {return Ttr_type_;}

    38

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

    39

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

    40

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

    41

	FORCEINLINE static bool Allow90degTurns() {return T90deg_turns_allowed_;}

    42

    43

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

    44

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

    45

	FORCEINLINE bool Follow(TileIndex old_tile, Trackdir old_td)

    46

	{

    47

		m_old_tile = old_tile;

    48

		m_old_td = old_td;

    49

		m_err = EC_NONE;

    50

		assert((GetTileTrackStatus(m_old_tile, TT(), m_veh->u.road.compatible_roadtypes) & TrackdirToTrackdirBits(m_old_td)) != 0);

    51

		m_exitdir = TrackdirToExitdir(m_old_td);

    52

		if (EnteredDepot()) return true;

    53

		if (!CanExitOldTile()) return false;

    54

		FollowTileExit();

    55

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

    56

		if (!CanEnterNewTile()) return false;

    57

		m_new_td_bits &= DiagdirReachesTrackdirs(m_exitdir);

    58

		if (m_new_td_bits == TRACKDIR_BIT_NONE) {

    59

			m_err = EC_NO_WAY;

    60

			return false;

    61

		}

    62

		if (!Allow90degTurns()) {

    63

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

    64

			if (m_new_td_bits == TRACKDIR_BIT_NONE) {

    65

				m_err = EC_90DEG;

    66

				return false;

    67

			}

    68

		}

    69

		return true;

    70

	}

    71

    72

protected:

    73

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

    74

	FORCEINLINE void FollowTileExit()

    75

	{

    76

		m_is_station = m_is_bridge = m_is_tunnel = false;

    77

		m_tiles_skipped = 0;

    78

    92

				return;

    93

			}

    95

		}

    96

    97

		// normal or station tile, do one step

    98

		TileIndexDiff diff = TileOffsByDiagDir(m_exitdir);

    99

		m_new_tile = TILE_ADD(m_old_tile, diff);

   100

   101

		// special handling for stations

   102

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

   103

			m_is_station = true;

   104

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

   105

			m_is_station = true;

   106

		} else {

   107

			m_is_station = false;

   108

		}

   109

	}

   110

   111

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

   112

	FORCEINLINE bool QueryNewTileTrackStatus()

   113

	{

   114

		CPerfStart perf(*m_pPerf);

   115

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

   116

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

   117

		} else {

   118

			uint32 ts = GetTileTrackStatus(m_new_tile, TT(), m_veh->u.road.compatible_roadtypes);

   119

			m_new_td_bits = (TrackdirBits)(ts & TRACKDIR_BIT_MASK);

   120

		}

   121

		return (m_new_td_bits != TRACKDIR_BIT_NONE);

   122

	}

   123

   124

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

   125

	FORCEINLINE bool CanExitOldTile()

   126

	{

   127

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

   128

		if (IsRoadTT() && IsStandardRoadStopTile(m_old_tile)) {

   129

			DiagDirection exitdir = GetRoadStopDir(m_old_tile);

   130

			if (exitdir != m_exitdir) {

   131

				m_err = EC_NO_WAY;

   132

				return false;

   133

			}

   134

		}

   135

   136

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

   137

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

   138

			DiagDirection exitdir = GetRoadDepotDirection(m_old_tile);

   139

			if (exitdir != m_exitdir) {

   140

				m_err = EC_NO_WAY;

   141

				return false;

   142

			}

   143

		}

   144

		return true;

   145

	}

   146

   147

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

   148

	FORCEINLINE bool CanEnterNewTile()

   149

	{

   150

		if (IsRoadTT() && IsStandardRoadStopTile(m_new_tile)) {

   151

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

   152

			DiagDirection exitdir = GetRoadStopDir(m_new_tile);

   153

			if (ReverseDiagDir(exitdir) != m_exitdir) {

   154

				m_err = EC_NO_WAY;

   155

				return false;

   156

			}

   157

		}

   158

   159

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

   160

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

   161

			DiagDirection exitdir = GetRoadDepotDirection(m_new_tile);

   162

			if (ReverseDiagDir(exitdir) != m_exitdir) {

   163

				m_err = EC_NO_WAY;

   164

				return false;

   165

			}

   166

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

   167

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

   168

				m_err = EC_OWNER;

   169

				return false;

   170

			}

   171

		}

   172

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

   173

			DiagDirection exitdir = GetRailDepotDirection(m_new_tile);

   174

			if (ReverseDiagDir(exitdir) != m_exitdir) {

   175

				m_err = EC_NO_WAY;

   176

				return false;

   177

			}

   178

		}

   179

   180

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

   181

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

   182

			// different owner

   183

			m_err = EC_NO_WAY;

   184

			return false;

   185

		}

   186

   187

		// rail transport is possible only on compatible rail types

   188

		if (IsRailTT()) {

   189

			RailType rail_type = GetTileRailType(m_new_tile);

   190

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

   191

				// incompatible rail type

   192

				m_err = EC_RAIL_TYPE;

   193

				return false;

   194

			}

   195

		}

   196

   197

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

   198

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

   199

			if (IsTunnel(m_new_tile)) {

   200

				if (!m_is_tunnel) {

   201

					DiagDirection tunnel_enterdir = GetTunnelBridgeDirection(m_new_tile);

   202

					if (tunnel_enterdir != m_exitdir) {

   203

						m_err = EC_NO_WAY;

   204

						return false;

   205

					}

   206

				}

   207

			} else { // IsBridge(m_new_tile)

   208

				if (!m_is_bridge) {

   209

					DiagDirection ramp_enderdir = GetTunnelBridgeDirection(m_new_tile);

   210

					if (ramp_enderdir != m_exitdir) {

   211

						m_err = EC_NO_WAY;

   212

						return false;

   213

					}

   214

				}

   215

			}

   216

		}

   217

   218

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

   219

		if (IsRailTT() && m_is_station) {

   220

			// entered railway station

   221

			// get platform length

   222

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

   223

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

   224

			m_tiles_skipped = length - 1;

   225

			// move to the platform end

   226

			TileIndexDiff diff = TileOffsByDiagDir(m_exitdir);

   227

			diff *= m_tiles_skipped;

   228

			m_new_tile = TILE_ADD(m_new_tile, diff);

   229

			return true;

   230

		}

   231

   232

		return true;

   233

	}

   234

   235

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

   236

	FORCEINLINE bool EnteredDepot()

   237

	{

   238

		// rail and road depots cause reversing

   239

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

   240

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

   241

			if (exitdir != m_exitdir) {

   242

				// reverse

   243

				m_new_tile = m_old_tile;

   244

				m_new_td_bits = TrackdirToTrackdirBits(ReverseTrackdir(m_old_td));

   245

				m_exitdir = exitdir;

   246

				m_tiles_skipped = 0;

   247

				m_is_tunnel = m_is_bridge = m_is_station = false;

   248

				return true;

   249

			}

   250

		}

   251

		return false;

   252

	}

   253

   254

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

   255

	FORCEINLINE bool TryReverse()

   256

	{

   257

		if (IsRoadTT()) {

   258

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

   259

			m_exitdir = ReverseDiagDir(m_exitdir);

   260

			// new tile will be the same as old one

   261

			m_new_tile = m_old_tile;

   262

			// set new trackdir bits to all reachable trackdirs

   263

			QueryNewTileTrackStatus();

   264

			m_new_td_bits &= DiagdirReachesTrackdirs(m_exitdir);

   265

			if (m_new_td_bits != TRACKDIR_BIT_NONE) {

   266

				// we have some trackdirs reachable after reversal

   267

				return true;

   268

			}

   269

		}

   270

		m_err = EC_NO_WAY;

   271

		return false;

   272

	}

   273

   274

public:

   275

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

   276

	int GetSpeedLimit(int *pmin_speed = NULL) const

   277

	{

   278

		int min_speed = 0;

   279

		int max_speed = INT_MAX; // no limit

   280

   281

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

   282

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

   283

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

   284

			if (IsRoadTT()) spd *= 2;

   285

			if (max_speed > spd) max_speed = spd;

   286

		}

   287

   288

		// if min speed was requested, return it

   289

		if (pmin_speed) *pmin_speed = min_speed;

   290

		return max_speed;

   291

	}

   292

};

   293

   294

typedef CFollowTrackT<TRANSPORT_WATER, true > CFollowTrackWater;

   295

typedef CFollowTrackT<TRANSPORT_ROAD , true > CFollowTrackRoad;

   296

typedef CFollowTrackT<TRANSPORT_RAIL , true > CFollowTrackRail;

   297

   298

typedef CFollowTrackT<TRANSPORT_WATER, false> CFollowTrackWaterNo90;

   299

typedef CFollowTrackT<TRANSPORT_ROAD , false> CFollowTrackRoadNo90;

   300

typedef CFollowTrackT<TRANSPORT_RAIL , false> CFollowTrackRailNo90;

   301

   302

#endif /* FOLLOW_TRACK_HPP */