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 "station.h"

    15

#include "gfx.h"

    16

#include "viewport.h"

    17

#include "command.h"

    18

#include "town.h"

    19

#include "vehicle.h"

    20

#include "news.h"

    21

#include "saveload.h"

    22

#include "economy.h"

    23

#include "player.h"

    24

#include "airport.h"

    25

#include "sprite.h"

    26

#include "depot.h"

    27

#include "train.h"

    28

#include "water_map.h"

    29

#include "industry_map.h"

    30

#include "newgrf_callbacks.h"

    31

#include "newgrf_station.h"

    32

#include "yapf/yapf.h"

    33

#include "date.h"

    34

#include "helpers.hpp"

    35

#include "cargotype.h"

    36

#include "roadveh.h"

    37

#include "station_gui.h"

    38

    39

Station::Station(TileIndex tile)

    40

{

    41

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

    42

    43

	xy = tile;

    44

	airport_tile = dock_tile = train_tile = 0;

    45

	bus_stops = truck_stops = NULL;

    46

	had_vehicle_of_type = 0;

    47

	time_since_load = 255;

    48

	time_since_unload = 255;

    49

	delete_ctr = 0;

    50

	facilities = 0;

    51

    52

	last_vehicle_type = VEH_INVALID;

    53

    54

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

    55

	waiting_triggers = 0;

    56

}

    57

    58

/**

    59

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

    60

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

    61

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

    62

 * is OT_GOTO_DEPOT.

    63

 */

    64

Station::~Station()

    65

{

    66

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

    67

    68

	DeleteName(this->string_id);

    69

	free(this->speclist);

    70

    71

	if (CleaningPool()) return;

    72

    73

	while (!loading_vehicles.empty()) {

    74

		loading_vehicles.front()->LeaveStation();

    75

	}

    76

    77

	MarkDirty();

    78

	RebuildStationLists();

    79

	InvalidateWindowClasses(WC_STATION_LIST);

    80

    81

	DeleteWindowById(WC_STATION_VIEW, index);

    82

    83

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

    84

	RemoveOrderFromAllVehicles(OT_GOTO_STATION, index);

    85

    86

	/* Subsidies need removal as well */

    87

	DeleteSubsidyWithStation(index);

    88

    89

	xy = 0;

    90

    91

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

    92

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

    93

	}

    94

}

    95

    96

    97

/**

    98

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

    99

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

   100

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

   101

 */

   102

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

   103

{

   104

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

   105

   106

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

   107

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

   108

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

   109

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

   110

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

   111

   112

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

   113

		break;

   114

	}

   115

   116

	return rs;

   117

}

   118

   119

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

   120

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

   121

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

   122

{

   123

	if (facilities == 0) {

   124

		xy = facil_xy;

   125

		random_bits = Random();

   126

	}

   127

	facilities |= new_facility_bit;

   128

	owner = _current_player;

   129

	build_date = _date;

   130

}

   131

   132

void Station::MarkDirty() const

   133

{

   134

	if (sign.width_1 != 0) {

   135

		InvalidateWindowWidget(WC_STATION_VIEW, index, SVW_CAPTION);

   136

   137

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

   138

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

   139

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

   140

		MarkAllViewportsDirty(

   141

			sign.left - 6,

   142

			sign.top,

   143

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

   144

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

   145

	}

   146

}

   147

   148

void Station::MarkTilesDirty(bool cargo_change) const

   149

{

   150

	TileIndex tile = train_tile;

   151

	int w, h;

   152

   153

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

   154

	if (tile == 0) return;

   155

   156

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

   157

	 * around. */

   158

	if (cargo_change) {

   159

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

   160

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

   161

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

   162

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

   163

	}

   164

   165

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

   166

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

   167

			if (TileBelongsToRailStation(tile)) {

   168

				MarkTileDirtyByTile(tile);

   169

			}

   170

			tile += TileDiffXY(1, 0);

   171

		}

   172

		tile += TileDiffXY(-w, 1);

   173

	}

   174

}

   175

   176

