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 "road_type.h"

    13

#include "newgrf_station.h"

    14

#include "cargopacket.h"

    16

#include <list>

    17

#include <set>

    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

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

    94

struct StationRect : public Rect {

    95

	enum StationRectMode

    96

	{

    97

		ADD_TEST = 0,

    98

		ADD_TRY,

    99

		ADD_FORCE

   100

	};

   101

   102

	StationRect();

   103

	void MakeEmpty();

   104

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

   105

	bool IsEmpty() const;

   106

	bool BeforeAddTile(TileIndex tile, StationRectMode mode);

   107

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

   108

	bool AfterRemoveTile(Station *st, TileIndex tile);

   109

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

   110

   111

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

   112

   113

	StationRect& operator = (Rect src);

   114

};

   115

   116

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

   117

public:

   118

	RoadStop *GetPrimaryRoadStop(RoadStop::Type type) const

   119

	{

   120

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

   121

	}

   122

   123

	RoadStop *GetPrimaryRoadStop(const Vehicle *v) const;

   124

   125

	const AirportFTAClass *Airport() const

   126

	{

   127

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

   128

		return GetAirport(airport_type);

   129

	}

   130

   131

	TileIndex xy;

   132

	RoadStop *bus_stops;

   133

	RoadStop *truck_stops;

   134

	TileIndex train_tile;

   135

	TileIndex airport_tile;

   136

	TileIndex dock_tile;

   137

	Town *town;

   138

	uint16 string_id;

   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

enum StationType {

   204

	STATION_RAIL,

   205

	STATION_AIRPORT,

   206

	STATION_TRUCK,

   207

	STATION_BUS,

   208

	STATION_OILRIG,

   209

	STATION_DOCK,

   210

	STATION_BUOY

   211

};

   212

   213

enum {

   214

	FACIL_TRAIN      = 0x01,

   215

	FACIL_TRUCK_STOP = 0x02,

   216

	FACIL_BUS_STOP   = 0x04,

   217

	FACIL_AIRPORT    = 0x08,

   218

	FACIL_DOCK       = 0x10,

   219

};

   220

   221

enum {

   222

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

   223

	HVOT_TRAIN    = 1 << 1,

   224

	HVOT_BUS      = 1 << 2,

   225

	HVOT_TRUCK    = 1 << 3,

   226

	HVOT_AIRCRAFT = 1 << 4,

   227

	HVOT_SHIP     = 1 << 5,

   228

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

   229

	 * can we do? ;-) */

   230

	HVOT_BUOY     = 1 << 6

   231

};

   232

   233

enum CatchmentArea {

   234

	CA_NONE            =  0,

   235

	CA_BUS             =  3,

   236

	CA_TRUCK           =  3,

   237

	CA_TRAIN           =  4,

   238

	CA_DOCK            =  5,

   239

   240

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

   241

};

   242

   243

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

   244

   245

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

   246

typedef std::set<Station*> StationSet;

   247

   248

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

   249

   250

void ShowStationViewWindow(StationID station);

   251

void UpdateAllStationVirtCoord();

   252

   253

static inline StationID GetMaxStationIndex()

   254

{

   255

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

   256

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

   257

	 *  _really_ returns the highest index. Now it just returns

   258

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

   259

	 */

   260

	return GetStationPoolSize() - 1;

   261

}

   262

   263

static inline uint GetNumStations()

   264

{

   265

	return GetStationPoolSize();

   266

}

   267

   268

static inline bool IsValidStationID(StationID index)

   269

{

   270

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

   271

}

   272

   273

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

   274

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

   275

   276

   277

/* Stuff for ROADSTOPS */

   278

   279

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

   280

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

   281

   282

/* End of stuff for ROADSTOPS */

   283

   284

   285

void AfterLoadStations();

   286

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

   287

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

   288

   289

   290

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

   291

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

   292

   293

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

   294

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

   295

RoadStop * AllocateRoadStop();

   296

void ClearSlot(Vehicle *v);

   297

   298

bool HasStationInUse(StationID station, PlayerID player);

   299

   300

void DeleteOilRig(TileIndex t);

   301

   302

#endif /* STATION_H */