1

/* $Id$ */

     2

     3

/** @file rail.h */

     4

     5

#ifndef RAIL_H

     6

#define RAIL_H

     7

     8

#include "direction.h"

     9

#include "tile.h"

    10

    11

typedef enum RailTypes {

    12

	RAILTYPE_RAIL     = 0,

    13

	RAILTYPE_ELECTRIC = 1,

    14

	RAILTYPE_MONO     = 2,

    15

	RAILTYPE_MAGLEV   = 3,

    16

	RAILTYPE_END,

    17

	INVALID_RAILTYPE = 0xFF

    18

} RailType;

    19

    20

typedef byte RailTypeMask;

    21

    22

    23

/** These are used to specify a single track.

    24

 * Can be translated to a trackbit with TrackToTrackbit */

    25

typedef enum Track {

    26

	TRACK_X     = 0,

    27

	TRACK_Y     = 1,

    28

	TRACK_UPPER = 2,

    29

	TRACK_LOWER = 3,

    30

	TRACK_LEFT  = 4,

    31

	TRACK_RIGHT = 5,

    32

	TRACK_END,

    33

	INVALID_TRACK = 0xFF

    34

} Track;

    35

    36

    37

/** Bitfield corresponding to Track */

    38

typedef enum TrackBits {

    39

	TRACK_BIT_NONE  = 0U,

    40

	TRACK_BIT_X     = 1U << TRACK_X,

    41

	TRACK_BIT_Y     = 1U << TRACK_Y,

    42

	TRACK_BIT_UPPER = 1U << TRACK_UPPER,

    43

	TRACK_BIT_LOWER = 1U << TRACK_LOWER,

    44

	TRACK_BIT_LEFT  = 1U << TRACK_LEFT,

    45

	TRACK_BIT_RIGHT = 1U << TRACK_RIGHT,

    46

	TRACK_BIT_CROSS = TRACK_BIT_X     | TRACK_BIT_Y,

    47

	TRACK_BIT_HORZ  = TRACK_BIT_UPPER | TRACK_BIT_LOWER,

    48

	TRACK_BIT_VERT  = TRACK_BIT_LEFT  | TRACK_BIT_RIGHT,

    49

	TRACK_BIT_3WAY_NE = TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

    50

	TRACK_BIT_3WAY_SE = TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

    51

	TRACK_BIT_3WAY_SW = TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

    52

	TRACK_BIT_3WAY_NW = TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

    53

	TRACK_BIT_ALL   = TRACK_BIT_CROSS | TRACK_BIT_HORZ | TRACK_BIT_VERT,

    54

	TRACK_BIT_MASK  = 0x3FU

    55

} TrackBits;

    56

    57

    58

/** These are a combination of tracks and directions. Values are 0-5 in one

    59

direction (corresponding to the Track enum) and 8-13 in the other direction. */

    60

typedef enum Trackdirs {

    61

	TRACKDIR_X_NE = 0,

    62

	TRACKDIR_Y_SE = 1,

    63

	TRACKDIR_UPPER_E  = 2,

    64

	TRACKDIR_LOWER_E  = 3,

    65

	TRACKDIR_LEFT_S   = 4,

    66

	TRACKDIR_RIGHT_S  = 5,

    67

	/* Note the two missing values here. This enables trackdir -> track

    68

	 * conversion by doing (trackdir & 7) */

    69

	TRACKDIR_X_SW = 8,

    70

	TRACKDIR_Y_NW = 9,

    71

	TRACKDIR_UPPER_W  = 10,

    72

	TRACKDIR_LOWER_W  = 11,

    73

	TRACKDIR_LEFT_N   = 12,

    74

	TRACKDIR_RIGHT_N  = 13,

    75

	TRACKDIR_END,

    76

	INVALID_TRACKDIR  = 0xFF,

    77

} Trackdir;

    78

    79

/** These are a combination of tracks and directions. Values are 0-5 in one

    80

direction (corresponding to the Track enum) and 8-13 in the other direction. */

    81

