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 "water_map.h"

    34

#include "industry_map.h"

    35

#include "newgrf_callbacks.h"

    36

#include "newgrf_station.h"

    37

#include "yapf/yapf.h"

    38

#include "date.h"

    39

#include "helpers.hpp"

    40

#include "misc/autoptr.hpp"

    41

#include "road.h"

    42

#include "cargotype.h"

    43

    44

/**

    45

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

    46

 */

    47

static void StationPoolNewBlock(uint start_item)

    48

{

    49

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

    50

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

    51

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

    52

}

    53

    54

static void StationPoolCleanBlock(uint start_item, uint end_item)

    55

{

    56

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

    57

		Station *st = GetStation(i);

    58

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

    59

	}

    60

}

    61

    62

/**

    63

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

    64

 */

    65

static void RoadStopPoolNewBlock(uint start_item)

    66

{

    67

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

    68

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

    69

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

    70

		rs->xy    = INVALID_TILE;

    71

		rs->index = start_item++;

    72

	}

    73

}

    74

    75

DEFINE_OLD_POOL(Station, Station, StationPoolNewBlock, StationPoolCleanBlock)

    76

DEFINE_OLD_POOL(RoadStop, RoadStop, RoadStopPoolNewBlock, NULL)

    77

    78

    79

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

    80

{

    81

	const Station* st = GetStationByTile(tile);

    82

    83

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

    84

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

    85

		assert(rs->next != NULL);

    86

	}

    87

}

    88

    89

    90

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

    91

{

    92

	uint num = 0;

    93

    94

	assert(st != NULL);

    95

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

    96

		num++;

    97

	}

    98

    99

	return num;

   100

}

   101

   102

   103

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

   104

 *  radius that is available within the station */

   105

static uint FindCatchmentRadius(const Station* st)

   106

{

   107

	uint ret = CA_NONE;

   108

   109

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

   110

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

   111

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

   112

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

   113

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

   114

   115

	return ret;

   116

}

   117

   118

#define CHECK_STATIONS_ERR ((Station*)-1)

   119

   120

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

   121

{

   122

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

   123

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

   124

		if (IsTileType(tile_cur, MP_STATION)) {

   125

			StationID t = GetStationIndex(tile_cur);

   126

   127

			if (closest_station == INVALID_STATION) {

   128

				closest_station = t;

   129

			} else if (closest_station != t) {

   130

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   131

				return CHECK_STATIONS_ERR;

   132

			}

   133

		}

   134

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

   135

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

   136

}

   137

   138

   139

/**

   140

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

   141

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

   142

 * @param type the type of tile searched for

   143

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

   144

 *                 in all other cases this parameter is ignored

   145

 * @return the result the noumber of matching tiles around

   146

 */

   147

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

   148

{

   149

	int num = 0;

   150

   151

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

   152

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

   153

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

   154

   155

			if (IsTileType(cur_tile, type)) {

   156

				switch (type) {

   157

					case MP_INDUSTRY:

   158

						if (GetIndustryType(cur_tile) == industry)

   159

							num++;

   160

						break;

   161

   162

					case MP_WATER:

   163

						if (!IsWater(cur_tile))

   164

							break;

   165

						/* FALL THROUGH WHEN WATER TILE */

   166

					case MP_TREES:

   167

						num++;

   168

						break;

   169

   170

					default:

   171

						break;

   172

				}

   173

			}

   174

		}

   175

	}

   176

   177

	return num;

   178

}

   179

   180

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

   181

   182

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

   183

{

   184

	static const uint32 _gen_station_name_bits[] = {

   185

		0,                                      /* 0 */

   186

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

   187

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

   188

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

   189

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

   190

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

   191

	};

   192

   193

	Town *t = st->town;

   194

	uint32 free_names = (uint32)-1;

   195

	int found;

   196

	unsigned long tmp;

   197

   198

	{

   199

		Station *s;

   200

   201

		FOR_ALL_STATIONS(s) {

   202

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

   203

				uint str = M(s->string_id);

   204

				if (str <= 0x20) {

   205

					if (str == M(STR_SV_STNAME_FOREST))

   206

						str = M(STR_SV_STNAME_WOODS);

   207

					CLRBIT(free_names, str);

   208

				}

   209

			}

   210

		}

   211

	}

   212

   213

	/* check default names */

   214

	tmp = free_names & _gen_station_name_bits[flag];

   215

	if (tmp != 0) {

   216

		found = FindFirstBit(tmp);

   217

		goto done;

   218

	}

   219

   220

	/* check mine? */

   221

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

   222

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

   223

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

   224

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

   225

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

   226

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

   227

			found = M(STR_SV_STNAME_MINES);

   228

			goto done;

   229

		}

   230

	}

   231

   232

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

   233

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

   234

		found = M(STR_SV_STNAME);

   235

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

   236

   237

		found = M(STR_SV_STNAME_CENTRAL);

   238

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

   239

	}

   240

   241

	/* Check lakeside */

   242

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

   243

			DistanceFromEdge(tile) < 20 &&

   244

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

   245

		found = M(STR_SV_STNAME_LAKESIDE);

   246

		goto done;

   247

	}

   248

   249

	/* Check woods */

   250

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

   251

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

   252

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

   253

			) {

   254

		found = _opt.landscape == LT_TROPIC ?

   255

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   256

		goto done;

   257

	}

   258

   259

	/* check elevation compared to town */

   260

	{

   261

		uint z = GetTileZ(tile);

   262

		uint z2 = GetTileZ(t->xy);

   263

		if (z < z2) {

   264

			found = M(STR_SV_STNAME_VALLEY);

   265

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

   266

		} else if (z > z2) {

   267

			found = M(STR_SV_STNAME_HEIGHTS);

   268

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

   269

		}

   270

	}

   271

   272

	/* check direction compared to town */

   273

	{

   274

		static const int8 _direction_and_table[] = {

   275

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

   276

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

   277

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

   279

		};

   280

   281

		free_names &= _direction_and_table[

   282

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

   283

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

   284

	}

   285

   286

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

   287

	if (tmp == 0) {

   288

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   289

		return false;

   290

	}

   291

	found = FindFirstBit(tmp);

   292

   293

done:

   294

	st->string_id = found + STR_SV_STNAME;

   295

	return true;

   296

}

   297

