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

    12

#include "order.h"

    13

#include "rail_map.h"

    14

#include "bridge_map.h"

    15

#include "saveload.h"

    16

#include "station.h"

    17

#include "tile.h"

    18

#include "town.h"

    19

#include "waypoint.h"

    20

#include "variables.h"

    21

#include "table/strings.h"

    22

#include "vehicle.h"

    23

#include "yapf/yapf.h"

    24

#include "date.h"

    26

    27

enum {

    28

	MAX_WAYPOINTS_PER_TOWN = 64,

    29

};

    30

    31

/**

    32

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

    33

 */

    34

static void WaypointPoolNewBlock(uint start_item)

    35

{

    36

	Waypoint *wp;

    37

    38

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

    39

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

    40

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

    41

}

    42

    43

DEFINE_OLD_POOL(Waypoint, Waypoint, WaypointPoolNewBlock, NULL)

    44

    45

/**

    46

 * Create a new waypoint

    47

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

    48

static Waypoint* AllocateWaypoint()

    49

{

    50

	Waypoint *wp;

    51

    52

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

    53

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

    54

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

    55

		if (!IsValidWaypoint(wp)) {

    56

			uint index = wp->index;

    57

    58

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

    59

			wp->index = index;

    60

    61

			return wp;

    62

		}

    63

	}

    64

    65

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

    66

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

    67

    68

	return NULL;

    69

}

    70

    71

/**

    72

 * Update the sign for the waypoint

    73

 * @param wp Waypoint to update sign */

    74

static void UpdateWaypointSign(Waypoint* wp)

    75

{

    76

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

    77

	SetDParam(0, wp->index);

    78

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

    79

}

    80

    81

/**

    82

 * Redraw the sign of a waypoint

    83

 * @param wp Waypoint to redraw sign */

    84

static void RedrawWaypointSign(const Waypoint* wp)

    85

{

    86

	MarkAllViewportsDirty(

    87

		wp->sign.left - 6,

    88

		wp->sign.top,

    89

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

    90

		wp->sign.top + 48);

    91

}

    92

    93

/**

    94

 * Update all signs

    95

 */

    96

void UpdateAllWaypointSigns()

    97

{

    98

	Waypoint *wp;

    99

   100

	FOR_ALL_WAYPOINTS(wp) {

   101

		UpdateWaypointSign(wp);

   102

	}

   103

}

   104

   105

/**

   106

 * Internal handler to delete a waypoint

   107

 * @param wp Waypoint to delete

   108

 */

   109

void DestroyWaypoint(Waypoint *wp)

   110

{

   111

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, wp->index);

   112

   113

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

   114

   115

	RedrawWaypointSign(wp);

   116

}

   117

   118

/**

   119

 * Set the default name for a waypoint

   120

 * @param wp Waypoint to work on

   121

 */

   122

static void MakeDefaultWaypointName(Waypoint* wp)

   123

{

   124

	Waypoint *local_wp;

   125

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   126

	int i;

   127

   128

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

   129

   130

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

   131

   132

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

   133

	FOR_ALL_WAYPOINTS(local_wp) {

   134

		if (wp == local_wp) continue;

   135

   136

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

   137

			used_waypoint[local_wp->town_cn] = true;

   138

	}

   139

   140

	/* Find an empty spot */

   141

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

   142

   143

	wp->string = STR_NULL;

   144

	wp->town_cn = i;

   145

}

   146

   147

/**

   148

 * Find a deleted waypoint close to a tile.

   149

 * @param tile to search from

   150

 */

   151

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   152

{

   153

	Waypoint *wp, *best = NULL;

   154

	uint thres = 8;

   155

   156

	FOR_ALL_WAYPOINTS(wp) {

   157

		if (wp->deleted) {

   158

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

   159

   160

			if (cur_dist < thres) {

   161

				thres = cur_dist;

   162

				best = wp;

   163

			}

   164

		}

   165

	}

   166

   167

	return best;

   168

}

   169

   170

/**

   171

 * Update waypoint graphics id against saved GRFID/localidx.

   172

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

   173

 */

   174

void AfterLoadWaypoints()

   175

