1

/* $Id$ */

     2

     3

/** @file station.h */

     4

     5

#ifndef STATION_H

     6

#define STATION_H

     7

     8

#include "airport.h"

     9

#include "player.h"

    10

#include "oldpool.h"

    11

#include "sprite.h"

    12

#include "tile.h"

    13

#include "road.h"

    14

#include "newgrf_station.h"

    15

#include "newgrf_fsmports.h"

    16

#include "cargopacket.h"

    17

#include <list>

    18

    19

struct Station;

    20

struct RoadStop;

    21

    22

DECLARE_OLD_POOL(Station, Station, 6, 1000)

    23

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

    24

    25

static const byte INITIAL_STATION_RATING = 175;

    26

    27

struct GoodsEntry {

    28

	enum AcceptancePickup {

    29

		ACCEPTANCE,

    30

		PICKUP

    31

	};

    32

    33

	GoodsEntry() :

    34

		acceptance_pickup(0),

    35

		days_since_pickup(255),

    36

		rating(INITIAL_STATION_RATING),

    37

		last_speed(0),

    38

		last_age(255)

    39

	{}

    40

    41

	byte acceptance_pickup;

    42

	byte days_since_pickup;

    43

	byte rating;

    44

	byte last_speed;

    45

	byte last_age;

    46

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

    47

};

    48

    49

/** A Stop for a Road Vehicle */

    50

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

    51

	/** Types of RoadStops */

    52

	enum Type {

    53

		BUS,                                ///< A standard stop for buses

    54

		TRUCK                               ///< A standard stop for trucks

    55

	};

    56

    57

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

    58

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

    59

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

    60

    61

	TileIndex        xy;                    ///< Position on the map

    62

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

    63

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

    64

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

    65

    66

	RoadStop(TileIndex tile = 0);

    67

	virtual ~RoadStop();

    68

    69

	/**

    70

	 * Determines whether a road stop exists

    71

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

    72

	 */

    73

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

    74

    75

	/* For accessing status */

    76

	bool HasFreeBay() const;

    77

	bool IsFreeBay(uint nr) const;

    78

	uint AllocateBay();

    79

	void AllocateDriveThroughBay(uint nr);

    80

	void FreeBay(uint nr);

    81

	bool IsEntranceBusy() const;

    82

	void SetEntranceBusy(bool busy);

    83

    84

	RoadStop *GetNextRoadStop(const Vehicle *v) const;

    85

};

    86

    87

struct StationSpecList {

    88

	const StationSpec *spec;

    89

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

    90

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

    91

};

    92

    93

struct FSMportsSpecList {

    94

	const FSMportsSpec *spec;

    95

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

    96

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

    97

};

    98

    99

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

   100

struct StationRect : public Rect {

   101

	enum StationRectMode

   102

	{

   103

		ADD_TEST = 0,

   104

		ADD_TRY,

   105

		ADD_FORCE

   106

	};

   107

   108

	StationRect();

   109

	void MakeEmpty();

   110

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

   111

	bool IsEmpty() const;

   112

	bool BeforeAddTile(TileIndex tile, StationRectMode mode);

   113

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

   114

	bool AfterRemoveTile(Station *st, TileIndex tile);

   115

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

   116

   117

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

   118

   119

	StationRect& operator = (Rect src);

   120

};

   121

   122

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

   123

