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

static const byte INITIAL_STATION_RATING = 175;

    19

    20

struct GoodsEntry {

    21

	GoodsEntry() :

    22

		acceptance(false),

    23

		days_since_pickup(255),

    24

		rating(INITIAL_STATION_RATING),

    25

		last_speed(0),

    26

		last_age(255)

    27

	{}

    28

    29

	bool acceptance;

    30

	byte days_since_pickup;

    31

	byte rating;

    32

	byte last_speed;

    33

	byte last_age;

    34

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

    35

};

    36

    37

/** A Stop for a Road Vehicle */

    38

struct RoadStop {

    39

	/** Types of RoadStops */

    40

	enum Type {

    41

		BUS,                                ///< A standard stop for buses

    42

		TRUCK                               ///< A standard stop for trucks

    43

	};

    44

    45

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

    46

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

    47

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

    48

    49

	TileIndex        xy;                    ///< Position on the map

    50

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

    51

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

    52

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

    53

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

    54

    55

	RoadStop(TileIndex tile);

    56

	~RoadStop();

    57

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

    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

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

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

   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

	std::list<Vehicle *> loading_vehicles;

   158

	GoodsEntry goods[NUM_CARGO];

   159

   160

	uint16 random_bits;

   161

	byte waiting_triggers;

   162

   163

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

   164

   165

	static const int cDebugCtorLevel = 3;

   166

   167

	Station(TileIndex tile = 0);

   168

	~Station();

   169

   173

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

   175

	void operator delete(void *p);

   176

   177

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

   179

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

   180

   181

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   182

	void MarkDirty() const;

   183

	void MarkTilesDirty(bool cargo_change) const;

   184

	bool TileBelongsToRailStation(TileIndex tile) const;

   185

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   186

	uint GetPlatformLength(TileIndex tile) const;

   187

	bool IsBuoy() const;

   188

	bool IsValid() const;

   189

   190

protected:

   191

	static Station *AllocateRaw();

   192

};

   193

   194

enum StationType {

   195

	STATION_RAIL,

   196

	STATION_AIRPORT,

   197

	STATION_TRUCK,

   198

	STATION_BUS,

   199

	STATION_OILRIG,

   200

	STATION_DOCK,

   201

	STATION_BUOY

   202

};

   203

   204

enum {

   205

	FACIL_TRAIN      = 0x01,

   206

	FACIL_TRUCK_STOP = 0x02,

   207

	FACIL_BUS_STOP   = 0x04,

   208

	FACIL_AIRPORT    = 0x08,

   209

	FACIL_DOCK       = 0x10,

   210

};

   211

   212

enum {

   213

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

   214

	HVOT_TRAIN    = 1 << 1,

   215

	HVOT_BUS      = 1 << 2,

   216

	HVOT_TRUCK    = 1 << 3,

   217

	HVOT_AIRCRAFT = 1 << 4,

   218

	HVOT_SHIP     = 1 << 5,

   219

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

   220

	 * can we do? ;-) */

   221

	HVOT_BUOY     = 1 << 6

   222

};

   223

   224

enum CatchmentArea {

   225

	CA_NONE            =  0,

   226

	CA_BUS             =  3,

   227

	CA_TRUCK           =  3,

   228

	CA_TRAIN           =  4,

   229

	CA_DOCK            =  5

   230

};

   231

   232

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

   233

   234

void ShowStationViewWindow(StationID station);

   235

void UpdateAllStationVirtCoord();

   236

   237

/* sorter stuff */

   238

void RebuildStationLists();

   239

void ResortStationLists();

   240

   241

DECLARE_OLD_POOL(Station, Station, 6, 1000)

   242

   243

static inline StationID GetMaxStationIndex()

   244

{

   245

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

   246

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

   247

	 *  _really_ returns the highest index. Now it just returns

   248

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

   249

	 */

   250

	return GetStationPoolSize() - 1;

   251

}

   252

   253

static inline uint GetNumStations()

   254

{

   255

	return GetStationPoolSize();

   256

}

   257

   258

static inline bool IsValidStationID(StationID index)

   259

{

   260

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

   261

}

   262

   263

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

   264

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

   265

   266

   267

/* Stuff for ROADSTOPS */

   268

   269

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

   270

   271

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

   272

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

   273

   274

/* End of stuff for ROADSTOPS */

   275

   276

   277

void AfterLoadStations();

   278

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

   279

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

   280

   281

   282

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

   283

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

   284

   285

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

   286

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

   287

RoadStop * AllocateRoadStop();

   288

void ClearSlot(Vehicle *v);

   289

   290

void DeleteOilRig(TileIndex t);

   291

   292

#endif /* STATION_H */