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

    34

#include "transparency.h"

    35

#include "water.h"

    36

#include "station_gui.h"

    37

#include "strings_func.h"

    38

#include "functions.h"

    39

#include "window_func.h"

    40

#include "date_func.h"

    41

#include "vehicle_func.h"

    42

#include "string_func.h"

    43

#include "signal_func.h"

    44

#include "oldpool_func.h"

    45

#include "animated_tile_func.h"

    46

#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

	Station *st = GetStationByTile(t);

    66

	FSMDepots *hangar_list;

    67

	byte num_depots;

    68

	if (IsCustomFSMportsSpecIndex(t)) {

    69

		hangar_list = st->fsmportsspeclist[1].spec->portFSM->depots;

    70

		num_depots = st->fsmportsspeclist[1].spec->portFSM->num_depots;

    71

	} else {

    72

		hangar_list = st->Airport()->depots;

    73

		num_depots = st->Airport()->num_depots;

    74

	}

    75

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

    76

		TileIndexDiffC depot = RotateFSMPosition(hangar_list[i].tile_pos,

    77

												 st->fsmportsspeclist[1].spec->size_x[st->FSMport_layout_set],

    78

												 st->fsmportsspeclist[1].spec->size_y[st->FSMport_layout_set],

    79

												 st->FSMport_orientation);

    80

		if (st->airport_tile + ToTileIndexDiff(depot) == t) {

    81

			return true;

    82

		}

    83

	}

    84

	return false;

    85

}

    86

    87

    88

FSMDepots GetKeyDepotByTile(TileIndex t)

    89

{

    90

	Station *st = GetStationByTile(t);

    91

    92

	FSMDepots *hangar_list;

    93

	byte num_depots;

    94

	uint i;

    95

    96

	if (IsCustomFSMportsSpecIndex(t)) {

    97

		hangar_list = st->fsmportsspeclist[1].spec->portFSM->depots;

    98

		num_depots = st->fsmportsspeclist[1].spec->portFSM->num_depots;

    99

	} else {

   100

		hangar_list = st->Airport()->depots;

   101

		num_depots = st->Airport()->num_depots;

   102

	}

   103

	for (i = 0; i < num_depots; i++) {

   104

		TileIndexDiffC depot = RotateFSMPosition(hangar_list[i].tile_pos,

   105

												 st->fsmportsspeclist[1].spec->size_x[st->FSMport_layout_set],

   106

												 st->fsmportsspeclist[1].spec->size_y[st->FSMport_layout_set],

   107

												 st->FSMport_orientation);

   108

		if (st->airport_tile + ToTileIndexDiff(depot) == t) {

   109

			break;

   110

		}

   111

	}

   112

	return hangar_list[i];

   113

}

   114

   115

/**

   116

 * goes from a tile location, looks up the depot, finds the location of the key part of the depot in the state machine

   117

 * returns the tile location of that key part

   118

 * @param t: the tile to start from

   119

 * @pre IsHangar(t)

   120

 * @return tile of key part of hangar

   121

 */

   122

TileIndex GetKeyDepotTile(TileIndex t)

   123

{

   124

	Station *st = GetStationByTile(t);

   125

	const FSMPortMovingData *md = st->fsmportsspeclist[1].spec->portFSM->MovingData(GetKeyDepotByTile(t).FSMposition);

   126

	TileIndexDiffC keydepot;

   127

	keydepot.x = md->x / TILE_SIZE;

   128

	keydepot.y = md->y / TILE_SIZE;

   129

	keydepot = RotateFSMPosition(keydepot,

   130

												 st->fsmportsspeclist[1].spec->size_x[st->FSMport_layout_set],

   131

												 st->fsmportsspeclist[1].spec->size_y[st->FSMport_layout_set],

   132

												 st->FSMport_orientation);

   133

	return st->airport_tile + ToTileIndexDiff(keydepot);

   134

}

   135

   136

RoadStop *GetRoadStopByTile(TileIndex tile, RoadStopType type)

   137

{

   138

	const Station *st = GetStationByTile(tile);

   139

   140

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

   141

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

   142

		assert(rs->next != NULL);

   143

	}

   144

}

   145

   146

   147

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

   148

