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

static uint FindCatchmentRadius(const Station* st)

    98

{

    99

	uint ret = CA_NONE;

   100

   101

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

   102

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

   103

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

   104

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

   105

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

   106

   107

	return ret;

   108

}

   109

   110

#define CHECK_STATIONS_ERR ((Station*)-1)

   111

   112

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

   113

{

   114

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

   115

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

   116

		if (IsTileType(tile_cur, MP_STATION)) {

   117

			StationID t = GetStationIndex(tile_cur);

   118

   119

			if (closest_station == INVALID_STATION) {

   120

				closest_station = t;

   121

			} else if (closest_station != t) {

   122

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   123

				return CHECK_STATIONS_ERR;

   124

			}

   125

		}

   126

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

   127

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

   128

}

   129

   130

/**

   131

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

   132

 * @param tile the tile to check

   133

 * @return true if it matches, false otherwise

   134

 */

   135

typedef bool (*CMSAMatcher)(TileIndex tile);

   136

   137

/**

   138

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

   139

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

   140

 * @param type the type of tile searched for

   141

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

   142

 *                 in all other cases this parameter is ignored

   143

 * @return the result the noumber of matching tiles around

   144

 */

   145

static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)

   146

{

   147

	int num = 0;

   148

   149

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

   150

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

   151

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

   152

		}

   153

	}

   154

   155

	return num;

   156

}

   157

   158

/**

   159

 * Check whether the tile is a mine.

   160

 * @param tile the tile to investigate.

   161

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

   162

 */

   163

static bool CMSAMine(TileIndex tile)

   164

{

   165

	/* No industry */

   166

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

   167

   168

	const Industry *ind = GetIndustryByTile(tile);

   169

   170

	/* No extractive industry */

   171

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

   172

   173

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

   174

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

   175

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

   176

	}

   177

   178

	return false;

   179

}

   180

   181

/**

   182

 * Check whether the tile is water.

   183

 * @param tile the tile to investigate.

   184

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

   185

 */

   186

static bool CMSAWater(TileIndex tile)

   187

{

   188

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

   189

}

   190

   191

/**

   192

 * Check whether the tile is a tree.

   193

 * @param tile the tile to investigate.

   194

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

   195

 */

   196

static bool CMSATree(TileIndex tile)

   197

{

   198

	return IsTileType(tile, MP_TREES);

   199

}

   200

   201

/**

   202

 * Check whether the tile is a forest.

   203

 * @param tile the tile to investigate.

   204

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

   205

 */

   206

static bool CMSAForest(TileIndex tile)

   207

{

   208

	/* No industry */

   209

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

   210

   211

	const Industry *ind = GetIndustryByTile(tile);

   212

   213

	/* No extractive industry */

   214

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

   215

   216

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

   217

		/* The industry produces wood. */

   218

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

   219

	}

   220

   221

	return false;

   222

}

   223

   224

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

   225

   226

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

   227

{

   228

	static const uint32 _gen_station_name_bits[] = {

   229

		0,                                      /* 0 */

   230

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

   231

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

   232

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

   233

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

   234

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

   235

	};

   236

   237

	Town *t = st->town;

   238

	uint32 free_names = (uint32)-1;

   239

	int found;

   240

	unsigned long tmp;

   241

   242

	{

   243

		Station *s;

   244

   245

		FOR_ALL_STATIONS(s) {

   246

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

   247

				uint str = M(s->string_id);

   248

				if (str <= 0x20) {

   249

					if (str == M(STR_SV_STNAME_FOREST))

   250

						str = M(STR_SV_STNAME_WOODS);

   251

					CLRBIT(free_names, str);

   252

				}

   253

			}

   254

		}

   255

	}

   256

   257

	/* check default names */

   258

	tmp = free_names & _gen_station_name_bits[flag];

   259

	if (tmp != 0) {

   260

		found = FindFirstBit(tmp);

   261

		goto done;

   262

	}

   263

   264

	/* check mine? */

   265

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

   266

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

   267

			found = M(STR_SV_STNAME_MINES);

   268

			goto done;

   269

		}

   270

	}

   271

   272

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

   273

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

   274

		found = M(STR_SV_STNAME);

   275

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

   276

   277

		found = M(STR_SV_STNAME_CENTRAL);

   278

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

   279

	}

   280

   281

	/* Check lakeside */

   282

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

   283

			DistanceFromEdge(tile) < 20 &&

   284

			CountMapSquareAround(tile, CMSAWater) >= 5) {

   285

		found = M(STR_SV_STNAME_LAKESIDE);

   286

		goto done;

   287

	}

   288

   289

	/* Check woods */

   290

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

   291

				CountMapSquareAround(tile, CMSATree) >= 8 ||

   292

				CountMapSquareAround(tile, CMSAForest) >= 2)

   293

			) {

   294

		found = _opt.landscape == LT_TROPIC ?

   295

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   296

		goto done;

   297

	}

   298

   299

	/* check elevation compared to town */

   300

	{

   301

		uint z = GetTileZ(tile);

   302

		uint z2 = GetTileZ(t->xy);

   303

		if (z < z2) {

   304

			found = M(STR_SV_STNAME_VALLEY);

   305

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

   306

		} else if (z > z2) {

   307

			found = M(STR_SV_STNAME_HEIGHTS);

   308

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

   309

		}

   310

	}

   311

   312

	/* check direction compared to town */

   313

	{

   314

		static const int8 _direction_and_table[] = {

   315

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

   316

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

   317

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

   318

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

   319

		};

   320

   321

		free_names &= _direction_and_table[

   322

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

   323

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

   324

	}

   325

   326

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

   327

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

   328

   329

done:

   330

	st->string_id = found + STR_SV_STNAME;

   331

	return true;

   332

}

   333

