1

/* $Id$ */

     2

     3

/** @file station_cmd.cpp Handling of station tiles. */

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

    12

#include "landscape.h"

    13

#include "station_map.h"

    14

#include "viewport_func.h"

    15

#include "command_func.h"

    16

#include "town.h"

    17

#include "news_func.h"

    18

#include "saveload.h"

    19

#include "airport.h"

    20

#include "sprite.h"

    21

#include "train.h"

    22

#include "roadveh.h"

    23

#include "water_map.h"

    24

#include "industry_map.h"

    25

#include "newgrf_callbacks.h"

    26

#include "newgrf_station.h"

    27

#include "yapf/yapf.h"

    28

#include "road_type.h"

    29

#include "road_internal.h" /* For drawing catenary/checking road removal */

    30

#include "cargotype.h"

    31

#include "variables.h"

    32

#include "autoslope.h"

    33

#include "transparency.h"

    34

#include "water.h"

    35

#include "station_gui.h"

    36

#include "strings_func.h"

    37

#include "functions.h"

    38

#include "window_func.h"

    39

#include "date_func.h"

    40

#include "vehicle_func.h"

    41

#include "string_func.h"

    42

#include "signal_func.h"

    43

#include "oldpool_func.h"

    44

#include "animated_tile_func.h"

    45

#include "elrail_func.h"

    46

    47

#include "table/sprites.h"

    48

#include "table/strings.h"

    49

    50

DEFINE_OLD_POOL_GENERIC(Station, Station)

    51

DEFINE_OLD_POOL_GENERIC(RoadStop, RoadStop)

    52

    53

    54

/**

    55

 * Check whether the given tile is a hangar.

    56

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

    57

 * @pre IsTileType(t, MP_STATION)

    58

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

    59

 */

    60

bool IsHangar(TileIndex t)

    61

{

    62

	assert(IsTileType(t, MP_STATION));

    63

    64

	const Station *st = GetStationByTile(t);

    65

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

    66

    67

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

    68

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

    69

	}

    70

    71

	return false;

    72

}

    73

    74

RoadStop *GetRoadStopByTile(TileIndex tile, RoadStopType type)

    75

{

    76

	const Station *st = GetStationByTile(tile);

    77

    78

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

    79

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

    80

		assert(rs->next != NULL);

    81

	}

    82

}

    83

    84

    85

static uint GetNumRoadStopsInStation(const Station *st, RoadStopType type)

    86

{

    87

	uint num = 0;

    88

    89

	assert(st != NULL);

    90

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

    91

		num++;

    92

	}

    93

    94

	return num;

    95

}

    96

    97

    98

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

    99

 *  radius that is available within the station

   100

 * @param st Station to query

   101

 * @return the so calculated radius

   102

 */

   103

static uint FindCatchmentRadius(const Station *st)

   104

{

   105

	uint ret = CA_NONE;

   106

   107

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

   108

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

   109

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

   110

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

   111

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

   112

   113

	return ret;

   114

}

   115

   116

#define CHECK_STATIONS_ERR ((Station*)-1)

   117

   118

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

   119

{

   120

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

   121

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

   122

		if (IsTileType(tile_cur, MP_STATION)) {

   123

			StationID t = GetStationIndex(tile_cur);

   124

   125

			if (closest_station == INVALID_STATION) {

   126

				closest_station = t;

   127

			} else if (closest_station != t) {

   128

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   129

				return CHECK_STATIONS_ERR;

   130

			}

   131

		}

   132

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

   133

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

   134

}

   135

   136

/**

   137

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

   138

 * @param tile the tile to check

   139

 * @return true if it matches, false otherwise

   140

 */

   141

typedef bool (*CMSAMatcher)(TileIndex tile);

   142

   143

/**

   144

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

   145

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

   146

 * @param type the type of tile searched for

   147

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

   148

 *                 in all other cases this parameter is ignored

   149

 * @return the result the noumber of matching tiles around

   150

 */

   151

static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)

   152

{

   153

	int num = 0;

   154

   155

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

   156

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

   157

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

   158

		}

   159

	}

   160

   161

	return num;

   162

}

   163

   164

/**

   165

 * Check whether the tile is a mine.

   166

 * @param tile the tile to investigate.

   167

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

   168

 */

   169

static bool CMSAMine(TileIndex tile)

   170

