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

#include "transparency.h"

    47

    48

DEFINE_OLD_POOL_GENERIC(Station, Station)

    49

DEFINE_OLD_POOL_GENERIC(RoadStop, RoadStop)

    50

    51

    52

/**

    53

 * Check whether the given tile is a hangar.

    54

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

    55

 * @pre IsTileType(t, MP_STATION)

    56

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

    57

 */

    58

bool IsHangar(TileIndex t)

    59

{

    60

	assert(IsTileType(t, MP_STATION));

    61

    62

	const Station *st = GetStationByTile(t);

    63

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

    64

    65

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

    66

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

    67

	}

    68

    69

	return false;

    70

}

    71

    72

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

    73

{

    74

	const Station* st = GetStationByTile(tile);

    75

    76

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

    77

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

    78

		assert(rs->next != NULL);

    79

	}

    80

}

    81

    82

    83

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

    84

{

    85

	uint num = 0;

    86

    87

	assert(st != NULL);

    88

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

    89

		num++;

    90

	}

    91

    92

	return num;

    93

}

    94

    95

    96

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

    97

 *  radius that is available within the station

    98

 * @param st Station to query

    99

 * @return the so calculated radius

   100

 */

   101

static uint FindCatchmentRadius(const Station* st)

   102

{

   103

	uint ret = CA_NONE;

   104

   105

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

   106

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

   107

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

   108

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

   109

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

   110

   111

	return ret;

   112

}

   113

   114

#define CHECK_STATIONS_ERR ((Station*)-1)

   115

   116

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

   117

{

   118

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

   119

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

   120

		if (IsTileType(tile_cur, MP_STATION)) {

   121

			StationID t = GetStationIndex(tile_cur);

   122

   123

			if (closest_station == INVALID_STATION) {

   124

				closest_station = t;

   125

			} else if (closest_station != t) {

   126

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   127

				return CHECK_STATIONS_ERR;

   128

			}

   129

		}

   130

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

   131

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

   132

}

   133

   134

/**

   135

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

   136

 * @param tile the tile to check

   137

 * @return true if it matches, false otherwise

   138

 */

   139

typedef bool (*CMSAMatcher)(TileIndex tile);

   140

   141

/**

   142

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

   143

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

   144

 * @param type the type of tile searched for

   145

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

   146

 *                 in all other cases this parameter is ignored

   147

 * @return the result the noumber of matching tiles around

   148

 */

   149

static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)

   150

{

   151

	int num = 0;

   152

   153

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

   154

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

   155

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

   156

		}

   157

	}

   158

   159

	return num;

   160

}

   161

   162

/**

   163

 * Check whether the tile is a mine.

   164

 * @param tile the tile to investigate.

   165

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

   166

 */

   167

static bool CMSAMine(TileIndex tile)

   168

{

   169

	/* No industry */

   170

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

   171

   172

	const Industry *ind = GetIndustryByTile(tile);

   173

   174

	/* No extractive industry */

   175

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

   176

   177

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

   178

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

   179

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

   180

	}

   181

   182

	return false;

   183

}

   184

   185

/**

   186

 * Check whether the tile is water.

   187

 * @param tile the tile to investigate.

   188

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

   189

 */

   190

static bool CMSAWater(TileIndex tile)

   191

{

   192

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

   193

}

   194

   195

/**

   196

 * Check whether the tile is a tree.

   197

 * @param tile the tile to investigate.

   198

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

   199

 */

   200

static bool CMSATree(TileIndex tile)

   201

{

   202

	return IsTileType(tile, MP_TREES);

   203

}

   204

   205

/**

   206

 * Check whether the tile is a forest.

   207

 * @param tile the tile to investigate.

   208

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

   209

 */

   210

static bool CMSAForest(TileIndex tile)

   211

{

   212

	/* No industry */

   213

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

   214

   215

	const Industry *ind = GetIndustryByTile(tile);

   216

   217

	/* No extractive industry */

   218

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

   219

   220

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

   221

		/* The industry produces wood. */

   222

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

   223

	}

   224

   225

	return false;

   226

}

   227

   228

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

   229

   230

enum StationNaming {

   231

	STATIONNAMING_RAIL = 0,

   232

	STATIONNAMING_ROAD = 0,

   233

	STATIONNAMING_AIRPORT,

   234

	STATIONNAMING_OILRIG,

   235

	STATIONNAMING_DOCK,

   236

	STATIONNAMING_BUOY,

   237

	STATIONNAMING_HELIPORT,

   238

};

   239

   240

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

   241

