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.

    29

 */

    31

{

    32

	byte exitdir = TrackdirToExitdir(trackdir);

    33

	TileIndex dst_tile;

    34

	uint32 ts;

    35

    36

	// tunnel entrance?

    37

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

    38

		return false;

    39

    40

	// depot

    41

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

    42

		return true;

    43

    44

	/* Calculate next tile */

    45

	dst_tile = tile + TileOffsByDir(exitdir);

    46

	// determine the track status on the next tile.

    47

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

    48

    49

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

    50

	if ( (ts & TRACKDIR_BIT_MASK) == 0)

    51

		return true;

    52

    53

	{

    54

		byte dst_type = GetTileRailType(dst_tile, exitdir);

    56

			return true;

    57

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

    58

			return true;

    59

    60

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

    61

			return true;

    62

    63

		/* Check for oneway signal against us */

    64

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

    65

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

    66

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

    67

				return true;

    68

		}

    69

    70

		return false;

    71

	}

    72

};

    73

    74

static uint NTPHash(uint key1, uint key2)

    75

{

    76

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

    77

	return PATHFIND_HASH_TILE(key1);

    78

}

    79

    80

/**

    81

 * Calculates a hash value for use in the NPF.

    82

 * @param key1	The TileIndex of the tile to hash

    83

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

    84

 *

    85

 * @todo	Think of a better hash.

    86

 */

    87

static uint NPFHash(uint key1, uint key2)

    88

{

    89

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

    90

	uint part1 = TileX(key1) & NPF_HASH_HALFMASK;

    91

	uint part2 = TileY(key1) & NPF_HASH_HALFMASK;

    92

    93

	assert(IsValidTrackdir(key2));

    94

	assert(IsValidTile(key1));

    95

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

    96

}

    97

    98

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

    99

{

   100

	return 0;

   101

}

   102

   103

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

   104

 * for this we assume the station is a rectangle,

   105

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

   106

 */

   107

static TileIndex CalcClosestStationTile(StationID station, TileIndex tile)

   108

{

   109

	const Station* st = GetStation(station);

   110

   111

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

   112

	uint miny = TileY(st->train_tile);

   113

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

   114

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

   115

	uint x;

   116

	uint y;

   117

   118

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

   119

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

   120

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

   121

   122

	// same for y coordinate, see above comment

   123

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

   124

   125

	// return the tile of our target coordinates

   126

	return TileXY(x, y);

   127

};

   128

   129

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

   130

 * reserve the appropriate tracks, if needed. */

   131

void NPFReservePBSPath(AyStar *as)

   132

{

   133

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

   134

	bool eol_end = false;

   135

   136

	if (ftd->best_trackdir == 0xFF)

   137

		return;

   138

   140

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

   141

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

   142

		eol_end = true;

   143

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

   144

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

   145

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

   146

	}

   147

   148

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

   149

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

   150

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

   151

	}

   152

   153

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

   154

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

   155

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

   156

		PathNode parent;

   157

		PathNode *curr;

   158

		PathNode *prev;

   159

		TileIndex start = INVALID_TILE;

   160

		byte trackdir = 0;

   161

   162

		parent.node = ftd->node;

   163

		parent.parent = &ftd->path;

   164

		curr = &parent;

   165

		prev = NULL;

   166

   167

		do {

   168

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

   169

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

   170

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

   171

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

   172

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

   173

				&& (start != INVALID_TILE)) {

   174

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

   175

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

   176

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

   177

					 * this point....

   178

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

   179

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

   180

					 */

   181

					PBSClearPath(start, trackdir);

   182

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

   183

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

   184

					return;

   185

				};

   186

   187

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

   188

   189

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

   190

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

   191

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

   192

					start = prev->node.tile;

   193

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

   194

				}

   195

			}

   196

   197

			prev = curr;

   198

			curr = curr->parent;

   199

		} while (curr != NULL);

   200

	}

   201

   202

}

   203

   204

   205

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

   206

 * takes into account the direction of approach.

   207

 */

   208

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

   209

