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

    45

/**

    46

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

    47

 */

    48

static void StationPoolNewBlock(uint start_item)

    49

{

    50

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

    51

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

    52

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

    53

}

    54

    55

static void StationPoolCleanBlock(uint start_item, uint end_item)

    56

{

    57

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

    58

		Station *st = GetStation(i);

    59

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

    60

	}

    61

}

    62

    63

/**

    64

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

    65

 */

    66

static void RoadStopPoolNewBlock(uint start_item)

    67

{

    68

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

    69

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

    70

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

    71

		rs->xy    = INVALID_TILE;

    72

		rs->index = start_item++;

    73

	}

    74

}

    75

    76

DEFINE_OLD_POOL(Station, Station, StationPoolNewBlock, StationPoolCleanBlock)

    77

DEFINE_OLD_POOL(RoadStop, RoadStop, RoadStopPoolNewBlock, NULL)

    78

    79

    80

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

    81

{

    82

	const Station* st = GetStationByTile(tile);

    83

    84

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

    85

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

    86

		assert(rs->next != NULL);

    87

	}

    88

}

    89

    90

    91

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

    92

{

    93

	uint num = 0;

    94

    95

	assert(st != NULL);

    96

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

    97

		num++;

    98

	}

    99

   100

	return num;

   101

}

   102

   103

   104

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

   105

 *  radius that is available within the station */

   106

static uint FindCatchmentRadius(const Station* st)

   107

{

   108

	uint ret = CA_NONE;

   109

   110

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

   111

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

   112

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

   113

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

   114

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

   115

   116

	return ret;

   117

}

   118

   119

#define CHECK_STATIONS_ERR ((Station*)-1)

   120

   121

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

   122

{

   123

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

   124

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

   125

		if (IsTileType(tile_cur, MP_STATION)) {

   126

			StationID t = GetStationIndex(tile_cur);

   127

   128

			if (closest_station == INVALID_STATION) {

   129

				closest_station = t;

   130

			} else if (closest_station != t) {

   131

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   132

				return CHECK_STATIONS_ERR;

   133

			}

   134

		}

   135

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

   136

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

   137

}

   138

   139

   140

/**

   141

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

   142

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

   143

 * @param type the type of tile searched for

   144

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

   145

 *                 in all other cases this parameter is ignored

   146

 * @return the result the noumber of matching tiles around

   147

 */

   148

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

   149

{

   150

	int num = 0;

   151

   152

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

   153

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

   154

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

   155

   156

			if (IsTileType(cur_tile, type)) {

   157

				switch (type) {

   158

					case MP_INDUSTRY:

   159

						if (GetIndustryType(cur_tile) == industry)

   160

							num++;

   161

						break;

   162

   163

					case MP_WATER:

   164

						if (!IsWater(cur_tile))

   165

							break;

   166

						/* FALL THROUGH WHEN WATER TILE */

   167

					case MP_TREES:

   168

						num++;

   169

						break;

   170

   171

					default:

   172

						break;

   173

				}

   174

			}

   175

		}

   176

	}

   177

   178

	return num;

   179

}

   180

   181

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

   182

   183

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

   184

{

   185

	static const uint32 _gen_station_name_bits[] = {

   186

		0,                                      /* 0 */

   187

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

   188

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

   189

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

   190

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

   191

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

   192

	};

   193

   194

	Town *t = st->town;

   195

	uint32 free_names = (uint32)-1;

   196

	int found;

   197

	unsigned long tmp;

   198

   199

	{

   200

		Station *s;

   201

   202

		FOR_ALL_STATIONS(s) {

   203

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

   204

				uint str = M(s->string_id);

   205

				if (str <= 0x20) {

   206

					if (str == M(STR_SV_STNAME_FOREST))

   207

						str = M(STR_SV_STNAME_WOODS);

   208

					CLRBIT(free_names, str);

   209

				}

   210

			}

   211

		}

   212

	}

   213

   214

	/* check default names */

   215

	tmp = free_names & _gen_station_name_bits[flag];

   216

	if (tmp != 0) {

   217

		found = FindFirstBit(tmp);

   218

		goto done;

   219

	}

   220

   221

	/* check mine? */

   222

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

   223

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

   224

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

   225

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

   226

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

   227

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

   228

			found = M(STR_SV_STNAME_MINES);

   229

			goto done;

   230

		}

   231

	}

   232

   233

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

   234

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

   235

		found = M(STR_SV_STNAME);

   236

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

   237

   238

		found = M(STR_SV_STNAME_CENTRAL);

   239

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

   240

	}

   241

   242

	/* Check lakeside */

   243

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

   244

			DistanceFromEdge(tile) < 20 &&

   245

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

   246

		found = M(STR_SV_STNAME_LAKESIDE);

   247

		goto done;

   248

	}

   249

   250

	/* Check woods */

   251

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

   252

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

   253

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

   254

			) {

   255

		found = _opt.landscape == LT_TROPIC ?

   256

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   257

		goto done;

   258

	}

   259

   260

	/* check elevation compared to town */

   261

	{

   262

		uint z = GetTileZ(tile);

   263

		uint z2 = GetTileZ(t->xy);

   264

		if (z < z2) {

   265

			found = M(STR_SV_STNAME_VALLEY);

   266

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

   267

		} else if (z > z2) {

   268

			found = M(STR_SV_STNAME_HEIGHTS);

   269

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

   270

		}

   271

	}

   272

   273

	/* check direction compared to town */

   274

	{

   275

		static const int8 _direction_and_table[] = {

   276

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

   277

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

   278

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

   279

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

   280

		};

   281

   282

		free_names &= _direction_and_table[

   283

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

   284

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

   285

	}

   286

   287

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

   288

	if (tmp == 0) {

   289

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   290

		return false;

   291

	}

   292

	found = FindFirstBit(tmp);

   293

   294

done:

   295

	st->string_id = found + STR_SV_STNAME;

   296

	return true;

   297

}

   298

