1

/* $Id$ */

     2

     3

#ifndef RAIL_H

     4

#define RAIL_H

     5

     6

#include "tile.h"

     7

     8

/*

     9

 * Some enums for accesing the map bytes for rail tiles

    10

 */

    11

    12

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

    13

 * get these values */

    14

typedef enum RailTileTypes {

    15

	RAIL_TYPE_NORMAL         = 0x0,

    16

	RAIL_TYPE_SIGNALS        = 0x40,

    17

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

    18

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

    19

	RAIL_TILE_TYPE_MASK      = 0xC0,

    20

} RailTileType;

    21

    22

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

    23

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

    24

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

    25

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

    26

														 * containing a value from RailTileTypes above.

    27

														 * This value is only maintained for backwards

    28

														 * compatibility */

    29

    30

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

    31

	 * TRACK_BIT_* */

    32

};

    33

    34

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

    35

 * RAIL_TYPE_DEPOT_WAYPOINT */

    36

typedef enum RailTileSubtypes {

    37

	RAIL_SUBTYPE_DEPOT    = 0x00,

    38

	RAIL_SUBTYPE_WAYPOINT = 0x04,

    39

	RAIL_SUBTYPE_MASK     = 0x3C,

    40

} RailTileSubtype;

    41

    42

typedef enum SignalTypes {

    43

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

    44

  SIGTYPE_NORMAL  = 0,        // normal signal

    45

  SIGTYPE_ENTRY   = 1,        // presignal block entry

    46

  SIGTYPE_EXIT    = 2,        // presignal block exit

    47

  SIGTYPE_COMBO   = 3,        // presignal inter-block

    48

	SIGTYPE_PBS     = 4,        // pbs signal

    49

	SIGTYPE_END,

    50

	SIGTYPE_MASK    = 7,

    51

} SignalType;

    52

    53

typedef enum RailTypes {

    54

	RAILTYPE_RAIL   = 0,

    55

	RAILTYPE_MONO   = 1,

    56

	RAILTYPE_MAGLEV = 2,

    57

	RAILTYPE_END,

    58

	RAILTYPE_MASK   = 0x3,

    59

	INVALID_RAILTYPE = 0xFF,

    60

} RailType;

    61

    62

enum {

    63

	SIG_SEMAPHORE_MASK = 1 << 3,

    64

};

    65

    66

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

    67

 * with TrackToTrackbit */

    68

typedef enum Tracks {

    69

  TRACK_DIAG1 = 0,

    70

  TRACK_DIAG2 = 1,

    71

  TRACK_UPPER = 2,

    72

  TRACK_LOWER = 3,

    73

  TRACK_LEFT  = 4,

    74

  TRACK_RIGHT = 5,

    75

  TRACK_END,

    76

  INVALID_TRACK = 0xFF,

    77

} Track;

    78

    79

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

    80

typedef enum TrackBits {

    81

  TRACK_BIT_DIAG1 = 1,  // 0

    82

  TRACK_BIT_DIAG2 = 2,  // 1

    83

  TRACK_BIT_UPPER = 4,  // 2

    84

  TRACK_BIT_LOWER = 8,  // 3

    85

  TRACK_BIT_LEFT  = 16, // 4

    86

  TRACK_BIT_RIGHT = 32, // 5

    87

	TRACK_BIT_MASK  = 0x3F,

    88

} TrackBits;

    89

    90

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

    91

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

    92

typedef enum Trackdirs {

    93

  TRACKDIR_DIAG1_NE = 0,

    94

  TRACKDIR_DIAG2_SE = 1,

    95

  TRACKDIR_UPPER_E  = 2,

    96

  TRACKDIR_LOWER_E  = 3,

    97

  TRACKDIR_LEFT_S   = 4,

    98

  TRACKDIR_RIGHT_S  = 5,

    99

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

   100

	 * conversion by doing (trackdir & 7) */

   101

  TRACKDIR_DIAG1_SW = 8,

   102

  TRACKDIR_DIAG2_NW = 9,

   103

  TRACKDIR_UPPER_W  = 10,

   104

  TRACKDIR_LOWER_W  = 11,

   105

  TRACKDIR_LEFT_N   = 12,

   106

  TRACKDIR_RIGHT_N  = 13,

   107

  TRACKDIR_END,

   108

  INVALID_TRACKDIR  = 0xFF,

   109

} Trackdir;

   110

   111

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

   112

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

   113

