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 void MarkStationDirty(const Station* st)

    89

{

    90

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

    91

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

    92

    93

		MarkAllViewportsDirty(

    94

			st->sign.left - 6,

    95

			st->sign.top,

    96

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

    97

			st->sign.top + 48);

    98

	}

    99

}

   100

   101

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

   102

{

   103

	road_stop->xy = tile;

   104

	road_stop->used = true;

   105

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

   106

	road_stop->next = NULL;

   107

	road_stop->prev = previous;

   108

	road_stop->station = index;

   109

	road_stop->num_vehicles = 0;

   110

}

   111

   112

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

   113

{

   114

	switch (type) {

   115

		case RS_BUS:   return st->bus_stops;

   116

		case RS_TRUCK: return st->truck_stops;

   117

		default: NOT_REACHED();

   118

	}

   119

   120

	return NULL;

   121

}

   122

   123

RoadStop* GetRoadStopByTile(TileIndex tile, RoadStopType type)

   124

{

   125

	const Station* st = GetStationByTile(tile);

   126

	RoadStop* rs;

   127

   128

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

   129

		assert(rs->next != NULL);

   130

	}

   131

   132

	return rs;

   133

}

   134

   135

uint GetNumRoadStopsInStation(const Station* st, RoadStopType type)

   136

{

   137

	uint num = 0;

   138

	const RoadStop *rs;

   139

   140

	assert(st != NULL);

   141

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

   142

   143

	return num;

   144

}

   145

   146

RoadStop *AllocateRoadStop(void)

   147

{

   148

	RoadStop *rs;

   149

   150

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

   151

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

   152

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

   153

		if (!IsValidRoadStop(rs)) {

   154

			RoadStopID index = rs->index;

   155

   156

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

   157

			rs->index = index;

   158

   159

			return rs;

   160

		}

   161

	}

   162

   163

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

   164

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

   165

   166

	return NULL;

   167

}

   168

   169

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

   170

 *  radius that is available within the station */

   171

static uint FindCatchmentRadius(const Station* st)

   172

{

   173

	uint ret = 0;

   174

   175

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

   176

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

   177

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

   178

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

   179

   180

	if (st->airport_tile) {

   181

		switch (st->airport_type) {

   182

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

   183

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

   184

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

   185

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

   186

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

   187

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

   188

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

   189

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

   190

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

   191

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

   192

		}

   193

	}

   194

   195

	return ret;

   196

}

   197

   198

#define CHECK_STATIONS_ERR ((Station*)-1)

   199

   200

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

   201

{

   202

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

   203

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

   204

		if (IsTileType(tile_cur, MP_STATION)) {

   205

			StationID t = GetStationIndex(tile_cur);

   206

			{

   207

				Station *st = GetStation(t);

   208

				// you cannot take control of an oilrig!!

   209

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

   210

					continue;

   211

			}

   212

   213

			if (closest_station == INVALID_STATION) {

   214

				closest_station = t;

   215

			} else if (closest_station != t) {

   216

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   217

				return CHECK_STATIONS_ERR;

   218

			}

   219

		}

   220

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

   221

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

   222

}

   223

   224

   225

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

   226

{

   227

	StationID station_index = st->index;

   228

	uint i;

   229

	uint x1 = TileX(tile);

   230

	uint y1 = TileY(tile);

   231

	uint x2 = x1 + w - 1;

   232

	uint y2 = y1 + h - 1;

   233

	uint t;

   234

   235

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

   236

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

   237

			t = TileX(i);

   238

			if (t < x1) x1 = t;

   239

			if (t > x2) x2 = t;

   240

   241

			t = TileY(i);

   242

			if (t < y1) y1 = t;

   243

			if (t > y2) y2 = t;

   244

		}

   245

	}

   246

   247

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

   248

		_error_message = STR_306C_STATION_TOO_SPREAD_OUT;

   249

		return false;

   250

	}

   251

   252

	return true;

   253

}

   254

   255

static Station *AllocateStation(void)

   256

{

   257

	Station *st = NULL;

   258

   259

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

   260

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

   261

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

   262

		if (!IsValidStation(st)) {

   263

			StationID index = st->index;

   264

   265

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

   266

			st->index = index;

   267

   268

			return st;

   269

		}

   270

	}

   271

   272

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

   273

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

   274

   275

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   276

	return NULL;

   277

}

   278

   279

   280

/**

   281

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

   282

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

   283

 * @param type the type of tile searched for

   284

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

   285

 *                 in all other cases this parameter is ignored

   286

 * @result the noumber of matching tiles around

   287

 */

   288

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

   289