public:

   124

	RoadStop *GetPrimaryRoadStop(RoadStop::Type type) const

   125

	{

   126

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

   127

	}

   128

   129

	RoadStop *GetPrimaryRoadStop(const Vehicle *v) const;

   130

   131

	const AirportFTAClass *Airport() const

   132

	{

   133

		return IsCustomFSMportsSpecIndex(airport_tile) ? fsmportsspeclist[1].spec->portFSM : AirportFTAClass::dummy;

   134

	}

   135

   136

	TileIndex xy;

   137

	RoadStop *bus_stops;

   138

	RoadStop *truck_stops;

   139

	TileIndex train_tile;

   140

	TileIndex airport_tile;

   141

	TileIndex dock_tile;

   142

	Town *town;

   143

	uint16 string_id;

   144

   145

	ViewportSign sign;

   146

   147

	uint16 had_vehicle_of_type;

   148

   149

	byte time_since_load;

   150

	byte time_since_unload;

   151

	byte delete_ctr;

   152

	PlayerByte owner;

   153

	byte facilities;

   154

	byte airport_type;

   155

	byte FSMport_layout_set;  /* indicates which layout set (S) of several in an FSMport spec->layouts[S] to use */

   156

	byte FSMport_orientation; /* direction of orientation of station for use with FSMports */

   157

	bool FSMport_flood_protected;     /* prevents flooding destroying water based FSMports */

   158

   159

	/* trainstation width/height */

   160

	byte trainst_w, trainst_h;

   161

   162

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

   163

	uint8 num_specs;

   164

	StationSpecList *speclist;

   165

	uint8 num_fsmportsspecs;

   166

	FSMportsSpecList *fsmportsspeclist;

   167

   168

	Date build_date;

   169

   170

	FSMblockmap airport_flags;   ///< stores which blocks on the port are taken

   171

   172

	byte last_vehicle_type;

   173

	std::list<Vehicle *> loading_vehicles;

   174

	GoodsEntry goods[NUM_CARGO];

   175

   176

	uint16 random_bits;

   177

	byte waiting_triggers;

   178

   179

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

   180

   181

	static const int cDebugCtorLevel = 5;

   182

   183

	Station(TileIndex tile = 0);

   184

	virtual ~Station();

   185

   186

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   193

	void MarkDirty() const;

   200

	void MarkTilesDirty(bool cargo_change) const;

   201

	bool TileBelongsToRailStation(TileIndex tile) const;

   202

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   203

	uint GetPlatformLength(TileIndex tile) const;

   204

	bool IsBuoy() const;

   205

   206

	/**

   207

	 * Determines whether a station exists

   208

	 * @return true if and only is the station exists

   209

	 */

   210

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

   211

};

   212

   213

enum StationType {

   214

	STATION_RAIL,

   215

	STATION_AIRPORT,

   216

	STATION_TRUCK,

   217

	STATION_BUS,

   218

	STATION_OILRIG,

   219

	STATION_DOCK,

   220

	STATION_BUOY

   221

};

   222

   223

enum {

   224

	FACIL_TRAIN      = 0x01,

   225

	FACIL_TRUCK_STOP = 0x02,

   226

	FACIL_BUS_STOP   = 0x04,

   227

	FACIL_AIRPORT    = 0x08,

   228

	FACIL_DOCK       = 0x10,

   229

};

   230

   231

enum {

   232

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

   233

	HVOT_TRAIN    = 1 << 1,

   234

	HVOT_BUS      = 1 << 2,

   235

	HVOT_TRUCK    = 1 << 3,

   236

	HVOT_AIRCRAFT = 1 << 4,

   237

	HVOT_SHIP     = 1 << 5,

   238

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

   239

	 * can we do? ;-) */

   240

	HVOT_BUOY     = 1 << 6

   241

};

   242

   243

enum CatchmentArea {

   244

	CA_NONE            =  0,

   245

	CA_BUS             =  3,

   246

	CA_TRUCK           =  3,

   247

	CA_TRAIN           =  4,

   248

	CA_DOCK            =  5,

   249

   250

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

   251

};

   252

   253

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

   254

   255

void ShowStationViewWindow(StationID station);

   256

void UpdateAllStationVirtCoord();

   257

   258

/* sorter stuff */

   259

void RebuildStationLists();

   260

void ResortStationLists();

   261

   262

static inline StationID GetMaxStationIndex()

   263

{

   264

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

   265

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

   266

	 *  _really_ returns the highest index. Now it just returns

   267

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

   268

	 */

   269

	return GetStationPoolSize() - 1;

   270

}

   271

   272

static inline uint GetNumStations()

   273

{

   274

	return GetStationPoolSize();

   275

}

   276

   277

static inline bool IsValidStationID(StationID index)

   278

{

   279

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

   280

}

   281

   282

#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())

   283

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

   284

   285

   286

/* Stuff for ROADSTOPS */

   287

   288

#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())

   289

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

   290

   291

/* End of stuff for ROADSTOPS */

   292

   293

   294

void AfterLoadStations();

   295

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

   296

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

   297

   298

   299

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

   300

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

   301

   302

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

   303

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

   304

RoadStop * AllocateRoadStop();

   305

void ClearSlot(Vehicle *v);

   306

   307

void DeleteOilRig(TileIndex t);

   308

   309

#endif /* STATION_H */