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

	indtype = IT_INVALID;

    55

    56

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

    57

	waiting_triggers = 0;

    58

}

    59

    60

/**

    61

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

    62

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

    63

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

    64

 * is OT_GOTO_DEPOT.

    65

 */

    66

Station::~Station()

    67

{

    68

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

    69

    70

	free(this->name);

    71

	free(this->speclist);

    72

    73

	if (CleaningPool()) return;

    74

    75

	while (!loading_vehicles.empty()) {

    76

		loading_vehicles.front()->LeaveStation();

    77

	}

    78

    79

	Vehicle *v;

    80

	FOR_ALL_VEHICLES(v) {

    81

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

    82

			v->u.air.targetairport = INVALID_STATION;

    83

		}

    84

	}

    85

    86

	MarkDirty();

    87

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

    88

    89

	DeleteWindowById(WC_STATION_VIEW, index);

    90

    91

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

    92

	RemoveOrderFromAllVehicles(OT_GOTO_STATION, index);

    93

    94

	/* Subsidies need removal as well */

    95

	DeleteSubsidyWithStation(index);

    96

    97

	/* Remove all news items */

    98

	DeleteStationNews(this->index);

    99

   100

	xy = 0;

   101

   102

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

   103

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

   104

	}

   105

}

   106

   107

   108

/**

   109

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

   110

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

   111

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

   112

 */

   113

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

   114

{

   115

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

   116

   117

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

   118

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

   119

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

   120

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

   121

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

   122

   123

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

   124

		break;

   125

	}

   126

   127

	return rs;

   128

}

   129

   130

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

   131

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

   132

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

   133

{

   134

	if (facilities == 0) {

   135

		xy = facil_xy;

   136

		random_bits = Random();

   137

	}

   138

	facilities |= new_facility_bit;

   139

	owner = _current_company;

   140

	build_date = _date;

   141

}

   142

   143

void Station::MarkDirty() const

   144

{

   145

	if (sign.width_1 != 0) {

   146

		InvalidateWindowWidget(WC_STATION_VIEW, index, SVW_CAPTION);

   147

   148

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

   149

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

   150

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

   151

		MarkAllViewportsDirty(

   152

			sign.left - 6,

   153

			sign.top,

   154

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

   155

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

   156

	}

   157

}

   158

   159

void Station::MarkTilesDirty(bool cargo_change) const

   160

{

   161

	TileIndex tile = train_tile;

   162

	int w, h;

   163

   164

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

   165

	if (tile == 0) return;

   166

   167

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

   168

	 * around. */

   169

	if (cargo_change) {

   170

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

   171

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

   172

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

   173

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

   174

	}

   175

   176

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

   177

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

   178

			if (TileBelongsToRailStation(tile)) {

   179

				MarkTileDirtyByTile(tile);

   180

			}

   181

			tile += TileDiffXY(1, 0);

   182

		}

   183

		tile += TileDiffXY(-w, 1);

   184

	}

   185

}

   186

   187

bool Station::TileBelongsToRailStation(TileIndex tile) const

   188

{

   189

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

   190

}

   191

   192

/** Obtain the length of a platform

   193

 * @pre tile must be a railway station tile

   194

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

   195

 * @return The length of the platform

   196

 */

   197

uint Station::GetPlatformLength(TileIndex tile) const

   198

{

   199

	TileIndex t;

   200

	TileIndexDiff delta;

   201

	uint len = 0;

   202

	assert(TileBelongsToRailStation(tile));

   203

   204

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

   205

   206

	t = tile;

   207

	do {

   208

		t -= delta;

   209

		len++;

   210

	} while (IsCompatibleTrainStationTile(t, tile));

   211

   212

	t = tile;

   213

	do {

   214

		t += delta;

   215

		len++;

   216

	} while (IsCompatibleTrainStationTile(t, tile));

   217

   218

	return len - 1;

   219

}

   220

   221

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

   222

 * the given tile.

   223

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

   224

 * @param dir The direction in which to search.

   225

 * @return The platform length

   226

 */

   227

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

   228

{

   229

	TileIndex start_tile = tile;

   230

	uint length = 0;

   231

	assert(IsRailwayStationTile(tile));

   232

	assert(dir < DIAGDIR_END);

   233

   234

	do {

   235

		length ++;

   236

		tile += TileOffsByDiagDir(dir);

   237

	} while (IsCompatibleTrainStationTile(tile, start_tile));

   238

   239

	return length;

   240

}

   241

   242

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

   243

 * @todo Ditch this encoding of buoys

   244

 */

   245

bool Station::IsBuoy() const

   246

{

   247

	return (had_vehicle_of_type & HVOT_BUOY) != 0;

   248

}

   249

   250

/** Determines the catchment radius of the station

   251

 * @return The radius

   252

 */

   253

uint Station::GetCatchmentRadius() const

   254

{

   255

	uint ret = CA_NONE;

   256

   257

	if (_settings_game.station.modified_catchment) {

   258

		if (this->bus_stops    != NULL) ret = max<uint>(ret, CA_BUS);

   259

		if (this->truck_stops  != NULL) ret = max<uint>(ret, CA_TRUCK);

   260

		if (this->train_tile   != 0)    ret = max<uint>(ret, CA_TRAIN);

   261

		if (this->dock_tile    != 0)    ret = max<uint>(ret, CA_DOCK);

   262

		if (this->airport_tile != 0)    ret = max<uint>(ret, this->Airport()->catchment);

   263

	} else {

   264

		if (this->bus_stops != NULL || this->truck_stops != NULL || this->train_tile != 0 || this->dock_tile != 0 || this->airport_tile != 0) {

   265

			ret = CA_UNMODIFIED;

   266

		}

   267

	}

   268

   269

	return ret;

   270

}

   271

   272

   273

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

   274

