1

/* $Id$ */

     2

     3

#ifndef STATION_H

     4

#define STATION_H

     5

     6

#include <deque>

     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;

    14

    15

typedef struct GoodsEntry {

    16

	GoodsEntry() :

    17

		waiting_acceptance(0),

    18

		days_since_pickup(0),

    19

		rating(175),

    20

		enroute_from(INVALID_STATION),

    21

		enroute_from_xy(INVALID_TILE),

    22

		last_speed(0),

    23

		last_age(255),

    24

		feeder_profit(0)

    25

	{}

    26

    27

	uint16 waiting_acceptance;

    28

	byte days_since_pickup;

    29

	byte rating;

    30

	StationID enroute_from;

    31

	TileIndex enroute_from_xy;

    32

	byte enroute_time;

    33

	byte last_speed;

    34

	byte last_age;

    35

	int32 feeder_profit;

    36

} GoodsEntry;

    37

    38

/** A Stop for a Road Vehicle */

    39

struct RoadStop {

    40

	/** Types of RoadStops */

    41

	enum Type {

    42

		BUS,                                ///< A standard stop for buses

    43

		TRUCK                               ///< A standard stop for trucks

    44

	};

    45

    46

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

    47

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

    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. TODO - enumify this

    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

    58

	void *operator new (size_t size);

    59

	void operator delete(void *rs);

    60

    61

	/* For loading games */

    62

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

    63

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

    64

    65

	bool IsValid() const;

    66

protected:

    67

	static RoadStop *AllocateRaw(void);

    68

};

    69

    70

typedef struct StationSpecList {

    71

	const StationSpec *spec;

    72

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

    73

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

    74

} StationSpecList;

    75

    76

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

    77

struct StationRect : public Rect {

    78

	enum StationRectMode

    79

	{

    80

		ADD_TEST = 0,

    81

		ADD_TRY,

    82

		ADD_FORCE

    83

	};

    84

    85

	StationRect();

    86

	void MakeEmpty();

    87

	bool PtInRectXY(int x, int y) const;

    88

	bool IsEmpty() const;

    89

	bool BeforeAddTile(TileIndex tile, StationRectMode mode);

    90

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

    91

	bool AfterRemoveTile(Station *st, TileIndex tile);

    92

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

    93

    94

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

    95

    96

	StationRect& operator = (Rect src);

    97

};

    98

    99

struct Station {

   100

	public:

   101

		RoadStop *GetPrimaryRoadStop(RoadStop::Type type) const

   102

		{

   103

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

   104

		}

   105

   106

	TileIndex xy;

   107

	RoadStop *bus_stops;

   108

	RoadStop *truck_stops;

   109

	TileIndex train_tile;

   110

	TileIndex airport_tile;

   111

	TileIndex dock_tile;

   112

	Town *town;

   113

	uint16 string_id;

   114

   115

	ViewportSign sign;

   116

   117

	uint16 had_vehicle_of_type;

   118

   119

	byte time_since_load;

   120

	byte time_since_unload;

   121

	byte delete_ctr;

   122

	PlayerByte owner;

   123

	byte facilities;

   124

	byte airport_type;

   125

   126

	// trainstation width/height

   127

	byte trainst_w, trainst_h;

   128

   129

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

   130

	uint8 num_specs;

   131

	StationSpecList *speclist;

   132

   133

	Date build_date;

   134

   135

	//uint16 airport_flags;

   136

	uint32 airport_flags;

   137

	StationID index;

   138

   139

	byte last_vehicle_type;

   140

	GoodsEntry goods[NUM_CARGO];

   141

   142

	uint16 random_bits;

   143

	byte waiting_triggers;

   144

   145

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

   146

   147

	static const int cDebugCtorLevel = 3;

   148

   149

	Station(TileIndex tile = 0);

   150

	~Station();

   151

   152

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

   153

	void* operator new (size_t size);

   154

	void operator delete(void *p);

   155

   156

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

   157

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

   158

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

   159

   160

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   161

	void MarkDirty() const;

   162

	void MarkTilesDirty() const;

   163

	bool TileBelongsToRailStation(TileIndex tile) const;

