1

/* $Id$ */

     2

     3

/** @file station_cmd.c */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "station_map.h"

    10

#include "table/sprites.h"

    11

#include "table/strings.h"

    12

#include "map.h"

    13

#include "tile.h"

    14

#include "station.h"

    15

#include "gfx.h"

    16

#include "window.h"

    17

#include "viewport.h"

    18

#include "command.h"

    19

#include "town.h"

    20

#include "vehicle.h"

    21

#include "news.h"

    22

#include "saveload.h"

    23

#include "economy.h"

    24

#include "player.h"

    25

#include "airport.h"

    26

#include "sprite.h"

    27

#include "depot.h"

    28

#include "train.h"

    29

#include "water_map.h"

    30

#include "industry_map.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_station.h"

    33

#include "yapf/yapf.h"

    34

#include "date.h"

    35

    36

enum {

    37

	/* Max stations: 64000 (64 * 1000) */

    38

	STATION_POOL_BLOCK_SIZE_BITS = 6,       /* In bits, so (1 << 6) == 64 */

    39

	STATION_POOL_MAX_BLOCKS      = 1000,

    40

    41

	/* Max roadstops: 64000 (32 * 2000) */

    42

	ROADSTOP_POOL_BLOCK_SIZE_BITS = 5,       /* In bits, so (1 << 5) == 32 */

    43

	ROADSTOP_POOL_MAX_BLOCKS      = 2000,

    44

};

    45

    46

/**

    47

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

    48

 */

    49

static void StationPoolNewBlock(uint start_item)

    50

{

    51

	Station *st;

    52

    53

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

    54

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

    55

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

    56

}

    57

    58

static void StationPoolCleanBlock(uint start_item, uint end_item)

    59

{

    60

	uint i;

    61

    62

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

    63

		Station *st = GetStation(i);

    64

		free(st->speclist);

    65

		st->speclist = NULL;

    66

	}

    67

}

    68

    69

/**

    70

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

    71

 */

    72

static void RoadStopPoolNewBlock(uint start_item)

    73

{

    74

	RoadStop *rs;

    75

    76

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

    77

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

    78

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

    79

}

    80

    81

/* Initialize the station-pool and roadstop-pool */

    82

MemoryPool _station_pool = { "Stations", STATION_POOL_MAX_BLOCKS, STATION_POOL_BLOCK_SIZE_BITS, sizeof(Station), &StationPoolNewBlock, &StationPoolCleanBlock, 0, 0, NULL };

    83

MemoryPool _roadstop_pool = { "RoadStop", ROADSTOP_POOL_MAX_BLOCKS, ROADSTOP_POOL_BLOCK_SIZE_BITS, sizeof(RoadStop), &RoadStopPoolNewBlock, NULL, 0, 0, NULL };

    84

    85

    86

extern void UpdateAirplanesOnNewStation(Station *st);

    87

    88

static bool TileBelongsToRailStation(const Station *st, TileIndex tile)

    89

{

    90

	return IsTileType(tile, MP_STATION) && GetStationIndex(tile) == st->index && IsRailwayStation(tile);

    91

}

    92

    93

static void MarkStationTilesDirty(const Station *st)

    94

{

    95

	TileIndex tile = st->train_tile;

    97

    98

	// XXX No station is recorded as 0, not INVALID_TILE...

    99

	if (tile == 0) return;

   100

   101

	for (h = 0; h < st->trainst_h; h++) {

   102

		for (w = 0; w < st->trainst_w; w++) {

   103

			if (TileBelongsToRailStation(st, tile)) {

   104

				MarkTileDirtyByTile(tile);

   105

			}

   106

			tile += TileDiffXY(1, 0);

   107

		}

   108

		tile += TileDiffXY(-w, 1);

   109

	}

   110

}

   111

   112

static void MarkStationDirty(const Station* st)

   113

{

   114

	if (st->sign.width_1 != 0) {

   115

		InvalidateWindowWidget(WC_STATION_VIEW, st->index, 1);

   116

   117

		MarkAllViewportsDirty(

   118

			st->sign.left - 6,

   119

			st->sign.top,

   120

			st->sign.left + (st->sign.width_1 << 2) + 12,

   121

			st->sign.top + 48);

   122

	}

   123

}

   124

   125

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

   126

{

   127

	road_stop->xy = tile;

   128

	road_stop->used = true;

   129

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

   130

	road_stop->next = NULL;

   131

	road_stop->prev = previous;

   132

	road_stop->station = index;

   133

	road_stop->num_vehicles = 0;

   134

}

   135

   136

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

   137

