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"

    46

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

	Station *st = GetStationByTile(t);

    63

	FSMDepots *hangar_list;

    64

	byte num_depots;

    65

	if (IsCustomFSMportsSpecIndex(t)) {

    66

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

    67

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

    68

	} else {

    69

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

    70

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

    71

	}

    72

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

    73

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

    74

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

    75

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

    76

												 st->FSMport_orientation);

    77

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

    78

			return true;

    79

		}

    80

	}

    81

	return false;

    82

}

    83

    84

    85

FSMDepots GetKeyDepotByTile(TileIndex t)

    86

{

    87

	Station *st = GetStationByTile(t);

    88

    89

	FSMDepots *hangar_list;

    90

	byte num_depots;

    91

	uint i;

    92

    93

	if (IsCustomFSMportsSpecIndex(t)) {

    94

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

    95

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

    96

	} else {

    97

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

    98

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

    99

	}

   100

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

   101

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

   102

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

   103

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

   104

												 st->FSMport_orientation);

   105

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

   106

			break;

   107

		}

   108

	}

   109

	return hangar_list[i];

   110

}

   111

   112

/**

   113

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

   114

 * returns the tile location of that key part

   115

 * @param t: the tile to start from

   116

 * @pre IsHangar(t)

   117

 * @return tile of key part of hangar

   118

 */

   119

TileIndex GetKeyDepotTile(TileIndex t)

   120

{

   121

	Station *st = GetStationByTile(t);

   122

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

   123

	TileIndexDiffC keydepot;

   124

	keydepot.x = md->x / TILE_SIZE;

   125

	keydepot.y = md->y / TILE_SIZE;

   126

	keydepot = RotateFSMPosition(keydepot,

   127

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

   128

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

   129

												 st->FSMport_orientation);

   130

	return st->airport_tile + ToTileIndexDiff(keydepot);

   131

}

   132

   133

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

   134

{

   135

	const Station* st = GetStationByTile(tile);

   136

   137

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

   138

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

   139

		assert(rs->next != NULL);

   140

	}

   141

}

   142

   143

   144

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

   145

{

   146

	uint num = 0;

   147

   148

	assert(st != NULL);

   149

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

   150

		num++;

   151

	}

   152

   153

	return num;

   154

}

   155

   156

   157

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

   158

 *  radius that is available within the station */

   159

static uint FindCatchmentRadius(const Station* st)

   160

{

   161

	uint ret = CA_NONE;

   162

   163

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

   164

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

   165

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

   166

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

   167

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

   168

   169

	return ret;

   170

}

   171

   172

#define CHECK_STATIONS_ERR ((Station*)-1)

   173

   174

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

   175

{

   176

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

   177

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

   178

		if (IsTileType(tile_cur, MP_STATION)) {

   179

			StationID t = GetStationIndex(tile_cur);

   180

   181

			if (closest_station == INVALID_STATION) {

   182

				closest_station = t;

   183

			} else if (closest_station != t) {

   184

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   185

				return CHECK_STATIONS_ERR;

   186

			}

   187

		}

   188

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

   189

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

   190

}

   191

   192

/**

   193

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

   194

 * @param tile the tile to check

   195

 * @return true if it matches, false otherwise

   196

 */

   197

typedef bool (*CMSAMatcher)(TileIndex tile);

   198

   199

/**

   200

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

   201

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

   202

 * @param type the type of tile searched for

   203

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

   204

 *                 in all other cases this parameter is ignored

   205

 * @return the result the noumber of matching tiles around

   206

 */

   207

static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)

   208

{

   209

	int num = 0;

   210

   211

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

   212

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

   213

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

   214

		}

   215

	}

   216

   217

	return num;

   218

}

   219

   220

/**

   221

 * Check whether the tile is a mine.

   222

 * @param tile the tile to investigate.

   223

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

   224

 */

   225

static bool CMSAMine(TileIndex tile)

   226

{

   227

	/* No industry */

   228

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

   229

   231

   232

	/* No extractive industry */

   236

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

   238

	}

   239

   240

	return false;

   241

}

   242

   243

/**

   244

 * Check whether the tile is water.

   245

 * @param tile the tile to investigate.

   246

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

   247

 */

   248

static bool CMSAWater(TileIndex tile)

   249

{

   250

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

   251

}

   252

   253

/**

   254

 * Check whether the tile is a tree.

   255

 * @param tile the tile to investigate.

   256

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

   257

 */

   258

static bool CMSATree(TileIndex tile)

   259

{

   260

	return IsTileType(tile, MP_TREES);

   261

}

   262

   263

/**

   264

 * Check whether the tile is a forest.

   265

 * @param tile the tile to investigate.

   266

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

   267

 */

   268

static bool CMSAForest(TileIndex tile)

   269

{

   270

	/* No industry */

   271

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

   272

   274

   275

	/* No extractive industry */

   279

		/* The industry produces wood. */

   281

	}

   282

   283

	return false;

   284

}

   285

   286

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

   287

   288

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

   289