{

   210

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

   211

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

   212

	TileIndex from = current->tile;

   213

	TileIndex to = fstd->dest_coords;

   214

	uint dist;

   215

   216

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

   217

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

   218

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

   219

   220

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

   221

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

   222

		dist = DistanceManhattan(from, to) * NPF_TILE_LENGTH;

   223

	else

   224

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

   225

		dist = DistanceTrack(from, to) * NPF_TILE_LENGTH;

   226

   227

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

   228

   229

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

   230

	   of the 'closest' tile */

   231

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

   232

	&&  (!NPFGetFlag(current , NPF_FLAG_SEEN_SIGNAL))

   234

		return dist;

   235

   236

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

   237

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

   238

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

   239

) {

   240

		ftd->best_bird_dist = dist;

   241

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

   242

		ftd->path = parent->path;

   243

		ftd->node = *current;

   244

	}

   245

	return dist;

   246

}

   247

   248

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

   249

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

   250

 * choice */

   251

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

   252

{

   253

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

   254

		Trackdir trackdir = (Trackdir)current->direction;

   255

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

   256

		 * direction we chose */

   257

		current->user_data[NPF_TRACKDIR_CHOICE] = trackdir;

   258

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

   259

	} else {

   260

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

   261

		 * decision */

   262

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

   263

	}

   264

   265

}

   266

   267

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

   268

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

   269

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

   270

static uint NPFTunnelCost(AyStarNode* current)

   271

{

   272

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

   273

	TileIndex tile = current->tile;

   274

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

   275

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

   276

		 * facing the tunnel exit */

   277

		FindLengthOfTunnelResult flotr;

   278

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

   279

		return flotr.length * NPF_TILE_LENGTH;

   280

		//TODO: Penalty for tunnels?

   281

	} else {

   282

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

   283

		 * straight track */

   284

		return NPF_TILE_LENGTH;

   285

	}

   286

}

   287

   288

static uint NPFSlopeCost(AyStarNode* current)

   289

{

   290

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

   291

	int x,y;

   292

	int8 z1,z2;

   293

   294

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

   295

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

   296

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

   297

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

   298

   299

	x = TileX(next) * TILE_SIZE;

   300

	y = TileY(next) * TILE_SIZE;

   301

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

   302

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

   303

   304

	if ((z2 - z1) > 1) {

   305

		/* Slope up */

   306

		return _patches.npf_rail_slope_penalty;

   307

	}

   308

	return 0;

   309

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

   310

	 * could just substract that bonus from the penalty, because

   311

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

   312

}

   313

   314

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

   315

static void NPFMarkTile(TileIndex tile)

   316

{

   317

#ifdef NO_DEBUG_MESSAGES

   318

	return;

   319

#else

   320

	if (_debug_npf_level >= 1)

   321

		switch(GetTileType(tile)) {

   322

			case MP_RAILWAY:

   323

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

   324

				 * ;-) */

   325

				if (!IsTileDepotType(tile, TRANSPORT_RAIL)) {

   326

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

   327

					MarkTileDirtyByTile(tile);

   328

				}

   329

				break;

   330

			case MP_STREET:

   331

				if (!IsTileDepotType(tile, TRANSPORT_ROAD)) {

   332

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

   333

					MarkTileDirtyByTile(tile);

   334

				}

   335

				break;

   336

			default:

   337

				break;

   338

		}

   339

#endif

   340

}

   341

   342

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

   343

{

   344

	//TileIndex tile = current->tile;

   345

	int32 cost = 0;

   346

	Trackdir trackdir = (Trackdir)current->direction;

   347

   348

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

   349

   350

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

   351

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

   352

   353

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

   354

		cost += _patches.npf_water_curve_penalty;

   355

   356

	/* TODO More penalties? */

   357

   358

	return cost;

   359

}

   360

   361

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

   362

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

   363