#undef M

   298

   299

static Station* GetClosestStationFromTile(TileIndex tile)

   300

{

   301

	uint threshold = 8;

   302

	Station* best_station = NULL;

   303

	Station* st;

   304

   305

	FOR_ALL_STATIONS(st) {

   306

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

   307

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

   308

   309

			if (cur_dist < threshold) {

   310

				threshold = cur_dist;

   311

				best_station = st;

   312

			}

   313

		}

   314

	}

   315

   316

	return best_station;

   317

}

   318

   319

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

   320

// st = Station to update for.

   321

static void UpdateStationVirtCoord(Station *st)

   322

{

   323

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

   324

   325

	pt.y -= 32;

   326

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

   327

   328

	SetDParam(0, st->index);

   329

	SetDParam(1, st->facilities);

   330

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

   331

}

   332

   333

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

   334

void UpdateAllStationVirtCoord()

   335

{

   336

	Station* st;

   337

   338

	FOR_ALL_STATIONS(st) {

   339

		UpdateStationVirtCoord(st);

   340

	}

   341

}

   342

   343

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

   344

static void UpdateStationVirtCoordDirty(Station *st)

   345

{

   346

	st->MarkDirty();

   347

	UpdateStationVirtCoord(st);

   348

	st->MarkDirty();

   349

}

   350

   351

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

   352

static uint GetAcceptanceMask(const Station *st)

   353

{

   354

	uint mask = 0;

   355

   356

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

   357

		if (st->goods[i].waiting_acceptance & 0x8000) mask |= 1 << i;

   358

	}

   359

	return mask;

   360

}

   361

   362

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

   363

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

   364

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

   365

{

   366

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

   367

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

   368

	}

   369

   370

	SetDParam(0, st->index);

   371

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

   372

}

   373

   374

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

   375

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   376

	int w, int h, int rad)

   377

{

   378

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

   379

   380

	int x = TileX(tile);

   381

	int y = TileY(tile);

   382

   383

	// expand the region by rad tiles on each side

   384

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

   385

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

   386

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

   387

   388

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

   389

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

   390

   391

	assert(x1 < x2);

   392

	assert(y1 < y2);

   393

	assert(w > 0);

   394

	assert(h > 0);

   395

   396

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

   397

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

   398

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

   399

				TileIndex tile = TileXY(xc, yc);

   400

   401

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

   402

				if (gpc != NULL) {

   403

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

   404

   405

					gpc(tile, cargos);

   406

					if (cargos[0] != CT_INVALID) {

   407

						produced[cargos[0]]++;

   408

						if (cargos[1] != CT_INVALID) {

   409

							produced[cargos[1]]++;

   410

						}

   411

					}

   412

				}

   413

			}

   414

		}

   415

	}

   416

}

   417

   418

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

   419

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile,

   420

	int w, int h, int rad)

   421

{

   422

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

   423

   424

	int x = TileX(tile);

   425

	int y = TileY(tile);

   426

   427

	// expand the region by rad tiles on each side

   428

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

   429

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

   430

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

   431

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

   432

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

   433

   434

	assert(x1 < x2);

   435

	assert(y1 < y2);

   436

	assert(w > 0);

   437

	assert(h > 0);

   438

   439

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

   440

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

   441

			TileIndex tile = TileXY(xc, yc);

   442

   443

			if (!IsTileType(tile, MP_STATION)) {

   444

				AcceptedCargo ac;

   445

   446

				GetAcceptedCargo(tile, ac);

   447

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

   448

			}

   449

		}

   450

	}

   451

}

   452

   453

struct ottd_Rectangle {

   454

	uint min_x;

   455

	uint min_y;

   456

	uint max_x;

   457

	uint max_y;

   458

};

   459

   460

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

   461

{

   462

	uint x = TileX(tile);

   463

	uint y = TileY(tile);

   464

   465

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

   466

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

   467

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

   468

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

   469

}

   470

   471

// Update the acceptance for a station.

   472

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

   473

static void UpdateStationAcceptance(Station *st, bool show_msg)

   474

{

   475

	// Don't update acceptance for a buoy

   476

	if (st->IsBuoy()) return;

   477

   478

	ottd_Rectangle rect;

   479

	rect.min_x = MapSizeX();

   480

	rect.min_y = MapSizeY();

   481

	rect.max_x = 0;

   482

	rect.max_y = 0;

   483

   484

	/* old accepted goods types */

   485

	uint old_acc = GetAcceptanceMask(st);

   486

   487

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

   488

	if (st->train_tile != 0) {

   489

		MergePoint(&rect, st->train_tile);

   490

		MergePoint(&rect,

   491

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

   492

		);

   493

	}

   494