#undef M

   299

   300

static Station* GetClosestStationFromTile(TileIndex tile)

   301

{

   302

	uint threshold = 8;

   303

	Station* best_station = NULL;

   304

	Station* st;

   305

   306

	FOR_ALL_STATIONS(st) {

   307

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

   308

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

   309

   310

			if (cur_dist < threshold) {

   311

				threshold = cur_dist;

   312

				best_station = st;

   313

			}

   314

		}

   315

	}

   316

   317

	return best_station;

   318

}

   319

   320

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

   321

// st = Station to update for.

   322

static void UpdateStationVirtCoord(Station *st)

   323

{

   324

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

   325

   326

	pt.y -= 32;

   327

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

   328

   329

	SetDParam(0, st->index);

   330

	SetDParam(1, st->facilities);

   331

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

   332

}

   333

   334

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

   335

void UpdateAllStationVirtCoord()

   336

{

   337

	Station* st;

   338

   339

	FOR_ALL_STATIONS(st) {

   340

		UpdateStationVirtCoord(st);

   341

	}

   342

}

   343

   344

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

   345

static void UpdateStationVirtCoordDirty(Station *st)

   346

{

   347

	st->MarkDirty();

   348

	UpdateStationVirtCoord(st);

   349

	st->MarkDirty();

   350

}

   351

   352

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

   353

static uint GetAcceptanceMask(const Station *st)

   354

{

   355

	uint mask = 0;

   356

   357

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

   358

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

   359

	}

   360

	return mask;

   361

}

   362

   363

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

   364

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

   365

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

   366

{

   367

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

   368

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

   369

	}

   370

   371

	SetDParam(0, st->index);

   372

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

   373

}

   374

   375

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

   376

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   377

	int w, int h, int rad)

   378

{

   379

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

   380

   381

	int x = TileX(tile);

   382

	int y = TileY(tile);

   383

   384

	// expand the region by rad tiles on each side

   385

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

   386

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

   387

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

   388

   389

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

   390

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

   391

   392

	assert(x1 < x2);

   393

	assert(y1 < y2);

   394

	assert(w > 0);

   395

	assert(h > 0);

   396

   397

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

   398

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

   399

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

   400

				TileIndex tile = TileXY(xc, yc);

   401

   402

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

   403

				if (gpc != NULL) {

   404

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

   405

   406

					gpc(tile, cargos);

   407

					if (cargos[0] != CT_INVALID) {

   408

						produced[cargos[0]]++;

   409

						if (cargos[1] != CT_INVALID) {

   410

							produced[cargos[1]]++;

   411

						}

   412

					}

   413

				}

   414

			}

   415

		}

   416

	}

   417

}

   418

   419

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

   420

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile,

   421

	int w, int h, int rad)

   422

{

   423

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

   424

   425

	int x = TileX(tile);

   426

	int y = TileY(tile);

   427

   428

	// expand the region by rad tiles on each side

   429

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

   430

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

   431

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

   432

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

   433

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

   434

   435

	assert(x1 < x2);

   436

	assert(y1 < y2);

   437

	assert(w > 0);

   438

	assert(h > 0);

   439

   440

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

   441

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

   442

			TileIndex tile = TileXY(xc, yc);

   443

   444

			if (!IsTileType(tile, MP_STATION)) {

   445

				AcceptedCargo ac;

   446

   447

				GetAcceptedCargo(tile, ac);

   448

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

   449

			}

   450

		}

   451

	}

   452

}

   453

   454

struct ottd_Rectangle {

   455

	uint min_x;

   456

	uint min_y;

   457

	uint max_x;

   458

	uint max_y;

   459

};

   460

   461

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

   462

{

   463

	uint x = TileX(tile);

   464

	uint y = TileY(tile);

   465

   466

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

   467

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

   468

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

   469

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

   470

}

   471

   472

// Update the acceptance for a station.

   473

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

   474

static void UpdateStationAcceptance(Station *st, bool show_msg)

   475

{

   476

	// Don't update acceptance for a buoy

   477

	if (st->IsBuoy()) return;

   478

   479

	ottd_Rectangle rect;

   480

	rect.min_x = MapSizeX();

   481

	rect.min_y = MapSizeY();

   482

	rect.max_x = 0;

   483

	rect.max_y = 0;

   484

   485

	/* old accepted goods types */

   486

	uint old_acc = GetAcceptanceMask(st);

   487

   488

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

   489

	if (st->train_tile != 0) {

   490

		MergePoint(&rect, st->train_tile);

   491

		MergePoint(&rect,

   492

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

   493

		);

   494

	}