/*                     StationRect implementation                       */

   275

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

   276

   277

StationRect::StationRect()

   278

{

   279

	MakeEmpty();

   280

}

   281

   282

void StationRect::MakeEmpty()

   283

{

   284

	left = top = right = bottom = 0;

   285

}

   286

   287

/**

   288

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

   289

 * the station rectangle.

   290

 * @note x and y are in Tile coordinates

   291

 * @param x X coordinate

   292

 * @param y Y coordinate

   293

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

   294

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

   295

 */

   296

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

   297

{

   298

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

   299

}

   300

   301

bool StationRect::IsEmpty() const

   302

{

   303

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

   304

}

   305

   306

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

   307

{

   308

	int x = TileX(tile);

   309

	int y = TileY(tile);

   310

	if (IsEmpty()) {

   311

		/* we are adding the first station tile */

   312

		if (mode != ADD_TEST) {

   313

			left = right = x;

   314

			top = bottom = y;

   315

		}

   316

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

   317

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

   318

		/* make new spread-out rectangle */

   319

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

   320

   321

		/* check new rect dimensions against preset max */

   322

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

   323

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

   324

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

   325

			assert(mode != ADD_TRY);

   326

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   327

			return false;

   328

		}

   329

   330

		/* spread-out ok, return true */

   331

		if (mode != ADD_TEST) {

   332

			/* we should update the station rect */

   333

			*this = new_rect;

   334

		}

   335

	} else {

   336

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

   337

	}

   338

	return true;

   339

}

   340

   341

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

   342

{

   343

	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

   344

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

   345

}

   346

   347

/**

   348

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

   349

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

   350

 * @param left_a   Minimal tile X edge of the rectangle

   351

 * @param top_a    Minimal tile Y edge of the rectangle

   352

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

   353

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

   354

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

   355

 */

   356

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

   357

{

   358

	TileIndex top_left = TileXY(left_a, top_a);

   359

	int width = right_a - left_a + 1;

   360

	int height = bottom_a - top_a + 1;

   361

   362

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   363

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

   364

	END_TILE_LOOP(tile, width, height, top_left);

   365

   366

	return false;

   367

}

   368

   369

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

   370

{

   371

	int x = TileX(tile);

   372

	int y = TileY(tile);

   373

   374

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

   375

	 * and try to reduce the rect by this edge

   376

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

   377

	for (;;) {

   378

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

   379

		bool left_edge = (x == left);

   380

		bool right_edge = (x == right);

   381

		bool top_edge = (y == top);

   382

		bool bottom_edge = (y == bottom);

   383

   384

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

   385

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

   386

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

   387

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

   388

   389

		if (reduce_x) {

   390

			/* reduce horizontally */

   391

			if (left_edge) {

   392

				/* move left edge right */

   393

				left = x = x + 1;

   394

			} else {

   395

				/* move right edge left */

   396

				right = x = x - 1;

   397

			}

   398

		}

   399

		if (reduce_y) {

   400

			/* reduce vertically */

   401

			if (top_edge) {

   402

				/* move top edge down */

   403

				top = y = y + 1;

   404

			} else {

   405

				/* move bottom edge up */

   406

				bottom = y = y - 1;

   407

			}

   408

		}

   409

   410

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

   411

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

   412

			MakeEmpty();

   413

			return true; // empty remaining rect

   414

		}

   415

	}

   416

	return false; // non-empty remaining rect

   417

}

   418

   419

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

   420

{

   421

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

   422

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

   423

   424

	bool empty = AfterRemoveTile(st, tile);

   425

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

   426

	return empty;

   427

}

   428

   429

StationRect& StationRect::operator = (Rect src)

   430

{

   431

	left = src.left;

   432

	top = src.top;

   433

	right = src.right;

   434

	bottom = src.bottom;

   435

	return *this;

   436

}

   437

   438

   439

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

   440

/*                     RoadStop implementation                          */

   441

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

   442

   443

/** Initializes a RoadStop */

   444

RoadStop::RoadStop(TileIndex tile) :

   445

	xy(tile),

   446

	status(3), // stop is free

   447

	num_vehicles(0),

   448

	next(NULL)

   449

{

   450

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

   451

}

   452

   453

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

   454

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

   455

  */

   456

RoadStop::~RoadStop()

   457

{

   458

	if (CleaningPool()) return;

   459

   460

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

   461

	if (num_vehicles != 0) {

   462

		Vehicle *v;

   463

   464

		FOR_ALL_VEHICLES(v) {

   465

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

   466

		}

   467

	}

   468

	assert(num_vehicles == 0);

   469

   470

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

   471

   472

	xy = 0;

   473

}

   474

   475

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

   476

bool RoadStop::HasFreeBay() const

   477

{

   478

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

   479

}

   480

   481

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

   482

bool RoadStop::IsFreeBay(uint nr) const

   483

{

   484

	assert(nr < MAX_BAY_COUNT);

   485

	return HasBit(status, nr);

   486

}

   487

   488

/**

   489

 * Allocates a bay

   490

 * @return the allocated bay number

   491

 * @pre this->HasFreeBay()

   492

 */

   493

uint RoadStop::AllocateBay()