1

/* $Id$ */

     2

     3

/** @file station_cmd.c */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "debug.h"

     9

#include "functions.h"

    10

#include "station_map.h"

    11

#include "table/sprites.h"

    12

#include "table/strings.h"

    13

#include "map.h"

    14

#include "tile.h"

    15

#include "station.h"

    16

#include "gfx.h"

    17

#include "window.h"

    18

#include "viewport.h"

    19

#include "command.h"

    20

#include "town.h"

    21

#include "vehicle.h"

    22

#include "news.h"

    23

#include "saveload.h"

    24

#include "economy.h"

    25

#include "player.h"

    26

#include "airport.h"

    27

#include "sprite.h"

    28

#include "depot.h"

    29

#include "train.h"

    30

#include "water_map.h"

    31

#include "industry_map.h"

    32

#include "newgrf_callbacks.h"

    33

#include "newgrf_station.h"

    34

#include "yapf/yapf.h"

    35

#include "date.h"

    36

#include "helpers.hpp"

    37

    38

#include <memory>     // for auto_ptr

    39

    40

/**

    41

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

    42

 */

    43

static void StationPoolNewBlock(uint start_item)

    44

{

    45

	Station *st;

    46

    47

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

    48

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

    49

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

    50

}

    51

    52

static void StationPoolCleanBlock(uint start_item, uint end_item)

    53

{

    54

	uint i;

    55

    56

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

    57

		Station *st = GetStation(i);

    58

		if (IsValidStation(st)) 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

	RoadStop *rs;

    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 (rs = GetRoadStop(start_item); rs != NULL; rs = (rs->index + 1U < GetRoadStopPoolSize()) ? GetRoadStop(rs->index + 1U) : NULL) rs->index = start_item++;

    72

}

    73

    74

DEFINE_OLD_POOL(Station, Station, StationPoolNewBlock, StationPoolCleanBlock)

    75

DEFINE_OLD_POOL(RoadStop, RoadStop, RoadStopPoolNewBlock, NULL)

    76

    77

    78

extern void UpdateAirplanesOnNewStation(Station *st);

    79

    80

    81

RoadStop* GetPrimaryRoadStop(const Station* st, RoadStopType type)

    82

{

    83

	switch (type) {

    84

		case RS_BUS:   return st->bus_stops;

    85

		case RS_TRUCK: return st->truck_stops;

    86

		default: NOT_REACHED();

    87

	}

    88

    89

	return NULL;

    90

}

    91

    92

RoadStop* GetRoadStopByTile(TileIndex tile, RoadStopType type)

    93

{

    94

	const Station* st = GetStationByTile(tile);

    95

	RoadStop* rs;

    96

    97

	for (rs = GetPrimaryRoadStop(st, type); rs->xy != tile; rs = rs->next) {

    98

		assert(rs->next != NULL);

    99

	}

   100

   101

	return rs;

   102

}

   103

   104

uint GetNumRoadStopsInStation(const Station* st, RoadStopType type)

   105

{

   106

	uint num = 0;

   107

	const RoadStop *rs;

   108

   109

	assert(st != NULL);

   110

	for (rs = GetPrimaryRoadStop(st, type); rs != NULL; rs = rs->next) num++;

   111

   112

	return num;

   113

}

   114

   115

   116

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

   117

 *  radius that is available within the station */

   118

static uint FindCatchmentRadius(const Station* st)

   119

{

   120

	CatchmentAera ret = CA_NONE;

   121

   122

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

   123

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

   124

	if (st->train_tile) ret = max(ret, CA_TRAIN);

   125

	if (st->dock_tile)  ret = max(ret, CA_DOCK);

   126

   127

	if (st->airport_tile) {

   128

		switch (st->airport_type) {

   129

			case AT_OILRIG:        ret = max(ret, CA_AIR_OILPAD);   break;

   130

			case AT_SMALL:         ret = max(ret, CA_AIR_SMALL);    break;

   131

			case AT_HELIPORT:      ret = max(ret, CA_AIR_HELIPORT); break;

   132

			case AT_LARGE:         ret = max(ret, CA_AIR_LARGE);    break;

   133

			case AT_METROPOLITAN:  ret = max(ret, CA_AIR_METRO);    break;

   134

			case AT_INTERNATIONAL: ret = max(ret, CA_AIR_INTER);    break;

   135

			case AT_COMMUTER:      ret = max(ret, CA_AIR_COMMUTER); break;

   136

			case AT_HELIDEPOT:     ret = max(ret, CA_AIR_HELIDEPOT); break;

   137

			case AT_INTERCON:      ret = max(ret, CA_AIR_INTERCON); break;

   138

			case AT_HELISTATION:   ret = max(ret, CA_AIR_HELISTATION); break;

   139

		}

   140

	}

   141

   142

	return ret;

   143

}

   144

   145