{

   242

	static const uint32 _gen_station_name_bits[] = {

   243

		0,                                      /* 0 */

   244

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

   245

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

   246

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

   247

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

   248

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

   249

	};

   250

   251

	Town *t = st->town;

   252

	uint32 free_names = (uint32)-1;

   253

	int found;

   254

	unsigned long tmp;

   255

   256

	{

   257

		Station *s;

   258

   259

		FOR_ALL_STATIONS(s) {

   260

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

   261

				uint str = M(s->string_id);

   262

				if (str <= 0x20) {

   263

					if (str == M(STR_SV_STNAME_FOREST))

   264

						str = M(STR_SV_STNAME_WOODS);

   265

					ClrBit(free_names, str);

   266

				}

   267

			}

   268

		}

   269

	}

   270

   271

	/* check default names */

   272

	tmp = free_names & _gen_station_name_bits[flag];

   273

	if (tmp != 0) {

   274

		found = FindFirstBit(tmp);

   275

		goto done;

   276

	}

   277

   278

	/* check mine? */

   279

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

   280

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

   281

			found = M(STR_SV_STNAME_MINES);

   282

			goto done;

   283

		}

   284

	}

   285

   286

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

   287

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

   288

		found = M(STR_SV_STNAME);

   289

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

   290

   291

		found = M(STR_SV_STNAME_CENTRAL);

   292

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

   293

	}

   294

   295

	/* Check lakeside */

   296

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

   297

			DistanceFromEdge(tile) < 20 &&

   298

			CountMapSquareAround(tile, CMSAWater) >= 5) {

   299

		found = M(STR_SV_STNAME_LAKESIDE);

   300

		goto done;

   301

	}

   302

   303

	/* Check woods */

   304

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

   305

				CountMapSquareAround(tile, CMSATree) >= 8 ||

   306

				CountMapSquareAround(tile, CMSAForest) >= 2)

   307

			) {

   308

		found = _opt.landscape == LT_TROPIC ?

   309

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   310

		goto done;

   311

	}

   312

   313

	/* check elevation compared to town */

   314

	{

   315

		uint z = GetTileZ(tile);

   316

		uint z2 = GetTileZ(t->xy);

   317

		if (z < z2) {

   318

			found = M(STR_SV_STNAME_VALLEY);

   319

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

   320

		} else if (z > z2) {

   321

			found = M(STR_SV_STNAME_HEIGHTS);

   322

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

   323

		}

   324

	}

   325

   326

	/* check direction compared to town */

   327

	{

   328

		static const int8 _direction_and_table[] = {

   329

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

   330

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

   331

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

   332

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

   333

		};

   334

   335

		free_names &= _direction_and_table[

   336

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

   337

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

   338

	}

   339

   340

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

   341

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

   342

   343

done:

   344

	st->string_id = found + STR_SV_STNAME;

   345

	return true;

   346

}

   347

#undef M

   348

   349

static Station* GetClosestStationFromTile(TileIndex tile)

   350

{

   351

	uint threshold = 8;

   352

	Station* best_station = NULL;

   353

	Station* st;

   354

   355

	FOR_ALL_STATIONS(st) {

   356

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

   357

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

   358

   359

			if (cur_dist < threshold) {

   360

				threshold = cur_dist;

   361

				best_station = st;

   362

			}

   363

		}

   364

	}

   365

   366

	return best_station;

   367

}

   368

   369

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

   370

 * @param st Station to update for.

   371

 */

   372

static void UpdateStationVirtCoord(Station *st)

   373

{

   374

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

   375

   376

	pt.y -= 32;

   377

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

   378

   379

	SetDParam(0, st->index);

   380

	SetDParam(1, st->facilities);

   381

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

   382

}

   383

   384

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

   385

void UpdateAllStationVirtCoord()

   386

{

   387

	Station* st;

   388

   389

	FOR_ALL_STATIONS(st) {

   390

		UpdateStationVirtCoord(st);

   391

	}

   392

}

   393

   394

/**

   395

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

   396

 *

   397

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

   398

 *

   399

 * @param st The station to update the virt coords

   400

 * @ingroup dirty

   401

 */

   402

static void UpdateStationVirtCoordDirty(Station *st)

   403

{

   404

	st->MarkDirty();

   405

	UpdateStationVirtCoord(st);

   406

	st->MarkDirty();

   407

}

   408

   409

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

   410

 * @param st Station to query

   411

 * @return the expected mask

   412

 */

   413

static uint GetAcceptanceMask(const Station *st)

   414

{

   415

	uint mask = 0;

   416

   417

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

   418

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

   419

	}

   420

	return mask;

   421

}

   422

   423

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

   424

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

   425

 */

   426

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

   427

{

   428

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

   429

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

   430

	}

   431

   432

	SetDParam(0, st->index);

   433

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

   434

}

   435

   436

/**

   437

* Get a list of the cargo types being produced around the tile (in a rectangle).

   438

* @param produced: Destination array of produced cargo

   439

* @param tile: Center of the search area

   440

* @param w: Width of the center

   441

* @param h: Height of the center

   442

* @param rad: Radius of the search area

   443

*/

   444

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   445

	int w, int h, int rad)

   446

{

   447

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

   448

   449

	int x = TileX(tile);

   450

	int y = TileY(tile);

   451

   452

	/* expand the region by rad tiles on each side

   453

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

   454

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

   455

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

   456

   457

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

   458

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

   459

   460

	assert(x1 < x2);

   461

	assert(y1 < y2);

   462

	assert(w > 0);

   463

	assert(h > 0);

   464

   465

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

   466

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

   467

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

   468

				TileIndex tile = TileXY(xc, yc);

   469

   470

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

   471

				if (gpc != NULL) {

   472

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

   473

   474

					gpc(tile, cargos);

   475

					if (cargos[0] != CT_INVALID) {

   476

						produced[cargos[0]]++;

   477

						if (cargos[1] != CT_INVALID) {

   478

							produced[cargos[1]]++;

   479

						}

   480

					}

   481

				}

   482

			}

   483

		}

   484

	}

   485

}

   486

   487

/**

   488

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

   489

* @param accepts: Destination array of accepted cargo

   490

* @param tile: Center of the search area

   491

* @param w: Width of the center

   492

* @param h: Height of the center