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 "player_func.h"

    32

#include "settings_type.h"

    33

#include "newgrf_station.h"

    34

#include "oldpool_func.h"

    35

#include "viewport_func.h"

    36

    37

#include "table/strings.h"

    38

    39

DEFINE_OLD_POOL_GENERIC(Waypoint, Waypoint)

    40

    41

    42

/**

    43

 * Update the sign for the waypoint

    44

 * @param wp Waypoint to update sign */

    45

static void UpdateWaypointSign(Waypoint* wp)

    46

{

    47

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

    48

	SetDParam(0, wp->index);

    49

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

    50

}

    51

    52

/**

    53

 * Redraw the sign of a waypoint

    54

 * @param wp Waypoint to redraw sign */

    55

static void RedrawWaypointSign(const Waypoint* wp)

    56

{

    57

	MarkAllViewportsDirty(

    58

		wp->sign.left - 6,

    59

		wp->sign.top,

    60

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

    61

		wp->sign.top + 48);

    62

}

    63

    64

/**

    65

 * Update all signs

    66

 */

    67

void UpdateAllWaypointSigns()

    68

{

    69

	Waypoint *wp;

    70

    71

	FOR_ALL_WAYPOINTS(wp) {

    72

		UpdateWaypointSign(wp);

    73

	}

    74

}

    75

    76

/**

    77

 * Set the default name for a waypoint

    78

 * @param wp Waypoint to work on

    79

 */

    80

static void MakeDefaultWaypointName(Waypoint* wp)

    81

{

    82

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

    83

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

    84

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

    85

    86

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

    87

    88

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

    89

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

    90

	 *

    91

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

    92

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

    93

	 * Usually, it needs only 'n' steps.

    94

	 *

    95

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

    96

	 * but this way it is faster */

    97

    98

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

    99

	do {

   100

		Waypoint *lwp = GetWaypoint(cid);

   101

   102

		/* check only valid waypoints... */

   103

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

   104

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

   105

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

   106

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

   107

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

   108

   109

				if (i < 32) {

   110

					SetBit(used, i); // update bitmap

   111

					if (i == 0) {

   112

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

   113

						 * increase the base of the bitmap too */

   114

						do {

   115

							used >>= 1;

   116

							next++;

   117

						} while (HasBit(used, 0));

   118

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

   119

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

   120

						 * so we can safely use it */

   121

						idx = cid;

   122

					}

   123

				}

   124

			}

   125

		}

   126

   127

		cid++;

   128

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

   129

	} while (cid != idx);

   130

   131

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

   132

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

   133

}

   134

   135

/**

   136

 * Find a deleted waypoint close to a tile.

   137

 * @param tile to search from

   138

 */

   139

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   140

{

   141

	Waypoint *wp, *best = NULL;

   142

	uint thres = 8;

   143

   144

	FOR_ALL_WAYPOINTS(wp) {

   145

		if (wp->deleted) {

   146

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

   147

   148

			if (cur_dist < thres) {

   149

				thres = cur_dist;

   150

				best = wp;

   151

			}

   152

		}

   153

	}

   154

   155

	return best;

   156

}

   157

   158

/**

   159

 * Update waypoint graphics id against saved GRFID/localidx.

   160

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

   161

 */

   162

void AfterLoadWaypoints()

   163

{

   164

	Waypoint *wp;

   165

   166

	FOR_ALL_WAYPOINTS(wp) {

   167

		uint i;

   168

   169

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

   170

   171

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

   172

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

   173

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

   174

				wp->stat_id = i;

   175

				break;

   176

			}

   177

		}

   178

	}

   179

}

   180

   181

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

   182

 * piece of rail

   183

 * @param tile tile where waypoint will be built

   184

 * @param flags type of operation

   185

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

   186

 * @param p2 unused

   187

 *

   188

 * @todo When checking for the tile slope,

   189

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

   190

 */

   191

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

   192

