1

#include "stdafx.h"

     2

#include "openttd.h"

     3

#include "debug.h"

     5

#include "npf.h"

     6

#include "aystar.h"

     7

#include "macros.h"

     8

#include "pathfind.h"

     9

#include "station.h"

    10

#include "tile.h"

    11

#include "depot.h"

    12

    13

static AyStar _npf_aystar;

    14

    15

/* The cost of each trackdir. A diagonal piece is the full NPF_TILE_LENGTH,

    16

 * the shorter piece is sqrt(2)/2*NPF_TILE_LENGTH =~ 0.7071

    17

 */

    18

#define NPF_STRAIGHT_LENGTH (uint)(NPF_TILE_LENGTH * STRAIGHT_TRACK_LENGTH)

    19

static const uint _trackdir_length[TRACKDIR_END] = {

    20

	NPF_TILE_LENGTH, NPF_TILE_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH,

    21

	0, 0,

    22

	NPF_TILE_LENGTH, NPF_TILE_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH

    23

};

    24

    25

/**

    26

 * Check if a rail track is the end of the line. Will also consider 1-way signals to be the end of a line.

    27

 * @param tile The tile on which the current track is.

    28

 * @param trackdir The (track)direction in which you want to look.

    29

 * @param enginetype The type of the engine for which we are checking this.

    30

 */

    31

bool IsEndOfLine(TileIndex tile, Trackdir trackdir, RailType enginetype)

    32

{

    33

	byte exitdir = TrackdirToExitdir(trackdir);

    34

	TileIndex dst_tile;

    35

	uint32 ts;

    36

    37

	// tunnel entrance?

    38

	if (IsTileType(tile, MP_TUNNELBRIDGE) && (_m[tile].m5 & 0xF0)==0 && (_m[tile].m5 & 3) == exitdir)

    39

		return false;

    40

    41

	// depot

    42

	if (IsTileDepotType(tile, TRANSPORT_RAIL) && (exitdir != GetDepotDirection(tile, TRANSPORT_RAIL)))

    43

		return true;

    44

    45

	/* Calculate next tile */

    46

	dst_tile = tile + TileOffsByDir(exitdir);

    47

	// determine the track status on the next tile.

    48

	ts = GetTileTrackStatus(dst_tile, TRANSPORT_RAIL) & TrackdirReachesTrackdirs(trackdir);

    49

    50

	// when none of the trackdir bits are set, we cant enter the new tile

    51

	if ( (ts & TRACKDIR_BIT_MASK) == 0)

    52

		return true;

    53

    54

	{

    55

		byte dst_type = GetTileRailType(dst_tile, exitdir);

    56

		if (!IsCompatibleRail(enginetype, dst_type))

    57

			return true;

    58

		if (GetTileOwner(tile) != GetTileOwner(dst_tile))

    59

			return true;

    60

    61

		if (IsTileDepotType(dst_tile, TRANSPORT_RAIL) && (exitdir != ReverseDiagdir(GetDepotDirection(dst_tile, TRANSPORT_RAIL))))

    62

			return true;

    63

    64

		/* Check for oneway signal against us */

    65

		if (IsTileType(dst_tile, MP_RAILWAY) && GetRailTileType(dst_tile) == RAIL_TYPE_SIGNALS) {

    66

			if (HasSignalOnTrackdir(dst_tile, ReverseTrackdir(FindFirstBit2x64(ts))) && !HasSignalOnTrackdir(dst_tile, FindFirstBit2x64(ts)))

    67

				// if one way signal not pointing towards us, stop going in this direction.

    68

				return true;

    69

		}

    70

    71

		return false;

    72

	}

    73

};

    74

    75

#if 0

    76

static uint NTPHash(uint key1, uint key2)

    77

{

    78

	/* This function uses the old hash, which is fixed on 10 bits (1024 buckets) */

    79

	return PATHFIND_HASH_TILE(key1);

    80

}

    81

#endif

    82

    83

/**

    84

 * Calculates a hash value for use in the NPF.

    85

 * @param key1	The TileIndex of the tile to hash

    86

 * @param key1	The Trackdir of the track on the tile.

    87

 *

    88

 * @todo	Think of a better hash.

    89

 */

    90