typedef enum TrackdirBits {

    82

	TRACKDIR_BIT_NONE     = 0x0,

    83

	TRACKDIR_BIT_X_NE     = 0x1,

    84

	TRACKDIR_BIT_Y_SE     = 0x2,

    85

	TRACKDIR_BIT_UPPER_E  = 0x4,

    86

	TRACKDIR_BIT_LOWER_E  = 0x8,

    87

	TRACKDIR_BIT_LEFT_S   = 0x10,

    88

	TRACKDIR_BIT_RIGHT_S  = 0x20,

    89

	/* Again, note the two missing values here. This enables trackdir -> track conversion by doing (trackdir & 0xFF) */

    90

	TRACKDIR_BIT_X_SW     = 0x0100,

    91

	TRACKDIR_BIT_Y_NW     = 0x0200,

    92

	TRACKDIR_BIT_UPPER_W  = 0x0400,

    93

	TRACKDIR_BIT_LOWER_W  = 0x0800,

    94

	TRACKDIR_BIT_LEFT_N   = 0x1000,

    95

	TRACKDIR_BIT_RIGHT_N  = 0x2000,

    96

	TRACKDIR_BIT_MASK			= 0x3F3F,

    97

	INVALID_TRACKDIR_BIT  = 0xFFFF,

    98

} TrackdirBits;

    99

   100

/** This struct contains all the info that is needed to draw and construct tracks.

   101

 */

   102

typedef struct RailtypeInfo {

   103

	/** Struct containing the main sprites. @note not all sprites are listed, but only

   104

	 *  the ones used directly in the code */

   105

	struct {

   106

		SpriteID track_y;      ///< single piece of rail in Y direction, with ground

   107

		SpriteID track_ns;     ///< two pieces of rail in North and South corner (East-West direction)

   108

		SpriteID ground;       ///< ground sprite for a 3-way switch

   109

		SpriteID single_y;     ///< single piece of rail in Y direction, without ground

   110

		SpriteID single_x;     ///< single piece of rail in X direction

   111

		SpriteID single_n;     ///< single piece of rail in the northern corner

   112

		SpriteID single_s;     ///< single piece of rail in the southern corner

   113

		SpriteID single_e;     ///< single piece of rail in the eastern corner

   114

		SpriteID single_w;     ///< single piece of rail in the western corner

   115

		SpriteID crossing;     ///< level crossing, rail in X direction

   116

		SpriteID tunnel;       ///< tunnel sprites base

   117

	} base_sprites;

   118

   119

	/** struct containing the sprites for the rail GUI. @note only sprites referred to

   120

	 * directly in the code are listed */

   121

	struct {

   122

		SpriteID build_ns_rail;      ///< button for building single rail in N-S direction

   123

		SpriteID build_x_rail;       ///< button for building single rail in X direction

   124

		SpriteID build_ew_rail;      ///< button for building single rail in E-W direction

   125

		SpriteID build_y_rail;       ///< button for building single rail in Y direction

   126

		SpriteID auto_rail;          ///< button for the autorail construction

   127

		SpriteID build_depot;        ///< button for building depots

   128

		SpriteID build_tunnel;       ///< button for building a tunnel

   129

		SpriteID convert_rail;       ///< button for converting rail

   130

	} gui_sprites;

   131

   132

	struct {

   133

		CursorID rail_ns;

   134

		CursorID rail_swne;

   135

		CursorID rail_ew;

   136

		CursorID rail_nwse;

   137

		CursorID autorail;

   138

		CursorID depot;

   139

		CursorID tunnel;

   140

		CursorID convert;

   141

	} cursor;

   142

   143

	struct {

   144

		StringID toolbar_caption;

   145

	} strings;

   146

   147

	/** sprite number difference between a piece of track on a snowy ground and the corresponding one on normal ground */

   148

	SpriteID snow_offset;

   149

   150

	/** bitmask to the OTHER railtypes on which an engine of THIS railtype generates power */

   151

	RailTypeMask powered_railtypes;

   152

   153

	/** bitmask to the OTHER railtypes on which an engine of THIS railtype can physically travel */

   154

	RailTypeMask compatible_railtypes;

   155

   156

	/**

   157

	 * Offset between the current railtype and normal rail. This means that:<p>

   158

	 * 1) All the sprites in a railset MUST be in the same order. This order

   159

	 *    is determined by normal rail. Check sprites 1005 and following for this order<p>

   160

	 * 2) The position where the railtype is loaded must always be the same, otherwise

   161

	 *    the offset will fail.<p>

   162

	 * @note: Something more flexible might be desirable in the future.

   163

	 */

   164

	SpriteID total_offset;

   165

   166

	/**

   167

	  * Bridge offset

   168

	  */

   169

	SpriteID bridge_offset;

   170

   171

	/**

   172

	 * Offset to add to ground sprite when drawing custom waypoints / stations

   173

	 */

   174

	byte custom_ground_offset;

   175

} RailtypeInfo;

   176

   177

