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

#include "date.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

	/* 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 + 1 < GetWaypointPoolSize()) ? GetWaypoint(wp->index + 1) : NULL) wp->index = start_item++;

    41

}

    42

    43

/* Initialize the town-pool */

    44

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

    45

    46

/* Create a new waypoint */

    47

static Waypoint* AllocateWaypoint(void)

    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 + 1 < GetWaypointPoolSize()) ? GetWaypoint(wp->index + 1) : 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

/* Update the sign for the waypoint */

    71

static void UpdateWaypointSign(Waypoint* wp)

    72

{

    73

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

    74

	SetDParam(0, wp->index);

    75

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

    76

}

    77

    78

/* Redraw the sign of a waypoint */

    79

static void RedrawWaypointSign(const Waypoint* wp)

    80

{

    81

	MarkAllViewportsDirty(

    82

		wp->sign.left - 6,

    83

		wp->sign.top,

    84

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

    85

		wp->sign.top + 48);

    86

}

    87

    88

/* Update all signs */

    89

void UpdateAllWaypointSigns(void)

    90

{

    91

	Waypoint *wp;

    92

    93

	FOR_ALL_WAYPOINTS(wp) {

    94

		UpdateWaypointSign(wp);

    95

	}

    96

}

    97

    98

/* Internal handler to delete a waypoint */

    99

void DestroyWaypoint(Waypoint *wp)

   100

{

   101

	DestinationID dest;

   102

   103

	dest.waypoint = wp->index;

   104

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, dest);

   105

   106

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

   107

   108

	RedrawWaypointSign(wp);

   109

}

   110

   111

/* Set the default name for a waypoint */

   112

static void MakeDefaultWaypointName(Waypoint* wp)

   113

{

   114

	Waypoint *local_wp;

   115

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   116

	int i;

   117

   118

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

   119

   120

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

   121

   122

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

   123

	FOR_ALL_WAYPOINTS(local_wp) {

   124

		if (wp == local_wp) continue;

   125

   126

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

   127

			used_waypoint[local_wp->town_cn] = true;

   128

	}

   129

   130

	/* Find an empty spot */

   131

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

   132

   133

	wp->string = STR_NULL;

   134

	wp->town_cn = i;

   135

}

   136

   137

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

   138

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   139

{

   140

	Waypoint *wp, *best = NULL;

   141

	uint thres = 8;

   142

   143

	FOR_ALL_WAYPOINTS(wp) {

   144

		if (wp->deleted) {

   145

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

   146

   147

			if (cur_dist < thres) {

   148

				thres = cur_dist;

   149

				best = wp;

   150

			}

   151

		}

   152

	}

   153

   154

	return best;

   155

}

   156

   157

/**

   158

 * Update waypoint graphics id against saved GRFID/localidx.

   159

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

   160

 */

   161

void UpdateAllWaypointCustomGraphics(void)

   162

{

   163

	Waypoint *wp;

   164

   165

	FOR_ALL_WAYPOINTS(wp) {

   166

		uint i;

   167

   168

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

   169

   170

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

   171

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

   172

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

   173

				wp->stat_id = i;

   174

				break;

   175

			}

   176

		}

   177

	}

   178

}

   179

   180

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

   181

 * piece of rail

   182

 * @param tile tile where waypoint will be built

   183

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

   184

 * @param p2 unused

   185

 *

   186

 * @todo When checking for the tile slope,

   187

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

   188

 */

   189

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

   190

{

   191

	Waypoint *wp;

   192

	Slope tileh;

   193

	Axis axis;

   194

   195

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   196

   197

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

   198

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

   199

   200

	if (!IsTileType(tile, MP_RAILWAY) ||

   201

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   202

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

   203

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

   204

			)) {

   205

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   206

	}

   207

   208

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   209

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   210

   211

	tileh = GetTileSlope(tile, NULL);

   212

	if (tileh != SLOPE_FLAT &&

   213

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

   214

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   215

	}

   216

   217

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

   218

	wp = FindDeletedWaypointCloseTo(tile);

   219

	if (wp == NULL) {

   220

		wp = AllocateWaypoint();

   221

		if (wp == NULL) return CMD_ERROR;

   222

   223

		wp->town_index = 0;

   224

		wp->string = STR_NULL;

   225

		wp->town_cn = 0;

   226

	}

   227

   228

	if (flags & DC_EXEC) {

   229

		const StationSpec* statspec;

   230

   231

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

   232

		MarkTileDirtyByTile(tile);

   233

   234

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   235

   236

		if (statspec != NULL) {

   237

			wp->stat_id = p1;

   238

			wp->grfid = statspec->grfid;

   239

			wp->localidx = statspec->localidx;

   240

		} else {

   241

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

   242

			wp->stat_id = 0;

   243

			wp->grfid = 0;

   244

			wp->localidx = 0;

   245

		}

   246

   247

		wp->deleted = 0;

   248

		wp->xy = tile;

   249

		wp->build_date = _date;

   250

   251

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

   252

   253

		UpdateWaypointSign(wp);

   254

		RedrawWaypointSign(wp);

   255

	}

   256

   257

	return _price.build_train_depot;

   258

}

   259

   260

