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

    12

#include "newgrf_fsmports.h"

    13

#include "cargopacket.h"

    14

#include "cargo_type.h"

    15

#include "town_type.h"

    16

#include "strings_type.h"

    17

#include "date_type.h"

    18

#include "vehicle_type.h"

    19

#include "player_type.h"

    20

#include "core/geometry_type.hpp"

    21

#include "viewport_type.h"

    22

#include <list>

    23

    24

DECLARE_OLD_POOL(Station, Station, 6, 1000)

    25

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

    26

    27

static const byte INITIAL_STATION_RATING = 175;

    28

    29

struct GoodsEntry {

    30

	enum AcceptancePickup {

    31

		ACCEPTANCE,

    32

		PICKUP

    33

	};

    34

    35

	GoodsEntry() :

    36

		acceptance_pickup(0),

    37

		days_since_pickup(255),

    38

		rating(INITIAL_STATION_RATING),

    39

		last_speed(0),

    40

		last_age(255)

    41

	{}

    42

    43

	byte acceptance_pickup;

    44

	byte days_since_pickup;

    45

	byte rating;

    46

	byte last_speed;

    47

	byte last_age;

    48

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

    49

};

    50

    51

/** A Stop for a Road Vehicle */

    52

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

    53

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

    54

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

    55

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

    56

    57

	TileIndex        xy;                    ///< Position on the map

    58

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

    59

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

    60

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

    61

    62

	RoadStop(TileIndex tile = 0);

    63

	virtual ~RoadStop();

    64

    65

	/**

    66

	 * Determines whether a road stop exists

    67

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

    68

	 */

    69

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

    70

    71

	/* For accessing status */

    72

	bool HasFreeBay() const;

    73

	bool IsFreeBay(uint nr) const;

    74

	uint AllocateBay();

    75

	void AllocateDriveThroughBay(uint nr);

    76

	void FreeBay(uint nr);

    77

	bool IsEntranceBusy() const;

    78

	void SetEntranceBusy(bool busy);

    79

    80

	RoadStop *GetNextRoadStop(const Vehicle *v) const;

    81

};

    82

    83

struct StationSpecList {

    84

	const StationSpec *spec;

    85

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

    86

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

    87

};

    88

    89

struct FSMportsSpecList {

    90

	const FSMportsSpec *spec;

    91

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

    92

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

    93

};

    94

    95

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

    96

struct StationRect : public Rect {

    97

	enum StationRectMode

    98

	{

    99

		ADD_TEST = 0,

   100

		ADD_TRY,

   101

		ADD_FORCE

   102

	};

   103

   104

	StationRect();

   105

	void MakeEmpty();

   106

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

   107

	bool IsEmpty() const;

   108

	bool BeforeAddTile(TileIndex tile, StationRectMode mode);

   109

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

   110

	bool AfterRemoveTile(Station *st, TileIndex tile);

   111

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

   112

   113

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

   114

   115

	StationRect& operator = (Rect src);

   116

};

   117

   118

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

   119

public:

   120

	RoadStop *GetPrimaryRoadStop(RoadStopType type) const

   121

	{

   122

		return type == ROADSTOP_BUS ? bus_stops : truck_stops;

   123

	}

   124

   125

	RoadStop *GetPrimaryRoadStop(const Vehicle *v) const;

   126

   127

	const AirportFTAClass *Airport() const

   128

	{

   129

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

   130

	}

   131

   132

	TileIndex xy;

   133

	RoadStop *bus_stops;

   134

	RoadStop *truck_stops;

   135

	TileIndex train_tile;

   136

	TileIndex airport_tile;

   137

	TileIndex dock_tile;

   138

	Town *town;

   139

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

   140

	char *name;             ///< Custom name

   141

   142

	ViewportSign sign;

   143

   144

	uint16 had_vehicle_of_type;

   145

   146

	byte time_since_load;

   147

	byte time_since_unload;

   148

	byte delete_ctr;

   149

	PlayerByte owner;

   150

	byte facilities;

   151

	byte airport_type;

   152

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

   153

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

   154

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

   155

   156

	/* trainstation width/height */

   157

	byte trainst_w, trainst_h;

   158

   159

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

   160

	uint8 num_specs;

   161

	StationSpecList *speclist;

   162

	uint8 num_fsmportsspecs;

   163

	FSMportsSpecList *fsmportsspeclist;

   164

   165

	Date build_date;

   166

   167

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

   168

   169

	byte last_vehicle_type;

   170

	std::list<Vehicle *> loading_vehicles;

   171

	GoodsEntry goods[NUM_CARGO];

   172

   173

	uint16 random_bits;

   174

	byte waiting_triggers;

   175

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

   176

   177

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

   178

   179

	static const int cDebugCtorLevel = 5;

   180

   181

	Station(TileIndex tile = 0);

   182

	virtual ~Station();

   183

   184

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   185

   186

	/**

   187

	 * Mark the sign of a station dirty for repaint.

   188

	 *

   189

	 * @ingroup dirty

   190

	 */

   191

	void MarkDirty() const;

   192

   193

	/**

   194

	 * Marks the tiles of the station as dirty.

   195

	 *

   196

	 * @ingroup dirty

   197

	 */

   198

	void MarkTilesDirty(bool cargo_change) const;

   199

	bool TileBelongsToRailStation(TileIndex tile) const;

   200

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   201

	uint GetPlatformLength(TileIndex tile) const;

   202

	bool IsBuoy() const;

   203

   204

	/**

   205

	 * Determines whether a station exists

   206

	 * @return true if and only is the station exists

   207

	 */

   208

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

   209

};

   210

   211

static inline StationID GetMaxStationIndex()

   212

{

   213

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

   214

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

   215

	 *  _really_ returns the highest index. Now it just returns

   216

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

   217

	 */

   218

	return GetStationPoolSize() - 1;

   219

}

   220

   221

static inline uint GetNumStations()

   222

{

   223

	return GetStationPoolSize();

   224

}

   225

   226

static inline bool IsValidStationID(StationID index)

   227

{

   228

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

   229

}

   230

   231

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

   232

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

   233

   234

   235

/* Stuff for ROADSTOPS */

   236

   237

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

   238

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

   239

   240

/* End of stuff for ROADSTOPS */

   241

   242

#endif /* STATION_BASE_H */