1

/* $Id$ */

     2

     3

/** @file station_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "aircraft.h"

     8

#include "bridge_map.h"

     9

#include "cmd_helper.h"

    10

#include "debug.h"

    11

#include "functions.h"

    12

#include "station_map.h"

    13

#include "table/sprites.h"

    14

#include "table/strings.h"

    15

#include "map.h"

    16

#include "tile.h"

    17

#include "station.h"

    18

#include "gfx.h"

    19

#include "window.h"

    20

#include "viewport.h"

    21

#include "command.h"

    22

#include "town.h"

    23

#include "vehicle.h"

    24

#include "news.h"

    25

#include "saveload.h"

    26

#include "economy.h"

    27

#include "player.h"

    28

#include "airport.h"

    29

#include "sprite.h"

    30

#include "depot.h"

    31

#include "train.h"

    32

#include "water_map.h"

    33

#include "industry_map.h"

    34

#include "newgrf_callbacks.h"

    35

#include "newgrf_station.h"

    36

#include "yapf/yapf.h"

    37

#include "date.h"

    38

#include "helpers.hpp"

    39

#include "misc/autoptr.hpp"

    40

#include "road.h"

    41

#include "cargotype.h"

    42

    43

/**

    44

 * Called if a new block is added to the station-pool

    45

 */

    46

static void StationPoolNewBlock(uint start_item)

    47

{

    48

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

    49

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

    50

	for (Station *st = GetStation(start_item); st != NULL; st = (st->index + 1U < GetStationPoolSize()) ? GetStation(st->index + 1U) : NULL) st->index = start_item++;

    51

}

    52

    53

static void StationPoolCleanBlock(uint start_item, uint end_item)

    54

{

    55

	for (uint i = start_item; i <= end_item; i++) {

    56

		Station *st = GetStation(i);

    57

		if (st->IsValid()) st->~Station();

    58

	}

    59

}

    60

    61

/**

    62

 * Called if a new block is added to the roadstop-pool

    63

 */

    64

static void RoadStopPoolNewBlock(uint start_item)

    65

{

    66

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

    67

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

    68

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

    69

		rs->xy    = INVALID_TILE;

    70

		rs->index = start_item++;

    71

	}

    72

}

    73

    74

DEFINE_OLD_POOL(Station, Station, StationPoolNewBlock, StationPoolCleanBlock)

    75

DEFINE_OLD_POOL(RoadStop, RoadStop, RoadStopPoolNewBlock, NULL)

    76

    77

    78

RoadStop* GetRoadStopByTile(TileIndex tile, RoadStop::Type type)

    79

{

    80

	const Station* st = GetStationByTile(tile);

    81

    82

	for (RoadStop *rs = st->GetPrimaryRoadStop(type);; rs = rs->next) {

    83

		if (rs->xy == tile) return rs;

    84

		assert(rs->next != NULL);

    85

	}

    86

}

    87

    88

    89

static uint GetNumRoadStopsInStation(const Station* st, RoadStop::Type type)

    90

{

    91

	uint num = 0;

    92

    93

	assert(st != NULL);

    94

	for (const RoadStop *rs = st->GetPrimaryRoadStop(type); rs != NULL; rs = rs->next) {

    95

		num++;

    96

	}

    97

    98

	return num;

    99

}

   100

   101

   102

/* Calculate the radius of the station. Basicly it is the biggest

   103

 *  radius that is available within the station */

   104

static uint FindCatchmentRadius(const Station* st)

   105

{

   106

	uint ret = CA_NONE;

   107

   108

	if (st->bus_stops   != NULL) ret = max<uint>(ret, CA_BUS);

   109

	if (st->truck_stops != NULL) ret = max<uint>(ret, CA_TRUCK);

   110

	if (st->train_tile  != 0)    ret = max<uint>(ret, CA_TRAIN);

   111

	if (st->dock_tile   != 0)    ret = max<uint>(ret, CA_DOCK);

   112

	if (st->airport_tile)        ret = max<uint>(ret, st->Airport()->catchment);

   113

   114

	return ret;

   115

}

   116

   117