/* Daily loop for waypoints */

   261

void WaypointsDailyLoop(void)

   262

{

   263

	Waypoint *wp;

   264

   265

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

   266

	FOR_ALL_WAYPOINTS(wp) {

   267

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

   268

	}

   269

}

   270

   271

/* Remove a waypoint */

   272

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

   273

{

   274

	Waypoint *wp;

   275

   276

	/* Make sure it's a waypoint */

   277

	if (!IsTileType(tile, MP_RAILWAY) ||

   278

			!IsRailWaypoint(tile) ||

   279

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

   280

			!EnsureNoVehicle(tile)) {

   281

		return CMD_ERROR;

   282

	}

   283

   284

	if (flags & DC_EXEC) {

   285

		wp = GetWaypointByTile(tile);

   286

   287

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

   288

		RedrawWaypointSign(wp);

   289

   290

		if (justremove) {

   291

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

   292

			MarkTileDirtyByTile(tile);

   293

		} else {

   294

			DoClearSquare(tile);

   295

			SetSignalsOnBothDir(tile, GetRailWaypointTrack(tile));

   296

			YapfNotifyTrackLayoutChange(tile, GetRailWaypointTrack(tile));

   297

		}

   298

	}

   299

   300

	return _price.remove_train_depot;

   301

}

   302

   303

/** Delete a waypoint

   304

 * @param tile tile where waypoint is to be deleted

   305

 * @param p1 unused

   306

 * @param p2 unused

   307

 */

   308

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

   309

{

   310

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   311

	return RemoveTrainWaypoint(tile, flags, true);

   312

}

   313

   314

/** Rename a waypoint.

   315

 * @param tile unused

   316

 * @param p1 id of waypoint

   317

 * @param p2 unused

   318

 */

   319

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

   320

{

   321

	Waypoint *wp;

   322

   323

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   324

   325

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

   326

		StringID str = AllocateNameUnique(_cmd_text, 0);

   327

   328

		if (str == 0) return CMD_ERROR;

   329

   330

		if (flags & DC_EXEC) {

   331

			wp = GetWaypoint(p1);

   332

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

   333

   334

			wp->string = str;

   335

			wp->town_cn = 0;

   336

   337

			UpdateWaypointSign(wp);

   338

			MarkWholeScreenDirty();

   339

		} else {

   340

			DeleteName(str);

   341

		}

   342

	} else {

   343

		if (flags & DC_EXEC) {

   344

			wp = GetWaypoint(p1);

   345

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

   346

   347

			MakeDefaultWaypointName(wp);

   348

			UpdateWaypointSign(wp);

   349

			MarkWholeScreenDirty();

   350

		}

   351

	}

   352

	return 0;

   353

}

   354

   355

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

   356

Station *ComposeWaypointStation(TileIndex tile)

   357

{

   358

	Waypoint *wp = GetWaypointByTile(tile);

   359

	static Station stat;

   360

   361

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

   362

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

   363

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

   364

	stat.build_date = wp->build_date;

   365

   366

	return &stat;

   367

}

   368

   369

/* Draw a waypoint */

   370

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

   371

{

   372

	x += 33;

   373

	y += 17;

   374

   375

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

   376

		DrawDefaultWaypointSprite(x, y, railtype);

   377

	}

   378

}

   379

   380

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

   381

void FixOldWaypoints(void)

   382

{

   383

	Waypoint *wp;

   384

   385

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

   386

	FOR_ALL_WAYPOINTS(wp) {

   387

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

   388

		wp->town_cn = 0;

   389

		if (wp->string & 0xC000) {

   390

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

   391

			wp->string = STR_NULL;

   392

		}

   393

	}

   394

}

   395

   396

void InitializeWaypoints(void)

   397

{

   398

	CleanPool(&_waypoint_pool);

   399

	AddBlockToPool(&_waypoint_pool);

   400

}

   401

   402

static const SaveLoad _waypoint_desc[] = {

   403

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

   404

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

   405

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

   406

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

   407

	    SLE_VAR(Waypoint, string,     SLE_UINT16),

   408

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   409

   410

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

   411

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

   412

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

   413

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

   414

   415

	SLE_END()

   416

};

   417

   418

static void Save_WAYP(void)

   419

{

   420

	Waypoint *wp;

   421

   422

	FOR_ALL_WAYPOINTS(wp) {

   423

		SlSetArrayIndex(wp->index);

   424

		SlObject(wp, _waypoint_desc);

   425

	}

   426

}

   427

   428

static void Load_WAYP(void)

   429

{

   430

	int index;

   431

   432

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

   433

		Waypoint *wp;

   434

   435

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   436

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

   437

   438

		wp = GetWaypoint(index);

   439

		SlObject(wp, _waypoint_desc);

   440

	}

   441

}

   442

   443

const ChunkHandler _waypoint_chunk_handlers[] = {

   444

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

   445

};