1

/* $Id$ */

     2

     3

#ifndef STATION_H

     4

#define STATION_H

     5

     6

#include "airport.h"

     7

#include "player.h"

     8

#include "oldpool.h"

     9

#include "sprite.h"

    10

#include "tile.h"

    11

#include "newgrf_station.h"

    12

    13

static const StationID INVALID_STATION = 0xFFFF;

    14

    15

typedef struct GoodsEntry {

    16

	GoodsEntry() :

    17

		waiting_acceptance(0),

    18

		unload_pending(0),

    19

		days_since_pickup(0),

    20

		rating(175),

    21

		enroute_from(INVALID_STATION),

    22

		enroute_from_xy(INVALID_TILE),

    23

		last_speed(0),

    24

		last_age(255),

    25

		feeder_profit(0)

    26

	{}

    27

    28

	uint16 waiting_acceptance;

    29

	uint16 unload_pending;        ///< records how much cargo is awaiting transfer during gradual loading to allow correct fee calc

    30

	byte days_since_pickup;

    31

	byte rating;

    32

	StationID enroute_from;

    33

	TileIndex enroute_from_xy;

    34

	byte enroute_time;

    35

	byte last_speed;

    36

	byte last_age;

    37

	int32 feeder_profit;

    38

} GoodsEntry;

    39

    40

/** A Stop for a Road Vehicle */

    41

struct RoadStop {

    42

	/** Types of RoadStops */

    43

	enum Type {

    44

		BUS,                                ///< A standard stop for buses

    45

		TRUCK                               ///< A standard stop for trucks

    46

	};

    47

    48

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

    49

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

    50

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

    51

    52

	TileIndex        xy;                    ///< Position on the map

    53

	RoadStopID       index;                 ///< Global (i.e. pool-wide) index

    54

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

    55

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

    56

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

    57

    58

	RoadStop(TileIndex tile);

    59

	~RoadStop();

    60

    61

	void *operator new (size_t size);

    62

	void operator delete(void *rs);

    63

    64

	/* For loading games */

    65

	void *operator new (size_t size, int index);

    66

	void operator delete(void *rs, int index);

    67

    68

	bool IsValid() const;

    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

protected:

    79

	static RoadStop *AllocateRaw(void);

    80

};

    81

    82

typedef 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

} StationSpecList;

    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

struct Station {

   112

	public:

   113

		RoadStop *GetPrimaryRoadStop(RoadStop::Type type) const

   114

		{

   115

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

   116

		}

   117

   118

		const AirportFTAClass *Airport() const

   119

		{

   120

			assert(airport_tile != 0);

   121

			return GetAirport(airport_type);

   122

		}

   123

   124

	TileIndex xy;

   125

	RoadStop *bus_stops;

   126

	RoadStop *truck_stops;

   127

	TileIndex train_tile;

   128

	TileIndex airport_tile;

   129

	TileIndex dock_tile;

   130

	Town *town;

   131

	uint16 string_id;

   132

   133

	ViewportSign sign;

   134

   135

	uint16 had_vehicle_of_type;

   136

   137

	byte time_since_load;

   138

	byte time_since_unload;

   139

	byte delete_ctr;

   140

	PlayerByte owner;

   141

	byte facilities;

   142

	byte airport_type;

   143

   144

	// trainstation width/height

   145

	byte trainst_w, trainst_h;

   146

   147

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

   148

	uint8 num_specs;

   149

	StationSpecList *speclist;

   150

   151

	Date build_date;

   152

   153

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

   154

	StationID index;

   155

   156

	byte last_vehicle_type;

   157

	GoodsEntry goods[NUM_CARGO];

   158

   159

	uint16 random_bits;

   160

	byte waiting_triggers;

   161

   162

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

   163

   164

	static const int cDebugCtorLevel = 3;

   165

   166

	Station(TileIndex tile = 0);

   167

	~Station();

   168

   169

	/* normal new/delete operators. Used when building/removing station */

   170

	void* operator new (size_t size);

   171

	void operator delete(void *p);

   172

   173

	/* new/delete operators accepting station index. Used when loading station from savegame. */

   174

	void* operator new (size_t size, int st_idx);

   175

	void operator delete(void *p, int st_idx);

   176

   177

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   178

	void MarkDirty() const;

   179

	void MarkTilesDirty() const;

   180

	bool TileBelongsToRailStation(TileIndex tile) const;

   181

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   182

	uint GetPlatformLength(TileIndex tile) const;

   183

	bool IsBuoy() const;

   184

	bool IsValid() const;

   185

   186

protected:

   187

	static Station *AllocateRaw(void);

   188

};

   189

   190

enum {

   191

	FACIL_TRAIN      = 0x01,

   192

	FACIL_TRUCK_STOP = 0x02,

   193

	FACIL_BUS_STOP   = 0x04,

   194

	FACIL_AIRPORT    = 0x08,

   195

	FACIL_DOCK       = 0x10,

   196

};

   197

   198

enum {

   199

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

   200

	HVOT_TRAIN    = 1 << 1,

   201

	HVOT_BUS      = 1 << 2,

   202

	HVOT_TRUCK    = 1 << 3,

   203

	HVOT_AIRCRAFT = 1 << 4,

   204

	HVOT_SHIP     = 1 << 5,

   205

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

   206

	 * can we do? ;-) */

   207

	HVOT_BUOY     = 1 << 6

   208

};

   209

   210

typedef enum CatchmentAreas {

   211

	CA_NONE            =  0,

   212

	CA_BUS             =  3,

   213

	CA_TRUCK           =  3,

   214

	CA_TRAIN           =  4,

   215

	CA_DOCK            =  5

   216

} CatchmentArea;

   217

   218

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

   219

   220

void ShowStationViewWindow(StationID station);

   221

void UpdateAllStationVirtCoord(void);

   222

   223

/* sorter stuff */

   224

void RebuildStationLists(void);

   225

void ResortStationLists(void);

   226

   227

DECLARE_OLD_POOL(Station, Station, 6, 1000)

   228

   229

static inline StationID GetMaxStationIndex(void)

   230

{

   231

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

   232

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

   233

	 *  _really_ returns the highest index. Now it just returns

   234

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

   235

	 */

   236

	return GetStationPoolSize() - 1;

   237

}

   238

   239

static inline uint GetNumStations(void)

   240

{

   241

	return GetStationPoolSize();

   242

}

   243

   244

static inline bool IsValidStationID(StationID index)

   245

{

   246

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

   247

}

   248

   249

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

   250

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

   251

   252

   253

/* Stuff for ROADSTOPS */

   254

   255

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

   256

   257

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

   258

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

   259

   260

/* End of stuff for ROADSTOPS */

   261

   262

   263

void AfterLoadStations(void);

   264

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

   265

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

   266

   267

   268

const DrawTileSprites *GetStationTileLayout(byte gfx);

   269

void StationPickerDrawSprite(int x, int y, RailType railtype, int image);

   270

   271

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

   272

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

   273

RoadStop * AllocateRoadStop( void );

   274

void ClearSlot(Vehicle *v);

   275

   276

void DeleteOilRig(TileIndex t);

   277

   278

#endif /* STATION_H */