1

/* $Id$ */

     2

     3

/** @file station_cmd.c */

     4

     5

#include "stdafx.h"

     6

#include "openttd.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

    37

/**

    38

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

    39

 */

    40

static void StationPoolNewBlock(uint start_item)

    41

{

    42

	Station *st;

    43

    44

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

    45

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

    46

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

    47

}

    48

    49

static void StationPoolCleanBlock(uint start_item, uint end_item)

    50

{

    51

	uint i;

    52

    53

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

    54

		Station *st = GetStation(i);

    55

		free(st->speclist);

    56

		st->speclist = NULL;

    57

	}

    58

}

    59

    60

/**

    61

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

    62

 */

    63

static void RoadStopPoolNewBlock(uint start_item)

    64

{

    65

	RoadStop *rs;

    66

    67

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

    68

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

    69

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

    70

}

    71

    72

DEFINE_OLD_POOL(Station, Station, StationPoolNewBlock, StationPoolCleanBlock)

    73

DEFINE_OLD_POOL(RoadStop, RoadStop, RoadStopPoolNewBlock, NULL)

    74

    75

    76

extern void UpdateAirplanesOnNewStation(Station *st);

    77

    78

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

    79

{

    80

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

    81

}

    82

    83

void MarkStationTilesDirty(const Station *st)

    84

{

    85

	TileIndex tile = st->train_tile;

    86

	int w, h;

    87

    88

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

    89

	if (tile == 0) return;

    90

    91

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

    92

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

    93

			if (TileBelongsToRailStation(st, tile)) {

    94

				MarkTileDirtyByTile(tile);

    95

			}

    96

			tile += TileDiffXY(1, 0);

    97

		}

    98

		tile += TileDiffXY(-w, 1);

    99

	}

   100

}

   101

   102

static void MarkStationDirty(const Station* st)

   103

{

   104

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

   105

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

   106

   107

		MarkAllViewportsDirty(

   108

			st->sign.left - 6,

   109

			st->sign.top,

   110

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

   111

			st->sign.top + 48);

   112

	}

   113

}

   114

   115

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

   116

{

   117

	road_stop->xy = tile;

   118

	road_stop->used = true;

   119

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

   120

	road_stop->next = NULL;

   121

	road_stop->prev = previous;

   122

	road_stop->station = index;

   123

	road_stop->num_vehicles = 0;

   124

}

   125

   126

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

   127

{

   128

	switch (type) {

   129

		case RS_BUS:   return st->bus_stops;

   130

		case RS_TRUCK: return st->truck_stops;

   131

		default: NOT_REACHED();

   132

	}

   133

   134

	return NULL;

   135

}

   136

   137

RoadStop* GetRoadStopByTile(TileIndex tile, RoadStopType type)

   138

{

   139

	const Station* st = GetStationByTile(tile);

   140

	RoadStop* rs;

   141

   142

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

   143

		assert(rs->next != NULL);

   144

	}

   145

   146

	return rs;

   147

}

   148

   149

uint GetNumRoadStopsInStation(const Station* st, RoadStopType type)

   150

{

   151

	uint num = 0;

   152

	const RoadStop *rs;

   153

   154

	assert(st != NULL);

   155

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

   156

   157

	return num;

   158

}

   159

   160

RoadStop *AllocateRoadStop(void)

   161

{

   162

	RoadStop *rs;

   163

   164

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

   165

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

   166

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

   167

		if (!IsValidRoadStop(rs)) {

   168

			RoadStopID index = rs->index;

   169

   170

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

   171

			rs->index = index;

   172

   173

			return rs;

   174

		}

   175

	}

   176

   177

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

   178

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

   179

   180

	return NULL;

   181

}

   182

   183

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

   184

 *  radius that is available within the station */

   185

static uint FindCatchmentRadius(const Station* st)

   186

{

   187

	uint ret = 0;

   188

   189

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

   190

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

   191

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

   192

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

   193

   194

	if (st->airport_tile) {

   195

		switch (st->airport_type) {

   196

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

   197

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

   198

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

   199

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

   200

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

   201

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

   202

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

   203

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

   204

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

   205

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

   206

		}

   207

	}

   208

   209

	return ret;

   210

}

   211

   212

#define CHECK_STATIONS_ERR ((Station*)-1)

   213

   214

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

   215

{

   216

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

   217

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

   218

		if (IsTileType(tile_cur, MP_STATION)) {

   219

			StationID t = GetStationIndex(tile_cur);

   220

			{

   221

				Station *st = GetStation(t);

   222

				// you cannot take control of an oilrig!!

   223

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

   224

					continue;

   225

			}

   226

   227

			if (closest_station == INVALID_STATION) {

   228

				closest_station = t;

   229

			} else if (closest_station != t) {

   230

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   231

				return CHECK_STATIONS_ERR;

   232

			}

   233

		}

   234

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

   235

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

   236

}

   237

   238

static Station *AllocateStation(void)

   239

{

   240

	Station *st = NULL;

   241

   242

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

   243

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

   244

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

   245

		if (!IsValidStation(st)) {

   246

			StationID index = st->index;

   247

   248

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

   249

			st->index = index;

   250

   251

			return st;

   252

		}

   253

	}

   254

   255

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

   256

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

   257

   258

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   259

	return NULL;

   260

}

   261

   262

   263

/**

   264

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

   265

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

   266

 * @param type the type of tile searched for

   267

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

   268

 *                 in all other cases this parameter is ignored

   269

 * @result the noumber of matching tiles around

   270

 */

   271

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

   272

