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

	Station *st = GetStationByTile(t);

    62

	FSMDepots *hangar_list;

    63

	byte num_depots;

    64

	if (IsCustomFSMportsSpecIndex(t)) {

    65

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

    66

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

    67

	} else {

    68

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

    69

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

    70

	}

    71

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

    72

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

    73

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

    74

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

    75

												 st->FSMport_orientation);

    76

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

    77

			return true;

    78

		}

    79

	}

    80

	return false;

    81

}

    82

    83

    84

FSMDepots GetKeyDepotByTile(TileIndex t)

    85

{

    86

	Station *st = GetStationByTile(t);

    87

    88

	FSMDepots *hangar_list;

    89

	byte num_depots;

    90

	uint i;

    91

    92

	if (IsCustomFSMportsSpecIndex(t)) {

    93

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

    94

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

    95

	} else {

    96

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

    97

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

    98

	}

    99

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

   100

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

   101

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

   102

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

   103

												 st->FSMport_orientation);

   104

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

   105

			break;

   106

		}

   107

	}

   108

	return hangar_list[i];

   109

}

   110

   111

/**

   112

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

   113

 * returns the tile location of that key part

   114

 * @param t: the tile to start from

   115

 * @pre IsHangar(t)

   116

 * @return tile of key part of hangar

   117

 */

   118

TileIndex GetKeyDepotTile(TileIndex t)

   119

{

   120

	Station *st = GetStationByTile(t);

   121

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

   122

	TileIndexDiffC keydepot;

   123

	keydepot.x = md->x / TILE_SIZE;

   124

	keydepot.y = md->y / TILE_SIZE;

   125

	keydepot = RotateFSMPosition(keydepot,

   126

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

   127

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

   128

												 st->FSMport_orientation);

   129

	return st->airport_tile + ToTileIndexDiff(keydepot);

   130

}

   131

   132

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

   133

{

   134

	const Station* st = GetStationByTile(tile);

   135

   136

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

   137

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

   138

		assert(rs->next != NULL);

   139

	}

   140

}

   141

   142

   143

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

   144

{

   145

	uint num = 0;

   146

   147

	assert(st != NULL);

   148

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

   149

		num++;

   150

	}

   151

   152

	return num;

   153

}

   154

   155

   156

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

   157

 *  radius that is available within the station */

   158

static uint FindCatchmentRadius(const Station* st)

   159

{

   160

	uint ret = CA_NONE;

   161

   162

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

   163

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

   164

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

   165

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

   166

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

   167

   168

	return ret;

   169

}

   170

   171

#define CHECK_STATIONS_ERR ((Station*)-1)

   172

   173

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

   174

{

   175

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

   176

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

   177

		if (IsTileType(tile_cur, MP_STATION)) {

   178

			StationID t = GetStationIndex(tile_cur);

   179

   180

			if (closest_station == INVALID_STATION) {

   181

				closest_station = t;

   182

			} else if (closest_station != t) {

   183

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   184

				return CHECK_STATIONS_ERR;

   185

			}

   186

		}

   187

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

   188

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

   189

}

   190

   191

/**

   192

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

   193

 * @param tile the tile to check

   194

 * @return true if it matches, false otherwise

   195

 */

   196

typedef bool (*CMSAMatcher)(TileIndex tile);

   197

   198

/**

   199

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

   200

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

   201

 * @param type the type of tile searched for

   202

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

   203

 *                 in all other cases this parameter is ignored

   204

 * @return the result the noumber of matching tiles around

   205

 */

   206

static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)

   207

{

   208

	int num = 0;

   209

   210

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

   211

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

   212

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

   213

		}

   214

	}

   215

   216

	return num;

   217

}

   218

   219

/**

   220

 * Check whether the tile is a mine.

   221

 * @param tile the tile to investigate.

   222

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

   223

 */

   224

static bool CMSAMine(TileIndex tile)

   225

{

   226

	/* No industry */

   227

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

   228

   229

	const IndustrySpec *indsp = GetIndustrySpec(GetIndustryByTile(tile)->type);

   230

   231

	/* No extractive industry */

   232

	if ((indsp->life_type & INDUSTRYLIFE_EXTRACTIVE) == 0) return false;

   233

   234

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

   235

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

   236

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

   237

	}

   238

   239

	return false;

   240

}

   241

   242

/**

   243

 * Check whether the tile is water.

   244

 * @param tile the tile to investigate.

   245

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

   246

 */

   247

static bool CMSAWater(TileIndex tile)

   248

{

   249

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

   250

}

   251

   252

/**

   253

 * Check whether the tile is a tree.

   254

 * @param tile the tile to investigate.

   255

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

   256

 */

   257

static bool CMSATree(TileIndex tile)

   258

{

   259

	return IsTileType(tile, MP_TREES);

   260

}

   261

   262

/**

   263

 * Check whether the tile is a forest.

   264

 * @param tile the tile to investigate.

   265

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

   266

 */

   267

static bool CMSAForest(TileIndex tile)

   268

