1

/* $Id$ */

     2

     3

/** @file rail.h */

     4

     5

#ifndef RAIL_H

     6

#define RAIL_H

     7

     8

#include "tile.h"

     9

    10

/*

    11

 * Some enums for accesing the map bytes for rail tiles

    12

 */

    13

    14

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

    15

 * get these values */

    16

typedef enum RailTileTypes {

    17

	RAIL_TYPE_NORMAL         = 0x0,

    18

	RAIL_TYPE_SIGNALS        = 0x40,

    19

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

    20

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

    21

	RAIL_TILE_TYPE_MASK      = 0xC0,

    22

} RailTileType;

    23

    24

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

    25

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

    26

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

    27

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

    28

														 * containing a value from RailTileTypes above.

    29

														 * This value is only maintained for backwards

    30

														 * compatibility */

    31

    32

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

    33

	 * TRACK_BIT_* */

    34

};

    35

    36

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

    37

 * RAIL_TYPE_DEPOT_WAYPOINT */

    38

typedef enum RailTileSubtypes {

    39

	RAIL_SUBTYPE_DEPOT    = 0x00,

    40

	RAIL_SUBTYPE_WAYPOINT = 0x04,

    41

	RAIL_SUBTYPE_MASK     = 0x3C,

    42

} RailTileSubtype;

    43

    44

typedef enum SignalTypes {

    45

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

    46

  SIGTYPE_NORMAL  = 0,        // normal signal

    47

  SIGTYPE_ENTRY   = 1,        // presignal block entry

    48

  SIGTYPE_EXIT    = 2,        // presignal block exit

    49

  SIGTYPE_COMBO   = 3,        // presignal inter-block

    50

	SIGTYPE_PBS     = 4,        // pbs signal

    51

	SIGTYPE_END,

    52

	SIGTYPE_MASK    = 7,

    53

} SignalType;

    54

    55

typedef enum RailTypes {

    56

	RAILTYPE_RAIL   = 0,

    57

	RAILTYPE_MONO   = 1,

    58

	RAILTYPE_MAGLEV = 2,

    59

	RAILTYPE_END,

    60

	RAILTYPE_MASK   = 0x3,

    61

	INVALID_RAILTYPE = 0xFF,

    62

} RailType;

    63

    64

enum {

    65

	SIG_SEMAPHORE_MASK = 1 << 3,

    66

};

    67

    68

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

    69

 * with TrackToTrackbit */

    70

typedef enum Tracks {

    71

  TRACK_DIAG1 = 0,

    72

  TRACK_DIAG2 = 1,

    73

  TRACK_UPPER = 2,

    74

  TRACK_LOWER = 3,

    75

  TRACK_LEFT  = 4,

    76

  TRACK_RIGHT = 5,

    77

  TRACK_END,

    78

  INVALID_TRACK = 0xFF,

    79

} Track;

    80

    81

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

    82

typedef enum TrackBits {

    83

  TRACK_BIT_DIAG1 = 1,  // 0

    84

  TRACK_BIT_DIAG2 = 2,  // 1

    85

  TRACK_BIT_UPPER = 4,  // 2

    86

  TRACK_BIT_LOWER = 8,  // 3

    87

  TRACK_BIT_LEFT  = 16, // 4

    88

  TRACK_BIT_RIGHT = 32, // 5

    89

	TRACK_BIT_MASK  = 0x3F,

    90

} TrackBits;

    91

    92

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

    93

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

    94

typedef enum Trackdirs {

    95

  TRACKDIR_DIAG1_NE = 0,

    96

  TRACKDIR_DIAG2_SE = 1,

    97

  TRACKDIR_UPPER_E  = 2,

    98

  TRACKDIR_LOWER_E  = 3,

    99

  TRACKDIR_LEFT_S   = 4,

   100

  TRACKDIR_RIGHT_S  = 5,

   101

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

   102

	 * conversion by doing (trackdir & 7) */

   103

  TRACKDIR_DIAG1_SW = 8,

   104

  TRACKDIR_DIAG2_NW = 9,

   105

  TRACKDIR_UPPER_W  = 10,

   106

  TRACKDIR_LOWER_W  = 11,

   107

  TRACKDIR_LEFT_N   = 12,

   108

  TRACKDIR_RIGHT_N  = 13,

   109

  TRACKDIR_END,

   110

  INVALID_TRACKDIR  = 0xFF,

   111

} Trackdir;

   112

   113

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

   114

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

   115

