1

/* $Id$ */

     2

     3

/** @file rail.h */

     4

     5

#ifndef RAIL_H

     6

#define RAIL_H

     7

     8

#include "direction.h"

     9

#include "rail_map.h"

    10

#include "tile.h"

    11

    12

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

    13

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

    14

typedef enum Trackdirs {

    15

	TRACKDIR_X_NE = 0,

    16

	TRACKDIR_Y_SE = 1,

    17

	TRACKDIR_UPPER_E  = 2,

    18

	TRACKDIR_LOWER_E  = 3,

    19

	TRACKDIR_LEFT_S   = 4,

    20

	TRACKDIR_RIGHT_S  = 5,

    21

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

    22

	 * conversion by doing (trackdir & 7) */

    23

	TRACKDIR_X_SW = 8,

    24

	TRACKDIR_Y_NW = 9,

    25

	TRACKDIR_UPPER_W  = 10,

    26

	TRACKDIR_LOWER_W  = 11,

    27

	TRACKDIR_LEFT_N   = 12,

    28

	TRACKDIR_RIGHT_N  = 13,

    29

	TRACKDIR_END,

    30

	INVALID_TRACKDIR  = 0xFF,

    31

} Trackdir;

    32

    33

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

    34

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

    35

typedef enum TrackdirBits {

    36

	TRACKDIR_BIT_X_NE     = 0x1,

    37

	TRACKDIR_BIT_Y_SE     = 0x2,

    38

	TRACKDIR_BIT_UPPER_E  = 0x4,

    39

	TRACKDIR_BIT_LOWER_E  = 0x8,

    40

	TRACKDIR_BIT_LEFT_S   = 0x10,

    41

	TRACKDIR_BIT_RIGHT_S  = 0x20,

    42

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

    43

	TRACKDIR_BIT_X_SW     = 0x0100,

    44

	TRACKDIR_BIT_Y_NW     = 0x0200,

    45

	TRACKDIR_BIT_UPPER_W  = 0x0400,

    46

	TRACKDIR_BIT_LOWER_W  = 0x0800,

    47

	TRACKDIR_BIT_LEFT_N   = 0x1000,

    48

	TRACKDIR_BIT_RIGHT_N  = 0x2000,

    49

	TRACKDIR_BIT_MASK			= 0x3F3F,

    50

	INVALID_TRACKDIR_BIT  = 0xFFFF,

    51

} TrackdirBits;

    52

    53

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

    54

 */

    55

typedef struct RailtypeInfo {

    56

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

    57

	 *  the ones used directly in the code */

    58

	struct {

    59

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

    60

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

    61

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

    62

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

    63

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

    64

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

    65

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

    66

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

    67

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

    68

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

    69

		SpriteID tunnel;       ///< tunnel sprites base

    70

	} base_sprites;

    71

    72

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

    73

	 * directly in the code are listed */

    74

	struct {

    75

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

    76

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

    77

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

    78

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

    79

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

    80

		SpriteID build_depot;        ///< button for building depots

    81

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

    82

		SpriteID convert_rail;       ///< button for converting rail

    83

	} gui_sprites;

    84

    85

	struct {

    86

		CursorID rail_ns;

    87

		CursorID rail_swne;

    88

		CursorID rail_ew;

    89

		CursorID rail_nwse;

    90

		CursorID autorail;

    91

		CursorID depot;

    92

		CursorID tunnel;

    93

		CursorID convert;

    94

	} cursor;

    95

    96

	struct {

    97

		StringID toolbar_caption;

    98

	} strings;

    99

   100

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

   101

	SpriteID snow_offset;

   102

   103

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

   104

	RailTypeMask powered_railtypes;

   105

   106

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

   107

	RailTypeMask compatible_railtypes;

   108

   109

	/**

   110

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

   111

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

   112

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

   113

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

   114

	 *    the offset will fail.<p>

   115

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

   116

	 */

   117

	SpriteID total_offset;

   118

   119

	/**

   120

	  * Bridge offset

   121

	  */

   122

	SpriteID bridge_offset;

   123

   124

	/**

   125

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

   126

	 */

   127

	byte custom_ground_offset;

   128

} RailtypeInfo;

   129

   130

extern const RailtypeInfo _railtypes[RAILTYPE_END];

   131

   132

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

   133

enum {