static uint NPFHash(uint key1, uint key2)

    91

{

    92

	/* TODO: think of a better hash? */

    93

	uint part1 = TileX(key1) & NPF_HASH_HALFMASK;

    94

	uint part2 = TileY(key1) & NPF_HASH_HALFMASK;

    95

    96

	assert(IsValidTrackdir(key2));

    97

	assert(IsValidTile(key1));

    98

	return ((((part1 << NPF_HASH_HALFBITS) | part2)) + (NPF_HASH_SIZE * key2 / TRACKDIR_END)) % NPF_HASH_SIZE;

    99

}

   100

   101

static int32 NPFCalcZero(AyStar* as, AyStarNode* current, OpenListNode* parent)

   102

{

   103

	return 0;

   104

}

   105

   106

/* Calcs the tile of given station that is closest to a given tile

   107

 * for this we assume the station is a rectangle,

   108

 * as defined by its top tile (st->train_tile) and its width/height (st->trainst_w, st->trainst_h)

   109

 */

   110

static TileIndex CalcClosestStationTile(StationID station, TileIndex tile)

   111

{

   112

	const Station* st = GetStation(station);

   113

   114

	uint minx = TileX(st->train_tile);  // topmost corner of station

   115

	uint miny = TileY(st->train_tile);

   116

	uint maxx = minx + st->trainst_w - 1; // lowermost corner of station

   117

	uint maxy = miny + st->trainst_h - 1;

   118

	uint x;

   119

	uint y;

   120

   121

	// we are going the aim for the x coordinate of the closest corner

   122

	// but if we are between those coordinates, we will aim for our own x coordinate

   123

	x = clamp(TileX(tile), minx, maxx);

   124

   125

	// same for y coordinate, see above comment

   126

	y = clamp(TileY(tile), miny, maxy);

   127

   128

	// return the tile of our target coordinates

   129

	return TileXY(x, y);

   130

};

   131

   132

/* On PBS pathfinding runs, this is called before pathfinding ends (BeforeExit aystar callback), and will

   133

 * reserve the appropriate tracks, if needed. */

   134

void NPFReservePBSPath(AyStar *as)

   135

