1

/* $Id$ */

     2

     3

/** @file station_base.h Base classes/functions for stations. */

     4

     5

#ifndef STATION_BASE_H

     6

#define STATION_BASE_H

     7

     8

#include "station_type.h"

     9

#include "airport.h"

    10

#include "oldpool.h"

    11

#include "cargopacket.h"

    12

#include "cargo_type.h"

    13

#include "town_type.h"

    14

#include "strings_type.h"

    15

#include "date_type.h"

    16

#include "vehicle_type.h"

    17

#include "company_type.h"

    18

#include "industry_type.h"

    19

#include "core/geometry_type.hpp"

    20

#include "viewport_type.h"

    21

#include <list>

    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

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

    53

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

    54

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

    55

    56

	TileIndex        xy;                    ///< Position on the map

    57

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

    58

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

    59

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

    60

    61

	RoadStop(TileIndex tile = 0);

    62

	virtual ~RoadStop();

    63

    64

	/**

    65

	 * Determines whether a road stop exists

    66

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

    67

	 */

    68

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

    69

    70

	/* For accessing status */

    71

	bool HasFreeBay() const;

    72

	bool IsFreeBay(uint nr) const;

    73

	uint AllocateBay();

    74

	void AllocateDriveThroughBay(uint nr);

    75

	void FreeBay(uint nr);

    76

	bool IsEntranceBusy() const;

    77

	void SetEntranceBusy(bool busy);

    78

    79

	RoadStop *GetNextRoadStop(const Vehicle *v) const;

    80

};

    81

    82

struct StationSpecList {

    83

	const StationSpec *spec;

    84

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

    85

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

    86

};

    87

    88

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

    89

struct StationRect : public Rect {

    90

	enum StationRectMode

    91

	{

    92

		ADD_TEST = 0,

    93

		ADD_TRY,

    94

		ADD_FORCE

    95

	};

    96

    97

	StationRect();

    98

	void MakeEmpty();

    99

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

   100

	bool IsEmpty() const;

   101

	bool BeforeAddTile(TileIndex tile, StationRectMode mode);

   102

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

   103

	bool AfterRemoveTile(Station *st, TileIndex tile);

   104

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

   105

   106

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

   107

   108

	StationRect& operator = (Rect src);

   109

};

   110

   111

/** Station data structure */

   112

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

   113

public:

   114

	RoadStop *GetPrimaryRoadStop(RoadStopType type) const

   115

	{

   116

		return type == ROADSTOP_BUS ? bus_stops : truck_stops;

   117

	}

   118

   119

	RoadStop *GetPrimaryRoadStop(const Vehicle *v) const;

   120

   121

	const AirportFTAClass *Airport() const

   122

	{

   123

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

   124

		return GetAirport(airport_type);

   125

	}

   126

   127

	TileIndex xy;

   128

	RoadStop *bus_stops;

   129

	RoadStop *truck_stops;

   130

	TileIndex train_tile;

   131

	TileIndex airport_tile;

   132

	TileIndex dock_tile;

   133

	Town *town;

   134

   135

	/* Place to get a name from, in order of importance: */

   136

	char *name;             ///< Custom name

   137

	IndustryType indtype;   ///< Industry type to get the name from

   138

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

   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

	OwnerByte 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;  ///< Date of construction

   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];  ///< Goods at this station

   165

   166

	uint16 random_bits;

   167

	byte waiting_triggers;

   168

	uint8 cached_anim_triggers; ///< Combined animation trigger bitmask, used to determine if trigger processing should happen.

   169

   170

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

   171

   172

	static const int cDebugCtorLevel = 5;

   173

   174

	Station(TileIndex tile = 0);

   175

	virtual ~Station();

   176

   177

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   178

   179

	/**

   180

	 * Mark the sign of a station dirty for repaint.

   181

	 *

   182

	 * @ingroup dirty

   183

	 */

   184

	void MarkDirty() const;

   185

   186

	/**

   187

	 * Marks the tiles of the station as dirty.

   188

	 *

   189

	 * @ingroup dirty

   190

	 */

   191

	void MarkTilesDirty(bool cargo_change) const;

   192

	bool TileBelongsToRailStation(TileIndex tile) const;

   193

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   194

	uint GetPlatformLength(TileIndex tile) const;

   195

	bool IsBuoy() const;

   196

   197

	/**

   198

	 * Determines whether a station exists

   199

	 * @return true if and only is the station exists

   200

	 */

   201

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

   202

   203

	uint GetCatchmentRadius() const;

   204

};

   205

   206

static inline StationID GetMaxStationIndex()

   207

{

   208

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

   209

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

   210

	 *  _really_ returns the highest index. Now it just returns

   211

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

   212

	 */

   213

	return GetStationPoolSize() - 1;

   214

}

   215

   216

static inline uint GetNumStations()

   217

{

   218

	return GetStationPoolSize();

   219

}

   220

   221

static inline bool IsValidStationID(StationID index)

   222

{

   223

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

   224

}

   225

   226

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

   227

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

   228

   229

   230

/* Stuff for ROADSTOPS */

   231

   232

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

   233

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

   234

   235

/* End of stuff for ROADSTOPS */

   236

   237

#endif /* STATION_BASE_H */