1

#ifndef RAIL_H

     2

#define RAIL_H

     3

     4

#include "tile.h"

     5

     6

/*

     7

 * Some enums for accesing the map bytes for rail tiles

     8

 */

     9

    10

/* These types are used in the map5 byte for rail tiles. Use GetRailTileType() to

    11

 * get these values */

    12

typedef enum RailTileTypes {

    13

	RAIL_TYPE_NORMAL         = 0x0,

    14

	RAIL_TYPE_SIGNALS        = 0x40,

    15

	RAIL_TYPE_UNUSED         = 0x80, /* XXX: Maybe this could become waypoints? */

    16

	RAIL_TYPE_DEPOT_WAYPOINT = 0xC0, /* Is really depots and waypoints... */

    17

	RAIL_TILE_TYPE_MASK      = 0xC0,

    18

} RailTileType;

    19

    20

enum { /* DEPRECATED TODO: Rewrite all uses of this */

    21

	RAIL_TYPE_SPECIAL = 0x80, /* This used to say "If this bit is set, then it's

    22

														 * not a regular track.", but currently, you

    23

														 * should rather view map5[6..7] as one type,

    24

														 * containing a value from RailTileTypes above.

    25

														 * This value is only maintained for backwards

    26

														 * compatibility */

    27

    28

	/* There used to be RAIL_BIT_* enums here, they moved to (for now) npf.c as

    29

	 * TRACK_BIT_* */

    30

};

    31

    32

/* These subtypes are used in the map5 byte when the main rail type is

    33

 * RAIL_TYPE_DEPOT_WAYPOINT */

    34

typedef enum RailTileSubtypes {

    35

	RAIL_SUBTYPE_DEPOT    = 0x00,

    36

	RAIL_SUBTYPE_WAYPOINT = 0x04,

    37

	RAIL_SUBTYPE_MASK     = 0x3C,

    38

} RailTileSubtype;

    39

    40

typedef enum SignalTypes {

    41

	/* Stored in _map3_hi[0..1] for MP_RAILWAY */

    42

  SIGTYPE_NORMAL  = 0,        // normal signal

    43

  SIGTYPE_ENTRY   = 1,        // presignal block entry

    44

  SIGTYPE_EXIT    = 2,        // presignal block exit

    45

  SIGTYPE_COMBO   = 3,        // presignal inter-block

    46

	SIGTYPE_END,

    47

	SIGTYPE_MASK    = 3,

    48

} SignalType;

    49

    50

typedef enum RailTypes {

    51

	RAILTYPE_RAIL   = 0,

    52

	RAILTYPE_MONO   = 1,

    53

	RAILTYPE_MAGLEV = 2,

    54

	RAILTYPE_END,

    55

	RAILTYPE_MASK   = 0x3,

    56

	INVALID_RAILTYPE = 0xFF,

    57

} RailType;

    58

    59

enum {

    60

	SIG_SEMAPHORE_MASK = 4,

    61

};

    62

    63

/* These are used to specify a single track. Can be translated to a trackbit

    64

 * with TrackToTrackbit */

    65

typedef enum Tracks {

    66

  TRACK_DIAG1 = 0,

    67

  TRACK_DIAG2 = 1,

    68

  TRACK_UPPER = 2,

    69

  TRACK_LOWER = 3,

    70

  TRACK_LEFT  = 4,

    71

  TRACK_RIGHT = 5,

    72

  TRACK_END,

    73

  INVALID_TRACK = 0xFF,

    74

} Track;

    75

    76

/* These are the bitfield variants of the above */

    77

typedef enum TrackBits {

    78

  TRACK_BIT_DIAG1 = 1,  // 0

    79

  TRACK_BIT_DIAG2 = 2,  // 1

    80

  TRACK_BIT_UPPER = 4,  // 2

    81

  TRACK_BIT_LOWER = 8,  // 3

    82

  TRACK_BIT_LEFT  = 16, // 4

    83

  TRACK_BIT_RIGHT = 32, // 5

    84

	TRACK_BIT_MASK  = 0x3F,

    85

} TrackBits;

    86

    87

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

    88

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

    89

typedef enum Trackdirs {

    90

  TRACKDIR_DIAG1_NE = 0,

    91

  TRACKDIR_DIAG2_SE = 1,

    92

  TRACKDIR_UPPER_E  = 2,

    93

  TRACKDIR_LOWER_E  = 3,

    94

  TRACKDIR_LEFT_S   = 4,

    95

  TRACKDIR_RIGHT_S  = 5,

    96

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

    97

	 * conversion by doing (trackdir & 7) */

    98

  TRACKDIR_DIAG1_SW = 8,

    99

  TRACKDIR_DIAG2_NW = 9,

   100

  TRACKDIR_UPPER_W  = 10,

   101

  TRACKDIR_LOWER_W  = 11,

   102

  TRACKDIR_LEFT_N   = 12,

   103

  TRACKDIR_RIGHT_N  = 13,

   104

  TRACKDIR_END,

   105

  INVALID_TRACKDIR  = 0xFF,

   106

} Trackdir;

   107

   108

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

   109

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

   110

