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

typedef enum StationRectModes

    41

{

    42

	RECT_MODE_TEST = 0,

    43

	RECT_MODE_TRY,

    44

	RECT_MODE_FORCE

    45

} StationRectMode;

    46

    47

void StationRect_Init(Station *st);

    48

static bool StationRect_IsEmpty(Station *st);

    49

static bool StationRect_BeforeAddTile(Station *st, TileIndex tile, StationRectMode mode);

    50

static bool StationRect_BeforeAddRect(Station *st, TileIndex tile, int w, int h, StationRectMode mode);

    51

static bool StationRect_AfterRemoveTile(Station *st, TileIndex tile);

    52

static bool StationRect_AfterRemoveRect(Station *st, TileIndex tile, int w, int h);

    53

    54

    55

/**

    56

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

    57

 */

    58

static void StationPoolNewBlock(uint start_item)

    59

{

    60

	Station *st;

    61

    62

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

    63

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

    64

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

    65

}

    66

    67

static void StationPoolCleanBlock(uint start_item, uint end_item)

    68

{

    69

	uint i;

    70

    71

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

    72

		Station *st = GetStation(i);

    73

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

    74

	}

    75

}

    76

    77

/**

    78

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

    79

 */

    80

static void RoadStopPoolNewBlock(uint start_item)

    81

{

    82

	RoadStop *rs;

    83

    84

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

    85

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

    86

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

    87

}

    88

    89

DEFINE_OLD_POOL(Station, Station, StationPoolNewBlock, StationPoolCleanBlock)

    90

DEFINE_OLD_POOL(RoadStop, RoadStop, RoadStopPoolNewBlock, NULL)

    91

    92

    93

extern void UpdateAirplanesOnNewStation(Station *st);

    94

    95

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

    96

{

    97

	road_stop->xy = tile;

    98

	road_stop->used = true;

    99

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

   100

	road_stop->next = NULL;

   101

	road_stop->prev = previous;

   102

	road_stop->station = index;

   103

	road_stop->num_vehicles = 0;

   104

}

   105

   106

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

   107

{

   108

	switch (type) {

   109

		case RS_BUS:   return st->bus_stops;

   110

		case RS_TRUCK: return st->truck_stops;

   111

		default: NOT_REACHED();

   112

	}

   113

   114

	return NULL;

   115

}

   116

   117

RoadStop* GetRoadStopByTile(TileIndex tile, RoadStopType type)

   118

{

   119

	const Station* st = GetStationByTile(tile);

   120

	RoadStop* rs;

   121

   122

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

   123

		assert(rs->next != NULL);

   124

	}

   125

   126

	return rs;

   127

}

   128

   129

uint GetNumRoadStopsInStation(const Station* st, RoadStopType type)

   130

{

   131

	uint num = 0;

   132

	const RoadStop *rs;

   133

   134

	assert(st != NULL);

   135

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

   136

   137

	return num;

   138

}

   139

   140

RoadStop *AllocateRoadStop(void)

   141

{

   142

	RoadStop *rs;

   143

   144

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

   145

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

   146

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

   147

		if (!IsValidRoadStop(rs)) {

   148

			RoadStopID index = rs->index;

   149

   150

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

   151

			rs->index = index;

   152

   153

			return rs;

   154

		}

   155

	}

   156

   157

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

   158

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

   159

   160

	return NULL;

   161

}

   162

   163

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

   164

 *  radius that is available within the station */

   165

static uint FindCatchmentRadius(const Station* st)

   166

{

   167

	CatchmentAera ret = CA_NONE;

   168

   169

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

   170

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

   171

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

   172

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

   173

   174

	if (st->airport_tile) {

   175

		switch (st->airport_type) {

   176

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

   177

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

   178

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

   179

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

   180

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

   181

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

   182

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

   183

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

   184

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

   185

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

   186

		}

   187

	}

   188

   189

	return ret;

   190

}

   191

   192

#define CHECK_STATIONS_ERR ((Station*)-1)

   193

   194

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

   195

{

   196

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

   197

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

   198

		if (IsTileType(tile_cur, MP_STATION)) {

   199

			StationID t = GetStationIndex(tile_cur);

   200

			{

   201

				Station *st = GetStation(t);

   202

				// you cannot take control of an oilrig!!

   203

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

   204

					continue;

   205

			}

   206

   207

			if (closest_station == INVALID_STATION) {

   208

				closest_station = t;

   209

			} else if (closest_station != t) {

   210

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   211

				return CHECK_STATIONS_ERR;

   212

			}

   213

		}

   214

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

   215

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

   216

}

   217

   218

static Station *AllocateStation(void)

   219

{

   220

	Station *st = NULL;

   221

   222

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

   223

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

   224

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

   225

		if (!IsValidStation(st)) {

   226

			StationID index = st->index;

   227

   228

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

   229

			st->index = index;

   230

			return st;

   231

		}

   232

	}

   233

   234

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

   235

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

   236

   237

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   238

	return NULL;

   239

}

   240

   241

   242

/**

   243

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

   244

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

   245

 * @param type the type of tile searched for

   246

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

   247

 *                 in all other cases this parameter is ignored

   248

 * @result the noumber of matching tiles around

   249

 */

   250

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

   251

{

   252

	TileIndex cur_tile;

   253

	int dx, dy;

   254

	int num = 0;

   255

   256

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

   257

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

   258

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

   259

   260

			if (IsTileType(cur_tile, type)) {

   261

				switch (type) {

   262

					case MP_INDUSTRY:

   263

						if (GetIndustryType(cur_tile) == industry)

   264

							num++;

   265

						break;

   266

   267

					case MP_WATER:

   268

						if (!IsWater(cur_tile))

   269

							break;

   270

						/* FALL THROUGH WHEN WATER TILE */

   271

					case MP_TREES:

   272

						num++;

   273

						break;

   274

   275

					default:

   276

						break;

   277

				}

   278

			}

   279

		}

   280

	}

   281

   282

	return num;

   283

}

   284

   285

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

   286

   287

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

   288