{

   136

	NPFFoundTargetData* ftd = (NPFFoundTargetData*)as->user_path;

   137

	bool eol_end = false;

   138

   139

	if (ftd->best_trackdir == 0xFF)

   140

		return;

   141

   142

	if (!NPFGetFlag(&ftd->node, NPF_FLAG_PBS_EXIT) && IsEndOfLine(ftd->node.tile, ftd->node.direction, as->user_data[NPF_RAILTYPE]) && !NPFGetFlag(&ftd->node, NPF_FLAG_SEEN_SIGNAL)) {

   143

		/* The path ends in an end of line, we'll need to reserve a path.

   144

		 * We treat and end of line as a red exit signal */

   145

		eol_end = true;

   146

		NPFSetFlag(&ftd->node, NPF_FLAG_PBS_EXIT, true);

   147

		if (!NPFGetFlag(&ftd->node, NPF_FLAG_PBS_TARGET_SEEN))

   148

			NPFSetFlag(&ftd->node, NPF_FLAG_PBS_RED, true);

   149

	}

   150

   151

	if (!NPFGetFlag(&ftd->node, NPF_FLAG_PBS_CHOICE)) {

   152

		/* there have been no choices to make on our path, we dont care if our end signal is red */

   153

		NPFSetFlag(&ftd->node, NPF_FLAG_PBS_RED, false);

   154

	}

   155

   156

	if (NPFGetFlag(&ftd->node, NPF_FLAG_PBS_EXIT) && // we passed an exit signal

   157

		 !NPFGetFlag(&ftd->node, NPF_FLAG_PBS_BLOCKED) && // we didnt encounter reserver tracks

   158

		 ((as->user_data[NPF_PBS_MODE] != PBS_MODE_GREEN) || (!NPFGetFlag(&ftd->node, NPF_FLAG_PBS_RED))) ) { // our mode permits having a red exit signal, or the signal is green

   159

		PathNode parent;

   160

		PathNode *curr;

   161

		PathNode *prev;

   162

		TileIndex start = INVALID_TILE;

   163

		byte trackdir = 0;

   164

   165

		parent.node = ftd->node;

   166

		parent.parent = &ftd->path;

   167

		curr = &parent;

   168

		prev = NULL;

   169

   170

		do {

   171

			if (!NPFGetFlag(&curr->node, NPF_FLAG_PBS_EXIT) || eol_end) {

   172

				/* check for already reserved track on this path, if they clash with what we

   173

				   currently trying to reserve, we have a self-crossing path :-( */

   174

				if ((PBSTileUnavail(curr->node.tile) & (1 << curr->node.direction))

   175

				&& !(PBSTileReserved(curr->node.tile) & (1 << (curr->node.direction & 7)))

   176

				&& (start != INVALID_TILE)) {

   177

					/* It's actually quite bad if this happens, it means the pathfinder

   178

					 * found a path that is intersecting with itself, which is a very bad

   179

					 * thing in a pbs block. Also there is not much we can do about it at

   180

					 * this point....

   181

					 * BUT, you have to have a pretty fucked up junction layout for this to happen,

   182

					 * so we'll just stop this train, the user will eventually notice, so he can fix it.

   183

					 */

   184

					PBSClearPath(start, trackdir, curr->node.tile, curr->node.direction);

   185

					NPFSetFlag(&ftd->node, NPF_FLAG_PBS_BLOCKED, true);

   186

					DEBUG(pbs, 1) ("PBS: Self-crossing path!!!");

   187

					return;

   188

				};

   189

   190

				PBSReserveTrack(curr->node.tile, TrackdirToTrack(curr->node.direction) );

   191

   192

				/* we want to reserve the last tile (with the signal) on the path too

   193

				   also remember this tile, cause its the end of the path (where we exit the block) */

   194

				if (start == INVALID_TILE) {

   195

					if (prev != NULL) {

   196

						PBSReserveTrack(prev->node.tile, TrackdirToTrack(prev->node.direction) );

   197

						start = prev->node.tile;

   198

						trackdir = ReverseTrackdir(prev->node.direction);

   199

					} else {

   200

						start = curr->node.tile;

   201

						trackdir = curr->node.direction;

   202

					}

   203

				}

   204

			}

   205

   206

			prev = curr;

   207

			curr = curr->parent;

   208

		} while (curr != NULL);

   209

		// we remember the tile/track where this path leaves the pbs junction

   210

		ftd->node.tile = start;

   211

		ftd->node.direction = trackdir;

   212

	}

   213

}

   214

   215

   216

/* Calcs the heuristic to the target station or tile. For train stations, it

   217

 * takes into account the direction of approach.

   218

 */

   219

static int32 NPFCalcStationOrTileHeuristic(AyStar* as, AyStarNode* current, OpenListNode* parent)

   220

