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

    13

#include "station.h"

    14

#include "tile.h"

    15

#include "town.h"

    16

#include "waypoint.h"

    17

#include "variables.h"

    18

#include "table/strings.h"

    19

#include "vehicle.h"

    20

#include "yapf/yapf.h"

    21

    22

enum {

    23

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

    24

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

    25

	WAYPOINT_POOL_MAX_BLOCKS      = 8000,

    26

    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

	FOR_ALL_WAYPOINTS_FROM(wp, start_item)

    38

		wp->index = start_item++;

    39

}

    40

    41

/* Initialize the town-pool */

    42

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

    43

    44

/* Create a new waypoint */

    45

static Waypoint* AllocateWaypoint(void)

    46

{

    47

	Waypoint *wp;

    48

    49

	FOR_ALL_WAYPOINTS(wp) {

    50

		if (wp->xy == 0) {

    51

			uint index = wp->index;

    52

    53

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

    54

			wp->index = index;

    55

    56

			return wp;

    57

		}

    58

	}

    59

    60

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

    61

	if (AddBlockToPool(&_waypoint_pool))

    62

		return AllocateWaypoint();

    63

    64

	return NULL;

    65

}

    66

    67

/* Update the sign for the waypoint */

    68

static void UpdateWaypointSign(Waypoint* wp)

    69

{

    70

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

    71

	SetDParam(0, wp->index);

    72

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

    73

}

    74

    75

/* Redraw the sign of a waypoint */

    76

static void RedrawWaypointSign(const Waypoint* wp)

    77

{

    78

	MarkAllViewportsDirty(

    79

		wp->sign.left - 6,

    80

		wp->sign.top,

    81

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

    82

		wp->sign.top + 48);

    83

}

    84

    85

/* Update all signs */

    86

void UpdateAllWaypointSigns(void)

    87

{

    88

	Waypoint *wp;

    89

    90

	FOR_ALL_WAYPOINTS(wp) {

    91

		if (wp->xy)

    92

			UpdateWaypointSign(wp);

    93

	}

    94

}

    95

    96

/* Set the default name for a waypoint */

    97

static void MakeDefaultWaypointName(Waypoint* wp)

    98

{

    99

	Waypoint *local_wp;

   100

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   101

	int i;

   102

   103

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

   104

   105

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

   106

   107

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

   108

	FOR_ALL_WAYPOINTS(local_wp) {

   109

		if (wp == local_wp)

   110

			continue;

   111

   112

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

   113

			used_waypoint[local_wp->town_cn] = true;

   114

	}

   115

   116

	/* Find an empty spot */

   117

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

   118

   119

	wp->string = STR_NULL;

   120

	wp->town_cn = i;

   121

}

   122

   123

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

   124

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   125

{

   126

	Waypoint *wp, *best = NULL;

   127

	uint thres = 8, cur_dist;

   128

   129

	FOR_ALL_WAYPOINTS(wp) {

   130

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

   131

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

   132

			if (cur_dist < thres) {

   133

				thres = cur_dist;

   134

				best = wp;

   135

			}

   136

		}

   137

	}

   138

   139

	return best;

   140

}

   141

   142

/**

   143

 * Update waypoint graphics id against saved GRFID/localidx.

   144

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

   145

 */

   146

void UpdateAllWaypointCustomGraphics(void)

   147

{

   148

	Waypoint *wp;

   149

   150

	FOR_ALL_WAYPOINTS(wp) {

   151

		uint i;

   152

   153

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

   154

   155

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

   156

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

   157

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

   158

				wp->stat_id = i;

   159

				break;

   160

			}

   161

		}

   162

	}

   163

}

   164

   165

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

   166

 * piece of rail

   167

 * @param tile tile where waypoint will be built

   168

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

   169

 * @param p2 unused

   170

 *

   171

 * @todo When checking for the tile slope,

   172

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

   173

 */

   174

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

   175

{

   176

	Waypoint *wp;

   177

	Slope tileh;

   178

	Axis axis;

   179

   180

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   181

   182

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

   183

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

   184

   185

	if (!IsTileType(tile, MP_RAILWAY) ||

   186

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   187

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

   188

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

   189

			)) {

   190

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   191

	}

   192

   193

	if (!CheckTileOwnership(tile))

   194

		return CMD_ERROR;

   195

   196

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   197

   198

	tileh = GetTileSlope(tile, NULL);

   199

	if (tileh != SLOPE_FLAT) {

   200

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

   201

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   202

	}

   203

   204

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

   205

	wp = FindDeletedWaypointCloseTo(tile);

   206

	if (wp == NULL) {

   207

		wp = AllocateWaypoint();

   208

		if (wp == NULL) return CMD_ERROR;

   209

   210

		wp->town_index = 0;

   211

		wp->string = STR_NULL;

   212

		wp->town_cn = 0;

   213

	}

   214

   215

	if (flags & DC_EXEC) {

   216

		const StationSpec* statspec;

   217

   218

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

   219

		MarkTileDirtyByTile(tile);

   220

   221

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   222

   223

		if (statspec != NULL) {

   224

			wp->stat_id = p1;

   225

			wp->grfid = statspec->grfid;

   226

			wp->localidx = statspec->localidx;

   227

		} else {

   228

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

   229

			wp->stat_id = 0;

   230

			wp->grfid = 0;

   231

			wp->localidx = 0;

   232

		}

   233

   234

		wp->deleted = 0;

   235

		wp->xy = tile;

   236

		wp->build_date = _date;

   237

   238

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

   239

   240

		UpdateWaypointSign(wp);

   241

		RedrawWaypointSign(wp);

   242

	}

   243

   244

	return _price.build_train_depot;

   245

}

   246

   247

