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;

    86

}

    87

    88

void* Station::operator new(size_t size)

    89

{

    90

	Station *st = AllocateRaw();

    91

	return st;

    92

}

    93

    94

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

    95

{

    96

	if (!AddBlockIfNeeded(&_Station_pool, st_idx))

    97

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

    98

    99

	Station *st = GetStation(st_idx);

   100

	return st;

   101

}

   102

   103

void Station::operator delete(void *p)

   104

{

   105

}

   106

   107

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

   108

{

   109

}

   110

   111

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

   112

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

   113

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

   114

{

   115

	if (facilities == 0) {

   116

		xy = facil_xy;

   117

		random_bits = Random();

   118

	}

   119

	facilities |= new_facility_bit;

   120

	owner = _current_player;

   121

	build_date = _date;

   122

}

   123

   124

void Station::MarkDirty() const

   125

{

   126

	if (sign.width_1 != 0) {

   127

		InvalidateWindowWidget(WC_STATION_VIEW, index, 1);

   128

   129

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

   130

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

   131

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

   132

		MarkAllViewportsDirty(

   133

			sign.left - 6,

   134

			sign.top,

   135

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

   136

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

   137

	}

   138

}

   139

   140

void Station::MarkTilesDirty(bool cargo_change) const

   141

{

   142

	TileIndex tile = train_tile;

   143

	int w, h;

   144

   145

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

   146

	if (tile == 0) return;

   147

   148

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

   149

	 * around. */

   150

	if (cargo_change) {

   151

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

   152

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

   153

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

   154

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

   155

	}

   156

   157

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

   158

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

   159

			if (TileBelongsToRailStation(tile)) {

   160

				MarkTileDirtyByTile(tile);

   161

			}

   162

			tile += TileDiffXY(1, 0);

   163

		}

   164

		tile += TileDiffXY(-w, 1);

   165

	}

   166

}

   167

   168

bool Station::TileBelongsToRailStation(TileIndex tile) const

   169

{

   170

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

   171

}

   172

   173

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

   174

{

   175

	Station *st = NULL;

   176

   177

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

   178

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

   179

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

   180

		if (!st->IsValid()) {

   181

			StationID index = st->index;

   182

   183

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

   184

			st->index = index;

   185

			return st;

   186

		}

   187

	}

   188

   189

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

   190

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

   191

   192

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   193

	return NULL;

   194

}

   195

   196

   197

/** Obtain the length of a platform

   198

 * @pre tile must be a railway station tile

   199

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

   200

 * @return The length of the platform

   201

 */

   202

uint Station::GetPlatformLength(TileIndex tile) const

   203

{

   204

	TileIndex t;

   205

	TileIndexDiff delta;

   206

	uint len = 0;

   207

	assert(TileBelongsToRailStation(tile));

   208

   209

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

   210

   211

	t = tile;

   212

	do {

   213

		t -= delta;

   214

		len++;

   215

	} while (IsCompatibleTrainStationTile(t, tile));

   216

   217

	t = tile;

   218

	do {

   219

		t += delta;

   220

		len++;

   221

	} while (IsCompatibleTrainStationTile(t, tile));

   222

   223

	return len - 1;

   224

}

   225

   226

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

   227

 * the given tile.

   228

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

   229

 * @param dir The direction in which to search.

   230

 * @return The platform length

   231

 */

   232

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

   233

{

   234

	TileIndex start_tile = tile;

   235

	uint length = 0;

   236

	assert(IsRailwayStationTile(tile));

   237

	assert(dir < DIAGDIR_END);

   238

   239

	do {

   240

		length ++;

   241

		tile += TileOffsByDiagDir(dir);

   242

	} while (IsCompatibleTrainStationTile(tile, start_tile));

   243

   244

	return length;

   245

}

   246

   247

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

   248

 * @todo Ditch this encoding of buoys

   249

 */

   250

bool Station::IsBuoy() const

   251

{

   252

	return (had_vehicle_of_type & HVOT_BUOY) != 0;

   253

}

   254

   255

/** Determines whether a station exists

   256

 * @todo replace 0 by INVALID_TILE

   257

 */

   258

bool Station::IsValid() const

   259

{

   260

	return xy != 0;

   261

}

   262

   263

   264

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

   265

/*                     StationRect implementation                       */

   266

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

   267

   268

StationRect::StationRect()

   269

{

   270

	MakeEmpty();

   271

}

   272

   273

void StationRect::MakeEmpty()

   274

{

   275

	left = top = right = bottom = 0;

   276

}

   277

   278

/**

   279

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

   280

 * the station rectangle.

   281

 * @note x and y are in Tile coordinates

   282

 * @param x X coordinate

   283

 * @param y Y coordinate

   284

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

   285

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

   286

 */

   287

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

   288