typedef enum TrackdirBits {

   114

  TRACKDIR_BIT_DIAG1_NE = 0x1,

   115

  TRACKDIR_BIT_DIAG2_SE = 0x2,

   116

  TRACKDIR_BIT_UPPER_E  = 0x4,

   117

  TRACKDIR_BIT_LOWER_E  = 0x8,

   118

  TRACKDIR_BIT_LEFT_S   = 0x10,

   119

  TRACKDIR_BIT_RIGHT_S  = 0x20,

   120

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

   121

  TRACKDIR_BIT_DIAG1_SW = 0x0100,

   122

  TRACKDIR_BIT_DIAG2_NW = 0x0200,

   123

  TRACKDIR_BIT_UPPER_W  = 0x0400,

   124

  TRACKDIR_BIT_LOWER_W  = 0x0800,

   125

  TRACKDIR_BIT_LEFT_N   = 0x1000,

   126

  TRACKDIR_BIT_RIGHT_N  = 0x2000,

   127

	TRACKDIR_BIT_MASK			= 0x3F3F,

   128

  INVALID_TRACKDIR_BIT  = 0xFFFF,

   129

} TrackdirBits;

   130

   131

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

   132

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

   133

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

   134

 */

   135

typedef enum SignalStates {

   136

	SIGNAL_STATE_RED = 0,

   137

	SIGNAL_STATE_GREEN = 1,

   138

} SignalState;

   139

   140

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

   141

enum {

   142

	NUM_SSD_ENTRY = 256, // max amount of blocks

   143

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

   144

};

   145

   146

/**

   147

 * Maps a Trackdir to the corresponding TrackdirBits value

   148

 */

   149

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

   150

   151

/*

   152

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

   153

 * them when convenient.

   154

 */

   155

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

   156

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

   157

   158

/*

   159

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

   160

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

   161

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

   162

 */

   163

   164

/**

   165

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

   166

 * direction along with the trackdir.

   167

 */

   168

extern const byte _signal_along_trackdir[TRACKDIR_END];

   169

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

   170

   171

/**

   172

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

   173

 * direction against the trackdir.

   174

 */

   175

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   176

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   177

	return _signal_against_trackdir[trackdir];

   178

}

   179

   180

/**

   181

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

   182

 * be present on the given track.

   183

 */

   184

static inline byte SignalOnTrack(Track track) {

   185

	extern const byte _signal_on_track[TRACK_END];

   186

	return _signal_on_track[track];

   187

}

   188

   189

/*

   190

 * Some functions to query rail tiles

   191

 */

   192

   193

/**

   194

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

   195

 * depot, etc.)

   196

 */

   197

static inline RailTileType GetRailTileType(TileIndex tile)

   198

{

   199

	assert(IsTileType(tile, MP_RAILWAY));

   200

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

   201

}

   202

   203

/**

   204

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

   205

 */

   206

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

   207

   208

/**

   209

 * Checks if a rail tile has signals.

   210

 */

   211

static inline bool HasSignals(TileIndex tile)

   212

{

   213

	return GetRailTileType(tile) == RAIL_TYPE_SIGNALS;

   214

}

   215

   216

/**

   217

 * Returns the RailTileSubtype of a given rail tile with type

   218

 * RAIL_TYPE_DEPOT_WAYPOINT

   219

 */

   220

static inline RailTileSubtype GetRailTileSubtype(TileIndex tile)

   221

{

   222

	assert(GetRailTileType(tile) == RAIL_TYPE_DEPOT_WAYPOINT);

   223

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

   224

}

   225

   226

/**

   227

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

   228

 * tiles RailTileType is RAIL_TYPE_NORMAL or RAIL_TYPE_SIGNALS.

   229

 */

   230

static inline bool IsPlainRailTile(TileIndex tile)

   231

{

   232

	RailTileType rtt = GetRailTileType(tile);

   233

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

   234

}

   235

   236

/**

   237

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

   238

 */

   239

static inline TrackBits GetTrackBits(TileIndex tile)

   240

{

   241

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

   242

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

   243

}

   244

   245

/**

   246

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

   247

 * a plain rail tile (IsPlainRailTile()).

   248

 */

   249

static inline bool HasTrack(TileIndex tile, Track track)

   250

{

   251

	assert(IsValidTrack(track));

   252

	return HASBIT(GetTrackBits(tile), track);

   253

}

   254

   255

/*

   256

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   257

 * TrackdirBits, Direction and DiagDirections.

   258

 *

   259

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

   260

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

   261

 */

   262

   263

/**

   264

 * Maps a trackdir to the reverse trackdir.

   265

 */

   266

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   267

	extern const Trackdir _reverse_trackdir[TRACKDIR_END];

   268

	return _reverse_trackdir[trackdir];

   269

}

   270

   271

/*

   272

 * Maps a Track to the corresponding TrackBits value

   273

 */

   274

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

   275

   276

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

   277

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

   278

   279

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

   280

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

   281

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

   282

 * in the future.

   283

 */

   284

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

   285

   286

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

   287

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

   288

 */

   289

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

   290

   291

/**

   292

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

   293

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

   294

 * different (alternating) one for straight trackdirs

   295

 */

   296

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   297

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   298

	return _next_trackdir[trackdir];

   299

}

   300

   301

/**

   302

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

   303

 */

   304

