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"

    11

#include "rail_map.h"

    12

#include "rail.h"

    13

#include "bridge_map.h"

    14

#include "saveload.h"

    15

#include "station.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

    35

#include "table/strings.h"

    36

    37

DEFINE_OLD_POOL_GENERIC(Waypoint, Waypoint)

    38

    39

    40

/**

    41

 * Update the sign for the waypoint

    42

 * @param wp Waypoint to update sign */

    43

static void UpdateWaypointSign(Waypoint* wp)

    44

{

    45

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

    46

	SetDParam(0, wp->index);

    47

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

    48

}

    49

    50

/**

    51

 * Redraw the sign of a waypoint

    52

 * @param wp Waypoint to redraw sign */

    53

static void RedrawWaypointSign(const Waypoint* wp)

    54

{

    55

	MarkAllViewportsDirty(

    56

		wp->sign.left - 6,

    57

		wp->sign.top,

    58

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

    59

		wp->sign.top + 48);

    60

}

    61

    62

/**

    63

 * Update all signs

    64

 */

    65

void UpdateAllWaypointSigns()

    66

{

    67

	Waypoint *wp;

    68

    69

	FOR_ALL_WAYPOINTS(wp) {

    70

		UpdateWaypointSign(wp);

    71

	}

    72

}

    73

    74

/**

    75

 * Set the default name for a waypoint

    76

 * @param wp Waypoint to work on

    77

 */

    78

static void MakeDefaultWaypointName(Waypoint* wp)

    79

{

    80

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

    81

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

    82

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

    83

    84

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

    85

    86

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

    87

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

    88

	 *

    89

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

    90

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

    91

	 * Usually, it needs only 'n' steps.

    92

	 *

    93

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

    94

	 * but this way it is faster */

    95

    96

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

    97

	do {

    98

		Waypoint *lwp = GetWaypoint(cid);

    99

   100

		/* check only valid waypoints... */

   101

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

   102

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

   103

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

   104

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

   105

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

   106

   107

				if (i < 32) {

   108

					SetBit(used, i); // update bitmap

   109

					if (i == 0) {

   110

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

   111

						 * increase the base of the bitmap too */

   112

						do {

   113

							used >>= 1;

   114

							next++;

   115

						} while (HasBit(used, 0));

   116

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

   117

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

   118

						 * so we can safely use it */

   119

						idx = cid;

   120

					}

   121

				}

   122

			}

   123

		}

   124

   125

		cid++;

   126

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

   127

	} while (cid != idx);

   128

   129

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

   130

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

   131

}

   132

   133

/**

   134

 * Find a deleted waypoint close to a tile.

   135

 * @param tile to search from

   136

 */

   137

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   138

{

   139

	Waypoint *wp, *best = NULL;

   140

	uint thres = 8;

   141

   142

	FOR_ALL_WAYPOINTS(wp) {

   143

		if (wp->deleted) {

   144

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

   145

   146

			if (cur_dist < thres) {

   147

				thres = cur_dist;

   148

				best = wp;

   149

			}

   150

		}

   151

	}

   152

   153

	return best;

   154

}

   155

   156

/**

   157

 * Update waypoint graphics id against saved GRFID/localidx.

   158

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

   159

 */

   160

void AfterLoadWaypoints()

   161

{

   162

	Waypoint *wp;

   163

   164

	FOR_ALL_WAYPOINTS(wp) {

   165

		uint i;

   166

   167

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

   168

   169

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

   170

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

   171

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

   172

				wp->stat_id = i;

   173

				break;

   174

			}

   175

		}

   176

	}

   177

}

   178

   179

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

   180

 * piece of rail

   181

 * @param tile tile where waypoint will be built

   182

 * @param flags type of operation

   183

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

   184

 * @param p2 unused

   185

 *

   186

 * @todo When checking for the tile slope,

   187

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

   188

 */

   189

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

   190

{

   191

	Waypoint *wp;

   192

	AutoPtrT<Waypoint> wp_auto_delete;

   193

	Slope tileh;

   194

	Axis axis;

   195

   196

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

   197

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

   198

   199

	if (!IsTileType(tile, MP_RAILWAY) ||

   200

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   201

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

   202

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

   203

			)) {

   204

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   205

	}

   206

   207

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   208

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   209

   210

	tileh = GetTileSlope(tile, NULL);

   211

	if (tileh != SLOPE_FLAT &&

   212

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

   213

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   214

	}

   215

   216

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

   217

   218

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

   219

	wp = FindDeletedWaypointCloseTo(tile);

   220

	if (wp == NULL) {

   221

		wp = new Waypoint(tile);

   222

		if (wp == NULL) return CMD_ERROR;

   223

   224

		wp_auto_delete = wp;

   225

   226

		wp->town_index = INVALID_TOWN;

   227

		wp->name = NULL;

   228

		wp->town_cn = 0;

   229

	} else if (flags & DC_EXEC) {

   230

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

   231

   232

		/* First we update the destination for all vehicles that

   233

		 * have the old waypoint in their orders. */

   234

		Vehicle *v;

   235

		FOR_ALL_VEHICLES(v) {

   236

			if (v->type == VEH_TRAIN &&

   237

					v->First() == v &&

   238

					v->current_order.type == OT_GOTO_WAYPOINT &&

   239

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

   240

				v->dest_tile = tile;

   241

			}

   242

		}

   243

   244

		RedrawWaypointSign(wp);

   245

		wp->xy = tile;

   246

	}

   247

   248

	if (flags & DC_EXEC) {

   249

		const StationSpec* statspec;

   250

   251

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

   252

		MarkTileDirtyByTile(tile);

   253

   254

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   255

   256

		if (statspec != NULL) {

   257

			wp->stat_id = p1;

   258

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

   259

			wp->localidx = statspec->localidx;

   260

		} else {

   261

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

   262

			wp->stat_id = 0;

   263

			wp->grfid = 0;

   264

			wp->localidx = 0;

   265

		}

   266

   267

		wp->deleted = 0;

   268

		wp->build_date = _date;

   269

   270

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

   271

   272

		UpdateWaypointSign(wp);

   273

		RedrawWaypointSign(wp);

   274

		YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));

   275

		wp_auto_delete.Detach();

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