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 roadstops: 64000 (32 * 2000) */

    38

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

    39

	ROADSTOP_POOL_MAX_BLOCKS      = 2000,

    40

};

    41

    42

/**

    43

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

    44

 */

    45

static void StationPoolNewBlock(uint start_item)

    46

{

    47

	Station *st;

    48

    49

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

    50

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

    51

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

    52

}

    53

    54

static void StationPoolCleanBlock(uint start_item, uint end_item)

    55

{

    56

	uint i;

    57

    58

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

    59

		Station *st = GetStation(i);

    60

		free(st->speclist);

    61

		st->speclist = NULL;

    62

	}

    63

}

    64

    65

/**

    66

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

    67

 */

    68

static void RoadStopPoolNewBlock(uint start_item)

    69

{

    70

	RoadStop *rs;

    71

    72

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

    73

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

    75

}

    76

    77

DEFINE_POOL(Station, Station, StationPoolNewBlock, StationPoolCleanBlock)

    79

    80

    81

extern void UpdateAirplanesOnNewStation(Station *st);

    82

    83

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

    84

{

    85

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

    86

}

    87

    88

static void MarkStationTilesDirty(const Station *st)

    89

{

    90

	TileIndex tile = st->train_tile;

    91

	int w, h;

    92

    93

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

    94

	if (tile == 0) return;

    95

    96

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

    97

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

    98

			if (TileBelongsToRailStation(st, tile)) {

    99

				MarkTileDirtyByTile(tile);

   100

			}

   101

			tile += TileDiffXY(1, 0);

   102

		}

   103

		tile += TileDiffXY(-w, 1);

   104

	}

   105

}

   106

   107

static void MarkStationDirty(const Station* st)

   108

{

   109

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

   110

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

   111

   112

		MarkAllViewportsDirty(

   113

			st->sign.left - 6,

   114

			st->sign.top,

   115

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

   116

			st->sign.top + 48);

   117

	}

   118

}

   119

   120

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

   121

{

   122

	road_stop->xy = tile;

   123

	road_stop->used = true;

   124

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

   125

	road_stop->next = NULL;

   126

	road_stop->prev = previous;

   127

	road_stop->station = index;

   128

	road_stop->num_vehicles = 0;

   129

}

   130

   131

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

   132

{

   133

	switch (type) {

   134

		case RS_BUS:   return st->bus_stops;

   135

		case RS_TRUCK: return st->truck_stops;

   136

		default: NOT_REACHED();

   137

	}

   138

   139

	return NULL;

   140

}

   141

   142

RoadStop* GetRoadStopByTile(TileIndex tile, RoadStopType type)

   143

{

   144

	const Station* st = GetStationByTile(tile);

   145

	RoadStop* rs;

   146

   147

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

   148

		assert(rs->next != NULL);

   149

	}

   150

   151

	return rs;

   152

}

   153

   154

uint GetNumRoadStopsInStation(const Station* st, RoadStopType type)

   155

{

   156

	uint num = 0;

   157

	const RoadStop *rs;

   158

   159

	assert(st != NULL);

   160

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

   161

   162

	return num;

   163

}

   164

   165

RoadStop *AllocateRoadStop(void)

   166

{

   167

	RoadStop *rs;

   168

   169

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

   170

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

   172

		if (!IsValidRoadStop(rs)) {

   173

			RoadStopID index = rs->index;

   174

   175

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

   176

			rs->index = index;

   177

   178

			return rs;

   179

		}

   180

	}

   181

   182

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

   184

   185

	return NULL;

   186

}

   187

   188

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

   189

 *  radius that is available within the station */

   190

static uint FindCatchmentRadius(const Station* st)

   191

{

   192

	uint ret = 0;

   193

   194

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

   195

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

   196

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

   197

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

   198

   199

	if (st->airport_tile) {

   200

		switch (st->airport_type) {

   201

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

   202

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

   203

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

   204

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

   205

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

   206

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

   207

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

   208

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

   209

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

   210

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

   211

		}

   212

	}

   213

   214

	return ret;

   215

}

   216

   217

#define CHECK_STATIONS_ERR ((Station*)-1)

   218

   219

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

   220

{

   221

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

   222

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

   223

		if (IsTileType(tile_cur, MP_STATION)) {

   224

			StationID t = GetStationIndex(tile_cur);

   225

			{

   226

				Station *st = GetStation(t);

   227

				// you cannot take control of an oilrig!!

   228

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

   229

					continue;

   230

			}

   231

   232

			if (closest_station == INVALID_STATION) {

   233

				closest_station = t;

   234

			} else if (closest_station != t) {

   235

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   236

				return CHECK_STATIONS_ERR;

   237

			}

   238

		}

   239

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

   240

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

   241

}

   242

   243

   244

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

   245

{

   246

	StationID station_index = st->index;

   247

	uint i;

   248

	uint x1 = TileX(tile);

   249

	uint y1 = TileY(tile);

   250

	uint x2 = x1 + w - 1;

   251

	uint y2 = y1 + h - 1;

   252

	uint t;

   253

   254

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

   255

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

   256

			t = TileX(i);

   257

			if (t < x1) x1 = t;

   258

			if (t > x2) x2 = t;

   259

   260

			t = TileY(i);

   261

			if (t < y1) y1 = t;

   262

			if (t > y2) y2 = t;

   263

		}

   264

	}

   265

   266

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

   267

		_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   268

		return false;

   269

	}

   270

   271

	return true;

   272

}

   273

   274

