1

/* $Id$ */

     2

     3

/** @file station.h */

     4

     5

#ifndef STATION_H

     6

#define STATION_H

     7

     8

#include "airport.h"

     9

#include "oldpool.h"

    10

#include "sprite.h"

    11

#include "road_type.h"

    12

#include "newgrf_station.h"

    13

#include "cargopacket.h"

    14

#include "cargo_type.h"

    15

#include "town_type.h"

    16

#include "core/geometry_type.hpp"

    17

#include <list>

    18

#include <set>

    19

    20

struct Station;

    21

struct RoadStop;

    22

    23

DECLARE_OLD_POOL(Station, Station, 6, 1000)

    24

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

    25

    26

static const byte INITIAL_STATION_RATING = 175;

    27

    28

struct GoodsEntry {

    29

	enum AcceptancePickup {

    30

		ACCEPTANCE,

    31

		PICKUP

    32

	};

    33

    34

	GoodsEntry() :

    35

		acceptance_pickup(0),

    36

		days_since_pickup(255),

    37

		rating(INITIAL_STATION_RATING),

    38

		last_speed(0),

    39

		last_age(255)

    40

	{}

    41

    42

	byte acceptance_pickup;

    43

	byte days_since_pickup;

    44

	byte rating;

    45

	byte last_speed;

    46

	byte last_age;

    47

	CargoList cargo; ///< The cargo packets of cargo waiting in this station

    48

};

    49

    50

/** A Stop for a Road Vehicle */

    51

struct RoadStop : PoolItem<RoadStop, RoadStopID, &_RoadStop_pool> {

    52

	/** Types of RoadStops */

    53

	enum Type {

    54

		BUS,                                ///< A standard stop for buses

    55

		TRUCK                               ///< A standard stop for trucks

    56

	};

    57

    58

	static const int  cDebugCtorLevel =  5;  ///< Debug level on which Contructor / Destructor messages are printed

    59

	static const uint LIMIT           = 16;  ///< The maximum amount of roadstops that are allowed at a single station

    60

	static const uint MAX_BAY_COUNT   =  2;  ///< The maximum number of loading bays

    61

    62

	TileIndex        xy;                    ///< Position on the map

    63

	byte             status;                ///< Current status of the Stop. Like which spot is taken. Access using *Bay and *Busy functions.

    64

	byte             num_vehicles;          ///< Number of vehicles currently slotted to this stop

    65

	struct RoadStop  *next;                 ///< Next stop of the given type at this station

    66

    67

	RoadStop(TileIndex tile = 0);

    68

	virtual ~RoadStop();

    69

    70

	/**

    71

	 * Determines whether a road stop exists

    72

	 * @return true if and only is the road stop exists

    73

	 */

    74

	inline bool IsValid() const { return this->xy != 0; }

    75

    76

	/* For accessing status */

    77

	bool HasFreeBay() const;

    78

	bool IsFreeBay(uint nr) const;

    79

	uint AllocateBay();

    80

	void AllocateDriveThroughBay(uint nr);

    81

	void FreeBay(uint nr);

    82

	bool IsEntranceBusy() const;

    83

	void SetEntranceBusy(bool busy);

    84

    85

	RoadStop *GetNextRoadStop(const Vehicle *v) const;

    86

};

    87

    88

struct StationSpecList {

    89

	const StationSpec *spec;

    90

	uint32 grfid;      ///< GRF ID of this custom station

    91

	uint8  localidx;   ///< Station ID within GRF of station

    92

};

    93

    94

/** StationRect - used to track station spread out rectangle - cheaper than scanning whole map */

    95

struct StationRect : public Rect {

    96

	enum StationRectMode

    97

	{

    98

		ADD_TEST = 0,

    99

		ADD_TRY,

   100

		ADD_FORCE

   101

	};

   102

   103

	StationRect();

   104

	void MakeEmpty();

   105

	bool PtInExtendedRect(int x, int y, int distance = 0) const;

   106

	bool IsEmpty() const;

   107