typedef enum TrackdirBits {

   116

  TRACKDIR_BIT_DIAG1_NE = 0x1,

   117

  TRACKDIR_BIT_DIAG2_SE = 0x2,

   118

  TRACKDIR_BIT_UPPER_E  = 0x4,

   119

  TRACKDIR_BIT_LOWER_E  = 0x8,

   120

  TRACKDIR_BIT_LEFT_S   = 0x10,

   121

  TRACKDIR_BIT_RIGHT_S  = 0x20,

   122

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

   123

  TRACKDIR_BIT_DIAG1_SW = 0x0100,

   124

  TRACKDIR_BIT_DIAG2_NW = 0x0200,

   125

  TRACKDIR_BIT_UPPER_W  = 0x0400,

   126

  TRACKDIR_BIT_LOWER_W  = 0x0800,

   127

  TRACKDIR_BIT_LEFT_N   = 0x1000,

   128

  TRACKDIR_BIT_RIGHT_N  = 0x2000,

   129

	TRACKDIR_BIT_MASK			= 0x3F3F,

   130

  INVALID_TRACKDIR_BIT  = 0xFFFF,

   131

} TrackdirBits;

   132

   133

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

   134

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

   135

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

   136

 */

   137

typedef enum SignalStates {

   138

	SIGNAL_STATE_RED = 0,

   139

	SIGNAL_STATE_GREEN = 1,

   140

} SignalState;

   141

   166

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

   167

enum {

   168

	NUM_SSD_ENTRY = 256, // max amount of blocks

   169

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

   170

};

   171

   172

/**

   173

 * Maps a Trackdir to the corresponding TrackdirBits value

   174

 */

   175

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

   176

   177

/**

   178

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

   179

 * them when convenient.

   180

 */

   181

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

   182

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

   183

   184

/**

   185

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

   186

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

   187

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

   188

 */

   189

   190

/**

   191

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

   192

 * direction along with the trackdir.

   193

 */

   194

extern const byte _signal_along_trackdir[TRACKDIR_END];

   195

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

   196

   197

/**

   198

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

   199

 * direction against the trackdir.

   200

 */

   201

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   202

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   203

	return _signal_against_trackdir[trackdir];

   204

}

   205

   206

/**

   207

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

   208

 * be present on the given track.

   209

 */

   210

static inline byte SignalOnTrack(Track track) {

   211

	extern const byte _signal_on_track[TRACK_END];

   212

	return _signal_on_track[track];

   213

}

   214

   215

/*

   216

 * Some functions to query rail tiles

   217

 */

   218

   219

/**

   220

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

   221

 * depot, etc.)

   222

 */

   223

static inline RailTileType GetRailTileType(TileIndex tile)

   224

{

   225

	assert(IsTileType(tile, MP_RAILWAY));

   226

	return (_m[tile].m5 & RAIL_TILE_TYPE_MASK);

   227

}

   228

   229

/**

   230

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

   231

 */

   232

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

   233

   234

/**

   235

 * Checks if a rail tile has signals.

   236

 */

   237

static inline bool HasSignals(TileIndex tile)

   238

{

   239

	return GetRailTileType(tile) == RAIL_TYPE_SIGNALS;

   240

}

   241

   242

/**

   243

 * Returns the RailTileSubtype of a given rail tile with type

   244

 * RAIL_TYPE_DEPOT_WAYPOINT

   245

 */

   246

static inline RailTileSubtype GetRailTileSubtype(TileIndex tile)

   247

{

   248

	assert(GetRailTileType(tile) == RAIL_TYPE_DEPOT_WAYPOINT);

   249

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

   250

}

   251

   252

/**

   253

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

   254

 * tiles RailTileType is RAIL_TYPE_NORMAL or RAIL_TYPE_SIGNALS.

   255

 */

   256

static inline bool IsPlainRailTile(TileIndex tile)

   257

{

   258

	RailTileType rtt = GetRailTileType(tile);

   259

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

   260

}

   261

   262

/**

   263

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

   264

 */

   265

static inline TrackBits GetTrackBits(TileIndex tile)

   266

{

   267

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

   268

	return (TrackBits)(_m[tile].m5 & TRACK_BIT_MASK);

   269

}

   270

   271

/**

   272

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

   273

 * a plain rail tile (IsPlainRailTile()).

   274

 */

   275

static inline bool HasTrack(TileIndex tile, Track track)

   276

{

   277

	assert(IsValidTrack(track));

   278

	return HASBIT(GetTrackBits(tile), track);

   279

}

   280

   281

/*

   282

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   283

 * TrackdirBits, Direction and DiagDirections.

   284

 *

   285

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

   286

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

   287

 */

   288

   289

/**

   290

 * Maps a trackdir to the reverse trackdir.

   291

 */

   292

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   293

	extern const Trackdir _reverse_trackdir[TRACKDIR_END];

   294

	return _reverse_trackdir[trackdir];

   295

}

   296

   297

/*

   298

 * Maps a Track to the corresponding TrackBits value

   299

 */

   300

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

   301

   302

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

   303

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

   304

   305

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

   306

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

   307

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

   308

 * in the future.

   309

 */

   310

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

   311

   312

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

   313

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

   314

 */

   315

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

   316

   317

