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

/**

    47

 * Called if a new block is added to the station-pool

    48

 */

    49

static void StationPoolNewBlock(uint start_item)

    50

{

    51

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    52

	 *  TODO - This is just a temporary stage, this will be removed. */

    53

	for (Station *st = GetStation(start_item); st != NULL; st = (st->index + 1U < GetStationPoolSize()) ? GetStation(st->index + 1U) : NULL) st->index = start_item++;

    54

}

    55

    56

static void StationPoolCleanBlock(uint start_item, uint end_item)

    57

{

    58

	for (uint i = start_item; i <= end_item; i++) {

    59

		Station *st = GetStation(i);

    60

		if (st->IsValid()) st->~Station();

    61

	}

    62

}

    63

    64

/**

    65

 * Called if a new block is added to the roadstop-pool

    66

 */

    67

static void RoadStopPoolNewBlock(uint start_item)

    68

{

    69

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    70

	 * TODO - This is just a temporary stage, this will be removed. */

    71

	for (RoadStop *rs = GetRoadStop(start_item); rs != NULL; rs = (rs->index + 1U < GetRoadStopPoolSize()) ? GetRoadStop(rs->index + 1U) : NULL) {

    72

		rs->xy    = INVALID_TILE;

    73

		rs->index = start_item++;

    74

	}

    75

}

    76

    77

DEFINE_OLD_POOL(Station, Station, StationPoolNewBlock, StationPoolCleanBlock)

    78

DEFINE_OLD_POOL(RoadStop, RoadStop, RoadStopPoolNewBlock, NULL)

    79

    80

    81

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

    82

{

    83

	const Station* st = GetStationByTile(tile);

    84

    85

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

    86

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

    87

		assert(rs->next != NULL);

    88

	}

    89

}

    90

    91

    92

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

    93

{

    94

	uint num = 0;

    95

    96

	assert(st != NULL);

    97

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

    98

		num++;

    99

	}

   100

   101

	return num;

   102

}

   103

   104

   105

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

   106

 *  radius that is available within the station */

   107

static uint FindCatchmentRadius(const Station* st)

   108

{

   109

	uint ret = CA_NONE;

   110

   111

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

   112

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

   113

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

   114

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

   115

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

   116

   117

	return ret;

   118

}

   119

   120

#define CHECK_STATIONS_ERR ((Station*)-1)

   121

   122

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

   123

{

   124

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

   125

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

   126

		if (IsTileType(tile_cur, MP_STATION)) {

   127

			StationID t = GetStationIndex(tile_cur);

   128

   129

			if (closest_station == INVALID_STATION) {

   130

				closest_station = t;

   131

			} else if (closest_station != t) {

   132

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   133

				return CHECK_STATIONS_ERR;

   134

			}

   135

		}

   136

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

   137

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

   138

}

   139

   140

   141

/**

   142

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

   143

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

   144

 * @param type the type of tile searched for

   145

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

   146

 *                 in all other cases this parameter is ignored

   147

 * @return the result the noumber of matching tiles around

   148

 */

   149

static int CountMapSquareAround(TileIndex tile, TileType type, IndustryType industry)

   150

{

   151

	int num = 0;

   152

   153

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

   154

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

   155

			TileIndex cur_tile = TILE_MASK(tile + TileDiffXY(dx, dy));

   156

   157

			if (IsTileType(cur_tile, type)) {

   158

				switch (type) {

   159

					case MP_INDUSTRY:

   160

						if (GetIndustryType(cur_tile) == industry)

   161

							num++;

   162

						break;

   163

   164

					case MP_WATER:

   165

						if (!IsWater(cur_tile))

   166

							break;

   167

						/* FALL THROUGH WHEN WATER TILE */

   168

					case MP_TREES:

   169

						num++;

   170

						break;

   171

   172

					default:

   173

						break;

   174

				}

   175

			}

   176

		}

   177

	}

   178

   179

	return num;

   180

}

   181

   182

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

   183

   184

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

   185

