1

/* $Id$ */

     2

     3

/** @file waypoint.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

     8

#include "command.h"

     9

#include "functions.h"

    10

#include "gfx.h"

    11

#include "landscape.h"

    12

#include "map.h"

    13

#include "order.h"

    14

#include "rail_map.h"

    15

#include "bridge_map.h"

    16

#include "saveload.h"

    17

#include "station.h"

    18

#include "tile.h"

    19

#include "town.h"

    20

#include "waypoint.h"

    21

#include "variables.h"

    22

#include "table/strings.h"

    23

#include "vehicle.h"

    24

#include "yapf/yapf.h"

    25

#include "date.h"

    26

#include "newgrf.h"

    27

#include "string.h"

    28

#include "strings.h"

    29

    30

enum {

    31

	MAX_WAYPOINTS_PER_TOWN = 64,

    32

};

    33

    34

/**

    35

 * Called if a new block is added to the waypoint-pool

    36

 */

    37

static void WaypointPoolNewBlock(uint start_item)

    38

{

    39

	Waypoint *wp;

    40

    41

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    42

	 * TODO - This is just a temporary stage, this will be removed. */

    43

	for (wp = GetWaypoint(start_item); wp != NULL; wp = (wp->index + 1U < GetWaypointPoolSize()) ? GetWaypoint(wp->index + 1U) : NULL) wp->index = start_item++;

    44

}

    45

    46

DEFINE_OLD_POOL(Waypoint, Waypoint, WaypointPoolNewBlock, NULL)

    47

    48

/**

    49

 * Create a new waypoint

    50

 * @return a pointer to the newly created Waypoint */

    51

static Waypoint* AllocateWaypoint()

    52

{

    53

	Waypoint *wp;

    54

    55

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    56

	 * TODO - This is just a temporary stage, this will be removed. */

    57

	for (wp = GetWaypoint(0); wp != NULL; wp = (wp->index + 1U < GetWaypointPoolSize()) ? GetWaypoint(wp->index + 1U) : NULL) {

    58

		if (!IsValidWaypoint(wp)) {

    59

			uint index = wp->index;

    60

    61

			memset(wp, 0, sizeof(*wp));

    62

			wp->index = index;

    63

    64

			return wp;

    65

		}

    66

	}

    67

    68

	/* Check if we can add a block to the pool */

    69

	if (AddBlockToPool(&_Waypoint_pool)) return AllocateWaypoint();

    70

    71

	return NULL;

    72

}

    73

    74

/**

    75

 * Update the sign for the waypoint

    76

 * @param wp Waypoint to update sign */

    77

static void UpdateWaypointSign(Waypoint* wp)

    78

{

    79

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

    80

	SetDParam(0, wp->index);

    81

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

    82

}

    83

    84

/**

    85

 * Redraw the sign of a waypoint

    86

 * @param wp Waypoint to redraw sign */

    87

static void RedrawWaypointSign(const Waypoint* wp)

    88

{

    89

	MarkAllViewportsDirty(

    90

		wp->sign.left - 6,

    91

		wp->sign.top,

    92

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

    93

		wp->sign.top + 48);

    94

}

    95

    96

/**

    97

 * Update all signs

    98

 */

    99

void UpdateAllWaypointSigns()

   100

{

   101

	Waypoint *wp;

   102

   103

	FOR_ALL_WAYPOINTS(wp) {

   104

		UpdateWaypointSign(wp);

   105

	}

   106

}

   107

   108

/**

   109

 * Internal handler to delete a waypoint

   110

 * @param wp Waypoint to delete

   111

 */

   112

void DestroyWaypoint(Waypoint *wp)

   113

{

   114

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, wp->index);

   115

   116

	if (wp->string != STR_NULL) DeleteName(wp->string);

   117

   118

	RedrawWaypointSign(wp);

   119

}

   120

   121

/**

   122

 * Set the default name for a waypoint

   123

 * @param wp Waypoint to work on

   124

 */

   125

static void MakeDefaultWaypointName(Waypoint* wp)

   126

{

   127

	Waypoint *local_wp;

   128

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   129

	int i;

   130

   131

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

   132

   133

	memset(used_waypoint, 0, sizeof(used_waypoint));

   134

   135

	/* Find an unused waypoint number belonging to this town */

   136

	FOR_ALL_WAYPOINTS(local_wp) {

   137

		if (wp == local_wp) continue;

   138

   139

		if (local_wp->xy && local_wp->string == STR_NULL && local_wp->town_index == wp->town_index)

   140

			used_waypoint[local_wp->town_cn] = true;

   141

	}

   142

   143

	/* Find an empty spot */

   144

	for (i = 0; used_waypoint[i] && i < MAX_WAYPOINTS_PER_TOWN; i++) {}

   145

   146

	wp->string = STR_NULL;

   147

	wp->town_cn = i;

   148

}

   149

   150