static Station *AllocateStation(void)

   275

{

   276

	Station *st = NULL;

   277

   278

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

   279

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

   280

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

   281

		if (!IsValidStation(st)) {

   282

			StationID index = st->index;

   283

   284

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

   285

			st->index = index;

   286

   287

			return st;

   288

		}

   289

	}

   290

   291

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

   292

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

   293

   294

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   295

	return NULL;

   296

}

   297

   298

   299

/**

   300

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

   301

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

   302

 * @param type the type of tile searched for

   303

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

   304

 *                 in all other cases this parameter is ignored

   305

 * @result the noumber of matching tiles around

   306

 */

   307

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

   308

{

   309

	TileIndex cur_tile;

   310

	int dx, dy;

   311

	int num = 0;

   312

   313

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

   314

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

   315

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

   316

   317

			if (IsTileType(cur_tile, type)) {

   318

				switch (type) {

   319

					case MP_INDUSTRY:

   320

						if (GetIndustryType(cur_tile) == industry)

   321

							num++;

   322

						break;

   323

   324

					case MP_WATER:

   325

						if (!IsWater(cur_tile))

   326

							break;

   327

						/* FALL THROUGH WHEN WATER TILE */

   328

					case MP_TREES:

   329

						num++;

   330

						break;

   331

   332

					default:

   333

						break;

   334

				}

   335

			}

   336

		}

   337

	}

   338

   339

	return num;

   340

}

   341

   342

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

   343

   344

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

   345

{

   346

	static const uint32 _gen_station_name_bits[] = {

   347

		0,                                      /* 0 */

   348

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

   349

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

   350

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

   351

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

   352

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

   353

	};

   354

   355

	Town *t = st->town;

   356

	uint32 free_names = (uint32)-1;

   357

	int found;

   358

	uint z,z2;

   359

	unsigned long tmp;

   360

   361

	{

   362

		Station *s;

   363

   364

		FOR_ALL_STATIONS(s) {

   365

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

   366

				uint str = M(s->string_id);

   367

				if (str <= 0x20) {

   368

					if (str == M(STR_SV_STNAME_FOREST))

   369

						str = M(STR_SV_STNAME_WOODS);

   370

					CLRBIT(free_names, str);

   371

				}

   372

			}

   373

		}

   374

	}

   375

   376

	/* check default names */

   377

	tmp = free_names & _gen_station_name_bits[flag];

   378

	if (tmp != 0) {

   379

		found = FindFirstBit(tmp);

   380

		goto done;

   381

	}

   382

   383

	/* check mine? */

   384

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

   385

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

   386

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

   387

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

   388

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

   389

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

   390

			found = M(STR_SV_STNAME_MINES);

   391

			goto done;

   392

		}

   393

	}

   394

   395

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

   396

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

   397

		found = M(STR_SV_STNAME);

   398

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

   399

   400

		found = M(STR_SV_STNAME_CENTRAL);

   401

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

   402

	}

   403

   404

	/* Check lakeside */

   405

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

   406

			DistanceFromEdge(tile) < 20 &&

   407

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

   408

		found = M(STR_SV_STNAME_LAKESIDE);

   409

		goto done;

   410

	}

   411

   412

	/* Check woods */

   413

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

   414

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

   415

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

   416

			) {

   417

		found = _opt.landscape == LT_DESERT ?

   418

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   419

		goto done;

   420

	}

   421

   422

	/* check elevation compared to town */

   423

	z = GetTileZ(tile);

   424

	z2 = GetTileZ(t->xy);

   425

	if (z < z2) {

   426

		found = M(STR_SV_STNAME_VALLEY);

   427

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

   428

	} else if (z > z2) {

   429

		found = M(STR_SV_STNAME_HEIGHTS);

   430

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

   431

	}

   432

   433

	/* check direction compared to town */

   434

	{

   435

		static const int8 _direction_and_table[] = {

   436

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

   437

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

   438

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

   439

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

   440

		};

   441

   442

		free_names &= _direction_and_table[

   443

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

   444

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

   445

	}

   446

   447

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

   448

	if (tmp == 0) {

   449

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   450

		return false;

   451

	}

   452

	found = FindFirstBit(tmp);

   453

   454

done:

   455

	st->string_id = found + STR_SV_STNAME;

   456

	return true;

   457

}

   458

#undef M

   459

   460

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

   461

{

   462

	Station* best_station = NULL;

   463

	Station* st;

   464

   465

	FOR_ALL_STATIONS(st) {

   466

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

   467

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

   468

   469

			if (cur_dist < threshold) {

   470

				threshold = cur_dist;

   471

				best_station = st;

   472

			}

   473

		}

   474

	}

   475

   476

	return best_station;

   477

}

   478

   479

static void StationInitialize(Station *st, TileIndex tile)

   480

{

   481

	GoodsEntry *ge;

   482

   483

	st->xy = tile;

   484

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

   485

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

   486

	st->had_vehicle_of_type = 0;

   487

	st->time_since_load = 255;

   488

	st->time_since_unload = 255;

   489

	st->delete_ctr = 0;

   490

	st->facilities = 0;

   491

   492

	st->last_vehicle_type = VEH_Invalid;

   493

   494

	for (ge = st->goods; ge != endof(st->goods); ge++) {

   495

		ge->waiting_acceptance = 0;

   496

		ge->days_since_pickup = 0;