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;

    15

    17

	GoodsEntry() :

    18

		waiting_acceptance(0),

    19

		unload_pending(0),

    20

		days_since_pickup(0),

    22

		enroute_from(INVALID_STATION),

    23

		enroute_from_xy(INVALID_TILE),

    24

		last_speed(0),

    25

		last_age(255),

    26

		feeder_profit(0)

    27

	{}

    28

    29

	uint16 waiting_acceptance;

    30

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

    31

	byte days_since_pickup;

    32

	byte rating;

    33

	StationID enroute_from;

    34

	TileIndex enroute_from_xy;

    35

	byte enroute_time;

    36

	byte last_speed;

    37

	byte last_age;

    38

	int32 feeder_profit;

    40

    41

/** A Stop for a Road Vehicle */

    42

struct RoadStop {

    43

	/** Types of RoadStops */

    44

	enum Type {

    45

		BUS,                                ///< A standard stop for buses

    46

		TRUCK                               ///< A standard stop for trucks

    47

	};

    48

    49

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

    50

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

    51

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

    52

    53

	TileIndex        xy;                    ///< Position on the map

    54

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

    55

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

    56

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

    57

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

    58

    59

	RoadStop(TileIndex tile);

    60

	~RoadStop();

    61

    62

	void *operator new (size_t size);

    63

	void operator delete(void *rs);

    64

    65

	/* For loading games */

    66

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

    67

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

    68

    69

	bool IsValid() const;

    70

    71

	/* For accessing status */

    72

	bool HasFreeBay() const;

    73

	bool IsFreeBay(uint nr) const;

    74

	uint AllocateBay();

    75

	void AllocateDriveThroughBay(uint nr);

    76

	void FreeBay(uint nr);

    77

	bool IsEntranceBusy() const;

    78

	void SetEntranceBusy(bool busy);

    79

protected:

    81

};

    82

    84

	const StationSpec *spec;

    85

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

    86

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

    88

    89

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

    90

struct StationRect : public Rect {

    91

	enum StationRectMode

    92

	{

    93

		ADD_TEST = 0,

    94

		ADD_TRY,

    95

		ADD_FORCE

    96

	};

    97

    98

	StationRect();

    99

	void MakeEmpty();

   100

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

   101

	bool IsEmpty() const;

   102

	bool BeforeAddTile(TileIndex tile, StationRectMode mode);

   103

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

   104

	bool AfterRemoveTile(Station *st, TileIndex tile);

   105

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

   106

   107

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

   108

   109

	StationRect& operator = (Rect src);

   110

};

   111

   112

struct Station {

   113

	public:

   114

		RoadStop *GetPrimaryRoadStop(RoadStop::Type type) const

   115

		{

   116

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

   117

		}

   118

   119

		const AirportFTAClass *Airport() const

   120

		{

   121

			assert(airport_tile != 0);

   122

			return GetAirport(airport_type);

   123

		}

   124

   125

	TileIndex xy;

   126

	RoadStop *bus_stops;

   127

	RoadStop *truck_stops;

   128

	TileIndex train_tile;

   129

	TileIndex airport_tile;

   130

	TileIndex dock_tile;

   131

	Town *town;

   132

	uint16 string_id;

   133

   134

	ViewportSign sign;

   135

   136

	uint16 had_vehicle_of_type;

   137

   138

	byte time_since_load;

   139

	byte time_since_unload;

   140

	byte delete_ctr;

   141

	PlayerByte owner;

   142

	byte facilities;

   143

	byte airport_type;

   144

   145

	// trainstation width/height

   146

	byte trainst_w, trainst_h;

   147

   148

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

   149

	uint8 num_specs;

   150

	StationSpecList *speclist;

   151

   152

	Date build_date;

   153

   154

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

   155

	StationID index;

   156

   157

	byte last_vehicle_type;

   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

   170

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

   171

	void* operator new (size_t size);

   172

	void operator delete(void *p);

   173

   174

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

   175

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

   176

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

   177

   178

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   179

	void MarkDirty() const;

   180

	void MarkTilesDirty() const;

   181

	bool TileBelongsToRailStation(TileIndex tile) const;

   182

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   183

	uint GetPlatformLength(TileIndex tile) const;

   184

	bool IsBuoy() const;

   185

	bool IsValid() const;

   186

   187

protected:

   189

};

   190

   191

enum {

   192

	FACIL_TRAIN      = 0x01,

   193

	FACIL_TRUCK_STOP = 0x02,

   194

	FACIL_BUS_STOP   = 0x04,

   195

	FACIL_AIRPORT    = 0x08,

   196

	FACIL_DOCK       = 0x10,

   197

};

   198

   199

enum {

   200

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

   201

	HVOT_TRAIN    = 1 << 1,

   202

	HVOT_BUS      = 1 << 2,

   203

	HVOT_TRUCK    = 1 << 3,

   204

	HVOT_AIRCRAFT = 1 << 4,

   205

	HVOT_SHIP     = 1 << 5,

   206

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

   207

	 * can we do? ;-) */

   208

	HVOT_BUOY     = 1 << 6

   209

};

   210

   212

	CA_NONE            =  0,

   213

	CA_BUS             =  3,

   214

	CA_TRUCK           =  3,

   215

	CA_TRAIN           =  4,

   216

	CA_DOCK            =  5

   218

   219

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

   220

   221

void ShowStationViewWindow(StationID station);

   223

   224

/* sorter stuff */

   227

   228

DECLARE_OLD_POOL(Station, Station, 6, 1000)

   229

   231

{

   232

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

   233

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

   234

	 *  _really_ returns the highest index. Now it just returns

   235

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

   236

	 */

   237

	return GetStationPoolSize() - 1;

   238

}

   239

   241

{

   242

	return GetStationPoolSize();

   243

}

   244

   245

static inline bool IsValidStationID(StationID index)

   246

{

   247

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

   248

}

   249

   250

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

   251

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

   252

   253

   254

/* Stuff for ROADSTOPS */

   255

   256

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

   257

   258

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

   259

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

   260

   261

/* End of stuff for ROADSTOPS */

   262

   263

   265

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

   266

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

   267

   268

   269

const DrawTileSprites *GetStationTileLayout(byte gfx);

   270

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

   271

   272

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

   273

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

   275

void ClearSlot(Vehicle *v);

   276

   277

void DeleteOilRig(TileIndex t);

   278

   279

#endif /* STATION_H */