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

#include "cargotype.h"

    38

#include "roadveh.h"

    39

#include "station_gui.h"

    40

    41

Station::Station(TileIndex tile)

    42

{

    43

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

    44

    45

	xy = tile;

    46

	airport_tile = dock_tile = train_tile = 0;

    47

	bus_stops = truck_stops = NULL;

    48

	had_vehicle_of_type = 0;

    49

	time_since_load = 255;

    50

	time_since_unload = 255;

    51

	delete_ctr = 0;

    52

	facilities = 0;

    53

    54

	last_vehicle_type = VEH_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

	DeleteName(this->string_id);

    71

	free(this->speclist);

    72

    73

	if (CleaningPool()) return;

    74

    75

	while (!loading_vehicles.empty()) {

    76

		loading_vehicles.front()->LeaveStation();

    77

	}

    78

    79

	MarkDirty();

    80

	RebuildStationLists();

    81

	InvalidateWindowClasses(WC_STATION_LIST);

    82

    83

	DeleteWindowById(WC_STATION_VIEW, index);

    84

    85

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

    86

	RemoveOrderFromAllVehicles(OT_GOTO_STATION, index);

    87

    88

	/* Subsidies need removal as well */

    89

	DeleteSubsidyWithStation(index);

    90

    91

	xy = 0;

    92

    93

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

    94

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

    95

	}

    96

}

    97

    98

    99

/**

   100

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

   101

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

   102

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

   103

 */

   104

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

   105

{

   106

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

   107

   108

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

   109

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

   110

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

   111

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

   112

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

   113

   114

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

   115

		break;

   116

	}

   117

   118

	return rs;

   119

}

   120

   121

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

   122

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

   123

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

   124

{

   125

	if (facilities == 0) {

   126

		xy = facil_xy;

   127

		random_bits = Random();

   128

	}

   129

	facilities |= new_facility_bit;

   130

	owner = _current_player;

   131

	build_date = _date;

   132

}

   133

   134

void Station::MarkDirty() const

   135

{

   136

	if (sign.width_1 != 0) {

   137

		InvalidateWindowWidget(WC_STATION_VIEW, index, SVW_CAPTION);

   138

   139

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

   140

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

   141

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

   142

		MarkAllViewportsDirty(

   143

			sign.left - 6,

   144

			sign.top,

   145

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

   146

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

   147

	}

   148

}

   149

   150

void Station::MarkTilesDirty(bool cargo_change) const

   151

{

   152

	TileIndex tile = train_tile;

   153

	int w, h;

   154

   155

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

   156

	if (tile == 0) return;

   157

   158

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

   159

	 * around. */

   160

	if (cargo_change) {

   161

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

   162

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

   163

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

   164

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

   165

	}

   166

   167

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

   168

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

   169

			if (TileBelongsToRailStation(tile)) {

   170

				MarkTileDirtyByTile(tile);

   171

			}

   172

			tile += TileDiffXY(1, 0);

   173

		}

   174

		tile += TileDiffXY(-w, 1);

   175

	}

   176

}

   177

   178

bool Station::TileBelongsToRailStation(TileIndex tile) const

   179

{

   180

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

   181

}

   182

   183

/** Obtain the length of a platform

   184

 * @pre tile must be a railway station tile

   185

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

   186

 * @return The length of the platform

   187

 */

   188

uint Station::GetPlatformLength(TileIndex tile) const

   189

{

   190

	TileIndex t;

   191

	TileIndexDiff delta;

   192

	uint len = 0;

   193

	assert(TileBelongsToRailStation(tile));

   194

   195

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

   196

   197

	t = tile;

   198

	do {

   199

		t -= delta;

   200

		len++;

   201

	} while (IsCompatibleTrainStationTile(t, tile));

   202

   203

	t = tile;

   204

	do {

   205

		t += delta;

   206

		len++;

   207

	} while (IsCompatibleTrainStationTile(t, tile));

   208

   209

	return len - 1;

   210

}

   211

   212

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

   213

 * the given tile.

   214

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

   215

 * @param dir The direction in which to search.

   216

 * @return The platform length

   217

 */

   218

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

   219

{

   220

	TileIndex start_tile = tile;

   221

	uint length = 0;

   222

	assert(IsRailwayStationTile(tile));

   223

	assert(dir < DIAGDIR_END);

   224

   225

	do {

   226

		length ++;

   227

		tile += TileOffsByDiagDir(dir);

   228

	} while (IsCompatibleTrainStationTile(tile, start_tile));

   229

   230

	return length;

   231

}

   232

   233

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

   234

 * @todo Ditch this encoding of buoys

   235

 */

   236

bool Station::IsBuoy() const

   237

{

   238

	return (had_vehicle_of_type & HVOT_BUOY) != 0;

   239

}

   240

   241

   242

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

   243

/*                     StationRect implementation                       */

   244

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

   245

   246

StationRect::StationRect()

   247

{

   248

	MakeEmpty();

   249

}

   250

   251

void StationRect::MakeEmpty()

   252

{

   253

	left = top = right = bottom = 0;

   254

}

   255

   256

/**

   257

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

   258

 * the station rectangle.

   259

 * @note x and y are in Tile coordinates

   260

 * @param x X coordinate

   261

 * @param y Y coordinate

   262

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

   263

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

   264

 */

   265

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

   266

{

   267

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

   268

}

   269

   270

bool StationRect::IsEmpty() const

   271

