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 "landscape.h"

    13

#include "station_map.h"

    14

#include "table/sprites.h"

    15

#include "table/strings.h"

    16

#include "map.h"

    17

#include "tile.h"

    18

#include "station.h"

    19

#include "gfx.h"

    20

#include "window.h"

    21

#include "viewport.h"

    22

#include "command.h"

    23

#include "town.h"

    24

#include "vehicle.h"

    25

#include "news.h"

    26

#include "saveload.h"

    27

#include "economy.h"

    28

#include "player.h"

    29

#include "airport.h"

    30

#include "sprite.h"

    31

#include "depot.h"

    32

#include "train.h"

    33

#include "roadveh.h"

    34

#include "water_map.h"

    35

#include "industry_map.h"

    36

#include "newgrf_callbacks.h"

    37

#include "newgrf_station.h"

    38

#include "yapf/yapf.h"

    39

#include "date.h"

    40

#include "helpers.hpp"

    41

#include "misc/autoptr.hpp"

    42

#include "road.h"

    43

#include "cargotype.h"

    44

#include "strings.h"

    45

#include "autoslope.h"

    46

    47

DEFINE_OLD_POOL_GENERIC(Station, Station)

    48

DEFINE_OLD_POOL_GENERIC(RoadStop, RoadStop)

    49

    50

    51

/**

    52

 * Check whether the given tile is a hangar.

    53

 * @param t the tile to of whether it is a hangar.

    54

 * @pre IsTileType(t, MP_STATION)

    55

 * @return true if and only if the tile is a hangar.

    56

 */

    57

bool IsHangar(TileIndex t)

    58

{

    59

	assert(IsTileType(t, MP_STATION));

    60

    61

	const Station *st = GetStationByTile(t);

    62

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

    63

    64

	for (uint i = 0; i < apc->nof_depots; i++) {

    65

		if (st->airport_tile + ToTileIndexDiff(apc->airport_depots[i]) == t) return true;

    66

	}

    67

    68

	return false;

    69

}

    70

    71

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

    72

{

    73

	const Station* st = GetStationByTile(tile);

    74

    75

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

    76

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

    77

		assert(rs->next != NULL);

    78

	}

    79

}

    80

    81

    82

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

    83

{

    84

	uint num = 0;

    85

    86

	assert(st != NULL);

    87

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

    88

		num++;

    89

	}

    90

    91

	return num;

    92

}

    93

    94

    95

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

    96

 *  radius that is available within the station

    97

 * @param st Station to query

    98

 * @return the so calculated radius

    99

 */

   100

static uint FindCatchmentRadius(const Station* st)

   101

{

   102

	uint ret = CA_NONE;

   103

   104

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

   105

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

   106

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

   107

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

   108

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

   109

   110

	return ret;

   111

}

   112

   113

#define CHECK_STATIONS_ERR ((Station*)-1)

   114

   115

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

   116

{

   117

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

   118

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

   119

		if (IsTileType(tile_cur, MP_STATION)) {

   120

			StationID t = GetStationIndex(tile_cur);

   121

   122

			if (closest_station == INVALID_STATION) {

   123

				closest_station = t;

   124

			} else if (closest_station != t) {

   125

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   126

				return CHECK_STATIONS_ERR;

   127

			}

   128

		}

   129

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

   130

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

   131

}

   132

   133

/**

   134

 * Function to check whether the given tile matches some criterion.

   135

 * @param tile the tile to check

   136

 * @return true if it matches, false otherwise

   137

 */

   138

typedef bool (*CMSAMatcher)(TileIndex tile);

   139

   140

/**

   141

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

   142

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

   143

 * @param type the type of tile searched for

   144

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

   145

 *                 in all other cases this parameter is ignored

   146

 * @return the result the noumber of matching tiles around

   147

 */

   148

static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)

   149

{

   150

	int num = 0;

   151

   152

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

   153

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

   154

			if (cmp(TILE_MASK(tile + TileDiffXY(dx, dy)))) num++;

   155

		}

   156

	}

   157

   158

	return num;

   159

}

   160

   161

/**

   162

 * Check whether the tile is a mine.

   163

 * @param tile the tile to investigate.

   164

 * @return true if and only if the tile is a mine

   165

 */

   166

static bool CMSAMine(TileIndex tile)

   167