{

   186

	static const uint32 _gen_station_name_bits[] = {

   187

		0,                                      /* 0 */

   188

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

   189

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

   190

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

   191

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

   192

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

   193

	};

   194

   195

	Town *t = st->town;

   196

	uint32 free_names = (uint32)-1;

   197

	int found;

   198

	unsigned long tmp;

   199

   200

	{

   201

		Station *s;

   202

   203

		FOR_ALL_STATIONS(s) {

   204

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

   205

				uint str = M(s->string_id);

   206

				if (str <= 0x20) {

   207

					if (str == M(STR_SV_STNAME_FOREST))

   208

						str = M(STR_SV_STNAME_WOODS);

   209

					CLRBIT(free_names, str);

   210

				}

   211

			}

   212

		}

   213

	}

   214

   215

	/* check default names */

   216

	tmp = free_names & _gen_station_name_bits[flag];

   217

	if (tmp != 0) {

   218

		found = FindFirstBit(tmp);

   219

		goto done;

   220

	}

   221

   222

	/* check mine? */

   223

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

   224

		if (CountMapSquareAround(tile, MP_INDUSTRY, IT_COAL_MINE) >= 2 ||

   225

				CountMapSquareAround(tile, MP_INDUSTRY, IT_IRON_MINE) >= 2 ||

   226

				CountMapSquareAround(tile, MP_INDUSTRY, IT_COPPER_MINE) >= 2 ||

   227

				CountMapSquareAround(tile, MP_INDUSTRY, IT_GOLD_MINE) >= 2 ||

   228

				CountMapSquareAround(tile, MP_INDUSTRY, IT_DIAMOND_MINE) >= 2) {

   229

			found = M(STR_SV_STNAME_MINES);

   230

			goto done;

   231

		}

   232

	}

   233

   234

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

   235

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

   236

		found = M(STR_SV_STNAME);

   237

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

   238

   239

		found = M(STR_SV_STNAME_CENTRAL);

   240

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

   241

	}

   242

   243

	/* Check lakeside */

   244

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

   245

			DistanceFromEdge(tile) < 20 &&

   246

			CountMapSquareAround(tile, MP_WATER, 0) >= 5) {

   247

		found = M(STR_SV_STNAME_LAKESIDE);

   248

		goto done;

   249

	}

   250

   251

	/* Check woods */

   252

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

   253

				CountMapSquareAround(tile, MP_TREES, 0) >= 8 ||

   254

				CountMapSquareAround(tile, MP_INDUSTRY, IT_FOREST) >= 2)

   255

			) {

   256

		found = _opt.landscape == LT_TROPIC ?

   257

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   258

		goto done;

   259

	}

   260

   261

	/* check elevation compared to town */

   262

	{

   263

		uint z = GetTileZ(tile);

   264

		uint z2 = GetTileZ(t->xy);

   265

		if (z < z2) {

   266

			found = M(STR_SV_STNAME_VALLEY);

   267

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

   268

		} else if (z > z2) {

   269

			found = M(STR_SV_STNAME_HEIGHTS);

   270

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

   271

		}

   272

	}

   273

   274

	/* check direction compared to town */

   275

	{

   276

		static const int8 _direction_and_table[] = {

   277

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

   278

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

   279

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

   280

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

   281

		};

   282

   283

		free_names &= _direction_and_table[

   284

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

   285

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

   286

	}

   287

   288

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

   289

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

   290

   291

done:

   292

	st->string_id = found + STR_SV_STNAME;

   293

	return true;

   294

}

   295

#undef M

   296

   297

static Station* GetClosestStationFromTile(TileIndex tile)

   298

{

   299

	uint threshold = 8;

   300

	Station* best_station = NULL;

   301

	Station* st;

   302

   303

	FOR_ALL_STATIONS(st) {

   304

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

   305

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

   306

   307

			if (cur_dist < threshold) {

   308

				threshold = cur_dist;

   309

				best_station = st;

   310

			}

   311

		}

   312

	}

   313

   314

	return best_station;

   315

}

   316

   317

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

   318

// st = Station to update for.

   319

static void UpdateStationVirtCoord(Station *st)

   320

{

   321

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

   322

   323

	pt.y -= 32;

   324

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

   325

   326

	SetDParam(0, st->index);

   327

	SetDParam(1, st->facilities);

   328

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

   329

}

   330

   331

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

   332

void UpdateAllStationVirtCoord()

   333

