1

#ifndef STATION_H

     2

#define STATION_H

     3

     4

#include "pool.h"

     5

#include "sprite.h"

     6

#include "tile.h"

     7

#include "vehicle.h"

     8

     9

typedef struct GoodsEntry {

    10

	uint16 waiting_acceptance;

    11

	byte days_since_pickup;

    12

	byte rating;

    13

	uint16 enroute_from;

    14

	byte enroute_time;

    15

	byte last_speed;

    16

	byte last_age;

    17

	int32 feeder_profit;

    18

} GoodsEntry;

    19

    20

typedef enum RoadStopType {

    21

	RS_BUS,

    22

	RS_TRUCK

    23

} RoadStopType;

    24

    25

enum {

    26

	INVALID_STATION = 0xFFFF,

    27

	INVALID_SLOT = 0xFFFF,

    28

	NUM_SLOTS = 2,

    29

	ROAD_STOP_LIMIT = 8,

    30

};

    31

    32

typedef uint16 StationID;

    33

    34

typedef struct RoadStop {

    35

	TileIndex xy;

    36

	bool used;

    37

	byte status;

    38

	uint32 index;

    39

	uint16 slot[NUM_SLOTS];

    40

	StationID station;

    41

	uint8 type;

    42

	struct RoadStop *next;

    43

	struct RoadStop *prev;

    44

} RoadStop;

    45

    46

struct Station {

    47

	TileIndex xy;

    48

	RoadStop *bus_stops;

    49

	RoadStop *truck_stops;

    50

	TileIndex train_tile;

    51

	TileIndex airport_tile;

    52

	TileIndex dock_tile;

    53

	Town *town;

    54

	uint16 string_id;

    55

    56

	ViewportSign sign;

    57

    58

	uint16 had_vehicle_of_type;

    59

    60

	byte time_since_load;

    61

	byte time_since_unload;

    62

	byte delete_ctr;

    63

	byte owner;

    64

	byte facilities;

    65

	byte airport_type;

    66

    67

	// trainstation width/height

    68

	byte trainst_w, trainst_h;

    69

    70

	byte class_id; // custom graphics station class

    71

	byte stat_id; // custom graphics station id in the @class_id class

    72

	uint16 build_date;

    73

    74

	//uint16 airport_flags;

    75

	uint32 airport_flags;

    76

	StationID index;

    77

    78

	VehicleID last_vehicle;

    79

	GoodsEntry goods[NUM_CARGO];

    80

    81

	/* Stuff that is no longer used, but needed for conversion */

    82

	TileIndex bus_tile_obsolete;

    83

	TileIndex lorry_tile_obsolete;

    84

    85

	byte truck_stop_status_obsolete;

    86

	byte bus_stop_status_obsolete;

    87

	byte blocked_months_obsolete;

    88

};

    89

    90

enum {

    91

	FACIL_TRAIN = 1,

    92

	FACIL_TRUCK_STOP = 2,

    93

	FACIL_BUS_STOP = 4,

    94

	FACIL_AIRPORT = 8,

    95

	FACIL_DOCK = 0x10,

    96

};

    97

    98

enum {

    99

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

   100

	HVOT_TRAIN = 1<<1,

   101

	HVOT_BUS = 1 << 2,

   102

	HVOT_TRUCK = 1 << 3,

   103

	HVOT_AIRCRAFT = 1 << 4,

   104

	HVOT_SHIP = 1 << 5,

   105

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

   106

	 * can we do? ;-) */

   107

	HVOT_BUOY = 1 << 6

   108

};

   109

   110

enum {

   111

	CA_BUS = 3,

   112

	CA_TRUCK = 3,

   113

	CA_AIR_OILPAD = 3,

   114

	CA_TRAIN = 4,

   115

	CA_AIR_HELIPORT = 4,

   116

	CA_AIR_SMALL = 4,

   117

	CA_AIR_LARGE = 5,

   118

	CA_DOCK = 5,

   119