{

   149

	uint num = 0;

   150

   151

	assert(st != NULL);

   152

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

   153

		num++;

   154

	}

   155

   156

	return num;

   157

}

   158

   159

   160

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

   161

 *  radius that is available within the station

   162

 * @param st Station to query

   163

 * @return the so calculated radius

   164

 */

   165

static uint FindCatchmentRadius(const Station *st)

   166

{

   167

	uint ret = CA_NONE;

   168

   169

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

   170

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

   171

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

   172

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

   173

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

   174

   175

	return ret;

   176

}

   177

   178

#define CHECK_STATIONS_ERR ((Station*)-1)

   179

   180

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

   181

{

   182

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

   183

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

   184

		if (IsTileType(tile_cur, MP_STATION)) {

   185

			StationID t = GetStationIndex(tile_cur);

   186

   187

			if (closest_station == INVALID_STATION) {

   188

				closest_station = t;

   189

			} else if (closest_station != t) {

   190

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   191

				return CHECK_STATIONS_ERR;

   192

			}

   193

		}

   194

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

   195

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

   196

}

   197

   198

/**

   199

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

   200

 * @param tile the tile to check

   201

 * @return true if it matches, false otherwise

   202

 */

   203

typedef bool (*CMSAMatcher)(TileIndex tile);

   204

   205

/**

   206

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

   207

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

   208

 * @param type the type of tile searched for

   209

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

   210

 *                 in all other cases this parameter is ignored

   211

 * @return the result the noumber of matching tiles around

   212

 */

   213

static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)

   214

{

   215

	int num = 0;

   216

   217

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

   218

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

   219

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

   220

		}

   221

	}

   222

   223

	return num;

   224

}

   225

   226

/**

   227

 * Check whether the tile is a mine.

   228

 * @param tile the tile to investigate.

   229

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

   230

 */

   231

static bool CMSAMine(TileIndex tile)

   232

{

   233

	/* No industry */

   234

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

   235

   236

	const Industry *ind = GetIndustryByTile(tile);

   237

   238

	/* No extractive industry */

   239

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

   240

   241

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

   242

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

   243

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

   244

	}

   245

   246

	return false;

   247

}

   248

   249

/**

   250

 * Check whether the tile is water.

   251

 * @param tile the tile to investigate.

   252

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

   253

 */

   254

static bool CMSAWater(TileIndex tile)

   255

{

   256

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

   257

}

   258

   259

/**

   260

 * Check whether the tile is a tree.

   261

 * @param tile the tile to investigate.

   262

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

   263

 */

   264

static bool CMSATree(TileIndex tile)

   265

{

   266

	return IsTileType(tile, MP_TREES);

   267

}

   268

   269

/**

   270

 * Check whether the tile is a forest.

   271

 * @param tile the tile to investigate.

   272

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

   273

 */

   274

static bool CMSAForest(TileIndex tile)

   275

{

   276

	/* No industry */

   277

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

   278

   279

	const Industry *ind = GetIndustryByTile(tile);

   280

   281

	/* No extractive industry */

   282

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

   283

   284

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

   285

		/* The industry produces wood. */

   286

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

   287

	}

   288

   289

	return false;

   290

}

   291

   292

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

   293

   294

enum StationNaming {

   295

	STATIONNAMING_RAIL = 0,

   296

	STATIONNAMING_ROAD = 0,

   297

	STATIONNAMING_AIRPORT,

   298

	STATIONNAMING_OILRIG,

   299

	STATIONNAMING_DOCK,

   300

	STATIONNAMING_BUOY,

   301

	STATIONNAMING_HELIPORT,

   302

};

   303

   304

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

   305

