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

    28

enum {

    29

	MAX_WAYPOINTS_PER_TOWN = 64,

    30

};

    31

    32

/**

    33

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

    34

 */

    35

static void WaypointPoolNewBlock(uint start_item)

    36

{

    37

	Waypoint *wp;

    38

    39

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

    40

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

    41

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

    42

}

    43

    44

DEFINE_OLD_POOL(Waypoint, Waypoint, WaypointPoolNewBlock, NULL)

    45

    46

/**

    47

 * Create a new waypoint

    48

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

    49

static Waypoint* AllocateWaypoint()

    50

{

    51

	Waypoint *wp;

    52

    53

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

    54

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

    55

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

    56

		if (!IsValidWaypoint(wp)) {

    57

			uint index = wp->index;

    58

    59

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

    60

			wp->index = index;

    61

    62

			return wp;

    63

		}

    64

	}

    65

    66

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

    67

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

    68

    69

	return NULL;

    70

}

    71

    72

/**

    73

 * Update the sign for the waypoint

    74

 * @param wp Waypoint to update sign */

    75

static void UpdateWaypointSign(Waypoint* wp)

    76

{

    77

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

    78

	SetDParam(0, wp->index);

    79

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

    80

}

    81

    82

/**

    83

 * Redraw the sign of a waypoint

    84

 * @param wp Waypoint to redraw sign */

    85

static void RedrawWaypointSign(const Waypoint* wp)

    86

{

    87

	MarkAllViewportsDirty(

    88

		wp->sign.left - 6,

    89

		wp->sign.top,

    90

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

    91

		wp->sign.top + 48);

    92

}

    93

    94

/**

    95

 * Update all signs

    96

 */

    97

void UpdateAllWaypointSigns()

    98

{

    99

	Waypoint *wp;

   100

   101

	FOR_ALL_WAYPOINTS(wp) {

   102

		UpdateWaypointSign(wp);

   103

	}

   104

}

   105

   106

/**

   107

 * Internal handler to delete a waypoint

   108

 * @param wp Waypoint to delete

   109

 */

   110

void DestroyWaypoint(Waypoint *wp)

   111

{

   112

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, wp->index);

   113

   114

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

   115

   116

	RedrawWaypointSign(wp);

   117

}

   118

   119

/**

   120

 * Set the default name for a waypoint

   121

 * @param wp Waypoint to work on

   122

 */

   123

static void MakeDefaultWaypointName(Waypoint* wp)

   124

{

   125

	Waypoint *local_wp;

   126

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   127

	int i;

   128

   129

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

   130

   131

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

   132

   133

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

   134

	FOR_ALL_WAYPOINTS(local_wp) {

   135

		if (wp == local_wp) continue;

   136

   137

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

   138

			used_waypoint[local_wp->town_cn] = true;

   139

	}

   140

   141

	/* Find an empty spot */

   142

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

   143

   144

	wp->string = STR_NULL;

   145

	wp->town_cn = i;

   146

}

   147

   148

/**

   149

 * Find a deleted waypoint close to a tile.

   150

 * @param tile to search from

   151

 */

   152

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   153

{

   154

	Waypoint *wp, *best = NULL;

   155

	uint thres = 8;

   156

   157

	FOR_ALL_WAYPOINTS(wp) {

   158

		if (wp->deleted) {

   159

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

   160

   161

			if (cur_dist < thres) {

   162

				thres = cur_dist;

   163

				best = wp;

   164

			}

   165

		}

   166

	}

   167

   168

	return best;

   169

}

   170

   171

/**

   172

 * Update waypoint graphics id against saved GRFID/localidx.

   173

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

   174

 */

   175

void AfterLoadWaypoints()

   176