/**

   151

 * Find a deleted waypoint close to a tile.

   152

 * @param tile to search from

   153

 */

   154

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   155

{

   156

	Waypoint *wp, *best = NULL;

   157

	uint thres = 8;

   158

   159

	FOR_ALL_WAYPOINTS(wp) {

   160

		if (wp->deleted) {

   161

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

   162

   163

			if (cur_dist < thres) {

   164

				thres = cur_dist;

   165

				best = wp;

   166

			}

   167

		}

   168

	}

   169

   170

	return best;

   171

}

   172

   173

/**

   174

 * Update waypoint graphics id against saved GRFID/localidx.

   175

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

   176

 */

   177

void AfterLoadWaypoints()

   178

{

   179

	Waypoint *wp;

   180

   181

	FOR_ALL_WAYPOINTS(wp) {

   182

		uint i;

   183

   184

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

   185

   186

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

   187

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

   188

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

   189

				wp->stat_id = i;

   190

				break;

   191

			}

   192

		}

   193

	}

   194

}

   195

   196

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

   197

 * piece of rail

   198

 * @param tile tile where waypoint will be built

   199

 * @param flags type of operation

   200

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

   201

 * @param p2 unused

   202

 *

   203

 * @todo When checking for the tile slope,

   204

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

   205

 */

   206

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

   207

{

   208

	Waypoint *wp;

   209

	Slope tileh;

   210

	Axis axis;

   211

   212

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   213

   214

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

   215

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

   216

   217

	if (!IsTileType(tile, MP_RAILWAY) ||

   218

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   219

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

   220

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

   221

			)) {

   222

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   223

	}

   224

   225

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   226

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   227

   228

	tileh = GetTileSlope(tile, NULL);

   229

	if (tileh != SLOPE_FLAT &&

   230

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

   231

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   232

	}

   233

   234

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

   235

   236

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

   237

	wp = FindDeletedWaypointCloseTo(tile);

   238

	if (wp == NULL) {

   239

		wp = AllocateWaypoint();

   240

		if (wp == NULL) return CMD_ERROR;

   241

   242

		wp->town_index = 0;

   243

		wp->string = STR_NULL;

   244

		wp->town_cn = 0;

   245

	}

   246

   247

	if (flags & DC_EXEC) {

   248

		const StationSpec* statspec;

   249

   250

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

   251

		MarkTileDirtyByTile(tile);

   252

   253

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   254

   255

		if (statspec != NULL) {

   256

			wp->stat_id = p1;

   257

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

   258

			wp->localidx = statspec->localidx;

   259

		} else {

   260

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

   261

			wp->stat_id = 0;

   262

			wp->grfid = 0;

   263

			wp->localidx = 0;

   264

		}

   265

   266

		wp->deleted = 0;

   267

		wp->xy = tile;

   268

		wp->build_date = _date;

   269

   270

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

   271

   272

		UpdateWaypointSign(wp);

   273

		RedrawWaypointSign(wp);

   274

		YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));

   275

	}

   276

   277

	return CommandCost(_price.build_train_depot);

   278

}

   279

   280

/**

   281

 * Daily loop for waypoints

   282

 */

   283

void WaypointsDailyLoop()

   284

{

   285

	Waypoint *wp;

   286

   287

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

   288

	FOR_ALL_WAYPOINTS(wp) {

   289

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

   290

	}

   291

}

   292

   293

/**

   294

 * Remove a waypoint

   295

 * @param tile from which to remove waypoint

   296

 * @param flags type of operation

   297

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

   298

 * @return cost of operation or error

   299

 */

   300

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

   301

{

   302

	Waypoint *wp;

   303

   304

	/* Make sure it's a waypoint */

   305

	if (!IsTileType(tile, MP_RAILWAY) ||

   306

			!IsRailWaypoint(tile) ||

   307

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

   308

			!EnsureNoVehicle(tile)) {

   309

		return CMD_ERROR;

   310

	}

   311

   312

	if (flags & DC_EXEC) {

   313

		Track track = GetRailWaypointTrack(tile);

   314

		wp = GetWaypointByTile(tile);

   315

   316

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

   317

		RedrawWaypointSign(wp);

   318

   319

		if (justremove) {

   320

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

   321

			MarkTileDirtyByTile(tile);

   322

		} else {

   323

			DoClearSquare(tile);

   324

			SetSignalsOnBothDir(tile, track);

   325

		}

   326

		YapfNotifyTrackLayoutChange(tile, track);

   327

	}

   328

   329

	return CommandCost(_price.remove_train_depot);

   330

}

   331

   332

