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"

    37

    38

typedef enum StationRectModes

    39

{

    40

	RECT_MODE_TEST = 0,

    41

	RECT_MODE_TRY,

    42

	RECT_MODE_FORCE

    43

} StationRectMode;

    44

    45

static void StationRect_Init(Station *st);

    46

static bool StationRect_IsEmpty(Station *st);

    47

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

    48

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

    49

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

    50

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

    51

    52

    53

/**

    54

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

    55

 */

    56

static void StationPoolNewBlock(uint start_item)

    57

{

    58

	Station *st;

    59

    60

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

    61

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

    62

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

    63

}

    64

    65

static void StationPoolCleanBlock(uint start_item, uint end_item)

    66

{

    67

	uint i;

    68

    69

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

    70

		Station *st = GetStation(i);

    71

		free(st->speclist);

    72

		st->speclist = NULL;

    73

	}

    74

}

    75

    76

/**

    77

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

    78

 */

    79

static void RoadStopPoolNewBlock(uint start_item)

    80

{

    81

	RoadStop *rs;

    82

    83

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

    84

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

    85

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

    86

}

    87

    88

DEFINE_OLD_POOL(Station, Station, StationPoolNewBlock, StationPoolCleanBlock)

    89

DEFINE_OLD_POOL(RoadStop, RoadStop, RoadStopPoolNewBlock, NULL)

    90

    91

    92

extern void UpdateAirplanesOnNewStation(Station *st);

    93

    94

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

    95

{

    96

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

    97

}

    98

    99

void MarkStationTilesDirty(const Station *st)

   100

{

   101

	TileIndex tile = st->train_tile;

   102

	int w, h;

   103

   104

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

   105

	if (tile == 0) return;

   106

   107

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

   108

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

   109

			if (TileBelongsToRailStation(st, tile)) {

   110

				MarkTileDirtyByTile(tile);

   111

			}

   112

			tile += TileDiffXY(1, 0);

   113

		}

   114

		tile += TileDiffXY(-w, 1);

   115

	}

   116

}

   117

   118

static void MarkStationDirty(const Station* st)

   119

{

   120

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

   121

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

   122

   123

		MarkAllViewportsDirty(

   124

			st->sign.left - 6,

   125

			st->sign.top,

   126

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

   127

			st->sign.top + 48);

   128

	}

   129

}

   130

   131

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

   132

{

   133

	road_stop->xy = tile;

   134

	road_stop->used = true;

   135

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

   136

	road_stop->next = NULL;

   137

	road_stop->prev = previous;

   138

	road_stop->station = index;

   139

	road_stop->num_vehicles = 0;

   140

}

   141

   142

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

   143

{

   144

	switch (type) {

   145

		case RS_BUS:   return st->bus_stops;

   146

		case RS_TRUCK: return st->truck_stops;

   147

		default: NOT_REACHED();

   148

	}

   149

   150

	return NULL;

   151

}

   152

   153

RoadStop* GetRoadStopByTile(TileIndex tile, RoadStopType type)

   154

{

   155

	const Station* st = GetStationByTile(tile);

   156

	RoadStop* rs;

   157

   158

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

   159

		assert(rs->next != NULL);

   160

	}

   161

   162

	return rs;

   163

}

   164

   165

uint GetNumRoadStopsInStation(const Station* st, RoadStopType type)

   166

{

   167

	uint num = 0;

   168

	const RoadStop *rs;

   169

   170

	assert(st != NULL);

   171

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

   172

   173

	return num;

   174

}

   175

   176

RoadStop *AllocateRoadStop(void)

   177

{

   178

	RoadStop *rs;

   179

   180

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

   181

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

   182

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

   183

		if (!IsValidRoadStop(rs)) {

   184

			RoadStopID index = rs->index;

   185

   186

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

   187

			rs->index = index;

   188

   189

			return rs;

   190

		}

   191

	}

   192

   193

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

   194

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

   195

   196

	return NULL;

   197

}

   198

   199

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

   200

 *  radius that is available within the station */

   201

static uint FindCatchmentRadius(const Station* st)

   202

{

   203

	uint ret = 0;

   204

   205

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

   206

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

   207

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

   208

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

   209

   210

	if (st->airport_tile) {

   211

		switch (st->airport_type) {

   212

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

   213

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

   214

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

   215

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

   216

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

   217

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

   218

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

   219

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

   220

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

   221

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

   222

		}

   223

	}

   224

   225

	return ret;

   226

}

   227

   228

#define CHECK_STATIONS_ERR ((Station*)-1)

   229

   230

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

   231

{

   232

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

   233

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

   234

		if (IsTileType(tile_cur, MP_STATION)) {

   235

			StationID t = GetStationIndex(tile_cur);

   236

			{

   237

				Station *st = GetStation(t);

   238

				// you cannot take control of an oilrig!!

   239

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

   240

					continue;

   241

			}

   242

   243

			if (closest_station == INVALID_STATION) {

   244

				closest_station = t;

   245

			} else if (closest_station != t) {

   246

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   247

				return CHECK_STATIONS_ERR;

   248

			}

   249

		}

   250

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

   251

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

   252

}

   253

   254

static Station *AllocateStation(void)

   255

{

   256

	Station *st = NULL;

   257

   258

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

   259

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

   260

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

   261

		if (!IsValidStation(st)) {

   262

			StationID index = st->index;

   263

   264

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

   265

			st->index = index;

   266

   267

			return st;

   268

		}

   269

	}

   270

   271

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

   272

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

   273

   274

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   275

	return NULL;

   276

}

   277

   278

   279