{

   176

	Waypoint *wp;

   177

   178

	FOR_ALL_WAYPOINTS(wp) {

   179

		uint i;

   180

   181

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

   182

   183

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

   184

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

   186

				wp->stat_id = i;

   187

				break;

   188

			}

   189

		}

   190

	}

   191

}

   192

   193

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

   194

 * piece of rail

   195

 * @param tile tile where waypoint will be built

   196

 * @param flags type of operation

   197

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

   198

 * @param p2 unused

   199

 *

   200

 * @todo When checking for the tile slope,

   201

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

   202

 */

   203

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

   204

{

   205

	Waypoint *wp;

   206

	Slope tileh;

   207

	Axis axis;

   208

   209

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   210

   211

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

   212

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

   213

   214

	if (!IsTileType(tile, MP_RAILWAY) ||

   215

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   216

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

   217

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

   218

			)) {

   219

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   220

	}

   221

   222

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   223

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   224

   225

	tileh = GetTileSlope(tile, NULL);

   226

	if (tileh != SLOPE_FLAT &&

   227

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

   228

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   229

	}

   230

   231

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

   232

   233

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

   234

	wp = FindDeletedWaypointCloseTo(tile);

   235

	if (wp == NULL) {

   236

		wp = AllocateWaypoint();

   237

		if (wp == NULL) return CMD_ERROR;

   238

   239

		wp->town_index = 0;

   240

		wp->string = STR_NULL;

   241

		wp->town_cn = 0;

   242

	}

   243

   244

	if (flags & DC_EXEC) {

   245

		const StationSpec* statspec;

   246

   247

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

   248

		MarkTileDirtyByTile(tile);

   249

   250

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   251

   252

		if (statspec != NULL) {

   253

			wp->stat_id = p1;

   255

			wp->localidx = statspec->localidx;

   256

		} else {

   257

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

   258

			wp->stat_id = 0;

   259

			wp->grfid = 0;

   260

			wp->localidx = 0;

   261

		}

   262

   263

		wp->deleted = 0;

   264

		wp->xy = tile;

   265

		wp->build_date = _date;

   266

   267

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

   268

   269

		UpdateWaypointSign(wp);

   270

		RedrawWaypointSign(wp);

   271

		YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));

   272

	}

   273

   274

	return _price.build_train_depot;

   275

}

   276

   277

/**

   278

 * Daily loop for waypoints

   279

 */

   280

void WaypointsDailyLoop()

   281

{

   282

	Waypoint *wp;

   283

   284

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

   285

	FOR_ALL_WAYPOINTS(wp) {

   286

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

   287

	}

   288

}

   289

   290

/**

   291

 * Remove a waypoint

   292

 * @param tile from which to remove waypoint

   293

 * @param flags type of operation

   294

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

   295

 * @return cost of operation or error

   296

 */

   297

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

   298

{

   299

	Waypoint *wp;

   300

   301

	/* Make sure it's a waypoint */

   302

	if (!IsTileType(tile, MP_RAILWAY) ||

   303

			!IsRailWaypoint(tile) ||

   304

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

   305

			!EnsureNoVehicle(tile)) {

   306

		return CMD_ERROR;

   307

	}

   308

   309

	if (flags & DC_EXEC) {

   310

		Track track = GetRailWaypointTrack(tile);

   311

		wp = GetWaypointByTile(tile);

   312

   313

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

   314

		RedrawWaypointSign(wp);

   315

   316

		if (justremove) {

   317

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

   318

			MarkTileDirtyByTile(tile);

   319

		} else {

   320

			DoClearSquare(tile);

   321

			SetSignalsOnBothDir(tile, track);

   322

		}

   323

		YapfNotifyTrackLayoutChange(tile, track);

   324

	}

   325

   326

	return _price.remove_train_depot;

   327

}

   328

   329

/**

   330

 * Delete a waypoint

   331

 * @param tile tile where waypoint is to be deleted

   332

 * @param flags type of operation

   333

 * @param p1 unused

   334

 * @param p2 unused

   335

 * @return cost of operation or error

   336

 */

   337

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

   338

{

   339

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   340

	return RemoveTrainWaypoint(tile, flags, true);

   341

}

   342

   343