	CA_AIR_METRO = 6,

   120

	CA_AIR_INTER = 8,

   121

};

   122

   123

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

   124

   125

TileIndex GetStationTileForVehicle(const Vehicle *v, const Station *st);

   126

   127

void ShowStationViewWindow(int station);

   128

void UpdateAllStationVirtCoord(void);

   129

   130

VARDEF SortStruct *_station_sort;

   131

   132

extern MemoryPool _station_pool;

   133

   134

/**

   135

 * Get the pointer to the station with index 'index'

   136

 */

   137

static inline Station *GetStation(StationID index)

   138

{

   139

	return (Station*)GetItemFromPool(&_station_pool, index);

   140

}

   141

   142

/**

   143

 * Get the current size of the StationPool

   144

 */

   145

static inline uint16 GetStationPoolSize(void)

   146

{

   147

	return _station_pool.total_items;

   148

}

   149

   150

static inline bool IsStationIndex(uint index)

   151

{

   152

	return index < GetStationPoolSize();

   153

}

   154

   155

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

   156

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

   157

   158

   159

/* Stuff for ROADSTOPS */

   160

   161

extern MemoryPool _roadstop_pool;

   162

   163

/**

   164

 * Get the pointer to the roadstop with index 'index'

   165

 */

   166

static inline RoadStop *GetRoadStop(uint index)

   167

{

   168

	return (RoadStop*)GetItemFromPool(&_roadstop_pool, index);

   169

}

   170

   171

/**

   172

 * Get the current size of the RoadStoptPool

   173

 */

   174

static inline uint16 GetRoadStopPoolSize(void)

   175

{

   176

	return _roadstop_pool.total_items;

   177

}

   178

   179

#define FOR_ALL_ROADSTOPS_FROM(rs, start) for (rs = GetRoadStop(start); rs != NULL; rs = (rs->index + 1 < GetRoadStopPoolSize()) ? GetRoadStop(rs->index + 1) : NULL)

   180

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

   181

   182

/* End of stuff for ROADSTOPS */

   183

   184

   185

VARDEF bool _station_sort_dirty[MAX_PLAYERS];

   186

VARDEF bool _global_station_sort_dirty;

   187

   188

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

   189

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

   190

uint GetStationPlatforms(Station *st, TileIndex tile);

   191

   192

   193

/* Station layout for given dimensions - it is a two-dimensional array

   194

 * where index is computed as (x * platforms) + platform. */

   195

typedef byte *StationLayout;

   196

   197

typedef enum StationClass {

   198

	STAT_CLASS_NONE, // unused station slot or so

   199

	STAT_CLASS_DFLT, // default station class

   200

	STAT_CLASS_WAYP, // waypoints

   201

   202

	/* TODO: When we actually support custom classes, they are

   203

	 * going to be allocated dynamically (with some classid->sclass

   204

	 * mapping, there's a TTDPatch limit on 16 custom classes in

   205

	 * the whole game at the same time) with base at

   206

	 * STAT_CLASS_CUSTOM. --pasky */

   207

	STAT_CLASS_CUSTOM, // some custom class

   208

} StationClass;

   209

   210