/**

   280

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

   281

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

   282

 * @param type the type of tile searched for

   283

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

   284

 *                 in all other cases this parameter is ignored

   285

 * @result the noumber of matching tiles around

   286

 */

   287

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

   288

{

   289

	TileIndex cur_tile;

   290

	int dx, dy;

   291

	int num = 0;

   292

   293

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

   294

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

   295

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

   296

   297

			if (IsTileType(cur_tile, type)) {

   298

				switch (type) {

   299

					case MP_INDUSTRY:

   300

						if (GetIndustryType(cur_tile) == industry)

   301

							num++;

   302

						break;

   303

   304

					case MP_WATER:

   305

						if (!IsWater(cur_tile))

   306

							break;

   307

						/* FALL THROUGH WHEN WATER TILE */

   308

					case MP_TREES:

   309

						num++;

   310

						break;

   311

   312

					default:

   313

						break;

   314

				}

   315

			}

   316

		}

   317

	}

   318

   319

	return num;

   320

}

   321

   322

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

   323

   324

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

   325

{

   326

	static const uint32 _gen_station_name_bits[] = {

   327

		0,                                      /* 0 */

   328

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

   329

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

   330

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

   331

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

   332

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

   333

	};

   334

   335

	Town *t = st->town;

   336

	uint32 free_names = (uint32)-1;

   337

	int found;

   338

	uint z,z2;

   339

	unsigned long tmp;

   340

   341

	{

   342

		Station *s;

   343

   344

		FOR_ALL_STATIONS(s) {

   345

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

   346

				uint str = M(s->string_id);

   347

				if (str <= 0x20) {

   348

					if (str == M(STR_SV_STNAME_FOREST))

   349

						str = M(STR_SV_STNAME_WOODS);

   350

					CLRBIT(free_names, str);

   351

				}

   352

			}

   353

		}

   354

	}

   355

   356

	/* check default names */

   357

	tmp = free_names & _gen_station_name_bits[flag];

   358

	if (tmp != 0) {

   359

		found = FindFirstBit(tmp);

   360

		goto done;

   361

	}

   362

   363

	/* check mine? */

   364

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

   365

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

   366

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

   367

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

   368

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

   369

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

   370

			found = M(STR_SV_STNAME_MINES);

   371

			goto done;

   372

		}

   373

	}

   374

   375

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

   376

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

   377

		found = M(STR_SV_STNAME);

   378

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

   379

   380

		found = M(STR_SV_STNAME_CENTRAL);

   381

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

   382

	}

   383

   384

	/* Check lakeside */

   385

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

   386

			DistanceFromEdge(tile) < 20 &&

   387

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

   388

		found = M(STR_SV_STNAME_LAKESIDE);

   389

		goto done;

   390

	}

   391

   392

	/* Check woods */

   393

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

   394

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

   395

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

   396

			) {

   397

		found = _opt.landscape == LT_DESERT ?

   398

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   399

		goto done;

   400

	}

   401

   402

	/* check elevation compared to town */

   403

	z = GetTileZ(tile);

   404

	z2 = GetTileZ(t->xy);

   405

	if (z < z2) {

   406

		found = M(STR_SV_STNAME_VALLEY);

   407

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

   408

	} else if (z > z2) {

   409

		found = M(STR_SV_STNAME_HEIGHTS);

   410

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

   411

	}

   412

   413

	/* check direction compared to town */

   414

	{

   415

		static const int8 _direction_and_table[] = {

   416

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

   417

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

   418

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

   419

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

   420

		};

   421

   422

		free_names &= _direction_and_table[

   423

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

   424

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

   425

	}

   426

   427

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

   428

	if (tmp == 0) {

   429

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   430

		return false;

   431

	}

   432

	found = FindFirstBit(tmp);

   433

   434

done:

   435

	st->string_id = found + STR_SV_STNAME;

   436

	return true;

   437

}

   438

#undef M

   439

   440

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

   441

{

   442

	Station* best_station = NULL;

   443

	Station* st;

   444

   445

	FOR_ALL_STATIONS(st) {

   446

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

   447

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

   448

   449

			if (cur_dist < threshold) {

   450

				threshold = cur_dist;

   451

				best_station = st;

   452

			}

   453

		}

   454

	}

   455

   456

	return best_station;

   457

}

   458

   459

static void StationInitialize(Station *st, TileIndex tile)

   460

{

   461

	GoodsEntry *ge;

   462

   463

	st->xy = tile;

   464

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

   465

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

   466

	st->had_vehicle_of_type = 0;

   467

	st->time_since_load = 255;

   468

	st->time_since_unload = 255;

   469

	st->delete_ctr = 0;

   470

	st->facilities = 0;

   471

   472

	st->last_vehicle_type = VEH_Invalid;

   473

   474

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

   475

		ge->waiting_acceptance = 0;

   476

		ge->days_since_pickup = 0;

   477

		ge->enroute_from = INVALID_STATION;

   478

		ge->rating = 175;

   479

		ge->last_speed = 0;

   480

		ge->last_age = 0xFF;

   481

		ge->feeder_profit = 0;

   482

	}

   483

   484

	st->random_bits = Random();

   485

	st->waiting_triggers = 0;

   486

   487

	StationRect_Init(st);

   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