{

   290

	TileIndex cur_tile;

   291

	int dx, dy;

   292

	int num = 0;

   293

   294

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

   295

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

   296

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

   297

   298

			if (IsTileType(cur_tile, type)) {

   299

				switch (type) {

   300

					case MP_INDUSTRY:

   301

						if (GetIndustryType(cur_tile) == industry)

   302

							num++;

   303

						break;

   304

   305

					case MP_WATER:

   306

						if (!IsWater(cur_tile))

   307

							break;

   308

						/* FALL THROUGH WHEN WATER TILE */

   309

					case MP_TREES:

   310

						num++;

   311

						break;

   312

   313

					default:

   314

						break;

   315

				}

   316

			}

   317

		}

   318

	}

   319

   320

	return num;

   321

}

   322

   323

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

   324

   325

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

   326

{

   327

	static const uint32 _gen_station_name_bits[] = {

   328

		0,                                      /* 0 */

   329

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

   330

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

   331

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

   332

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

   333

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

   334

	};

   335

   336

	Town *t = st->town;

   337

	uint32 free_names = (uint32)-1;

   338

	int found;

   339

	uint z,z2;

   340

	unsigned long tmp;

   341

   342

	{

   343

		Station *s;

   344

   345

		FOR_ALL_STATIONS(s) {

   346

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

   347

				uint str = M(s->string_id);

   348

				if (str <= 0x20) {

   349

					if (str == M(STR_SV_STNAME_FOREST))

   350

						str = M(STR_SV_STNAME_WOODS);

   351

					CLRBIT(free_names, str);

   352

				}

   353

			}

   354

		}

   355

	}

   356

   357

	/* check default names */

   358

	tmp = free_names & _gen_station_name_bits[flag];

   359

	if (tmp != 0) {

   360

		found = FindFirstBit(tmp);

   361

		goto done;

   362

	}

   363

   364

	/* check mine? */

   365

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

   366

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

   367

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

   368

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

   369

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

   370

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

   371

			found = M(STR_SV_STNAME_MINES);

   372

			goto done;

   373

		}

   374

	}

   375

   376

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

   377

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

   378

		found = M(STR_SV_STNAME);

   379

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

   380

   381

		found = M(STR_SV_STNAME_CENTRAL);

   382

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

   383

	}

   384

   385

	/* Check lakeside */

   386

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

   387

			DistanceFromEdge(tile) < 20 &&

   388

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

   389

		found = M(STR_SV_STNAME_LAKESIDE);

   390

		goto done;

   391

	}

   392

   393

	/* Check woods */

   394

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

   395

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

   396

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

   397

			) {

   398

		found = _opt.landscape == LT_DESERT ?

   399

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   400

		goto done;

   401

	}

   402

   403

	/* check elevation compared to town */

   404

	z = GetTileZ(tile);

   405

	z2 = GetTileZ(t->xy);

   406

	if (z < z2) {

   407

		found = M(STR_SV_STNAME_VALLEY);

   408

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

   409

	} else if (z > z2) {

   410

		found = M(STR_SV_STNAME_HEIGHTS);

   411

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

   412

	}

   413

   414

	/* check direction compared to town */

   415

	{

   416

		static const int8 _direction_and_table[] = {

   417

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

   418

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

   419

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

   420

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

   421

		};

   422

   423

		free_names &= _direction_and_table[

   424

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

   425

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

   426

	}

   427

   428

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

   429

	if (tmp == 0) {

   430

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   431

		return false;

   432

	}

   433

	found = FindFirstBit(tmp);

   434

   435

done:

   436

	st->string_id = found + STR_SV_STNAME;

   437

	return true;

   438

}

   439

#undef M

   440

   441

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

   442

{

   443

	Station* best_station = NULL;

   444

	Station* st;

   445

   446

	FOR_ALL_STATIONS(st) {

   448

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

   449

   450

			if (cur_dist < threshold) {

   451

				threshold = cur_dist;

   452

				best_station = st;

   453

			}

   454

		}

   455

	}

   456

   457

	return best_station;

   458

}

   459

   460

static void StationInitialize(Station *st, TileIndex tile)

   461

{

   462

	GoodsEntry *ge;

   463

   464

	st->xy = tile;

   465

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

   466

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

   467

	st->had_vehicle_of_type = 0;

   468

	st->time_since_load = 255;

   469

	st->time_since_unload = 255;

   470

	st->delete_ctr = 0;

   471

	st->facilities = 0;

   472

   473

	st->last_vehicle_type = VEH_Invalid;

   474

   475

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

   476

		ge->waiting_acceptance = 0;

   477

		ge->days_since_pickup = 0;

   478

		ge->enroute_from = INVALID_STATION;

   479

		ge->rating = 175;

   480

		ge->last_speed = 0;

   481

		ge->last_age = 0xFF;

   482

		ge->feeder_profit = 0;

   483

	}

   484

   485

	st->random_bits = Random();

   486

	st->waiting_triggers = 0;

   487

   488

}

   489

   490

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

   491

// st = Station to update for.

   492

static void UpdateStationVirtCoord(Station *st)

   493

{

   494

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

   495

   496

	pt.y -= 32;

   497

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