{

   177

	Waypoint *wp;

   178

   179

	FOR_ALL_WAYPOINTS(wp) {

   180

		uint i;

   181

   182

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

   183

   184

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

   185

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

   186

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

   187

				wp->stat_id = i;

   188

				break;

   189

			}

   190

		}

   191

	}

   192

}

   193

   194

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

   195

 * piece of rail

   196

 * @param tile tile where waypoint will be built

   197

 * @param flags type of operation

   198

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

   199

 * @param p2 unused

   200

 *

   201

 * @todo When checking for the tile slope,

   202

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

   203

 */

   205

{

   206

	Waypoint *wp;

   207

	Slope tileh;

   208

	Axis axis;

   209

   210

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   211

   212

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

   213

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

   214

   215

	if (!IsTileType(tile, MP_RAILWAY) ||

   216

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   217

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

   218

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

   219

			)) {

   220

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   221

	}

   222

   223

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   224

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   225

   226

	tileh = GetTileSlope(tile, NULL);

   227

	if (tileh != SLOPE_FLAT &&

   228

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

   229

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   230

	}

   231

   232

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

   233

   234

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

   235

	wp = FindDeletedWaypointCloseTo(tile);

   236

	if (wp == NULL) {

   237

		wp = AllocateWaypoint();

   238

		if (wp == NULL) return CMD_ERROR;

   239

   240

		wp->town_index = 0;

   241

		wp->string = STR_NULL;

   242

		wp->town_cn = 0;

   243

	}

   244

   245

	if (flags & DC_EXEC) {

   246

		const StationSpec* statspec;

   247

   248

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

   249

		MarkTileDirtyByTile(tile);

   250

   251

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   252

   253

		if (statspec != NULL) {

   254

			wp->stat_id = p1;

   255

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

   256

			wp->localidx = statspec->localidx;

   257

		} else {

   258

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

   259

			wp->stat_id = 0;

   260

			wp->grfid = 0;

   261

			wp->localidx = 0;

   262

		}

   263

   264

		wp->deleted = 0;

   265

		wp->xy = tile;

   266

		wp->build_date = _date;

   267

   268

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

   269

   270

		UpdateWaypointSign(wp);

   271

		RedrawWaypointSign(wp);

   272

		YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));

   273

	}

   274

   275

	return _eco->GetPrice(CEconomy::BUILD_TRAIN_DEPOT);

   276

}

   277

   278

/**

   279

 * Daily loop for waypoints

   280

 */

   281

void WaypointsDailyLoop()

   282

{

   283

	Waypoint *wp;

   284

   285

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

   286

	FOR_ALL_WAYPOINTS(wp) {

   287

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

   288

	}

   289

}

   290

   291

/**

   292

 * Remove a waypoint

   293

 * @param tile from which to remove waypoint

   294

 * @param flags type of operation

   295

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

   296

 * @return cost of operation or error

   297

 */

   299

{

   300

	Waypoint *wp;

   301

   302

	/* Make sure it's a waypoint */

   303

	if (!IsTileType(tile, MP_RAILWAY) ||

   304

			!IsRailWaypoint(tile) ||

   305

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

   306

			!EnsureNoVehicle(tile)) {

   307

		return CMD_ERROR;

   308

	}

   309

   310

	if (flags & DC_EXEC) {

   311

		Track track = GetRailWaypointTrack(tile);

   312

		wp = GetWaypointByTile(tile);

   313

   314

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

   315

		RedrawWaypointSign(wp);

   316

   317

		if (justremove) {

   318

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

   319

			MarkTileDirtyByTile(tile);

   320

		} else {

   321

			DoClearSquare(tile);

   322

			SetSignalsOnBothDir(tile, track);

   323

		}

   324

		YapfNotifyTrackLayoutChange(tile, track);

   325

	}

   326

   327

	return _eco->GetPrice(CEconomy::REMOVE_TRAIN_DEPOT);

   328

}

   329

   330

/**

   331

 * Delete a waypoint

   332

 * @param tile tile where waypoint is to be deleted

   333

 * @param flags type of operation

   334

 * @param p1 unused

   335

 * @param p2 unused

   336

 * @return cost of operation or error

   337

 */

   339