{

   269

	/* No industry */

   270

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

   271

   272

	const IndustrySpec *indsp = GetIndustrySpec(GetIndustryByTile(tile)->type);

   273

   274

	/* No extractive industry */

   275

	if ((indsp->life_type & INDUSTRYLIFE_ORGANIC) == 0) return false;

   276

   277

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

   278

		/* The industry produces wood. */

   279

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

   280

	}

   281

   282

	return false;

   283

}

   284

   285

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

   286

   287

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

   288

{

   289

	static const uint32 _gen_station_name_bits[] = {

   290

		0,                                      /* 0 */

   291

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

   292

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

   293

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

   294

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

   295

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

   296

	};

   297

   298

	Town *t = st->town;

   299

	uint32 free_names = (uint32)-1;

   300

	int found;

   301

	unsigned long tmp;

   302

   303

	{

   304

		Station *s;

   305

   306

		FOR_ALL_STATIONS(s) {

   307

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

   308

				uint str = M(s->string_id);

   309

				if (str <= 0x20) {

   310

					if (str == M(STR_SV_STNAME_FOREST))

   311

						str = M(STR_SV_STNAME_WOODS);

   312

					CLRBIT(free_names, str);

   313

				}

   314

			}

   315

		}

   316

	}

   317

   318

	/* check default names */

   319

	tmp = free_names & _gen_station_name_bits[flag];

   320

	if (tmp != 0) {

   321

		found = FindFirstBit(tmp);

   322

		goto done;

   323

	}

   324

   325

	/* check mine? */

   326

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

   327

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

   328

			found = M(STR_SV_STNAME_MINES);

   329

			goto done;

   330

		}

   331

	}

   332

   333

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

   334

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

   335

		found = M(STR_SV_STNAME);

   336

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

   337

   338

		found = M(STR_SV_STNAME_CENTRAL);

   339

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

   340

	}

   341

   342

	/* Check lakeside */

   343

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

   344

			DistanceFromEdge(tile) < 20 &&

   345

			CountMapSquareAround(tile, CMSAWater) >= 5) {

   346

		found = M(STR_SV_STNAME_LAKESIDE);

   347

		goto done;

   348

	}

   349

   350

	/* Check woods */

   351

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

   352

				CountMapSquareAround(tile, CMSATree) >= 8 ||

   353

				CountMapSquareAround(tile, CMSAForest) >= 2)

   354

			) {

   355

		found = _opt.landscape == LT_TROPIC ?

   356

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   357

		goto done;

   358

	}

   359

   360

	/* check elevation compared to town */

   361

	{

   362

		uint z = GetTileZ(tile);

   363

		uint z2 = GetTileZ(t->xy);

   364

		if (z < z2) {

   365

			found = M(STR_SV_STNAME_VALLEY);

   366

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

   367

		} else if (z > z2) {

   368

			found = M(STR_SV_STNAME_HEIGHTS);

   369

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

   370

		}

   371

	}

   372

   373

	/* check direction compared to town */

   374

	{

   375

		static const int8 _direction_and_table[] = {

   376

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

   377

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

   378

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

   379

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

   380

		};

   381

   382

		free_names &= _direction_and_table[

   383

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

   384

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

   385

	}

   386

   387

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

   388

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

   389

   390

done:

   391

	st->string_id = found + STR_SV_STNAME;

   392

	return true;

   393

}

   394

#undef M

   395

   396

static Station* GetClosestStationFromTile(TileIndex tile)

   397

{

   398

	uint threshold = 8;

   399

	Station* best_station = NULL;

   400

	Station* st;

   401

   402

	FOR_ALL_STATIONS(st) {

   403

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

   404

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

   405

   406

			if (cur_dist < threshold) {

   407

				threshold = cur_dist;

   408

				best_station = st;

   409

			}

   410

		}

   411

	}

   412

   413

	return best_station;

   414

}

   415

   416

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

   417

// st = Station to update for.

   418

static void UpdateStationVirtCoord(Station *st)

   419

{

   420

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

   421

   422

	pt.y -= 32;

   423

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

   424

   425

	SetDParam(0, st->index);

   426

	SetDParam(1, st->facilities);

   427

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

   428

}

   429

   430

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

   431

void UpdateAllStationVirtCoord()

   432

{

   433

	Station* st;

   434

   435

	FOR_ALL_STATIONS(st) {

   436

		UpdateStationVirtCoord(st);

   437

	}

   438

}

   439

   440

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

   441

static void UpdateStationVirtCoordDirty(Station *st)

   442

{

   443

	st->MarkDirty();

   444

	UpdateStationVirtCoord(st);

   445

	st->MarkDirty();

   446

}

   447

   448

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

   449

static uint GetAcceptanceMask(const Station *st)

   450

{

   451

	uint mask = 0;

   452

   453

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

   455

	}

   456

	return mask;

   457

}

   458

   459

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

   460

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

   461

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

   462

{

   463

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

   464

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

   465

	}

   466

   467

	SetDParam(0, st->index);

   468

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

   469

}

   470

   471

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

   472

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   473

	int w, int h, int rad)

   474

{

   475

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

   484

   485

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

   486

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

   487

   488

	assert(x1 < x2);

   489

	assert(y1 < y2);

   490

	assert(w > 0);

   491

	assert(h > 0);

   492

   493

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

   494

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