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

    46

DEFINE_OLD_POOL_GENERIC(Station, Station)

    47

DEFINE_OLD_POOL_GENERIC(RoadStop, RoadStop)

    48

    49

    50

/**

    51

 * Check whether the given tile is a hangar.

    52

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

    53

 * @pre IsTileType(t, MP_STATION)

    54

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

    55

 */

    56

bool IsHangar(TileIndex t)

    57

{

    58

	assert(IsTileType(t, MP_STATION));

    59

    60

	const Station *st = GetStationByTile(t);

    61

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

    62

    63

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

    64

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

    65

	}

    66

    67

	return false;

    68

}

    69

    70

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

    71

{

    72

	const Station* st = GetStationByTile(tile);

    73

    74

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

    75

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

    76

		assert(rs->next != NULL);

    77

	}

    78

}

    79

    80

    81

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

    82

{

    83

	uint num = 0;

    84

    85

	assert(st != NULL);

    86

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

    87

		num++;

    88

	}

    89

    90

	return num;

    91

}

    92

    93

    94

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

    95

 *  radius that is available within the station */

    96

static uint FindCatchmentRadius(const Station* st)

    97

{

    98

	uint ret = CA_NONE;

    99

   100

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

   101

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

   102

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

   103

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

   104

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

   105

   106

	return ret;

   107

}

   108

   109

#define CHECK_STATIONS_ERR ((Station*)-1)

   110

   111

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

   112

{

   113

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

   114

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

   115

		if (IsTileType(tile_cur, MP_STATION)) {

   116

			StationID t = GetStationIndex(tile_cur);

   117

   118

			if (closest_station == INVALID_STATION) {

   119

				closest_station = t;

   120

			} else if (closest_station != t) {

   121

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   122

				return CHECK_STATIONS_ERR;

   123

			}

   124

		}

   125

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

   126

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

   127

}

   128

   129

/**

   130

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

   131

 * @param tile the tile to check

   132

 * @return true if it matches, false otherwise

   133

 */

   134

typedef bool (*CMSAMatcher)(TileIndex tile);

   135

   136

/**

   137

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

   138

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

   139

 * @param type the type of tile searched for

   140

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

   141

 *                 in all other cases this parameter is ignored

   142

 * @return the result the noumber of matching tiles around

   143

 */

   144

static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)

   145

{

   146

	int num = 0;

   147

   148

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

   149

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

   150

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

   151

		}

   152

	}

   153

   154

	return num;

   155

}

   156

   157

/**

   158

 * Check whether the tile is a mine.

   159

 * @param tile the tile to investigate.

   160

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

   161

 */

   162

static bool CMSAMine(TileIndex tile)

   163

{

   164

	/* No industry */

   165

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

   166

   167

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

   168

   169

	/* No extractive industry */

   170

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

   171

   172

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

   173

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

   174

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

   175

	}

   176

   177

	return false;

   178

}

   179

   180

/**

   181

 * Check whether the tile is water.

   182

 * @param tile the tile to investigate.

   183

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

   184

 */

   185

static bool CMSAWater(TileIndex tile)

   186

{

   187

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

   188

}

   189

   190

/**

   191

 * Check whether the tile is a tree.

   192

 * @param tile the tile to investigate.

   193

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

   194

 */

   195

static bool CMSATree(TileIndex tile)

   196

{

   197

	return IsTileType(tile, MP_TREES);

   198

}

   199

   200

/**

   201

 * Check whether the tile is a forest.

   202

 * @param tile the tile to investigate.

   203

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

   204

 */

   205

static bool CMSAForest(TileIndex tile)

   206

{

   207

	/* No industry */

   208

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

   209

   210

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

   211

   212

	/* No extractive industry */

   213

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

   214

   215

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

   216

		/* The industry produces wood. */

   217

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

   218

	}

   219

   220

	return false;

   221

}

   222

   223

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

   224

   225

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

   226

{

   227

	static const uint32 _gen_station_name_bits[] = {

   228

		0,                                      /* 0 */

   229

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

   230

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

   231

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

   232

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

   233

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

   234

	};

   235

   236

	Town *t = st->town;

   237

	uint32 free_names = (uint32)-1;

   238

	int found;

   239

	unsigned long tmp;

   240

   241

	{

   242

		Station *s;

   243

   244

		FOR_ALL_STATIONS(s) {

   245

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

   246

				uint str = M(s->string_id);

   247

				if (str <= 0x20) {

   248

					if (str == M(STR_SV_STNAME_FOREST))

   249

						str = M(STR_SV_STNAME_WOODS);

   250

					CLRBIT(free_names, str);

   251

				}

   252

			}

   253

		}

   254

	}

   255

   256

	/* check default names */

   257

	tmp = free_names & _gen_station_name_bits[flag];

   258

	if (tmp != 0) {

   259

		found = FindFirstBit(tmp);

   260

		goto done;

   261

	}

   262

   263

	/* check mine? */

   264

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

   265

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

   266

			found = M(STR_SV_STNAME_MINES);

   267

			goto done;

   268

		}

   269

	}

   270

   271

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

   272

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

   273

		found = M(STR_SV_STNAME);

   274

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

   275

   276

		found = M(STR_SV_STNAME_CENTRAL);

   277

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

   278

	}

   279

   280

	/* Check lakeside */

   281

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

   282

			DistanceFromEdge(tile) < 20 &&

   283

			CountMapSquareAround(tile, CMSAWater) >= 5) {

   284

		found = M(STR_SV_STNAME_LAKESIDE);

   285

		goto done;

   286

	}

   287

   288

	/* Check woods */

   289

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

   290

				CountMapSquareAround(tile, CMSATree) >= 8 ||

   291

				CountMapSquareAround(tile, CMSAForest) >= 2)

   292

			) {

   293

		found = _opt.landscape == LT_TROPIC ?

   294

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   295

		goto done;

   296

	}

   297

   298

	/* check elevation compared to town */

   299

	{

   300

		uint z = GetTileZ(tile);

   301

		uint z2 = GetTileZ(t->xy);

   302

		if (z < z2) {

   303

			found = M(STR_SV_STNAME_VALLEY);

   304

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

   305

		} else if (z > z2) {

   306

			found = M(STR_SV_STNAME_HEIGHTS);

   307

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

   308

		}

   309

	}

   310

   311

	/* check direction compared to town */

   312

	{

   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

   325

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

   326

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

   327

   328

done:

   329

	st->string_id = found + STR_SV_STNAME;

   330

	return true;

   331

}

   332

