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

    15

    16

static const StationID INVALID_STATION = 0xFFFF;

    17

static const byte INITIAL_STATION_RATING = 175;

    18

    19

struct GoodsEntry {

    20

	GoodsEntry() :

    21

		waiting_acceptance(0),

    22

		unload_pending(0),

    23

		days_since_pickup(0),

    24

		rating(INITIAL_STATION_RATING),

    25

		enroute_from(INVALID_STATION),

    26

		enroute_from_xy(INVALID_TILE),

    27

		last_speed(0),

    28

		last_age(255),

    29

		feeder_profit(0)

    30

	{}

    31

    32

	uint16 waiting_acceptance;

    33

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

    34

	byte days_since_pickup;

    35

	byte rating;

    36

	StationID enroute_from;

    37

	TileIndex enroute_from_xy;

    38

	byte enroute_time;

    39

	byte last_speed;

    40

	byte last_age;

    41

	int32 feeder_profit;

    42

};

    43

    44

/** A Stop for a Road Vehicle */

    45

struct RoadStop {

    46

	/** Types of RoadStops */

    47

	enum Type {

    48

		BUS,                                ///< A standard stop for buses

    49

		TRUCK                               ///< A standard stop for trucks

    50

	};

    51

    52

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

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

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

    63

	~RoadStop();

    64

    65

	void *operator new (size_t size);

    66

	void operator delete(void *rs);

    67

    68

	/* For loading games */

    69

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

    70

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

    71

    72

	bool IsValid() const;

    73

    74

	/* For accessing status */

    75

	bool HasFreeBay() const;

    76

	bool IsFreeBay(uint nr) const;

    77

	uint AllocateBay();

    78

	void AllocateDriveThroughBay(uint nr);

    79

	void FreeBay(uint nr);

    80

	bool IsEntranceBusy() const;

    81

	void SetEntranceBusy(bool busy);

    82

protected:

    83

	static RoadStop *AllocateRaw();

    84

};

    85

    86

struct StationSpecList {

    87

	const StationSpec *spec;

    88

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

    89

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

    90

};

    91

    92

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

    93

struct StationRect : public Rect {

    94

	enum StationRectMode

    95

	{

    96

		ADD_TEST = 0,

    97

		ADD_TRY,

    98

		ADD_FORCE

    99

	};

   100

   101

	StationRect();

   102

	void MakeEmpty();

   103

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

   104

	bool IsEmpty() const;

   105

	bool BeforeAddTile(TileIndex tile, StationRectMode mode);

   106

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

   107

	bool AfterRemoveTile(Station *st, TileIndex tile);

   108

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

   109

   110

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

   111

   112

	StationRect& operator = (Rect src);

   113

};

   114

   115

struct Station {

   116

	public:

   117

		RoadStop *GetPrimaryRoadStop(RoadStop::Type type) const

   118

		{

   119

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

   120

		}

   121

   122

		const AirportFTAClass *Airport() const

   123

		{

   124

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

   125

			return GetAirport(airport_type);

   126

		}

   127

   128

	TileIndex xy;

   129

	RoadStop *bus_stops;

   130

	RoadStop *truck_stops;

   131

	TileIndex train_tile;

   132

	TileIndex airport_tile;

   133

	TileIndex dock_tile;

   134

	Town *town;

   135

	uint16 string_id;

   136

   137

	ViewportSign sign;

   138

   139

	uint16 had_vehicle_of_type;

   140

   141

	byte time_since_load;

   142

	byte time_since_unload;

   143

	byte delete_ctr;

   144

	PlayerByte owner;

   145

	byte facilities;

   146

	byte airport_type;

   147

   148

	/* trainstation width/height */

   149

	byte trainst_w, trainst_h;

   150

   151

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

   152

	uint8 num_specs;

   153

	StationSpecList *speclist;

   154

   155

	Date build_date;

   156

   157

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

   158

	StationID index;

   159

   160

	byte last_vehicle_type;

   162

	GoodsEntry goods[NUM_CARGO];

   163

   164

	uint16 random_bits;

   165

	byte waiting_triggers;

   166

   167

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

   168

   169

	static const int cDebugCtorLevel = 3;

   170

   171

	Station(TileIndex tile = 0);

   172

	~Station();

   173

   174

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

   175

	void* operator new (size_t size);

   176

	void operator delete(void *p);

   177

   178

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

   179

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

   180

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

   181

   182

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   183

	void MarkDirty() const;

   184

	void MarkTilesDirty() const;

   185

	bool TileBelongsToRailStation(TileIndex tile) const;

   186

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   187

	uint GetPlatformLength(TileIndex tile) const;

   188

	bool IsBuoy() const;

   189

	bool IsValid() const;

   190

   191

protected:

   192

	static Station *AllocateRaw();

   193

};

   194

   195

enum {

   196

	FACIL_TRAIN      = 0x01,

   197

	FACIL_TRUCK_STOP = 0x02,

   198

	FACIL_BUS_STOP   = 0x04,

   199

	FACIL_AIRPORT    = 0x08,

   200

	FACIL_DOCK       = 0x10,

   201

};

   202

   203

enum {

   204

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

   205

	HVOT_TRAIN    = 1 << 1,

   206

	HVOT_BUS      = 1 << 2,

   207

	HVOT_TRUCK    = 1 << 3,

   208

	HVOT_AIRCRAFT = 1 << 4,

   209

	HVOT_SHIP     = 1 << 5,

   210

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

   211

	 * can we do? ;-) */

   212

	HVOT_BUOY     = 1 << 6

   213

};

   214

   215

enum CatchmentArea {

   216

	CA_NONE            =  0,

   217

	CA_BUS             =  3,

   218

	CA_TRUCK           =  3,

   219

	CA_TRAIN           =  4,

   220

	CA_DOCK            =  5

   221

};

   222

   223

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

   224

   225

void ShowStationViewWindow(StationID station);

   226

void UpdateAllStationVirtCoord();

   227

   228

/* sorter stuff */

   229

void RebuildStationLists();

   230

void ResortStationLists();

   231

   232

DECLARE_OLD_POOL(Station, Station, 6, 1000)

   233

   234

static inline StationID GetMaxStationIndex()

   235

{

   236

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

   237

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

   238

	 *  _really_ returns the highest index. Now it just returns

   239

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

   240

	 */

   241

	return GetStationPoolSize() - 1;

   242

}

   243

   244

static inline uint GetNumStations()

   245

{

   246

	return GetStationPoolSize();

   247

}

   248

   249

static inline bool IsValidStationID(StationID index)

   250

{

   251

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

   252

}

   253

   254

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

   255

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

   256

   257

   258

/* Stuff for ROADSTOPS */

   259

   260

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

   261

   262

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

   263

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

   264

   265

/* End of stuff for ROADSTOPS */

   266

   267

   268

void AfterLoadStations();

   269

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

   270

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

   271

   272

   273

const DrawTileSprites *GetStationTileLayout(byte gfx);

   274

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

   275

   276

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

   277

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

   278

RoadStop * AllocateRoadStop();

   279

void ClearSlot(Vehicle *v);

   280

   281

void DeleteOilRig(TileIndex t);

   282

   283

#endif /* STATION_H */