   134

	NUM_SSD_ENTRY = 256, // max amount of blocks

   135

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

   136

};

   137

   138

/**

   139

 * Maps a Trackdir to the corresponding TrackdirBits value

   140

 */

   141

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

   142

   143

/**

   144

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

   145

 * them when convenient.

   146

 */

   147

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

   148

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

   149

   150

/**

   151

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

   152

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

   153

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

   154

 */

   155

   156

/**

   157

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

   158

 * direction along with the trackdir.

   159

 */

   160

extern const byte _signal_along_trackdir[TRACKDIR_END];

   161

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

   162

   163

/**

   164

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

   165

 * direction against the trackdir.

   166

 */

   167

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   168

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   169

	return _signal_against_trackdir[trackdir];

   170

}

   171

   172

/**

   173

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

   174

 * be present on the given track.

   175

 */

   176

static inline byte SignalOnTrack(Track track) {

   177

	extern const byte _signal_on_track[TRACK_END];

   178

	return _signal_on_track[track];

   179

}

   180

   181

/*

   182

 * Some functions to query rail tiles

   183

 */

   184

   185

   186

/**

   187

 * Checks if a rail tile has signals.

   188

 */

   189

static inline bool HasSignals(TileIndex tile)

   190

{

   191

	return GetRailTileType(tile) == RAIL_TYPE_SIGNALS;

   192

}

   193

   194

/**

   195

 * Returns the RailTileSubtype of a given rail tile with type

   196

 * RAIL_TYPE_DEPOT_WAYPOINT

   197

 */

   198

static inline RailTileSubtype GetRailTileSubtype(TileIndex tile)

   199

{

   200

	assert(GetRailTileType(tile) == RAIL_TYPE_DEPOT_WAYPOINT);

   201

	return (RailTileSubtype)(_m[tile].m5 & RAIL_SUBTYPE_MASK);

   202

}

   203

   204

/**

   205

 * Returns whether this is plain rails, with or without signals. Iow, if this

   206

 * tiles RailTileType is RAIL_TYPE_NORMAL or RAIL_TYPE_SIGNALS.

   207

 */

   208

static inline bool IsPlainRailTile(TileIndex tile)

   209

{

   210

	RailTileType rtt = GetRailTileType(tile);

   211

	return rtt == RAIL_TYPE_NORMAL || rtt == RAIL_TYPE_SIGNALS;

   212

}

   213

   214

   215

/**

   216

 * Returns whether the given track is present on the given tile. Tile must be

   217

 * a plain rail tile (IsPlainRailTile()).

   218

 */

   219

static inline bool HasTrack(TileIndex tile, Track track)

   220

{

   221

	assert(IsValidTrack(track));

   222

	return HASBIT(GetTrackBits(tile), track);

   223

}

   224

   225

/*

   226

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   227

 * TrackdirBits, Direction and DiagDirections.

   228

 *

   229

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

   230

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

   231

 */

   232

   233

/**

   234

 * Maps a trackdir to the reverse trackdir.

   235

 */

   236

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   237

	return (Trackdir)(trackdir ^ 8);

   238

}

   239

   240

/**

   241

 * Maps a Track to the corresponding TrackBits value

   242

 */

   243

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

   244

   245

/**

   246

 * Returns the Track that a given Trackdir represents

   247

 */

   248

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

   249

   250

/**

   251

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

   252

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

   253

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

   254

 * in the future.

   255

 */

   256

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

   257

   258

/**

   259

 * Returns a TrackdirBit mask that contains the two TrackdirBits that

   260

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

   261

 */

   262

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

   263

   264

/**

   265

 * Discards all directional information from the given TrackdirBits. Any

   266

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

   267

 */

   268

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

   269

   270

/**

   271

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

   272

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

   273

 * different (alternating) one for straight trackdirs

   274

 */

   275

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   276

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   277

	return _next_trackdir[trackdir];

   278

}

   279

   280

/**

   281

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

   282

 */

   283

static inline TrackBits TrackCrossesTracks(Track track) {

   284

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   285

	return _track_crosses_tracks[track];

   286

}

   287

   288

/**

   289

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

   290

 * that trackdir.

   291

 */

   292

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   293

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   294

	return _trackdir_to_exitdir[trackdir];

   295

}

   296

   297