/* Internal handler to delete a waypoint */

   248

static void DoDeleteWaypoint(Waypoint *wp)

   249

{

   250

	Order order;

   251

   252

	wp->xy = 0;

   253

   254

	order.type = OT_GOTO_WAYPOINT;

   255

	order.station = wp->index;

   256

	DeleteDestinationFromVehicleOrder(order);

   257

   258

	if (wp->string != STR_NULL)

   259

		DeleteName(wp->string);

   260

   261

	RedrawWaypointSign(wp);

   262

}

   263

   264

/* Daily loop for waypoints */

   265

void WaypointsDailyLoop(void)

   266

{

   267

	Waypoint *wp;

   268

   269

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

   270

	FOR_ALL_WAYPOINTS(wp) {

   271

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

   272

			DoDeleteWaypoint(wp);

   273

		}

   274

	}

   275

}

   276

   277

/* Remove a waypoint */

   278

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

   279

{

   280

	Waypoint *wp;

   281

   282

	/* Make sure it's a waypoint */

   283

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

   284

		return CMD_ERROR;

   285

   286

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

   287

		return CMD_ERROR;

   288

   289

	if (!EnsureNoVehicle(tile))

   290

		return CMD_ERROR;

   291

   292

	if (flags & DC_EXEC) {

   293

		wp = GetWaypointByTile(tile);

   294

   295

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

   296

		RedrawWaypointSign(wp);

   297

   298

		if (justremove) {

   299

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

   300

			MarkTileDirtyByTile(tile);

   301

		} else {

   302

			DoClearSquare(tile);

   303

			SetSignalsOnBothDir(tile, GetRailWaypointTrack(tile));

   304

			YapfNotifyTrackLayoutChange(tile, GetRailWaypointTrack(tile));

   305

		}

   306

	}

   307

   308

	return _price.remove_train_depot;

   309

}

   310

   311

/** Delete a waypoint

   312

 * @param tile tile where waypoint is to be deleted

   313

 * @param p1 unused

   314

 * @param p2 unused

   315

 */

   316

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

   317

{

   318

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   319

	return RemoveTrainWaypoint(tile, flags, true);

   320

}

   321

   322

/** Rename a waypoint.

   323

 * @param tile unused

   324

 * @param p1 id of waypoint

   325

 * @param p2 unused

   326

 */

   327

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

   328

{

   329

	Waypoint *wp;

   330

	StringID str;

   331

   332

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   333

   334

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

   335

		str = AllocateNameUnique(_cmd_text, 0);

   336

		if (str == 0)

   337

			return CMD_ERROR;

   338

   339

		if (flags & DC_EXEC) {

   340

			wp = GetWaypoint(p1);

   341

			if (wp->string != STR_NULL)

   342

				DeleteName(wp->string);

   343

   344

			wp->string = str;

   345

			wp->town_cn = 0;

   346

   347

			UpdateWaypointSign(wp);

   348

			MarkWholeScreenDirty();

   349

		} else {

   350

			DeleteName(str);

   351

		}

   352

	} else {

   353

		if (flags & DC_EXEC) {

   354

			wp = GetWaypoint(p1);

   355

			if (wp->string != STR_NULL)

   356

				DeleteName(wp->string);

   357

   358

			MakeDefaultWaypointName(wp);

   359

			UpdateWaypointSign(wp);

   360

			MarkWholeScreenDirty();

   361

		}

   362

	}

   363

	return 0;

   364

}

   365

   366

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

   367

Station *ComposeWaypointStation(TileIndex tile)

   368

{

   369

	Waypoint *wp = GetWaypointByTile(tile);

   370

	static Station stat;

   371

   372

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

   373

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

   374

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

   375

	stat.build_date = wp->build_date;

   376

   377

	return &stat;

   378

}

   379

   380

/* Draw a waypoint */

   381

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

   382

{

   383

	x += 33;

   384

	y += 17;

   385

   386

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

   387

		DrawDefaultWaypointSprite(x, y, railtype);

   388

	}

   389

}

   390

   391

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

   392

void FixOldWaypoints(void)

   393

{

   394

	Waypoint *wp;

   395

   396

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

   397

	FOR_ALL_WAYPOINTS(wp) {

   398

		if (wp->xy == 0)

   399

			continue;

   400

   401

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

   402

		wp->town_cn = 0;

   403

		if (wp->string & 0xC000) {

   404

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

   405

			wp->string = STR_NULL;

   406

		}

   407

	}

   408

}

   409

   410

void InitializeWaypoints(void)

   411

{

   412

	CleanPool(&_waypoint_pool);

   413

	AddBlockToPool(&_waypoint_pool);

   414

}

   415

   416

static const SaveLoad _waypoint_desc[] = {

   417

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

   418

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

   419

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

   420

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

   421

	SLE_VAR(Waypoint, string, SLE_UINT16),

   422

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   423

   424

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

   425

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

   426

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

   427

   428

	SLE_END()

   429

};

   430

   431

static void Save_WAYP(void)

   432

{

   433

	Waypoint *wp;

   434

   435

	FOR_ALL_WAYPOINTS(wp) {

   436

		if (wp->xy != 0) {

   437

			SlSetArrayIndex(wp->index);

   438

			SlObject(wp, _waypoint_desc);

   439

		}

   440

	}

   441

}

   442

   443

static void Load_WAYP(void)

   444

{

   445

	int index;

   446

   447

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

   448

		Waypoint *wp;

   449

   450

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   451

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

   452

   453

		wp = GetWaypoint(index);

   454

		SlObject(wp, _waypoint_desc);

   455

	}

   456

}

   457

   458

const ChunkHandler _waypoint_chunk_handlers[] = {

   459

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

   460

};