#define CHECK_STATIONS_ERR ((Station*)-1)

   118

   119

static Station* GetStationAround(TileIndex tile, int w, int h, StationID closest_station)

   120

{

   121

	// check around to see if there's any stations there

   122

	BEGIN_TILE_LOOP(tile_cur, w + 2, h + 2, tile - TileDiffXY(1, 1))

   123

		if (IsTileType(tile_cur, MP_STATION)) {

   124

			StationID t = GetStationIndex(tile_cur);

   125

   126

			if (closest_station == INVALID_STATION) {

   127

				closest_station = t;

   128

			} else if (closest_station != t) {

   129

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   130

				return CHECK_STATIONS_ERR;

   131

			}

   132

		}

   133

	END_TILE_LOOP(tile_cur, w + 2, h + 2, tile - TileDiffXY(1, 1))

   134

	return (closest_station == INVALID_STATION) ? NULL : GetStation(closest_station);

   135

}

   136

   137

   138

/**

   139

 * Counts the numbers of tiles matching a specific type in the area around

   140

 * @param tile the center tile of the 'count area'

   141

 * @param type the type of tile searched for

   142

 * @param industry when type == MP_INDUSTRY, the type of the industry,

   143

 *                 in all other cases this parameter is ignored

   144

 * @return the result the noumber of matching tiles around

   145

 */

   146

static int CountMapSquareAround(TileIndex tile, TileType type, IndustryType industry)

   147

{

   148

	int num = 0;

   149

   150

	for (int dx = -3; dx <= 3; dx++) {

   151

		for (int dy = -3; dy <= 3; dy++) {

   152

			TileIndex cur_tile = TILE_MASK(tile + TileDiffXY(dx, dy));

   153

   154

			if (IsTileType(cur_tile, type)) {

   155

				switch (type) {

   156

					case MP_INDUSTRY:

   157

						if (GetIndustryType(cur_tile) == industry)

   158

							num++;

   159

						break;

   160

   161

					case MP_WATER:

   162

						if (!IsWater(cur_tile))

   163

							break;

   164

						/* FALL THROUGH WHEN WATER TILE */

   165

					case MP_TREES:

   166

						num++;

   167

						break;

   168

   169

					default:

   170

						break;

   171

				}

   172

			}

   173

		}

   174

	}

   175

   176

	return num;

   177

}

   178

   179

#define M(x) ((x) - STR_SV_STNAME)

   180

   181

static bool GenerateStationName(Station *st, TileIndex tile, int flag)

   182

