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

		/* We use ZOOM_LVL_MAX here, as every viewport can have an other zoom,

   126

		 *  and there is no way for us to know which is the biggest. So make the

   127

		 *  biggest area dirty, and we are safe for sure. */

   128

		MarkAllViewportsDirty(

   129

			sign.left - 6,

   130

			sign.top,

   131

			sign.left + ScaleByZoom(sign.width_1 + 12, ZOOM_LVL_MAX),

   132

			sign.top + ScaleByZoom(12, ZOOM_LVL_MAX));

   133

	}

   134

}

   135

   136

void Station::MarkTilesDirty(bool cargo_change) const

   137

{

   138

	TileIndex tile = train_tile;

   139

	int w, h;

   140

   141

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

   142

	if (tile == 0) return;

   143

   144

	/* cargo_change is set if we're refreshing the tiles due to cargo moving

   145

	 * around. */

   146

	if (cargo_change) {

   147

		/* Don't waste time updating if there are no custom station graphics

   148

		 * that might change. Even if there are custom graphics, they might

   149

		 * not change. Unfortunately we have no way of telling. */

   150

		if (this->num_specs == 0) return;

   151

	}

   152

   153

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

   154

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

   155

			if (TileBelongsToRailStation(tile)) {

   156

				MarkTileDirtyByTile(tile);

   157

			}

   158

			tile += TileDiffXY(1, 0);

   159

		}

   160

		tile += TileDiffXY(-w, 1);

   161

	}

   162

}

   163

   164

bool Station::TileBelongsToRailStation(TileIndex tile) const

   165

{

   166

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

   167

}

   168

   169

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

   170

{

   171

	Station *st = NULL;

   172

   173

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

   174

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

   175

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

   176

		if (!st->IsValid()) {

   177

			StationID index = st->index;

   178

   179

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

   180

			st->index = index;

   181

			return st;

   182

		}

   183

	}

   184

   185

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

   186

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

   187

   188

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   189

	return NULL;

   190

}

   191

   192

   193

/** Obtain the length of a platform

   194

 * @pre tile must be a railway station tile

   195

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

   196

 * @return The length of the platform

   197

 */

   198

uint Station::GetPlatformLength(TileIndex tile) const

   199

{

   200

	TileIndex t;

   201

	TileIndexDiff delta;

   202

	uint len = 0;

   203

	assert(TileBelongsToRailStation(tile));

   204

   205

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

   206

   207

	t = tile;

   208

	do {

   209

		t -= delta;

   210

		len++;

   211

	} while (IsCompatibleTrainStationTile(t, tile));

   212

   213

	t = tile;

   214

	do {

   215

		t += delta;

   216

		len++;

   217

	} while (IsCompatibleTrainStationTile(t, tile));

   218

   219

	return len - 1;

   220

}

   221

   222

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

   223

 * the given tile.

   224

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

   225

 * @param dir The direction in which to search.

   226

 * @return The platform length

   227

 */

   228

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

   229

{

   230

	TileIndex start_tile = tile;

   231

	uint length = 0;

   232

	assert(IsRailwayStationTile(tile));

   233

	assert(dir < DIAGDIR_END);

   234

   235

	do {

   236

		length ++;

   237

		tile += TileOffsByDiagDir(dir);

   238

	} while (IsCompatibleTrainStationTile(tile, start_tile));

   239

   240

	return length;

   241

}

   242

   243

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

   244

 * @todo Ditch this encoding of buoys

   245

 */

   246

bool Station::IsBuoy() const

   247

{

   248

	return (had_vehicle_of_type & HVOT_BUOY) != 0;

   249

}

   250

   251

/** Determines whether a station exists

   252

 * @todo replace 0 by INVALID_TILE

   253

 */

   254

bool Station::IsValid() const

   255

{

   256

	return xy != 0;

   257

}

   258

   259

   260

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

   261

/*                     StationRect implementation                       */

   262

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

   263

   264

StationRect::StationRect()

   265

{

   266

	MakeEmpty();

   267

}

   268

   269

void StationRect::MakeEmpty()

   270

{

   271

	left = top = right = bottom = 0;

   272

}

   273

   274

/**

   275

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

   276

 * the station rectangle.

   277

 * @note x and y are in Tile coordinates

   278

 * @param x X coordinate

   279

 * @param y Y coordinate

   280

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

   281

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

   282

 */

   283

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

   284

{

   285

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

   286

}

   287

   288

bool StationRect::IsEmpty() const

   289

{

   290

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

   291

}

   292

   293

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

   294

