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

    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

    72

	MarkDirty();

    73

	RebuildStationLists();

    74

	InvalidateWindowClasses(WC_STATION_LIST);

    75

    76

	DeleteWindowById(WC_STATION_VIEW, index);

    77

    78

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

    79

	RemoveOrderFromAllVehicles(OT_GOTO_STATION, index);

    80

    81

	/* Subsidies need removal as well */

    82

	DeleteSubsidyWithStation(index);

    83

    84

	xy = 0;

    85

    86

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

    87

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

    88

	}

    89

}

    90

    91

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

    92

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

    93

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

    94

{

    95

	if (facilities == 0) {

    96

		xy = facil_xy;

    97

		random_bits = Random();

    98

	}

    99

	facilities |= new_facility_bit;

   100

	owner = _current_player;

   101

	build_date = _date;

   102

}

   103

   104

void Station::MarkDirty() const

   105

{

   106

	if (sign.width_1 != 0) {

   107

		InvalidateWindowWidget(WC_STATION_VIEW, index, 1);

   108

   109

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

   110

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

   111

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

   112

		MarkAllViewportsDirty(

   113

			sign.left - 6,

   114

			sign.top,

   115

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

   116

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

   117

	}

   118

}

   119

   120

void Station::MarkTilesDirty(bool cargo_change) const

   121

{

   122

	TileIndex tile = train_tile;

   123

	int w, h;

   124

   125

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

   126

	if (tile == 0) return;

   127

   128

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

   129

	 * around. */

   130

	if (cargo_change) {

   131

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

   132

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

   133

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

   134

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

   135

	}

   136

   137

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

   138

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

   139

			if (TileBelongsToRailStation(tile)) {

   140

				MarkTileDirtyByTile(tile);

   141

			}

   142

			tile += TileDiffXY(1, 0);

   143

		}

   144

		tile += TileDiffXY(-w, 1);

   145

	}

   146

}

   147

   148

bool Station::TileBelongsToRailStation(TileIndex tile) const

   149

{

   150

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

   151

}

   152

   153

/** Obtain the length of a platform

   154

 * @pre tile must be a railway station tile

   155

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

   156

 * @return The length of the platform

   157

 */

   158

uint Station::GetPlatformLength(TileIndex tile) const

   159

{

   160

	TileIndex t;

   161

	TileIndexDiff delta;

   162

	uint len = 0;

   163

	assert(TileBelongsToRailStation(tile));

   164

   165

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

   166

   167

	t = tile;

   168

	do {

   169

		t -= delta;

   170

		len++;

   171

	} while (IsCompatibleTrainStationTile(t, tile));

   172

   173

	t = tile;

   174

	do {

   175

		t += delta;

   176

		len++;

   177

	} while (IsCompatibleTrainStationTile(t, tile));

   178

   179

	return len - 1;

   180

}

   181

   182

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

   183

 * the given tile.

   184

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

   185

 * @param dir The direction in which to search.

   186

 * @return The platform length

   187

 */

   188

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

   189

{

   190

	TileIndex start_tile = tile;

   191

	uint length = 0;

   192

	assert(IsRailwayStationTile(tile));

   193

	assert(dir < DIAGDIR_END);

   194

   195

	do {

   196

		length ++;

   197

		tile += TileOffsByDiagDir(dir);

   198

	} while (IsCompatibleTrainStationTile(tile, start_tile));

   199

   200

	return length;

   201

}

   202

   203

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

   204

 * @todo Ditch this encoding of buoys

   205

 */

   206

bool Station::IsBuoy() const

   207

{

   208

	return (had_vehicle_of_type & HVOT_BUOY) != 0;

   209

}

   210

   211

/** Determines whether a station exists

   212

 * @todo replace 0 by INVALID_TILE

   213

 */

   214

bool Station::IsValid() const

   215

{

   216

	return xy != 0;

   217

}

   218

   219

   220

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

   221

/*                     StationRect implementation                       */

   222

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

   223

   224

StationRect::StationRect()

   225

{

   226

	MakeEmpty();

   227

}

   228

   229

void StationRect::MakeEmpty()

   230

{

   231

	left = top = right = bottom = 0;

   232

}

   233

   234

/**

   235

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

   236

 * the station rectangle.

   237

 * @note x and y are in Tile coordinates

   238

 * @param x X coordinate

   239

 * @param y Y coordinate

   240

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

   241

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

   242

 */

   243

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

   244

{

   245

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

   246

}

   247

   248

bool StationRect::IsEmpty() const

   249

{

   250

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

   251

}

   252

   253

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

   254

{

   255

	int x = TileX(tile);

   256

	int y = TileY(tile);

   257

	if (IsEmpty()) {

   258

		/* we are adding the first station tile */

   259

		left = right = x;

   260

		top = bottom = y;

   261

   262

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

   263

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

   264

		/* make new spread-out rectangle */

   265

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

   266

   267

		/* check new rect dimensions against preset max */

   268

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

   269

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

   270

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

   271

			assert(mode != ADD_TRY);

   272

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   273

			return false;

   274

		}

   275

   276

		/* spread-out ok, return true */

   277

		if (mode != ADD_TEST) {

   278

			/* we should update the station rect */

   279

			*this = new_rect;

   280

		}

   281

	} else {

   282

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

   283

	}

   284

	return true;

   285

}

   286

   287

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

   288