{

   272

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

   273

}

   274

   275

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

   276

{

   277

	int x = TileX(tile);

   278

	int y = TileY(tile);

   279

	if (IsEmpty()) {

   280

		/* we are adding the first station tile */

   281

		left = right = x;

   282

		top = bottom = y;

   283

   284

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

   285

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

   286

		/* make new spread-out rectangle */

   287

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

   288

   289

		/* check new rect dimensions against preset max */

   290

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

   291

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

   292

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

   293

			assert(mode != ADD_TRY);

   294

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   295

			return false;

   296

		}

   297

   298

		/* spread-out ok, return true */

   299

		if (mode != ADD_TEST) {

   300

			/* we should update the station rect */

   301

			*this = new_rect;

   302

		}

   303

	} else {

   304

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

   305

	}

   306

	return true;

   307

}

   308

   309

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

   310

{

   311

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

   312

}

   313

   314

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

   315

{

   316

	TileIndex top_left = TileXY(left_a, top_a);

   317

	int width = right_a - left_a + 1;

   318

	int height = bottom_a - top_a + 1;

   319

   320

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   321

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

   322

	END_TILE_LOOP(tile, width, height, top_left);

   323

   324

	return false;

   325

}

   326

   327

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

   328

{

   329

	int x = TileX(tile);

   330

	int y = TileY(tile);

   331

   332

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

   333

	 * and try to reduce the rect by this edge

   334

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

   335

	for (;;) {

   336

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

   337

		bool left_edge = (x == left);

   338

		bool right_edge = (x == right);

   339

		bool top_edge = (y == top);

   340

		bool bottom_edge = (y == bottom);

   341

   342

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

   343

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

   344

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

   345

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

   346

   347

		if (reduce_x) {

   348

			/* reduce horizontally */

   349

			if (left_edge) {

   350

				/* move left edge right */

   351

				left = x = x + 1;

   352

			} else {

   353

				/* move right edge left */

   354

				right = x = x - 1;

   355

			}

   356

		}

   357

		if (reduce_y) {

   358

			/* reduce vertically */

   359

			if (top_edge) {

   360

				/* move top edge down */

   361

				top = y = y + 1;

   362

			} else {

   363

				/* move bottom edge up */

   364

				bottom = y = y - 1;

   365

			}

   366

		}

   367

   368

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

   369

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

   370

			MakeEmpty();

   371

			return true; // empty remaining rect

   372

		}

   373

	}

   374

	return false; // non-empty remaining rect

   375

}

   376

   377

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

   378

{

   379

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

   380

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

   381

   382

	bool empty = AfterRemoveTile(st, tile);

   383

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

   384

	return empty;

   385

}

   386

   387

StationRect& StationRect::operator = (Rect src)

   388

{

   389

	left = src.left;

   390

	top = src.top;

   391

	right = src.right;

   392

	bottom = src.bottom;

   393

	return *this;

   394

}

   395

   396

   397

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

   398

/*                     RoadStop implementation                          */

   399

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

   400

   401

/** Initializes a RoadStop */

   402

RoadStop::RoadStop(TileIndex tile) :

   403

	xy(tile),

   404

	status(3), // stop is free

   405

	num_vehicles(0),

   406

	next(NULL)

   407

{

   408

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

   409

}

   410

   411

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

   412

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

   413

  */

   414

RoadStop::~RoadStop()

   415

{

   416

	if (CleaningPool()) return;

   417

   418

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

   419

	if (num_vehicles != 0) {

   420

		Vehicle *v;

   421

   422

		FOR_ALL_VEHICLES(v) {

   423

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

   424

		}

   425

	}

   426

	assert(num_vehicles == 0);

   427

   428

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

   429

   430

	xy = 0;

   431

}

   432

   433

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

   434

bool RoadStop::HasFreeBay() const

   435

{

   436

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

   437

}

   438

   439

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

   440

bool RoadStop::IsFreeBay(uint nr) const

   441

{

   442

	assert(nr < MAX_BAY_COUNT);

   443

	return HasBit(status, nr);

   444

}

   445

   446

/**

   447

 * Allocates a bay

   448

 * @return the allocated bay number

   449

 * @pre this->HasFreeBay()

   450

 */

   451

uint RoadStop::AllocateBay()

   452

{

   453

	assert(HasFreeBay());

   454

   455

	/* Find the first free bay. If the bit is set, the bay is free. */

   456

	uint bay_nr = 0;

   457

	while (!HasBit(status, bay_nr)) bay_nr++;

   458

   459

	ClrBit(status, bay_nr);

   460

	return bay_nr;

   461

}

   462

   463

/**

   464

 * Allocates a bay in a drive-through road stop

   465

 * @param nr the number of the bay to allocate

   466

 */

   467

void RoadStop::AllocateDriveThroughBay(uint nr)

   468

{

   469

	assert(nr < MAX_BAY_COUNT);

   470

	ClrBit(status, nr);

   471

}

   472

   473

/**

   474

 * Frees the given bay

   475

 * @param nr the number of the bay to free

   476

 */

   477

void RoadStop::FreeBay(uint nr)

   478

{

   479

	assert(nr < MAX_BAY_COUNT);

   480

	SetBit(status, nr);

   481

}

   482

   483

   484

/** Checks whether the entrance of the road stop is occupied by a vehicle */

   485

bool RoadStop::IsEntranceBusy() const

   486

{

   487

	return HasBit(status, 7);