1

#include "stdafx.h"

     2

#include "openttd.h"

     3

#include "debug.h"

     4

#include "npf.h"

     5

#include "aystar.h"

     6

#include "macros.h"

     7

#include "pathfind.h"

     8

#include "station.h"

     9

#include "tile.h"

    10

#include "depot.h"

    11

    12

static AyStar _npf_aystar;

    13

    14

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

    15

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

    16

 */

    17

#define NPF_STRAIGHT_LENGTH (uint)(NPF_TILE_LENGTH * STRAIGHT_TRACK_LENGTH)

    18

static const uint _trackdir_length[TRACKDIR_END] = {

    19

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

    20

	0, 0,

    21

	NPF_TILE_LENGTH, NPF_TILE_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH

    22

};

    23

    24

/**

    25

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

    26

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

    27

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

    28

 */

    29

bool IsEndOfLine(TileIndex tile, Trackdir trackdir)

    30

{

    31

	byte exitdir = TrackdirToExitdir(trackdir);

    32

	TileIndex dst_tile;

    33

	uint32 ts;

    34

    35

	// tunnel entrance?

    36

	if (IsTileType(tile, MP_TUNNELBRIDGE) && (_map5[tile] & 0xF0)==0 && (_map5[tile] & 3) == exitdir)

    37

		return false;

    38

    39

	// depot

    40

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

    41

		return true;

    42

    43

	/* Calculate next tile */

    44

	dst_tile = tile + TileOffsByDir(exitdir);

    45

	// determine the track status on the next tile.

    46

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

    47

    48

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

    49

	if ( (ts & TRACKDIR_BIT_MASK) == 0)

    50

		return true;

    51

    52

	{

    53

		byte src_type = GetTileRailType(tile, trackdir);

    54

		byte dst_type = GetTileRailType(dst_tile, exitdir);

    55

		if (src_type != dst_type) {

    56

			return true;

    57

		}

    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

static uint NTPHash(uint key1, uint key2)

    76

{

    77

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

    78

	return PATHFIND_HASH_TILE(key1);

    79

}

    80

    81

/**

    82

 * Calculates a hash value for use in the NPF.

    83

 * @param key1	The TileIndex of the tile to hash

    84

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

    85

 *

    86

 * @todo	Think of a better hash.

    87

 */

    88

static uint NPFHash(uint key1, uint key2)

    89

{

    90

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

    91

	uint part1 = TileX(key1) & NPF_HASH_HALFMASK;

    92

	uint part2 = TileY(key1) & NPF_HASH_HALFMASK;

    93

    94

	assert(IsValidTrackdir(key2));

    95

	assert(IsValidTile(key1));

    96

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

    97

}

    98

    99

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

   100

{

   101

	return 0;

   102

}

   103

   104

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

   105

 * for this we assume the station is a rectangle,

   106

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

   107

 */

   108

static TileIndex CalcClosestStationTile(StationID station, TileIndex tile)

   109

{

   110

	const Station* st = GetStation(station);

   111

   112

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

   113

	uint miny = TileY(st->train_tile);

   114

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

   115

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

   116

	uint x;

   117

	uint y;

   118

   119

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

   120

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

   121

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

   122

   123

	// same for y coordinate, see above comment

   124

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

   125

   126

	// return the tile of our target coordinates

   127

	return TileXY(x, y);

   128

};

   129

   130

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

   131

 * reserve the appropriate tracks, if needed. */

   132

void NPFReservePBSPath(AyStar *as)

   133

{

   134

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

   135

	bool eol_end = false;

   136

   137

	if (ftd->best_trackdir == 0xFF)

   138

		return;

   139

   140

	if (!NPFGetFlag(&ftd->node, NPF_FLAG_PBS_EXIT) && IsEndOfLine(ftd->node.tile, ftd->node.direction) && !NPFGetFlag(&ftd->node, NPF_FLAG_SEEN_SIGNAL)) {

   141

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

   142

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

   143

		eol_end = true;

   144

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

   145

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

   146

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

   147

	}

   148

   149

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

   150

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

   151

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

   152

	}

   153

   154

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

   155

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

   156

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

   157

		PathNode parent;

   158

		PathNode *curr;

   159

		PathNode *prev;

   160

		TileIndex start = INVALID_TILE;

   161

		byte trackdir = 0;

   162

   163

		parent.node = ftd->node;

   164

		parent.parent = &ftd->path;

   165

		curr = &parent;

   166

		prev = NULL;

   167

   168

		do {

   169

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

   170

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

   171

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

   172

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

   173

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

   174

				&& (start != INVALID_TILE)) {

   175

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

   176

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

   177

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

   178

					 * this point....

   179

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

   180

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

   181

					 */

   182

					PBSClearPath(start, trackdir);

   183

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

   184

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

   185

					return;

   186

				};

   187

   188

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

   189

   190

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

   191

				if (prev != NULL && start == INVALID_TILE) {

   192

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

   193

					start = prev->node.tile;

   194

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

   195

				}

   196

			}

   197

   198

			prev = curr;

   199

			curr = curr->parent;

   200

		} while (curr != NULL);

   201

	}

   202

   203

}

   204

   205

   206

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

   207

 * takes into account the direction of approach.

   208

 */

   209

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

   210

