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"

    47

    48

#include "table/sprites.h"

    49

#include "table/strings.h"

    50

    51

DEFINE_OLD_POOL_GENERIC(Station, Station)

    52

DEFINE_OLD_POOL_GENERIC(RoadStop, RoadStop)

    53

    54

    55

/**

    56

 * Check whether the given tile is a hangar.

    57

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

    58

 * @pre IsTileType(t, MP_STATION)

    59

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

    60

 */

    61

bool IsHangar(TileIndex t)

    62

{

    63

	assert(IsTileType(t, MP_STATION));

    64

    65

	const Station *st = GetStationByTile(t);

    66

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

    67

    68

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

    69

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

    70

	}

    71

    72

	return false;

    73

}

    74

    75

RoadStop *GetRoadStopByTile(TileIndex tile, RoadStopType type)

    76

{

    77

	const Station *st = GetStationByTile(tile);

    78

    79

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

    80

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

    81

		assert(rs->next != NULL);

    82

	}

    83

}

    84

    85

    86

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

    87

{

    88

	uint num = 0;

    89

    90

	assert(st != NULL);

    91

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

    92

		num++;

    93

	}

    94

    95

	return num;

    96

}

    97

    98

    99

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

   100

 *  radius that is available within the station

   101

 * @param st Station to query

   102

 * @return the so calculated radius

   103

 */

   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

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

   139

 * @param tile the tile to check

   140

 * @return true if it matches, false otherwise

   141

 */

   142

typedef bool (*CMSAMatcher)(TileIndex tile);

   143

   144

/**

   145

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

   146

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

   147

 * @param type the type of tile searched for

   148

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

   149

 *                 in all other cases this parameter is ignored

   150

 * @return the result the noumber of matching tiles around

   151

 */

   152

static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)

   153

{

   154

	int num = 0;

   155

   156

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

   157

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

   158

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

   159

		}

   160

	}

   161

   162

	return num;

   163

}

   164

   165

/**

   166

 * Check whether the tile is a mine.

   167

 * @param tile the tile to investigate.

   168

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

   169

 */

   170

static bool CMSAMine(TileIndex tile)

   171

{

   172

	/* No industry */

   173

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

   174

   175

	const Industry *ind = GetIndustryByTile(tile);

   176

   177

	/* No extractive industry */

   178

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

   179

   180

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

   181

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

   182

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

   183

	}

   184

   185

	return false;

   186

}

   187

   188

/**

   189

 * Check whether the tile is water.

   190

 * @param tile the tile to investigate.

   191

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

   192

 */

   193

static bool CMSAWater(TileIndex tile)

   194

{

   195

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

   196

}

   197

   198

/**

   199

 * Check whether the tile is a tree.

   200

 * @param tile the tile to investigate.

   201

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

   202

 */

   203

static bool CMSATree(TileIndex tile)

   204

{

   205

	return IsTileType(tile, MP_TREES);

   206

}

   207

   208

/**

   209

 * Check whether the tile is a forest.

   210

 * @param tile the tile to investigate.

   211

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

   212

 */

   213

static bool CMSAForest(TileIndex tile)

   214

{

   215

	/* No industry */

   216

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

   217

   218

	const Industry *ind = GetIndustryByTile(tile);

   219

   220

	/* No extractive industry */

   221

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

   222

   223

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

   224

		/* The industry produces wood. */

   225

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

   226

	}

   227

   228

	return false;

   229

}

   230

   231

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

   232

   233

enum StationNaming {

   234

	STATIONNAMING_RAIL = 0,

   235

	STATIONNAMING_ROAD = 0,

   236

	STATIONNAMING_AIRPORT,

   237

	STATIONNAMING_OILRIG,

   238

	STATIONNAMING_DOCK,

   239

	STATIONNAMING_BUOY,

   240

	STATIONNAMING_HELIPORT,

   241

};

   242

   243

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

   244

