1

/* $Id$ */

     2

     3

/** @file waypoint.cpp Handling of waypoints. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

     8

#include "command_func.h"

     9

#include "landscape.h"

    10

#include "order_func.h"

    11

#include "rail_map.h"

    12

#include "rail.h"

    13

#include "bridge_map.h"

    14

#include "saveload.h"

    15

#include "station_base.h"

    16

#include "town.h"

    17

#include "waypoint.h"

    18

#include "variables.h"

    19

#include "yapf/yapf.h"

    20

#include "newgrf.h"

    21

#include "strings_func.h"

    22

#include "gfx_func.h"

    23

#include "functions.h"

    24

#include "window_func.h"

    25

#include "economy_func.h"

    26

#include "date_func.h"

    27

#include "vehicle_func.h"

    28

#include "vehicle_base.h"

    29

#include "string_func.h"

    30

#include "signal_func.h"

    31

#include "company_func.h"

    32

#include "settings_type.h"

    33

#include "newgrf_station.h"

    34

#include "oldpool_func.h"

    35

#include "viewport_func.h"

    36

#include "pbs.h"

    37

#include "train.h"

    38

    39

#include "table/strings.h"

    40

    41

DEFINE_OLD_POOL_GENERIC(Waypoint, Waypoint)

    42

    43

    44

/**

    45

 * Update the sign for the waypoint

    46

 * @param wp Waypoint to update sign */

    47

static void UpdateWaypointSign(Waypoint* wp)

    48

{

    49

	Point pt = RemapCoords2(TileX(wp->xy) * TILE_SIZE, TileY(wp->xy) * TILE_SIZE);

    50

	SetDParam(0, wp->index);

    51

	UpdateViewportSignPos(&wp->sign, pt.x, pt.y - 0x20, STR_WAYPOINT_VIEWPORT);

    52

}

    53

    54

/**

    55

 * Redraw the sign of a waypoint

    56

 * @param wp Waypoint to redraw sign */

    57

static void RedrawWaypointSign(const Waypoint* wp)

    58

{

    59

	MarkAllViewportsDirty(

    60

		wp->sign.left - 6,

    61

		wp->sign.top,

    62

		wp->sign.left + (wp->sign.width_1 << 2) + 12,

    63

		wp->sign.top + 48);

    64

}

    65

    66

/**

    67

 * Update all signs

    68

 */

    69

void UpdateAllWaypointSigns()

    70

{

    71

	Waypoint *wp;

    72

    73

	FOR_ALL_WAYPOINTS(wp) {

    74

		UpdateWaypointSign(wp);

    75

	}

    76

}

    77

    78

/**

    79

 * Set the default name for a waypoint

    80

 * @param wp Waypoint to work on

    81

 */

    82

static void MakeDefaultWaypointName(Waypoint* wp)

    83

{

    84

	uint32 used = 0; // bitmap of used waypoint numbers, sliding window with 'next' as base

    85

	uint32 next = 0; // first waypoint number in the bitmap

    86

	WaypointID idx = 0; // index where we will stop

    87

    88

	wp->town_index = ClosestTownFromTile(wp->xy, UINT_MAX)->index;

    89

    90

	/* Find first unused waypoint number belonging to this town. This can never fail,

    91

	 * as long as there can be at most 65535 waypoints in total.

    92

	 *

    93

	 * This does 'n * m' search, but with 32bit 'used' bitmap, it needs at most 'n * (1 + ceil(m / 32))'

    94

	 * steps (n - number of waypoints in pool, m - number of waypoints near this town).

    95

	 * Usually, it needs only 'n' steps.

    96

	 *

    97

	 * If it wasn't using 'used' and 'idx', it would just search for increasing 'next',

    98

	 * but this way it is faster */

    99

   100

	WaypointID cid = 0; // current index, goes to GetWaypointPoolSize()-1, then wraps to 0

   101

	do {

   102

		Waypoint *lwp = GetWaypoint(cid);

   103

   104

		/* check only valid waypoints... */

   105

		if (lwp->IsValid() && wp != lwp) {

   106

			/* only waypoints with 'generic' name within the same city */

   107

			if (lwp->name == NULL && lwp->town_index == wp->town_index) {

   108

				/* if lwp->town_cn < next, uint will overflow to '+inf' */

   109

				uint i = (uint)lwp->town_cn - next;

   110

   111

				if (i < 32) {

   112

					SetBit(used, i); // update bitmap

   113

					if (i == 0) {

   114

						/* shift bitmap while the lowest bit is '1';

   115

						 * increase the base of the bitmap too */

   116

						do {

   117

							used >>= 1;

   118

							next++;

   119

						} while (HasBit(used, 0));

   120

						/* when we are at 'idx' again at end of the loop and

   121

						 * 'next' hasn't changed, then no waypoint had town_cn == next,

   122

						 * so we can safely use it */

   123

						idx = cid;

   124

					}

   125

				}

   126

			}

   127

		}

   128

   129

		cid++;

   130

		if (cid == GetWaypointPoolSize()) cid = 0; // wrap to zero...

   131

	} while (cid != idx);

   132

   133

	wp->town_cn = (uint16)next; // set index...

   134

	wp->name = NULL; // ... and use generic name

   135

}

   136

   137