{

   211

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

   212

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

   213

	TileIndex from = current->tile;

   214

	TileIndex to = fstd->dest_coords;

   215

	uint dist;

   216

   217

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

   218

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

   219

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

   220

   221

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

   222

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

   223

		dist = DistanceManhattan(from, to) * NPF_TILE_LENGTH;

   224

	else

   225

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

   226

		dist = DistanceTrack(from, to) * NPF_TILE_LENGTH;

   227

   228

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

   229

   230

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

   231

	   of the 'closest' tile */

   232

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

   233

	&&  (!NPFGetFlag(current , NPF_FLAG_SEEN_SIGNAL))

   234

	&&  (!IsEndOfLine(current->tile, current->direction)))

   235

		return dist;

   236

   237

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

   238

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

   239

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

   240

) {

   241

		ftd->best_bird_dist = dist;

   242

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

   243

		ftd->path = parent->path;

   244

		ftd->node = *current;

   245

	}

   246

	return dist;

   247

}

   248

   249

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

   250

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

   251

 * choice */

   252

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

   253

{

   254

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

   255

		Trackdir trackdir = (Trackdir)current->direction;

   256

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

   257

		 * direction we chose */

   258

		current->user_data[NPF_TRACKDIR_CHOICE] = trackdir;

   259

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

   260

	} else {

   261

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

   262

		 * decision */

   263

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

   264

	}

   265

   266

}

   267

   268

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

   269

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

   270

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

   271

static uint NPFTunnelCost(AyStarNode* current)

   272

{

   273

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

   274

	TileIndex tile = current->tile;

   275

	if ( (DiagDirection)(_map5[tile] & 3) == ReverseDiagdir(exitdir)) {

   276

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

   277

		 * facing the tunnel exit */

   278

		FindLengthOfTunnelResult flotr;

   279

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

   280

		return flotr.length * NPF_TILE_LENGTH;

   281

		//TODO: Penalty for tunnels?

   282

	} else {

   283

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

   284

		 * straight track */

   285

		return NPF_TILE_LENGTH;

   286

	}

   287

}

   288

   289

static uint NPFSlopeCost(AyStarNode* current)

   290

{

   291

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

   292

	int x,y;

   293

	int8 z1,z2;

   294

   295

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

   296

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

   297

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

   298

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

   299

   300

	x = TileX(next) * TILE_SIZE;

   301

	y = TileY(next) * TILE_SIZE;

   302

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

   303

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

   304

   305

	if ((z2 - z1) > 1) {

   306

		/* Slope up */

   307

		return _patches.npf_rail_slope_penalty;

   308

	}

   309

	return 0;

   310

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

   311

	 * could just substract that bonus from the penalty, because

   312

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

   313

}

   314

   315

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

   316

static void NPFMarkTile(TileIndex tile)

   317

{

   318

#ifdef NO_DEBUG_MESSAGES

   319

	return;

   320

#else

   321

	if (_debug_npf_level >= 1)

   322

		switch(GetTileType(tile)) {

   323

			case MP_RAILWAY:

   324

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

   325

				 * ;-) */

   326

				if (!IsTileDepotType(tile, TRANSPORT_RAIL)) {

   327

					_map2[tile] &= ~15; /* Clear bits 0-3 */

   328

					MarkTileDirtyByTile(tile);

   329

				}

   330

				break;

   331

			case MP_STREET:

   332

				if (!IsTileDepotType(tile, TRANSPORT_ROAD)) {

   333

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

   334

					MarkTileDirtyByTile(tile);

   335

				}

   336

				break;

   337

			default:

   338

				break;

   339

		}

   340

#endif

   341

}

   342

   343

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

   344

{

   345

	//TileIndex tile = current->tile;

   346

	int32 cost = 0;

   347

	Trackdir trackdir = (Trackdir)current->direction;

   348

   349

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

   350

   351

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

   352

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

   353

   354

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

   355

		cost += _patches.npf_water_curve_penalty;

   356

   357

	/* TODO More penalties? */

   358

   359

	return cost;

   360

}

   361

   362

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

   363

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

   364