#undef M

   334

   335

static Station* GetClosestStationFromTile(TileIndex tile)

   336

{

   337

	uint threshold = 8;

   338

	Station* best_station = NULL;

   339

	Station* st;

   340

   341

	FOR_ALL_STATIONS(st) {

   342

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

   343

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

   344

   345

			if (cur_dist < threshold) {

   346

				threshold = cur_dist;

   347

				best_station = st;

   348

			}

   349

		}

   350

	}

   351

   352

	return best_station;

   353

}

   354

   355

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

   356

// st = Station to update for.

   357

static void UpdateStationVirtCoord(Station *st)

   358

{

   359

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

   360

   361

	pt.y -= 32;

   362

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

   363

   364

	SetDParam(0, st->index);

   365

	SetDParam(1, st->facilities);

   366

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

   367

}

   368

   369

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

   370

void UpdateAllStationVirtCoord()

   371

{

   372

	Station* st;

   373

   374

	FOR_ALL_STATIONS(st) {

   375

		UpdateStationVirtCoord(st);

   376

	}

   377

}

   378

   379

/**

   380

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

   381

 *

   382

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

   383

 *

   384

 * @param st The station to update the virt coords

   385

 * @ingroup dirty

   386

 */

   387

static void UpdateStationVirtCoordDirty(Station *st)

   388

{

   389

	st->MarkDirty();

   390

	UpdateStationVirtCoord(st);

   391

	st->MarkDirty();

   392

}

   393

   394

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

   395

static uint GetAcceptanceMask(const Station *st)

   396

{

   397

	uint mask = 0;

   398

   399

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

   400

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

   401

	}

   402

	return mask;

   403

}

   404

   405

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

   406

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

   407

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

   408

{

   409

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

   410

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

   411

	}

   412

   413

	SetDParam(0, st->index);

   414

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

   415

}

   416

   417

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

   418

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   419

	int w, int h, int rad)

   420

{

   421

	memset(produced, 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 x1 = max(x - rad, 0);

   430

   431

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

   432

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

   433

   434

	assert(x1 < x2);

   435

	assert(y1 < y2);

   436

	assert(w > 0);

   437

	assert(h > 0);

   438

   439

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

   440

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

   441

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

   442

				TileIndex tile = TileXY(xc, yc);

   443

   444

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

   445

				if (gpc != NULL) {

   446

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

   447

   448

					gpc(tile, cargos);

   449

					if (cargos[0] != CT_INVALID) {

   450

						produced[cargos[0]]++;

   451

						if (cargos[1] != CT_INVALID) {

   452

							produced[cargos[1]]++;

   453

						}

   454

					}

   455

				}

   456

			}

   457

		}

   458

	}

   459

}

   460

   461

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

   462

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile,

   463

	int w, int h, int rad)

   464

{

   465

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

   466

   467

	int x = TileX(tile);

   468

	int y = TileY(tile);

   469

   470

	// expand the region by rad tiles on each side

   471

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

   472

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

   473

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

   474

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

   475

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

   476

   477

	assert(x1 < x2);

   478

	assert(y1 < y2);

   479

	assert(w > 0);

   480

	assert(h > 0);

   481

   482

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

   483

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

   484

			TileIndex tile = TileXY(xc, yc);

   485

   486

			if (!IsTileType(tile, MP_STATION)) {

   487

				AcceptedCargo ac;

   488

   489

				GetAcceptedCargo(tile, ac);

   490

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

   491

			}

   492

		}

   493

	}

   494

}