{

   183

	static const uint32 _gen_station_name_bits[] = {

   184

		0,                                      /* 0 */

   185

		1 << M(STR_SV_STNAME_AIRPORT),          /* 1 */

   186

		1 << M(STR_SV_STNAME_OILFIELD),         /* 2 */

   187

		1 << M(STR_SV_STNAME_DOCKS),            /* 3 */

   188

		0x1FF << M(STR_SV_STNAME_BUOY_1),       /* 4 */

   189

		1 << M(STR_SV_STNAME_HELIPORT),         /* 5 */

   190

	};

   191

   192

	Town *t = st->town;

   193

	uint32 free_names = (uint32)-1;

   194

	int found;

   195

	unsigned long tmp;

   196

   197

	{

   198

		Station *s;

   199

   200

		FOR_ALL_STATIONS(s) {

   201

			if (s != st && s->town==t) {

   202

				uint str = M(s->string_id);

   203

				if (str <= 0x20) {

   204

					if (str == M(STR_SV_STNAME_FOREST))

   205

						str = M(STR_SV_STNAME_WOODS);

   206

					CLRBIT(free_names, str);

   207

				}

   208

			}

   209

		}

   210

	}

   211

   212

	/* check default names */

   213

	tmp = free_names & _gen_station_name_bits[flag];

   214

	if (tmp != 0) {

   215

		found = FindFirstBit(tmp);

   216

		goto done;

   217

	}

   218

   219

	/* check mine? */

   220

	if (HASBIT(free_names, M(STR_SV_STNAME_MINES))) {

   221

		if (CountMapSquareAround(tile, MP_INDUSTRY, IT_COAL_MINE) >= 2 ||

   222

				CountMapSquareAround(tile, MP_INDUSTRY, IT_IRON_MINE) >= 2 ||

   223

				CountMapSquareAround(tile, MP_INDUSTRY, IT_COPPER_MINE) >= 2 ||

   224

				CountMapSquareAround(tile, MP_INDUSTRY, IT_GOLD_MINE) >= 2 ||

   225

				CountMapSquareAround(tile, MP_INDUSTRY, IT_DIAMOND_MINE) >= 2) {

   226

			found = M(STR_SV_STNAME_MINES);

   227

			goto done;

   228

		}

   229

	}

   230

   231

	/* check close enough to town to get central as name? */

   232

	if (DistanceMax(tile,t->xy) < 8) {

   233

		found = M(STR_SV_STNAME);

   234

		if (HASBIT(free_names, M(STR_SV_STNAME))) goto done;

   235

   236

		found = M(STR_SV_STNAME_CENTRAL);

   237

		if (HASBIT(free_names, M(STR_SV_STNAME_CENTRAL))) goto done;

   238

	}

   239

   240

	/* Check lakeside */

   241

	if (HASBIT(free_names, M(STR_SV_STNAME_LAKESIDE)) &&

   242

			DistanceFromEdge(tile) < 20 &&

   243

			CountMapSquareAround(tile, MP_WATER, 0) >= 5) {

   244

		found = M(STR_SV_STNAME_LAKESIDE);

   245

		goto done;

   246

	}

   247

   248

	/* Check woods */

   249

	if (HASBIT(free_names, M(STR_SV_STNAME_WOODS)) && (

   250

				CountMapSquareAround(tile, MP_TREES, 0) >= 8 ||

   251

				CountMapSquareAround(tile, MP_INDUSTRY, IT_FOREST) >= 2)

   252

			) {

   253

		found = _opt.landscape == LT_DESERT ?

   254

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   255

		goto done;

   256

	}

   257

   258

	/* check elevation compared to town */

   259

	{

   260

		uint z = GetTileZ(tile);

   261

		uint z2 = GetTileZ(t->xy);

   262

		if (z < z2) {

   263

			found = M(STR_SV_STNAME_VALLEY);

   264

			if (HASBIT(free_names, M(STR_SV_STNAME_VALLEY))) goto done;

   265

		} else if (z > z2) {

   266

			found = M(STR_SV_STNAME_HEIGHTS);

   267

			if (HASBIT(free_names, M(STR_SV_STNAME_HEIGHTS))) goto done;

   268

		}

   269

	}

   270

   271

	/* check direction compared to town */

   272

	{

   273

		static const int8 _direction_and_table[] = {

   274

			~( (1<<M(STR_SV_STNAME_WEST)) | (1<<M(STR_SV_STNAME_EAST)) | (1<<M(STR_SV_STNAME_NORTH)) ),

   275

			~( (1<<M(STR_SV_STNAME_SOUTH)) | (1<<M(STR_SV_STNAME_WEST)) | (1<<M(STR_SV_STNAME_NORTH)) ),

   276

			~( (1<<M(STR_SV_STNAME_SOUTH)) | (1<<M(STR_SV_STNAME_EAST)) | (1<<M(STR_SV_STNAME_NORTH)) ),

   277

			~( (1<<M(STR_SV_STNAME_SOUTH)) | (1<<M(STR_SV_STNAME_WEST)) | (1<<M(STR_SV_STNAME_EAST)) ),

   278

		};

   279

   280

		free_names &= _direction_and_table[

   281

			(TileX(tile) < TileX(t->xy)) +

   282

			(TileY(tile) < TileY(t->xy)) * 2];

   283

	}

   284

   285

	tmp = free_names & ((1<<1)|(1<<2)|(1<<3)|(1<<4)|(1<<6)|(1<<7)|(1<<12)|(1<<26)|(1<<27)|(1<<28)|(1<<29)|(1<<30));

   286

	if (tmp == 0) {

   287

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   288

		return false;

   289

	}

   290

	found = FindFirstBit(tmp);

   291

   292

done:

   293

	st->string_id = found + STR_SV_STNAME;

   294

	return true;

   295

}

   296

