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

static void InitializeRoadStop(RoadStop *road_stop, RoadStop *previous, TileIndex tile, StationID index)

    81

{

    82

	road_stop->xy = tile;

    83

	road_stop->used = true;

    84

	road_stop->status = 3; //stop is free

    85

	road_stop->next = NULL;

    86

	road_stop->prev = previous;

    87

	road_stop->station = index;

    88

	road_stop->num_vehicles = 0;

    89

}

    90

    91

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

    92

{

    93

	switch (type) {

    94

		case RS_BUS:   return st->bus_stops;

    95

		case RS_TRUCK: return st->truck_stops;

    96

		default: NOT_REACHED();

    97

	}

    98

    99

	return NULL;

   100

}

   101

   102

RoadStop* GetRoadStopByTile(TileIndex tile, RoadStopType type)

   103

{

   104

	const Station* st = GetStationByTile(tile);

   105

	RoadStop* rs;

   106

   107

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

   108

		assert(rs->next != NULL);

   109

	}

   110

   111

	return rs;

   112

}

   113

   114

uint GetNumRoadStopsInStation(const Station* st, RoadStopType type)

   115

{

   116

	uint num = 0;

   117

	const RoadStop *rs;

   118

   119

	assert(st != NULL);

   120

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

   121

   122

	return num;

   123

}

   124

   125

RoadStop *AllocateRoadStop(void)

   126

{

   127

	RoadStop *rs;

   128

   129

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

   130

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

   131

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

   132

		if (!IsValidRoadStop(rs)) {

   133

			RoadStopID index = rs->index;

   134

   135

			memset(rs, 0, sizeof(*rs));

   136

			rs->index = index;

   137

   138

			return rs;

   139

		}

   140

	}

   141

   142

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

   143

	if (AddBlockToPool(&_RoadStop_pool)) return AllocateRoadStop();

   144

   145

	return NULL;

   146

}

   147

   148

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

   149

 *  radius that is available within the station */

   150

static uint FindCatchmentRadius(const Station* st)

   151

{

   152

	CatchmentAera ret = CA_NONE;

   153

   154

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

   155

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

   156

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

   157

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

   158

   159

	if (st->airport_tile) {

   160

		switch (st->airport_type) {

   161

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

   162

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

   163

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

   164

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

   165

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

   166

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

   167

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

   168

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

   169

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

   170

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

   171

		}

   172

	}

   173

   174

	return ret;

   175

}

   176

   177

#define CHECK_STATIONS_ERR ((Station*)-1)

   178

   179

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

   180

{

   181

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

   182

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

   183

		if (IsTileType(tile_cur, MP_STATION)) {

   184

			StationID t = GetStationIndex(tile_cur);

   185

			{

   186

				Station *st = GetStation(t);

   187

				// you cannot take control of an oilrig!!

   188

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

   189

					continue;

   190

			}

   191

   192

			if (closest_station == INVALID_STATION) {

   193

				closest_station = t;

   194

			} else if (closest_station != t) {

   195

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   196

				return CHECK_STATIONS_ERR;

   197

			}

   198

		}

   199

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

   200

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

   201

}

   202

   203

static Station *AllocateStation(void)

   204

{

   205

	Station *st = NULL;

   206

   207

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

   208

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

   209

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

   210

		if (!IsValidStation(st)) {

   211

			StationID index = st->index;

   212

   213

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

   214

			st->index = index;

   215

			return st;

   216

		}

   217

	}

   218

   219

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

   220

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

   221

   222

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   223

	return NULL;

   224

}

   225

   226

   227

/**

   228

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

   229

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

   230

 * @param type the type of tile searched for

   231

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

   232

 *                 in all other cases this parameter is ignored

   233

 * @result the noumber of matching tiles around

   234

 */

   235

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

   236

{

   237

	TileIndex cur_tile;

   238

	int dx, dy;

   239

	int num = 0;

   240

   241

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

   242

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

   243

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

   244

   245

			if (IsTileType(cur_tile, type)) {

   246

				switch (type) {

   247

					case MP_INDUSTRY:

   248

						if (GetIndustryType(cur_tile) == industry)

   249

							num++;

   250

						break;

   251

   252

					case MP_WATER:

   253

						if (!IsWater(cur_tile))

   254

							break;

   255

						/* FALL THROUGH WHEN WATER TILE */

   256

					case MP_TREES:

   257

						num++;

   258

						break;

   259

   260

					default:

   261

						break;

   262

				}

   263

			}

   264

		}

   265

	}

   266

   267

	return num;

   268

}

   269

   270

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

   271

   272

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

   273