bool Station::TileBelongsToRailStation(TileIndex tile) const

   177

{

   178

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

   179

}

   180

   181

/** Obtain the length of a platform

   182

 * @pre tile must be a railway station tile

   183

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

   184

 * @return The length of the platform

   185

 */

   186

uint Station::GetPlatformLength(TileIndex tile) const

   187

{

   188

	TileIndex t;

   189

	TileIndexDiff delta;

   190

	uint len = 0;

   191

	assert(TileBelongsToRailStation(tile));

   192

   193

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

   194

   195

	t = tile;

   196

	do {

   197

		t -= delta;

   198

		len++;

   199

	} while (IsCompatibleTrainStationTile(t, tile));

   200

   201

	t = tile;

   202

	do {

   203

		t += delta;

   204

		len++;

   205

	} while (IsCompatibleTrainStationTile(t, tile));

   206

   207

	return len - 1;

   208

}

   209

   210

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

   211

 * the given tile.

   212

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

   213

 * @param dir The direction in which to search.

   214

 * @return The platform length

   215

 */

   216

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

   217

{

   218

	TileIndex start_tile = tile;

   219

	uint length = 0;

   220

	assert(IsRailwayStationTile(tile));

   221

	assert(dir < DIAGDIR_END);

   222

   223

	do {

   224

		length ++;

   225

		tile += TileOffsByDiagDir(dir);

   226

	} while (IsCompatibleTrainStationTile(tile, start_tile));

   227

   228

	return length;

   229

}

   230

   231

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

   232

 * @todo Ditch this encoding of buoys

   233

 */

   234

bool Station::IsBuoy() const

   235

{

   236

	return (had_vehicle_of_type & HVOT_BUOY) != 0;

   237

}

   238

   239

   240

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

   241

/*                     StationRect implementation                       */

   242

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

   243

   244

StationRect::StationRect()

   245

{

   246

	MakeEmpty();

   247

}

   248

   249

void StationRect::MakeEmpty()

   250

{

   251

	left = top = right = bottom = 0;

   252

}

   253

   254

/**

   255

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

   256

 * the station rectangle.

   257

 * @note x and y are in Tile coordinates

   258

 * @param x X coordinate

   259

 * @param y Y coordinate

   260

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

   261

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

   262

 */

   263

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

   264

{

   265

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

   266

}

   267

   268

bool StationRect::IsEmpty() const

   269

{

   270

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

   271

}

   272

   273

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

   274

{

   275

	int x = TileX(tile);

   276

	int y = TileY(tile);

   277

	if (IsEmpty()) {

   278

		/* we are adding the first station tile */

   279

		left = right = x;

   280

		top = bottom = y;

   281

   282

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

   283

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

   284

		/* make new spread-out rectangle */

   285

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

   286

   287

		/* check new rect dimensions against preset max */

   288

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

   289

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

   290

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

   291

			assert(mode != ADD_TRY);

   292

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   293

			return false;

   294

		}

   295

   296

		/* spread-out ok, return true */

   297

		if (mode != ADD_TEST) {

   298

			/* we should update the station rect */

   299

			*this = new_rect;

   300

		}

   301

	} else {

   302

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

   303

	}

   304

	return true;

   305

}

   306

   307

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

   308

{

   309

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

   310

}

   311

   312

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

   313

{

   314

	TileIndex top_left = TileXY(left_a, top_a);

   315

	int width = right_a - left_a + 1;

   316

	int height = bottom_a - top_a + 1;

   317

   318

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   319

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

   320

	END_TILE_LOOP(tile, width, height, top_left);

   321

   322

	return false;

   323

}

   324

   325

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

   326