{

   171

	/* No industry */

   172

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

   173

   174

	const Industry *ind = GetIndustryByTile(tile);

   175

   176

	/* No extractive industry */

   177

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

   178

   179

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

   180

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

   181

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

   182

	}

   183

   184

	return false;

   185

}

   186

   187

/**

   188

 * Check whether the tile is water.

   189

 * @param tile the tile to investigate.

   190

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

   191

 */

   192

static bool CMSAWater(TileIndex tile)

   193

{

   194

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

   195

}

   196

   197

/**

   198

 * Check whether the tile is a tree.

   199

 * @param tile the tile to investigate.

   200

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

   201

 */

   202

static bool CMSATree(TileIndex tile)

   203

{

   204

	return IsTileType(tile, MP_TREES);

   205

}

   206

   207

/**

   208

 * Check whether the tile is a forest.

   209

 * @param tile the tile to investigate.

   210

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

   211

 */

   212

static bool CMSAForest(TileIndex tile)

   213

{

   214

	/* No industry */

   215

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

   216

   217

	const Industry *ind = GetIndustryByTile(tile);

   218

   219

	/* No extractive industry */

   220

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

   221

   222

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

   223

		/* The industry produces wood. */

   224

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

   225

	}

   226

   227

	return false;

   228

}

   229

   230

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

   231

   232

enum StationNaming {

   233

	STATIONNAMING_RAIL = 0,

   234

	STATIONNAMING_ROAD = 0,

   235

	STATIONNAMING_AIRPORT,

   236

	STATIONNAMING_OILRIG,

   237

	STATIONNAMING_DOCK,

   238

	STATIONNAMING_BUOY,

   239

	STATIONNAMING_HELIPORT,

   240

};

   241

   242

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

   243

{

   244

	static const uint32 _gen_station_name_bits[] = {

   245

		0,                                      /* 0 */

   246

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

   247

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

   248

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

   249

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

   250

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

   251

	};

   252

   253

	const Town *t = st->town;

   254

	uint32 free_names = UINT32_MAX;

   255

   256

	const Station *s;

   257

	FOR_ALL_STATIONS(s) {

   258

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

   259

			uint str = M(s->string_id);

   260

			if (str <= 0x20) {

   261

				if (str == M(STR_SV_STNAME_FOREST)) {

   262

					str = M(STR_SV_STNAME_WOODS);

   263

				}

   264

				ClrBit(free_names, str);

   265

			}

   266

		}

   267

	}

   268

   269

	/* check default names */

   270

	uint32 tmp = free_names & _gen_station_name_bits[flag];

   271

	if (tmp != 0) return STR_SV_STNAME + FindFirstBit(tmp);

   272

   273

	/* check mine? */

   274

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

   275

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

   276

			return STR_SV_STNAME_MINES;

   277

		}

   278

	}

   279

   280

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

   281

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

   282

		if (HasBit(free_names, M(STR_SV_STNAME))) return STR_SV_STNAME;

   283

   284

		if (HasBit(free_names, M(STR_SV_STNAME_CENTRAL))) return STR_SV_STNAME_CENTRAL;

   285

	}

   286

   287

	/* Check lakeside */

   288

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

   289

			DistanceFromEdge(tile) < 20 &&

   290

			CountMapSquareAround(tile, CMSAWater) >= 5) {

   291

		return STR_SV_STNAME_LAKESIDE;

   292

	}

   293

   294

	/* Check woods */

   295

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

   296

				CountMapSquareAround(tile, CMSATree) >= 8 ||

   297

				CountMapSquareAround(tile, CMSAForest) >= 2)

   298

			) {

   299

		return _opt.landscape == LT_TROPIC ? STR_SV_STNAME_FOREST : STR_SV_STNAME_WOODS;

   300

	}

   301

   302

	/* check elevation compared to town */

   303

	uint z = GetTileZ(tile);

   304

	uint z2 = GetTileZ(t->xy);

   305

	if (z < z2) {

   306

		if (HasBit(free_names, M(STR_SV_STNAME_VALLEY))) return STR_SV_STNAME_VALLEY;

   307

	} else if (z > z2) {

   308

		if (HasBit(free_names, M(STR_SV_STNAME_HEIGHTS))) return STR_SV_STNAME_HEIGHTS;

   309

	}

   310

   311

	/* check direction compared to town */

   312

	static const int8 _direction_and_table[] = {

   313

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

   314

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

   315

		~( (1 << M(STR_SV_STNAME_SOUTH)) | (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_EAST)) ),

   317

	};

   318

   319

	free_names &= _direction_and_table[

   320

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

   321

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

   322

   323

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

   324

	return (tmp == 0) ? STR_SV_STNAME_FALLBACK : (STR_SV_STNAME + FindFirstBit(tmp));

   325

}

   326