{

   273

	TileIndex cur_tile;

   274

	int dx, dy;

   275

	int num = 0;

   276

   277

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

   278

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

   279

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

   280

   281

			if (IsTileType(cur_tile, type)) {

   282

				switch (type) {

   283

					case MP_INDUSTRY:

   284

						if (GetIndustryType(cur_tile) == industry)

   285

							num++;

   286

						break;

   287

   288

					case MP_WATER:

   289

						if (!IsWater(cur_tile))

   290

							break;

   291

						/* FALL THROUGH WHEN WATER TILE */

   292

					case MP_TREES:

   293

						num++;

   294

						break;

   295

   296

					default:

   297

						break;

   298

				}

   299

			}

   300

		}

   301

	}

   302

   303

	return num;

   304

}

   305

   306

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

   307

   308

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

   309

{

   310

	static const uint32 _gen_station_name_bits[] = {

   311

		0,                                      /* 0 */

   312

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

   313

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

   314

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

   315

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

   316

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

   317

	};

   318

   319

	Town *t = st->town;

   320

	uint32 free_names = (uint32)-1;

   321

	int found;

   322

	uint z,z2;

   323

	unsigned long tmp;

   324

   325

	{

   326

		Station *s;

   327

   328

		FOR_ALL_STATIONS(s) {

   329

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

   330

				uint str = M(s->string_id);

   331

				if (str <= 0x20) {

   332

					if (str == M(STR_SV_STNAME_FOREST))

   333

						str = M(STR_SV_STNAME_WOODS);

   334

					CLRBIT(free_names, str);

   335

				}

   336

			}

   337

		}

   338

	}

   339

   340

	/* check default names */

   341

	tmp = free_names & _gen_station_name_bits[flag];

   342

	if (tmp != 0) {

   343

		found = FindFirstBit(tmp);

   344

		goto done;

   345

	}

   346

   347

	/* check mine? */

   348

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

   349

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

   350

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

   351

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

   352

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

   353

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

   354

			found = M(STR_SV_STNAME_MINES);

   355

			goto done;

   356

		}

   357

	}

   358

   359

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

   360

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

   361

		found = M(STR_SV_STNAME);

   362

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

   363

   364

		found = M(STR_SV_STNAME_CENTRAL);

   365

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

   366

	}

   367

   368

	/* Check lakeside */

   369

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

   370

			DistanceFromEdge(tile) < 20 &&

   371

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

   372

		found = M(STR_SV_STNAME_LAKESIDE);

   373

		goto done;

   374

	}

   375

   376

	/* Check woods */

   377

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

   378

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

   379

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

   380

			) {

   381

		found = _opt.landscape == LT_DESERT ?

   382

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   383

		goto done;

   384

	}

   385

   386

	/* check elevation compared to town */

   387

	z = GetTileZ(tile);

   388

	z2 = GetTileZ(t->xy);

   389

	if (z < z2) {

   390

		found = M(STR_SV_STNAME_VALLEY);

   391

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

   392

	} else if (z > z2) {

   393

		found = M(STR_SV_STNAME_HEIGHTS);

   394

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

   395

	}

   396

   397

	/* check direction compared to town */

   398

	{

   399

		static const int8 _direction_and_table[] = {

   400

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

   401

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

   402

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

   403

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

   404

		};

   405

   406

		free_names &= _direction_and_table[

   407

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

   408

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

   409

	}

   410

   411

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

   412

	if (tmp == 0) {

   413

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   414

		return false;

   415

	}

   416

	found = FindFirstBit(tmp);

   417

   418

done:

   419

	st->string_id = found + STR_SV_STNAME;

   420

	return true;

   421

}

   422

#undef M

   423

   424

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

   425

{

   426

	Station* best_station = NULL;

   427

	Station* st;

   428

   429

	FOR_ALL_STATIONS(st) {

   430

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

   431

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

   432

   433

			if (cur_dist < threshold) {

   434

				threshold = cur_dist;

   435

				best_station = st;

   436

			}

   437

		}

   438

	}

   439

   440

	return best_station;

   441

}

   442

   443

static void StationInitialize(Station *st, TileIndex tile)

   444

{

   445

	GoodsEntry *ge;

   446

   447

	st->xy = tile;

   448

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

   449

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

   450

	st->had_vehicle_of_type = 0;

   451

	st->time_since_load = 255;

   452

	st->time_since_unload = 255;

   453

	st->delete_ctr = 0;

   454

	st->facilities = 0;

   455

   456

	st->last_vehicle_type = VEH_Invalid;

   457

   458

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

   459

		ge->waiting_acceptance = 0;

   460

		ge->days_since_pickup = 0;

   461

		ge->enroute_from = INVALID_STATION;

   462

		ge->rating = 175;

   463

		ge->last_speed = 0;

   464

		ge->last_age = 0xFF;

   465

		ge->feeder_profit = 0;

   466

	}

   467

   468

	st->random_bits = Random();

   469

	st->waiting_triggers = 0;

   470

   471

}

   472

   473

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

   474

// st = Station to update for.

   475

static void UpdateStationVirtCoord(Station *st)

   476

{

   477

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

   478

   479

	pt.y -= 32;

   480

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

   481

   482

	SetDParam(0, st->index);

   483

	SetDParam(1, st->facilities);

   484

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

   485

}

   486

   487

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

   488

void UpdateAllStationVirtCoord(void)

   489

{

   490

	Station* st;

   491

   492

	FOR_ALL_STATIONS(st) {

   493

		UpdateStationVirtCoord(st);

   494

	}

   495

}

   496