{

   340

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   341

	return RemoveTrainWaypoint(tile, flags, true);

   342

}

   343

   344

/**

   345

 * Rename a waypoint.

   346

 * @param tile unused

   347

 * @param flags type of operation

   348

 * @param p1 id of waypoint

   349

 * @param p2 unused

   350

 * @return cost of operation or error

   351

 */

   353

{

   354

	Waypoint *wp;

   355

   356

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   357

   358

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

   359

		StringID str = AllocateNameUnique(_cmd_text, 0);

   360

   361

		if (str == 0) return CMD_ERROR;

   362

   363

		if (flags & DC_EXEC) {

   364

			wp = GetWaypoint(p1);

   365

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

   366

   367

			wp->string = str;

   368

			wp->town_cn = 0;

   369

   370

			UpdateWaypointSign(wp);

   371

			MarkWholeScreenDirty();

   372

		} else {

   373

			DeleteName(str);

   374

		}

   375

	} else {

   376

		if (flags & DC_EXEC) {

   377

			wp = GetWaypoint(p1);

   378

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

   379

   380

			MakeDefaultWaypointName(wp);

   381

			UpdateWaypointSign(wp);

   382

			MarkWholeScreenDirty();

   383

		}

   384

	}

   385

	return 0;

   386

}

   387

   388

/**

   389

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

   390

 * @param tile on which to work

   391

 * @return pointer to a Station

   392

 */

   393

Station *ComposeWaypointStation(TileIndex tile)

   394

{

   395

	Waypoint *wp = GetWaypointByTile(tile);

   396

   397

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

   398

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

   399

	static byte stat_raw[sizeof(Station)];

   400

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

   401

   402

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

   403

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

   404

	stat.string_id = wp->string;

   405

	stat.build_date = wp->build_date;

   406

   407

	return &stat;

   408

}

   409

   410

/**

   411

 * Draw a waypoint

   412

 * @param x coordinate

   413

 * @param y coordinate

   414

 * @param stat_id station id

   415

 * @param railtype RailType to use for

   416

 */

   417

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

   418

{

   419

	x += 33;

   420

	y += 17;

   421

   422

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

   423

		DrawDefaultWaypointSprite(x, y, railtype);

   424

	}

   425

}

   426

   427

/**

   428

 * Fix savegames which stored waypoints in their old format

   429

 */

   430

void FixOldWaypoints()

   431

{

   432

	Waypoint *wp;

   433

   434

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

   435

	FOR_ALL_WAYPOINTS(wp) {

   436

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

   437

		wp->town_cn = 0;

   438

		if (wp->string & 0xC000) {

   439

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

   440

			wp->string = STR_NULL;

   441

		}

   442

	}

   443

}

   444

   445

void InitializeWaypoints()

   446

{

   447

	CleanPool(&_Waypoint_pool);

   448

	AddBlockToPool(&_Waypoint_pool);

   449

}

   450

   451

static const SaveLoad _waypoint_desc[] = {

   452

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

   453

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

   454

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

   455

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

   456

	    SLE_VAR(Waypoint, string,     SLE_UINT16),

   457

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   458

   459

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

   460

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

   461

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

   462

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

   463

   464

	SLE_END()

   465

};

   466

   467

static void Save_WAYP()

   468

{

   469

	Waypoint *wp;

   470

   471

	FOR_ALL_WAYPOINTS(wp) {

   472

		SlSetArrayIndex(wp->index);

   473

		SlObject(wp, _waypoint_desc);

   474

	}

   475

}

   476

   477

static void Load_WAYP()

   478

{

   479

	int index;

   480

   481

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

   482

		Waypoint *wp;

   483

   484

		if (!AddBlockIfNeeded(&_Waypoint_pool, index))

   485

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

   486

   487

		wp = GetWaypoint(index);

   488

		SlObject(wp, _waypoint_desc);

   489

	}

   490

}

   491

   492

extern const ChunkHandler _waypoint_chunk_handlers[] = {

   493

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

   494

};