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

    67

	MarkDirty();

    68

	RebuildStationLists();

    69

	InvalidateWindowClasses(WC_STATION_LIST);

    70

    71

	DeleteWindowById(WC_STATION_VIEW, index);

    72

    73

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

    74

	RemoveOrderFromAllVehicles(OT_GOTO_STATION, index);

    75

    76

	/* Subsidies need removal as well */

    77

	DeleteSubsidyWithStation(index);

    78

    79

	xy = 0;

    80

    81

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

    82

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

    83

	}

    84

    86

}

    87

    89

{

    92

}

    93

    94

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

    95

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

    96

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

    97

{

    98

	if (facilities == 0) {

    99

		xy = facil_xy;

   100

		random_bits = Random();

   101

	}

   102

	facilities |= new_facility_bit;

   103

	owner = _current_player;

   104

	build_date = _date;

   105

}

   106

   107

void Station::MarkDirty() const

   108

{

   109

	if (sign.width_1 != 0) {

   110

		InvalidateWindowWidget(WC_STATION_VIEW, index, 1);

   111

   112

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

   113

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

   114

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

   115

		MarkAllViewportsDirty(

   116

			sign.left - 6,

   117

			sign.top,

   118

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

   119

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

   120

	}

   121

}

   122

   123

void Station::MarkTilesDirty(bool cargo_change) const

   124

{

   125

	TileIndex tile = train_tile;

   126

	int w, h;

   127

   128

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

   129

	if (tile == 0) return;

   130

   131

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

   132

	 * around. */

   133

	if (cargo_change) {

   134

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

   135

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

   136

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

   137

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

   138

	}

   139

   140

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

   141

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

   142

			if (TileBelongsToRailStation(tile)) {

   143

				MarkTileDirtyByTile(tile);

   144

			}

   145

			tile += TileDiffXY(1, 0);

   146

		}

   147

		tile += TileDiffXY(-w, 1);

   148

	}

   149

}

   150

   151

bool Station::TileBelongsToRailStation(TileIndex tile) const

   152

{

   153

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

   154

}

   155

   156

/** Obtain the length of a platform

   157

 * @pre tile must be a railway station tile

   158

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

   159

 * @return The length of the platform

   160

 */

   161

uint Station::GetPlatformLength(TileIndex tile) const

   162

{

   163

	TileIndex t;

   164

	TileIndexDiff delta;

   165

	uint len = 0;

   166

	assert(TileBelongsToRailStation(tile));

   167

   168

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

   169

   170

	t = tile;

   171

	do {

   172

		t -= delta;

   173

		len++;

   174

	} while (IsCompatibleTrainStationTile(t, tile));

   175

   176

	t = tile;

   177

	do {

   178

		t += delta;

   179

		len++;

   180

	} while (IsCompatibleTrainStationTile(t, tile));

   181

   182

	return len - 1;

   183

}

   184

   185

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

   186

 * the given tile.

   187

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

   188

 * @param dir The direction in which to search.

   189

 * @return The platform length

   190

 */

   191

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

   192

{

   193

	TileIndex start_tile = tile;

   194

	uint length = 0;

   195

	assert(IsRailwayStationTile(tile));

   196

	assert(dir < DIAGDIR_END);

   197

   198

	do {

   199

		length ++;

   200

		tile += TileOffsByDiagDir(dir);

   201

	} while (IsCompatibleTrainStationTile(tile, start_tile));

   202

   203

	return length;

   204

}

   205

   206

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

   207

 * @todo Ditch this encoding of buoys

   208

 */

   209

bool Station::IsBuoy() const

   210

{

   211

	return (had_vehicle_of_type & HVOT_BUOY) != 0;

   212

}

   213

   214

/** Determines whether a station exists

   215

 * @todo replace 0 by INVALID_TILE

   216

 */

   217

bool Station::IsValid() const

   218

{

   219

	return xy != 0;

   220

}

   221

   222

   223

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

   224

/*                     StationRect implementation                       */

   225

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

   226

   227

StationRect::StationRect()

   228

{

   229

	MakeEmpty();

   230

}

   231

   232

void StationRect::MakeEmpty()

   233

{

   234

	left = top = right = bottom = 0;

   235

}

   236

   237

/**

   238

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

   239

 * the station rectangle.

   240

 * @note x and y are in Tile coordinates

   241

 * @param x X coordinate

   242

 * @param y Y coordinate

   243

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

   244

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

   245

 */

   246

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

   247

{

   248

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

   249

}

   250

   251

bool StationRect::IsEmpty() const

   252

{

   253

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

   254

}

   255

   256

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

   257

{

   258

	int x = TileX(tile);

   259

	int y = TileY(tile);

   260

	if (IsEmpty()) {

   261

		/* we are adding the first station tile */

   262

		left = right = x;

   263

		top = bottom = y;

   264

   265

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

   266

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

   267

		/* make new spread-out rectangle */

   268

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

   269

   270

		/* check new rect dimensions against preset max */

   271

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

   272

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

   273

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

   274

			assert(mode != ADD_TRY);

   275

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   276

			return false;

   277

		}

   278

   279

		/* spread-out ok, return true */

   280

		if (mode != ADD_TEST) {

   281

			/* we should update the station rect */

   282

			*this = new_rect;

   283

		}

   284

	} else {

   285

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

   286

	}

   287

	return true;

   288

}

   289

   290

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

   291

