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_PER_TOWN = 64,

    25

};

    26

    27

/**

    28

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

    29

 */

    30

static void WaypointPoolNewBlock(uint start_item)

    31

{

    32

	Waypoint *wp;

    33

    34

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

    35

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

    36

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

    37

}

    38

    39

DEFINE_OLD_POOL(Waypoint, Waypoint, WaypointPoolNewBlock, NULL)

    40

    41

/* Create a new waypoint */

    42

static Waypoint* AllocateWaypoint(void)

    43

{

    44

	Waypoint *wp;

    45

    46

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

    47

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

    48

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

    49

		if (!IsValidWaypoint(wp)) {

    50

			uint index = wp->index;

    51

    52

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

    53

			wp->index = index;

    54

    55

			return wp;

    56

		}

    57

	}

    58

    59

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

    60

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

    61

    62

	return NULL;

    63

}

    64

    65

/* Update the sign for the waypoint */

    66

static void UpdateWaypointSign(Waypoint* wp)

    67

{

    68

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

    69

	SetDParam(0, wp->index);

    70

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

    71

}

    72

    73

/* Redraw the sign of a waypoint */

    74

static void RedrawWaypointSign(const Waypoint* wp)

    75

{

    76

	MarkAllViewportsDirty(

    77

		wp->sign.left - 6,

    78

		wp->sign.top,

    79

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

    80

		wp->sign.top + 48);

    81

}

    82

    83

/* Update all signs */

    84

void UpdateAllWaypointSigns(void)

    85

{

    86

	Waypoint *wp;

    87

    88

	FOR_ALL_WAYPOINTS(wp) {

    89

		UpdateWaypointSign(wp);

    90

	}

    91

}

    92

    93

/* Internal handler to delete a waypoint */

    94

void DestroyWaypoint(Waypoint *wp)

    95

{

    96

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, wp->index);

    97

    98

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

    99

   100

	RedrawWaypointSign(wp);

   101

}

   102

   103

/* Set the default name for a waypoint */

   104

static void MakeDefaultWaypointName(Waypoint* wp)

   105

{

   106

	Waypoint *local_wp;

   107

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   108

	int i;

   109

   110

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

   111

   112

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

   113

   114

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

   115

	FOR_ALL_WAYPOINTS(local_wp) {

   116

		if (wp == local_wp) continue;

   117

   118

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

   119

			used_waypoint[local_wp->town_cn] = true;

   120

	}

   121

   122

	/* Find an empty spot */

   123

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

   124

   125

	wp->string = STR_NULL;

   126

	wp->town_cn = i;

   127

}

   128

   129

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

   130

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   131

{

   132

	Waypoint *wp, *best = NULL;

   133

	uint thres = 8;

   134

   135

	FOR_ALL_WAYPOINTS(wp) {

   136

		if (wp->deleted) {

   137

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

   138

   139

			if (cur_dist < thres) {

   140

				thres = cur_dist;

   141

				best = wp;

   142

			}

   143

		}

   144

	}

   145

   146

	return best;

   147

}

   148

   149

/**

   150

 * Update waypoint graphics id against saved GRFID/localidx.

   151

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

   152

 */

   153

void AfterLoadWaypoints(void)

   154

{

   155

	Waypoint *wp;

   156

   157

	FOR_ALL_WAYPOINTS(wp) {

   158

		uint i;

   159

   160

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

   161

   162

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

   163

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

   164

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

   165

				wp->stat_id = i;

   166

				break;

   167

			}

   168

		}

   169

	}

   170

}

   171

   172

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

   173

 * piece of rail

   174

 * @param tile tile where waypoint will be built

   175

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

   176

 * @param p2 unused

   177

 *

   178

 * @todo When checking for the tile slope,

   179

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

   180

 */

   181

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

   182

{

   183

	Waypoint *wp;

   184

	Slope tileh;

   185

	Axis axis;

   186

   187

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   188

   189

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

   190

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

   191

   192

	if (!IsTileType(tile, MP_RAILWAY) ||

   193

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   194

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

   195

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

   196

			)) {

   197

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   198

	}

   199

   200

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   201

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   202

   203

	tileh = GetTileSlope(tile, NULL);

   204

	if (tileh != SLOPE_FLAT &&

   205

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

   206

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   207

	}

   208

   209

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

   210

	wp = FindDeletedWaypointCloseTo(tile);

   211

	if (wp == NULL) {

   212

		wp = AllocateWaypoint();

   213

		if (wp == NULL) return CMD_ERROR;

   214

   215

		wp->town_index = 0;

   216

		wp->string = STR_NULL;

   217

		wp->town_cn = 0;

   218

	}

   219

   220

	if (flags & DC_EXEC) {

   221

		const StationSpec* statspec;

   222

   223

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

   224

		MarkTileDirtyByTile(tile);

   225

   226

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   227

   228

		if (statspec != NULL) {

   229

			wp->stat_id = p1;

   230

			wp->grfid = statspec->grfid;

   231

			wp->localidx = statspec->localidx;

   232

		} else {

   233

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

   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) MakeDefaultWaypointName(wp);

   244

   245

		UpdateWaypointSign(wp);

   246

		RedrawWaypointSign(wp);

   247

		YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));

   248

	}

   249

   250

	return _price.build_train_depot;

   251

}

   252

   253

