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

typedef enum StationRectModes

    37

{

    38

	RECT_MODE_TEST = 0,

    39

	RECT_MODE_TRY,

    40

	RECT_MODE_FORCE

    41

} StationRectMode;

    42

    43

static void StationRect_Init(Station *st);

    44

static bool StationRect_IsEmpty(Station *st);

    45

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

    46

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

    47

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

    48

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

    49

    50

    51

/**

    52

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

    53

 */

    54

static void StationPoolNewBlock(uint start_item)

    55

{

    56

	Station *st;

    57

    58

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

    59

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

    60

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

    61

}

    62

    63

static void StationPoolCleanBlock(uint start_item, uint end_item)

    64

{

    65

	uint i;

    66

    67

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

    68

		Station *st = GetStation(i);

    69

		free(st->speclist);

    70

		st->speclist = NULL;

    71

	}

    72

}

    73

    74

/**

    75

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

    76

 */

    77

static void RoadStopPoolNewBlock(uint start_item)

    78

{

    79

	RoadStop *rs;

    80

    81

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

    82

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

    83

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

    84

}

    85

    86

DEFINE_OLD_POOL(Station, Station, StationPoolNewBlock, StationPoolCleanBlock)

    87

DEFINE_OLD_POOL(RoadStop, RoadStop, RoadStopPoolNewBlock, NULL)

    88

    89

    90

extern void UpdateAirplanesOnNewStation(Station *st);

    91

    92

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

    93

{

    94

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

    95

}

    96

    97

void MarkStationTilesDirty(const Station *st)

    98

{

    99

	TileIndex tile = st->train_tile;

   100

	int w, h;

   101

   102

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

   103

	if (tile == 0) return;

   104

   105

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

   106

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

   107

			if (TileBelongsToRailStation(st, tile)) {

   108

				MarkTileDirtyByTile(tile);

   109

			}

   110

			tile += TileDiffXY(1, 0);

   111

		}

   112

		tile += TileDiffXY(-w, 1);

   113

	}

   114

}

   115

   116

static void MarkStationDirty(const Station* st)

   117

{

   118

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

   119

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

   120

   121

		MarkAllViewportsDirty(

   122

			st->sign.left - 6,

   123

			st->sign.top,

   124

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

   125

			st->sign.top + 48);

   126

	}

   127

}

   128

   129

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

   130

{

   131

	road_stop->xy = tile;

   132

	road_stop->used = true;

   133

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

   134

	road_stop->next = NULL;

   135

	road_stop->prev = previous;

   136

	road_stop->station = index;

   137

	road_stop->num_vehicles = 0;

   138

}

   139

   140

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

   141

{

   142

	switch (type) {

   143

		case RS_BUS:   return st->bus_stops;

   144

		case RS_TRUCK: return st->truck_stops;

   145

		default: NOT_REACHED();

   146

	}

   147

   148

	return NULL;

   149

}

   150

   151

RoadStop* GetRoadStopByTile(TileIndex tile, RoadStopType type)

   152

{

   153

	const Station* st = GetStationByTile(tile);

   154

	RoadStop* rs;

   155

   156

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

   157

		assert(rs->next != NULL);

   158

	}

   159

   160

	return rs;

   161

}

   162

   163

uint GetNumRoadStopsInStation(const Station* st, RoadStopType type)

   164

{

   165

	uint num = 0;

   166

	const RoadStop *rs;

   167

   168

	assert(st != NULL);

   169

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

   170

   171

	return num;

   172

}

   173

   174

RoadStop *AllocateRoadStop(void)

   175

{

   176

	RoadStop *rs;

   177

   178

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

   179

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

   180

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

   181

		if (!IsValidRoadStop(rs)) {

   182

			RoadStopID index = rs->index;

   183

   184

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

   185

			rs->index = index;

   186

   187

			return rs;

   188

		}

   189

	}

   190

   191

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

   192

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

   193

   194

	return NULL;

   195

}

   196

   197

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

   198

 *  radius that is available within the station */

   199

static uint FindCatchmentRadius(const Station* st)

   200

{

   201

	uint ret = 0;

   202

   203

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

   204

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

   205

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

   206

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

   207

   208

	if (st->airport_tile) {

   209

		switch (st->airport_type) {

   210

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

   211

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

   212

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

   213

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

   214

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

   215

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

   216

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

   217

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

   218

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

   219

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

   220

		}

   221

	}

   222

   223

	return ret;

   224

}

   225

   226

#define CHECK_STATIONS_ERR ((Station*)-1)

   227

   228

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

   229

{

   230

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

   231

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

   232

		if (IsTileType(tile_cur, MP_STATION)) {

   233

			StationID t = GetStationIndex(tile_cur);

   234

   235

			if (closest_station == INVALID_STATION) {

   236

				closest_station = t;

   237

			} else if (closest_station != t) {

   238

				_error_message = STR_3006_ADJOINS_MORE_THAN_ONE_EXISTING;

   239

				return CHECK_STATIONS_ERR;

   240

			}

   241

		}

   242

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

   243

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

   244

}

   245

   246

static Station *AllocateStation(void)

   247

{

   248

	Station *st = NULL;

   249

   250

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

   251

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

   252

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

   253

		if (!IsValidStation(st)) {

   254

			StationID index = st->index;

   255

   256

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

   257

			st->index = index;

   258

   259

			return st;

   260

		}

   261

	}

   262

   263

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

   264

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

   265

   266

	_error_message = STR_3008_TOO_MANY_STATIONS_LOADING;

   267

	return NULL;

   268

}

   269

   270

   271