/**

   318

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

   319

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

   320

 * different (alternating) one for straight trackdirs

   321

 */

   322

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   323

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   324

	return _next_trackdir[trackdir];

   325

}

   326

   327

/**

   328

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

   329

 */

   330

static inline TrackBits TrackCrossesTracks(Track track) {

   331

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   332

	return _track_crosses_tracks[track];

   333

}

   334

   335

/**

   336

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

   337

 * that trackdir.

   338

 */

   339

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   340

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   341

	return _trackdir_to_exitdir[trackdir];

   342

}

   343

   344

/**

   345

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

   346

 * with the exit in the given direction.

   347

 */

   348

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

   349

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   350

	return _track_exitdir_to_trackdir[track][diagdir];

   351

}

   352

   353

/**

   354

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

   355

 * with the exit in the given direction.

   356

 */

   357

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

   358

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   359

	return _track_enterdir_to_trackdir[track][diagdir];

   360

}

   361

   362

/**

   363

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

   364

 * the track running in the given direction.

   365

 */

   366

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

   367

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   368

	return _track_direction_to_trackdir[track][dir];

   369

}

   370

   371

/**

   372

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

   373

 * direction.

   374

 */

   375

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) {

   376

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   377

	return _dir_to_diag_trackdir[diagdir];

   378

}

   379

   380

/**

   381

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

   382

 * entering the next tile. This

   383

 */

   384

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   385

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

   386

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

   387

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

   388

   389

/**

   390

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

   391

 */

   392

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   393

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   394

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   395

}

   396

   397

/**

   398

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

   399

 */

   400

static inline DiagDirection ReverseDiagdir(DiagDirection diagdir) {

   401

	extern const DiagDirection _reverse_diagdir[DIAGDIR_END];

   402

	return _reverse_diagdir[diagdir];

   403

}

   404

   405

/**

   406

 * Maps a (8-way) direction to a (4-way) DiagDirection

   407

 */

   408

static inline DiagDirection DirToDiagdir(Direction dir) {

   409

	assert(dir < DIR_END);

   410

	return (DiagDirection)(dir >> 1);

   411

}

   412

   413

/* Checks if a given Track is diagonal */

   414

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

   415

   416

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

   417

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

   418

   419

/*

   420

 * Functions quering signals on tiles.

   421

 */

   422

   423

/**

   424

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

   425

 * given rail tile.

   426

 */

   427

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   428

{

   429

	assert(IsValidTrack(track));

   430

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

   431

}

   432

   433

/**

   434

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

   435

 * rail tile.

   436

 *

   437

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

   438

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

   439

 */

   440

static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)

   441

{

   442

	assert (IsValidTrackdir(trackdir));

   443

	return (GetRailTileType(tile) == RAIL_TYPE_SIGNALS) && (_m[tile].m3 & SignalAlongTrackdir(trackdir));

   444

}

   445

   446

/**

   447

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

   448

 *

   449

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

   450

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

   451

 */

   452

static inline SignalState GetSignalState(TileIndex tile, Trackdir trackdir)

   453

{

   454

	assert(IsValidTrackdir(trackdir));

   455

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

   456

	return ((_m[tile].m2 & SignalAlongTrackdir(trackdir))?SIGNAL_STATE_GREEN:SIGNAL_STATE_RED);

   457

}

   458

   459

/**

   460

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

   461

 *

   462

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

   463

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

   464

 * future-compatible, though.

   465

 */

   466

static inline SignalType GetSignalType(TileIndex tile, Track track)

   467

{

   468

	assert(IsValidTrack(track));

   469

	assert(GetRailTileType(tile) == RAIL_TYPE_SIGNALS);

   470

	return (SignalType)(_m[tile].m4 & SIGTYPE_MASK);

   471

}

   472

   473

/**

   474

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

   475

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

   476

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

   477

 *

   478

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

   479

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

   480

 * future-compatible, though.

   481

 */

   482

static inline bool HasSemaphores(TileIndex tile, Track track)

   483

{

   484

	assert(IsValidTrack(track));

   485

	return (_m[tile].m4 & SIG_SEMAPHORE_MASK);

   486

}

   487

   488

/**

   489

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

   490

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

   491

 * the tile!

   492

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

   493

 * one tile.

   494

 */

   495

RailType GetTileRailType(TileIndex tile, Trackdir trackdir);

   496

   497

/**

   498

 * Returns whether the given tile is a level crossing.

   499

 */

   500

static inline bool IsLevelCrossing(TileIndex tile)

   501

{

   502

	return (_m[tile].m5 & 0xF0) == 0x10;

   503

}

   504

   505

/**

   506

 * Gets the transport type of the given track on the given crossing tile.

   507

 * @return  The transport type of the given track, either TRANSPORT_ROAD,

   508

 * TRANSPORT_RAIL.

   509

 */