{

   306

	static const uint32 _gen_station_name_bits[] = {

   307

		0,                                      /* 0 */

   308

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

   309

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

   310

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

   311

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

   312

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

   313

	};

   314

   315

	const Town *t = st->town;

   316

	uint32 free_names = UINT32_MAX;

   317

   318

	const Station *s;

   319

	FOR_ALL_STATIONS(s) {

   320

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

   321

			uint str = M(s->string_id);

   322

			if (str <= 0x20) {

   323

				if (str == M(STR_SV_STNAME_FOREST)) {

   324

					str = M(STR_SV_STNAME_WOODS);

   325

				}

   326

				ClrBit(free_names, str);

   327

			}

   328

		}

   329

	}

   330

   331

	/* check default names */

   332

	uint32 tmp = free_names & _gen_station_name_bits[flag];

   333

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

   334

   335

	/* check mine? */

   336

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

   337

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

   338

			return STR_SV_STNAME_MINES;

   339

		}

   340

	}

   341

   342

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

   343

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

   344

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

   345

   346

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

   347

	}

   348

   349

	/* Check lakeside */

   350

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

   351

			DistanceFromEdge(tile) < 20 &&

   352

			CountMapSquareAround(tile, CMSAWater) >= 5) {

   353

		return STR_SV_STNAME_LAKESIDE;

   354

	}

   355

   356

	/* Check woods */

   357

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

   358

				CountMapSquareAround(tile, CMSATree) >= 8 ||

   359

				CountMapSquareAround(tile, CMSAForest) >= 2)

   360

			) {

   361

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

   362

	}

   363

   364

	/* check elevation compared to town */

   365

	uint z = GetTileZ(tile);

   366

	uint z2 = GetTileZ(t->xy);

   367

	if (z < z2) {

   368

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

   369

	} else if (z > z2) {

   370

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

   371

	}

   372

   373

	/* check direction compared to town */

   374

	static const int8 _direction_and_table[] = {

   375

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

   376

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

   377

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

   378

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

   379

	};

   380

   381

	free_names &= _direction_and_table[

   382

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

   383

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

   384

   385

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

   386

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

   387

}

   388

#undef M

   389

   390

static Station *GetClosestStationFromTile(TileIndex tile)

   391

{

   392

	uint threshold = 8;

   393

	Station *best_station = NULL;

   394

	Station *st;

   395

   396

	FOR_ALL_STATIONS(st) {

   397

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

   398

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

   399

   400

			if (cur_dist < threshold) {

   401

				threshold = cur_dist;

   402

				best_station = st;

   403

			}

   404

		}

   405

	}

   406

   407

	return best_station;

   408

}

   409

   410

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

   411

 * @param st Station to update for.

   412

 */

   413

static void UpdateStationVirtCoord(Station *st)

   414

{

   415

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

   416

   417

	pt.y -= 32;

   418

	if (st->facilities & FACIL_AIRPORT && st->Airport() == AirportFTAClass::oil_rig) pt.y -= 16;

   419

   420

	SetDParam(0, st->index);

   421

	SetDParam(1, st->facilities);

   422

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

   423

}

   424

   425

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

   426

void UpdateAllStationVirtCoord()

   427

{

   428

	Station *st;

   429

   430

	FOR_ALL_STATIONS(st) {

   431

		UpdateStationVirtCoord(st);

   432

	}

   433

}

   434

   435

/**

   436

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

   437

 *

   438

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

   439

 *

   440

 * @param st The station to update the virt coords

   441

 * @ingroup dirty

   442

 */

   443

static void UpdateStationVirtCoordDirty(Station *st)

   444

{

   445

	st->MarkDirty();

   446

	UpdateStationVirtCoord(st);

   447

	st->MarkDirty();

   448

}

   449

   450

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

   451

 * @param st Station to query

   452

 * @return the expected mask

   453

 */

   454

static uint GetAcceptanceMask(const Station *st)

   455

{

   456

	uint mask = 0;

   457

   458

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

   459

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

   460

	}

   461

	return mask;

   462

}

   463

   464

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

   465

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

   466

 */

   467

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

   468

{

   469

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

   470

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

   471

	}

   472

   473

	SetDParam(0, st->index);

   474

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

   475

}

   476

   477

/**

   478

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

   479

 * @param produced: Destination array of produced cargo

   480

 * @param tile: Center of the search area

   481

 * @param w: Width of the center

   482

 * @param h: Height of the center

   483

 * @param rad: Radius of the search area

   484

 */

   485

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   486

	int w, int h, int rad)

   487

{

   488

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

   489