3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "npf.h"

     8

#include "aystar.h"

     9

#include "macros.h"

    10

#include "pathfind.h"

    11

#include "station.h"

    12

#include "tile.h"

    13

#include "depot.h"

    14

    15

static AyStar _npf_aystar;

    16

    17

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

    18

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

    19

 */

    20

#define NPF_STRAIGHT_LENGTH (uint)(NPF_TILE_LENGTH * STRAIGHT_TRACK_LENGTH)

    21

static const uint _trackdir_length[TRACKDIR_END] = {

    22

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

    23

	0, 0,

    24

	NPF_TILE_LENGTH, NPF_TILE_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH

    25

};

    26

    27

/**

    28

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

    29

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

    30

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

    31

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

    32

 */

    33

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

    34

{

    35

	byte exitdir = TrackdirToExitdir(trackdir);

    36

	TileIndex dst_tile;

    37

	uint32 ts;

    38

    39

	// tunnel entrance?

    40

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

    41

		return false;

    42

    43

	// depot

    44

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

    45

		return true;

    46

    47

	/* Calculate next tile */

    48

	dst_tile = tile + TileOffsByDir(exitdir);

    49

	// determine the track status on the next tile.

    50

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

    51

    52

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

    53

	if ( (ts & TRACKDIR_BIT_MASK) == 0)

    54

		return true;

    55

    56

	{

    57

		byte dst_type = GetTileRailType(dst_tile, exitdir);

    58

		if (!IsCompatibleRail(enginetype, dst_type))

    59

			return true;

    60

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

    61

			return true;

    62

    63

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

    64

			return true;

    65

    66

		/* Check for oneway signal against us */

    67

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

    68

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

    69

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

    70

				return true;

    71

		}

    72

    73

		return false;

    74

	}

    75

}

    76

    77

#if 0

    78

static uint NTPHash(uint key1, uint key2)

    79

{

    80

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

    81

	return PATHFIND_HASH_TILE(key1);

    82

}

    83

#endif

    84

    85

/**

    86

 * Calculates a hash value for use in the NPF.

    87

 * @param key1	The TileIndex of the tile to hash

    88

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

    89

 *

    90

 * @todo	Think of a better hash.

    91

 */

    92

static uint NPFHash(uint key1, uint key2)

    93

{

    94

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

    95

	uint part1 = TileX(key1) & NPF_HASH_HALFMASK;

    96

	uint part2 = TileY(key1) & NPF_HASH_HALFMASK;

    97

    98

	assert(IsValidTrackdir(key2));

    99

	assert(IsValidTile(key1));

   100

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

   101

}

   102

   103

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

   104

{

   105

	return 0;

   106

}

   107

   108

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

   109

 * for this we assume the station is a rectangle,

   110

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

   111

 */

   112

static TileIndex CalcClosestStationTile(StationID station, TileIndex tile)

   113

{

   114

	const Station* st = GetStation(station);

   115

   116

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

   117

	uint miny = TileY(st->train_tile);

   118

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

   119

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

   120

	uint x;

   121

	uint y;

   122

   123

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

   124

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

   125

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

   126

   127

	// same for y coordinate, see above comment

   128

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

   129

   130

	// return the tile of our target coordinates

   131

	return TileXY(x, y);

   132

}

   133

   134

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

   135

 * reserve the appropriate tracks, if needed. */

   136

void NPFReservePBSPath(AyStar *as)

   137