{

   168

	/* No industry */

   169

	if (!IsTileType(tile, MP_INDUSTRY)) return false;

   170

   171

	const Industry *ind = GetIndustryByTile(tile);

   172

   173

	/* No extractive industry */

   174

	if ((GetIndustrySpec(ind->type)->life_type & INDUSTRYLIFE_EXTRACTIVE) == 0) return false;

   175

   176

	for (uint i = 0; i < lengthof(ind->produced_cargo); i++) {

   177

		/* The industry extracts something non-liquid, i.e. no oil or plastic, so it is a mine */

   178

		if (ind->produced_cargo[i] != CT_INVALID && (GetCargo(ind->produced_cargo[i])->classes & CC_LIQUID) == 0) return true;

   179

	}

   180

   181

	return false;

   182

}

   183

   184

/**

   185

 * Check whether the tile is water.

   186

 * @param tile the tile to investigate.

   187

 * @return true if and only if the tile is a mine

   188

 */

   189

static bool CMSAWater(TileIndex tile)

   190

{

   191

	return IsTileType(tile, MP_WATER) && IsWater(tile);

   192

}

   193

   194

/**

   195

 * Check whether the tile is a tree.

   196

 * @param tile the tile to investigate.

   197

 * @return true if and only if the tile is a mine

   198

 */

   199

static bool CMSATree(TileIndex tile)

   200

{

   201

	return IsTileType(tile, MP_TREES);

   202

}

   203

   204

/**

   205

 * Check whether the tile is a forest.

   206

 * @param tile the tile to investigate.

   207

 * @return true if and only if the tile is a mine

   208

 */

   209

static bool CMSAForest(TileIndex tile)

   210

{

   211

	/* No industry */

   212

	if (!IsTileType(tile, MP_INDUSTRY)) return false;

   213

   214

	const Industry *ind = GetIndustryByTile(tile);

   215

   216

	/* No extractive industry */

   217

	if ((GetIndustrySpec(ind->type)->life_type & INDUSTRYLIFE_ORGANIC) == 0) return false;

   218

   219

	for (uint i = 0; i < lengthof(ind->produced_cargo); i++) {

   220

		/* The industry produces wood. */

   221

		if (ind->produced_cargo[i] != CT_INVALID && GetCargo(ind->produced_cargo[i])->label == 'WOOD') return true;

   222

	}

   223

   224

	return false;

   225

}

   226

   227

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

   228

   229

enum StationNaming {

   230

	STATIONNAMING_RAIL = 0,

   231

	STATIONNAMING_ROAD = 0,

   232

	STATIONNAMING_AIRPORT,

   233

	STATIONNAMING_OILRIG,

   234

	STATIONNAMING_DOCK,

   235

	STATIONNAMING_BUOY,

   236

	STATIONNAMING_HELIPORT,

   237

};

   238

   239

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

   240

{

   241

	static const uint32 _gen_station_name_bits[] = {

   242

		0,                                      /* 0 */

   243

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

   244

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

   245

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

   246

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

   247

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

   248

	};

   249

   250

	Town *t = st->town;

   251

	uint32 free_names = (uint32)-1;

   252

	int found;

   253

	unsigned long tmp;

   254

   255

	{

   256

		Station *s;

   257

   258

		FOR_ALL_STATIONS(s) {

   259

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

   260

				uint str = M(s->string_id);

   261

				if (str <= 0x20) {

   262

					if (str == M(STR_SV_STNAME_FOREST))

   263

						str = M(STR_SV_STNAME_WOODS);

   264

					CLRBIT(free_names, str);

   265

				}

   266

			}

   267

		}

   268

	}

   269

   270

	/* check default names */

   271

	tmp = free_names & _gen_station_name_bits[flag];

   272

	if (tmp != 0) {

   273

		found = FindFirstBit(tmp);

   274

		goto done;

   275

	}

   276

   277

	/* check mine? */

   278

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

   279

		if (CountMapSquareAround(tile, CMSAMine) >= 2) {

   280

			found = M(STR_SV_STNAME_MINES);

   281

			goto done;

   282

		}

   283

	}

   284

   285

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

   286

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

   287

		found = M(STR_SV_STNAME);

   288

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

   289

   290

		found = M(STR_SV_STNAME_CENTRAL);

   291

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

   292

	}

   293

   294

	/* Check lakeside */

   295

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

   296

			DistanceFromEdge(tile) < 20 &&

   297

			CountMapSquareAround(tile, CMSAWater) >= 5) {

   298

		found = M(STR_SV_STNAME_LAKESIDE);

   299

		goto done;

   300

	}

   301

   302

	/* Check woods */

   303

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

   304

				CountMapSquareAround(tile, CMSATree) >= 8 ||

   305

				CountMapSquareAround(tile, CMSAForest) >= 2)

   306

			) {

   307

		found = _opt.landscape == LT_TROPIC ?

   308

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   309

		goto done;

   310

	}

   311

   312

	/* check elevation compared to town */

   313

	{

   314

		uint z = GetTileZ(tile);

   315

		uint z2 = GetTileZ(t->xy);

   316

		if (z < z2) {

   317

			found = M(STR_SV_STNAME_VALLEY);

   318

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

   319

		} else if (z > z2) {

   320

			found = M(STR_SV_STNAME_HEIGHTS);

   321

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

   322

		}

   323

	}

   324

   325

	/* check direction compared to town */

   326

	{

   327

		static const int8 _direction_and_table[] = {

   328

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

   329

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

   330

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

   331

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

   332

		};

   333

   334

		free_names &= _direction_and_table[

   335

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

   336

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

   337

	}

   338

   339

	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));

   340

	found = (tmp == 0) ? M(STR_SV_STNAME_FALLBACK) : FindFirstBit(tmp);

   341

   342