#undef M

   333

   334

static Station* GetClosestStationFromTile(TileIndex tile)

   335

{

   336

	uint threshold = 8;

   337

	Station* best_station = NULL;

   338

	Station* st;

   339

   340

	FOR_ALL_STATIONS(st) {

   341

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

   342

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

   343

   344

			if (cur_dist < threshold) {

   345

				threshold = cur_dist;

   346

				best_station = st;

   347

			}

   348

		}

   349

	}

   350

   351

	return best_station;

   352

}

   353

   354

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

   355

// st = Station to update for.

   356

static void UpdateStationVirtCoord(Station *st)

   357

{

   358

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

   359

   360

	pt.y -= 32;

   361

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

   362

   363

	SetDParam(0, st->index);

   364

	SetDParam(1, st->facilities);

   365

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

   366

}

   367

   368

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

   369

void UpdateAllStationVirtCoord()

   370

{

   371

	Station* st;

   372

   373

	FOR_ALL_STATIONS(st) {

   374

		UpdateStationVirtCoord(st);

   375

	}

   376

}

   377

   378

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

   379

static void UpdateStationVirtCoordDirty(Station *st)

   380

{

   381

	st->MarkDirty();

   382

	UpdateStationVirtCoord(st);

   383

	st->MarkDirty();

   384

}

   385

   386

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

   387

static uint GetAcceptanceMask(const Station *st)

   388

{

   389

	uint mask = 0;

   390

   391

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

   392

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

   393

	}

   394

	return mask;

   395

}

   396

   397

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

   398

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

   399

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

   400

{

   401

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

   402

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

   403

	}

   404

   405

	SetDParam(0, st->index);

   406

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

   407

}

   408

   409

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

   410

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   411

	int w, int h, int rad)

   412

{

   413

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

   414

   415

	int x = TileX(tile);

   416

	int y = TileY(tile);

   417

   418

	// expand the region by rad tiles on each side

   419

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

   420

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

   421

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

   422

   423

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

   424

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

   425

   426

	assert(x1 < x2);

   427

	assert(y1 < y2);

   428

	assert(w > 0);

   429

	assert(h > 0);

   430

   431

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

   432

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

   433

			if (!(IS_INSIDE_1D(xc, x, w) && IS_INSIDE_1D(yc, y, h))) {

   434

				TileIndex tile = TileXY(xc, yc);

   435

   436

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

   437

				if (gpc != NULL) {

   438

					CargoID cargos[2] = { CT_INVALID, CT_INVALID };

   439

   440

					gpc(tile, cargos);

   441

					if (cargos[0] != CT_INVALID) {

   442

						produced[cargos[0]]++;

   443

						if (cargos[1] != CT_INVALID) {

   444

							produced[cargos[1]]++;

   445

						}

   446

					}

   447

				}

   448

			}

   449

		}

   450

	}

   451

}

   452

   453

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

   454

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile,

   455

	int w, int h, int rad)

   456

{

   457

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

   458

   459

	int x = TileX(tile);

   460

	int y = TileY(tile);

   461

   462

	// expand the region by rad tiles on each side

   463

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

   464

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

   465

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

   466

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

   467

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

   468

   469

	assert(x1 < x2);

   470

	assert(y1 < y2);

   471

	assert(w > 0);

   472

	assert(h > 0);

   473

   474

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

   475

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

   476

			TileIndex tile = TileXY(xc, yc);

   477

   478

			if (!IsTileType(tile, MP_STATION)) {

   479

				AcceptedCargo ac;

   480

   481

				GetAcceptedCargo(tile, ac);

   482

				for (uint i = 0; i < lengthof(ac); ++i) accepts[i] += ac[i];

   483

			}

   484

		}

   485

	}

   486

}

   487

   488

struct ottd_Rectangle {

   489

	uint min_x;

   490

	uint min_y;

   491

	uint max_x;

   492

	uint max_y;

   493

};

   494