/**

   138

 * Find a deleted waypoint close to a tile.

   139

 * @param tile to search from

   140

 */

   141

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   142

{

   143

	Waypoint *wp, *best = NULL;

   144

	uint thres = 8;

   145

   146

	FOR_ALL_WAYPOINTS(wp) {

   147

		if (wp->deleted && (wp->owner == OWNER_NONE || wp->owner == _current_company)) {

   148

			uint cur_dist = DistanceManhattan(tile, wp->xy);

   149

   150

			if (cur_dist < thres) {

   151

				thres = cur_dist;

   152

				best = wp;

   153

			}

   154

		}

   155

	}

   156

   157

	return best;

   158

}

   159

   160

/**

   161

 * Update waypoint graphics id against saved GRFID/localidx.

   162

 * This is to ensure the chosen graphics are correct if GRF files are changed.

   163

 */

   164

void AfterLoadWaypoints()

   165

{

   166

	Waypoint *wp;

   167

   168

	FOR_ALL_WAYPOINTS(wp) {

   169

		uint i;

   170

   171

		if (wp->grfid == 0) continue;

   172

   173

		for (i = 0; i < GetNumCustomStations(STAT_CLASS_WAYP); i++) {

   174

			const StationSpec *statspec = GetCustomStationSpec(STAT_CLASS_WAYP, i);

   175

			if (statspec != NULL && statspec->grffile->grfid == wp->grfid && statspec->localidx == wp->localidx) {

   176

				wp->stat_id = i;

   177

				break;

   178

			}

   179

		}

   180

	}

   181

}

   182

   183

/** Convert existing rail to waypoint. Eg build a waypoint station over

   184

 * piece of rail

   185

 * @param tile tile where waypoint will be built

   186

 * @param flags type of operation

   187

 * @param p1 graphics for waypoint type, 0 indicates standard graphics

   188

 * @param p2 unused

   189

 *

   190

 * @todo When checking for the tile slope,

   191

 * distingush between "Flat land required" and "land sloped in wrong direction"

   192

 */

   193

CommandCost CmdBuildTrainWaypoint(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   194

{

   195

	Waypoint *wp;

   196

	Slope tileh;

   197

	Axis axis;

   198

   199

	/* if custom gfx are used, make sure it is within bounds */

   200

	if (p1 >= GetNumCustomStations(STAT_CLASS_WAYP)) return CMD_ERROR;

   201

   202

	if (!IsTileType(tile, MP_RAILWAY) ||

   203

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   204

				(axis = AXIS_X, GetTrackBits(tile) != TRACK_BIT_X) &&

   205

				(axis = AXIS_Y, GetTrackBits(tile) != TRACK_BIT_Y)

   206

			)) {

   207

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   208

	}

   209

   210

	Owner owner = GetTileOwner(tile);

   211

	if (!CheckOwnership(owner)) return CMD_ERROR;

   212

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   213

   214

	tileh = GetTileSlope(tile, NULL);

   215

	if (tileh != SLOPE_FLAT &&

   216

			(!_settings_game.construction.build_on_slopes || IsSteepSlope(tileh) || !(tileh & (0x3 << axis)) || !(tileh & ~(0x3 << axis)))) {

   217

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   218

	}

   219

   220

	if (MayHaveBridgeAbove(tile) && IsBridgeAbove(tile)) return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   221

   222

	/* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */

   223

	wp = FindDeletedWaypointCloseTo(tile);

   224

	if (wp == NULL && !Waypoint::CanAllocateItem()) return CMD_ERROR;

   225

   226

	if (flags & DC_EXEC) {

   227

		if (wp == NULL) {

   228

			wp = new Waypoint(tile);

   229

   230

			wp->town_index = INVALID_TOWN;

   231

			wp->name = NULL;

   232

			wp->town_cn = 0;

   233

		} else {

   234

			/* Move existing (recently deleted) waypoint to the new location */

   235

   236

			/* First we update the destination for all vehicles that

   237

			* have the old waypoint in their orders. */

   238

			Vehicle *v;

   239

			FOR_ALL_VEHICLES(v) {

   240

				if (v->type == VEH_TRAIN &&

   241

						v->First() == v &&

   242

						v->current_order.IsType(OT_GOTO_WAYPOINT) &&

   243

						v->dest_tile == wp->xy) {

   244

					v->dest_tile = tile;

   245

				}

   246

			}

   247

   248

			RedrawWaypointSign(wp);

   249

			wp->xy = tile;

   250

			InvalidateWindowData(WC_WAYPOINT_VIEW, wp->index);

   251

		}

   252

		wp->owner = owner;

   253

   254

		const StationSpec* statspec;

   255

   256

		bool reserved = HasBit(GetTrackReservation(tile), AxisToTrack(axis));

   257

		MakeRailWaypoint(tile, owner, axis, GetRailType(tile), wp->index);

   258

		SetDepotWaypointReservation(tile, reserved);

   259

		MarkTileDirtyByTile(tile);

   260

   261

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   262

   263

		if (statspec != NULL) {

   264

			wp->stat_id = p1;

   265

			wp->grfid = statspec->grffile->grfid;

   266

			wp->localidx = statspec->localidx;

   267

		} else {

   268

			/* Specified custom graphics do not exist, so use default. */

   269

			wp->stat_id = 0;

   270

			wp->grfid = 0;

   271

			wp->localidx = 0;

   272

		}

   273

   274

		wp->deleted = 0;

   275

		wp->build_date = _date;

   276

   277

		if (wp->town_index == INVALID_TOWN) MakeDefaultWaypointName(wp);

   278

   279

		UpdateWaypointSign(wp);

   280

		RedrawWaypointSign(wp);

   281

		YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));

   282

	}

   283

   284

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_train_depot);

   285

}

   286

   287