   164

   165

protected:

   166

	static Station *AllocateRaw(void);

   167

};

   168

   169

enum {

   170

	FACIL_TRAIN      = 0x01,

   171

	FACIL_TRUCK_STOP = 0x02,

   172

	FACIL_BUS_STOP   = 0x04,

   173

	FACIL_AIRPORT    = 0x08,

   174

	FACIL_DOCK       = 0x10,

   175

};

   176

   177

enum {

   178

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

   179

	HVOT_TRAIN    = 1 << 1,

   180

	HVOT_BUS      = 1 << 2,

   181

	HVOT_TRUCK    = 1 << 3,

   182

	HVOT_AIRCRAFT = 1 << 4,

   183

	HVOT_SHIP     = 1 << 5,

   184

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

   185

	 * can we do? ;-) */

   186

	HVOT_BUOY     = 1 << 6

   187

};

   188

   189

typedef enum CatchmentAeras {

   190

	CA_NONE            =  0,

   191

	CA_BUS             =  3,

   192

	CA_TRUCK           =  3,

   193

	CA_AIR_OILPAD      =  3,

   194

	CA_TRAIN           =  4,

   195

	CA_AIR_HELIPORT    =  4,

   196

	CA_AIR_SMALL       =  4,

   197

	CA_AIR_LARGE       =  5,

   198

	CA_DOCK            =  5,

   199

	CA_AIR_METRO       =  6,

   200

	CA_AIR_INTER       =  8,

   201

	CA_AIR_COMMUTER    =  4,

   202

	CA_AIR_HELIDEPOT   =  4,

   203

	CA_AIR_INTERCON    = 10,

   204

	CA_AIR_HELISTATION =  4,

   205

} CatchmentAera;

   206

   207

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

   208

   209

void ShowStationViewWindow(StationID station);

   210

void UpdateAllStationVirtCoord(void);

   211

   212

/* sorter stuff */

   213

void RebuildStationLists(void);

   214

void ResortStationLists(void);

   215

   216

DECLARE_OLD_POOL(Station, Station, 6, 1000)

   217

   218

static inline StationID GetMaxStationIndex(void)

   219

{

   220

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

   221

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

   222

	 *  _really_ returns the highest index. Now it just returns

   223

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

   224

	 */

   225

	return GetStationPoolSize() - 1;

   226

}

   227

   228

static inline uint GetNumStations(void)

   229

{

   230

	return GetStationPoolSize();

   231

}

   232

   233

/**

   234

 * Check if a station really exists.

   235

 */

   236

static inline bool IsValidStation(const Station *st)

   237

{

   238

	return st->xy != 0;

   239

}

   240

   241

static inline bool IsValidStationID(StationID index)

   242

{

   243

	return index < GetStationPoolSize() && IsValidStation(GetStation(index));

   244

}

   245

   246

#define FOR_ALL_STATIONS_FROM(st, start) for (st = GetStation(start); st != NULL; st = (st->index + 1U < GetStationPoolSize()) ? GetStation(st->index + 1U) : NULL) if (IsValidStation(st))

   247

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

   248

   249

   250

/* Stuff for ROADSTOPS */

   251

   252

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

   253

   254

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

   255

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

   256

   257

/* End of stuff for ROADSTOPS */

   258

   259

   260

void AfterLoadStations(void);

   261

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

   262

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

   263

uint GetStationPlatforms(const Station *st, TileIndex tile);

   264

uint GetPlatformLength(TileIndex tile, DiagDirection dir);

   265

   266

   267

const DrawTileSprites *GetStationTileLayout(byte gfx);

   268

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

   269

   270

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

   271

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

   272

RoadStop * AllocateRoadStop( void );

   273

void ClearSlot(Vehicle *v);

   274

   275

static inline bool IsBuoy(const Station* st)

   276

{

   277

	return (st->had_vehicle_of_type & HVOT_BUOY) != 0; /* XXX: We should really ditch this ugly coding and switch to something sane... */

   278

}

   279

   280

void DeleteOilRig(TileIndex t);

   281

   282

#endif /* STATION_H */