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"

    25

    26

enum {

    27

	MAX_WAYPOINTS_PER_TOWN = 64,

    28

};

    29

    30

/**

    31

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

    32

 */

    33

static void WaypointPoolNewBlock(uint start_item)

    34

{

    35

	Waypoint *wp;

    36

    37

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

    38

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

    39

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

    40

}

    41

    42

DEFINE_OLD_POOL(Waypoint, Waypoint, WaypointPoolNewBlock, NULL)

    43

    44

/**

    45

 * Create a new waypoint

    46

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

    47

static Waypoint* AllocateWaypoint()

    48

{

    49

	Waypoint *wp;

    50

    51

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

    52

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

    53

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

    54

		if (!IsValidWaypoint(wp)) {

    55

			uint index = wp->index;

    56

    57

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

    58

			wp->index = index;

    59

    60

			return wp;

    61

		}

    62

	}

    63

    64

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

    65

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

    66

    67

	return NULL;

    68

}

    69

    70

/**

    71

 * Update the sign for the waypoint

    72

 * @param wp Waypoint to update sign */

    73

static void UpdateWaypointSign(Waypoint* wp)

    74

{

    75

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

    76

	SetDParam(0, wp->index);

    77

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

    78

}

    79

    80

/**

    81

 * Redraw the sign of a waypoint

    82

 * @param wp Waypoint to redraw sign */

    83

static void RedrawWaypointSign(const Waypoint* wp)

    84

{

    85

	MarkAllViewportsDirty(

    86

		wp->sign.left - 6,

    87

		wp->sign.top,

    88

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

    89

		wp->sign.top + 48);

    90

}

    91

    92

/**

    93

 * Update all signs

    94

 */

    95

void UpdateAllWaypointSigns()

    96

{

    97

	Waypoint *wp;

    98

    99

	FOR_ALL_WAYPOINTS(wp) {

   100

		UpdateWaypointSign(wp);

   101

	}

   102

}

   103

   104

/**

   105

 * Internal handler to delete a waypoint

   106

 * @param wp Waypoint to delete

   107

 */

   108

void DestroyWaypoint(Waypoint *wp)

   109

{

   110

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, wp->index);

   111

   112

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

   113

   114

	RedrawWaypointSign(wp);

   115

}

   116

   117

/**

   118

 * Set the default name for a waypoint

   119

 * @param wp Waypoint to work on

   120

 */

   121

static void MakeDefaultWaypointName(Waypoint* wp)

   122

{

   123

	Waypoint *local_wp;

   124

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   125

	int i;

   126

   127

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

   128

   129

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

   130

   131

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

   132

	FOR_ALL_WAYPOINTS(local_wp) {

   133

		if (wp == local_wp) continue;

   134

   135

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

   136

			used_waypoint[local_wp->town_cn] = true;

   137

	}

   138

   139

	/* Find an empty spot */

   140

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

   141

   142

	wp->string = STR_NULL;

   143

	wp->town_cn = i;

   144

}

   145

   146

/**

   147

 * Find a deleted waypoint close to a tile.

   148

 * @param tile to search from

   149

 */

   150

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   151

{

   152

	Waypoint *wp, *best = NULL;

   153

	uint thres = 8;

   154

   155

	FOR_ALL_WAYPOINTS(wp) {

   156

		if (wp->deleted) {

   157

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

   158

   159

			if (cur_dist < thres) {

   160

				thres = cur_dist;

   161

				best = wp;

   162

			}

   163

		}

   164

	}

   165

   166

	return best;

   167

}

   168

   169

/**

   170

 * Update waypoint graphics id against saved GRFID/localidx.

   171

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

   172

 */

   173

void AfterLoadWaypoints()

   174