/**

   333

 * Delete a waypoint

   334

 * @param tile tile where waypoint is to be deleted

   335

 * @param flags type of operation

   336

 * @param p1 unused

   337

 * @param p2 unused

   338

 * @return cost of operation or error

   339

 */

   340

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

   341

{

   342

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   343

	return RemoveTrainWaypoint(tile, flags, true);

   344

}

   345

   346

static bool IsUniqueWaypointName(const char *name)

   347

{

   348

	const Waypoint *wp;

   349

	char buf[512];

   350

   351

	FOR_ALL_WAYPOINTS(wp) {

   352

		SetDParam(0, wp->index);

   353

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

   354

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

   355

	}

   356

   357

	return true;

   358

}

   359

   360

/**

   361

 * Rename a waypoint.

   362

 * @param tile unused

   363

 * @param flags type of operation

   364

 * @param p1 id of waypoint

   365

 * @param p2 unused

   366

 * @return cost of operation or error

   367

 */

   368

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

   369

{

   370

	Waypoint *wp;

   371

   372

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   373

   374

	wp = GetWaypoint(p1);

   375

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

   376

   377

	if (!StrEmpty(_cmd_text)) {

   378

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

   379

   380

		StringID str = AllocateName(_cmd_text, 0);

   381

   382

		if (str == 0) return CMD_ERROR;

   383

   384

		if (flags & DC_EXEC) {

   385

			if (wp->string != STR_NULL) DeleteName(wp->string);

   386

   387

			wp->string = str;

   388

			wp->town_cn = 0;

   389

   390

			UpdateWaypointSign(wp);

   391

			MarkWholeScreenDirty();

   392

		} else {

   393

			DeleteName(str);

   394

		}

   395

	} else {

   396

		if (flags & DC_EXEC) {

   397

			if (wp->string != STR_NULL) DeleteName(wp->string);

   398

   399

			MakeDefaultWaypointName(wp);

   400

			UpdateWaypointSign(wp);

   401

			MarkWholeScreenDirty();

   402

		}

   403

	}

   404

	return CommandCost();

   405

}

   406

   407

/**

   408

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

   409

 * @param tile on which to work

   410

 * @return pointer to a Station

   411

 */

   412

Station *ComposeWaypointStation(TileIndex tile)

   413

{

   414

	Waypoint *wp = GetWaypointByTile(tile);

   415

   416

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

   417

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

   418

	static byte stat_raw[sizeof(Station)];

   419

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

   420

   421

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

   422

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

   423

	stat.string_id = wp->string;

   424

	stat.build_date = wp->build_date;

   425

   426

	return &stat;

   427

}

   428

   429

/**

   430

 * Draw a waypoint

   431

 * @param x coordinate

   432

 * @param y coordinate

   433

 * @param stat_id station id

   434

 * @param railtype RailType to use for

   435

 */

   436

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

   437

{

   438

	x += 33;

   439

	y += 17;

   440

   441

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

   442

		DrawDefaultWaypointSprite(x, y, railtype);

   443

	}

   444

}

   445

   446

/**

   447

 * Fix savegames which stored waypoints in their old format

   448

 */

   449

void FixOldWaypoints()

   450

{

   451

	Waypoint *wp;

   452

   453

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

   454

	FOR_ALL_WAYPOINTS(wp) {

   455

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

   456

		wp->town_cn = 0;

   457

		if (wp->string & 0xC000) {

   458

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

   459

			wp->string = STR_NULL;

   460

		}

   461

	}

   462

}

   463

   464

void InitializeWaypoints()

   465

{

   466

	CleanPool(&_Waypoint_pool);

   467

	AddBlockToPool(&_Waypoint_pool);

   468

}

   469

   470

static const SaveLoad _waypoint_desc[] = {

   471

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

   472

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

   473

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

   474

	SLE_CONDVAR(Waypoint, town_cn,    SLE_UINT8,                  12, SL_MAX_VERSION),

   475

	    SLE_VAR(Waypoint, string,     SLE_UINT16),

   476

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   477

   478

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

   479

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

   480

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

   481

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

   482

   483

	SLE_END()

   484

};

   485

   486

static void Save_WAYP()

   487

{

   488

	Waypoint *wp;

   489

   490

	FOR_ALL_WAYPOINTS(wp) {

   491

		SlSetArrayIndex(wp->index);

   492

		SlObject(wp, _waypoint_desc);

   493

	}

   494

}

   495

   496

static void Load_WAYP()

   497

{

   498

	int index;