/**

   344

 * Rename a waypoint.

   345

 * @param tile unused

   346

 * @param flags type of operation

   347

 * @param p1 id of waypoint

   348

 * @param p2 unused

   349

 * @return cost of operation or error

   350

 */

   351

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

   352

{

   353

	Waypoint *wp;

   354

   355

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   356

   357

	if (_cmd_text[0] != '\0') {

   358

		StringID str = AllocateNameUnique(_cmd_text, 0);

   359

   360

		if (str == 0) return CMD_ERROR;

   361

   362

		if (flags & DC_EXEC) {

   363

			wp = GetWaypoint(p1);

   364

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

   365

   366

			wp->string = str;

   367

			wp->town_cn = 0;

   368

   369

			UpdateWaypointSign(wp);

   370

			MarkWholeScreenDirty();

   371

		} else {

   372

			DeleteName(str);

   373

		}

   374

	} else {

   375

		if (flags & DC_EXEC) {

   376

			wp = GetWaypoint(p1);

   377

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

   378

   379

			MakeDefaultWaypointName(wp);

   380

			UpdateWaypointSign(wp);

   381

			MarkWholeScreenDirty();

   382

		}

   383

	}

   384

	return 0;

   385

}

   386

   387

/**

   388

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

   389

 * @param tile on which to work

   390

 * @return pointer to a Station

   391

 */

   392

Station *ComposeWaypointStation(TileIndex tile)

   393

{

   394

	Waypoint *wp = GetWaypointByTile(tile);

   395

   396

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

   397

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

   398

	static byte stat_raw[sizeof(Station)];

   399

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

   400

   401

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

   402

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

   403

	stat.string_id = wp->string;

   404

	stat.build_date = wp->build_date;

   405

   406

	return &stat;

   407

}

   408

   409

/**

   410

 * Draw a waypoint

   411

 * @param x coordinate

   412

 * @param y coordinate

   413

 * @param stat_id station id

   414

 * @param railtype RailType to use for

   415

 */

   416

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

   417

{

   418

	x += 33;

   419

	y += 17;

   420

   421

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

   422

		DrawDefaultWaypointSprite(x, y, railtype);

   423

	}

   424

}

   425

   426

/**

   427

 * Fix savegames which stored waypoints in their old format

   428

 */

   429

void FixOldWaypoints()

   430

{

   431

	Waypoint *wp;

   432

   433

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

   434

	FOR_ALL_WAYPOINTS(wp) {

   435

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

   436

		wp->town_cn = 0;

   437

		if (wp->string & 0xC000) {

   438

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

   439

			wp->string = STR_NULL;

   440

		}

   441

	}

   442

}

   443

   444

void InitializeWaypoints()

   445

{

   446

	CleanPool(&_Waypoint_pool);

   447

	AddBlockToPool(&_Waypoint_pool);

   448

}

   449

   450

static const SaveLoad _waypoint_desc[] = {

   451

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

   452

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

   453

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

   454

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

   455

	    SLE_VAR(Waypoint, string,     SLE_UINT16),

   456

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   457

   458

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

   459

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

   460

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

   461

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

   462

   463

	SLE_END()

   464

};

   465

   466

static void Save_WAYP()

   467

{

   468

	Waypoint *wp;

   469

   470

	FOR_ALL_WAYPOINTS(wp) {

   471

		SlSetArrayIndex(wp->index);

   472

		SlObject(wp, _waypoint_desc);

   473

	}

   474

}

   475

   476

static void Load_WAYP()

   477

{

   478

	int index;

   479

   480

	while ((index = SlIterateArray()) != -1) {

   481

		Waypoint *wp;

   482

   483

		if (!AddBlockIfNeeded(&_Waypoint_pool, index))

   484

			error("Waypoints: failed loading savegame: too many waypoints");

   485

   486

		wp = GetWaypoint(index);

   487

		SlObject(wp, _waypoint_desc);

   488

	}

   489

}

   490

   491

extern const ChunkHandler _waypoint_chunk_handlers[] = {

   492

	{ 'CHKP', Save_WAYP, Load_WAYP, CH_ARRAY | CH_LAST},

   493

};