{

   175

	Waypoint *wp;

   176

   177

	FOR_ALL_WAYPOINTS(wp) {

   178

		uint i;

   179

   180

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

   181

   182

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

   183

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

   184

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

   185

				wp->stat_id = i;

   186

				break;

   187

			}

   188

		}

   189

	}

   190

}

   191

   192

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

   193

 * piece of rail

   194

 * @param tile tile where waypoint will be built

   195

 * @param flags type of operation

   196

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

   197

 * @param p2 unused

   198

 *

   199

 * @todo When checking for the tile slope,

   200

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

   201

 */

   202

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

   203

{

   204

	Waypoint *wp;

   205

	Slope tileh;

   206

	Axis axis;

   207

   208

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   209

   210

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

   211

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

   212

   213

	if (!IsTileType(tile, MP_RAILWAY) ||

   214

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   215

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

   216

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

   217

			)) {

   218

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   219

	}

   220

   221

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   222

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   223

   224

	tileh = GetTileSlope(tile, NULL);

   225

	if (tileh != SLOPE_FLAT &&

   226

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

   227

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   228

	}

   229

   230

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

   231

   232

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

   233

	wp = FindDeletedWaypointCloseTo(tile);

   234

	if (wp == NULL) {

   235

		wp = AllocateWaypoint();

   236

		if (wp == NULL) return CMD_ERROR;

   237

   238

		wp->town_index = 0;

   239

		wp->string = STR_NULL;

   240

		wp->town_cn = 0;

   241

	}

   242

   243

	if (flags & DC_EXEC) {

   244

		const StationSpec* statspec;

   245

   246

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

   247

		MarkTileDirtyByTile(tile);

   248

   249

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   250

   251

		if (statspec != NULL) {

   252

			wp->stat_id = p1;

   253

			wp->grfid = statspec->grfid;

   254

			wp->localidx = statspec->localidx;

   255

		} else {

   256

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

   257

			wp->stat_id = 0;

   258

			wp->grfid = 0;

   259

			wp->localidx = 0;

   260

		}

   261

   262

		wp->deleted = 0;

   263

		wp->xy = tile;

   264

		wp->build_date = _date;

   265

   266

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

   267

   268

		UpdateWaypointSign(wp);

   269

		RedrawWaypointSign(wp);

   270

		YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));

   271

	}

   272

   273

	return _price.build_train_depot;

   274

}

   275

   276

/**

   277

 * Daily loop for waypoints

   278

 */

   279

void WaypointsDailyLoop()

   280

{

   281

	Waypoint *wp;

   282

   283

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

   284

	FOR_ALL_WAYPOINTS(wp) {

   285

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

   286

	}

   287

}

   288

   289

/**

   290

 * Remove a waypoint

   291

 * @param tile from which to remove waypoint

   292

 * @param flags type of operation

   293

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

   294

 * @return cost of operation or error

   295

 */

   296

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

   297

{

   298

	Waypoint *wp;

   299

   300

	/* Make sure it's a waypoint */

   301

	if (!IsTileType(tile, MP_RAILWAY) ||

   302

			!IsRailWaypoint(tile) ||

   303

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

   304

			!EnsureNoVehicle(tile)) {

   305

		return CMD_ERROR;

   306

	}

   307

   308

	if (flags & DC_EXEC) {

   309

		Track track = GetRailWaypointTrack(tile);

   310

		wp = GetWaypointByTile(tile);

   311

   312

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

   313

		RedrawWaypointSign(wp);

   314

   315

		if (justremove) {

   316

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

   317

			MarkTileDirtyByTile(tile);

   318

		} else {

   319

			DoClearSquare(tile);

   320

			SetSignalsOnBothDir(tile, track);

   321

		}

   322

		YapfNotifyTrackLayoutChange(tile, track);

   323

	}

   324

   325

	return _price.remove_train_depot;

   326

}

   327

   328

/**

   329

 * Delete a waypoint

   330

 * @param tile tile where waypoint is to be deleted

   331

 * @param flags type of operation

   332

 * @param p1 unused

   333

 * @param p2 unused

   334

 * @return cost of operation or error

   335

 */

   336

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

   337