{

   334

	Station* st;

   335

   336

	FOR_ALL_STATIONS(st) {

   337

		UpdateStationVirtCoord(st);

   338

	}

   339

}

   340

   341

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

   342

static void UpdateStationVirtCoordDirty(Station *st)

   343

{

   344

	st->MarkDirty();

   345

	UpdateStationVirtCoord(st);

   346

	st->MarkDirty();

   347

}

   348

   349

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

   350

static uint GetAcceptanceMask(const Station *st)

   351

{

   352

	uint mask = 0;

   353

   354

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

   355

		if (st->goods[i].acceptance) mask |= 1 << i;

   356

	}

   357

	return mask;

   358

}

   359

   360

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

   361

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

   362

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

   363

{

   364

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

   365

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

   366

	}

   367

   368

	SetDParam(0, st->index);

   369

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

   370

}

   371

   372

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

   373

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   374

	int w, int h, int rad)

   375

{

   376

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

   377

   378

	int x = TileX(tile);

   379

	int y = TileY(tile);

   380

   381

	// expand the region by rad tiles on each side

   382

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

   383

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

   384

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

   385

   386

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

   387

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

   388

   389

	assert(x1 < x2);

   390

	assert(y1 < y2);

   391

	assert(w > 0);

   392

	assert(h > 0);

   393

   394

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

   395

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

   396

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

   397

				TileIndex tile = TileXY(xc, yc);

   398

   399

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

   400

				if (gpc != NULL) {

   401

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

   402

   403

					gpc(tile, cargos);

   404

					if (cargos[0] != CT_INVALID) {

   405

						produced[cargos[0]]++;

   406

						if (cargos[1] != CT_INVALID) {

   407

							produced[cargos[1]]++;

   408

						}

   409

					}

   410

				}

   411

			}

   412

		}

   413

	}

   414

}

   415

   416

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

   417

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile,

   418

	int w, int h, int rad)

   419

{

   420

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

   421

   422

	int x = TileX(tile);

   423

	int y = TileY(tile);

   424

   425

	// expand the region by rad tiles on each side

   426

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

   427

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

   428

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

   429

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

   430

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

   431

   432

	assert(x1 < x2);

   433

	assert(y1 < y2);

   434

	assert(w > 0);

   435

	assert(h > 0);

   436

   437

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

   438

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

   439

			TileIndex tile = TileXY(xc, yc);

   440

   441

			if (!IsTileType(tile, MP_STATION)) {

   442

				AcceptedCargo ac;

   443

   444

				GetAcceptedCargo(tile, ac);

   445

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

   446

			}

   447

		}

   448

	}

   449

}

   450

   451

struct ottd_Rectangle {

   452

	uint min_x;

   453

	uint min_y;

   454

	uint max_x;

   455

	uint max_y;

   456

};

   457

   458

static inline void MergePoint(ottd_Rectangle* rect, TileIndex tile)

   459

{

   460

	uint x = TileX(tile);

   461

	uint y = TileY(tile);

   462

   463

	if (rect->min_x > x) rect->min_x = x;

   464

	if (rect->min_y > y) rect->min_y = y;

   465

	if (rect->max_x < x) rect->max_x = x;

   466

	if (rect->max_y < y) rect->max_y = y;

   467

}

   468

   469

// Update the acceptance for a station.

   470

// show_msg controls whether to display a message that acceptance was changed.

   471

static void UpdateStationAcceptance(Station *st, bool show_msg)

   472

{

   473

	// Don't update acceptance for a buoy

   474

	if (st->IsBuoy()) return;

   475

   476

	ottd_Rectangle rect;

   477

	rect.min_x = MapSizeX();

   478

	rect.min_y = MapSizeY();

   479

	rect.max_x = 0;

   480

	rect.max_y = 0;

   481

   482

	/* old accepted goods types */

   483

	uint old_acc = GetAcceptanceMask(st);

   484

   485

	// Put all the tiles that span an area in the table.

   486

	if (st->train_tile != 0) {

   487

		MergePoint(&rect, st->train_tile);

   488

		MergePoint(&rect,

   489

			st->train_tile + TileDiffXY(st->trainst_w - 1, st->trainst_h - 1)

   490

		);

   491

	}

   492

   493

	if (st->airport_tile != 0) {

   494