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

/**

    64

Station::~Station()

    65

{

    66

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

    67

    68

	DeleteName(string_id);

    69

	MarkDirty();

    70

	RebuildStationLists();

    71

	InvalidateWindowClasses(WC_STATION_LIST);

    72

    73

	DeleteWindowById(WC_STATION_VIEW, index);

    74

    75

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

    76

	RemoveOrderFromAllVehicles(OT_GOTO_STATION, index);

    77

    78

	/* Subsidies need removal as well */

    79

	DeleteSubsidyWithStation(index);

    80

    81

	free(speclist);

    82

	xy = 0;

    83

}

    84

    85

void* Station::operator new(size_t size)

    86

{

    87

	Station *st = AllocateRaw();

    88

	return st;

    89

}

    90

    91

void* Station::operator new(size_t size, int st_idx)

    92

{

    93

	if (!AddBlockIfNeeded(&_Station_pool, st_idx))

    94

		error("Stations: failed loading savegame: too many stations");

    95

    96

	Station *st = GetStation(st_idx);

    97

	return st;

    98

}

    99

   100

void Station::operator delete(void *p)

   101

{

   102

}

   103

   104

void Station::operator delete(void *p, int st_idx)

   105

{

   106

}

   107

   108

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

   110

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

   111

{

   112

	if (facilities == 0) {

   113

		xy = facil_xy;

   114

		random_bits = Random();

   115

	}

   116

	facilities |= new_facility_bit;

   117

	owner = _current_player;

   118

	build_date = _date;

   119

}

   120

   121

void Station::MarkDirty() const

   122

{

   123

	if (sign.width_1 != 0) {

   124

		InvalidateWindowWidget(WC_STATION_VIEW, index, 1);

   125

   126

		MarkAllViewportsDirty(

   127

			sign.left - 6,

   128

			sign.top,

   129

			sign.left + (sign.width_1 << 2) + 12,

   130

			sign.top + 48);

   131

	}

   132

}

   133

   134

void Station::MarkTilesDirty() const

   135

{

   136

	TileIndex tile = train_tile;

   137

	int w, h;

   138

   139

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

   140

	if (tile == 0) return;

   141

   142

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

   143

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

   144

			if (TileBelongsToRailStation(tile)) {

   145

				MarkTileDirtyByTile(tile);

   146

			}

   147

			tile += TileDiffXY(1, 0);

   148

		}

   149

		tile += TileDiffXY(-w, 1);

   150

	}

   151

}

   152

   153

bool Station::TileBelongsToRailStation(TileIndex tile) const

   154

{

   155

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

   156

}

   157

   158

/*static*/ Station *Station::AllocateRaw()

   159

{

   160

	Station *st = NULL;

   161

   162

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   163

	 * TODO - This is just a temporary stage, this will be removed. */

   164

	for (st = GetStation(0); st != NULL; st = (st->index + 1U < GetStationPoolSize()) ? GetStation(st->index + 1U) : NULL) {

   165

		if (!st->IsValid()) {

   166

			StationID index = st->index;

   167

   168

			memset(st, 0, sizeof(Station));

   169

			st->index = index;

   170

			return st;

   171

		}

   172

	}

   173

   174

	/* Check if we can add a block to the pool */

   175

	if (AddBlockToPool(&_Station_pool)) return AllocateRaw();

   176

   177

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   178

	return NULL;

   179

}

   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

   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

/** Determines whether a station exists

   241

 * @todo replace 0 by INVALID_TILE

   242

 */

   243

bool Station::IsValid() const

   244

{

   245

	return xy != 0;

   246

}

   247

   248

   249

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

   250

/*                     StationRect implementation                       */

   251

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

   252

   253

StationRect::StationRect()

   254

{

   255

	MakeEmpty();

   256

}

   257

   258

void StationRect::MakeEmpty()

   259

{

   260

	left = top = right = bottom = 0;

   261

}

   262

   263

/**

   264

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

   265

 * the station rectangle.

   266

 * @note x and y are in Tile coordinates

   267

 * @param x X coordinate

   268

 * @param y Y coordinate

   269

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

   270

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

   271

 */

   272

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

   273

{

   274

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

   275

}

   276

   277

bool StationRect::IsEmpty() const

   278

{

   279

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

   280

}

   281

   282

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

   283

{

   284

	int x = TileX(tile);

   285

	int y = TileY(tile);

   286

	if (IsEmpty()) {

   287

		/* we are adding the first station tile */

   288

		left = right = x;

   289

		top = bottom = y;

   290

   291

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

   292

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

   293

		/* make new spread-out rectangle */

   294

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

   295

   296

		/* check new rect dimensions against preset max */

   297

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

   298

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

   299

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

   300

			assert(mode != ADD_TRY);

   301

			_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   302

			return false;

   303

		}

   304

   305

		/* spread-out ok, return true */

   306

		if (mode != ADD_TEST) {

   307

			/* we should update the station rect */

   308

			*this = new_rect;

   309

		}

   310

	} else {

   311

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

   312

	}

   313

	return true;

   314

}

   315

   316

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

   317