{

   338

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   339

	return RemoveTrainWaypoint(tile, flags, true);

   340

}

   341

   342

/**

   343

 * Rename a waypoint.

   344

 * @param tile unused

   345

 * @param flags type of operation

   346

 * @param p1 id of waypoint

   347

 * @param p2 unused

   348

 * @return cost of operation or error

   349

 */

   350

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

   351

{

   352

	Waypoint *wp;

   353

   354

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   355

   356

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

   357

		StringID str = AllocateNameUnique(_cmd_text, 0);

   358

   359

		if (str == 0) return CMD_ERROR;

   360

   361

		if (flags & DC_EXEC) {

   362

			wp = GetWaypoint(p1);

   363

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

   364

   365

			wp->string = str;

   366

			wp->town_cn = 0;

   367

   368

			UpdateWaypointSign(wp);

   369

			MarkWholeScreenDirty();

   370

		} else {

   371

			DeleteName(str);

   372

		}

   373

	} else {

   374

		if (flags & DC_EXEC) {

   375

			wp = GetWaypoint(p1);

   376

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

   377

   378

			MakeDefaultWaypointName(wp);

   379

			UpdateWaypointSign(wp);

   380

			MarkWholeScreenDirty();

   381

		}

   382

	}

   383

	return 0;

   384

}

   385

   386

/**

   387

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

   388

 * @param tile on which to work

   389

 * @return pointer to a Station

   390

 */

   391

Station *ComposeWaypointStation(TileIndex tile)

   392

{

   393

	Waypoint *wp = GetWaypointByTile(tile);

   394

   395

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

   396

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

   397

	static byte stat_raw[sizeof(Station)];

   398

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

   399

   400

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

   401

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

   402

	stat.string_id = wp->string;

   403

	stat.build_date = wp->build_date;

   404

   405

	return &stat;

   406

}

   407

   408

/**

   409

 * Draw a waypoint

   410

 * @param x coordinate

   411

 * @param y coordinate

   412

 * @param stat_id station id

   413

 * @param railtype RailType to use for

   414

 */

   415

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

   416

{

   417

	x += 33;

   418

	y += 17;

   419

   420

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

   421

		DrawDefaultWaypointSprite(x, y, railtype);

   422

	}

   423

}

   424

   425

/**

   426

 * Fix savegames which stored waypoints in their old format

   427

 */

   428

void FixOldWaypoints()

   429

{

   430

	Waypoint *wp;

   431

   432

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

   433

	FOR_ALL_WAYPOINTS(wp) {

   434

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

   435

		wp->town_cn = 0;

   436

		if (wp->string & 0xC000) {

   437

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

   438

			wp->string = STR_NULL;

   439

		}

   440

	}

   441

}

   442

   443

void InitializeWaypoints()

   444

{

   445

	CleanPool(&_Waypoint_pool);

   446

	AddBlockToPool(&_Waypoint_pool);

   447

}

   448

   449

static const SaveLoad _waypoint_desc[] = {

   450

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

   451

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

   452

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

   453

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

   454

	    SLE_VAR(Waypoint, string,     SLE_UINT16),

   455

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   456

   457

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

   458

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

   459

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

   460

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

   461

   462

	SLE_END()

   463

};

   464

   465

static void Save_WAYP()

   466

{

   467

	Waypoint *wp;

   468

   469

	FOR_ALL_WAYPOINTS(wp) {

   470

		SlSetArrayIndex(wp->index);

   471

		SlObject(wp, _waypoint_desc);

   472

	}

   473

}

   474

   475

static void Load_WAYP()

   476

{

   477

	int index;

   478

   479

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

   480

		Waypoint *wp;

   481

   482

		if (!AddBlockIfNeeded(&_Waypoint_pool, index))

   483

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

   484

   485

		wp = GetWaypoint(index);

   486

		SlObject(wp, _waypoint_desc);

   487

	}

   488

}

   489

   490

extern const ChunkHandler _waypoint_chunk_handlers[] = {

   491

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

   492

};