#undef M

   327

   328

static Station *GetClosestStationFromTile(TileIndex tile)

   329

{

   330

	uint threshold = 8;

   331

	Station *best_station = NULL;

   332

	Station *st;

   333

   334

	FOR_ALL_STATIONS(st) {

   335

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

   336

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

   337

   338

			if (cur_dist < threshold) {

   339

				threshold = cur_dist;

   340

				best_station = st;

   341

			}

   342

		}

   343

	}

   344

   345

	return best_station;

   346

}

   347

   348

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

   349

 * @param st Station to update for.

   350

 */

   351

static void UpdateStationVirtCoord(Station *st)

   352

{

   353

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

   354

   355

	pt.y -= 32;

   356

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

   357

   358

	SetDParam(0, st->index);

   359

	SetDParam(1, st->facilities);

   360

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

   361

}

   362

   363

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

   364

void UpdateAllStationVirtCoord()

   365

{

   366

	Station *st;

   367

   368

	FOR_ALL_STATIONS(st) {

   369

		UpdateStationVirtCoord(st);

   370

	}

   371

}

   372

   373

/**

   374

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

   375

 *

   376

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

   377

 *

   378

 * @param st The station to update the virt coords

   379

 * @ingroup dirty

   380

 */

   381

static void UpdateStationVirtCoordDirty(Station *st)

   382

{

   383

	st->MarkDirty();

   384

	UpdateStationVirtCoord(st);

   385

	st->MarkDirty();

   386

}

   387

   388

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

   389

 * @param st Station to query

   390

 * @return the expected mask

   391

 */

   392

static uint GetAcceptanceMask(const Station *st)

   393

{

   394

	uint mask = 0;

   395

   396

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

   397

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

   398

	}

   399

	return mask;

   400

}

   401

   402

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

   403

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

   404

 */

   405

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

   406

{

   407

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

   408

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

   409

	}

   410

   411

	SetDParam(0, st->index);

   413

}

   414

   415

/**

   416

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

   417

 * @param produced: Destination array of produced cargo

   418

 * @param tile: Center of the search area

   419

 * @param w: Width of the center

   420

 * @param h: Height of the center

   421

 * @param rad: Radius of the search area

   422

 */

   423

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   424

	int w, int h, int rad)

   425

{

   426

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

   427

   428

	int x = TileX(tile);

   429

	int y = TileY(tile);

   430

   431

	/* expand the region by rad tiles on each side

   432

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

   433

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

   434

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

   435

   436

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

   437

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

   438

   439

	assert(x1 < x2);

   440

	assert(y1 < y2);

   441

	assert(w > 0);

   442

	assert(h > 0);

   443

   444

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

   445

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

   446

			TileIndex tile = TileXY(xc, yc);

   447

   448

			if (!IsTileType(tile, MP_STATION)) {

   449

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

   450

				if (gpc != NULL) {

   451

					CargoID cargos[256]; // Required for CBID_HOUSE_PRODUCE_CARGO.

   452

					memset(cargos, CT_INVALID, 256);

   453

   454

					gpc(tile, cargos);

   455

					for (uint i = 0; i < lengthof(cargos); ++i) {

   456

						if (cargos[i] != CT_INVALID) produced[cargos[i]]++;

   457

					}

   458

				}

   459

			}

   460

		}

   461

	}

   462

}

   463

   464

/**

   465

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

   466

 * @param accepts: Destination array of accepted cargo

   467

 * @param tile: Center of the search area

   468

 * @param w: Width of the center

   469

 * @param h: Height of the center

   470

 * @param rad: Radius of the rectangular search area

   471

 */

   472

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile,

   473

	int w, int h, int rad)

   474

{

   475

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

   476

   477

	int x = TileX(tile);

   478

	int y = TileY(tile);

   479

   480

	/* expand the region by rad tiles on each side

   481

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

   482

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

   483

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

   484

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

   485

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

   486

   487

	assert(x1 < x2);

   488

	assert(y1 < y2);

   489

	assert(w > 0);