{

   274

	static const uint32 _gen_station_name_bits[] = {

   275

		0,                                      /* 0 */

   276

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

   277

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

   278

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

   279

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

   280

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

   281

	};

   282

   283

	Town *t = st->town;

   284

	uint32 free_names = (uint32)-1;

   285

	int found;

   286

	uint z,z2;

   287

	unsigned long tmp;

   288

   289

	{

   290

		Station *s;

   291

   292

		FOR_ALL_STATIONS(s) {

   293

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

   294

				uint str = M(s->string_id);

   295

				if (str <= 0x20) {

   296

					if (str == M(STR_SV_STNAME_FOREST))

   297

						str = M(STR_SV_STNAME_WOODS);

   298

					CLRBIT(free_names, str);

   299

				}

   300

			}

   301

		}

   302

	}

   303

   304

	/* check default names */

   305

	tmp = free_names & _gen_station_name_bits[flag];

   306

	if (tmp != 0) {

   307

		found = FindFirstBit(tmp);

   308

		goto done;

   309

	}

   310

   311

	/* check mine? */

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

			found = M(STR_SV_STNAME_MINES);

   319

			goto done;

   320

		}

   321

	}

   322

   323

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

   324

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

   325

		found = M(STR_SV_STNAME);

   326

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

   327

   328

		found = M(STR_SV_STNAME_CENTRAL);

   329

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

   330

	}

   331

   332

	/* Check lakeside */

   333

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

   334

			DistanceFromEdge(tile) < 20 &&

   335

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

   336

		found = M(STR_SV_STNAME_LAKESIDE);

   337

		goto done;

   338

	}

   339

   340

	/* Check woods */

   341

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

   342

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

   343

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

   344

			) {

   345

		found = _opt.landscape == LT_DESERT ?

   346

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   347

		goto done;

   348

	}

   349

   350

	/* check elevation compared to town */

   351

	z = GetTileZ(tile);

   352

	z2 = GetTileZ(t->xy);

   353

	if (z < z2) {

   354

		found = M(STR_SV_STNAME_VALLEY);

   355

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

   356

	} else if (z > z2) {

   357

		found = M(STR_SV_STNAME_HEIGHTS);

   358

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

   359

	}

   360

   361

	/* check direction compared to town */

   362

	{

   363

		static const int8 _direction_and_table[] = {

   364

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

   365

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

   366

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

   367

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

   368

		};

   369

   370

		free_names &= _direction_and_table[

   371

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

   372

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

   373

	}

   374

   375

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

   376

	if (tmp == 0) {

   377

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   378

		return false;

   379

	}

   380

	found = FindFirstBit(tmp);

   381

   382

done:

   383

	st->string_id = found + STR_SV_STNAME;

   384

	return true;

   385

}

   386

#undef M

   387

   388

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

   389

{

   390

	Station* best_station = NULL;

   391

	Station* st;

   392

   393

	FOR_ALL_STATIONS(st) {

   394

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

   395

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

   396

   397

			if (cur_dist < threshold) {

   398

				threshold = cur_dist;

   399

				best_station = st;

   400

			}

   401

		}

   402

	}

   403

   404

	return best_station;

   405

}

   406

   407

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

   408

// st = Station to update for.

   409

static void UpdateStationVirtCoord(Station *st)

   410

{

   411

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

   412

   413

	pt.y -= 32;

   414

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

   415

   416

	SetDParam(0, st->index);

   417

	SetDParam(1, st->facilities);

   418

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

   419

}

   420

   421

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

   422

void UpdateAllStationVirtCoord(void)

   423

{

   424

	Station* st;

   425

   426

	FOR_ALL_STATIONS(st) {

   427

		UpdateStationVirtCoord(st);

   428

	}

   429

}

   430

   431

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

   432

static void UpdateStationVirtCoordDirty(Station *st)

   433

{

   434

	st->MarkDirty();

   435

	UpdateStationVirtCoord(st);

   436

	st->MarkDirty();

   437

}

   438

   439

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

   440

static uint GetAcceptanceMask(const Station *st)

   441

{

   442

	uint mask = 0;

   443

	uint i;

   444

   445

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

   446

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

   447

	}

   448

	return mask;

   449

}

   450

   451

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

   452

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

   453

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

   454

{

   455

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

   456

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

   457

	}

   458

   459

	SetDParam(0, st->index);

   460

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

   461

}

   462

   463

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

   464

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   465

	int w, int h, int rad)

   466

{

   467

	int x,y;

   468

	int x1,y1,x2,y2;

   469

	int xc,yc;

   470

   471

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

   472

   473

	x = TileX(tile);

   474

	y = TileY(tile);

   475

   476

	// expand the region by rad tiles on each side

   477

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

   478

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

   479

	x1 = max(x - rad, 0);

   480

   481

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

   482

	y1 = max(y - rad, 0);

   483

   484

	assert(x1 < x2);

   485

	assert(y1 < y2);

   486

	assert(w > 0);

   487

	assert(h > 0);

   488

   489

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

   490

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

   491

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

   492

				GetProducedCargoProc *gpc;

   493

				TileIndex tile = TileXY(xc, yc);

   494

   495

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