1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

     6

#include "command.h"

     7

#include "functions.h"

     8

#include "gfx.h"

     9

#include "map.h"

    10

#include "order.h"

    11

#include "rail_map.h"

    12

#include "bridge_map.h"

    13

#include "saveload.h"

    14

#include "station.h"

    15

#include "tile.h"

    16

#include "town.h"

    17

#include "waypoint.h"

    18

#include "variables.h"

    19

#include "table/strings.h"

    20

#include "vehicle.h"

    21

#include "yapf/yapf.h"

    22

    23

enum {

    24

	/* Max waypoints: 64000 (8 * 8000) */

    25

	WAYPOINT_POOL_BLOCK_SIZE_BITS = 3,       /* In bits, so (1 << 3) == 8 */

    26

	WAYPOINT_POOL_MAX_BLOCKS      = 8000,

    27

    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

	FOR_ALL_WAYPOINTS_FROM(wp, start_item)

    39

		wp->index = start_item++;

    40

}

    41

    42

/* Initialize the town-pool */

    43

MemoryPool _waypoint_pool = { "Waypoints", WAYPOINT_POOL_MAX_BLOCKS, WAYPOINT_POOL_BLOCK_SIZE_BITS, sizeof(Waypoint), &WaypointPoolNewBlock, NULL, 0, 0, NULL };

    44

    45

/* Create a new waypoint */

    46

static Waypoint* AllocateWaypoint(void)

    47

{

    48

	Waypoint *wp;

    49

    50

	FOR_ALL_WAYPOINTS(wp) {

    51

		if (wp->xy == 0) {

    52

			uint index = wp->index;

    53

    54

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

    55

			wp->index = index;

    56

    57

			return wp;

    58

		}

    59

	}

    60

    61

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

    62

	if (AddBlockToPool(&_waypoint_pool))

    63

		return AllocateWaypoint();

    64

    65

	return NULL;

    66

}

    67

    68

/* Update the sign for the waypoint */

    69

static void UpdateWaypointSign(Waypoint* wp)

    70

{

    71

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

    72

	SetDParam(0, wp->index);

    73

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

    74

}

    75

    76

/* Redraw the sign of a waypoint */

    77

static void RedrawWaypointSign(const Waypoint* wp)

    78

{

    79

	MarkAllViewportsDirty(

    80

		wp->sign.left - 6,

    81

		wp->sign.top,

    82

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

    83

		wp->sign.top + 48);

    84

}

    85

    86

/* Update all signs */

    87

void UpdateAllWaypointSigns(void)

    88

{

    89

	Waypoint *wp;

    90

    91

	FOR_ALL_WAYPOINTS(wp) {

    92

		if (wp->xy)

    93

			UpdateWaypointSign(wp);

    94

	}

    95

}

    96

    97

/* Set the default name for a waypoint */

    98

static void MakeDefaultWaypointName(Waypoint* wp)

    99

{

   100

	Waypoint *local_wp;

   101

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   102

	int i;

   103

   104

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

   105

   106

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

   107

   108

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

   109

	FOR_ALL_WAYPOINTS(local_wp) {

   110

		if (wp == local_wp)

   111

			continue;

   112

   113

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

   114

			used_waypoint[local_wp->town_cn] = true;

   115

	}

   116

   117

	/* Find an empty spot */

   118

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

   119

   120

	wp->string = STR_NULL;

   121

	wp->town_cn = i;

   122

}

   123

   124

/* Find a deleted waypoint close to a tile. */

   125

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   126

{

   127

	Waypoint *wp, *best = NULL;

   128

	uint thres = 8, cur_dist;

   129

   130

	FOR_ALL_WAYPOINTS(wp) {

   131

		if (wp->deleted && wp->xy) {

   132

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

   133

			if (cur_dist < thres) {

   134

				thres = cur_dist;

   135

				best = wp;

   136

			}

   137

		}

   138

	}

   139

   140

	return best;

   141

}

   142

   143

/**

   144

 * Update waypoint graphics id against saved GRFID/localidx.

   145

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

   146

 */

   147

void UpdateAllWaypointCustomGraphics(void)

   148