{

   138

	switch (type) {

   139

		case RS_BUS:   return st->bus_stops;

   140

		case RS_TRUCK: return st->truck_stops;

   141

		default: NOT_REACHED();

   142

	}

   143

   144

	return NULL;

   145

}

   146

   147

RoadStop* GetRoadStopByTile(TileIndex tile, RoadStopType type)

   148

{

   149

	const Station* st = GetStationByTile(tile);

   150

	RoadStop* rs;

   151

   152

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

   153

		assert(rs->next != NULL);

   154

	}

   155

   156

	return rs;

   157

}

   158

   159

uint GetNumRoadStopsInStation(const Station* st, RoadStopType type)

   160

{

   161

	uint num = 0;

   162

	const RoadStop *rs;

   163

   164

	assert(st != NULL);

   165

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

   166

   167

	return num;

   168

}

   169

   170

RoadStop *AllocateRoadStop(void)

   171

{

   172

	RoadStop *rs;

   173

   174

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

   175

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

   176

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

   177

		if (!IsValidRoadStop(rs)) {

   178

			RoadStopID index = rs->index;

   179

   180

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

   181

			rs->index = index;

   182

   183

			return rs;

   184

		}

   185

	}

   186

   187

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

   188

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

   189

   190

	return NULL;

   191

}

   192

   193

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

   194

 *  radius that is available within the station */

   195

static uint FindCatchmentRadius(const Station* st)

   196

{

   197

	uint ret = 0;

   198

   199

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

   200

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

   201

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

   202

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

   203

   204

	if (st->airport_tile) {

   205

		switch (st->airport_type) {

   206

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

   207

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

   208

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

   209

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

   210

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

   211

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

   212

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

   213

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

   214

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

   215

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

   216

		}

   217

	}

   218

   219

	return ret;

   220

}

   221

   222

#define CHECK_STATIONS_ERR ((Station*)-1)

   223

   224

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

   225

{

   226

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

   227

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

   228

		if (IsTileType(tile_cur, MP_STATION)) {

   229

			StationID t = GetStationIndex(tile_cur);

   230

			{

   231

				Station *st = GetStation(t);

   232

				// you cannot take control of an oilrig!!

   233

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

   234

					continue;

   235

			}

   236

   237

			if (closest_station == INVALID_STATION) {

   238

				closest_station = t;

   239

			} else if (closest_station != t) {

   240

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   241

				return CHECK_STATIONS_ERR;

   242

			}

   243

		}

   244

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

   245

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

   246

}

   247

   248

   249

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

   250

{

   251

	StationID station_index = st->index;

   252

	uint i;

   253

	uint x1 = TileX(tile);

   254

	uint y1 = TileY(tile);

   255

	uint x2 = x1 + w - 1;

   256

	uint y2 = y1 + h - 1;

   257

	uint t;

   258

   259

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

   260

		if (IsTileType(i, MP_STATION) && GetStationIndex(i) == station_index) {

   261

			t = TileX(i);

   262

			if (t < x1) x1 = t;

   263

			if (t > x2) x2 = t;

   264

   265

			t = TileY(i);

   266

			if (t < y1) y1 = t;

   267

			if (t > y2) y2 = t;

   268

		}

   269

	}

   270

   271

	if (y2 - y1 >= _patches.station_spread || x2 - x1 >= _patches.station_spread) {

   272

		_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   273

		return false;

   274

	}

   275

   276

	return true;

   277

}

   278

   279

static Station *AllocateStation(void)

   280

{

   281

	Station *st = NULL;

   282

   283

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

   284

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

   285

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

   286

		if (!IsValidStation(st)) {

   287

			StationID index = st->index;

   288

   289

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

   290

			st->index = index;

   291

   292

			return st;

   293

		}

   294

	}

   295

   296

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

   297

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

   298

   299

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   300

	return NULL;

   301

}

   302

   303

   304

/**

   305

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

   306

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

   307

 * @param type the type of tile searched for

   308

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

   309

 *                 in all other cases this parameter is ignored

   310

 * @result the noumber of matching tiles around

   311

 */

   312

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

   313