extern RailtypeInfo _railtypes[RAILTYPE_END];

   178

   179

// these are the maximums used for updating signal blocks, and checking if a depot is in a pbs block

   180

enum {

   181

	NUM_SSD_ENTRY = 256, // max amount of blocks

   182

	NUM_SSD_STACK = 32 ,// max amount of blocks to check recursively

   183

};

   184

   185

/**

   186

 * Maps a Trackdir to the corresponding TrackdirBits value

   187

 */

   188

static inline TrackdirBits TrackdirToTrackdirBits(Trackdir trackdir) { return (TrackdirBits)(1 << trackdir); }

   189

   190

/**

   191

 * These functions check the validity of Tracks and Trackdirs. assert against

   192

 * them when convenient.

   193

 */

   194

static inline bool IsValidTrack(Track track) { return track < TRACK_END; }

   195

static inline bool IsValidTrackdir(Trackdir trackdir) { return (TrackdirToTrackdirBits(trackdir) & TRACKDIR_BIT_MASK) != 0; }

   196

   197

/**

   198

 * Functions to map tracks to the corresponding bits in the signal

   199

 * presence/status bytes in the map. You should not use these directly, but

   200

 * wrapper functions below instead. XXX: Which are these?

   201

 */

   202

   203

/**

   204

 * Maps a trackdir to the bit that stores its status in the map arrays, in the

   205

 * direction along with the trackdir.

   206

 */

   207

extern const byte _signal_along_trackdir[TRACKDIR_END];

   208

static inline byte SignalAlongTrackdir(Trackdir trackdir) {return _signal_along_trackdir[trackdir];}

   209

   210

/**

   211

 * Maps a trackdir to the bit that stores its status in the map arrays, in the

   212

 * direction against the trackdir.

   213

 */

   214

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   215

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   216

	return _signal_against_trackdir[trackdir];

   217

}

   218

   219

/**

   220

 * Maps a Track to the bits that store the status of the two signals that can

   221

 * be present on the given track.

   222

 */

   223

static inline byte SignalOnTrack(Track track) {

   224

	extern const byte _signal_on_track[TRACK_END];

   225

	return _signal_on_track[track];

   226

}

   227

   228

   229

/*

   230

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   231

 * TrackdirBits, Direction and DiagDirections.

   232

 *

   233

 * TODO: Add #unndefs or something similar to remove the arrays used below

   234

 * from the global scope and expose direct uses of them.

   235

 */

   236

   237

/**

   238

 * Maps a trackdir to the reverse trackdir.

   239

 */

   240

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   241

	return (Trackdir)(trackdir ^ 8);

   242

}

   243

   244

/**

   245

 * Maps a Track to the corresponding TrackBits value

   246

 */

   247

static inline TrackBits TrackToTrackBits(Track track) { return (TrackBits)(1 << track); }

   248

   249