{

   149

	Waypoint *wp;

   150

   151

	FOR_ALL_WAYPOINTS(wp) {

   152

		uint i;

   153

   154

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

   155

   156

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

   157

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

   158

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

   159

				wp->stat_id = i;

   160

				break;

   161

			}

   162

		}

   163

	}

   164

}

   165

   166

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

   167

 * piece of rail

   168

 * @param tile tile where waypoint will be built

   169

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

   170

 * @param p2 unused

   171

 *

   172

 * @todo When checking for the tile slope,

   173

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

   174

 */

   175

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

   176

{

   177

	Waypoint *wp;

   178

	Slope tileh;

   179

	Axis axis;

   180

   181

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   182

   183

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

   184

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

   185

   186

	if (!IsTileType(tile, MP_RAILWAY) ||

   187

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   188

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

   189

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

   190

			)) {

   191

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   192

	}

   193

   194

	if (!CheckTileOwnership(tile))

   195

		return CMD_ERROR;

   196

   197

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   198

   199

	tileh = GetTileSlope(tile, NULL);

   200

	if (tileh != SLOPE_FLAT) {

   201

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

   202

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   203

	}

   204

   205

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

   206

   207

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

   208

	wp = FindDeletedWaypointCloseTo(tile);

   209

	if (wp == NULL) {

   210

		wp = AllocateWaypoint();

   211

		if (wp == NULL) return CMD_ERROR;

   212

   213

		wp->town_index = 0;

   214

		wp->string = STR_NULL;

   215

		wp->town_cn = 0;

   216

	}

   217

   218

	if (flags & DC_EXEC) {

   219

		const StationSpec *statspec = NULL;

   220

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

   221

		MarkTileDirtyByTile(tile);

   222

   223

		if (GB(p1, 0, 8) < GetNumCustomStations(STAT_CLASS_WAYP))

   224

			statspec = GetCustomStationSpec(STAT_CLASS_WAYP, GB(p1, 0, 8));

   225

   226

		if (statspec != NULL) {

   227

			SetCustomWaypointSprite(tile);

   228

			wp->stat_id = GB(p1, 0, 8);

   229

			wp->grfid = statspec->grfid;

   230

			wp->localidx = statspec->localidx;

   231

		} else {

   232

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

   233

			ClearCustomWaypointSprite(tile);

   234

			wp->stat_id = 0;

   235

			wp->grfid = 0;

   236

			wp->localidx = 0;

   237

		}

   238

   239

		wp->deleted = 0;

   240

		wp->xy = tile;

   241

		wp->build_date = _date;

   242

   243

		if (wp->town_index == 0)

   244

			MakeDefaultWaypointName(wp);

   245

   246

		UpdateWaypointSign(wp);

   247

		RedrawWaypointSign(wp);

   248

	}

   249

   250

	return _price.build_train_depot;

   251

}

   252

   253

/* Internal handler to delete a waypoint */

   254

static void DoDeleteWaypoint(Waypoint *wp)

   255

{

   256

	Order order;

   257

   258

	wp->xy = 0;

   259

   260

	order.type = OT_GOTO_WAYPOINT;

   261

	order.station = wp->index;

   262

	DeleteDestinationFromVehicleOrder(order);

   263

   264

	if (wp->string != STR_NULL)

   265

		DeleteName(wp->string);

   266

   267

	RedrawWaypointSign(wp);

   268

}

   269

   270

/* Daily loop for waypoints */

   271

void WaypointsDailyLoop(void)

   272

{

   273

	Waypoint *wp;

   274

   275

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

   276

	FOR_ALL_WAYPOINTS(wp) {

   277

		if (wp->deleted && !--wp->deleted) {

   278

			DoDeleteWaypoint(wp);

   279

		}

   280

	}

   281

}

   282

   283

/* Remove a waypoint */

   284

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

   285

{

   286

	Waypoint *wp;

   287

   288

	/* Make sure it's a waypoint */

   289

	if (!IsTileType(tile, MP_RAILWAY) || !IsRailWaypoint(tile))

   290

		return CMD_ERROR;

   291

   292

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

   293

		return CMD_ERROR;

   294

   295

	if (!EnsureNoVehicle(tile))

   296

		return CMD_ERROR;

   297

   298

	if (flags & DC_EXEC) {

   299

		wp = GetWaypointByTile(tile);

   300

   301

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

   302

		RedrawWaypointSign(wp);

   303

   304

		if (justremove) {

   305

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

   306

			MarkTileDirtyByTile(tile);

   307

		} else {

   308

			DoClearSquare(tile);

   309

			SetSignalsOnBothDir(tile, GetRailWaypointTrack(tile));

   310

			YapfNotifyTrackLayoutChange(tile, GetRailWaypointTrack(tile));

   311

		}

   312

	}

   313

   314

	return _price.remove_train_depot;

   315

}

   316

   317