	bool BeforeAddTile(TileIndex tile, StationRectMode mode);

   108

	bool BeforeAddRect(TileIndex tile, int w, int h, StationRectMode mode);

   109

	bool AfterRemoveTile(Station *st, TileIndex tile);

   110

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

   111

   112

	static bool ScanForStationTiles(StationID st_id, int left_a, int top_a, int right_a, int bottom_a);

   113

   114

	StationRect& operator = (Rect src);

   115

};

   116

   117

struct Station : PoolItem<Station, StationID, &_Station_pool> {

   118

public:

   119

	RoadStop *GetPrimaryRoadStop(RoadStop::Type type) const

   120

	{

   121

		return type == RoadStop::BUS ? bus_stops : truck_stops;

   122

	}

   123

   124

	RoadStop *GetPrimaryRoadStop(const Vehicle *v) const;

   125

   126

	const AirportFTAClass *Airport() const

   127

	{

   128

		if (airport_tile == 0) return GetAirport(AT_DUMMY);

   129

		return GetAirport(airport_type);

   130

	}

   131

   132

	TileIndex xy;

   133

	RoadStop *bus_stops;

   134

	RoadStop *truck_stops;

   135

	TileIndex train_tile;

   136

	TileIndex airport_tile;

   137

	TileIndex dock_tile;

   138

	Town *town;

   139

	StringID string_id;     ///< Default name (town area) of station

   140

	char *name;             ///< Custom name

   141

   142

	ViewportSign sign;

   143

   144

	uint16 had_vehicle_of_type;

   145

   146

	byte time_since_load;

   147

	byte time_since_unload;

   148

	byte delete_ctr;

   149

	PlayerByte owner;

   150

	byte facilities;

   151

	byte airport_type;

   152

   153

	/* trainstation width/height */

   154

	byte trainst_w, trainst_h;

   155

   156

	/** List of custom stations (StationSpecs) allocated to the station */

   157

	uint8 num_specs;

   158

	StationSpecList *speclist;

   159

   160

	Date build_date;

   161

   162

	uint64 airport_flags;   ///< stores which blocks on the airport are taken. was 16 bit earlier on, then 32

   163

   164

	byte last_vehicle_type;

   165

	std::list<Vehicle *> loading_vehicles;

   166

	GoodsEntry goods[NUM_CARGO];

   167

   168

	uint16 random_bits;

   169

	byte waiting_triggers;

   170

   171

	StationRect rect; ///< Station spread out rectangle (not saved) maintained by StationRect_xxx() functions

   172

   173

	static const int cDebugCtorLevel = 5;

   174

   175

	Station(TileIndex tile = 0);

   176

	virtual ~Station();

   177

   178

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   179

   180

	/**

   181

	 * Mark the sign of a station dirty for repaint.

   182

	 *

   183

	 * @ingroup dirty

   184

	 */

   185

	void MarkDirty() const;

   186

   187

	/**

   188

	 * Marks the tiles of the station as dirty.

   189

	 *

   190

	 * @ingroup dirty

   191

	 */

   192

	void MarkTilesDirty(bool cargo_change) const;

   193

	bool TileBelongsToRailStation(TileIndex tile) const;

   194

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   195

	uint GetPlatformLength(TileIndex tile) const;

   196

	bool IsBuoy() const;

   197

   198

	/**

   199

	 * Determines whether a station exists

   200

	 * @return true if and only is the station exists

   201

	 */

   202

	inline bool IsValid() const { return this->xy != 0; }

   203

};

   204

   205

enum StationType {

   206

	STATION_RAIL,

   207

	STATION_AIRPORT,

   208

	STATION_TRUCK,

   209

	STATION_BUS,

   210

	STATION_OILRIG,

   211

	STATION_DOCK,

   212

	STATION_BUOY

   213

};

   214

   215

enum {

   216

	FACIL_TRAIN      = 0x01,

   217

	FACIL_TRUCK_STOP = 0x02,

   218

	FACIL_BUS_STOP   = 0x04,

   219

	FACIL_AIRPORT    = 0x08,