/**

   298

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

   299

 * with the exit in the given direction.

   300

 */

   301

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

   302

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   303

	return _track_exitdir_to_trackdir[track][diagdir];

   304

}

   305

   306

/**

   307

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

   308

 * with the exit in the given direction.

   309

 */

   310

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

   311

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   312

	return _track_enterdir_to_trackdir[track][diagdir];

   313

}

   314

   315

/**

   316

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

   317

 * the track running in the given direction.

   318

 */

   319

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

   320

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   321

	return _track_direction_to_trackdir[track][dir];

   322

}

   323

   324

/**

   325

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

   326

 * direction.

   327

 */

   328

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) {

   329

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   330

	return _dir_to_diag_trackdir[diagdir];

   331

}

   332

   333

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   334

   335

/**

   336

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

   337

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

   338

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

   339

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

   340

   341

/**

   342

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

   343

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

   344

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

   345

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

   346

   347

/**

   348

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

   349

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

   350

 */

   351

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

   352

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

   353

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

   354

   355

   356

/**

   357

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

   358

 */

   359

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   360

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   361

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   362

}

   363

   364

   365

/* Checks if a given Track is diagonal */

   366

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

   367

   368

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

   369

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

   370

   371

/*

   372

 * Functions quering signals on tiles.

   373

 */

   374

   375

/**

   376

 * Checks for the presence of signals (either way) on the given track on the

   377

 * given rail tile.

   378

 */

   379

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   380

{

   381

	assert(IsValidTrack(track));

   382

	return

   383

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   384

		(_m[tile].m3 & SignalOnTrack(track)) != 0;

   385

}

   386

   387

/**

   388

 * Checks for the presence of signals along the given trackdir on the given

   389

 * rail tile.

   390

 *

   391

 * Along meaning if you are currently driving on the given trackdir, this is

   392

 * the signal that is facing us (for which we stop when it's red).

   393

 */

   394

static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)

   395

{

   396

	assert (IsValidTrackdir(trackdir));

   397

	return

   398

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   399

		_m[tile].m3 & SignalAlongTrackdir(trackdir);

   400

}

   401

   402

/**

   403

 * Gets the state of the signal along the given trackdir.

   404

 *

   405

 * Along meaning if you are currently driving on the given trackdir, this is

   406

 * the signal that is facing us (for which we stop when it's red).

   407

 */

   408

static inline SignalState GetSignalStateByTrackdir(TileIndex tile, Trackdir trackdir)

   409

{

   410

	assert(IsValidTrackdir(trackdir));

   411

	assert(HasSignalOnTrack(tile, TrackdirToTrack(trackdir)));

   412

	return _m[tile].m2 & SignalAlongTrackdir(trackdir) ?

   413

		SIGNAL_STATE_GREEN : SIGNAL_STATE_RED;

   414

}

   415

   416

   417

/**

   418

 * Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile.

   419

 * Note that there is no check if the given trackdir is actually present on

   420

 * the tile!

   421

 * The given trackdir is used when there are (could be) multiple rail types on

   422

 * one tile.

   423

 */

   424

RailType GetTileRailType(TileIndex tile, Trackdir trackdir);

   425

   426

   427

/**

   428

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

   429

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

   430

 * @return The pointer to the RailtypeInfo

   431

 */

   432

static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)

   433

{

   434

	assert(railtype < RAILTYPE_END);

   435

	return &_railtypes[railtype];

   436

}

   437

   438

/**

   439

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

   440

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

   441

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

   442

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

   443

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

   444

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

   445

 */

   446

static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)

   447

{

   448

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

   449

}

   450

   451

static inline bool HasPowerOnRail(RailType enginetype, RailType tiletype)

   452

{

   453

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

   454

}

   455

   456

/**

   457

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

   458

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

   459

 * two parallel tracks.

   460

 * @param  bits The tracks present.

   461

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

   462

 */

   463

static inline bool TracksOverlap(TrackBits bits)

   464

{

   465

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

   466

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

   467

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

   468

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

   469

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

   470

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

   471

}

   472

   473

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

   474

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

   475

   476

/**

   477

 * Draws overhead wires and pylons for electric railways.

   478

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

   479

 * @see DrawCatenaryRailway

   480

 */

   481

void DrawCatenary(const TileInfo *ti);

   482

   484

#endif /* RAIL_H */