/**

   288

 * Daily loop for waypoints

   289

 */

   290

void WaypointsDailyLoop()

   291

{

   292

	Waypoint *wp;

   293

   294

	/* Check if we need to delete a waypoint */

   295

	FOR_ALL_WAYPOINTS(wp) {

   296

		if (wp->deleted != 0 && --wp->deleted == 0) delete wp;

   297

	}

   298

}

   299

   300

/**

   301

 * Remove a waypoint

   302

 * @param tile from which to remove waypoint

   303

 * @param flags type of operation

   304

 * @param justremove will indicate if it is removed from rail or if rails are removed too

   305

 * @return cost of operation or error

   306

 */

   307

CommandCost RemoveTrainWaypoint(TileIndex tile, uint32 flags, bool justremove)

   308

{

   309

	Waypoint *wp;

   310

   311

	/* Make sure it's a waypoint */

   312

	if (!IsRailWaypointTile(tile) ||

   313

			(!CheckTileOwnership(tile) && _current_company != OWNER_WATER) ||

   314

			!EnsureNoVehicleOnGround(tile)) {

   315

		return CMD_ERROR;

   316

	}

   317

   318

	if (flags & DC_EXEC) {

   319

		Track track = GetRailWaypointTrack(tile);

   320

		wp = GetWaypointByTile(tile);

   321

   322

		wp->deleted = 30; // let it live for this many days before we do the actual deletion.

   323

		RedrawWaypointSign(wp);

   324

   325

		Vehicle *v = NULL;

   326

		if (justremove) {

   327

			TrackBits tracks = GetRailWaypointBits(tile);

   328

			bool reserved = GetDepotWaypointReservation(tile);

   329

			MakeRailNormal(tile, wp->owner, tracks, GetRailType(tile));

   330

			if (reserved) SetTrackReservation(tile, tracks);

   331

			MarkTileDirtyByTile(tile);

   332

		} else {

   333

			if (GetDepotWaypointReservation(tile)) {

   334

				v = GetTrainForReservation(tile, track);

   335

				if (v != NULL) FreeTrainTrackReservation(v);

   336

			}

   337

			DoClearSquare(tile);

   338

			AddTrackToSignalBuffer(tile, track, wp->owner);

   339

		}

   340

		YapfNotifyTrackLayoutChange(tile, track);

   341

		if (v != NULL) TryPathReserve(v, true);

   342

	}

   343

   344

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_train_depot);

   345

}

   346

   347

/**

   348

 * Delete a waypoint

   349

 * @param tile tile where waypoint is to be deleted

   350

 * @param flags type of operation

   351

 * @param p1 unused

   352

 * @param p2 unused

   353

 * @return cost of operation or error

   354

 */

   355