{

   314

	TileIndex cur_tile;

   315

	int dx, dy;

   316

	int num = 0;

   317

   318

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

   319

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

   320

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

   321

   322

			if (IsTileType(cur_tile, type)) {

   323

				switch (type) {

   324

					case MP_INDUSTRY:

   325

						if (GetIndustryType(cur_tile) == industry)

   326

							num++;

   327

						break;

   328

   329

					case MP_WATER:

   330

						if (!IsWater(cur_tile))

   331

							break;

   332

						/* FALL THROUGH WHEN WATER TILE */

   333

					case MP_TREES:

   334

						num++;

   335

						break;

   336

   337

					default:

   338

						break;

   339

				}

   340

			}

   341

		}

   342

	}

   343

   344

	return num;

   345

}

   346

   347

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

   348

   349

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

   350

{

   351

	static const uint32 _gen_station_name_bits[] = {

   352

		0,                                      /* 0 */

   353

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

   354

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

   355

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

   356

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

   357

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

   358

	};

   359

   360

	Town *t = st->town;

   361

	uint32 free_names = (uint32)-1;

   362

	int found;

   363

	uint z,z2;

   364

	unsigned long tmp;

   365

   366

	{

   367

		Station *s;

   368

   369

		FOR_ALL_STATIONS(s) {

   370

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

   371

				uint str = M(s->string_id);

   372

				if (str <= 0x20) {

   373

					if (str == M(STR_SV_STNAME_FOREST))

   374

						str = M(STR_SV_STNAME_WOODS);

   375

					CLRBIT(free_names, str);

   376

				}

   377

			}

   378

		}

   379

	}

   380

   381

	/* check default names */

   382

	tmp = free_names & _gen_station_name_bits[flag];

   383

	if (tmp != 0) {

   384

		found = FindFirstBit(tmp);

   385

		goto done;

   386

	}

   387

   388

	/* check mine? */

   389

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

   390

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

   391

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

   392

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

   393

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

   394

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

   395

			found = M(STR_SV_STNAME_MINES);

   396

			goto done;

   397

		}

   398

	}

   399

   400

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

   401

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

   402

		found = M(STR_SV_STNAME);

   403

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

   404

   405

		found = M(STR_SV_STNAME_CENTRAL);

   406

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

   407

	}

   408

   409

	/* Check lakeside */

   410

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

   411

			DistanceFromEdge(tile) < 20 &&

   412

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

   413

		found = M(STR_SV_STNAME_LAKESIDE);

   414

		goto done;

   415

	}

   416

   417

	/* Check woods */

   418

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

   419

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

   420

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

   421

			) {

   422

		found = _opt.landscape == LT_DESERT ?

   423

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   424

		goto done;

   425

	}

   426

   427

	/* check elevation compared to town */

   428

	z = GetTileZ(tile);

   429

	z2 = GetTileZ(t->xy);

   430

	if (z < z2) {

   431

		found = M(STR_SV_STNAME_VALLEY);

   432

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

   433

	} else if (z > z2) {

   434

		found = M(STR_SV_STNAME_HEIGHTS);

   435

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

   436

	}

   437

   438

	/* check direction compared to town */

   439

	{

   440

		static const int8 _direction_and_table[] = {

   441

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

   442

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

   443

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

   444

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

   445

		};

   446

   447

		free_names &= _direction_and_table[

   448

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

   449

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

   450

	}

   451

   452

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

   453

	if (tmp == 0) {

   454

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   455

		return false;

   456

	}

   457

	found = FindFirstBit(tmp);

   458

   459

done:

   460

	st->string_id = found + STR_SV_STNAME;

   461

	return true;

   462

}

   463

#undef M

   464

   465

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

   466

{

   467

	Station* best_station = NULL;

   468

	Station* st;

   469

   470

	FOR_ALL_STATIONS(st) {

   471

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

   472

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

   473

   474

			if (cur_dist < threshold) {

   475

				threshold = cur_dist;

   476

				best_station = st;

   477

			}

   478

		}

   479

	}

   480

   481

	return best_station;

   482

}

   483

   484

static void StationInitialize(Station *st, TileIndex tile)

   485

{

   486

	GoodsEntry *ge;

   487

   488

	st->xy = tile;

   489

	st->airport_tile = st->dock_tile = st->train_tile = 0;

   490

	st->bus_stops = st->truck_stops = NULL;

   491

	st->had_vehicle_of_type = 0;

   492

	st->time_since_load = 255;

   493

	st->time_since_unload = 255;

   494

	st->delete_ctr = 0;

   495

	st->facilities = 0;

   496

   497

	st->last_vehicle_type = VEH_Invalid;