1

/* $Id$ */

     2

     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"

    14

    15

static const StationID INVALID_STATION = 0xFFFF;

    16

static const byte INITIAL_STATION_RATING = 175;

    17

    18

struct GoodsEntry {

    19

	GoodsEntry() :

    20

		waiting_acceptance(0),

    21

		unload_pending(0),

    22

		days_since_pickup(0),

    23

		rating(INITIAL_STATION_RATING),

    24

		enroute_from(INVALID_STATION),

    25

		enroute_from_xy(INVALID_TILE),

    26

		last_speed(0),

    27

		last_age(255),

    28

		feeder_profit(0)

    29

	{}

    30

    31

	uint16 waiting_acceptance;

    32

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

    33

	byte days_since_pickup;

    34

	byte rating;

    35

	StationID enroute_from;

    36

	TileIndex enroute_from_xy;

    37

	byte enroute_time;

    38

	byte last_speed;

    39

	byte last_age;

    40

	int32 feeder_profit;

    41

};

    42

    43

/** A Stop for a Road Vehicle */

    44

struct RoadStop {

    45

	/** Types of RoadStops */

    46

	enum Type {

    47

		BUS,                                ///< A standard stop for buses

    48

		TRUCK                               ///< A standard stop for trucks

    49

	};

    50

    51

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

    52

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

    53

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

    54

    55

	TileIndex        xy;                    ///< Position on the map

    56

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

    57

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

    58

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

    59

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

    60

    61

	RoadStop(TileIndex tile);

    62

	~RoadStop();

    63

    64

	void *operator new (size_t size);

    65

	void operator delete(void *rs);

    66

    67

	/* For loading games */

    68

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

    69

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

    70

    71

	bool IsValid() const;

    72

    73

	/* For accessing status */

    74

	bool HasFreeBay() const;

    75

	bool IsFreeBay(uint nr) const;

    76

	uint AllocateBay();

    77

	void AllocateDriveThroughBay(uint nr);

    78

	void FreeBay(uint nr);

    79

	bool IsEntranceBusy() const;

    80

	void SetEntranceBusy(bool busy);

    81

protected:

    82

	static RoadStop *AllocateRaw();

    83

};

    84

    85

struct StationSpecList {

    86

	const StationSpec *spec;

    89

};

    90

    91

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

    92

struct StationRect : public Rect {

    93

	enum StationRectMode

    94

	{

    95

		ADD_TEST = 0,

    96

		ADD_TRY,

    97

		ADD_FORCE

    98

	};

    99

   100

	StationRect();

   101

	void MakeEmpty();

   102

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

   103

	bool IsEmpty() const;

   104

	bool BeforeAddTile(TileIndex tile, StationRectMode mode);

   105

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

   106

	bool AfterRemoveTile(Station *st, TileIndex tile);

   107

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

   108

   109

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

   110

   111

	StationRect& operator = (Rect src);

   112

};

   113

   114

struct Station {

   115

	public:

   116

		RoadStop *GetPrimaryRoadStop(RoadStop::Type type) const

   117

		{

   118

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

   119

		}

   120

   121

		const AirportFTAClass *Airport() const

   122

		{

   123

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

   124

			return GetAirport(airport_type);

   125

		}

   126

   127

	TileIndex xy;

   128

	RoadStop *bus_stops;

   129

	RoadStop *truck_stops;

   130

	TileIndex train_tile;

   131

	TileIndex airport_tile;

   132

	TileIndex dock_tile;

   133

	Town *town;

   134

	uint16 string_id;

   135

   136

	ViewportSign sign;

   137

   138

	uint16 had_vehicle_of_type;

   139

   140

	byte time_since_load;

   141

	byte time_since_unload;

   142

	byte delete_ctr;

   143

	PlayerByte owner;

   144

	byte facilities;

   145

	byte airport_type;

   146

   148

	byte trainst_w, trainst_h;

   149

   150

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

   151

	uint8 num_specs;

   152

	StationSpecList *speclist;

   153

   154

	Date build_date;

   155

   157

	StationID index;

   158

   159

	byte last_vehicle_type;

   160

	GoodsEntry goods[NUM_CARGO];

   161

   162

	uint16 random_bits;

   163

	byte waiting_triggers;

   164

   165

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

   166

   167

	static const int cDebugCtorLevel = 3;

   168

   169

	Station(TileIndex tile = 0);

   170

	~Station();

   171

   172

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

   173

	void* operator new (size_t size);

   174

	void operator delete(void *p);

   175

   176

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

   177

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

   178

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

   179

   180

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   181

	void MarkDirty() const;

   182

	void MarkTilesDirty() const;

   183

	bool TileBelongsToRailStation(TileIndex tile) const;

   184

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   185

	uint GetPlatformLength(TileIndex tile) const;

   186

	bool IsBuoy() const;

   187

	bool IsValid() const;

   188

   189

protected:

   190

	static Station *AllocateRaw();

   191

};

   192

   193

enum {

   194

	FACIL_TRAIN      = 0x01,

   195

	FACIL_TRUCK_STOP = 0x02,

   196

	FACIL_BUS_STOP   = 0x04,

   197

	FACIL_AIRPORT    = 0x08,

   198

	FACIL_DOCK       = 0x10,

   199

};

   200

   201

enum {

   202

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

   203

	HVOT_TRAIN    = 1 << 1,

   204

	HVOT_BUS      = 1 << 2,

   205

	HVOT_TRUCK    = 1 << 3,

   206

	HVOT_AIRCRAFT = 1 << 4,

   207

	HVOT_SHIP     = 1 << 5,

   208

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

   209

	 * can we do? ;-) */

   210

	HVOT_BUOY     = 1 << 6

   211

};

   212

   213

enum CatchmentArea {

   214

	CA_NONE            =  0,

   215

	CA_BUS             =  3,

   216

	CA_TRUCK           =  3,

   217

	CA_TRAIN           =  4,

   218

	CA_DOCK            =  5

   219

};

   220

   221

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

   222

   223

void ShowStationViewWindow(StationID station);

   224

void UpdateAllStationVirtCoord();

   225

   226

/* sorter stuff */

   227

void RebuildStationLists();

   228

void ResortStationLists();

   229

   230

DECLARE_OLD_POOL(Station, Station, 6, 1000)

   231

   232

static inline StationID GetMaxStationIndex()

   233

{

   234

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

   235

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

   236

	 *  _really_ returns the highest index. Now it just returns

   237

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

   238

	 */

   239

	return GetStationPoolSize() - 1;

   240

}

   241

   242

static inline uint GetNumStations()

   243

{

   244

	return GetStationPoolSize();

   245

}

   246

   247

static inline bool IsValidStationID(StationID index)

   248

{

   249

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

   250

}

   251

   252

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

   253

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

   254

   255

   256

/* Stuff for ROADSTOPS */

   257

   258

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

   259

   260

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

   261

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

   262

   263

/* End of stuff for ROADSTOPS */

   264

   265

   266

void AfterLoadStations();

   267

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

   268

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

   269

   270

   271

const DrawTileSprites *GetStationTileLayout(byte gfx);

   272

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

   273

   274

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

   275

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

   276

RoadStop * AllocateRoadStop();

   277

void ClearSlot(Vehicle *v);

   278

   279

void DeleteOilRig(TileIndex t);

   280

   281

#endif /* STATION_H */