{

   290

	static const uint32 _gen_station_name_bits[] = {

   291

		0,                                      /* 0 */

   292

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

   293

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

   294

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

   295

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

   296

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

   297

	};

   298

   299

	Town *t = st->town;

   300

	uint32 free_names = (uint32)-1;

   301

	int found;

   302

	unsigned long tmp;

   303

   304

	{

   305

		Station *s;

   306

   307

		FOR_ALL_STATIONS(s) {

   308

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

   309

				uint str = M(s->string_id);

   310

				if (str <= 0x20) {

   311

					if (str == M(STR_SV_STNAME_FOREST))

   312

						str = M(STR_SV_STNAME_WOODS);

   313

					CLRBIT(free_names, str);

   314

				}

   315

			}

   316

		}

   317

	}

   318

   319

	/* check default names */

   320

	tmp = free_names & _gen_station_name_bits[flag];

   321

	if (tmp != 0) {

   322

		found = FindFirstBit(tmp);

   323

		goto done;

   324

	}

   325

   326

	/* check mine? */

   327

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

   328

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

   329

			found = M(STR_SV_STNAME_MINES);

   330

			goto done;

   331

		}

   332

	}

   333

   334

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

   335

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

   336

		found = M(STR_SV_STNAME);

   337

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

   338

   339

		found = M(STR_SV_STNAME_CENTRAL);

   340

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

   341

	}

   342

   343

	/* Check lakeside */

   344

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

   345

			DistanceFromEdge(tile) < 20 &&

   346

			CountMapSquareAround(tile, CMSAWater) >= 5) {

   347

		found = M(STR_SV_STNAME_LAKESIDE);

   348

		goto done;

   349

	}

   350

   351

	/* Check woods */

   352

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

   353

				CountMapSquareAround(tile, CMSATree) >= 8 ||

   354

				CountMapSquareAround(tile, CMSAForest) >= 2)

   355

			) {

   356

		found = _opt.landscape == LT_TROPIC ?

   357

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   358

		goto done;

   359

	}

   360

   361

	/* check elevation compared to town */

   362

	{

   363

		uint z = GetTileZ(tile);

   364

		uint z2 = GetTileZ(t->xy);

   365

		if (z < z2) {

   366

			found = M(STR_SV_STNAME_VALLEY);

   367

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

   368

		} else if (z > z2) {

   369

			found = M(STR_SV_STNAME_HEIGHTS);

   370

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

   371

		}

   372

	}

   373

   374

	/* check direction compared to town */

   375

	{

   376

		static const int8 _direction_and_table[] = {

   377

			~( (1 << M(STR_SV_STNAME_WEST)) | (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_NORTH)) ),

   379

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

   380

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

   381

		};

   382

   383

		free_names &= _direction_and_table[

   384

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

   385

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

   386

	}

   387

   388

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

   389

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

   390

   391

done:

   392

	st->string_id = found + STR_SV_STNAME;

   393

	return true;

   394

}

   395

#undef M

   396

   397

static Station* GetClosestStationFromTile(TileIndex tile)

   398

{

   399

	uint threshold = 8;

   400

	Station* best_station = NULL;

   401

	Station* st;

   402

   403

	FOR_ALL_STATIONS(st) {

   404

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

   405

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

   406

   407

			if (cur_dist < threshold) {

   408

				threshold = cur_dist;

   409

				best_station = st;

   410

			}

   411

		}

   412

	}

   413

   414

	return best_station;

   415

}

   416

   417

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

   418

// st = Station to update for.

   419

static void UpdateStationVirtCoord(Station *st)

   420

{

   421

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

   422

   423

	pt.y -= 32;

   424

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

   425

   426

	SetDParam(0, st->index);

   427

	SetDParam(1, st->facilities);

   428

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

   429

}

   430

   431

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

   432

void UpdateAllStationVirtCoord()

   433

{

   434

	Station* st;

   435

   436

	FOR_ALL_STATIONS(st) {

   437

		UpdateStationVirtCoord(st);

   438

	}

   439

}

   440

   449

static void UpdateStationVirtCoordDirty(Station *st)

   450

{

   451

	st->MarkDirty();

   452

	UpdateStationVirtCoord(st);

   453

	st->MarkDirty();

   454

}

   455

   456

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

   457

static uint GetAcceptanceMask(const Station *st)

   458

{

   459

	uint mask = 0;

   460

   461

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

   462

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

   463

	}

   464

	return mask;

   465

}

   466

   467

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

   468

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

   469

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

   470

{

   471

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

   472

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

   473

	}

   474

   475

	SetDParam(0, st->index);

   476

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

   477

}

   478

   479

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

   480

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   481

	int w, int h, int rad)

   482

{

   483

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

   484

   485

	int x = TileX(tile);

   486

	int y = TileY(tile);

   487

   488

	// expand the region by rad tiles on each side

   489

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

   490

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

   491

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

   492

   493