{

   289

	static const uint32 _gen_station_name_bits[] = {

   290

		0,                                      /* 0 */

   291

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

   292

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

   293

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

   294

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

   295

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

   296

	};

   297

   298

	Town *t = st->town;

   299

	uint32 free_names = (uint32)-1;

   300

	int found;

   301

	uint z,z2;

   302

	unsigned long tmp;

   303

   304

	{

   305

		Station *s;

   306

   307

		FOR_ALL_STATIONS(s) {

   308

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

   309

				uint str = M(s->string_id);

   310

				if (str <= 0x20) {

   311

					if (str == M(STR_SV_STNAME_FOREST))

   312

						str = M(STR_SV_STNAME_WOODS);

   313

					CLRBIT(free_names, str);

   314

				}

   315

			}

   316

		}

   317

	}

   318

   319

	/* check default names */

   320

	tmp = free_names & _gen_station_name_bits[flag];

   321

	if (tmp != 0) {

   322

		found = FindFirstBit(tmp);

   323

		goto done;

   324

	}

   325

   326

	/* check mine? */

   327

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

   328

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

   329

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

   330

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

   331

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

   332

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

   333

			found = M(STR_SV_STNAME_MINES);

   334

			goto done;

   335

		}

   336

	}

   337

   338

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

   339

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

   340

		found = M(STR_SV_STNAME);

   341

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

   342

   343

		found = M(STR_SV_STNAME_CENTRAL);

   344

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

   345

	}

   346

   347

	/* Check lakeside */

   348

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

   349

			DistanceFromEdge(tile) < 20 &&

   350

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

   351

		found = M(STR_SV_STNAME_LAKESIDE);

   352

		goto done;

   353

	}

   354

   355

	/* Check woods */

   356

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

   357

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

   358

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

   359

			) {

   360

		found = _opt.landscape == LT_DESERT ?

   361

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   362

		goto done;

   363

	}

   364

   365

	/* check elevation compared to town */

   366

	z = GetTileZ(tile);

   367

	z2 = GetTileZ(t->xy);

   368

	if (z < z2) {

   369

		found = M(STR_SV_STNAME_VALLEY);

   370

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

   371

	} else if (z > z2) {

   372

		found = M(STR_SV_STNAME_HEIGHTS);

   373

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

   374

	}

   375

   376

	/* check direction compared to town */

   377

	{

   378

		static const int8 _direction_and_table[] = {

   379

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

   380

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

   381

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

   382

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

   383

		};

   384

   385

		free_names &= _direction_and_table[

   386

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

   387

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

   388

	}

   389

   390

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

   391

	if (tmp == 0) {

   392

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   393

		return false;

   394

	}

   395

	found = FindFirstBit(tmp);

   396

   397

done:

   398

	st->string_id = found + STR_SV_STNAME;

   399

	return true;

   400

}

   401

#undef M

   402

   403

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

   404

{

   405

	Station* best_station = NULL;

   406

	Station* st;

   407

   408

	FOR_ALL_STATIONS(st) {

   409

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

   410

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

   411

   412

			if (cur_dist < threshold) {

   413

				threshold = cur_dist;

   414

				best_station = st;

   415

			}

   416

		}

   417

	}

   418

   419

	return best_station;

   420

}

   421

   422

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

   423

// st = Station to update for.

   424

static void UpdateStationVirtCoord(Station *st)

   425

{

   426

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

   427

   428

	pt.y -= 32;

   429

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

   430

   431

	SetDParam(0, st->index);

   432

	SetDParam(1, st->facilities);

   433

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

   434

}

   435

   436

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

   437

void UpdateAllStationVirtCoord(void)

   438

{

   439

	Station* st;

   440

   441

	FOR_ALL_STATIONS(st) {

   442

		UpdateStationVirtCoord(st);

   443

	}

   444

}

   445

   446

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

   447

static void UpdateStationVirtCoordDirty(Station *st)

   448

{

   449

	st->MarkDirty();

   450

	UpdateStationVirtCoord(st);

   451

	st->MarkDirty();

   452

}

   453

   454

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

   455

static uint GetAcceptanceMask(const Station *st)

   456

{

   457

	uint mask = 0;

   458

	uint i;

   459

   460

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

   461

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

   462

	}

   463

	return mask;

   464

}

   465

   466

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

   467

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

   468

static void ShowRejectOrAcceptNews(const Station *st, uint32 items, StringID msg)

   469

{

   470

	if (items) {

   471

		SetDParam(2, GB(items, 16, 16));

   472

		SetDParam(1, GB(items,  0, 16));

   473

		SetDParam(0, st->index);

   474

		AddNewsItem(msg + (GB(items, 16, 16) ? 1 : 0), NEWS_FLAGS(NM_SMALL, NF_VIEWPORT|NF_TILE, NT_ACCEPTANCE, 0), st->xy, 0);

   475

	}

   476

}

   477

   478

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

   479

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile,

   480

	int w, int h, int rad)

   481

{

   482

	int x,y;

   483

	int x1,y1,x2,y2;

   484

	int xc,yc;

   485

   486

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

   487

   488

	x = TileX(tile);

   489

	y = TileY(tile);

   490

   491

	// expand the region by rad tiles on each side

   492

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

   493

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

   494

	x1 = max(x - rad, 0);

   495