/**

   272

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

   273

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

   274

 * @param type the type of tile searched for

   275

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

   276

 *                 in all other cases this parameter is ignored

   277

 * @result the noumber of matching tiles around

   278

 */

   279

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

   280

{

   281

	TileIndex cur_tile;

   282

	int dx, dy;

   283

	int num = 0;

   284

   285

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

   286

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

   287

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

   288

   289

			if (IsTileType(cur_tile, type)) {

   290

				switch (type) {

   291

					case MP_INDUSTRY:

   292

						if (GetIndustryType(cur_tile) == industry)

   293

							num++;

   294

						break;

   295

   296

					case MP_WATER:

   297

						if (!IsWater(cur_tile))

   298

							break;

   299

						/* FALL THROUGH WHEN WATER TILE */

   300

					case MP_TREES:

   301

						num++;

   302

						break;

   303

   304

					default:

   305

						break;

   306

				}

   307

			}

   308

		}

   309

	}

   310

   311

	return num;

   312

}

   313

   314

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

   315

   316

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

   317

{

   318

	static const uint32 _gen_station_name_bits[] = {

   319

		0,                                      /* 0 */

   320

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

   321

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

   322

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

   323

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

   324

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

   325

	};

   326

   327

	Town *t = st->town;

   328

	uint32 free_names = (uint32)-1;

   329

	int found;

   330

	uint z,z2;

   331

	unsigned long tmp;

   332

   333

	{

   334

		Station *s;

   335

   336

		FOR_ALL_STATIONS(s) {

   337

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

   338

				uint str = M(s->string_id);

   339

				if (str <= 0x20) {

   340

					if (str == M(STR_SV_STNAME_FOREST))

   341

						str = M(STR_SV_STNAME_WOODS);

   342

					CLRBIT(free_names, str);

   343

				}

   344

			}

   345

		}

   346

	}

   347

   348

	/* check default names */

   349

	tmp = free_names & _gen_station_name_bits[flag];

   350

	if (tmp != 0) {

   351

		found = FindFirstBit(tmp);

   352

		goto done;

   353

	}

   354

   355

	/* check mine? */

   356

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

   357

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

   358

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

   359

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

   360

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

   361

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

   362

			found = M(STR_SV_STNAME_MINES);

   363

			goto done;

   364

		}

   365

	}

   366

   367

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

   368

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

   369

		found = M(STR_SV_STNAME);

   370

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

   371

   372

		found = M(STR_SV_STNAME_CENTRAL);

   373

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

   374

	}

   375

   376

	/* Check lakeside */

   377

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

   378

			DistanceFromEdge(tile) < 20 &&

   379

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

   380

		found = M(STR_SV_STNAME_LAKESIDE);

   381

		goto done;

   382

	}

   383

   384

	/* Check woods */

   385

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

   386

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

   387

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

   388

			) {

   389

		found = _opt.landscape == LT_DESERT ?

   390

			M(STR_SV_STNAME_FOREST) : M(STR_SV_STNAME_WOODS);

   391

		goto done;

   392

	}

   393

   394

	/* check elevation compared to town */

   395

	z = GetTileZ(tile);

   396

	z2 = GetTileZ(t->xy);

   397

	if (z < z2) {

   398

		found = M(STR_SV_STNAME_VALLEY);

   399

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

   400

	} else if (z > z2) {

   401

		found = M(STR_SV_STNAME_HEIGHTS);

   402

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

   403

	}

   404

   405

	/* check direction compared to town */

   406

	{

   407

		static const int8 _direction_and_table[] = {

   408

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

   409

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

   410

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

   411

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

   412

		};

   413

   414

		free_names &= _direction_and_table[

   415

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

   416

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

   417

	}

   418

   419

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

   420

	if (tmp == 0) {

   421

		_error_message = STR_3007_TOO_MANY_STATIONS_LOADING;

   422

		return false;

   423

	}

   424

	found = FindFirstBit(tmp);

   425

   426

done:

   427

	st->string_id = found + STR_SV_STNAME;

   428

	return true;

   429

}

   430

#undef M

   431

   432

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

   433

{

   434

	Station* best_station = NULL;

   435

	Station* st;

   436

   437

	FOR_ALL_STATIONS(st) {

   438

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

   439

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

   440

   441

			if (cur_dist < threshold) {

   442

				threshold = cur_dist;

   443

				best_station = st;

   444

			}

   445

		}

   446

	}

   447

   448

	return best_station;

   449

}

   450

   451

static void StationInitialize(Station *st, TileIndex tile)

   452

{

   453

	GoodsEntry *ge;

   454

   455

	st->xy = tile;

   456

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

   457

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

   458

	st->had_vehicle_of_type = 0;

   459

	st->time_since_load = 255;

   460

	st->time_since_unload = 255;

   461

	st->delete_ctr = 0;

   462

	st->facilities = 0;

   463

   464

	st->last_vehicle_type = VEH_Invalid;

   465

   466

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

   467

		ge->waiting_acceptance = 0;

   468

		ge->days_since_pickup = 0;

   469

		ge->enroute_from = INVALID_STATION;

   470

		ge->rating = INITIAL_STATION_RATING;

   471

		ge->last_speed = 0;

   472

		ge->last_age = 0xFF;

   473

		ge->feeder_profit = 0;

   474

	}

   475

   476

	st->random_bits = Random();

   477

	st->waiting_triggers = 0;

   478

   479

	StationRect_Init(st);

   480

}

   481

   482

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

   483

// st = Station to update for.

   484

static void UpdateStationVirtCoord(Station *st)

   485

{

   486

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

   487

   488

	pt.y -= 32;

   489

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

   490

   491

	SetDParam(0, st->index);

   492

	SetDParam(1, st->facilities);

   493

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

   494

}

   495

   496

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