{

   138

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

   139

	bool eol_end = false;

   140

   141

	if (ftd->best_trackdir == 0xFF)

   142

		return;

   143

   144

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

   145

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

   146

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

   147

		eol_end = true;

   148

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

   149

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

   150

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

   151

	}

   152

   153

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

   154

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

   155

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

   156

	}

   157

   158

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

   159

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

   160

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

   161

		PathNode parent;

   162

		PathNode *curr;

   163

		PathNode *prev;

   164

		TileIndex start = INVALID_TILE;

   165

		byte trackdir = 0;

   166

   167

		parent.node = ftd->node;

   168

		parent.parent = &ftd->path;

   169

		curr = &parent;

   170

		prev = NULL;

   171

   172

		do {

   173

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

   174

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

   175

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

   176

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

   177

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

   178

				&& (start != INVALID_TILE)) {

   179

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

   180

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

   181

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

   182

					 * this point....

   183

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

   184

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

   185

					 */

   186

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

   187

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

   188

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

   189

					return;

   190

				};

   191

   192

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

   193

   194

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

   195

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

   196

				if (start == INVALID_TILE) {

   197

					if (prev != NULL) {

   198

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

   199

						start = prev->node.tile;

   200

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

   201

					} else {

   202

						start = curr->node.tile;

   203

						trackdir = curr->node.direction;

   204

					}

   205

				}

   206

			}

   207

   208

			prev = curr;

   209

			curr = curr->parent;

   210

		} while (curr != NULL);

   211

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

   212

		ftd->node.tile = start;

   213

		ftd->node.direction = trackdir;

   214

	}

   215

}

   216

   217

   218

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

   219

 * takes into account the direction of approach.

   220

 */

   221

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

   222

{

   223

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

   224

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

   225

	TileIndex from = current->tile;

   226

	TileIndex to = fstd->dest_coords;

   227

	uint dist;

   228

   229

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

   230

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

   231

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

   232

   233

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

   234

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

   235

		dist = DistanceManhattan(from, to) * NPF_TILE_LENGTH;

   236

	else

   237

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

   238

		dist = DistanceTrack(from, to) * NPF_TILE_LENGTH;

   239

   240

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

   241

   242

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

   243

	   of the 'closest' tile */

   244

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

   245

	&&  (!NPFGetFlag(current , NPF_FLAG_SEEN_SIGNAL))

   246

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

   247

		return dist;

   248

   249

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

   250

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

   251

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

   252

) {

   253

		ftd->best_bird_dist = dist;

   254

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

   255

		ftd->path = parent->path;

   256

		ftd->node = *current;

   257

	}

   258

	return dist;

   259

}

   260

   261

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

   262

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

   263

 * choice */

   264

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

   265

{

   266

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

   267

		Trackdir trackdir = (Trackdir)current->direction;

   268

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

   269

		 * direction we chose */

   270

		current->user_data[NPF_TRACKDIR_CHOICE] = trackdir;

   271

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

   272

	} else {

   273

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

   274

		 * decision */

   275

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

   276

	}

   277

   278

}

   279

   280

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

   281

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

   282

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

   283

static uint NPFTunnelCost(AyStarNode* current)

   284

{

   285

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

   286

	TileIndex tile = current->tile;

   287

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

   288

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

   289

		 * facing the tunnel exit */

   290

		FindLengthOfTunnelResult flotr;

   291

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

   292

		return flotr.length * NPF_TILE_LENGTH;

   293

		//TODO: Penalty for tunnels?

   294

	} else {

   295

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

   296

		 * straight track */

   297

		return NPF_TILE_LENGTH;

   298

	}

   299

}

   300

   301

static uint NPFSlopeCost(AyStarNode* current)

   302

{

   303

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

   304

	int x,y;

   305

	int8 z1,z2;

   306

   307

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

   308

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

   309

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

   310

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

   311

   312

	x = TileX(next) * TILE_SIZE;

   313

	y = TileY(next) * TILE_SIZE;

   314

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

   315

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

   316

   317

	if ((z2 - z1) > 1) {

   318

		/* Slope up */

   319

		return _patches.npf_rail_slope_penalty;

   320

	}

   321

	return 0;

   322

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

   323

	 * could just substract that bonus from the penalty, because

   324

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

   325

}

   326

   327

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

   328

static void NPFMarkTile(TileIndex tile)

   329

{

   330

#ifdef NO_DEBUG_MESSAGES

   331

	return;

   332

#else

   333

	if (_debug_npf_level >= 1)

   334

		switch(GetTileType(tile)) {

   335

			case MP_RAILWAY:

   336

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

   337

				 * ;-) */

   338

				if (!IsTileDepotType(tile, TRANSPORT_RAIL)) {

   339

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

   340

					MarkTileDirtyByTile(tile);

   341

				}

   342

				break;

   343

			case MP_STREET:

   344

				if (!IsTileDepotType(tile, TRANSPORT_ROAD)) {

   345

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

   346

					MarkTileDirtyByTile(tile);

   347

				}

   348

				break;

   349

			default:

   350

				break;

   351

		}

   352