static inline TrackBits TrackCrossesTracks(Track track) {

   305

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   306

	return _track_crosses_tracks[track];

   307

}

   308

   309

/**

   310

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

   311

 * that trackdir.

   312

 */

   313

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   314

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   315

	return _trackdir_to_exitdir[trackdir];

   316

}

   317

   318

/**

   319

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

   320

 * with the exit in the given direction.

   321

 */

   322

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

   323

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   324

	return _track_exitdir_to_trackdir[track][diagdir];

   325

}

   326

   327

/**

   328

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

   329

 * with the exit in the given direction.

   330

 */

   331

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

   332

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   333

	return _track_enterdir_to_trackdir[track][diagdir];

   334

}

   335

   336

/**

   337

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

   338

 * the track running in the given direction.

   339

 */

   340

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

   341

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   342

	return _track_direction_to_trackdir[track][dir];

   343

}

   344

   345

/**

   346

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

   347

 * direction.

   348

 */

   349

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) {

   350

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   351

	return _dir_to_diag_trackdir[diagdir];

   352

}

   353

   354

/**

   355

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

   356

 * entering the next tile. This

   357

 */

   358

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   359

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

   360

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

   361

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

   362

   363

/**

   364

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

   365

 */

   366

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   367

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   368

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   369

}

   370

   371

/**

   372

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

   373

 */

   374

static inline DiagDirection ReverseDiagdir(DiagDirection diagdir) {

   375

	extern const DiagDirection _reverse_diagdir[DIAGDIR_END];

   376

	return _reverse_diagdir[diagdir];

   377

}

   378

   379

/**

   380

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

   381

 */

   382

static inline DiagDirection DirToDiagdir(Direction dir) {

   383

	assert(dir < DIR_END);

   384

	return (DiagDirection)(dir >> 1);

   385

}

   386

   387

/* Checks if a given Track is diagonal */

   388

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

   389

   390

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

   391

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

   392

   393

/*

   394

 * Functions quering signals on tiles.

   395

 */

   396

   397

/**

   398

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

   399

 * given rail tile.

   400

 */

   401

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   402

{

   403

	assert(IsValidTrack(track));

   404

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

   405

}

   406

   407

/**

   408

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

   409

 * rail tile.

   410

 *

   411

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

   412

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

   413

 */

   414

static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)

   415

{

   416

	assert (IsValidTrackdir(trackdir));

   417

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

   418

}

   419

   420

/**

   421

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

   422

 *

   423

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

   424

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

   425

 */

   426

static inline SignalState GetSignalState(TileIndex tile, Trackdir trackdir)

   427

{

   428

	assert(IsValidTrackdir(trackdir));

   429

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

   430

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

   431

}

   432

   433

/**

   434

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

   435

 *

   436

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

   437

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

   438

 * future-compatible, though.

   439

 */

   440

static inline SignalType GetSignalType(TileIndex tile, Track track)

   441

{

   442

	assert(IsValidTrack(track));

   443

	assert(GetRailTileType(tile) == RAIL_TYPE_SIGNALS);

   444

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

   445

}

   446

   447

/**

   448

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

   449

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

   450

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

   451

 *

   452

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

   453

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

   454

 * future-compatible, though.

   455

 */

   456

static inline bool HasSemaphores(TileIndex tile, Track track)

   457

{

   458

	assert(IsValidTrack(track));

   459

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

   460

}

   461

   462

/**

   463

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

   464

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

   465

 * the tile!

   466

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

   467

 * one tile.

   468

 */

   469

RailType GetTileRailType(TileIndex tile, Trackdir trackdir);

   470

   471

/**

   472

 * Returns whether the given tile is a level crossing.

   473

 */

   474

static inline bool IsLevelCrossing(TileIndex tile)

   475

{

   476

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

   477

}

   478

   479

/**

   480

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

   481

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

   482

 * TRANSPORT_RAIL.

   483

 */

   484

static inline TransportType GetCrossingTransportType(TileIndex tile, Track track)

   485

{

   486

	/* XXX: Nicer way to write this? */

   487

	switch(track)

   488

	{

   489

		/* When map5 bit 3 is set, the road runs in the y direction (DIAG2) */

   490

		case TRACK_DIAG1:

   491

			return (HASBIT(_m[tile].m5, 3) ? TRANSPORT_RAIL : TRANSPORT_ROAD);

   492

		case TRACK_DIAG2:

   493

			return (HASBIT(_m[tile].m5, 3) ? TRANSPORT_ROAD : TRANSPORT_RAIL);

   494

		default:

   495

			assert(0);

   496

	}

   497

	return INVALID_TRANSPORT;

   498

}

   499

   500

/**

   501

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

   502

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

   503

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

   504

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

   505

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

   506

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

   507

 */

   508

static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)

   509

{

   510

	static const bool EquivRailTypes[RAILTYPE_END][RAILTYPE_END] = {