{

   327

	int x = TileX(tile);

   328

	int y = TileY(tile);

   329

   330

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

   331

	 * and try to reduce the rect by this edge

   332

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

   333

	for (;;) {

   334

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

   335

		bool left_edge = (x == left);

   336

		bool right_edge = (x == right);

   337

		bool top_edge = (y == top);

   338

		bool bottom_edge = (y == bottom);

   339

   340

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

   341

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

   342

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

   343

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

   344

   345

		if (reduce_x) {

   346

			/* reduce horizontally */

   347

			if (left_edge) {

   348

				/* move left edge right */

   349

				left = x = x + 1;

   350

			} else {

   351

				/* move right edge left */

   352

				right = x = x - 1;

   353

			}

   354

		}

   355

		if (reduce_y) {

   356

			/* reduce vertically */

   357

			if (top_edge) {

   358

				/* move top edge down */

   359

				top = y = y + 1;

   360

			} else {

   361

				/* move bottom edge up */

   362

				bottom = y = y - 1;

   363

			}

   364

		}

   365

   366

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

   367

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

   368

			MakeEmpty();

   369

			return true; // empty remaining rect

   370

		}

   371

	}

   372

	return false; // non-empty remaining rect

   373

}

   374

   375

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

   376

{

   377

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

   378

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

   379

   380

	bool empty = AfterRemoveTile(st, tile);

   381

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

   382

	return empty;

   383

}

   384

   385

StationRect& StationRect::operator = (Rect src)

   386

{

   387

	left = src.left;

   388

	top = src.top;

   389

	right = src.right;

   390

	bottom = src.bottom;

   391

	return *this;

   392

}

   393

   394

   395

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

   396

/*                     RoadStop implementation                          */

   397

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

   398

   399

/** Initializes a RoadStop */

   400

RoadStop::RoadStop(TileIndex tile) :

   401

	xy(tile),

   402

	status(3), // stop is free

   403

	num_vehicles(0),

   404

	next(NULL)

   405

{

   406

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

   407

}

   408

   409

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

   410

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

   411

  */

   412

RoadStop::~RoadStop()

   413

{

   414

	if (CleaningPool()) return;

   415

   416

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

   417

	if (num_vehicles != 0) {

   418

		Vehicle *v;

   419

   420

		FOR_ALL_VEHICLES(v) {

   421

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

   422

		}

   423

	}

   424

	assert(num_vehicles == 0);

   425

   426

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

   427

   428

	xy = 0;

   429

}

   430

   431

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

   432

bool RoadStop::HasFreeBay() const

   433

{

   434

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

   435

}

   436

   437

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

   438

bool RoadStop::IsFreeBay(uint nr) const

   439

{

   440

	assert(nr < MAX_BAY_COUNT);

   441

	return HasBit(status, nr);

   442

}

   443

   444

/**

   445

 * Allocates a bay

   446

 * @return the allocated bay number

   447

 * @pre this->HasFreeBay()

   448

 */

   449

uint RoadStop::AllocateBay()

   450

{

   451

	assert(HasFreeBay());

   452

   453

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

   454

	uint bay_nr = 0;

   455

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

   456

   457

	ClrBit(status, bay_nr);

   458

	return bay_nr;

   459

}

   460

   461

/**

   462

 * Allocates a bay in a drive-through road stop

   463

 * @param nr the number of the bay to allocate

   464

 */

   465

void RoadStop::AllocateDriveThroughBay(uint nr)

   466

{

   467

	assert(nr < MAX_BAY_COUNT);

   468

	ClrBit(status, nr);

   469

}

   470

   471

/**

   472

 * Frees the given bay

   473

 * @param nr the number of the bay to free

   474

 */

   475

void RoadStop::FreeBay(uint nr)

   476

{

   477

	assert(nr < MAX_BAY_COUNT);

   478

	SetBit(status, nr);

   479

}

   480

   481

   482

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

   483

bool RoadStop::IsEntranceBusy() const

   484

{

   485

	return HasBit(status, 7);

   486

}

   487

   488

/** Makes an entrance occupied or free */

   489

void RoadStop::SetEntranceBusy(bool busy)

   490

{

   491

	SB(status, 7, 1, busy);

   492

}

   493

   494

/**