   220

	FACIL_DOCK       = 0x10,

   221

};

   222

   223

enum {

   224

//	HVOT_PENDING_DELETE = 1 << 0, // not needed anymore

   225

	HVOT_TRAIN    = 1 << 1,

   226

	HVOT_BUS      = 1 << 2,

   227

	HVOT_TRUCK    = 1 << 3,

   228

	HVOT_AIRCRAFT = 1 << 4,

   229

	HVOT_SHIP     = 1 << 5,

   230

	/* This bit is used to mark stations. No, it does not belong here, but what

   231

	 * can we do? ;-) */

   232

	HVOT_BUOY     = 1 << 6

   233

};

   234

   235

enum CatchmentArea {

   236

	CA_NONE            =  0,

   237

	CA_BUS             =  3,

   238

	CA_TRUCK           =  3,

   239

	CA_TRAIN           =  4,

   240

	CA_DOCK            =  5,

   241

   242

	CA_UNMODIFIED      =  4, ///< Used when _patches.modified_catchment is false

   243

   244

	MAX_CATCHMENT      = 10, ///< Airports have a catchment up to this number.

   245

};

   246

   247

void ModifyStationRatingAround(TileIndex tile, PlayerID owner, int amount, uint radius);

   248

   249

/** A set of stations (\c const \c Station* ) */

   250

typedef std::set<Station*> StationSet;

   251

   252

StationSet FindStationsAroundIndustryTile(TileIndex tile, int w, int h);

   253

   254

void ShowStationViewWindow(StationID station);

   255

void UpdateAllStationVirtCoord();

   256

   257

static inline StationID GetMaxStationIndex()

   258

{

   259

	/* TODO - This isn't the real content of the function, but

   260

	 *  with the new pool-system this will be replaced with one that

   261

	 *  _really_ returns the highest index. Now it just returns

   262

	 *  the next safe value we are sure about everything is below.

   263

	 */

   264

	return GetStationPoolSize() - 1;

   265

}

   266

   267

static inline uint GetNumStations()

   268

{

   269

	return GetStationPoolSize();

   270

}

   271

   272

static inline bool IsValidStationID(StationID index)

   273

{

   274

	return index < GetStationPoolSize() && GetStation(index)->IsValid();

   275

}

   276

   277

#define FOR_ALL_STATIONS_FROM(st, start) for (st = GetStation(start); st != NULL; st = (st->index + 1U < GetStationPoolSize()) ? GetStation(st->index + 1U) : NULL) if (st->IsValid())

   278

#define FOR_ALL_STATIONS(st) FOR_ALL_STATIONS_FROM(st, 0)

   279

   280

   281

/* Stuff for ROADSTOPS */

   282

   283

#define FOR_ALL_ROADSTOPS_FROM(rs, start) for (rs = GetRoadStop(start); rs != NULL; rs = (rs->index + 1U < GetRoadStopPoolSize()) ? GetRoadStop(rs->index + 1U) : NULL) if (rs->IsValid())

   284

#define FOR_ALL_ROADSTOPS(rs) FOR_ALL_ROADSTOPS_FROM(rs, 0)

   285

   286

/* End of stuff for ROADSTOPS */

   287

   288

   289

void AfterLoadStations();

   290

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile, int w, int h, int rad);

   291

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile, int w, int h, int rad);

   292

   293

   294

const DrawTileSprites *GetStationTileLayout(StationType st, byte gfx);

   295

void StationPickerDrawSprite(int x, int y, StationType st, RailType railtype, RoadType roadtype, int image);

   296

   297

RoadStop * GetRoadStopByTile(TileIndex tile, RoadStop::Type type);

   298

uint GetNumRoadStops(const Station* st, RoadStop::Type type);

   299

RoadStop * AllocateRoadStop();

   300

void ClearSlot(Vehicle *v);

   301

   302

bool HasStationInUse(StationID station, PlayerID player);

   303

   304

void DeleteOilRig(TileIndex t);

   305

   306

#endif /* STATION_H */