CommandCost CmdRemoveTrainWaypoint(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   356

{

   357

	return RemoveTrainWaypoint(tile, flags, true);

   358

}

   359

   360

static bool IsUniqueWaypointName(const char *name)

   361

{

   362

	const Waypoint *wp;

   363

	char buf[512];

   364

   365

	FOR_ALL_WAYPOINTS(wp) {

   366

		SetDParam(0, wp->index);

   367

		GetString(buf, STR_WAYPOINT_RAW, lastof(buf));

   368

		if (strcmp(buf, name) == 0) return false;

   369

	}

   370

   371

	return true;

   372

}

   373

   374

/**

   375

 * Rename a waypoint.

   376

 * @param tile unused

   377

 * @param flags type of operation

   378

 * @param p1 id of waypoint

   379

 * @param p2 unused

   380

 * @return cost of operation or error

   381

 */

   382

CommandCost CmdRenameWaypoint(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   383

{

   384

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   385

   386

	Waypoint *wp = GetWaypoint(p1);

   387

	if (!CheckOwnership(wp->owner)) return CMD_ERROR;

   388

   389

	bool reset = StrEmpty(_cmd_text);

   390

   391

	if (!reset) {

   392

		if (strlen(_cmd_text) >= MAX_LENGTH_WAYPOINT_NAME_BYTES) return CMD_ERROR;

   393

		if (!IsUniqueWaypointName(_cmd_text)) return_cmd_error(STR_NAME_MUST_BE_UNIQUE);

   394

	}

   395

   396

	if (flags & DC_EXEC) {

   397

		free(wp->name);

   398

   399

		if (reset) {

   400

			MakeDefaultWaypointName(wp); // sets wp->name = NULL

   401

		} else {

   402

			wp->name = strdup(_cmd_text);

   403

		}

   404

   405

		UpdateWaypointSign(wp);

   406

		MarkWholeScreenDirty();

   407

	}

   408

	return CommandCost();

   409

}

   410

   411

/**

   412

 * This hacks together some dummy one-shot Station structure for a waypoint.

   413

 * @param tile on which to work

   414

 * @return pointer to a Station

   415

 */

   416

Station *ComposeWaypointStation(TileIndex tile)

   417

{

   418

	Waypoint *wp = GetWaypointByTile(tile);

   419

   420

	/* instead of 'static Station stat' use byte array to avoid Station's destructor call upon exit. As

   421

	 * a side effect, the station is not constructed now. */

   422

	static byte stat_raw[sizeof(Station)];

   423

	static Station &stat = *(Station*)stat_raw;

   424

   425

	stat.train_tile = stat.xy = wp->xy;

   426

	stat.town = GetTown(wp->town_index);

   427

	stat.build_date = wp->build_date;

   428

   429

	return &stat;

   430

}

   431

   432

/**

   433

 * Draw a waypoint

   434

 * @param x coordinate

   435

 * @param y coordinate

   436

 * @param stat_id station id

   437

 * @param railtype RailType to use for

   438

 */

   439

void DrawWaypointSprite(int x, int y, int stat_id, RailType railtype)

   440

{

   441

	x += 33;

   442

	y += 17;

   443

   444

	if (!DrawStationTile(x, y, railtype, AXIS_X, STAT_CLASS_WAYP, stat_id)) {

   445

		DrawDefaultWaypointSprite(x, y, railtype);

   446

	}

   447

}

   448

   449

Waypoint::Waypoint(TileIndex tile)

   450

{

   451

	this->xy = tile;

   452

}

   453

   454

Waypoint::~Waypoint()

   455

{

   456

	free(this->name);

   457

   458

	if (CleaningPool()) return;

   459

	DeleteWindowById(WC_WAYPOINT_VIEW, this->index);

   460

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, this->index);

   461

   462

	RedrawWaypointSign(this);

   463

	this->xy = 0;

   464

}

   465

   466

/**

   467

 * Fix savegames which stored waypoints in their old format

   468

 */

   469

void FixOldWaypoints()

   470

{

   471

	Waypoint *wp;

   472

   473

	/* Convert the old 'town_or_string', to 'string' / 'town' / 'town_cn' */

   474

	FOR_ALL_WAYPOINTS(wp) {

   475

		wp->town_index = ClosestTownFromTile(wp->xy, UINT_MAX)->index;

   476

		wp->town_cn = 0;

   477

		if (wp->string & 0xC000) {

   478

			wp->town_cn = wp->string & 0x3F;

   479

			wp->string = STR_NULL;

   480

		}

   481

	}

   482

}

   483

   484

void InitializeWaypoints()

   485

{

   486

	_Waypoint_pool.CleanPool();

   487

	_Waypoint_pool.AddBlockToPool();

   488

}

   489

   490

static const SaveLoad _waypoint_desc[] = {

   491

	SLE_CONDVAR(Waypoint, xy,         SLE_FILE_U16 | SLE_VAR_U32,  0, 5),