{

   221

	NPFFindStationOrTileData* fstd = (NPFFindStationOrTileData*)as->user_target;

   222

	NPFFoundTargetData* ftd = (NPFFoundTargetData*)as->user_path;

   223

	TileIndex from = current->tile;

   224

	TileIndex to = fstd->dest_coords;

   225

	uint dist;

   226

   227

	// for train-stations, we are going to aim for the closest station tile

   228

	if ((as->user_data[NPF_TYPE] == TRANSPORT_RAIL) && (fstd->station_index != -1))

   229

		to = CalcClosestStationTile(fstd->station_index, from);

   230

   231

	if (as->user_data[NPF_TYPE] == TRANSPORT_ROAD)

   232

		/* Since roads only have diagonal pieces, we use manhattan distance here */

   233

		dist = DistanceManhattan(from, to) * NPF_TILE_LENGTH;

   234

	else

   235

		/* Ships and trains can also go diagonal, so the minimum distance is shorter */

   236

		dist = DistanceTrack(from, to) * NPF_TILE_LENGTH;

   237

   238

	DEBUG(npf, 4)("Calculating H for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), dist);

   239

   240

	/* for pbs runs, we ignore tiles inside the pbs block for the tracking

   241

	   of the 'closest' tile */

   242

	if ((as->user_data[NPF_PBS_MODE] != PBS_MODE_NONE)

   243

	&&  (!NPFGetFlag(current , NPF_FLAG_SEEN_SIGNAL))

   244

	&&  (!IsEndOfLine(current->tile, current->direction, as->user_data[NPF_RAILTYPE])))

   245

		return dist;

   246

   247

	if ((dist < ftd->best_bird_dist) ||

   248

		/* for pbs runs, prefer tiles that pass a green exit signal to the pbs blocks */

   249

		((as->user_data[NPF_PBS_MODE] != PBS_MODE_NONE) && !NPFGetFlag(current, NPF_FLAG_PBS_RED) && NPFGetFlag(&ftd->node, NPF_FLAG_PBS_RED))

   250

) {

   251

		ftd->best_bird_dist = dist;

   252

		ftd->best_trackdir = current->user_data[NPF_TRACKDIR_CHOICE];

   253

		ftd->path = parent->path;

   254

		ftd->node = *current;

   255

	}

   256

	return dist;

   257

}

   258

   259

/* Fills AyStarNode.user_data[NPF_TRACKDIRCHOICE] with the chosen direction to

   260

 * get here, either getting it from the current choice or from the parent's

   261

 * choice */

   262

static void NPFFillTrackdirChoice(AyStarNode* current, OpenListNode* parent)

   263

{

   264

	if (parent->path.parent == NULL) {

   265

		Trackdir trackdir = (Trackdir)current->direction;

   266

		/* This is a first order decision, so we'd better save the

   267

		 * direction we chose */

   268

		current->user_data[NPF_TRACKDIR_CHOICE] = trackdir;

   269

		DEBUG(npf, 6)("Saving trackdir: %#x", trackdir);

   270

	} else {

   271

		/* We've already made the decision, so just save our parent's

   272

		 * decision */

   273

		current->user_data[NPF_TRACKDIR_CHOICE] = parent->path.node.user_data[NPF_TRACKDIR_CHOICE];

   274

	}

   275

   276

}

   277

   278

/* Will return the cost of the tunnel. If it is an entry, it will return the

   279

 * cost of that tile. If the tile is an exit, it will return the tunnel length

   280

 * including the exit tile. Requires that this is a Tunnel tile */

   281

static uint NPFTunnelCost(AyStarNode* current)

   282

{

   283

	DiagDirection exitdir = TrackdirToExitdir((Trackdir)current->direction);

   284

	TileIndex tile = current->tile;

   285

	if ( (DiagDirection)(_m[tile].m5 & 3) == ReverseDiagdir(exitdir)) {

   286

		/* We just popped out if this tunnel, since were

   287

		 * facing the tunnel exit */

   288

		FindLengthOfTunnelResult flotr;

   289

		flotr = FindLengthOfTunnel(tile, ReverseDiagdir(exitdir));

   290

		return flotr.length * NPF_TILE_LENGTH;

   291

		//TODO: Penalty for tunnels?

   292

	} else {

   293

		/* We are entering the tunnel, the enter tile is just a

   294

		 * straight track */

   295

		return NPF_TILE_LENGTH;

   296

	}

   297

}

   298

   299

static uint NPFSlopeCost(AyStarNode* current)

   300

{

   301

	TileIndex next = current->tile + TileOffsByDir(TrackdirToExitdir(current->direction));

   302

	int x,y;

   303

	int8 z1,z2;

   304

   305

	x = TileX(current->tile) * TILE_SIZE;

   306

	y = TileY(current->tile) * TILE_SIZE;

   307

	/* get the height of the center of the current tile */

   308

	z1 = GetSlopeZ(x+TILE_HEIGHT, y+TILE_HEIGHT);

   309

   310

	x = TileX(next) * TILE_SIZE;

   311

	y = TileY(next) * TILE_SIZE;

   312

	/* get the height of the center of the next tile */

   313

	z2 = GetSlopeZ(x+TILE_HEIGHT, y+TILE_HEIGHT);

   314

   315

	if ((z2 - z1) > 1) {

   316

		/* Slope up */

   317

		return _patches.npf_rail_slope_penalty;

   318

	}

   319

	return 0;

   320

	/* Should we give a bonus for slope down? Probably not, we

   321

	 * could just substract that bonus from the penalty, because

   322

	 * there is only one level of steepness... */

   323

}

   324

   325

/* Mark tiles by mowing the grass when npf debug level >= 1 */

   326

static void NPFMarkTile(TileIndex tile)

   327

{

   328

#ifdef NO_DEBUG_MESSAGES

   329

	return;

   330

#else

   331

	if (_debug_npf_level >= 1)

   332

		switch(GetTileType(tile)) {

   333

			case MP_RAILWAY:

   334

				/* DEBUG: mark visited tiles by mowing the grass under them

   335

				 * ;-) */

   336

				if (!IsTileDepotType(tile, TRANSPORT_RAIL)) {

   337

					_m[tile].m2 &= ~15; /* Clear bits 0-3 */

   338

					MarkTileDirtyByTile(tile);

   339

				}

   340

				break;

   341

			case MP_STREET:

   342

				if (!IsTileDepotType(tile, TRANSPORT_ROAD)) {

   343

					_m[tile].m4 &= ~0x70; /* Clear bits 4-6 */

   344

					MarkTileDirtyByTile(tile);

   345

				}

   346

				break;

   347

			default:

   348

				break;

   349

		}

   350

#endif

   351

}

   352

   353

static int32 NPFWaterPathCost(AyStar* as, AyStarNode* current, OpenListNode* parent)

   354

{

   355

	//TileIndex tile = current->tile;

   356

	int32 cost = 0;

   357

	Trackdir trackdir = (Trackdir)current->direction;

   358

   359

	cost = _trackdir_length[trackdir]; /* Should be different for diagonal tracks */

   360

   361

	if (IsBuoyTile(current->tile) && IsDiagonalTrackdir(trackdir))

   362

		cost += _patches.npf_buoy_penalty; /* A small penalty for going over buoys */

   363

   364

	if (current->direction != NextTrackdir((Trackdir)parent->path.node.direction))

   365

		cost += _patches.npf_water_curve_penalty;

   366

   367

	/* TODO More penalties? */

   368

   369

	return cost;

   370

}

   371

   372

/* Determine the cost of this node, for road tracks */

   373

static int32 NPFRoadPathCost(AyStar* as, AyStarNode* current, OpenListNode* parent)

   374

{

   375

	TileIndex tile = current->tile;

   376

	int32 cost = 0;

   377

   378

	/* Determine base length */

   379

	switch (GetTileType(tile)) {

   380

		case MP_TUNNELBRIDGE:

   381

			if ((_m[tile].m5 & 0xF0)==0) {

   382

				cost = NPFTunnelCost(current);

   383

				break;

   384

			}

   385

			/* Fall through if above if is false, it is a bridge

   386

			 * then. We treat that as ordinary road */

   387

		case MP_STREET:

   388

			cost = NPF_TILE_LENGTH;

   389

			/* Increase the cost for level crossings */

   390

			if ((_m[tile].m5 & 0xF0) == 0x10)

   391

				cost += _patches.npf_crossing_penalty;

   392

			break;

   393

		default:

   394

			break;

   395

	}

   396

   397

	/* Determine extra costs */

   398

   399

	/* Check for slope */

   400

	cost += NPFSlopeCost(current);

   401

   402

	/* Check for turns. Road vehicles only really drive diagonal, turns are

   403

	 * represented by non-diagonal tracks */

   404

	if (!IsDiagonalTrackdir(current->direction))

   405

		cost += _patches.npf_road_curve_penalty;

   406

   407

	NPFMarkTile(tile);

   408

	DEBUG(npf, 4)("Calculating G for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), cost);

   409

	return cost;

   410

}

   411

   412

   413

/* Determine the cost of this node, for railway tracks */

   414

static int32 NPFRailPathCost(AyStar* as, AyStarNode* current, OpenListNode* parent)

   415

{

   416

	TileIndex tile = current->tile;

   417

	Trackdir trackdir = (Trackdir)current->direction;

   418

	int32 cost = 0;

   419

	/* HACK: We create a OpenListNode manualy, so we can call EndNodeCheck */

   420

	OpenListNode new_node;

   421

   422

	/* Determine base length */

   423

	switch (GetTileType(tile)) {

   424

		case MP_TUNNELBRIDGE:

   425

			if ((_m[tile].m5 & 0xF0)==0) {

   426

				cost = NPFTunnelCost(current);

   427

				break;

   428

			}

   429

			/* Fall through if above if is false, it is a bridge

   430

			 * then. We treat that as ordinary rail */

   431

		case MP_RAILWAY:

   432

			cost = _trackdir_length[trackdir]; /* Should be different for diagonal tracks */

   433

			break;

   434

		case MP_STREET: /* Railway crossing */

   435

			cost = NPF_TILE_LENGTH;

   436

			break;

   437

		case MP_STATION:

   438

			/* We give a station tile a penalty. Logically we would only

   439

					* want to give station tiles that are not our destination

   440

					* this penalty. This would discourage trains to drive through

   441

					* busy stations. But, we can just give any station tile a

   442

					* penalty, because every possible route will get this penalty

   443

					* exactly once, on its end tile (if it's a station) and it

   444

			* will therefore not make a difference. */

   445

			cost = NPF_TILE_LENGTH + _patches.npf_rail_station_penalty;

   446

			break;

   447

		default:

   448

			break;

   449

	}

   450

   451

	/* Determine extra costs */

   452

   453

	/* Check for reserved tracks (PBS) */

   454

	if ((as->user_data[NPF_PBS_MODE] != PBS_MODE_NONE) && !(NPFGetFlag(current, NPF_FLAG_PBS_EXIT)) && !(NPFGetFlag(current, NPF_FLAG_PBS_BLOCKED)) && (PBSTileUnavail(tile) & (1<<trackdir))) {

   455

		NPFSetFlag(current, NPF_FLAG_PBS_BLOCKED, true);

   456

	};

   457

   458

	/* Check for signals */

   459

	if (IsTileType(tile, MP_RAILWAY) && HasSignalOnTrackdir(tile, trackdir)) {

   460

		/* Ordinary track with signals */

   461

		if (GetSignalState(tile, trackdir) == SIGNAL_STATE_RED) {

   462

			/* Signal facing us is red */

   463

			if (!NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL)) {

   464

				/* Penalize the first signal we

   465

				 * encounter, if it is red */

   466

   467

				/* Is this a presignal exit or combo? */

   468

				SignalType sigtype = GetSignalType(tile, TrackdirToTrack(trackdir));

   469

				if (sigtype == SIGTYPE_EXIT || sigtype == SIGTYPE_COMBO)

   470

					/* Penalise exit and combo signals differently (heavier) */

   471

					cost += _patches.npf_rail_firstred_exit_penalty;

   472

				else

   473

					cost += _patches.npf_rail_firstred_penalty;

   474

   475

				/* for pbs runs, store the fact that the exit signal to the pbs block was red */

   476

				if (!(NPFGetFlag(current, NPF_FLAG_PBS_EXIT)) && !(NPFGetFlag(current, NPF_FLAG_PBS_RED)) && NPFGetFlag(current, NPF_FLAG_PBS_CHOICE))

   477

					NPFSetFlag(current, NPF_FLAG_PBS_RED, true);

   478

			}

   479

			/* Record the state of this signal */

   480

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, true);

   481

		} else {

   482

			/* Record the state of this signal */

   483

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, false);

   484

		}

   485

   486

		if (!NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL) && NPFGetFlag(current, NPF_FLAG_PBS_BLOCKED)) {

   487

			/* penalise a path through the pbs block if it crosses reserved tracks */

   488

			cost += 1000;

   489

		}

   490

		if ((PBSIsPbsSignal(tile, trackdir)) && !NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL)) {

   491

			/* we've encountered an exit signal to the pbs block */

   492

			NPFSetFlag(current, NPF_FLAG_PBS_EXIT, true);

   493

		}

   494

		NPFSetFlag(current, NPF_FLAG_SEEN_SIGNAL, true);