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

    46

#include "table/sprites.h"

    47

#include "table/strings.h"

    48

    49

DEFINE_OLD_POOL_GENERIC(Station, Station)

    50

DEFINE_OLD_POOL_GENERIC(RoadStop, RoadStop)

    51

    52

    53

/**

    54

 * Check whether the given tile is a hangar.

    55

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

    56

 * @pre IsTileType(t, MP_STATION)

    57

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

    58

 */

    59

bool IsHangar(TileIndex t)

    60

{

    61

	assert(IsTileType(t, MP_STATION));

    62

    63

	const Station *st = GetStationByTile(t);

    64

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

    65

    66

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

    67

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

    68

	}

    69

    70

	return false;

    71

}

    72

    73

RoadStop *GetRoadStopByTile(TileIndex tile, RoadStopType type)

    74

{

    75

	const Station *st = GetStationByTile(tile);

    76

    77

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

    78

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

    79

		assert(rs->next != NULL);

    80

	}

    81

}

    82

    83

    84

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

    85

{

    86

	uint num = 0;

    87

    88

	assert(st != NULL);

    89

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

    90

		num++;

    91

	}

    92

    93

	return num;

    94

}

    95

    96

    97

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

    98

 *  radius that is available within the station

    99

 * @param st Station to query

   100

 * @return the so calculated radius

   101

 */

   102

static uint FindCatchmentRadius(const Station *st)

   103

{

   104

	uint ret = CA_NONE;

   105

   106

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

   107

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

   108

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

   109

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

   110

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

   111

   112

	return ret;

   113

}

   114

   115

#define CHECK_STATIONS_ERR ((Station*)-1)

   116

   117

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

   118

{

   119

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

   120

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

   121

		if (IsTileType(tile_cur, MP_STATION)) {

   122

			StationID t = GetStationIndex(tile_cur);

   123

   124

			if (closest_station == INVALID_STATION) {

   125

				closest_station = t;

   126

			} else if (closest_station != t) {

   127

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   128

				return CHECK_STATIONS_ERR;

   129

			}

   130

		}

   131

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

   132

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

   133

}

   134

   135

/**

   136

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

   137

 * @param tile the tile to check

   138

 * @return true if it matches, false otherwise

   139

 */

   140

typedef bool (*CMSAMatcher)(TileIndex tile);

   141

   142

/**

   143

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

   144

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

   145

 * @param type the type of tile searched for

   146

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

   147

 *                 in all other cases this parameter is ignored

   148

 * @return the result the noumber of matching tiles around

   149

 */

   150

static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)

   151

{

   152

	int num = 0;

   153

   154

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

   155

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

   156

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

   157

		}

   158

	}

   159

   160

	return num;

   161

}

   162

   163

/**

   164

 * Check whether the tile is a mine.

   165

 * @param tile the tile to investigate.

   166

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

   167

 */

   168

static bool CMSAMine(TileIndex tile)

   169

{

   170

	/* No industry */

   171

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

   172

   173

	const Industry *ind = GetIndustryByTile(tile);

   174

   175

	/* No extractive industry */

   176

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

   177

   178

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

   179

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

   180

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

   181

	}

   182

   183

	return false;

   184

}

   185

   186

/**

   187

 * Check whether the tile is water.

   188

 * @param tile the tile to investigate.

   189

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

   190

 */

   191

static bool CMSAWater(TileIndex tile)

   192

{

   193

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

   194

}

   195

   196

/**

   197

 * Check whether the tile is a tree.

   198

 * @param tile the tile to investigate.

   199

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

   200

 */

   201

static bool CMSATree(TileIndex tile)

   202

{

   203

	return IsTileType(tile, MP_TREES);

   204

}

   205

   206

/**

   207

 * Check whether the tile is a forest.

   208

 * @param tile the tile to investigate.

   209

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

   210

 */

   211

static bool CMSAForest(TileIndex tile)

   212

{

   213

	/* No industry */

   214

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

   215

   216

	const Industry *ind = GetIndustryByTile(tile);

   217

   218

	/* No extractive industry */

   219

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

   220

   221

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

   222

		/* The industry produces wood. */

   223

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

   224

	}

   225

   226

	return false;

   227

}

   228

   229

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

   230

   231

enum StationNaming {

   232

	STATIONNAMING_RAIL = 0,

   233

	STATIONNAMING_ROAD = 0,

   234

	STATIONNAMING_AIRPORT,

   235

	STATIONNAMING_OILRIG,

   236

	STATIONNAMING_DOCK,

   237

	STATIONNAMING_BUOY,

   238

	STATIONNAMING_HELIPORT,

   239

};

   240

   241

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

   242