{

   289

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

   290

}

   291

   292

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

   293

{

   294

	TileIndex top_left = TileXY(left_a, top_a);

   295

	int width = right_a - left_a + 1;

   296

	int height = bottom_a - top_a + 1;

   297

   298

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   299

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

   300

	END_TILE_LOOP(tile, width, height, top_left);

   301

   302

	return false;

   303

}

   304

   305

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

   306

{

   307

	int x = TileX(tile);

   308

	int y = TileY(tile);

   309

   310

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

   311

	 * and try to reduce the rect by this edge

   312

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

   313

	for (;;) {

   314

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

   315

		bool left_edge = (x == left);

   316

		bool right_edge = (x == right);

   317

		bool top_edge = (y == top);

   318

		bool bottom_edge = (y == bottom);

   319

   320

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

   321

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

   322

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

   323

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

   324

   325

		if (reduce_x) {

   326

			/* reduce horizontally */

   327

			if (left_edge) {

   328

				/* move left edge right */

   329

				left = x = x + 1;

   330

			} else {

   331

				/* move right edge left */

   332

				right = x = x - 1;

   333

			}

   334

		}

   335

		if (reduce_y) {

   336

			/* reduce vertically */

   337

			if (top_edge) {

   338

				/* move top edge down */

   339

				top = y = y + 1;

   340

			} else {

   341

				/* move bottom edge up */

   342

				bottom = y = y - 1;

   343

			}

   344

		}

   345

   346

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

   347

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

   348

			MakeEmpty();

   349

			return true; // empty remaining rect

   350

		}

   351

	}

   352

	return false; // non-empty remaining rect

   353

}

   354

   355

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

   356

{

   357

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

   358

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

   359

   360

	bool empty = AfterRemoveTile(st, tile);

   361

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

   362

	return empty;

   363

}

   364

   365

StationRect& StationRect::operator = (Rect src)

   366

{

   367

	left = src.left;

   368

	top = src.top;

   369

	right = src.right;

   370

	bottom = src.bottom;

   371

	return *this;

   372

}

   373

   374

   375

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

   376

/*                     RoadStop implementation                          */

   377

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

   378

   379

/** Initializes a RoadStop */

   380

RoadStop::RoadStop(TileIndex tile) :

   381

	xy(tile),

   382

	status(3), // stop is free

   383

	num_vehicles(0),

   384

	next(NULL)

   385

{

   386

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

   387

}

   388

   389

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

   390

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

   391

  */

   392

RoadStop::~RoadStop()

   393

{

   394

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

   395

	if (num_vehicles != 0) {

   396

		Vehicle *v;

   397

   398

		FOR_ALL_VEHICLES(v) {

   399

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

   400

		}

   401

	}

   402

	assert(num_vehicles == 0);

   403

   404

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

   405

   406

	xy = 0;

   407

}

   408

   409

/** Determines whether a RoadStop is a valid (i.e. existing) one */

   410

bool RoadStop::IsValid() const

   411

{

   412

	return xy != 0;

   413

}

   414

   415

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

   416

bool RoadStop::HasFreeBay() const

   417

{

   418

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

   419

}

   420

   421

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

   422

bool RoadStop::IsFreeBay(uint nr) const

   423

{

   424

	assert(nr < MAX_BAY_COUNT);

   425

	return HASBIT(status, nr);

   426

}

   427

   428

/**

   429

 * Allocates a bay

   430

 * @return the allocated bay number

   431

 * @pre this->HasFreeBay()

   432

 */

   433

uint RoadStop::AllocateBay()

   434

{

   435

	assert(HasFreeBay());

   436

   437

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

   438

	uint bay_nr = 0;

   439

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

   440

   441

	CLRBIT(status, bay_nr);

   442

	return bay_nr;

   443

}

   444

   445

/**

   446

 * Allocates a bay in a drive-through road stop

   447

 * @param nr the number of the bay to allocate

   448

 */

   449

void RoadStop::AllocateDriveThroughBay(uint nr)

   450

{

   451

	assert(nr < MAX_BAY_COUNT);

   452

	CLRBIT(status, nr);

   453

}

   454

   455

/**

   456

 * Frees the given bay

   457

 * @param nr the number of the bay to free

   458

 */

   459

void RoadStop::FreeBay(uint nr)

   460

{

   461

	assert(nr < MAX_BAY_COUNT);

   462

	SETBIT(status, nr);

   463

}

   464

   465

   466

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

   467

bool RoadStop::IsEntranceBusy() const

   468

{

   469

	return HASBIT(status, 7);

   470

}

   471

   472

/** Makes an entrance occupied or free */

   473

void RoadStop::SetEntranceBusy(bool busy)

   474

{

   475

	SB(status, 7, 1, busy);

   476

}