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"

    36

    37

typedef enum StationRectModes

    38

{

    39

	RECT_MODE_TEST = 0,

    40

	RECT_MODE_TRY,

    41

	RECT_MODE_FORCE

    42

} StationRectMode;

    43

    44

static void StationRect_Init(Station *st);

    45

static bool StationRect_IsEmpty(Station *st);

    46

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

    47

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

    48

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

    49

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

    50

    51

    52

/**

    53

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

    54

 */

    55

static void StationPoolNewBlock(uint start_item)

    56

{

    57

	Station *st;

    58

    59

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

    60

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

    61

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

    62

}

    63

    64

static void StationPoolCleanBlock(uint start_item, uint end_item)

    65

{

    66

	uint i;

    67

    68

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

    69

		Station *st = GetStation(i);

    70

		free(st->speclist);

    71

		st->speclist = NULL;

    72

	}

    73

}

    74

    75

/**

    76

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

    77

 */

    78

static void RoadStopPoolNewBlock(uint start_item)

    79

{

    80

	RoadStop *rs;

    81

    82

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

    83

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

    84

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

    85

}

    86

    87

DEFINE_OLD_POOL(Station, Station, StationPoolNewBlock, StationPoolCleanBlock)

    88

DEFINE_OLD_POOL(RoadStop, RoadStop, RoadStopPoolNewBlock, NULL)

    89

    90

    91

extern void UpdateAirplanesOnNewStation(Station *st);

    92

    93

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

    94

{

    95

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

    96

}

    97

    98

void MarkStationTilesDirty(const Station *st)

    99

{

   100

	TileIndex tile = st->train_tile;

   101

	int w, h;

   102

   103

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

   104

	if (tile == 0) return;

   105

   106

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

   107

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

   108

			if (TileBelongsToRailStation(st, tile)) {

   109

				MarkTileDirtyByTile(tile);

   110

			}

   111

			tile += TileDiffXY(1, 0);

   112

		}

   113

		tile += TileDiffXY(-w, 1);

   114

	}

   115

}

   116

   117

static void MarkStationDirty(const Station* st)

   118

{

   119

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

   120

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

   121

   122

		MarkAllViewportsDirty(

   123

			st->sign.left - 6,

   124

			st->sign.top,

   125

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

   126

			st->sign.top + 48);

   127

	}

   128

}

   129

   130

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

   131

{

   132

	road_stop->xy = tile;

   133

	road_stop->used = true;

   134

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

   135

	road_stop->next = NULL;

   136

	road_stop->prev = previous;

   137

	road_stop->station = index;

   138

	road_stop->num_vehicles = 0;

   139

}

   140

   141

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

   142

{

   143

	switch (type) {

   144

		case RS_BUS:   return st->bus_stops;

   145

		case RS_TRUCK: return st->truck_stops;

   146

		default: NOT_REACHED();

   147

	}

   148

   149

	return NULL;

   150

}

   151

   152

RoadStop* GetRoadStopByTile(TileIndex tile, RoadStopType type)

   153

{

   154

	const Station* st = GetStationByTile(tile);

   155

	RoadStop* rs;

   156

   157

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

   158

		assert(rs->next != NULL);

   159

	}

   160

   161

	return rs;

   162

}

   163

   164

uint GetNumRoadStopsInStation(const Station* st, RoadStopType type)

   165

{

   166

	uint num = 0;

   167

	const RoadStop *rs;

   168

   169

	assert(st != NULL);

   170

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

   171

   172

	return num;

   173

}

   174

   175

RoadStop *AllocateRoadStop(void)

   176

{

   177

	RoadStop *rs;

   178

   179

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

   180

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

   181

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

   182

		if (!IsValidRoadStop(rs)) {

   183

			RoadStopID index = rs->index;

   184

   185

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

   186

			rs->index = index;

   187

   188

			return rs;

   189

		}

   190

	}

   191

   192

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

   193

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

   194

   195

	return NULL;

   196

}

   197

   198

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

   199

 *  radius that is available within the station */

   200

static uint FindCatchmentRadius(const Station* st)

   201

{

   202

	uint ret = 0;

   203

   204

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

   205

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

   206

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

   207

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

   208

   209

	if (st->airport_tile) {

   210

		switch (st->airport_type) {

   211

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

   212

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

   213

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

   214

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

   215

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

   216

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

   217

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

   218

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

   219

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

   220

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

   221

		}

   222

	}

   223

   224

	return ret;

   225

}

   226

   227

#define CHECK_STATIONS_ERR ((Station*)-1)

   228

   229

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

   230

{

   231

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

   232

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

   233

		if (IsTileType(tile_cur, MP_STATION)) {

   234

			StationID t = GetStationIndex(tile_cur);

   235

			{

   236

				Station *st = GetStation(t);

   237

				// you cannot take control of an oilrig!!

   238

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

   239

					continue;

   240

			}

   241

   242

			if (closest_station == INVALID_STATION) {

   243

				closest_station = t;

   244

			} else if (closest_station != t) {

   245

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   246

				return CHECK_STATIONS_ERR;

   247

			}

   248

		}

   249

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

   250

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

   251

}

   252

   253

static Station *AllocateStation(void)

   254

{

   255

	Station *st = NULL;

   256

   257

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

   258

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

   259

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

   260

		if (!IsValidStation(st)) {

   261

			StationID index = st->index;

   262

   263

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

   264

			st->index = index;

   265

   266

			return st;

   267

		}

   268

	}

   269

   270

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

   271

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

   272

   273

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   274

	return NULL;

   275

}

   276

   277

   278