typedef enum TrackdirBits {

   111

  TRACKDIR_BIT_DIAG1_NE = 0x1,

   112

  TRACKDIR_BIT_DIAG2_SE = 0x2,

   113

  TRACKDIR_BIT_UPPER_E  = 0x4,

   114

  TRACKDIR_BIT_LOWER_E  = 0x8,

   115

  TRACKDIR_BIT_LEFT_S   = 0x10,

   116

  TRACKDIR_BIT_RIGHT_S  = 0x20,

   117

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

   118

  TRACKDIR_BIT_DIAG1_SW = 0x0100,

   119

  TRACKDIR_BIT_DIAG2_NW = 0x0200,

   120

  TRACKDIR_BIT_UPPER_W  = 0x0400,

   121

  TRACKDIR_BIT_LOWER_W  = 0x0800,

   122

  TRACKDIR_BIT_LEFT_N   = 0x1000,

   123

  TRACKDIR_BIT_RIGHT_N  = 0x2000,

   124

	TRACKDIR_BIT_MASK			= 0x3F3F,

   125

  INVALID_TRACKDIR_BIT  = 0xFFFF,

   126

} TrackdirBits;

   127

   128

/* These are states in which a signal can be. Currently these are only two, so

   129

 * simple boolean logic will do. But do try to compare to this enum instead of

   130

 * normal boolean evaluation, since that will make future additions easier.

   131

 */

   132

typedef enum SignalStates {

   133

	SIGNAL_STATE_RED = 0,

   134

	SIGNAL_STATE_GREEN = 1,

   135

} SignalState;

   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

 * Returns the RailTileType of a given rail tile. (ie normal, with signals,

   187

 * depot, etc.)

   188

 */

   189

static inline RailTileType GetRailTileType(TileIndex tile)

   190

{

   191

	assert(IsTileType(tile, MP_RAILWAY));

   192

	return (_map5[tile] & RAIL_TILE_TYPE_MASK);

   193

}

   194

   195

/**

   196

 * Returns the rail type of the given rail tile (ie rail, mono, maglev).

   197

 */

   198

static inline RailType GetRailType(TileIndex tile) { return (RailType)(_map3_lo[tile] & RAILTYPE_MASK); }

   199

   200

/**

   201

 * Checks if a rail tile has signals.

   202

 */

   203

static inline bool HasSignals(TileIndex tile)

   204

{

   205

	return GetRailTileType(tile) == RAIL_TYPE_SIGNALS;

   206

}

   207

   208

/**

   209

 * Returns the RailTileSubtype of a given rail tile with type

   210

 * RAIL_TYPE_DEPOT_WAYPOINT

   211

 */

   212

static inline RailTileSubtype GetRailTileSubtype(TileIndex tile)

   213

{

   214

	assert(GetRailTileType(tile) == RAIL_TYPE_DEPOT_WAYPOINT);

   215

	return (RailTileSubtype)(_map5[tile] & RAIL_SUBTYPE_MASK);

   216

}

   217

   218

/**

   219

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

   220

 * tiles RailTileType is RAIL_TYPE_NORMAL or RAIL_TYPE_SIGNALS.

   221

 */

   222

static inline bool IsPlainRailTile(TileIndex tile)

   223

{

   224

	RailTileType rtt = GetRailTileType(tile);

   225

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

   226

}

   227

   228

/**

   229

 * Returns the tracks present on the given plain rail tile (IsPlainRailTile())

   230

 */

   231

static inline TrackBits GetTrackBits(TileIndex tile)

   232

{

   233

	assert(GetRailTileType(tile) == RAIL_TYPE_NORMAL || GetRailTileType(tile) == RAIL_TYPE_SIGNALS);

   234

	return (TrackBits)(_map5[tile] & TRACK_BIT_MASK);

   235

}

   236

   237

/**

   238

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

   239

 * a plain rail tile (IsPlainRailTile()).

   240

 */

   241

static inline bool HasTrack(TileIndex tile, Track track)

   242

{

   243

	assert(IsValidTrack(track));

   244

	return HASBIT(GetTrackBits(tile), track);

   245

}

   246

   247

/*

   248

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   249

 * TrackdirBits, Direction and DiagDirections.

   250

 *

   251

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

   252

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

   253

 */

   254

   255