{

   243

	static const uint32 _gen_station_name_bits[] = {

   244

		0,                                      /* 0 */

   245

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

   246

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

   247

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

   248

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

   249

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

   250

	};

   251

   252

	const Town *t = st->town;

   253

	uint32 free_names = UINT32_MAX;

   254

   255

	const Station *s;

   256

	FOR_ALL_STATIONS(s) {

   257

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

   258

			uint str = M(s->string_id);

   259

			if (str <= 0x20) {

   260

				if (str == M(STR_SV_STNAME_FOREST)) {

   261

					str = M(STR_SV_STNAME_WOODS);

   262

				}

   263

				ClrBit(free_names, str);

   264

			}

   265

		}

   266

	}

   267

   268

	/* check default names */

   269

	uint32 tmp = free_names & _gen_station_name_bits[flag];

   270

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

   271

   272

	/* check mine? */

   273

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

   274

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

   275

			return STR_SV_STNAME_MINES;

   276

		}

   277

	}

   278

   279

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

   280

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

   281

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

   282

   283

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

   284

	}

   285

   286

	/* Check lakeside */

   287

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

   288

			DistanceFromEdge(tile) < 20 &&

   289

			CountMapSquareAround(tile, CMSAWater) >= 5) {

   290

		return STR_SV_STNAME_LAKESIDE;

   291

	}

   292

   293

	/* Check woods */

   294

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

   295

				CountMapSquareAround(tile, CMSATree) >= 8 ||

   296

				CountMapSquareAround(tile, CMSAForest) >= 2)

   297

			) {

   298

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

   299

	}

   300

   301

	/* check elevation compared to town */

   302

	uint z = GetTileZ(tile);

   303

	uint z2 = GetTileZ(t->xy);

   304

	if (z < z2) {

   305

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

   306

	} else if (z > z2) {

   307

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

   308

	}

   309

   310

	/* check direction compared to town */

   311

	static const int8 _direction_and_table[] = {

   312

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

   313

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

   314

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

   316

	};

   317

   318

	free_names &= _direction_and_table[

   319

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

   320

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

   321

   322

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

   323

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

   324

}

   325

#undef M

   326

   327

static Station *GetClosestStationFromTile(TileIndex tile)

   328

{

   329

	uint threshold = 8;

   330

	Station *best_station = NULL;

   331

	Station *st;

   332

   333

	FOR_ALL_STATIONS(st) {

   334

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

   335

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

   336

   337

			if (cur_dist < threshold) {

   338

				threshold = cur_dist;

   339

				best_station = st;

   340

			}

   341

		}

   342

	}

   343

   344

	return best_station;

   345

}

   346

   347

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

   348

 * @param st Station to update for.

   349

 */

   350

static void UpdateStationVirtCoord(Station *st)

   351

{

   352

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

   353

   354

	pt.y -= 32;

   355

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

   356

   357

	SetDParam(0, st->index);

   358

	SetDParam(1, st->facilities);

   359

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

   360

}

   361

   362

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

   363

void UpdateAllStationVirtCoord()

   364

{

   365

	Station *st;

   366

   367

	FOR_ALL_STATIONS(st) {

   368

		UpdateStationVirtCoord(st);

   369

	}

   370

}

   371

   372

/**

   373

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

   374

 *

   375

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

   376

 *

   377

 * @param st The station to update the virt coords

   378

 * @ingroup dirty

   379

 */

   380

static void UpdateStationVirtCoordDirty(Station *st)

   381

{

   382

	st->MarkDirty();

   383

	UpdateStationVirtCoord(st);

   384

	st->MarkDirty();

   385

}

   386

   387

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

   388

 * @param st Station to query

   389

 * @return the expected mask

   390

 */

   391

static uint GetAcceptanceMask(const Station *st)

   392

{

   393

	uint mask = 0;

   394

   395

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

   396

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

   397

	}

   398

	return mask;

   399

}

   400

   401

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

   402

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

   403

 */

   404

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

   405

{

   406

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

   407

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

   408

	}

   409

   410

	SetDParam(0, st->index);

   411

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

   412

}

   413

   414

/**

   415

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

   416

 * @param produced: Destination array of produced cargo

   417

 * @param tile: Center of the search area

   418

 * @param w: Width of the center

   419

 * @param h: Height of the center

   420

 * @param rad: Radius of the search area

   421

 */

   422

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   423

	int w, int h, int rad)

   424

{

   425

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

   426

   427

	int x = TileX(tile);

   428

	int y = TileY(tile);

   429

   430

	/* expand the region by rad tiles on each side

   431

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

   432

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

   433

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

   434

   435

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

   436

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

   437

   438

	assert(x1 < x2);

   439

	assert(y1 < y2);

   440

	assert(w > 0);

   441

	assert(h > 0);

   442

   443

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

   444

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

   445

			TileIndex tile = TileXY(xc, yc);

   446

   447

			if (!IsTileType(tile, MP_STATION)) {

   448

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

   449

				if (gpc != NULL) {

   450

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

   451

					memset(cargos, CT_INVALID, 256);

   452

   453

					gpc(tile, cargos);

   454

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

   455

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

   456

					}

   457

				}

   458

			}

   459

		}

   460

	}

   461

}

   462

   463

/**

   464

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

   465

 * @param accepts: Destination array of accepted cargo

   466

 * @param tile: Center of the search area

   467

 * @param w: Width of the center

   468

 * @param h: Height of the center

   469

 * @param rad: Radius of the rectangular search area

   470

 */

   471

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile,

   472

	int w, int h, int rad)

   473

{

   474

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

   475

   476

	int x = TileX(tile);

   477

	int y = TileY(tile);

   478

   479

	/* expand the region by rad tiles on each side

   480

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

   481

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

   482

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

   483

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

   484

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

   485

   486

	assert(x1 < x2);

   487

	assert(y1 < y2);

   488

	assert(w > 0);

   489

	assert(h > 0);