1

/* $Id$ */

     2

     3

/** @file station.cpp Implementation of the station base class. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "debug.h"

     9

#include "station_map.h"

    10

#include "station_base.h"

    11

#include "town.h"

    12

#include "saveload.h"

    13

#include "company_func.h"

    14

#include "airport.h"

    15

#include "sprite.h"

    16

#include "train.h"

    17

#include "water_map.h"

    18

#include "industry_map.h"

    19

#include "newgrf_callbacks.h"

    20

#include "newgrf_station.h"

    21

#include "yapf/yapf.h"

    22

#include "cargotype.h"

    23

#include "roadveh.h"

    24

#include "window_type.h"

    25

#include "station_gui.h"

    26

#include "zoom_func.h"

    27

#include "functions.h"

    28

#include "window_func.h"

    29

#include "date_func.h"

    30

#include "variables.h"

    31

#include "settings_type.h"

    32

#include "command_func.h"

    33

#include "order_func.h"

    34

#include "news_func.h"

    35

#include "aircraft.h"

    36

    37

#include "table/sprites.h"

    38

#include "table/strings.h"

    39

    40

Station::Station(TileIndex tile)

    41

{

    42

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

    43

    44

	xy = tile;

    45

	airport_tile = dock_tile = train_tile = 0;

    46

	bus_stops = truck_stops = NULL;

    47

	had_vehicle_of_type = 0;

    48

	time_since_load = 255;

    49

	time_since_unload = 255;

    50

	delete_ctr = 0;

    51

	facilities = 0;

    52

    53

	last_vehicle_type = VEH_INVALID;

    54

    55

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

    56

	waiting_triggers = 0;

    57

}

    58

    59

/**

    60

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

    61

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

    62

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

    63

 * is OT_GOTO_DEPOT.

    64

 */

    65

Station::~Station()

    66

{

    67

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

    68

    69

	free(this->name);

    70

	free(this->speclist);

    71

    72

	if (CleaningPool()) return;

    73

    74

	while (!loading_vehicles.empty()) {

    75

		loading_vehicles.front()->LeaveStation();

    76

	}

    77

    78

	Vehicle *v;

    79

	FOR_ALL_VEHICLES(v) {

    80

		if (v->type == VEH_AIRCRAFT && IsNormalAircraft(v) && v->u.air.targetairport == this->index) {

    81

			v->u.air.targetairport = INVALID_STATION;

    82

		}

    83

	}

    84

    85

	MarkDirty();

    86

	InvalidateWindowData(WC_STATION_LIST, this->owner, 0);

    87

    88

	DeleteWindowById(WC_STATION_VIEW, index);

    89

    90

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

    91

	RemoveOrderFromAllVehicles(OT_GOTO_STATION, index);

    92

    93

	/* Subsidies need removal as well */

    94

	DeleteSubsidyWithStation(index);

    95

    96

	/* Remove all news items */

    97

	DeleteStationNews(this->index);

    98

    99

	xy = 0;

   100

   101

	for (CargoID c = 0; c < NUM_CARGO; c++) {

   102

		goods[c].cargo.Truncate(0);

   103

	}

   104

}

   105

   106

   107

/**

   108

 * Get the primary road stop (the first road stop) that the given vehicle can load/unload.

   109

 * @param v the vehicle to get the first road stop for

   110

 * @return the first roadstop that this vehicle can load at

   111

 */

   112

RoadStop *Station::GetPrimaryRoadStop(const Vehicle *v) const

   113

{

   114

	RoadStop *rs = this->GetPrimaryRoadStop(IsCargoInClass(v->cargo_type, CC_PASSENGERS) ? ROADSTOP_BUS : ROADSTOP_TRUCK);

   115

   116

	for (; rs != NULL; rs = rs->next) {

   117

		/* The vehicle cannot go to this roadstop (different roadtype) */

   118

		if ((GetRoadTypes(rs->xy) & v->u.road.compatible_roadtypes) == ROADTYPES_NONE) continue;

   119

		/* The vehicle is articulated and can therefor not go the a standard road stop */

   120

		if (IsStandardRoadStopTile(rs->xy) && RoadVehHasArticPart(v)) continue;

   121

   122

		/* The vehicle can actually go to this road stop. So, return it! */

   123

		break;

   124

	}

   125

   126

	return rs;

   127

}

   128

   129

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

   130

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

   131

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

   132