{

   193

	Waypoint *wp;

   194

	Slope tileh;

   195

	Axis axis;

   196

   197

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

   198

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

   199

   200

	if (!IsTileType(tile, MP_RAILWAY) ||

   201

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   202

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

   203

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

   204

			)) {

   205

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   206

	}

   207

   208

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   209

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   210

   211

	tileh = GetTileSlope(tile, NULL);

   212

	if (tileh != SLOPE_FLAT &&

   214

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   215

	}

   216

   217

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

   218

   219

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

   220

	wp = FindDeletedWaypointCloseTo(tile);

   221

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

   222

   223

	if (flags & DC_EXEC) {

   224

		if (wp == NULL) {

   225

			wp = new Waypoint(tile);

   226

			if (wp == NULL) return CMD_ERROR;

   227

   228

			wp->town_index = INVALID_TOWN;

   229

			wp->name = NULL;

   230

			wp->town_cn = 0;

   231

		} else {

   232

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

   233

   234

			/* First we update the destination for all vehicles that

   235

			* have the old waypoint in their orders. */

   236

			Vehicle *v;

   237

			FOR_ALL_VEHICLES(v) {

   238

				if (v->type == VEH_TRAIN &&

   239

						v->First() == v &&

   240

						v->current_order.IsType(OT_GOTO_WAYPOINT) &&

   241

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

   242

					v->dest_tile = tile;

   243

				}

   244

			}

   245

   246

			RedrawWaypointSign(wp);

   247

			wp->xy = tile;

   248

		}

   249

   250

		const StationSpec* statspec;

   251

   252

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

   253

		MarkTileDirtyByTile(tile);

   254

   255

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   256

   257

		if (statspec != NULL) {

   258

			wp->stat_id = p1;

   259

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

   260

			wp->localidx = statspec->localidx;

   261

		} else {

   262

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

   263

			wp->stat_id = 0;

   264

			wp->grfid = 0;

   265

			wp->localidx = 0;

   266

		}

   267

   268

		wp->deleted = 0;

   269

		wp->build_date = _date;

   270

   271

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

   272

   273

		UpdateWaypointSign(wp);

   274

		RedrawWaypointSign(wp);

   275

		YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));

   276

	}

   277

   278

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_train_depot);

   279

}

   280

   281

/**

   282

 * Daily loop for waypoints

   283

 */

   284

void WaypointsDailyLoop()

   285

{

   286

	Waypoint *wp;

   287

   288

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

   289

	FOR_ALL_WAYPOINTS(wp) {

   290

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

   291

	}

   292

}

   293

   294

/**

   295

 * Remove a waypoint

   296

 * @param tile from which to remove waypoint

   297

 * @param flags type of operation

   298

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

   299

 * @return cost of operation or error

   300

 */

   301

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

   302

{

   303

	Waypoint *wp;

   304

   305

	/* Make sure it's a waypoint */

   306

	if (!IsTileType(tile, MP_RAILWAY) ||

   307

			!IsRailWaypoint(tile) ||

   308

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

   309

			!EnsureNoVehicleOnGround(tile)) {

   310

		return CMD_ERROR;

   311

	}

   312

   313

	if (flags & DC_EXEC) {

   314

		Track track = GetRailWaypointTrack(tile);

   315

		Owner owner = GetTileOwner(tile); // cannot use _current_player because of possible floods

   316

		wp = GetWaypointByTile(tile);

   317

   318

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

   319

		RedrawWaypointSign(wp);

   320

   321

		if (justremove) {

   322

			MakeRailNormal(tile, GetTileOwner(tile), GetRailWaypointBits(tile), GetRailType(tile));

   323

			MarkTileDirtyByTile(tile);

   324

		} else {

   325

			DoClearSquare(tile);

   326

			AddTrackToSignalBuffer(tile, track, owner);

   327

		}

   328

		YapfNotifyTrackLayoutChange(tile, track);

   329

	}

   330

   331

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_train_depot);

   332

}

   333

   334

/**

   335

 * Delete a waypoint

   336

 * @param tile tile where waypoint is to be deleted

   337

 * @param flags type of operation

   338

 * @param p1 unused

   339

 * @param p2 unused

   340

 * @return cost of operation or error

   341

 */

   342

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

   343

{

   344

	return RemoveTrainWaypoint(tile, flags, true);

   345

}

   346

   347

static bool IsUniqueWaypointName(const char *name)

   348

{

   349

	const Waypoint *wp;

   350

	char buf[512];

   351

   352

	FOR_ALL_WAYPOINTS(wp) {

   353

		SetDParam(0, wp->index);

   354

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

   355

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

   356

	}

   357

   358

	return true;

   359

}

   360

   361

/**

   362

 * Rename a waypoint.

   363

 * @param tile unused

   364

 * @param flags type of operation

   365

 * @param p1 id of waypoint

   366

 * @param p2 unused

   367

 * @return cost of operation or error

   368

 */

   369

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

   370

