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 "player_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

    35

#include "table/sprites.h"

    36

#include "table/strings.h"

    37

    38

Station::Station(TileIndex tile)

    39

{

    40

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

    41

    42

	xy = tile;

    43

	airport_tile = dock_tile = train_tile = 0;

    44

	bus_stops = truck_stops = NULL;

    45

	had_vehicle_of_type = 0;

    46

	time_since_load = 255;

    47

	time_since_unload = 255;

    48

	delete_ctr = 0;

    49

	facilities = 0;

    50

    51

	last_vehicle_type = VEH_INVALID;

    52

    53

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

    54

	waiting_triggers = 0;

    55

}

    56

    57

/**

    58

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

    59

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

    60

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

    61

 * is OT_GOTO_DEPOT.

    62

 */

    63

Station::~Station()

    64

{

    65

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

    66

    67

	free(this->name);

    68

	free(this->speclist);

    69

    70

	if (CleaningPool()) return;

    71

    72

	while (!loading_vehicles.empty()) {

    73

		loading_vehicles.front()->LeaveStation();

    74

	}

    75

    76

	MarkDirty();

    77

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

    78

    79

	DeleteWindowById(WC_STATION_VIEW, index);

    80

    81

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

    82

	RemoveOrderFromAllVehicles(OT_GOTO_STATION, index);

    83

    84

	/* Subsidies need removal as well */

    85

	DeleteSubsidyWithStation(index);

    86

    87

	xy = 0;

    88

    89

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

    90

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

    91

	}

    92

}

    93

    94

    95

/**

    96

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

    97

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

    98

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

    99

 */

   100

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

   101

{

   102

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

   103

   104

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

   105

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

   106

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

   107

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

   108

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

   109

   110

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

   111

		break;

   112

	}

   113

   114

	return rs;

   115

}

   116

   117

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

   118

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

   119

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

   120

{

   121

	if (facilities == 0) {

   122

		xy = facil_xy;

   123

		random_bits = Random();

   124

	}

   125

	facilities |= new_facility_bit;

   126

	owner = _current_player;

   127

	build_date = _date;

   128

}

   129

   130

void Station::MarkDirty() const

   131

{

   132

	if (sign.width_1 != 0) {

   133

		InvalidateWindowWidget(WC_STATION_VIEW, index, SVW_CAPTION);

   134

   135

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

   136

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

   137

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

   138

		MarkAllViewportsDirty(

   139

			sign.left - 6,

   140

			sign.top,

   141

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

   142

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

   143

	}

   144

}

   145

   146

void Station::MarkTilesDirty(bool cargo_change) const

   147

{

   148

	TileIndex tile = train_tile;

   149

	int w, h;

   150

   151

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

   152

	if (tile == 0) return;

   153

   154

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

   155

	 * around. */

   156

	if (cargo_change) {

   157

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

   158

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

   159

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

   160

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

   161

	}

   162

   163

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

   164

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

   165

			if (TileBelongsToRailStation(tile)) {

   166

				MarkTileDirtyByTile(tile);

   167

			}

   168

			tile += TileDiffXY(1, 0);

   169

		}

   170

		tile += TileDiffXY(-w, 1);

   171

	}

   172

}

   173

   174

bool Station::TileBelongsToRailStation(TileIndex tile) const

   175

{

   176

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

   177

}

   178

   179

/** Obtain the length of a platform

   180

 * @pre tile must be a railway station tile

   181

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

   182

 * @return The length of the platform

   183

 */

   184

uint Station::GetPlatformLength(TileIndex tile) const

   185

{

   186

	TileIndex t;

   187

	TileIndexDiff delta;

   188

	uint len = 0;

   189

	assert(TileBelongsToRailStation(tile));

   190

   191

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

   192

   193

	t = tile;

   194

	do {

   195

		t -= delta;

   196

		len++;

   197

	} while (IsCompatibleTrainStationTile(t, tile));

   198

   199

	t = tile;

   200

	do {

   201

		t += delta;

   202

		len++;

   203

	} while (IsCompatibleTrainStationTile(t, tile));

   204

   205

	return len - 1;

   206

}

   207

   208

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

   209

 * the given tile.

   210

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

   211

 * @param dir The direction in which to search.

   212

 * @return The platform length

   213

 */

   214

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

   215

{

   216

	TileIndex start_tile = tile;

   217

	uint length = 0;

   218

	assert(IsRailwayStationTile(tile));

   219

	assert(dir < DIAGDIR_END);

   220

   221

	do {

   222

		length ++;

   223

		tile += TileOffsByDiagDir(dir);

   224

	} while (IsCompatibleTrainStationTile(tile, start_tile));

   225

   226

	return length;

   227

}

   228

   229

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

   230

 * @todo Ditch this encoding of buoys

   231

 */

   232

bool Station::IsBuoy() const

   233

{

   234

	return (had_vehicle_of_type & HVOT_BUOY) != 0;

   235

}

   236

   237

   238

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

   239

/*                     StationRect implementation                       */

   240

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

   241

   242

StationRect::StationRect()

   243

{

   244

	MakeEmpty();

   245

}

   246

   247

void StationRect::MakeEmpty()

   248

{

   249

	left = top = right = bottom = 0;

   250

}

   251

   252

/**

   253

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

   254

 * the station rectangle.

   255

 * @note x and y are in Tile coordinates

   256

 * @param x X coordinate

   257

 * @param y Y coordinate

   258

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

   259

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

   260

 */

   261

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

   262

