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

    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

	DeleteName(this->string_id);

    70

	free(this->speclist);

    71

    72

	if (CleaningPool()) return;

    73

    74

	while (!loading_vehicles.empty()) {

    75

		loading_vehicles.front()->LeaveStation();

    76

	}

    77

    78

	MarkDirty();

    79

	RebuildStationLists();

    80

	InvalidateWindowClasses(WC_STATION_LIST);

    81

    82

	DeleteWindowById(WC_STATION_VIEW, index);

    83

    84

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

    85

	RemoveOrderFromAllVehicles(OT_GOTO_STATION, index);

    86

    87

	/* Subsidies need removal as well */

    88

	DeleteSubsidyWithStation(index);

    89

    90

	xy = 0;

    91

    92

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

    93

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

    94

	}

    95

}

    96

    97

    98

/**

    99

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

   100

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

   101

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

   102

 */

   103

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

   104

{

   105

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

   106

   107

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

   108

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

   109

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

   110

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

   111

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

   112

   113

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

   114

		break;

   115

	}

   116

   117

	return rs;

   118

}

   119

   120

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

   121

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

   122

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

   123

{

   124

	if (facilities == 0) {

   125

		xy = facil_xy;

   126

		random_bits = Random();

   127

	}

   128

	facilities |= new_facility_bit;

   129

	owner = _current_player;

   130

	build_date = _date;

   131

}

   132

   133

void Station::MarkDirty() const

   134

{

   135

	if (sign.width_1 != 0) {

   136

		InvalidateWindowWidget(WC_STATION_VIEW, index, 1);

   137

   138

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

   139

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

   140

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

   141

		MarkAllViewportsDirty(

   142

			sign.left - 6,

   143

			sign.top,

   144

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

   145

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

   146

	}

   147

}

   148

   149

void Station::MarkTilesDirty(bool cargo_change) const

   150

{

   151

	TileIndex tile = train_tile;

   152

	int w, h;

   153

   154

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

   155

	if (tile == 0) return;

   156

   157

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

   158

	 * around. */

   159

	if (cargo_change) {

   160

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

   161

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

   162

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

   163

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

   164

	}

   165

   166

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

   167

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

   168

			if (TileBelongsToRailStation(tile)) {

   169

				MarkTileDirtyByTile(tile);

   170

			}

   171

			tile += TileDiffXY(1, 0);

   172

		}

   173

		tile += TileDiffXY(-w, 1);

   174

	}

   175

}

   176

   177

bool Station::TileBelongsToRailStation(TileIndex tile) const

   178

{

   179

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

   180

}

   181

   182

/** Obtain the length of a platform

   183

 * @pre tile must be a railway station tile

   184

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

   185

 * @return The length of the platform

   186

 */

   187

uint Station::GetPlatformLength(TileIndex tile) const

   188

{

   189

	TileIndex t;

   190

	TileIndexDiff delta;

   191

	uint len = 0;

   192

	assert(TileBelongsToRailStation(tile));

   193

   194

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

   195

   196

	t = tile;

   197

	do {

   198

		t -= delta;

   199

		len++;

   200

	} while (IsCompatibleTrainStationTile(t, tile));

   201

   202

	t = tile;

   203

	do {

   204

		t += delta;

   205

		len++;

   206

	} while (IsCompatibleTrainStationTile(t, tile));

   207

   208

	return len - 1;

   209

}

   210

   211

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

   212

 * the given tile.

   213

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

   214

 * @param dir The direction in which to search.

   215

 * @return The platform length

   216

 */

   217

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

   218

{

   219

	TileIndex start_tile = tile;

   220

	uint length = 0;

   221

	assert(IsRailwayStationTile(tile));

   222

	assert(dir < DIAGDIR_END);

   223

   224

	do {

   225

		length ++;

   226

		tile += TileOffsByDiagDir(dir);

   227

	} while (IsCompatibleTrainStationTile(tile, start_tile));

   228

   229

	return length;

   230

}

   231

   232

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

   233

 * @todo Ditch this encoding of buoys

   234

 */

   235

bool Station::IsBuoy() const

   236

{

   237

	return (had_vehicle_of_type & HVOT_BUOY) != 0;

   238

}

   239

   240

   241

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

   242

/*                     StationRect implementation                       */

   243

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

   244

   245

StationRect::StationRect()

   246

{

   247

	MakeEmpty();

   248

}

   249

   250

void StationRect::MakeEmpty()

   251

{

   252

	left = top = right = bottom = 0;

   253

}

   254

   255

/**

   256

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

   257

 * the station rectangle.

   258

 * @note x and y are in Tile coordinates

   259

 * @param x X coordinate

   260

 * @param y Y coordinate

   261

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

   262

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

   263

 */

   264

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

   265

{

   266

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

   267

}

   268

   269

bool StationRect::IsEmpty() const

   270

{

   271

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

   272

}

   273

   274

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

   275