{

   245

	static const uint32 _gen_station_name_bits[] = {

   246

		0,                                      /* 0 */

   247

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

   248

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

   249

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

   250

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

   251

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

   252

	};

   253

   254

	const Town *t = st->town;

   255

	uint32 free_names = UINT32_MAX;

   256

   257

	const Station *s;

   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

				}

   265

				ClrBit(free_names, str);

   266

			}

   267

		}

   268

	}

   269

   270

	/* check default names */

   271

	uint32 tmp = free_names & _gen_station_name_bits[flag];

   272

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

   273

   274

	/* check mine? */

   275

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

   276

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

   277

			return STR_SV_STNAME_MINES;

   278

		}

   279

	}

   280

   281

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

   282

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

   283

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

   284

   285

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

   286

	}

   287

   288

	/* Check lakeside */

   289

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

   290

			DistanceFromEdge(tile) < 20 &&

   291

			CountMapSquareAround(tile, CMSAWater) >= 5) {

   292

		return STR_SV_STNAME_LAKESIDE;

   293

	}

   294

   295

	/* Check woods */

   296

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

   297

				CountMapSquareAround(tile, CMSATree) >= 8 ||

   298

				CountMapSquareAround(tile, CMSAForest) >= 2)

   299

			) {

   300

		return _settings_game.game_creation.landscape == LT_TROPIC ? STR_SV_STNAME_FOREST : STR_SV_STNAME_WOODS;

   301

	}

   302

   303

	/* check elevation compared to town */

   304

	uint z = GetTileZ(tile);

   305

	uint z2 = GetTileZ(t->xy);

   306

	if (z < z2) {

   307

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

   308

	} else if (z > z2) {

   309

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

   310

	}

   311

   312

	/* check direction compared to town */

   313

	static const int8 _direction_and_table[] = {

   314

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

   315

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

   316

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

   317

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

   318

	};

   319

   320

	free_names &= _direction_and_table[

   321

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

   322

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

   323

   324

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

   325

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

   326

}

   327

#undef M

   328

   329

static Station *GetClosestStationFromTile(TileIndex tile)

   330

{

   331

	uint threshold = 8;

   332

	Station *best_station = NULL;

   333

	Station *st;

   334

   335

	FOR_ALL_STATIONS(st) {

   336

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

   337

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

   338

   339

			if (cur_dist < threshold) {

   340

				threshold = cur_dist;

   341

				best_station = st;

   342

			}

   343

		}

   344

	}

   345

   346

	return best_station;

   347

}

   348

   349

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

   350

 * @param st Station to update for.

   351

 */

   352

static void UpdateStationVirtCoord(Station *st)

   353

{

   354

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

   355

   356

	pt.y -= 32;

   357

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

   358

   359

	SetDParam(0, st->index);

   360

	SetDParam(1, st->facilities);

   361

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

   362

}

   363

   364

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

   365

void UpdateAllStationVirtCoord()

   366

{

   367

	Station *st;

   368

   369

	FOR_ALL_STATIONS(st) {

   370

		UpdateStationVirtCoord(st);

   371

	}

   372

}

   373

   374

/**

   375

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

   376

 *

   377

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

   378

 *

   379

 * @param st The station to update the virt coords

   380

 * @ingroup dirty

   381

 */

   382

static void UpdateStationVirtCoordDirty(Station *st)

   383

{

   384

	st->MarkDirty();

   385

	UpdateStationVirtCoord(st);

   386

	st->MarkDirty();

   387

}

   388

   389

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

   390

 * @param st Station to query

   391

 * @return the expected mask

   392

 */

   393

static uint GetAcceptanceMask(const Station *st)

   394

{

   395

	uint mask = 0;

   396

   397

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

   398

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

   399

	}

   400

	return mask;

   401

}

   402

   403

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

   404

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

   405

 */

   406

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

   407

{

   408

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

   409

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

   410

	}

   411

   412

	SetDParam(0, st->index);

   413

	AddNewsItem(msg, NS_ACCEPTANCE, st->xy, 0);

   414

}

   415

   416

/**

   417

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

   418

 * @param produced: Destination array of produced cargo

   419

 * @param tile: Center of the search area

   420

 * @param w: Width of the center

   421

 * @param h: Height of the center

   422

 * @param rad: Radius of the search area

   423

 */

   424

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   425

	int w, int h, int rad)

   426

{

   427

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

   428

   429

	int x = TileX(tile);

   430

	int y = TileY(tile);

   431

   432

	/* expand the region by rad tiles on each side

   433

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

   434

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

   435

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

   436

   437

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

   438

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

   439

   440

	assert(x1 < x2);

   441

	assert(y1 < y2);

   442

	assert(w > 0);

   443

	assert(h > 0);

   444

   445

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

   446

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

   447

			TileIndex tile = TileXY(xc, yc);

   448

   449

			if (!IsTileType(tile, MP_STATION)) {

   450

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

   451

				if (gpc != NULL) {

   452

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

   453

					memset(cargos, CT_INVALID, 256);

   454

   455

					gpc(tile, cargos);

   456

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

   457

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

   458

					}

   459

				}

   460

			}

   461

		}

   462

	}

   463

}

   464

   465

/**

   466

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

   467

 * @param accepts: Destination array of accepted cargo

   468

 * @param tile: Center of the search area

   469

 * @param w: Width of the center

   470

 * @param h: Height of the center

   471

 * @param rad: Radius of the rectangular search area

   472

 */

   473

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile,

   474

	int w, int h, int rad)

   475

{

   476

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

   477

   478

	int x = TileX(tile);

   479

	int y = TileY(tile);

   480

   481

	/* expand the region by rad tiles on each side

   482

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

   483

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

   484

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

   485

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

   486

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

   487

   488

	assert(x1 < x2);

   489

	assert(y1 < y2);