{

   318

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

   319

}

   320

   321

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

   322

{

   323

	TileIndex top_left = TileXY(left_a, top_a);

   324

	int width = right_a - left_a + 1;

   325

	int height = bottom_a - top_a + 1;

   326

   327

	BEGIN_TILE_LOOP(tile, width, height, top_left)

   328

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

   329

	END_TILE_LOOP(tile, width, height, top_left);

   330

   331

	return false;

   332

}

   333

   334

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

   335

{

   336

	int x = TileX(tile);

   337

	int y = TileY(tile);

   338

   339

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

   340

	 * and try to reduce the rect by this edge

   341

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

   342

	for (;;) {

   343

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

   344

		bool left_edge = (x == left);

   345

		bool right_edge = (x == right);

   346

		bool top_edge = (y == top);

   347

		bool bottom_edge = (y == bottom);

   348

   349

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

   350

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

   351

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

   352

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

   353

   354

		if (reduce_x) {

   355

			/* reduce horizontally */

   356

			if (left_edge) {

   357

				/* move left edge right */

   358

				left = x = x + 1;

   359

			} else {

   360

				/* move right edge left */

   361

				right = x = x - 1;

   362

			}

   363

		}

   364

		if (reduce_y) {

   365

			/* reduce vertically */

   366

			if (top_edge) {

   367

				/* move top edge down */

   368

				top = y = y + 1;

   369

			} else {

   370

				/* move bottom edge up */

   371

				bottom = y = y - 1;

   372

			}

   373

		}

   374

   375

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

   376

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

   377

			MakeEmpty();

   378

			return true; // empty remaining rect

   379

		}

   380

	}

   381

	return false; // non-empty remaining rect

   382

}

   383

   384

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

   385

{

   386

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

   387

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

   388

   389

	bool empty = AfterRemoveTile(st, tile);

   390

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

   391

	return empty;

   392

}

   393

   394

StationRect& StationRect::operator = (Rect src)

   395

{

   396

	left = src.left;

   397

	top = src.top;

   398

	right = src.right;

   399

	bottom = src.bottom;

   400

	return *this;

   401

}

   402

   403

   404

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

   405

/*                     RoadStop implementation                          */

   406

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

   407

   408

/** Allocates a new RoadStop onto the pool, or recycles an unsed one

   409

 *  @return a pointer to the new roadstop

   410

 */

   411

void *RoadStop::operator new(size_t size)

   412

{

   413

	RoadStop *rs = AllocateRaw();

   414

	return rs;

   415

}

   416

   417

/** Gets a RoadStop with a given index and allocates it when needed

   418

  * @return a pointer to the roadstop

   419

  */

   420

void *RoadStop::operator new(size_t size, int index)

   421

{

   422

	if (!AddBlockIfNeeded(&_RoadStop_pool, index)) {

   423

		error("RoadStops: failed loading savegame: too many RoadStops");

   424

	}

   425

   426

	RoadStop *rs = GetRoadStop(index);

   427

	return rs;

   428

}

   429

   430

void RoadStop::operator delete(void *p)

   431

{

   432

}

   433

   434

void RoadStop::operator delete(void *p, int index)

   435

{

   436

}

   437

   438

/** Initializes a RoadStop */

   439

RoadStop::RoadStop(TileIndex tile) :

   440

	xy(tile),

   441

	status(3), // stop is free

   442

	num_vehicles(0),

   443

	next(NULL)

   444

{

   445

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

   446

}

   447

   448

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

   449

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

   450

  */

   451

RoadStop::~RoadStop()

   452

{

   453

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

   454

	if (num_vehicles != 0) {

   455

		Vehicle *v;

   456

   457

		FOR_ALL_VEHICLES(v) {

   458

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

   459

		}

   460

	}

   461

	assert(num_vehicles == 0);

   462

   463

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

   464

   465

	xy = INVALID_TILE;

   466

}

   467

   468

   469

/** Low-level function for allocating a RoadStop on the pool */

   470

RoadStop *RoadStop::AllocateRaw()

   471

{

   472

	RoadStop *rs;

   473

   474

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   475

	 * TODO - This is just a temporary stage, this will be removed. */

   476

	for (rs = GetRoadStop(0); rs != NULL; rs = (rs->index + 1U < GetRoadStopPoolSize()) ? GetRoadStop(rs->index + 1U) : NULL) {

   477

		if (!rs->IsValid()) {

   478

			RoadStopID index = rs->index;

   479

   480

			memset(rs, 0, sizeof(*rs));

   481

			rs->index = index;

   482

   483

			return rs;

   484

		}

   485

	}

   486

   487

	/* Check if we can add a block to the pool */

   488

	if (AddBlockToPool(&_RoadStop_pool)) return AllocateRaw();