1

/* $Id$ */

     2

     3

/** @file waypoint.cpp */

     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 "misc/autoptr.hpp"

    22

#include "strings_func.h"

    23

#include "gfx_func.h"

    24

#include "functions.h"

    25

#include "window_func.h"

    26

#include "economy_func.h"

    27

#include "date_func.h"

    28

#include "vehicle_func.h"

    29

#include "vehicle_base.h"

    30

#include "string_func.h"

    31

#include "signal_func.h"

    32

#include "player_func.h"

    33

#include "settings_type.h"

    34

#include "newgrf_station.h"

    35

    36

#include "table/strings.h"

    37

    38

DEFINE_OLD_POOL_GENERIC(Waypoint, Waypoint)

    39

    40

    41

/**

    42

 * Update the sign for the waypoint

    43

 * @param wp Waypoint to update sign */

    44

static void UpdateWaypointSign(Waypoint* wp)

    45

{

    46

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

    47

	SetDParam(0, wp->index);

    48

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

    49

}

    50

    51

/**

    52

 * Redraw the sign of a waypoint

    53

 * @param wp Waypoint to redraw sign */

    54

static void RedrawWaypointSign(const Waypoint* wp)

    55

{

    56

	MarkAllViewportsDirty(

    57

		wp->sign.left - 6,

    58

		wp->sign.top,

    59

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

    60

		wp->sign.top + 48);

    61

}

    62

    63

/**

    64

 * Update all signs

    65

 */

    66

void UpdateAllWaypointSigns()

    67

{

    68

	Waypoint *wp;

    69

    70

	FOR_ALL_WAYPOINTS(wp) {

    71

		UpdateWaypointSign(wp);

    72

	}

    73

}

    74

    75

/**

    76

 * Set the default name for a waypoint

    77

 * @param wp Waypoint to work on

    78

 */

    79

static void MakeDefaultWaypointName(Waypoint* wp)

    80

{

    81

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

    82

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

    83

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

    84

    85

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

    86

    87

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

    88

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

    89

	 *

    90

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

    91

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

    92

	 * Usually, it needs only 'n' steps.

    93

	 *

    94

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

    95

	 * but this way it is faster */

    96

    97

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

    98

	do {

    99

		Waypoint *lwp = GetWaypoint(cid);

   100

   101

		/* check only valid waypoints... */

   102

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

   103

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

   104

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

   105

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

   106

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

   107

   108

				if (i < 32) {

   109

					SetBit(used, i); // update bitmap

   110

					if (i == 0) {

   111

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

   112

						 * increase the base of the bitmap too */

   113

						do {

   114

							used >>= 1;

   115

							next++;

   116

						} while (HasBit(used, 0));

   117

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

   118

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

   119

						 * so we can safely use it */

   120

						idx = cid;

   121

					}

   122

				}

   123

			}

   124

		}

   125

   126

		cid++;

   127

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

   128

	} while (cid != idx);

   129

   130

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

   131

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

   132

}

   133

   134

/**

   135

 * Find a deleted waypoint close to a tile.

   136

 * @param tile to search from

   137

 */

   138

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   139

{

   140

	Waypoint *wp, *best = NULL;

   141

	uint thres = 8;

   142

   143

	FOR_ALL_WAYPOINTS(wp) {

   144

		if (wp->deleted) {

   145

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

   146

   147

			if (cur_dist < thres) {

   148

				thres = cur_dist;

   149

				best = wp;

   150

			}

   151

		}

   152

	}

   153

   154

	return best;

   155

}

   156

   157

/**

   158

 * Update waypoint graphics id against saved GRFID/localidx.

   159

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

   160

 */

   161

void AfterLoadWaypoints()

   162

{

   163

	Waypoint *wp;

   164

   165

	FOR_ALL_WAYPOINTS(wp) {

   166

		uint i;

   167

   168

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

   169

   170

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

   171

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

   172

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

   173

				wp->stat_id = i;

   174

				break;

   175

			}

   176

		}

   177

	}

   178

}

   179

   180

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

   181

 * piece of rail

   182

 * @param tile tile where waypoint will be built

   183

 * @param flags type of operation

   184

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

   185

 * @param p2 unused

   186

 *

   187

 * @todo When checking for the tile slope,

   188

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

   189

 */

   190

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

   191

{

   192

	Waypoint *wp;

   193

	AutoPtrT<Waypoint> wp_auto_delete;

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

   213

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

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

   222

		wp = new Waypoint(tile);

   223

		if (wp == NULL) return CMD_ERROR;

   224

   225

		wp_auto_delete = wp;

   226

   227

		wp->town_index = INVALID_TOWN;

   228

		wp->name = NULL;

   229

		wp->town_cn = 0;

   230

	} else if (flags & DC_EXEC) {

   231

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

   232

   233

		/* First we update the destination for all vehicles that

   234

		 * have the old waypoint in their orders. */

   235

		Vehicle *v;

   236

		FOR_ALL_VEHICLES(v) {

   237

			if (v->type == VEH_TRAIN &&

   238

					v->First() == v &&

   240

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

   241

				v->dest_tile = tile;

   242

			}

   243

		}

   244

   245

		RedrawWaypointSign(wp);

   246

		wp->xy = tile;

   247

	}

   248

   249

	if (flags & DC_EXEC) {

   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

		wp_auto_delete.Detach();

   277

	}

   278

   279

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_train_depot);

   280

}

   281

   282