{

   292

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

   293

}

   294

   295

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

   296

{

   297

	TileIndex top_left = TileXY(left_a, top_a);

   298

	int width = right_a - left_a + 1;

   299

	int height = bottom_a - top_a + 1;

   300

   301

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   302

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

   303

	END_TILE_LOOP(tile, width, height, top_left);

   304

   305

	return false;

   306

}

   307

   308

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

   309

{

   310

	int x = TileX(tile);

   311

	int y = TileY(tile);

   312

   313

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

   314

	 * and try to reduce the rect by this edge

   315

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

   316

	for (;;) {

   317

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

   318

		bool left_edge = (x == left);

   319

		bool right_edge = (x == right);

   320

		bool top_edge = (y == top);

   321

		bool bottom_edge = (y == bottom);

   322

   323

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

   324

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

   325

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

   326

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

   327

   328

		if (reduce_x) {

   329

			/* reduce horizontally */

   330

			if (left_edge) {

   331

				/* move left edge right */

   332

				left = x = x + 1;

   333

			} else {

   334

				/* move right edge left */

   335

				right = x = x - 1;

   336

			}

   337

		}

   338

		if (reduce_y) {

   339

			/* reduce vertically */

   340

			if (top_edge) {

   341

				/* move top edge down */

   342

				top = y = y + 1;

   343

			} else {

   344

				/* move bottom edge up */

   345

				bottom = y = y - 1;

   346

			}

   347

		}

   348

   349

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

   350

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

   351

			MakeEmpty();

   352

			return true; // empty remaining rect

   353

		}

   354

	}

   355

	return false; // non-empty remaining rect

   356

}

   357

   358

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

   359

{

   360

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

   361

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

   362

   363

	bool empty = AfterRemoveTile(st, tile);

   364

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

   365

	return empty;

   366

}

   367

   368

StationRect& StationRect::operator = (Rect src)

   369

{

   370

	left = src.left;

   371

	top = src.top;

   372

	right = src.right;

   373

	bottom = src.bottom;

   374

	return *this;

   375

}

   376

   377

   378

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

   379

/*                     RoadStop implementation                          */

   380

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

   381

   382

/** Initializes a RoadStop */

   383

RoadStop::RoadStop(TileIndex tile) :

   384

	xy(tile),

   385

	status(3), // stop is free

   386

	num_vehicles(0),

   387

	next(NULL)

   388

{

   389

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

   390

}

   391

   392

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

   393

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

   394

  */

   395

RoadStop::~RoadStop()

   396

{

   397

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

   398

	if (num_vehicles != 0) {

   399

		Vehicle *v;

   400

   401

		FOR_ALL_VEHICLES(v) {

   402

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

   403

		}

   404

	}

   405

	assert(num_vehicles == 0);

   406

   407

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

   408

   410

}

   411

   412

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

   413

bool RoadStop::IsValid() const

   414

{

   416

}

   417

   418

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

   419

bool RoadStop::HasFreeBay() const

   420

{

   421

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

   422

}

   423

   424

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

   425

bool RoadStop::IsFreeBay(uint nr) const

   426

{

   427

	assert(nr < MAX_BAY_COUNT);

   428

	return HASBIT(status, nr);

   429

}

   430

   431

/**

   432

 * Allocates a bay

   433

 * @return the allocated bay number

   434

 * @pre this->HasFreeBay()

   435

 */

   436

uint RoadStop::AllocateBay()

   437

{

   438

	assert(HasFreeBay());

   439

   440

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

   441

	uint bay_nr = 0;

   442

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

   443

   444

	CLRBIT(status, bay_nr);

   445

	return bay_nr;

   446

}

   447

   448

/**

   449

 * Allocates a bay in a drive-through road stop

   450

 * @param nr the number of the bay to allocate

   451

 */

   452

void RoadStop::AllocateDriveThroughBay(uint nr)

   453

{

   454

	assert(nr < MAX_BAY_COUNT);

   455

	CLRBIT(status, nr);

   456

}

   457

   458

/**

   459

 * Frees the given bay

   460

 * @param nr the number of the bay to free

   461

 */

   462

void RoadStop::FreeBay(uint nr)

   463

{

   464

	assert(nr < MAX_BAY_COUNT);

   465

	SETBIT(status, nr);

   466

}

   467

   468

   469

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

   470

bool RoadStop::IsEntranceBusy() const

   471

{

   472

	return HASBIT(status, 7);

   473

}

   474

   475

/** Makes an entrance occupied or free */

   476

void RoadStop::SetEntranceBusy(bool busy)

   477

{

   478

	SB(status, 7, 1, busy);

   479

}