typedef struct StationSpec {

   211

	uint32 grfid;

   212

	int localidx; // per-GRFFile station index + 1; SetCustomStation() takes care of this

   213

   214

	StationClass sclass;

   215

   216

	/* Bitmask of platform numbers/lengths available for the station.  Bits

   217

	 * 0..6 correspond to 1..7, while bit 7 corresponds to >7 platforms or

   218

	 * lenght. */

   219

	byte allowed_platforms;

   220

	byte allowed_lengths;

   221

   222

	/* Custom sprites */

   223

	byte tiles;

   224

	/* 00 = plain platform

   225

	 * 02 = platform with building

   226

	 * 04 = platform with roof, left side

   227

	 * 06 = platform with roof, right side

   228

	 *

   229

	 * These numbers are used for stations in NE-SW direction, or these

   230

	 * numbers plus one for stations in the NW-SE direction.  */

   231

	DrawTileSprites renderdata[8];

   232

   233

	/* Custom layouts */

   234

	/* The layout array is organized like [lenghts][platforms], both being

   235

	 * dynamic arrays, the field itself is length*platforms array containing

   236

	 * indexes to @renderdata (only even numbers allowed) for the given

   237

	 * station tile. */

   238

	/* @lengths is length of the @platforms and @layouts arrays, that is

   239

	 * number of maximal length for which the layout is defined (since

   240

	 * arrays are indexed from 0, the length itself is at [length - 1]). */

   241

	byte lengths;

   242

	/* @platforms is array of number of platforms defined for each length.

   243

	 * Zero means no platforms defined. */

   244

	byte *platforms;

   245

	/* @layout is @layouts-sized array of @platforms-sized arrays,

   246

	 * containing pointers to length*platforms-sized arrays or NULL if

   247

	 * default OTTD station layout should be used for stations of these

   248

	 * dimensions. */

   249

	StationLayout **layouts;

   250

   251

	/* Sprite offsets for renderdata->seq->image. spritegroup[0] is default

   252

	 * whilst spritegroup[1] is "GC_PURCHASE". */

   253

	SpriteGroup spritegroup[2];

   254

} StationSpec;

   255

   256

/* Here, @stid is local per-GRFFile station index. If spec->localidx is not yet

   257

 * set, it gets new dynamically allocated global index and spec->localidx is

   258

 * set to @stid, otherwise we take it as that we are replacing it and try to

   259

 * search for it first (that isn't much fast but we do it only very seldom). */

   260

void SetCustomStation(byte stid, StationSpec *spec);

   261

/* Here, @stid is global station index (in continous range 0..GetCustomStationsCount())

   262

 * (lookup is therefore very fast as we do this very frequently). */

   263

StationSpec *GetCustomStation(StationClass sclass, byte stid);

   264

/* Get sprite offset for a given custom station and station structure (may be

   265

 * NULL if ctype is set - that means we are in a build dialog). The station

   266

 * structure is used for variational sprite groups. */

   267

uint32 GetCustomStationRelocation(StationSpec *spec, Station *stat, byte ctype);

   268

int GetCustomStationsCount(StationClass sclass);

   269

   270

RoadStop * GetRoadStopByTile(TileIndex tile, RoadStopType type);

   271

static inline int GetRoadStopType(TileIndex tile)

   272

{

   274

}

   275

   276

uint GetNumRoadStops(const Station *st, RoadStopType type);

   277

RoadStop * GetPrimaryRoadStop(const Station *st, RoadStopType type);

   278

RoadStop * AllocateRoadStop( void );

   279

void ClearSlot(Vehicle *v, RoadStop *rs);

   280

   281

static inline bool IsTrainStationTile(TileIndex tile)

   282

{

   284

}

   285

   286

static inline bool IsCompatibleTrainStationTile(TileIndex tile, TileIndex ref)

   287

{

   288

	assert(IsTrainStationTile(ref));

   289

	return

   290

		IsTrainStationTile(tile) &&

   293

}

   294

   295

static inline bool IsRoadStationTile(TileIndex tile) {

   297

}

   298

   299

/**

   300

 * Check if a station really exists.

   301

 */

   302

static inline bool IsValidStation(const Station *st)

   303

{

   304

	return st->xy != 0; /* XXX: Replace by INVALID_TILE someday */

   305

}

   306

   307

static inline bool IsBuoy(const Station* st)

   308

{

   309

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

   310

}

   311

   312

static inline bool IsBuoyTile(TileIndex tile) {

   314

}

   315

   316

/* Get's the direction the station exit points towards. Ie, returns 0 for a

   317

 * station with the exit NE. */

   318

static inline byte GetRoadStationDir(TileIndex tile)

   319

{

   320

	assert(IsRoadStationTile(tile));

   322

}

   323

   324

#endif /* STATION_H */