/**

   250

 * Returns the Track that a given Trackdir represents

   251

 */

   252

static inline Track TrackdirToTrack(Trackdir trackdir) { return (Track)(trackdir & 0x7); }

   253

   254

/**

   255

 * Returns a Trackdir for the given Track. Since every Track corresponds to

   256

 * two Trackdirs, we choose the one which points between NE and S.

   257

 * Note that the actual implementation is quite futile, but this might change

   258

 * in the future.

   259

 */

   260

static inline Trackdir TrackToTrackdir(Track track) { return (Trackdir)track; }

   261

   262

/**

   263

 * Returns a TrackdirBit mask that contains the two TrackdirBits that

   264

 * correspond with the given Track (one for each direction).

   265

 */

   266

static inline TrackdirBits TrackToTrackdirBits(Track track) { Trackdir td = TrackToTrackdir(track); return (TrackdirBits)(TrackdirToTrackdirBits(td) | TrackdirToTrackdirBits(ReverseTrackdir(td)));}

   267

   268

/**

   269

 * Discards all directional information from the given TrackdirBits. Any

   270

 * Track which is present in either direction will be present in the result.

   271

 */

   272

static inline TrackBits TrackdirBitsToTrackBits(TrackdirBits bits) { return (TrackBits)(bits | (bits >> 8)); }

   273

   274

/**

   275

 * Maps a trackdir to the trackdir that you will end up on if you go straight

   276

 * ahead. This will be the same trackdir for diagonal trackdirs, but a

   277

 * different (alternating) one for straight trackdirs

   278

 */

   279

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   280

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   281

	return _next_trackdir[trackdir];

   282

}

   283

   284

/**

   285

 * Maps a track to all tracks that make 90 deg turns with it.

   286

 */

   287

static inline TrackBits TrackCrossesTracks(Track track) {

   288

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   289

	return _track_crosses_tracks[track];

   290

}

   291

   292

/**

   293

 * Maps a trackdir to the (4-way) direction the tile is exited when following

   294

 * that trackdir.

   295

 */

   296

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   297

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   298

	return _trackdir_to_exitdir[trackdir];

   299

}

   300

   301

/**

   302

 * Maps a track and an (4-way) dir to the trackdir that represents the track

   303

 * with the exit in the given direction.

   304

 */

   305

static inline Trackdir TrackExitdirToTrackdir(Track track, DiagDirection diagdir) {

   306

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   307

	return _track_exitdir_to_trackdir[track][diagdir];

   308

}

   309

   310

/**

   311

 * Maps a track and an (4-way) dir to the trackdir that represents the track

   312

 * with the exit in the given direction.

   313

 */

   314

static inline Trackdir TrackEnterdirToTrackdir(Track track, DiagDirection diagdir) {

   315

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   316

	return _track_enterdir_to_trackdir[track][diagdir];

   317

}

   318

   319

/**

   320

 * Maps a track and a full (8-way) direction to the trackdir that represents

   321

 * the track running in the given direction.

   322

 */

   323

static inline Trackdir TrackDirectionToTrackdir(Track track, Direction dir) {

   324

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   325

	return _track_direction_to_trackdir[track][dir];

   326

}

   327

   328

/**

   329

 * Maps a (4-way) direction to the diagonal trackdir that runs in that

   330

 * direction.

   331

 */

   332

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) {

   333

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   334

	return _dir_to_diag_trackdir[diagdir];

   335

}

   336

   337

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   338

   339

/**

   340

 * Returns all trackdirs that can be reached when entering a tile from a given

   341

 * (diagonal) direction. This will obviously include 90 degree turns, since no

   342

 * information is available about the exact angle of entering */

   343

static inline TrackdirBits DiagdirReachesTrackdirs(DiagDirection diagdir) { return _exitdir_reaches_trackdirs[diagdir]; }

   344

   345

