1

/* $Id$ */

     2

     3

/** @file station.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "debug.h"

     9

#include "functions.h"

    10

#include "station_map.h"

    11

#include "table/sprites.h"

    12

#include "table/strings.h"

    13

#include "map.h"

    14

#include "tile.h"

    15

#include "station.h"

    16

#include "gfx.h"

    17

#include "window.h"

    18

#include "viewport.h"

    19

#include "command.h"

    20

#include "town.h"

    21

#include "vehicle.h"

    22

#include "news.h"

    23

#include "saveload.h"

    24

#include "economy.h"

    25

#include "player.h"

    26

#include "airport.h"

    27

#include "sprite.h"

    28

#include "depot.h"

    29

#include "train.h"

    30

#include "water_map.h"

    31

#include "industry_map.h"

    32

#include "newgrf_callbacks.h"

    33

#include "newgrf_station.h"

    34

#include "yapf/yapf.h"

    35

#include "date.h"

    36

#include "helpers.hpp"

    37

    38

Station::Station(TileIndex tile)

    39

{

    40

	DEBUG(station, cDebugCtorLevel, "I+%3d", index);

    41

    42

	xy = tile;

    43

	airport_tile = dock_tile = train_tile = 0;

    44

	bus_stops = truck_stops = NULL;

    45

	had_vehicle_of_type = 0;

    46

	time_since_load = 255;

    47

	time_since_unload = 255;

    48

	delete_ctr = 0;

    49

	facilities = 0;

    50

    51

	last_vehicle_type = VEH_INVALID;

    52

    53

	random_bits = 0; // Random() must be called when station is really built (DC_EXEC)

    54

	waiting_triggers = 0;

    55

}

    56

    57

/**

    58

 * Clean up a station by clearing vehicle orders and invalidating windows.

    59

 * Aircraft-Hangar orders need special treatment here, as the hangars are

    60

 * actually part of a station (tiletype is STATION), but the order type

    61

 * is OT_GOTO_DEPOT.

    62

 */

    63

Station::~Station()

    64

{

    65

	DEBUG(station, cDebugCtorLevel, "I-%3d", index);

    66

    67

	DeleteName(string_id);

    68

	MarkDirty();

    69

	RebuildStationLists();

    70

	InvalidateWindowClasses(WC_STATION_LIST);

    71

    72

	DeleteWindowById(WC_STATION_VIEW, index);

    73

    74

	/* Now delete all orders that go to the station */

    75

	RemoveOrderFromAllVehicles(OT_GOTO_STATION, index);

    76

    77

	/* Subsidies need removal as well */

    78

	DeleteSubsidyWithStation(index);

    79

    80

	free(speclist);

    81

	xy = 0;

    82

}

    83

    84

void* Station::operator new(size_t size)

    85

{

    86

	Station *st = AllocateRaw();

    87

	return st;

    88

}

    89

    90

void* Station::operator new(size_t size, int st_idx)

    91

{

    92

	if (!AddBlockIfNeeded(&_Station_pool, st_idx))

    93

		error("Stations: failed loading savegame: too many stations");

    94

    95

	Station *st = GetStation(st_idx);

    96

	return st;

    97

}

    98

    99

void Station::operator delete(void *p)

   100

{

   101

}

   102

   103

void Station::operator delete(void *p, int st_idx)

   104

{

   105

}

   106

   107

/** Called when new facility is built on the station. If it is the first facility

   108

 * it initializes also 'xy' and 'random_bits' members */

   109

void Station::AddFacility(byte new_facility_bit, TileIndex facil_xy)

   110

{

   111

	if (facilities == 0) {

   112

		xy = facil_xy;

   113

		random_bits = Random();

   114

	}

   115

	facilities |= new_facility_bit;

   116

	owner = _current_player;

   117

	build_date = _date;

   118

}

   119

   120

void Station::MarkDirty() const

   121

{

   122

	if (sign.width_1 != 0) {

   123

		InvalidateWindowWidget(WC_STATION_VIEW, index, 1);

   124

   125

		MarkAllViewportsDirty(

   126

			sign.left - 6,

   127

			sign.top,

   128

			sign.left + (sign.width_1 << 2) + 12,

   129

			sign.top + 48);

   130

	}

   131

}

   132

   133

void Station::MarkTilesDirty() const

   134

