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

    16

#include <list>

    17

    18

struct Station;

    19

struct RoadStop;

    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

	uint16 string_id;

   138

   139

	ViewportSign sign;

   140

   141

	uint16 had_vehicle_of_type;

   142

   143

	byte time_since_load;

   144

	byte time_since_unload;

   145

	byte delete_ctr;

   146

	PlayerByte owner;

   147

	byte facilities;

   148

	byte airport_type;

   149

   150

	/* trainstation width/height */

   151

	byte trainst_w, trainst_h;

   152

   153

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

   154

	uint8 num_specs;

   155

	StationSpecList *speclist;

   156

   157

	Date build_date;

   158

   159

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

   160

   161

	byte last_vehicle_type;

   162

	std::list<Vehicle *> loading_vehicles;

   163

	GoodsEntry goods[NUM_CARGO];

   164

   165

	uint16 random_bits;

   166

	byte waiting_triggers;

   167

   168

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

   169

   170

	static const int cDebugCtorLevel = 5;

   171

   172

	Station(TileIndex tile = 0);

   173

	virtual ~Station();

   174

   175

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   176

   177

	/**

   178

	 * Mark the sign of a station dirty for repaint.

   179

	 *

   180

	 * @ingroup dirty

   181

	 */

   182

	void MarkDirty() const;

   183

   184

	/**

   185

	 * Marks the tiles of the station as dirty.

   186

	 *

   187

	 * @ingroup dirty

   188

	 */

   189

	void MarkTilesDirty(bool cargo_change) const;

   190

	bool TileBelongsToRailStation(TileIndex tile) const;

   191

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   192

	uint GetPlatformLength(TileIndex tile) const;

   193

	bool IsBuoy() const;

   194

   195

	/**

   196

	 * Determines whether a station exists

   197

	 * @return true if and only is the station exists

   198

	 */

   199

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

   200

};

   201

   202

enum StationType {

   203

	STATION_RAIL,

   204

	STATION_AIRPORT,

   205

	STATION_TRUCK,

   206

	STATION_BUS,

   207

	STATION_OILRIG,

   208

	STATION_DOCK,

   209

	STATION_BUOY

   210

};

   211

   212

enum {

   213

	FACIL_TRAIN      = 0x01,

   214

	FACIL_TRUCK_STOP = 0x02,

   215

	FACIL_BUS_STOP   = 0x04,

   216

	FACIL_AIRPORT    = 0x08,

   217

	FACIL_DOCK       = 0x10,

   218

};

   219

   220

enum {

   221

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

   222

	HVOT_TRAIN    = 1 << 1,

   223

	HVOT_BUS      = 1 << 2,

   224

	HVOT_TRUCK    = 1 << 3,

   225

	HVOT_AIRCRAFT = 1 << 4,

   226

	HVOT_SHIP     = 1 << 5,

   227

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

   228

	 * can we do? ;-) */

   229

	HVOT_BUOY     = 1 << 6

   230

};

   231

   232

enum CatchmentArea {

   233

	CA_NONE            =  0,

   234

	CA_BUS             =  3,

   235

	CA_TRUCK           =  3,

   236

	CA_TRAIN           =  4,

   237

	CA_DOCK            =  5,

   238

   239

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

   240

};

   241

   242

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

   243

   244

void ShowStationViewWindow(StationID station);

   245

void UpdateAllStationVirtCoord();

   246

   247

/* sorter stuff */

   248

void RebuildStationLists();

   249

void ResortStationLists();

   250

   251

static inline StationID GetMaxStationIndex()

   252

{

   253

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

   254

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

   255

	 *  _really_ returns the highest index. Now it just returns

   256

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

   257

	 */

   258

	return GetStationPoolSize() - 1;

   259

}

   260

   261

static inline uint GetNumStations()

   262

{

   263

	return GetStationPoolSize();

   264

}

   265

   266

static inline bool IsValidStationID(StationID index)

   267

{

   268

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

   269

}

   270

   271

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

   272

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

   273

   274

   275

/* Stuff for ROADSTOPS */

   276

   277

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

   278

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

   279

   280

/* End of stuff for ROADSTOPS */

   281

   282

   283

void AfterLoadStations();

   284

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

   285

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

   286

   287

   288

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

   289

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

   290

   291

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

   292

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

   293

RoadStop * AllocateRoadStop();

   294

void ClearSlot(Vehicle *v);

   295

   296

void DeleteOilRig(TileIndex t);

   297

   298

#endif /* STATION_H */