{

   364

	TileIndex tile = current->tile;

   365

	int32 cost = 0;

   366

   367

	/* Determine base length */

   368

	switch (GetTileType(tile)) {

   369

		case MP_TUNNELBRIDGE:

   370

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

   371

				cost = NPFTunnelCost(current);

   372

				break;

   373

			}

   374

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

   375

			 * then. We treat that as ordinary road */

   376

		case MP_STREET:

   377

			cost = NPF_TILE_LENGTH;

   378

			/* Increase the cost for level crossings */

   379

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

   380

				cost += _patches.npf_crossing_penalty;

   381

			break;

   382

		default:

   383

			break;

   384

	}

   385

   386

	/* Determine extra costs */

   387

   388

	/* Check for slope */

   389

	cost += NPFSlopeCost(current);

   390

   391

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

   392

	 * represented by non-diagonal tracks */

   393

	if (!IsDiagonalTrackdir(current->direction))

   394

		cost += _patches.npf_road_curve_penalty;

   395

   396

	NPFMarkTile(tile);

   397

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

   398

	return cost;

   399

}

   400

   401

   402

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

   403

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

   404

{

   405

	TileIndex tile = current->tile;

   406

	Trackdir trackdir = (Trackdir)current->direction;

   407

	int32 cost = 0;

   408

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

   409

	OpenListNode new_node;

   410

   411

	/* Determine base length */

   412

	switch (GetTileType(tile)) {

   413

		case MP_TUNNELBRIDGE:

   414

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

   415

				cost = NPFTunnelCost(current);

   416

				break;

   417

			}

   418

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

   419

			 * then. We treat that as ordinary rail */

   420

		case MP_RAILWAY:

   421

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

   422

			break;

   423

		case MP_STREET: /* Railway crossing */

   424

			cost = NPF_TILE_LENGTH;

   425

			break;

   426

		case MP_STATION:

   427

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

   428

					* want to give station tiles that are not our destination

   429

					* this penalty. This would discourage trains to drive through

   430

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

   431

					* penalty, because every possible route will get this penalty

   432

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

   433

			* will therefore not make a difference. */

   434

			cost = NPF_TILE_LENGTH + _patches.npf_rail_station_penalty;

   435

			break;

   436

		default:

   437

			break;

   438

	}

   439

   440

	/* Determine extra costs */

   441

   442

	/* Check for reserved tracks (PBS) */

   443

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

   444

		NPFSetFlag(current, NPF_FLAG_PBS_BLOCKED, true);

   445

	};

   446

   447

	/* Check for signals */

   448

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

   449

		/* Ordinary track with signals */

   450

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

   451

			/* Signal facing us is red */

   452

			if (!NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL)) {

   453

				/* Penalize the first signal we

   454

				 * encounter, if it is red */

   455

   456

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

   457

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

   458

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

   459

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

   460

					cost += _patches.npf_rail_firstred_exit_penalty;

   461

				else

   462

					cost += _patches.npf_rail_firstred_penalty;

   463

   464

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

   465

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

   466

					NPFSetFlag(current, NPF_FLAG_PBS_RED, true);

   467

			}

   468

			/* Record the state of this signal */

   469

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, true);

   470

		} else {

   471

			/* Record the state of this signal */

   472

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, false);

   473

		}

   474

   475

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

   476

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

   477

			cost += 1000;

   478

		}

   479

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

   480

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

   481

			NPFSetFlag(current, NPF_FLAG_PBS_EXIT, true);

   482

		}

   483

		NPFSetFlag(current, NPF_FLAG_SEEN_SIGNAL, true);

   484

	}

   485

   486

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

   487

	 * red */

   488

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

   489

	 * of course... */

   490

	new_node.path.node = *current;

   491

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

   492

		cost += _patches.npf_rail_lastred_penalty;

   493

   494

	/* Check for slope */

   495

	cost += NPFSlopeCost(current);

   496