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 <list>

    16

    17

static const StationID INVALID_STATION = 0xFFFF;

    18

static const byte INITIAL_STATION_RATING = 175;

    19

    20

struct GoodsEntry {

    21

	GoodsEntry() :

    22

		waiting_acceptance(0),

    23

		unload_pending(0),

    24

		days_since_pickup(0),

    25

		rating(INITIAL_STATION_RATING),

    26

		enroute_from(INVALID_STATION),

    27

		enroute_from_xy(INVALID_TILE),

    28

		last_speed(0),

    29

		last_age(255),

    30

		feeder_profit(0)

    31

	{}

    32

    33

	uint16 waiting_acceptance;

    34

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

    35

	byte days_since_pickup;

    36

	byte rating;

    37

	StationID enroute_from;

    38

	TileIndex enroute_from_xy;

    39

	byte enroute_time;

    40

	byte last_speed;

    41

	byte last_age;

    42

	int32 feeder_profit;

    43

};

    44

    45

/** A Stop for a Road Vehicle */

    46

struct RoadStop {

    47

	/** Types of RoadStops */

    48

	enum Type {

    49

		BUS,                                ///< A standard stop for buses

    50

		TRUCK                               ///< A standard stop for trucks

    51

	};

    52

    53

	static const int  cDebugCtorLevel =  3;  ///< 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

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

    59

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

    60

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

    61

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

    62

    63

	RoadStop(TileIndex tile);

    64

	~RoadStop();

    65

    66

	void *operator new (size_t size);

    67

	void operator delete(void *rs);

    68

    69

	/* For loading games */

    70

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

    71

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

    72

    73

	bool IsValid() const;

    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

protected:

    84

	static RoadStop *AllocateRaw();

    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 {

   117

	public:

   118

		RoadStop *GetPrimaryRoadStop(RoadStop::Type type) const

   119

		{

   120

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

   121

		}

   122

   123

		const AirportFTAClass *Airport() const

   124

		{

   125

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

   126

			return GetAirport(airport_type);

   127

		}

   128

   129

	TileIndex xy;

   130

	RoadStop *bus_stops;

   131

	RoadStop *truck_stops;

   132

	TileIndex train_tile;

   133

	TileIndex airport_tile;

   134

	TileIndex dock_tile;

   135

	Town *town;

   136

	uint16 string_id;

   137

   138

	ViewportSign sign;

   139

   140

	uint16 had_vehicle_of_type;

   141

   142

	byte time_since_load;

   143

	byte time_since_unload;

   144

	byte delete_ctr;

   145

	PlayerByte owner;

   146

	byte facilities;

   147

	byte airport_type;

   148

   149

	/* trainstation width/height */

   150

	byte trainst_w, trainst_h;

   151

   152

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

   153

	uint8 num_specs;

   154

	StationSpecList *speclist;

   155

   156

	Date build_date;

   157

   158

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

   159

	StationID index;

   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 = 3;

   171

   172

	Station(TileIndex tile = 0);

   173

	~Station();

   174

   175

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

   176

	void* operator new (size_t size);

   177

	void operator delete(void *p);

   178

   179

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

   180

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

   181

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

   182

   183

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   184

	void MarkDirty() const;

   186

	bool TileBelongsToRailStation(TileIndex tile) const;

   187

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   188

	uint GetPlatformLength(TileIndex tile) const;

   189

	bool IsBuoy() const;

   190

	bool IsValid() const;

   191

   192

protected:

   193

	static Station *AllocateRaw();

   194

};

   195

   196

enum {

   197

	FACIL_TRAIN      = 0x01,

   198

	FACIL_TRUCK_STOP = 0x02,

   199

	FACIL_BUS_STOP   = 0x04,

   200

	FACIL_AIRPORT    = 0x08,

   201

	FACIL_DOCK       = 0x10,

   202

};

   203

   204

enum {

   205

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

   206

	HVOT_TRAIN    = 1 << 1,

   207

	HVOT_BUS      = 1 << 2,

   208

	HVOT_TRUCK    = 1 << 3,

   209

	HVOT_AIRCRAFT = 1 << 4,

   210

	HVOT_SHIP     = 1 << 5,

   211

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

   212

	 * can we do? ;-) */

   213

	HVOT_BUOY     = 1 << 6

   214

};

   215

   216

enum CatchmentArea {

   217

	CA_NONE            =  0,

   218

	CA_BUS             =  3,

   219

	CA_TRUCK           =  3,

   220

	CA_TRAIN           =  4,

   221

	CA_DOCK            =  5

   222

};

   223

   224

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

   225

   226

void ShowStationViewWindow(StationID station);

   227

void UpdateAllStationVirtCoord();

   228

   229

/* sorter stuff */

   230

void RebuildStationLists();

   231

void ResortStationLists();

   232

   233

DECLARE_OLD_POOL(Station, Station, 6, 1000)

   234

   235

static inline StationID GetMaxStationIndex()

   236

{

   237

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

   238

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

   239

	 *  _really_ returns the highest index. Now it just returns

   240

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

   241

	 */

   242

	return GetStationPoolSize() - 1;

   243

}

   244

   245

static inline uint GetNumStations()

   246

{

   247

	return GetStationPoolSize();

   248

}

   249

   250

static inline bool IsValidStationID(StationID index)

   251

{

   252

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

   253

}

   254

   255

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

   256

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

   257

   258

   259

/* Stuff for ROADSTOPS */

   260

   261

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

   262

   263

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

   264

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

   265

   266

/* End of stuff for ROADSTOPS */

   267

   268

   269

void AfterLoadStations();

   270

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

   271

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

   272

   273

   274

const DrawTileSprites *GetStationTileLayout(byte gfx);

   275

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

   276

   277

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

   278

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

   279

RoadStop * AllocateRoadStop();

   280

void ClearSlot(Vehicle *v);

   281

   282

void DeleteOilRig(TileIndex t);

   283

   284

#endif /* STATION_H */