/**

   283

 * Daily loop for waypoints

   284

 */

   285

void WaypointsDailyLoop()

   286

{

   287

	Waypoint *wp;

   288

   289

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

   290

	FOR_ALL_WAYPOINTS(wp) {

   291

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

   292

	}

   293

}

   294

   295

/**

   296

 * Remove a waypoint

   297

 * @param tile from which to remove waypoint

   298

 * @param flags type of operation

   299

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

   300

 * @return cost of operation or error

   301

 */

   302

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

   303

{

   304

	Waypoint *wp;

   305

   306

	/* Make sure it's a waypoint */

   307

	if (!IsTileType(tile, MP_RAILWAY) ||

   308

			!IsRailWaypoint(tile) ||

   309

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

   310

			!EnsureNoVehicleOnGround(tile)) {

   311

		return CMD_ERROR;

   312

	}

   313

   314

	if (flags & DC_EXEC) {

   315

		Track track = GetRailWaypointTrack(tile);

   316

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

   317

		wp = GetWaypointByTile(tile);

   318

   319

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

   320

		RedrawWaypointSign(wp);

   321

   322

		if (justremove) {

   323

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

   324

			MarkTileDirtyByTile(tile);

   325

		} else {

   326

			DoClearSquare(tile);

   327

			AddTrackToSignalBuffer(tile, track, owner);

   328

		}

   329

		YapfNotifyTrackLayoutChange(tile, track);

   330

	}

   331

   332

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_train_depot);

   333

}

   334

   335

/**

   336

 * Delete a waypoint

   337

 * @param tile tile where waypoint is to be deleted

   338

 * @param flags type of operation

   339

 * @param p1 unused

   340

 * @param p2 unused

   341

 * @return cost of operation or error

   342

 */

   343

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

   344

{

   345

	return RemoveTrainWaypoint(tile, flags, true);

   346

}

   347

   348

static bool IsUniqueWaypointName(const char *name)

   349

{

   350

	const Waypoint *wp;

   351

	char buf[512];

   352

   353

	FOR_ALL_WAYPOINTS(wp) {

   354

		SetDParam(0, wp->index);

   355

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

   356

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

   357

	}

   358

   359

	return true;

   360

}

   361

   362

/**

   363

 * Rename a waypoint.

   364

 * @param tile unused

   365

 * @param flags type of operation

   366

 * @param p1 id of waypoint

   367

 * @param p2 unused

   368

 * @return cost of operation or error

   369

 */

   370

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

   371

{

   372

	Waypoint *wp;

   373

   374

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   375

   376

	wp = GetWaypoint(p1);

   377

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

   378

   379

	if (!StrEmpty(_cmd_text)) {

   380

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

   381

   382

		if (flags & DC_EXEC) {

   383

			free(wp->name);

   384

			wp->name = strdup(_cmd_text);

   385

			wp->town_cn = 0;

   386

   387

			UpdateWaypointSign(wp);

   388

			MarkWholeScreenDirty();

   389

		}

   390

	} else {

   391

		if (flags & DC_EXEC) {

   392

			free(wp->name);

   393

   394

			MakeDefaultWaypointName(wp);

   395

			UpdateWaypointSign(wp);

   396

			MarkWholeScreenDirty();

   397

		}

   398

	}

   399

	return CommandCost();

   400

}

   401

   402

/**

   403

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

   404

 * @param tile on which to work

   405

 * @return pointer to a Station

   406

 */

   407

Station *ComposeWaypointStation(TileIndex tile)

   408

{

   409

	Waypoint *wp = GetWaypointByTile(tile);

   410

   411

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

   412

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

   413

	static byte stat_raw[sizeof(Station)];

   414

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

   415

   416

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

   417

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

   418

	stat.build_date = wp->build_date;

   419

   420

	return &stat;

   421

}

   422

   423

/**

   424

 * Draw a waypoint

   425

 * @param x coordinate

   426

 * @param y coordinate

   427

 * @param stat_id station id

   428

 * @param railtype RailType to use for

   429

 */

   430

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

   431

{

   432

	x += 33;

   433

	y += 17;

   434

   435

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

   436

		DrawDefaultWaypointSprite(x, y, railtype);

   437

	}

   438

}

   439

   440

Waypoint::Waypoint(TileIndex tile)

   441

{

   442

	this->xy = tile;

   443

}

   444

   445

Waypoint::~Waypoint()

   446

{

   447

	free(this->name);

   448

   449

	if (CleaningPool()) return;

   450

   451

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, this->index);

   452

   453

	RedrawWaypointSign(this);

   454

	this->xy = 0;

   455

}

   456

   457

/**

   458

 * Fix savegames which stored waypoints in their old format

   459

 */

   460

void FixOldWaypoints()

   461

{

   462

	Waypoint *wp;

   463

   464

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

   465

	FOR_ALL_WAYPOINTS(wp) {

   466

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

   467

		wp->town_cn = 0;

   468

		if (wp->string & 0xC000) {

   469

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

   470

			wp->string = STR_NULL;

   471

		}

   472

	}

   473

}

   474

   475

void InitializeWaypoints()

   476

{

   477

	_Waypoint_pool.CleanPool();

   478

	_Waypoint_pool.AddBlockToPool();

   479

}

   480

   481

static const SaveLoad _waypoint_desc[] = {

   482

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

   483

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

   484

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

   485

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

   486

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

   487

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

   488

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

   489

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   490

   491

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

   492

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

   493

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