#define CHECK_STATIONS_ERR ((Station*)-1)

   146

   147

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

   148

{

   149

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

   150

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

   151

		if (IsTileType(tile_cur, MP_STATION)) {

   152

			StationID t = GetStationIndex(tile_cur);

   153

			{

   154

				Station *st = GetStation(t);

   155

				// you cannot take control of an oilrig!!

   156

				if (st->airport_type == AT_OILRIG && st->facilities == (FACIL_AIRPORT|FACIL_DOCK))

   157

					continue;

   158

			}

   159

   160

			if (closest_station == INVALID_STATION) {

   161

				closest_station = t;

   162

			} else if (closest_station != t) {

   163

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   164

				return CHECK_STATIONS_ERR;

   165

			}

   166

		}

   167

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

   168

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

   169

}

   170

   171

static Station *AllocateStation(void)

   172

{

   173

	Station *st = NULL;

   174

   175

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

   176

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

   177

	for (st = GetStation(0); st != NULL; st = (st->index + 1U < GetStationPoolSize()) ? GetStation(st->index + 1U) : NULL) {

   178

		if (!IsValidStation(st)) {

   179

			StationID index = st->index;

   180

   181

			memset(st, 0, sizeof(Station));

   182

			st->index = index;

   183

			return st;

   184

		}

   185

	}

   186

   187

	/* Check if we can add a block to the pool */

   188

	if (AddBlockToPool(&_Station_pool)) return AllocateStation();

   189

   190

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   191

	return NULL;

   192

}

   193

   194

   195

/**

   196

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

   197

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

   198

 * @param type the type of tile searched for

   199

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

   200

 *                 in all other cases this parameter is ignored

   201

 * @result the noumber of matching tiles around

   202

 */

   203

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

   204

{

   205

	TileIndex cur_tile;

   206

	int dx, dy;

   207

	int num = 0;

   208

   209

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

   210

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

   211

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

   212

   213

			if (IsTileType(cur_tile, type)) {

   214

				switch (type) {

   215

					case MP_INDUSTRY:

   216

						if (GetIndustryType(cur_tile) == industry)

   217

							num++;

   218

						break;

   219

   220

					case MP_WATER:

   221

						if (!IsWater(cur_tile))

   222

							break;

   223

						/* FALL THROUGH WHEN WATER TILE */

   224

					case MP_TREES:

   225

						num++;

   226

						break;

   227

   228

					default:

   229

						break;

   230

				}

   231

			}

   232

		}

   233

	}

   234

   235

	return num;

   236

}

   237

   238

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

   239

   240

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

   241

{

   242

	static const uint32 _gen_station_name_bits[] = {

   243

		0,                                      /* 0 */

   244

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

   245

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

   246

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

   247

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

   248

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

   249

	};

   250

   251

	Town *t = st->town;

   252

	uint32 free_names = (uint32)-1;

   253

	int found;

   254

	uint z,z2;

   255

	unsigned long tmp;

   256

   257

	{

   258

		Station *s;

   259

   260

		FOR_ALL_STATIONS(s) {

   261

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

   262

				uint str = M(s->string_id);

   263

				if (str <= 0x20) {

   264

					if (str == M(STR_SV_STNAME_FOREST))

   265

						str = M(STR_SV_STNAME_WOODS);

   266

					CLRBIT(free_names, str);

   267

				}

   268

			}

   269

		}

   270

	}

   271

   272

	/* check default names */

   273

	tmp = free_names & _gen_station_name_bits[flag];

   274

	if (tmp != 0) {

   275

		found = FindFirstBit(tmp);

   276

		goto done;

   277

	}

   278

   279

	/* check mine? */

   280

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

   281

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

   282

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

   283

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

   284

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

   285

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

   286

			found = M(STR_SV_STNAME_MINES);

   287

			goto done;

   288

		}

   289

	}

   290

   291

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

   292

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

   293

		found = M(STR_SV_STNAME);

   294

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

   295

   296

		found = M(STR_SV_STNAME_CENTRAL);

   297

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

   298

	}

   299

   300

	/* Check lakeside */

   301

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

   302

			DistanceFromEdge(tile) < 20 &&

   303

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

   304

		found = M(STR_SV_STNAME_LAKESIDE);

   305

		goto done;

   306

	}

   307

   308

	/* Check woods */

   309

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

   310

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

   311

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

   312

			) {

   313

		found = _opt.landscape == LT_DESERT ?

   314

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   315

		goto done;

   316

	}

   317

   318

	/* check elevation compared to town */

   319

	z = GetTileZ(tile);

   320

	z2 = GetTileZ(t->xy);

   321

	if (z < z2) {

   322

		found = M(STR_SV_STNAME_VALLEY);

   323

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

   324

	} else if (z > z2) {

   325

		found = M(STR_SV_STNAME_HEIGHTS);

   326

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

   327

	}

   328

   329

	/* check direction compared to town */

   330

	{

   331

		static const int8 _direction_and_table[] = {

   332

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

   333

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

   334

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

   335

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

   336

		};

   337

   338

		free_names &= _direction_and_table[

   339

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

   340

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

   341

	}

   342

   343

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

   344

	if (tmp == 0) {

   345

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   346

		return false;

   347

	}

   348

	found = FindFirstBit(tmp);

   349

   350

done:

   351

	st->string_id = found + STR_SV_STNAME;

   352

	return true;

   353

}

   354