{

   295

	int x = TileX(tile);

   296

	int y = TileY(tile);

   297

	if (IsEmpty()) {

   298

		/* we are adding the first station tile */

   299

		left = right = x;

   300

		top = bottom = y;

   301

   302

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

   303

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

   304

		/* make new spread-out rectangle */

   305

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

   306

   307

		/* check new rect dimensions against preset max */

   308

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

   309

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

   310

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

   311

			assert(mode != ADD_TRY);

   312

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   313

			return false;

   314

		}

   315

   316

		/* spread-out ok, return true */

   317

		if (mode != ADD_TEST) {

   318

			/* we should update the station rect */

   319

			*this = new_rect;

   320

		}

   321

	} else {

   322

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

   323

	}

   324

	return true;

   325

}

   326

   327

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

   328

{

   329

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

   330

}

   331

   332

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

   333

{

   334

	TileIndex top_left = TileXY(left_a, top_a);

   335

	int width = right_a - left_a + 1;

   336

	int height = bottom_a - top_a + 1;

   337

   338

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   339

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

   340

	END_TILE_LOOP(tile, width, height, top_left);

   341

   342

	return false;

   343

}

   344

   345

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

   346

{

   347

	int x = TileX(tile);

   348

	int y = TileY(tile);

   349

   350

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

   351

	 * and try to reduce the rect by this edge

   352

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

   353

	for (;;) {

   354

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

   355

		bool left_edge = (x == left);

   356

		bool right_edge = (x == right);

   357

		bool top_edge = (y == top);

   358

		bool bottom_edge = (y == bottom);

   359

   360

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

   361

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

   362

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

   363

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

   364

   365

		if (reduce_x) {

   366

			/* reduce horizontally */

   367

			if (left_edge) {

   368

				/* move left edge right */

   369

				left = x = x + 1;

   370

			} else {

   371

				/* move right edge left */

   372

				right = x = x - 1;

   373

			}

   374

		}

   375

		if (reduce_y) {

   376

			/* reduce vertically */

   377

			if (top_edge) {

   378

				/* move top edge down */

   379

				top = y = y + 1;

   380

			} else {

   381

				/* move bottom edge up */

   382

				bottom = y = y - 1;

   383

			}

   384

		}

   385

   386

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

   387

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

   388

			MakeEmpty();

   389

			return true; // empty remaining rect

   390

		}

   391

	}

   392

	return false; // non-empty remaining rect

   393

}

   394

   395

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

   396

{

   397

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

   398

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

   399

   400

	bool empty = AfterRemoveTile(st, tile);

   401

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

   402

	return empty;

   403

}

   404

   405

StationRect& StationRect::operator = (Rect src)

   406

{

   407

	left = src.left;

   408

	top = src.top;

   409

	right = src.right;

   410

	bottom = src.bottom;

   411

	return *this;

   412

}

   413

   414

   415

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

   416

/*                     RoadStop implementation                          */

   417

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

   418

   419

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

   420

 *  @return a pointer to the new roadstop

   421

 */

   422

void *RoadStop::operator new(size_t size)

   423

{

   424

	RoadStop *rs = AllocateRaw();

   425

	return rs;

   426

}

   427

   428

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

   429

  * @return a pointer to the roadstop

   430

  */

   431

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

   432

{

   433

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

   434

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

   435

	}

   436

   437

	RoadStop *rs = GetRoadStop(index);

   438

	return rs;

   439

}

   440

   441

void RoadStop::operator delete(void *p)

   442

{

   443

}

   444

   445

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

   446

{

   447

}

   448

   449

/** Initializes a RoadStop */

   450

RoadStop::RoadStop(TileIndex tile) :

   451

	xy(tile),

   452

	status(3), // stop is free

   453

	num_vehicles(0),

   454

	next(NULL)

   455

{

   456

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

   457

}

   458

   459

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

   460

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

   461

  */

   462

RoadStop::~RoadStop()

   463

{

   464

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

   465

	if (num_vehicles != 0) {

   466

		Vehicle *v;

   467

   468

		FOR_ALL_VEHICLES(v) {

   469

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

   470

		}

   471

	}

   472

	assert(num_vehicles == 0);

   473

   474

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

   475

   476

	xy = INVALID_TILE;

   477

}

   478

   479

   480

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

   481

RoadStop *RoadStop::AllocateRaw()

   482

{

   483

	RoadStop *rs;

   484

   485

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

   486

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

   487

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

   488

		if (!rs->IsValid()) {

   489

			RoadStopID index = rs->index;

   490

   491

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

   492

			rs->index = index;

   493

   494

			return rs;

   495

		}

   496

	}

   497

   498

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

   499

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