{

   365

	TileIndex tile = current->tile;

   366

	int32 cost = 0;

   367

   368

	/* Determine base length */

   369

	switch (GetTileType(tile)) {

   370

		case MP_TUNNELBRIDGE:

   371

			if ((_map5[tile] & 0xF0)==0) {

   372

				cost = NPFTunnelCost(current);

   373

				break;

   374

			}

   375

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

   376

			 * then. We treat that as ordinary road */

   377

		case MP_STREET:

   378

			cost = NPF_TILE_LENGTH;

   379

			/* Increase the cost for level crossings */

   380

			if ((_map5[tile] & 0xF0) == 0x10)

   381

				cost += _patches.npf_crossing_penalty;

   382

			break;

   383

		default:

   384

			break;

   385

	}

   386

   387

	/* Determine extra costs */

   388

   389

	/* Check for slope */

   390

	cost += NPFSlopeCost(current);

   391

   392

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

   393

	 * represented by non-diagonal tracks */

   394

	if (!IsDiagonalTrackdir(current->direction))

   395

		cost += _patches.npf_road_curve_penalty;

   396

   397

	NPFMarkTile(tile);

   398

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

   399

	return cost;

   400

}

   401

   402

   403

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

   404

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

   405

{

   406

	TileIndex tile = current->tile;

   407

	Trackdir trackdir = (Trackdir)current->direction;

   408

	int32 cost = 0;

   409

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

   410

	OpenListNode new_node;

   411

   412

	/* Determine base length */

   413

	switch (GetTileType(tile)) {

   414

		case MP_TUNNELBRIDGE:

   415

			if ((_map5[tile] & 0xF0)==0) {

   416

				cost = NPFTunnelCost(current);

   417

				break;

   418

			}

   419

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

   420

			 * then. We treat that as ordinary rail */

   421

		case MP_RAILWAY:

   422

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

   423

			break;

   424

		case MP_STREET: /* Railway crossing */

   425

			cost = NPF_TILE_LENGTH;

   426

			break;

   427

		case MP_STATION:

   428

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

   429

					* want to give station tiles that are not our destination

   430

					* this penalty. This would discourage trains to drive through

   431

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

   432

					* penalty, because every possible route will get this penalty

   433

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

   434

			* will therefore not make a difference. */

   435

			cost = NPF_TILE_LENGTH + _patches.npf_rail_station_penalty;

   436

			break;

   437

		default:

   438

			break;

   439

	}

   440

   441

	/* Determine extra costs */

   442

   443

	/* Check for reserved tracks (PBS) */

   444

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

   445

		NPFSetFlag(current, NPF_FLAG_PBS_BLOCKED, true);

   446

	};

   447

   448

	/* Check for signals */

   449

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

   450

		/* Ordinary track with signals */

   451

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

   452

			/* Signal facing us is red */

   453

			if (!NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL)) {

   454

				/* Penalize the first signal we

   455

				 * encounter, if it is red */

   456

   457

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

   458

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

   459

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

   460

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

   461

					cost += _patches.npf_rail_firstred_exit_penalty;

   462

				else

   463

					cost += _patches.npf_rail_firstred_penalty;

   464

   465

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

   466

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

   467

					NPFSetFlag(current, NPF_FLAG_PBS_RED, true);

   468

			}

   469

			/* Record the state of this signal */

   470

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, true);

   471

		} else {

   472

			/* Record the state of this signal */

   473

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, false);

   474

		}

   475

   476

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

   477

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

   478

			cost += 1000;

   479

		}

   480

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

   481

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

   482

			NPFSetFlag(current, NPF_FLAG_PBS_EXIT, true);

   483

		}

   484

		NPFSetFlag(current, NPF_FLAG_SEEN_SIGNAL, true);

   485

	}

   486

   487

	/* Penalise the tile if it is a target tile and the last signal was

   488

	 * red */

   489

	/* HACK: We create a new_node here so we can call EndNodeCheck. Ugly as hell

   490

	 * of course... */

   491

	new_node.path.node = *current;

   492

	if (as->EndNodeCheck(as, &new_node) == AYSTAR_FOUND_END_NODE && NPFGetFlag(current, NPF_FLAG_LAST_SIGNAL_RED))

   493

		cost += _patches.npf_rail_lastred_penalty;

   494

   495

	/* Check for slope */

   496

	cost += NPFSlopeCost(current);