#undef M

   355

   356

static Station* GetClosestStationFromTile(TileIndex tile, uint threshold, PlayerID owner)

   357

{

   358

	Station* best_station = NULL;

   359

	Station* st;

   360

   361

	FOR_ALL_STATIONS(st) {

   362

		if ((owner == PLAYER_SPECTATOR || st->owner == owner)) {

   363

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

   364

   365

			if (cur_dist < threshold) {

   366

				threshold = cur_dist;

   367

				best_station = st;

   368

			}

   369

		}

   370

	}

   371

   372

	return best_station;

   373

}

   374

   375

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

   376

// st = Station to update for.

   377

static void UpdateStationVirtCoord(Station *st)

   378

{

   379

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

   380

   381

	pt.y -= 32;

   382

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

   383

   384

	SetDParam(0, st->index);

   385

	SetDParam(1, st->facilities);

   386

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

   387

}

   388

   389

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

   390

void UpdateAllStationVirtCoord(void)

   391

{

   392

	Station* st;

   393

   394

	FOR_ALL_STATIONS(st) {

   395

		UpdateStationVirtCoord(st);

   396

	}

   397

}

   398

   399

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

   400

static void UpdateStationVirtCoordDirty(Station *st)

   401

{

   402

	st->MarkDirty();

   403

	UpdateStationVirtCoord(st);

   404

	st->MarkDirty();

   405

}

   406

   407

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

   408

static uint GetAcceptanceMask(const Station *st)

   409

{

   410

	uint mask = 0;

   411

	uint i;

   412

   413

	for (i = 0; i != NUM_CARGO; i++) {

   414

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

   415

	}

   416

	return mask;

   417

}

   418

   419

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

   420

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

   421

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

   422

{

   423

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

   424

		SetDParam(i + 1, _cargoc.names_s[cargo[i]]);

   425

	}

   426

   427

	SetDParam(0, st->index);

   428

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

   429

}

   430

   431

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

   432

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   433

	int w, int h, int rad)

   434

{

   435

	int x,y;

   436

	int x1,y1,x2,y2;

   437

	int xc,yc;

   438

   439

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

   440

   441

	x = TileX(tile);

   442

	y = TileY(tile);

   443

   444

	// expand the region by rad tiles on each side

   445

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

   446

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

   447

	x1 = max(x - rad, 0);

   448

   449

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

   450

	y1 = max(y - rad, 0);

   451

   452

	assert(x1 < x2);

   453

	assert(y1 < y2);

   454

	assert(w > 0);

   455

	assert(h > 0);

   456

   457

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

   458

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

   459

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

   460

				GetProducedCargoProc *gpc;

   461

				TileIndex tile = TileXY(xc, yc);

   462

   463

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

   464

				if (gpc != NULL) {

   465

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

   466

   467

					gpc(tile, cargos);

   468

					if (cargos[0] != CT_INVALID) {

   469

						produced[cargos[0]]++;

   470

						if (cargos[1] != CT_INVALID) {

   471

							produced[cargos[1]]++;

   472

						}

   473

					}

   474

				}

   475

			}

   476

		}

   477

	}

   478

}

   479

   480

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

   481

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile,

   482

	int w, int h, int rad)

   483

{

   484

	int x,y;

   485

	int x1,y1,x2,y2;

   486

	int xc,yc;

   487

   488

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

   489

   490

	x = TileX(tile);

   491

	y = TileY(tile);

   492

   493

	// expand the region by rad tiles on each side

   494

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

   495

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

   496

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