{

   263

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

   264

}

   265

   266

bool StationRect::IsEmpty() const

   267

{

   268

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

   269

}

   270

   271

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

   272

{

   273

	int x = TileX(tile);

   274

	int y = TileY(tile);

   275

	if (IsEmpty()) {

   276

		/* we are adding the first station tile */

   277

		left = right = x;

   278

		top = bottom = y;

   279

   280

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

   281

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

   282

		/* make new spread-out rectangle */

   283

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

   284

   285

		/* check new rect dimensions against preset max */

   286

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

   287

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

   288

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

   289

			assert(mode != ADD_TRY);

   290

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   291

			return false;

   292

		}

   293

   294

		/* spread-out ok, return true */

   295

		if (mode != ADD_TEST) {

   296

			/* we should update the station rect */

   297

			*this = new_rect;

   298

		}

   299

	} else {

   300

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

   301

	}

   302

	return true;

   303

}

   304

   305

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

   306

{

   307

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

   308

}

   309

   310

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

   311

{

   312

	TileIndex top_left = TileXY(left_a, top_a);

   313

	int width = right_a - left_a + 1;

   314

	int height = bottom_a - top_a + 1;

   315

   316

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   317

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

   318

	END_TILE_LOOP(tile, width, height, top_left);

   319

   320

	return false;

   321

}

   322

   323

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

   324

{

   325

	int x = TileX(tile);

   326

	int y = TileY(tile);

   327

   328

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

   329

	 * and try to reduce the rect by this edge

   330

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

   331

	for (;;) {

   332

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

   333

		bool left_edge = (x == left);

   334

		bool right_edge = (x == right);

   335

		bool top_edge = (y == top);

   336

		bool bottom_edge = (y == bottom);

   337

   338

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

   339

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

   340

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

   341

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

   342

   343

		if (reduce_x) {

   344

			/* reduce horizontally */

   345

			if (left_edge) {

   346

				/* move left edge right */

   347

				left = x = x + 1;

   348

			} else {

   349

				/* move right edge left */

   350

				right = x = x - 1;

   351

			}

   352

		}

   353

		if (reduce_y) {

   354

			/* reduce vertically */

   355

			if (top_edge) {

   356

				/* move top edge down */

   357

				top = y = y + 1;

   358

			} else {

   359

				/* move bottom edge up */

   360

				bottom = y = y - 1;

   361

			}

   362

		}

   363

   364

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

   365

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

   366

			MakeEmpty();

   367

			return true; // empty remaining rect

   368

		}

   369

	}

   370

	return false; // non-empty remaining rect

   371

}

   372

   373

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

   374

{

   375

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

   376

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

   377

   378

	bool empty = AfterRemoveTile(st, tile);

   379

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

   380

	return empty;

   381

}

   382

   383

StationRect& StationRect::operator = (Rect src)

   384

{

   385

	left = src.left;

   386

	top = src.top;

   387

	right = src.right;

   388

	bottom = src.bottom;

   389

	return *this;

   390

}

   391

   392

   393

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

   394

/*                     RoadStop implementation                          */

   395

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

   396

   397

/** Initializes a RoadStop */

   398

RoadStop::RoadStop(TileIndex tile) :

   399

	xy(tile),

   400

	status(3), // stop is free

   401

	num_vehicles(0),

   402

	next(NULL)

   403

{

   404

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

   405

}

   406

   407

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

   408

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

   409

  */

   410

RoadStop::~RoadStop()

   411

{

   412

	if (CleaningPool()) return;

   413

   414

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

   415

	if (num_vehicles != 0) {

   416

		Vehicle *v;

   417

   418

		FOR_ALL_VEHICLES(v) {

   419

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

   420

		}

   421

	}

   422

	assert(num_vehicles == 0);

   423

   424

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

   425

   426

	xy = 0;

   427

}

   428

   429

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

   430

bool RoadStop::HasFreeBay() const

   431

{

   432

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

   433

}

   434

   435

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

   436

bool RoadStop::IsFreeBay(uint nr) const

   437

{

   438

	assert(nr < MAX_BAY_COUNT);

   439

	return HasBit(status, nr);

   440

}

   441

   442

/**

   443

 * Allocates a bay

   444

 * @return the allocated bay number

   445

 * @pre this->HasFreeBay()

   446

 */

   447

uint RoadStop::AllocateBay()

   448

{

   449

	assert(HasFreeBay());

   450

   451

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

   452

	uint bay_nr = 0;

   453

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

   454

   455

	ClrBit(status, bay_nr);

   456

	return bay_nr;

   457

}

   458

   459

/**

   460

 * Allocates a bay in a drive-through road stop

   461

 * @param nr the number of the bay to allocate

   462

 */

   463

void RoadStop::AllocateDriveThroughBay(uint nr)

   464

{

   465

	assert(nr < MAX_BAY_COUNT);

   466

	ClrBit(status, nr);

   467

}

   468

   469

/**

   470

 * Frees the given bay

   471

 * @param nr the number of the bay to free

   472

 */

   473

void RoadStop::FreeBay(uint nr)

   474

{

   475

	assert(nr < MAX_BAY_COUNT);

   476

	SetBit(status, nr);

   477

}

   478

   479

   480

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

   481

bool RoadStop::IsEntranceBusy() const

   482

{

   483

	return HasBit(status, 7);

   484

}

   485

   486

/** Makes an entrance occupied or free */