/**

   256

 * Maps a trackdir to the reverse trackdir.

   257

 */

   258

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   259

	extern const Trackdir _reverse_trackdir[TRACKDIR_END];

   260

	return _reverse_trackdir[trackdir];

   261

}

   262

   263

/*

   264

 * Maps a Track to the corresponding TrackBits value

   265

 */

   266

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

   267

   268

/* Returns the Track that a given Trackdir represents */

   269

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

   270

   271

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

   272

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

   273

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

   274

 * in the future.

   275

 */

   276

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

   277

   278

/* Returns a TrackdirBit mask that contains the two TrackdirBits that

   279

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

   280

 */

   281

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

   282

   283

/**

   284

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

   285

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

   286

 * different (alternating) one for straight trackdirs

   287

 */

   288

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   289

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   290

	return _next_trackdir[trackdir];

   291

}

   292

   293

/**

   294

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

   295

 */

   296

static inline TrackBits TrackCrossesTracks(Track track) {

   297

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   298

	return _track_crosses_tracks[track];

   299

}

   300

   301

/**

   302

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

   303

 * that trackdir.

   304

 */

   305

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   306

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   307

	return _trackdir_to_exitdir[trackdir];

   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 TrackExitdirToTrackdir(Track track, DiagDirection diagdir) {

   315

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   316

	return _track_exitdir_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

/**

   338

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

   339

 * entering the next tile. This

   340

 */

   341

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   342

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

   343

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

   344

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

   345

   346

/**

   347

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

   348

 */

   349

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   350

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   351

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   352

}

   353

   354

/**

   355

 * Maps a (4-way) direction to the reverse.

   356

 */

   357

static inline DiagDirection ReverseDiagdir(DiagDirection diagdir) {

   358

	extern const DiagDirection _reverse_diagdir[DIAGDIR_END];

   359

	return _reverse_diagdir[diagdir];

   360

}

   361

   362

/* Checks if a given Track is diagonal */

   363

static inline bool IsDiagonalTrack(Track track) { return (track == TRACK_DIAG1) || (track == TRACK_DIAG2); }

   364

   365

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

   366

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

   367

   368

/*

   369

 * Functions quering signals on tiles.

   370

 */

   371

   372

/**

   373

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

   374

 * given rail tile.

   375

 */

   376

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   377

{

   378

	assert(IsValidTrack(track));

   379

	return ((GetRailTileType(tile) == RAIL_TYPE_SIGNALS) && ((_map3_lo[tile] & SignalOnTrack(track)) != 0));

   380

}

   381

   382

/**

   383

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

   384

 * rail tile.

   385

 *

   386

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

   387

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

   388

 */

   389

static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)

   390

{

   391

	assert (IsValidTrackdir(trackdir));

   392

	return (GetRailTileType(tile) == RAIL_TYPE_SIGNALS) && (_map3_lo[tile] & SignalAlongTrackdir(trackdir));

   393

}

   394

   395

/**

   396

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

   397

 *

   398

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

   399

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

   400

 */

   401

static inline SignalState GetSignalState(TileIndex tile, Trackdir trackdir)

   402

{

   403

	assert(IsValidTrackdir(trackdir));

   404

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

   405

	return ((_map2[tile] & SignalAlongTrackdir(trackdir))?SIGNAL_STATE_GREEN:SIGNAL_STATE_RED);

   406

}

   407

   408

/**

   409

 * Gets the type of signal on a given track on a given rail tile with signals.

   410

 *

   411

 * Note that currently, the track argument is not used, since

   412

 * signal types cannot be mixed. This function is trying to be

   413

 * future-compatible, though.

   414

 */

   415

static inline SignalType GetSignalType(TileIndex tile, Track track)

   416

{

   417

	assert(IsValidTrack(track));

   418

	assert(GetRailTileType(tile) == RAIL_TYPE_SIGNALS);

   419

	return (SignalType)(_map3_hi[tile] & SIGTYPE_MASK);

   420

}

   421

   422

/**

   423

 * Checks if this tile contains semaphores (returns true) or normal signals

   424

 * (returns false) on the given track. Does not check if there are actually

   425

 * signals on the track, you should use HasSignalsOnTrack() for that.

   426

 *

   427

 * Note that currently, the track argument is not used, since

   428

 * semaphores/electric signals cannot be mixed. This function is trying to be

   429

 * future-compatible, though.

   430

 */

   431

static inline bool HasSemaphores(TileIndex tile, Track track)

   432

{

   433

	assert(IsValidTrack(track));

   434

	return (_map3_hi[tile] & SIG_SEMAPHORE_MASK);

   435

}

   436

   437

/**

   438

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

   439

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

   440

 * the tile!

   441

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

   442

 * one tile.

   443

 */

   444

RailType GetTileRailType(TileIndex tile, byte trackdir);

   445

   475

#endif // RAIL_H