#undef M

   297

   298

static Station* GetClosestStationFromTile(TileIndex tile)

   299

{

   300

	uint threshold = 8;

   301

	Station* best_station = NULL;

   302

	Station* st;

   303

   304

	FOR_ALL_STATIONS(st) {

   305

		if (st->facilities == 0 && st->owner == _current_player) {

   306

			uint cur_dist = DistanceManhattan(tile, st->xy);

   307

   308

			if (cur_dist < threshold) {

   309

				threshold = cur_dist;

   310

				best_station = st;

   311

			}

   312

		}

   313

	}

   314

   315

	return best_station;

   316

}

   317

   318

// Update the virtual coords needed to draw the station sign.

   319

// st = Station to update for.

   320

static void UpdateStationVirtCoord(Station *st)

   321

{

   322

	Point pt = RemapCoords2(TileX(st->xy) * TILE_SIZE, TileY(st->xy) * TILE_SIZE);

   323

   324

	pt.y -= 32;

   325

	if (st->facilities & FACIL_AIRPORT && st->airport_type == AT_OILRIG) pt.y -= 16;

   326

   327

	SetDParam(0, st->index);

   328

	SetDParam(1, st->facilities);

   329

	UpdateViewportSignPos(&st->sign, pt.x, pt.y, STR_305C_0);

   330

}

   331

   332

// Update the virtual coords needed to draw the station sign for all stations.

   333

void UpdateAllStationVirtCoord()

   334

{

   335

	Station* st;

   336

   337

	FOR_ALL_STATIONS(st) {

   338

		UpdateStationVirtCoord(st);

   339

	}

   340

}

   341

   342

// Update the station virt coords while making the modified parts dirty.

   343

static void UpdateStationVirtCoordDirty(Station *st)

   344

{

   345

	st->MarkDirty();

   346

	UpdateStationVirtCoord(st);

   347

	st->MarkDirty();

   348

}

   349

   350

// Get a mask of the cargo types that the station accepts.

   351

static uint GetAcceptanceMask(const Station *st)

   352

{

   353

	uint mask = 0;

   354

   355

	for (uint i = 0; i != NUM_CARGO; i++) {

   356

		if (st->goods[i].waiting_acceptance & 0x8000) mask |= 1 << i;

   357

	}

   358

	return mask;

   359

}

   360

   361

// Items contains the two cargo names that are to be accepted or rejected.

   362

// msg is the string id of the message to display.

   363

static void ShowRejectOrAcceptNews(const Station *st, uint num_items, CargoID *cargo, StringID msg)

   364

{

   365

	for (uint i = 0; i < num_items; i++) {

   366

		SetDParam(i + 1, GetCargo(cargo[i])->name);

   367

	}

   368

   369

	SetDParam(0, st->index);

   370

	AddNewsItem(msg, NEWS_FLAGS(NM_SMALL, NF_VIEWPORT|NF_TILE, NT_ACCEPTANCE, 0), st->xy, 0);

   371

}

   372

   373

// Get a list of the cargo types being produced around the tile.

   374

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   375

	int w, int h, int rad)

   376