{

   289

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

   290

}

   291

   292

bool StationRect::IsEmpty() const

   293

{

   294

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

   295

}

   296

   297

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

   298

{

   299

	int x = TileX(tile);

   300

	int y = TileY(tile);

   301

	if (IsEmpty()) {

   302

		/* we are adding the first station tile */

   303

		left = right = x;

   304

		top = bottom = y;

   305

   306

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

   307

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

   308

		/* make new spread-out rectangle */

   309

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

   310

   311

		/* check new rect dimensions against preset max */

   312

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

   313

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

   314

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

   315

			assert(mode != ADD_TRY);

   316

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   317

			return false;

   318

		}

   319

   320

		/* spread-out ok, return true */

   321

		if (mode != ADD_TEST) {

   322

			/* we should update the station rect */

   323

			*this = new_rect;

   324

		}

   325

	} else {

   326

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

   327

	}

   328

	return true;

   329

}

   330

   331

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

   332

{

   333

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

   334

}

   335

   336

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

   337

{

   338

	TileIndex top_left = TileXY(left_a, top_a);

   339

	int width = right_a - left_a + 1;

   340

	int height = bottom_a - top_a + 1;

   341

   342

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   343

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

   344

	END_TILE_LOOP(tile, width, height, top_left);

   345

   346

	return false;

   347

}

   348

   349

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

   350

{

   351

	int x = TileX(tile);

   352

	int y = TileY(tile);

   353

   354

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

   355

	 * and try to reduce the rect by this edge

   356

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

   357

	for (;;) {

   358

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

   359

		bool left_edge = (x == left);

   360

		bool right_edge = (x == right);

   361

		bool top_edge = (y == top);

   362

		bool bottom_edge = (y == bottom);

   363

   364

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

   365

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

   366

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

   367

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

   368

   369

		if (reduce_x) {

   370

			/* reduce horizontally */

   371

			if (left_edge) {

   372

				/* move left edge right */

   373

				left = x = x + 1;

   374

			} else {

   375

				/* move right edge left */

   376

				right = x = x - 1;

   377

			}

   378

		}

   379

		if (reduce_y) {

   380

			/* reduce vertically */

   381

			if (top_edge) {

   382

				/* move top edge down */

   383

				top = y = y + 1;

   384

			} else {

   385

				/* move bottom edge up */

   386

				bottom = y = y - 1;

   387

			}

   388

		}

   389

   390

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

   391

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

   392

			MakeEmpty();

   393

			return true; // empty remaining rect

   394

		}

   395

	}

   396

	return false; // non-empty remaining rect

   397

}

   398

   399

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

   400

{

   401

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

   402

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

   403

   404

	bool empty = AfterRemoveTile(st, tile);

   405

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

   406

	return empty;

   407

}

   408

   409

StationRect& StationRect::operator = (Rect src)

   410

{

   411

	left = src.left;

   412

	top = src.top;

   413

	right = src.right;

   414

	bottom = src.bottom;

   415

	return *this;

   416

}

   417

   418

   419

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

   420

/*                     RoadStop implementation                          */

   421

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

   422

   423

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

   424

 *  @return a pointer to the new roadstop

   425

 */

   426

void *RoadStop::operator new(size_t size)

   427

{

   428

	RoadStop *rs = AllocateRaw();

   429

	return rs;

   430

}

   431

   432

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

   433

  * @return a pointer to the roadstop

   434

  */

   435

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

   436

{

   437

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

   438

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

   439

	}

   440

   441

	RoadStop *rs = GetRoadStop(index);

   442

	return rs;

   443

}

   444

   445

void RoadStop::operator delete(void *p)

   446

{

   447

}

   448

   449

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

   450

{

   451

}

   452

   453

/** Initializes a RoadStop */

   454

RoadStop::RoadStop(TileIndex tile) :

   455

	xy(tile),

   456

	status(3), // stop is free

   457

	num_vehicles(0),

   458

	next(NULL)

   459

{

   460

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

   461

}

   462

   463

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

   464

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

   465

  */

   466

RoadStop::~RoadStop()

   467

{

   468

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

   469

	if (num_vehicles != 0) {

   470

		Vehicle *v;

   471

   472

		FOR_ALL_VEHICLES(v) {

   473

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

   474

		}

   475

	}

   476

	assert(num_vehicles == 0);

   477

   478

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

   479

   480

	xy = INVALID_TILE;

   481

}

   482

   483

   484

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

   485

RoadStop *RoadStop::AllocateRaw()

   486

{

   487

	RoadStop *rs;

   488