/**

   279

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

   280

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

   281

 * @param type the type of tile searched for

   282

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

   283

 *                 in all other cases this parameter is ignored

   284

 * @result the noumber of matching tiles around

   285

 */

   286

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

   287

{

   288

	TileIndex cur_tile;

   289

	int dx, dy;

   290

	int num = 0;

   291

   292

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

   293

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

   294

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

   295

   296

			if (IsTileType(cur_tile, type)) {

   297

				switch (type) {

   298

					case MP_INDUSTRY:

   299

						if (GetIndustryType(cur_tile) == industry)

   300

							num++;

   301

						break;

   302

   303

					case MP_WATER:

   304

						if (!IsWater(cur_tile))

   305

							break;

   306

						/* FALL THROUGH WHEN WATER TILE */

   307

					case MP_TREES:

   308

						num++;

   309

						break;

   310

   311

					default:

   312

						break;

   313

				}

   314

			}

   315

		}

   316

	}

   317

   318

	return num;

   319

}

   320

   321

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

   322

   323

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

   324

{

   325

	static const uint32 _gen_station_name_bits[] = {

   326

		0,                                      /* 0 */

   327

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

   328

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

   329

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

   330

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

   331

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

   332

	};

   333

   334

	Town *t = st->town;

   335

	uint32 free_names = (uint32)-1;

   336

	int found;

   337

	uint z,z2;

   338

	unsigned long tmp;

   339

   340

	{

   341

		Station *s;

   342

   343

		FOR_ALL_STATIONS(s) {

   344

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

   345

				uint str = M(s->string_id);

   346

				if (str <= 0x20) {

   347

					if (str == M(STR_SV_STNAME_FOREST))

   348

						str = M(STR_SV_STNAME_WOODS);

   349

					CLRBIT(free_names, str);

   350

				}

   351

			}

   352

		}

   353

	}

   354

   355

	/* check default names */

   356

	tmp = free_names & _gen_station_name_bits[flag];

   357

	if (tmp != 0) {

   358

		found = FindFirstBit(tmp);

   359

		goto done;

   360

	}

   361

   362

	/* check mine? */

   363

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

   364

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

   365

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

   366

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

   367

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

   368

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

   369

			found = M(STR_SV_STNAME_MINES);

   370

			goto done;

   371

		}

   372

	}

   373

   374

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

   375

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

   376

		found = M(STR_SV_STNAME);

   377

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

   378

   379

		found = M(STR_SV_STNAME_CENTRAL);

   380

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

   381

	}

   382

   383

	/* Check lakeside */

   384

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

   385

			DistanceFromEdge(tile) < 20 &&

   386

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

   387

		found = M(STR_SV_STNAME_LAKESIDE);

   388

		goto done;

   389

	}

   390

   391

	/* Check woods */

   392

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

   393

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

   394

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

   395

			) {

   396

		found = _opt.landscape == LT_DESERT ?

   397

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   398

		goto done;

   399

	}

   400

   401

	/* check elevation compared to town */

   402

	z = GetTileZ(tile);

   403

	z2 = GetTileZ(t->xy);

   404

	if (z < z2) {

   405

		found = M(STR_SV_STNAME_VALLEY);

   406

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

   407

	} else if (z > z2) {

   408

		found = M(STR_SV_STNAME_HEIGHTS);

   409

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

   410

	}

   411

   412

	/* check direction compared to town */

   413

	{

   414

		static const int8 _direction_and_table[] = {

   415

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

   416

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

   417

			~( (1<<M(STR_SV_STNAME_SOUTH)) | (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_EAST)) ),

   419

		};

   420

   421

		free_names &= _direction_and_table[

   422

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

   423

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

   424

	}

   425

   426

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

   427

	if (tmp == 0) {

   428

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   429

		return false;

   430

	}

   431

	found = FindFirstBit(tmp);

   432

   433

done:

   434

	st->string_id = found + STR_SV_STNAME;

   435

	return true;

   436

}

   437

#undef M

   438

   439

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

   440

{

   441

	Station* best_station = NULL;

   442

	Station* st;

   443

   444

	FOR_ALL_STATIONS(st) {

   445

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

   446

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

   447

   448

			if (cur_dist < threshold) {

   449

				threshold = cur_dist;

   450

				best_station = st;

   451

			}

   452

		}

   453

	}

   454

   455

	return best_station;

   456

}

   457

   458

static void StationInitialize(Station *st, TileIndex tile)

   459

{

   460

	GoodsEntry *ge;

   461

   462

	st->xy = tile;

   463

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

   464

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

   465

	st->had_vehicle_of_type = 0;

   466

	st->time_since_load = 255;

   467

	st->time_since_unload = 255;

   468

	st->delete_ctr = 0;

   469

	st->facilities = 0;

   470

   471

	st->last_vehicle_type = VEH_Invalid;

   472

   473

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

   474

		ge->waiting_acceptance = 0;

   475

		ge->days_since_pickup = 0;

   476

		ge->enroute_from = INVALID_STATION;

   477

		ge->rating = 175;

   478

		ge->last_speed = 0;

   479

		ge->last_age = 0xFF;

   480

		ge->feeder_profit = 0;

   481

	}

   482

   483

	st->random_bits = Random();

   484

	st->waiting_triggers = 0;

   485

   486

	StationRect_Init(st);

   487

}

   488

   489

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

   490

// st = Station to update for.

   491

static void UpdateStationVirtCoord(Station *st)

   492

{

   493

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

   494

   495

	pt.y -= 32;

   496