{

   133

	if (facilities == 0) {

   134

		xy = facil_xy;

   135

		random_bits = Random();

   136

	}

   137

	facilities |= new_facility_bit;

   138

	owner = _current_company;

   139

	build_date = _date;

   140

}

   141

   142

void Station::MarkDirty() const

   143

{

   144

	if (sign.width_1 != 0) {

   145

		InvalidateWindowWidget(WC_STATION_VIEW, index, SVW_CAPTION);

   146

   147

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

   148

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

   149

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

   150

		MarkAllViewportsDirty(

   151

			sign.left - 6,

   152

			sign.top,

   153

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

   154

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

   155

	}

   156

}

   157

   158

void Station::MarkTilesDirty(bool cargo_change) const

   159

{

   160

	TileIndex tile = train_tile;

   161

	int w, h;

   162

   163

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

   164

	if (tile == 0) return;

   165

   166

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

   167

	 * around. */

   168

	if (cargo_change) {

   169

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

   170

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

   171

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

   172

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

   173

	}

   174

   175

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

   176

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

   177

			if (TileBelongsToRailStation(tile)) {

   178

				MarkTileDirtyByTile(tile);

   179

			}

   180

			tile += TileDiffXY(1, 0);

   181

		}

   182

		tile += TileDiffXY(-w, 1);

   183

	}

   184

}

   185

   186

bool Station::TileBelongsToRailStation(TileIndex tile) const

   187

{

   188

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

   189

}

   190

   191

/** Obtain the length of a platform

   192

 * @pre tile must be a railway station tile

   193

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

   194

 * @return The length of the platform

   195

 */

   196

uint Station::GetPlatformLength(TileIndex tile) const

   197

{

   198

	TileIndex t;

   199

	TileIndexDiff delta;

   200

	uint len = 0;

   201

	assert(TileBelongsToRailStation(tile));

   202

   203

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

   204

   205

	t = tile;

   206

	do {

   207

		t -= delta;

   208

		len++;

   209

	} while (IsCompatibleTrainStationTile(t, tile));

   210

   211

	t = tile;

   212

	do {

   213

		t += delta;

   214

		len++;

   215

	} while (IsCompatibleTrainStationTile(t, tile));

   216

   217

	return len - 1;

   218

}

   219

   220

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

   221

 * the given tile.

   222

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

   223

 * @param dir The direction in which to search.

   224

 * @return The platform length

   225

 */

   226

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

   227

{

   228

	TileIndex start_tile = tile;

   229

	uint length = 0;

   230

	assert(IsRailwayStationTile(tile));

   231

	assert(dir < DIAGDIR_END);

   232

   233

	do {

   234

		length ++;

   235

		tile += TileOffsByDiagDir(dir);

   236

	} while (IsCompatibleTrainStationTile(tile, start_tile));

   237

   238

	return length;

   239

}

   240

   241

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

   242

 * @todo Ditch this encoding of buoys

   243

 */

   244

bool Station::IsBuoy() const

   245

{

   246

	return (had_vehicle_of_type & HVOT_BUOY) != 0;

   247

}

   248

   271

   272

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

   273

/*                     StationRect implementation                       */

   274

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

   275

   276

StationRect::StationRect()

   277

{

   278

	MakeEmpty();

   279

}

   280

   281

void StationRect::MakeEmpty()

   282

{

   283

	left = top = right = bottom = 0;

   284

}

   285

   286

/**

   287

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

   288

 * the station rectangle.

   289

 * @note x and y are in Tile coordinates

   290

 * @param x X coordinate

   291

 * @param y Y coordinate

   292

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

   293

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

   294

 */

   295

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

   296

{

   297

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

   298

}

   299

   300

bool StationRect::IsEmpty() const

   301

{

   302

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

   303

}

   304

   305

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

   306

{

   307

	int x = TileX(tile);

   308

	int y = TileY(tile);

   309

	if (IsEmpty()) {

   310

		/* we are adding the first station tile */

   311

		if (mode != ADD_TEST) {

   312

			left = right = x;

   313

			top = bottom = y;

   314

		}

   315

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

   316

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

   317

		/* make new spread-out rectangle */

   318

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

   319

   320

		/* check new rect dimensions against preset max */

   321

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

   322

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

   323

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

   324

			assert(mode != ADD_TRY);

   325

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   326

			return false;

   327

		}

   328

   329

		/* spread-out ok, return true */

   330

		if (mode != ADD_TEST) {

   331

			/* we should update the station rect */

   332

			*this = new_rect;

   333

		}

   334

	} else {

   335

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

   336

	}

   337

	return true;

   338

}

   339

   340

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

   341