{

   135

	TileIndex tile = train_tile;

   136

	int w, h;

   137

   138

	/* XXX No station is recorded as 0, not INVALID_TILE... */

   139

	if (tile == 0) return;

   140

   141

	for (h = 0; h < trainst_h; h++) {

   142

		for (w = 0; w < trainst_w; w++) {

   143

			if (TileBelongsToRailStation(tile)) {

   144

				MarkTileDirtyByTile(tile);

   145

			}

   146

			tile += TileDiffXY(1, 0);

   147

		}

   148

		tile += TileDiffXY(-w, 1);

   149

	}

   150

}

   151

   152

bool Station::TileBelongsToRailStation(TileIndex tile) const

   153

{

   154

	return IsTileType(tile, MP_STATION) && GetStationIndex(tile) == index && IsRailwayStation(tile);

   155

}

   156

   157

/*static*/ Station *Station::AllocateRaw()

   158

{

   159

	Station *st = NULL;

   160

   161

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

   162

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

   163

	for (st = GetStation(0); st != NULL; st = (st->index + 1U < GetStationPoolSize()) ? GetStation(st->index + 1U) : NULL) {

   164

		if (!st->IsValid()) {

   165

			StationID index = st->index;

   166

   167

			memset(st, 0, sizeof(Station));

   168

			st->index = index;

   169

			return st;

   170

		}

   171

	}

   172

   173

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

   174

	if (AddBlockToPool(&_Station_pool)) return AllocateRaw();

   175

   176

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   177

	return NULL;

   178

}

   179

   180

   181

/** Obtain the length of a platform

   182

 * @pre tile must be a railway station tile

   183

 * @param tile A tile that contains the platform in question

   184

 * @return The length of the platform

   185

 */

   186

uint Station::GetPlatformLength(TileIndex tile) const

   187

{

   188

	TileIndex t;

   189

	TileIndexDiff delta;

   190

	uint len = 0;

   191

	assert(TileBelongsToRailStation(tile));

   192

   193

	delta = (GetRailStationAxis(tile) == AXIS_X ? TileDiffXY(1, 0) : TileDiffXY(0, 1));

   194

   195

	t = tile;

   196

	do {

   197

		t -= delta;

   198

		len++;

   199

	} while (IsCompatibleTrainStationTile(t, tile));

   200

   201

	t = tile;

   202

	do {

   203

		t += delta;

   204

		len++;

   205

	} while (IsCompatibleTrainStationTile(t, tile));

   206

   207

	return len - 1;

   208

}

   209

   210

/** Determines the REMAINING length of a platform, starting at (and including)

   211

 * the given tile.

   212

 * @param tile the tile from which to start searching. Must be a railway station tile

   213

 * @param dir The direction in which to search.

   214

 * @return The platform length

   215

 */

   216

uint Station::GetPlatformLength(TileIndex tile, DiagDirection dir) const

   217

{

   218

	TileIndex start_tile = tile;

   219

	uint length = 0;

   220

	assert(IsRailwayStationTile(tile));

   221

	assert(dir < DIAGDIR_END);

   222

   223

	do {

   224

		length ++;

   225

		tile += TileOffsByDiagDir(dir);

   226

	} while (IsCompatibleTrainStationTile(tile, start_tile));

   227

   228

	return length;

   229

}

   230

   231

/** Determines whether a station is a buoy only.

   232

 * @todo Ditch this encoding of buoys

   233

 */

   234

bool Station::IsBuoy() const

   235

{

   236

	return (had_vehicle_of_type & HVOT_BUOY) != 0;

   237

}

   238

   239

/** Determines whether a station exists

   240

 * @todo replace 0 by INVALID_TILE

   241

 */

   242

bool Station::IsValid() const

   243

{

   244

	return xy != 0;

   245

}

   246

   247

   248

/************************************************************************/

   249

/*                     StationRect implementation                       */

   250

/************************************************************************/

   251

   252

StationRect::StationRect()

   253

{

   254

	MakeEmpty();

   255

}

   256

   257

void StationRect::MakeEmpty()

   258

{

   259

	left = top = right = bottom = 0;

   260

}

   261

   262

/**

   263

 * Determines whether a given point (x, y) is within a certain distance of

   264

 * the station rectangle.

   265

 * @note x and y are in Tile coordinates

   266

 * @param x X coordinate

   267

 * @param y Y coordinate

   268

 * @param distance The maxmium distance a point may have (L1 norm)

   269

 * @return true if the point is within distance tiles of the station rectangle

   270

 */

   271

