1

/* $Id$ */

     2

     3

/** @file station.h */

     4

     5

#ifndef STATION_H

     6

#define STATION_H

     7

     9

#include "airport.h"

    10

#include "oldpool.h"

    11

#include "sprite.h"

    12

#include "road_type.h"

    13

#include "newgrf_station.h"

    14

#include "cargopacket.h"

    15

#include "cargo_type.h"

    16

#include "town_type.h"

    17

#include "core/geometry_type.hpp"

    18

#include <list>

    19

#include <set>

    20

    21

DECLARE_OLD_POOL(Station, Station, 6, 1000)

    22

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

    23

    24

static const byte INITIAL_STATION_RATING = 175;

    25

    26

struct GoodsEntry {

    27

	enum AcceptancePickup {

    28

		ACCEPTANCE,

    29

		PICKUP

    30

	};

    31

    32

	GoodsEntry() :

    33

		acceptance_pickup(0),

    34

		days_since_pickup(255),

    35

		rating(INITIAL_STATION_RATING),

    36

		last_speed(0),

    37

		last_age(255)

    38

	{}

    39

    40

	byte acceptance_pickup;

    41

	byte days_since_pickup;

    42

	byte rating;

    43

	byte last_speed;

    44

	byte last_age;

    45

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

    46

};

    47

    48

/** A Stop for a Road Vehicle */

    49

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

    50

	/** Types of RoadStops */

    51

	enum Type {

    52

		BUS,                                ///< A standard stop for buses

    53

		TRUCK                               ///< A standard stop for trucks

    54

	};

    55

    56

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

    57

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

    58

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

    59

    60

	TileIndex        xy;                    ///< Position on the map

    61

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

    62

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

    63

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

    64

    65

	RoadStop(TileIndex tile = 0);

    66

	virtual ~RoadStop();

    67

    68

	/**

    69

	 * Determines whether a road stop exists

    70

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

    71

	 */

    72

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

    73

    74

	/* For accessing status */

    75

	bool HasFreeBay() const;

    76

	bool IsFreeBay(uint nr) const;

    77

	uint AllocateBay();

    78

	void AllocateDriveThroughBay(uint nr);

    79

	void FreeBay(uint nr);

    80

	bool IsEntranceBusy() const;

    81

	void SetEntranceBusy(bool busy);

    82

    83

	RoadStop *GetNextRoadStop(const Vehicle *v) const;

    84

};

    85

    86

struct StationSpecList {

    87

	const StationSpec *spec;

    88

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

    89

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

    90

};

    91

    92

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

    93

struct StationRect : public Rect {

    94

	enum StationRectMode

    95

	{

    96

		ADD_TEST = 0,

    97

		ADD_TRY,

    98

		ADD_FORCE

    99

	};

   100

   101

	StationRect();

   102

	void MakeEmpty();

   103

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

   104

	bool IsEmpty() const;

   105

	bool BeforeAddTile(TileIndex tile, StationRectMode mode);

   106

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

   107

	bool AfterRemoveTile(Station *st, TileIndex tile);

   108

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

   109

   110

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

   111

   112

	StationRect& operator = (Rect src);

   113

};

   114

   115

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

   116

public:

   117

	RoadStop *GetPrimaryRoadStop(RoadStop::Type type) const

   118

	{

   119

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

   120

	}

   121

   122

	RoadStop *GetPrimaryRoadStop(const Vehicle *v) const;

   123

   124

	const AirportFTAClass *Airport() const

   125

	{

   126

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

   127

		return GetAirport(airport_type);

   128

	}

   129

   130

	TileIndex xy;

   131

	RoadStop *bus_stops;

   132

	RoadStop *truck_stops;

   133

	TileIndex train_tile;

   134

	TileIndex airport_tile;

   135

	TileIndex dock_tile;

   136

	Town *town;

   137

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

   138

	char *name;             ///< Custom name

   139

   140

	ViewportSign sign;

   141

   142

	uint16 had_vehicle_of_type;

   143

   144

	byte time_since_load;

   145

	byte time_since_unload;

   146

	byte delete_ctr;

   147

	PlayerByte owner;

   148

	byte facilities;

   149

	byte airport_type;

   150

   151

	/* trainstation width/height */

   152

	byte trainst_w, trainst_h;

   153

   154

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

   155

	uint8 num_specs;

   156

	StationSpecList *speclist;

   157

   158

	Date build_date;

   159

   160

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

   161

   162

	byte last_vehicle_type;

   163

	std::list<Vehicle *> loading_vehicles;

   164

	GoodsEntry goods[NUM_CARGO];

   165

   166

	uint16 random_bits;

   167

	byte waiting_triggers;

   168

   169

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

   170

   171

	static const int cDebugCtorLevel = 5;

   172

   173

	Station(TileIndex tile = 0);

   174

	virtual ~Station();

   175

   176

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   177

   178

	/**

   179

	 * Mark the sign of a station dirty for repaint.

   180

	 *

   181

	 * @ingroup dirty

   182

	 */

   183

	void MarkDirty() const;

   184

   185

	/**

   186

	 * Marks the tiles of the station as dirty.

   187

	 *

   188

	 * @ingroup dirty

   189

	 */

   190

	void MarkTilesDirty(bool cargo_change) const;

   191

	bool TileBelongsToRailStation(TileIndex tile) const;

   192

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   193

	uint GetPlatformLength(TileIndex tile) const;

   194

	bool IsBuoy() const;

   195

   196

	/**

   197

	 * Determines whether a station exists

   198

	 * @return true if and only is the station exists

   199

	 */

   200

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

   201

};

   202

   203

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

   204

   205

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

   206

typedef std::set<Station*> StationSet;

   207

   208

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

   209

   210

void ShowStationViewWindow(StationID station);

   211

void UpdateAllStationVirtCoord();

   212

   213

static inline StationID GetMaxStationIndex()

   214

{

   215

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

   216

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

   217

	 *  _really_ returns the highest index. Now it just returns

   218

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

   219

	 */

   220

	return GetStationPoolSize() - 1;

   221

}

   222

   223

static inline uint GetNumStations()

   224

{

   225

	return GetStationPoolSize();

   226

}

   227

   228

static inline bool IsValidStationID(StationID index)

   229

{

   230

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

   231

}

   232

   233

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

   234

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

   235

   236

   237

/* Stuff for ROADSTOPS */

   238

   239

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

   240

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

   241

   242

/* End of stuff for ROADSTOPS */

   243

   244

   245

void AfterLoadStations();

   246

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

   247

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

   248

   249

   250

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

   251

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

   252

   253

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

   254

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

   255

RoadStop * AllocateRoadStop();

   256

void ClearSlot(Vehicle *v);

   257

   258

bool HasStationInUse(StationID station, PlayerID player);

   259

   260

void DeleteOilRig(TileIndex t);

   261

   262

#endif /* STATION_H */