{

   342

	return (mode == ADD_FORCE || (w <= _settings_game.station.station_spread && h <= _settings_game.station.station_spread)) && // important when the old rect is completely inside the new rect, resp. the old one was empty

   343

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

   344

}

   345

   346

/**

   347

 * Check whether station tiles of the given station id exist in the given rectangle

   348

 * @param st_id    Station ID to look for in the rectangle

   349

 * @param left_a   Minimal tile X edge of the rectangle

   350

 * @param top_a    Minimal tile Y edge of the rectangle

   351

 * @param right_a  Maximal tile X edge of the rectangle (inclusive)

   352

 * @param bottom_a Maximal tile Y edge of the rectangle (inclusive)

   353

 * @return \c true if a station tile with the given \a st_id exists in the rectangle, \c false otherwise

   354

 */

   355

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

   356

{

   357

	TileIndex top_left = TileXY(left_a, top_a);

   358

	int width = right_a - left_a + 1;

   359

	int height = bottom_a - top_a + 1;

   360

   361

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   362

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

   363

	END_TILE_LOOP(tile, width, height, top_left);

   364

   365

	return false;

   366

}

   367

   368

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

   369

{

   370

	int x = TileX(tile);

   371

	int y = TileY(tile);

   372

   373

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

   374

	 * and try to reduce the rect by this edge

   375

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

   376

	for (;;) {

   377

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

   378

		bool left_edge = (x == left);

   379

		bool right_edge = (x == right);

   380

		bool top_edge = (y == top);

   381

		bool bottom_edge = (y == bottom);

   382

   383

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

   384

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

   385

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

   386

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

   387

   388

		if (reduce_x) {

   389

			/* reduce horizontally */

   390

			if (left_edge) {

   391

				/* move left edge right */

   392

				left = x = x + 1;

   393

			} else {

   394

				/* move right edge left */

   395

				right = x = x - 1;

   396

			}

   397

		}

   398

		if (reduce_y) {

   399

			/* reduce vertically */

   400

			if (top_edge) {

   401

				/* move top edge down */

   402

				top = y = y + 1;

   403

			} else {

   404

				/* move bottom edge up */

   405

				bottom = y = y - 1;

   406

			}

   407

		}

   408

   409

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

   410

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

   411

			MakeEmpty();

   412

			return true; // empty remaining rect

   413

		}

   414

	}

   415

	return false; // non-empty remaining rect

   416

}

   417

   418

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

   419

{

   420

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

   421

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

   422

   423

	bool empty = AfterRemoveTile(st, tile);

   424

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

   425

	return empty;

   426

}

   427

   428

StationRect& StationRect::operator = (Rect src)

   429

{

   430

	left = src.left;

   431

	top = src.top;

   432

	right = src.right;

   433

	bottom = src.bottom;

   434

	return *this;

   435

}

   436

   437

   438

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

   439

/*                     RoadStop implementation                          */

   440

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

   441

   442

/** Initializes a RoadStop */

   443

RoadStop::RoadStop(TileIndex tile) :

   444

	xy(tile),

   445

	status(3), // stop is free

   446

	num_vehicles(0),

   447

	next(NULL)

   448

{

   449

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

   450

}

   451

   452

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

   453

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

   454

  */

   455

RoadStop::~RoadStop()

   456

{

   457

	if (CleaningPool()) return;

   458

   459

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

   460

	if (num_vehicles != 0) {

   461

		Vehicle *v;

   462

   463

		FOR_ALL_VEHICLES(v) {

   464

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

   465

		}

   466

	}

   467

	assert(num_vehicles == 0);

   468

   469

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

   470

   471

	xy = 0;

   472

}

   473

   474

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

   475

bool RoadStop::HasFreeBay() const

   476

{

   477

	return GB(status, 0, MAX_BAY_COUNT) != 0;

   478

}

   479

   480

/** Checks whether the given bay is free in this road stop */

   481

bool RoadStop::IsFreeBay(uint nr) const

   482

{

   483

	assert(nr < MAX_BAY_COUNT);

   484

	return HasBit(status, nr);

   485

}

   486

   487

/**

   488

 * Allocates a bay

   489

 * @return the allocated bay number

   490

 * @pre this->HasFreeBay()

   491

 */

   492

uint RoadStop::AllocateBay()

   493