/**

   346

 * Returns all tracks that can be reached when entering a tile from a given

   347

 * (diagonal) direction. This will obviously include 90 degree turns, since no

   348

 * information is available about the exact angle of entering */

   349

static inline TrackBits DiagdirReachesTracks(DiagDirection diagdir) { return TrackdirBitsToTrackBits(DiagdirReachesTrackdirs(diagdir)); }

   350

   351

/**

   352

 * Maps a trackdir to the trackdirs that can be reached from it (ie, when

   353

 * entering the next tile. This will include 90 degree turns!

   354

 */

   355

static inline TrackdirBits TrackdirReachesTrackdirs(Trackdir trackdir) { return _exitdir_reaches_trackdirs[TrackdirToExitdir(trackdir)]; }

   356

/* Note that there is no direct table for this function (there used to be),

   357

 * but it uses two simpeler tables to achieve the result */

   358

   359

   360

/**

   361

 * Maps a trackdir to all trackdirs that make 90 deg turns with it.

   362

 */

   363

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   364

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   365

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   366

}

   367

   368

   369

/* Checks if a given Track is diagonal */

   370

static inline bool IsDiagonalTrack(Track track) { return (track == TRACK_X) || (track == TRACK_Y); }

   371

   372

/* Checks if a given Trackdir is diagonal. */

   373

static inline bool IsDiagonalTrackdir(Trackdir trackdir) { return IsDiagonalTrack(TrackdirToTrack(trackdir)); }

   374

   375

   376

/**

   377

 * Returns a pointer to the Railtype information for a given railtype

   378

 * @param railtype the rail type which the information is requested for

   379

 * @return The pointer to the RailtypeInfo

   380

 */

   381

static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)

   382

{

   383

	assert(railtype < RAILTYPE_END);

   384

	return &_railtypes[railtype];

   385

}

   386

   387

/**

   388

 * Checks if an engine of the given RailType can drive on a tile with a given

   389

 * RailType. This would normally just be an equality check, but for electric

   390

 * rails (which also support non-electric engines).

   391

 * @return Whether the engine can drive on this tile.

   392

 * @param  enginetype The RailType of the engine we are considering.

   393

 * @param  tiletype   The RailType of the tile we are considering.

   394

 */

   395

static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)

   396

{

   397

	return HASBIT(GetRailTypeInfo(enginetype)->compatible_railtypes, tiletype);

   398

}

   399

   400

static inline bool HasPowerOnRail(RailType enginetype, RailType tiletype)

   401

{

   402

	return HASBIT(GetRailTypeInfo(enginetype)->powered_railtypes, tiletype);

   403

}

   404

   405

/**

   406

 * Checks if the given tracks overlap, ie form a crossing. Basically this

   407

 * means when there is more than one track on the tile, exept when there are

   408

 * two parallel tracks.

   409

 * @param  bits The tracks present.

   410

 * @return Whether the tracks present overlap in any way.

   411

 */

   412

static inline bool TracksOverlap(TrackBits bits)

   413

{

   414

  /* With no, or only one track, there is no overlap */

   415

  if (bits == 0 || KILL_FIRST_BIT(bits) == 0) return false;

   416

  /* We know that there are at least two tracks present. When there are more

   417

   * than 2 tracks, they will surely overlap. When there are two, they will

   418

   * always overlap unless they are lower & upper or right & left. */

   419

	return bits != TRACK_BIT_HORZ && bits != TRACK_BIT_VERT;

   420

}

   421

   422

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

   423

void DrawDefaultWaypointSprite(int x, int y, RailType railtype);

   424

   425

/**

   426

 * Draws overhead wires and pylons for electric railways.

   427

 * @param ti The TileInfo struct of the tile being drawn

   428

 * @see DrawCatenaryRailway

   429

 */

   430

void DrawCatenary(const TileInfo *ti);

   431

   432

uint GetRailFoundation(Slope tileh, TrackBits bits);

   433

#endif /* RAIL_H */