{

   276

	int x = TileX(tile);

   277

	int y = TileY(tile);

   278

	if (IsEmpty()) {

   279

		/* we are adding the first station tile */

   280

		left = right = x;

   281

		top = bottom = y;

   282

   283

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

   284

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

   285

		/* make new spread-out rectangle */

   286

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

   287

   288

		/* check new rect dimensions against preset max */

   289

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

   290

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

   291

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

   292

			assert(mode != ADD_TRY);

   293

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   294

			return false;

   295

		}

   296

   297

		/* spread-out ok, return true */

   298

		if (mode != ADD_TEST) {

   299

			/* we should update the station rect */

   300

			*this = new_rect;

   301

		}

   302

	} else {

   303

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

   304

	}

   305

	return true;

   306

}

   307

   308

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

   309

{

   310

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

   311

}

   312

   313

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

   314

{

   315

	TileIndex top_left = TileXY(left_a, top_a);

   316

	int width = right_a - left_a + 1;

   317

	int height = bottom_a - top_a + 1;

   318

   319

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   320

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

   321

	END_TILE_LOOP(tile, width, height, top_left);

   322

   323

	return false;

   324

}

   325

   326

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

   327

{

   328

	int x = TileX(tile);

   329

	int y = TileY(tile);

   330

   331

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

   332

	 * and try to reduce the rect by this edge

   333

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

   334

	for (;;) {

   335

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

   336

		bool left_edge = (x == left);

   337

		bool right_edge = (x == right);

   338

		bool top_edge = (y == top);

   339

		bool bottom_edge = (y == bottom);

   340

   341

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

   342

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

   343

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

   344

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

   345

   346

		if (reduce_x) {

   347

			/* reduce horizontally */

   348

			if (left_edge) {

   349

				/* move left edge right */

   350

				left = x = x + 1;

   351

			} else {

   352

				/* move right edge left */

   353

				right = x = x - 1;

   354

			}

   355

		}

   356

		if (reduce_y) {

   357

			/* reduce vertically */

   358

			if (top_edge) {

   359

				/* move top edge down */

   360

				top = y = y + 1;

   361

			} else {

   362

				/* move bottom edge up */

   363

				bottom = y = y - 1;

   364

			}

   365

		}

   366

   367

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

   368

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

   369

			MakeEmpty();

   370

			return true; // empty remaining rect

   371

		}

   372

	}

   373

	return false; // non-empty remaining rect

   374

}

   375

   376

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

   377

{

   378

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

   379

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

   380

   381

	bool empty = AfterRemoveTile(st, tile);

   382

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

   383

	return empty;

   384

}

   385

   386

StationRect& StationRect::operator = (Rect src)

   387

{

   388

	left = src.left;

   389

	top = src.top;

   390

	right = src.right;

   391

	bottom = src.bottom;

   392

	return *this;

   393

}

   394

   395

   396

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

   397

/*                     RoadStop implementation                          */

   398

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

   399

   400

/** Initializes a RoadStop */

   401

RoadStop::RoadStop(TileIndex tile) :

   402

	xy(tile),

   403

	status(3), // stop is free

   404

	num_vehicles(0),

   405

	next(NULL)

   406

{

   407

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

   408

}

   409

   410

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

   411

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

   412

  */

   413

RoadStop::~RoadStop()

   414

{

   415

	if (CleaningPool()) return;

   416

   417

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

   418

	if (num_vehicles != 0) {

   419

		Vehicle *v;

   420

   421

		FOR_ALL_VEHICLES(v) {

   422

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

   423

		}

   424

	}

   425

	assert(num_vehicles == 0);

   426

   427

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

   428

   429

	xy = 0;

   430

}

   431

   432

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

   433

bool RoadStop::HasFreeBay() const

   434

{

   435

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

   436

}

   437

   438

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

   439

bool RoadStop::IsFreeBay(uint nr) const

   440

{

   441

	assert(nr < MAX_BAY_COUNT);

   442

	return HasBit(status, nr);

   443

}

   444

   445

/**

   446

 * Allocates a bay

   447

 * @return the allocated bay number

   448

 * @pre this->HasFreeBay()

   449

 */

   450

uint RoadStop::AllocateBay()

   451

{

   452

	assert(HasFreeBay());

   453

   454

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

   455

	uint bay_nr = 0;

   456

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

   457

   458

	ClrBit(status, bay_nr);

   459

	return bay_nr;

   460

}

   461

   462

/**

   463

 * Allocates a bay in a drive-through road stop

   464

 * @param nr the number of the bay to allocate

   465

 */

   466

void RoadStop::AllocateDriveThroughBay(uint nr)

   467

{

   468

	assert(nr < MAX_BAY_COUNT);

   469

	ClrBit(status, nr);

   470

}

   471

   472

/**

   473

 * Frees the given bay

   474

 * @param nr the number of the bay to free

   475

 */

   476

void RoadStop::FreeBay(uint nr)

   477

{

   478

	assert(nr < MAX_BAY_COUNT);

   479

	SetBit(status, nr);

   480

}

   481

   482

   483

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

   484

bool RoadStop::IsEntranceBusy() const

   485

{

   486

	return HasBit(status, 7);

   487

}