bool StationRect::PtInExtendedRect(int x, int y, int distance) const

   272

{

   273

	return (left - distance <= x && x <= right + distance && top - distance <= y && y <= bottom + distance);

   274

}

   275

   276

bool StationRect::IsEmpty() const

   277

{

   278

	return (left == 0 || left > right || top > bottom);

   279

}

   280

   281

bool StationRect::BeforeAddTile(TileIndex tile, StationRectMode mode)

   282

{

   283

	int x = TileX(tile);

   284

	int y = TileY(tile);

   285

	if (IsEmpty()) {

   286

		/* we are adding the first station tile */

   287

		left = right = x;

   288

		top = bottom = y;

   289

   290

	} else if (!PtInExtendedRect(x, y)) {

   291

		/* current rect is not empty and new point is outside this rect */

   292

		/* make new spread-out rectangle */

   293

		Rect new_rect = {min(x, left), min(y, top), max(x, right), max(y, bottom)};

   294

   295

		/* check new rect dimensions against preset max */

   296

		int w = new_rect.right - new_rect.left + 1;

   297

		int h = new_rect.bottom - new_rect.top + 1;

   298

		if (mode != ADD_FORCE && (w > _patches.station_spread || h > _patches.station_spread)) {

   299

			assert(mode != ADD_TRY);

   300

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   301

			return false;

   302

		}

   303

   304

		/* spread-out ok, return true */

   305

		if (mode != ADD_TEST) {

   306

			/* we should update the station rect */

   307

			*this = new_rect;

   308

		}

   309

	} else {

   310

		; // new point is inside the rect, we don't need to do anything

   311

	}

   312

	return true;

   313

}

   314

   315

bool StationRect::BeforeAddRect(TileIndex tile, int w, int h, StationRectMode mode)

   316

{

   317

	return BeforeAddTile(tile, mode) && BeforeAddTile(TILE_ADDXY(tile, w - 1, h - 1), mode);

   318

}

   319

   320

/*static*/ bool StationRect::ScanForStationTiles(StationID st_id, int left_a, int top_a, int right_a, int bottom_a)

   321

{

   322

	TileIndex top_left = TileXY(left_a, top_a);

   323

	int width = right_a - left_a + 1;

   324

	int height = bottom_a - top_a + 1;

   325

   326

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   327

		if (IsTileType(tile, MP_STATION) && GetStationIndex(tile) == st_id) return true;

   328

	END_TILE_LOOP(tile, width, height, top_left);

   329

   330

	return false;

   331

}

   332

   333

bool StationRect::AfterRemoveTile(Station *st, TileIndex tile)

   334

{

   335

	int x = TileX(tile);

   336

	int y = TileY(tile);

   337

   338

	/* look if removed tile was on the bounding rect edge

   339

	 * and try to reduce the rect by this edge

   340

	 * do it until we have empty rect or nothing to do */

   341

	for (;;) {

   342

		/* check if removed tile is on rect edge */

   343

		bool left_edge = (x == left);

   344

		bool right_edge = (x == right);

   345

		bool top_edge = (y == top);

   346

		bool bottom_edge = (y == bottom);

   347

   348

		/* can we reduce the rect in either direction? */

   349

		bool reduce_x = ((left_edge || right_edge) && !ScanForStationTiles(st->index, x, top, x, bottom));

   350

		bool reduce_y = ((top_edge || bottom_edge) && !ScanForStationTiles(st->index, left, y, right, y));

   351

		if (!(reduce_x || reduce_y)) break; // nothing to do (can't reduce)

   352

   353

		if (reduce_x) {

   354

			/* reduce horizontally */

   355

			if (left_edge) {

   356

				/* move left edge right */

   357

				left = x = x + 1;

   358

			} else {

   359

				/* move right edge left */

   360

				right = x = x - 1;

   361

			}

   362

		}

   363

		if (reduce_y) {

   364

			/* reduce vertically */

   365

			if (top_edge) {

   366

				/* move top edge down */

   367

				top = y = y + 1;

   368

			} else {

   369

				/* move bottom edge up */

   370

				bottom = y = y - 1;

   371

			}

   372

		}

   373

   374

		if (left > right || top > bottom) {

   375

			/* can't continue, if the remaining rectangle is empty */

   376

			MakeEmpty();

   377

			return true; // empty remaining rect

   378

		}

   379

	}

   380

	return false; // non-empty remaining rect

   381

}

   382

   383