#endif

   353

}

   354

   355

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

   356

{

   357

	//TileIndex tile = current->tile;

   358

	int32 cost = 0;

   359

	Trackdir trackdir = (Trackdir)current->direction;

   360

   361

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

   362

   363

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

   364

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

   365

   366

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

   367

		cost += _patches.npf_water_curve_penalty;

   368

   369

	/* TODO More penalties? */

   370

   371

	return cost;

   372

}

   373

   374

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

   375

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

   376

{

   377

	TileIndex tile = current->tile;

   378

	int32 cost = 0;

   379

   380

	/* Determine base length */

   381

	switch (GetTileType(tile)) {

   382

		case MP_TUNNELBRIDGE:

   383

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

   384

				cost = NPFTunnelCost(current);

   385

				break;

   386

			}

   387

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

   388

			 * then. We treat that as ordinary road */

   389

		case MP_STREET:

   390

			cost = NPF_TILE_LENGTH;

   391

			/* Increase the cost for level crossings */

   392

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

   393

				cost += _patches.npf_crossing_penalty;

   394

			break;

   395

		default:

   396

			break;

   397

	}

   398

   399

	/* Determine extra costs */

   400

   401

	/* Check for slope */

   402

	cost += NPFSlopeCost(current);

   403

   404

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

   405

	 * represented by non-diagonal tracks */

   406

	if (!IsDiagonalTrackdir(current->direction))

   407

		cost += _patches.npf_road_curve_penalty;

   408

   409

	NPFMarkTile(tile);

   410

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

   411

	return cost;

   412

}

   413

   414

   415

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

   416

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

   417

{

   418

	TileIndex tile = current->tile;

   419

	Trackdir trackdir = (Trackdir)current->direction;

   420

	int32 cost = 0;

   421

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

   422

	OpenListNode new_node;

   423

   424

	/* Determine base length */

   425

	switch (GetTileType(tile)) {

   426

		case MP_TUNNELBRIDGE:

   427

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

   428

				cost = NPFTunnelCost(current);

   429

				break;

   430

			}

   431

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

   432

			 * then. We treat that as ordinary rail */

   433

		case MP_RAILWAY:

   434

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

   435

			break;

   436

		case MP_STREET: /* Railway crossing */

   437

			cost = NPF_TILE_LENGTH;

   438

			break;

   439

		case MP_STATION:

   440

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

   441

					* want to give station tiles that are not our destination

   442

					* this penalty. This would discourage trains to drive through

   443

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

   444

					* penalty, because every possible route will get this penalty

   445

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

   446

			* will therefore not make a difference. */

   447

			cost = NPF_TILE_LENGTH + _patches.npf_rail_station_penalty;

   448

			break;

   449

		default:

   450

			break;

   451

	}

   452

   453

	/* Determine extra costs */

   454

   455

	/* Check for reserved tracks (PBS) */

   456

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

   457

		NPFSetFlag(current, NPF_FLAG_PBS_BLOCKED, true);

   458

	};

   459

   460

	/* Check for signals */

   461

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

   462

		/* Ordinary track with signals */

   463

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

   464

			/* Signal facing us is red */

   465

			if (!NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL)) {

   466

				/* Penalize the first signal we

   467

				 * encounter, if it is red */

   468

   469

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

   470

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

   471

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

   472

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

   473

					cost += _patches.npf_rail_firstred_exit_penalty;

   474

				else

   475

					cost += _patches.npf_rail_firstred_penalty;

   476

   477

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

   478

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

   479

					NPFSetFlag(current, NPF_FLAG_PBS_RED, true);

   480

			}

   481

			/* Record the state of this signal */

   482

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, true);

   483

		} else {

   484

			/* Record the state of this signal */

   485

			NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, false);

   486

		}

   487

   488

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

   489

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

   490

			cost += 1000;

   491

		}

   492

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

   493

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

   494

			NPFSetFlag(current, NPF_FLAG_PBS_EXIT, true);