/** Delete a waypoint

   318

 * @param tile tile where waypoint is to be deleted

   319

 * @param p1 unused

   320

 * @param p2 unused

   321

 */

   322

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

   323

{

   324

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   325

	return RemoveTrainWaypoint(tile, flags, true);

   326

}

   327

   328

/** Rename a waypoint.

   329

 * @param tile unused

   330

 * @param p1 id of waypoint

   331

 * @param p2 unused

   332

 */

   333

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

   334

{

   335

	Waypoint *wp;

   336

	StringID str;

   337

   338

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   339

   340

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

   341

		str = AllocateNameUnique(_cmd_text, 0);

   342

		if (str == 0)

   343

			return CMD_ERROR;

   344

   345

		if (flags & DC_EXEC) {

   346

			wp = GetWaypoint(p1);

   347

			if (wp->string != STR_NULL)

   348

				DeleteName(wp->string);

   349

   350

			wp->string = str;

   351

			wp->town_cn = 0;

   352

   353

			UpdateWaypointSign(wp);

   354

			MarkWholeScreenDirty();

   355

		} else {

   356

			DeleteName(str);

   357

		}

   358

	} else {

   359

		if (flags & DC_EXEC) {

   360

			wp = GetWaypoint(p1);

   361

			if (wp->string != STR_NULL)

   362

				DeleteName(wp->string);

   363

   364

			MakeDefaultWaypointName(wp);

   365

			UpdateWaypointSign(wp);

   366

			MarkWholeScreenDirty();

   367

		}

   368

	}

   369

	return 0;

   370

}

   371

   372

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

   373

Station *ComposeWaypointStation(TileIndex tile)

   374

{

   375

	Waypoint *wp = GetWaypointByTile(tile);

   376

	static Station stat;

   377

   378

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

   379

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

   380

	stat.string_id = wp->string == STR_NULL ? /* FIXME? */ 0 : wp->string;

   381

	stat.build_date = wp->build_date;

   382

   383

	return &stat;

   384

}

   385

   386

/* Draw a waypoint */

   387

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

   388

{

   389

	x += 33;

   390

	y += 17;

   391

   392

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

   393

		DrawDefaultWaypointSprite(x, y, railtype);

   394

	}

   395

}

   396

   397

/* Fix savegames which stored waypoints in their old format */

   398

void FixOldWaypoints(void)

   399

{

   400

	Waypoint *wp;

   401

   402

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

   403

	FOR_ALL_WAYPOINTS(wp) {

   404

		if (wp->xy == 0)

   405

			continue;

   406

   407

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

   408

		wp->town_cn = 0;

   409

		if (wp->string & 0xC000) {

   410

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

   411

			wp->string = STR_NULL;

   412

		}

   413

	}

   414

}

   415

   416

void InitializeWaypoints(void)

   417

{

   418

	CleanPool(&_waypoint_pool);

   419

	AddBlockToPool(&_waypoint_pool);

   420

}

   421

   422

static const SaveLoad _waypoint_desc[] = {

   423

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

   424

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

   425

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

   426

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

   427

	SLE_VAR(Waypoint, string, SLE_UINT16),

   428

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   429

   430

	SLE_CONDVAR(Waypoint, build_date, SLE_UINT16,  3, SL_MAX_VERSION),

   431

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

   432

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

   433

   434

	SLE_END()

   435

};

   436

   437

static void Save_WAYP(void)

   438

{

   439

	Waypoint *wp;

   440

   441

	FOR_ALL_WAYPOINTS(wp) {

   442

		if (wp->xy != 0) {

   443

			SlSetArrayIndex(wp->index);

   444

			SlObject(wp, _waypoint_desc);

   445

		}

   446

	}

   447

}

   448

   449

static void Load_WAYP(void)

   450

{

   451

	int index;

   452

   453

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

   454

		Waypoint *wp;

   455

   456

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   457

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

   458

   459

		wp = GetWaypoint(index);

   460

		SlObject(wp, _waypoint_desc);

   461

	}

   462

}

   463

   464

const ChunkHandler _waypoint_chunk_handlers[] = {

   465

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

   466

};