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

/* Set the default name for a waypoint */

    99

static void MakeDefaultWaypointName(Waypoint* wp)

   100

{

   101

	Waypoint *local_wp;

   102

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   103

	int i;

   104

   105

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

   106

   107

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

   108

   109

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

   110

	FOR_ALL_WAYPOINTS(local_wp) {

   111

		if (wp == local_wp) 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;

   129

   130

	FOR_ALL_WAYPOINTS(wp) {

   131

		if (wp->deleted) {

   132

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

   133

   134

			if (cur_dist < thres) {

   135

				thres = cur_dist;

   136

				best = wp;

   137

			}

   138

		}

   139

	}

   140

   141

	return best;

   142

}

   143

   144

/**

   145

 * Update waypoint graphics id against saved GRFID/localidx.

   146

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

   147

 */

   148

void UpdateAllWaypointCustomGraphics(void)

   149

{

   150

	Waypoint *wp;

   151

   152

	FOR_ALL_WAYPOINTS(wp) {

   153

		uint i;

   154

   155

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

   156

   157

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

   158

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

   159

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

   160

				wp->stat_id = i;

   161

				break;

   162

			}

   163

		}

   164

	}

   165

}

   166

   167

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

   168

 * piece of rail

   169

 * @param tile tile where waypoint will be built

   170

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

   171

 * @param p2 unused

   172

 *

   173

 * @todo When checking for the tile slope,

   174

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

   175

 */

   176

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

   177

{

   178

	Waypoint *wp;

   179

	Slope tileh;

   180

	Axis axis;

   181

   182

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   183

   184

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

   185

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

   186

   187

	if (!IsTileType(tile, MP_RAILWAY) ||

   188

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   189

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

   190

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

   191

			)) {

   192

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   193

	}

   194

   195

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   196

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   197

   198

	tileh = GetTileSlope(tile, NULL);

   199

	if (tileh != SLOPE_FLAT &&

   200

			(!_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

	wp->xy = 0;

   251

   253

   254

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

   255

   256

	RedrawWaypointSign(wp);

   257

}

   258

   259

/* Daily loop for waypoints */

   260

void WaypointsDailyLoop(void)

   261

{

   262

	Waypoint *wp;

   263

   264

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

   265

	FOR_ALL_WAYPOINTS(wp) {

   266

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

   267

	}

   268

}

   269

   270

/* Remove a waypoint */

   271

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

   272

{

   273

	Waypoint *wp;

   274

   275

	/* Make sure it's a waypoint */

   276

	if (!IsTileType(tile, MP_RAILWAY) ||

   277

			!IsRailWaypoint(tile) ||

   278

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

   279

			!EnsureNoVehicle(tile)) {

   280

		return CMD_ERROR;

   281

	}

   282

   283

	if (flags & DC_EXEC) {

   284

		wp = GetWaypointByTile(tile);

   285

   286

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

   287

		RedrawWaypointSign(wp);

   288

   289

		if (justremove) {

   290

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

   291

			MarkTileDirtyByTile(tile);

   292

		} else {

   293

			DoClearSquare(tile);

   294

			SetSignalsOnBothDir(tile, GetRailWaypointTrack(tile));

   295

			YapfNotifyTrackLayoutChange(tile, GetRailWaypointTrack(tile));

   296

		}

   297

	}

   298

   299

	return _price.remove_train_depot;

   300

}

   301

   302

/** Delete a waypoint

   303

 * @param tile tile where waypoint is to be deleted

   304

 * @param p1 unused

   305

 * @param p2 unused

   306

 */

   307

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

   308

{

   309

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   310

	return RemoveTrainWaypoint(tile, flags, true);

   311

}

   312

   313

/** Rename a waypoint.

   314

 * @param tile unused

   315

 * @param p1 id of waypoint

   316

 * @param p2 unused

   317

 */

   318

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

   319

{

   320

	Waypoint *wp;

   321

   322

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   323

   324

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

   325

		StringID str = AllocateNameUnique(_cmd_text, 0);

   326

   327

		if (str == 0) return CMD_ERROR;

   328

   329

		if (flags & DC_EXEC) {

   330

			wp = GetWaypoint(p1);

   331

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

   332

   333

			wp->string = str;

   334

			wp->town_cn = 0;

   335

   336

			UpdateWaypointSign(wp);

   337

			MarkWholeScreenDirty();

   338

		} else {

   339

			DeleteName(str);

   340

		}

   341

	} else {

   342

		if (flags & DC_EXEC) {

   343

			wp = GetWaypoint(p1);

   344

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

   345

   346

			MakeDefaultWaypointName(wp);

   347

			UpdateWaypointSign(wp);

   348

			MarkWholeScreenDirty();

   349

		}

   350

	}

   351

	return 0;

   352

}

   353

   354

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

   355

Station *ComposeWaypointStation(TileIndex tile)

   356

{

   357

	Waypoint *wp = GetWaypointByTile(tile);

   358

	static Station stat;

   359

   360

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

   361

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

   362

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

   363

	stat.build_date = wp->build_date;

   364

   365

	return &stat;

   366

}

   367

   368

/* Draw a waypoint */

   369

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

   370

{

   371

	x += 33;

   372

	y += 17;

   373

   374

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

   375

		DrawDefaultWaypointSprite(x, y, railtype);

   376

	}

   377

}

   378

   379

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

   380

void FixOldWaypoints(void)

   381

{

   382

	Waypoint *wp;

   383

   384

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

   385

	FOR_ALL_WAYPOINTS(wp) {

   386

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

   387

		wp->town_cn = 0;

   388

		if (wp->string & 0xC000) {

   389

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

   390

			wp->string = STR_NULL;

   391

		}

   392

	}

   393

}

   394

   395

void InitializeWaypoints(void)

   396

{

   397

	CleanPool(&_waypoint_pool);

   398

	AddBlockToPool(&_waypoint_pool);

   399

}

   400

   401

static const SaveLoad _waypoint_desc[] = {

   402

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

   403

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

   404

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

   405

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

   406

	    SLE_VAR(Waypoint, string,     SLE_UINT16),

   407

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   408

   409

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

   410

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

   411

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

   412

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

   413

   414

	SLE_END()

   415

};

   416

   417

static void Save_WAYP(void)

   418

{

   419

	Waypoint *wp;

   420

   421

	FOR_ALL_WAYPOINTS(wp) {

   422

		SlSetArrayIndex(wp->index);

   423

		SlObject(wp, _waypoint_desc);

   424

	}

   425

}

   426

   427

static void Load_WAYP(void)

   428

{

   429

	int index;

   430

   431

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

   432

		Waypoint *wp;

   433

   434

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   435

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

   436

   437

		wp = GetWaypoint(index);

   438

		SlObject(wp, _waypoint_desc);

   439

	}

   440

}

   441

   442

const ChunkHandler _waypoint_chunk_handlers[] = {

   443

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

   444

};