{

   377

	memset(produced, 0, sizeof(AcceptedCargo));

   378

   379

	int x = TileX(tile);

   380

	int y = TileY(tile);

   381

   382

	// expand the region by rad tiles on each side

   383

	// while making sure that we remain inside the board.

   384

	int x2 = min(x + w + rad, MapSizeX());

   385

	int x1 = max(x - rad, 0);

   386

   387

	int y2 = min(y + h + rad, MapSizeY());

   388

	int y1 = max(y - rad, 0);

   389

   390

	assert(x1 < x2);

   391

	assert(y1 < y2);

   392

	assert(w > 0);

   393

	assert(h > 0);

   394

   395

	for (int yc = y1; yc != y2; yc++) {

   396

		for (int xc = x1; xc != x2; xc++) {

   397

			if (!(IS_INSIDE_1D(xc, x, w) && IS_INSIDE_1D(yc, y, h))) {

   398

				TileIndex tile = TileXY(xc, yc);

   399

   400

				GetProducedCargoProc *gpc = _tile_type_procs[GetTileType(tile)]->get_produced_cargo_proc;

   401

				if (gpc != NULL) {

   402

					CargoID cargos[2] = { CT_INVALID, CT_INVALID };

   403

   404

					gpc(tile, cargos);

   405

					if (cargos[0] != CT_INVALID) {

   406

						produced[cargos[0]]++;

   407

						if (cargos[1] != CT_INVALID) {

   408

							produced[cargos[1]]++;

   409

						}

   410

					}

   411

				}

   412

			}

   413

		}

   414

	}

   415

}

   416

   417

// Get a list of the cargo types that are accepted around the tile.

   418

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile,

   419

	int w, int h, int rad)

   420

{

   421

	memset(accepts, 0, sizeof(AcceptedCargo));

   422

   423

	int x = TileX(tile);

   424

	int y = TileY(tile);

   425

   426

	// expand the region by rad tiles on each side

   427

	// while making sure that we remain inside the board.

   428

	int x2 = min(x + w + rad, MapSizeX());

   429

	int y2 = min(y + h + rad, MapSizeY());

   430

	int x1 = max(x - rad, 0);

   431

	int y1 = max(y - rad, 0);

   432

   433

	assert(x1 < x2);

   434

	assert(y1 < y2);

   435

	assert(w > 0);

   436

	assert(h > 0);

   437

   438

	for (int yc = y1; yc != y2; yc++) {

   439

		for (int xc = x1; xc != x2; xc++) {

   440

			TileIndex tile = TileXY(xc, yc);

   441

   442

			if (!IsTileType(tile, MP_STATION)) {

   443

				AcceptedCargo ac;

   444

   445

				GetAcceptedCargo(tile, ac);

   446

				for (uint i = 0; i < lengthof(ac); ++i) accepts[i] += ac[i];

   447

			}

   448

		}

   449

	}

   450

}

   451

   452

struct ottd_Rectangle {

   453

	uint min_x;

   454

	uint min_y;

   455

	uint max_x;

   456

	uint max_y;

   457

};

   458

   459

static inline void MergePoint(ottd_Rectangle* rect, TileIndex tile)

   460

{

   461

	uint x = TileX(tile);

   462

	uint y = TileY(tile);

   463

   464

	if (rect->min_x > x) rect->min_x = x;

   465

	if (rect->min_y > y) rect->min_y = y;

   466

	if (rect->max_x < x) rect->max_x = x;

   467

	if (rect->max_y < y) rect->max_y = y;

   468

}

   469

   470

// Update the acceptance for a station.

   471

// show_msg controls whether to display a message that acceptance was changed.

   472

static void UpdateStationAcceptance(Station *st, bool show_msg)

   473

{

   474

	// Don't update acceptance for a buoy

   475

	if (st->IsBuoy()) return;

   476

   477

	ottd_Rectangle rect;

   478

	rect.min_x = MapSizeX();

   479

	rect.min_y = MapSizeY();

   480

	rect.max_x = 0;

   481

	rect.max_y = 0;

   482

   483

	/* old accepted goods types */

   484

	uint old_acc = GetAcceptanceMask(st);

   485

   486

	// Put all the tiles that span an area in the table.

   487

	if (st->train_tile != 0) {

   488

		MergePoint(&rect, st->train_tile);

   489

		MergePoint(&rect,

   490

			st->train_tile + TileDiffXY(st->trainst_w - 1, st->trainst_h - 1)

   491

		);

   492

	}

   493

   494

	if (st->airport_tile != 0) {

   495

		const AirportFTAClass* afc = st->Airport();