{

   371

	Waypoint *wp;

   372

   373

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   374

   375

	wp = GetWaypoint(p1);

   376

	if (!CheckTileOwnership(wp->xy)) return CMD_ERROR;

   377

   378

	if (!StrEmpty(_cmd_text)) {

   379

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

   380

   381

		if (flags & DC_EXEC) {

   382

			free(wp->name);

   383

			wp->name = strdup(_cmd_text);

   384

			wp->town_cn = 0;

   385

   386

			UpdateWaypointSign(wp);

   387

			MarkWholeScreenDirty();

   388

		}

   389

	} else {

   390

		if (flags & DC_EXEC) {

   391

			free(wp->name);

   392

   393

			MakeDefaultWaypointName(wp);

   394

			UpdateWaypointSign(wp);

   395

			MarkWholeScreenDirty();

   396

		}

   397

	}

   398

	return CommandCost();

   399

}

   400

   401

/**

   402

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

   403

 * @param tile on which to work

   404

 * @return pointer to a Station

   405

 */

   406

Station *ComposeWaypointStation(TileIndex tile)

   407

{

   408

	Waypoint *wp = GetWaypointByTile(tile);

   409

   410

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

   411

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

   412

	static byte stat_raw[sizeof(Station)];

   413

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

   414

   415

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

   416

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

   417

	stat.build_date = wp->build_date;

   418

   419

	return &stat;

   420

}

   421

   422

/**

   423

 * Draw a waypoint

   424

 * @param x coordinate

   425

 * @param y coordinate

   426

 * @param stat_id station id

   427

 * @param railtype RailType to use for

   428

 */

   429

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

   430

{

   431

	x += 33;

   432

	y += 17;

   433

   434

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

   435

		DrawDefaultWaypointSprite(x, y, railtype);

   436

	}

   437

}

   438

   439

Waypoint::Waypoint(TileIndex tile)

   440

{

   441

	this->xy = tile;

   442

}

   443

   444

Waypoint::~Waypoint()

   445

{

   446

	free(this->name);

   447

   448

	if (CleaningPool()) return;

   449

   450

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, this->index);

   451

   452

	RedrawWaypointSign(this);

   453

	this->xy = 0;

   454

}

   455

   456

/**

   457

 * Fix savegames which stored waypoints in their old format

   458

 */

   459

void FixOldWaypoints()

   460

{

   461

	Waypoint *wp;

   462

   463

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

   464

	FOR_ALL_WAYPOINTS(wp) {

   465

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

   466

		wp->town_cn = 0;

   467

		if (wp->string & 0xC000) {

   468

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

   469

			wp->string = STR_NULL;

   470

		}

   471

	}

   472

}

   473

   474

void InitializeWaypoints()

   475

{

   476

	_Waypoint_pool.CleanPool();

   477

	_Waypoint_pool.AddBlockToPool();

   478

}

   479

   480

static const SaveLoad _waypoint_desc[] = {

   481

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

   482

	SLE_CONDVAR(Waypoint, xy,         SLE_UINT32,                  6, SL_MAX_VERSION),

   483

	SLE_CONDVAR(Waypoint, town_index, SLE_UINT16,                 12, SL_MAX_VERSION),

   484

	SLE_CONDVAR(Waypoint, town_cn,    SLE_FILE_U8 | SLE_VAR_U16,  12, 88),

   485

	SLE_CONDVAR(Waypoint, town_cn,    SLE_UINT16,                 89, SL_MAX_VERSION),

   486

	SLE_CONDVAR(Waypoint, string,     SLE_STRINGID,                0, 83),

   487

	SLE_CONDSTR(Waypoint, name,       SLE_STR, 0,                 84, SL_MAX_VERSION),

   488

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   489

   490

	SLE_CONDVAR(Waypoint, build_date, SLE_FILE_U16 | SLE_VAR_I32,  3, 30),

   491

	SLE_CONDVAR(Waypoint, build_date, SLE_INT32,                  31, SL_MAX_VERSION),

   492

	SLE_CONDVAR(Waypoint, localidx,   SLE_UINT8,                   3, SL_MAX_VERSION),

   493

	SLE_CONDVAR(Waypoint, grfid,      SLE_UINT32,                 17, SL_MAX_VERSION),