done:

   343

	st->string_id = found + STR_SV_STNAME;

   344

	return true;

   345

}

   346

#undef M

   347

   348

static Station* GetClosestStationFromTile(TileIndex tile)

   349

{

   350

	uint threshold = 8;

   351

	Station* best_station = NULL;

   352

	Station* st;

   353

   354

	FOR_ALL_STATIONS(st) {

   355

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

   356

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

   357

   358

			if (cur_dist < threshold) {

   359

				threshold = cur_dist;

   360

				best_station = st;

   361

			}

   362

		}

   363

	}

   364

   365

	return best_station;

   366

}

   367

   368

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

   369

 * @param st Station to update for.

   370

 */

   371

static void UpdateStationVirtCoord(Station *st)

   372

{

   373

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

   374

   375

	pt.y -= 32;

   376

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

   377

   378

	SetDParam(0, st->index);

   379

	SetDParam(1, st->facilities);

   380

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

   381

}

   382

   383

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

   384

void UpdateAllStationVirtCoord()

   385

{

   386

	Station* st;

   387

   388

	FOR_ALL_STATIONS(st) {

   389

		UpdateStationVirtCoord(st);

   390

	}

   391

}

   392

   393

/**

   394

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

   395

 *

   396

 * This function updates the virt coords and mark the modified parts as dirty

   397

 *

   398

 * @param st The station to update the virt coords

   399

 * @ingroup dirty

   400

 */

   401

static void UpdateStationVirtCoordDirty(Station *st)

   402

{

   403

	st->MarkDirty();

   404

	UpdateStationVirtCoord(st);

   405

	st->MarkDirty();

   406

}

   407

   408

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

   409

 * @param st Station to query

   410

 * @return the expected mask

   411

 */

   412

static uint GetAcceptanceMask(const Station *st)

   413

{

   414

	uint mask = 0;

   415

   416

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

   417

		if (HASBIT(st->goods[i].acceptance_pickup, GoodsEntry::ACCEPTANCE)) mask |= 1 << i;

   418

	}

   419

	return mask;

   420

}

   421

   422

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

   423

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

   424

 */

   425

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

   426

{

   427

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

   428

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

   429

	}

   430

   431

	SetDParam(0, st->index);

   432

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

   433

}

   434

   435

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

   436

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   437

	int w, int h, int rad)

   438

{

   439

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

   440

   441

	int x = TileX(tile);

   442

	int y = TileY(tile);

   443

   444

	/* expand the region by rad tiles on each side

   445

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

   446

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

   447

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

   448

   449

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

   450

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

   451

   452

	assert(x1 < x2);

   453

	assert(y1 < y2);

   454

	assert(w > 0);

   455

	assert(h > 0);

   456

   457

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

   458

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

   459

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

   460

				TileIndex tile = TileXY(xc, yc);

   461

   462

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

   463

				if (gpc != NULL) {

   464

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

   465

   466

					gpc(tile, cargos);

   467

					if (cargos[0] != CT_INVALID) {

   468

						produced[cargos[0]]++;

   469

						if (cargos[1] != CT_INVALID) {

   470

							produced[cargos[1]]++;

   471

						}

   472

					}

   473

				}

   474

			}

   475

		}

   476

	}

   477

}

   478

   479

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

   480

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile,

   481

	int w, int h, int rad)

   482

{

   483

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

   484

   485

	int x = TileX(tile);

   486

	int y = TileY(tile);

   487

   488

	/* expand the region by rad tiles on each side

   489

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

   490

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

   491

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

   492

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

   493

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