/* Daily loop for waypoints */

   254

void WaypointsDailyLoop(void)

   255

{

   256

	Waypoint *wp;

   257

   258

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

   259

	FOR_ALL_WAYPOINTS(wp) {

   260

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

   261

	}

   262

}

   263

   264

/* Remove a waypoint */

   265

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

   266

{

   267

	Waypoint *wp;

   268

   269

	/* Make sure it's a waypoint */

   270

	if (!IsTileType(tile, MP_RAILWAY) ||

   271

			!IsRailWaypoint(tile) ||

   272

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

   273

			!EnsureNoVehicle(tile)) {

   274

		return CMD_ERROR;

   275

	}

   276

   277

	if (flags & DC_EXEC) {

   278

		Track track = GetRailWaypointTrack(tile);

   279

		wp = GetWaypointByTile(tile);

   280

   281

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

   282

		RedrawWaypointSign(wp);

   283

   284

		if (justremove) {

   285

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

   286

			MarkTileDirtyByTile(tile);

   287

		} else {

   288

			DoClearSquare(tile);

   289

			SetSignalsOnBothDir(tile, track);

   290

		}

   291

		YapfNotifyTrackLayoutChange(tile, track);

   292

	}

   293

   294

	return _price.remove_train_depot;

   295

}

   296

   297

/** Delete a waypoint

   298

 * @param tile tile where waypoint is to be deleted

   299

 * @param p1 unused

   300

 * @param p2 unused

   301

 */

   302

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

   303

{

   304

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   305

	return RemoveTrainWaypoint(tile, flags, true);

   306

}

   307

   308

/** Rename a waypoint.

   309

 * @param tile unused

   310

 * @param p1 id of waypoint

   311

 * @param p2 unused

   312

 */

   313

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

   314

{

   315

	Waypoint *wp;

   316

   317

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   318

   319

	wp = GetWaypoint(p1);

   320

	if (!CheckTileOwnership(wp->xy)) return CMD_ERROR;

   321

   322

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

   323

		StringID str = AllocateNameUnique(_cmd_text, 0);

   324

   325

		if (str == 0) return CMD_ERROR;

   326

   327

		if (flags & DC_EXEC) {

   328

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

   329

   330

			wp->string = str;

   331

			wp->town_cn = 0;

   332

   333

			UpdateWaypointSign(wp);

   334

			MarkWholeScreenDirty();

   335

		} else {

   336

			DeleteName(str);

   337

		}

   338

	} else {

   339

		if (flags & DC_EXEC) {

   340

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

   341

   342

			MakeDefaultWaypointName(wp);

   343

			UpdateWaypointSign(wp);

   344

			MarkWholeScreenDirty();

   345

		}

   346

	}

   347

	return 0;

   348

}

   349

   350

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

   351

Station *ComposeWaypointStation(TileIndex tile)

   352

{

   353

	Waypoint *wp = GetWaypointByTile(tile);

   354

	static Station stat;

   355

   356

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

   357

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

   358

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

   359

	stat.build_date = wp->build_date;

   360

   361

	return &stat;

   362

}

   363

   364

/* Draw a waypoint */

   365

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

   366

{

   367

	x += 33;

   368

	y += 17;

   369

   370

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

   371

		DrawDefaultWaypointSprite(x, y, railtype);

   372

	}

   373

}

   374

   375

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

   376

void FixOldWaypoints(void)

   377

{

   378

	Waypoint *wp;

   379

   380

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

   381

	FOR_ALL_WAYPOINTS(wp) {

   382

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

   383

		wp->town_cn = 0;

   384

		if (wp->string & 0xC000) {

   385

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

   386

			wp->string = STR_NULL;

   387

		}

   388

	}

   389

}

   390

   391

void InitializeWaypoints(void)

   392

{

   393

	CleanPool(&_Waypoint_pool);

   394

	AddBlockToPool(&_Waypoint_pool);

   395

}

   396

   397

static const SaveLoad _waypoint_desc[] = {

   398

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

   399

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

   400

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

   401

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

   402

	    SLE_VAR(Waypoint, string,     SLE_UINT16),

   403

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   404

   405

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

   406

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

   407

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

   408

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

   409

   410

	SLE_END()

   411

};

   412

   413

static void Save_WAYP(void)

   414

{

   415

	Waypoint *wp;

   416

   417

	FOR_ALL_WAYPOINTS(wp) {

   418

		SlSetArrayIndex(wp->index);

   419

		SlObject(wp, _waypoint_desc);

   420

	}

   421

}

   422

   423

static void Load_WAYP(void)

   424

{

   425

	int index;

   426

   427

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

   428

		Waypoint *wp;

   429

   430

		if (!AddBlockIfNeeded(&_Waypoint_pool, index))

   431

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

   432

   433

		wp = GetWaypoint(index);

   434

		SlObject(wp, _waypoint_desc);

   435

	}

   436

}

   437

   438

const ChunkHandler _waypoint_chunk_handlers[] = {

   439

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

   440

};