bool StationRect::AfterRemoveRect(Station *st, TileIndex tile, int w, int h)

   384

{

   385

	assert(PtInExtendedRect(TileX(tile), TileY(tile)));

   386

	assert(PtInExtendedRect(TileX(tile) + w - 1, TileY(tile) + h - 1));

   387

   388

	bool empty = AfterRemoveTile(st, tile);

   389

	if (w != 1 || h != 1) empty = empty || AfterRemoveTile(st, TILE_ADDXY(tile, w - 1, h - 1));

   390

	return empty;

   391

}

   392

   393

StationRect& StationRect::operator = (Rect src)

   394

{

   395

	left = src.left;

   396

	top = src.top;

   397

	right = src.right;

   398

	bottom = src.bottom;

   399

	return *this;

   400

}

   401

   402

   403

/************************************************************************/

   404

/*                     RoadStop implementation                          */

   405

/************************************************************************/

   406

   407

/** Allocates a new RoadStop onto the pool, or recycles an unsed one

   408

 *  @return a pointer to the new roadstop

   409

 */

   410

void *RoadStop::operator new(size_t size)

   411

{

   412

	RoadStop *rs = AllocateRaw();

   413

	return rs;

   414

}

   415

   416

/** Gets a RoadStop with a given index and allocates it when needed

   417

  * @return a pointer to the roadstop

   418

  */

   419

void *RoadStop::operator new(size_t size, int index)

   420

{

   421

	if (!AddBlockIfNeeded(&_RoadStop_pool, index)) {

   422

		error("RoadStops: failed loading savegame: too many RoadStops");

   423

	}

   424

   425

	RoadStop *rs = GetRoadStop(index);

   426

	return rs;

   427

}

   428

   429

void RoadStop::operator delete(void *p)

   430

{

   431

}

   432

   433

void RoadStop::operator delete(void *p, int index)

   434

{

   435

}

   436

   437

/** Initializes a RoadStop */

   438

RoadStop::RoadStop(TileIndex tile) :

   439

	xy(tile),

   440

	status(3), // stop is free

   441

	num_vehicles(0),

   442

	next(NULL)

   443

{

   444

	DEBUG(ms, cDebugCtorLevel,  "I+ at %d[0x%x]", tile, tile);

   445

}

   446

   447

/** De-Initializes a RoadStops. This includes clearing all slots that vehicles might

   448

  * have and unlinks it from the linked list of road stops at the given station

   449

  */

   450

RoadStop::~RoadStop()

   451

{

   452

	/* Clear the slot assignment of all vehicles heading for this road stop */

   453

	if (num_vehicles != 0) {

   454

		Vehicle *v;

   455

   456

		FOR_ALL_VEHICLES(v) {

   457

			if (v->type == VEH_ROAD && v->u.road.slot == this) ClearSlot(v);

   458

		}

   459

	}

   460

	assert(num_vehicles == 0);

   461

   462

	DEBUG(ms, cDebugCtorLevel , "I- at %d[0x%x]", xy, xy);

   463

   464

	xy = INVALID_TILE;

   465

}

   466

   467

   468

/** Low-level function for allocating a RoadStop on the pool */

   469

RoadStop *RoadStop::AllocateRaw()

   470

{

   471

	RoadStop *rs;

   472

   473

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

   474

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

   475

	for (rs = GetRoadStop(0); rs != NULL; rs = (rs->index + 1U < GetRoadStopPoolSize()) ? GetRoadStop(rs->index + 1U) : NULL) {

   476

		if (!rs->IsValid()) {

   477

			RoadStopID index = rs->index;

   478

   479

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

   480

			rs->index = index;

   481

   482

			return rs;

   483

		}

   484

	}

   485

   486

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

   487

	if (AddBlockToPool(&_RoadStop_pool)) return AllocateRaw();

   488

   489

	return NULL;

   490

}

   491

   492

/** Determines whether a RoadStop is a valid (i.e. existing) one */

   493

bool RoadStop::IsValid() const

   494

{

   495

	return xy != INVALID_TILE;

   496

}

   497

   498

/** Checks whether there is a free bay in this road stop */

   499

bool RoadStop::HasFreeBay() const

   500

{