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

   142

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

   143

 */

   144

typedef struct RailtypeInfo {

   145

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

   146

	 *  the ones used directly in the code */

   147

	struct {

   148

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

   149

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

   150

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

   151

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

   152

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

   153

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

   154

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

   155

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

   156

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

   157

	} base_sprites;

   158

   159

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

   160

	 * directly in the code are listed */

   161

	struct {

   162

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

   163

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

   164

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

   165

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

   166

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

   167

		SpriteID build_depot;        ///< button for building depots

   168

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

   169

		SpriteID convert_rail;       ///< button for converting rail

   170

	} gui_sprites;

   171

   172

	struct {

   173

		StringID toolbar_caption;

   174

	} strings;

   175

   176

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

   177

	SpriteID snow_offset;

   178

   179

	/** bitmask to the OTHER railtypes that can be used by an engine of THIS railtype */

   180

	byte compatible_railtypes;

   181

   182

	/**

   183

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

   184

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

   185

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

   186

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

   187

	 *    the offset will fail.<p>

   188

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

   189

	 */

   190

	SpriteID total_offset;

   191

} RailtypeInfo;

   192

   193

extern const RailtypeInfo _railtypes[RAILTYPE_END];

   194

   195

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

   196

enum {

   197

	NUM_SSD_ENTRY = 256, // max amount of blocks

   198

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

   199

};

   200

   201

/**

   202

 * Maps a Trackdir to the corresponding TrackdirBits value

   203

 */

   204

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

   205

   206

/**

   207

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

   208

 * them when convenient.

   209

 */

   210

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

   211

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

   212

   213

/**

   214

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

   215

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

   216

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

   217

 */

   218

   219

/**

   220

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

   221

 * direction along with the trackdir.

   222

 */

   223

extern const byte _signal_along_trackdir[TRACKDIR_END];

   224

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

   225

   226

/**

   227

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

   228

 * direction against the trackdir.

   229

 */

   230

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   231

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   232

	return _signal_against_trackdir[trackdir];

   233

}

   234

   235

/**

   236

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

   237

 * be present on the given track.

   238

 */

   239

static inline byte SignalOnTrack(Track track) {

   240

	extern const byte _signal_on_track[TRACK_END];

   241

	return _signal_on_track[track];

   242

}

   243

   244

/*

   245

 * Some functions to query rail tiles

   246

 */

   247

   248

/**

   249

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

   250

 * depot, etc.)

   251

 */

   252

static inline RailTileType GetRailTileType(TileIndex tile)

   253

{

   254

	assert(IsTileType(tile, MP_RAILWAY));

   255

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

   256

}

   257

   258

/**

   259

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

   260

 */

   261

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

   262

   263

/**

   264

 * Checks if a rail tile has signals.

   265

 */

   266

static inline bool HasSignals(TileIndex tile)

   267

{

   268

	return GetRailTileType(tile) == RAIL_TYPE_SIGNALS;

   269

}

   270

   271

/**

   272

 * Returns the RailTileSubtype of a given rail tile with type

   273

 * RAIL_TYPE_DEPOT_WAYPOINT

   274

 */

   275

static inline RailTileSubtype GetRailTileSubtype(TileIndex tile)

   276

{

   277

	assert(GetRailTileType(tile) == RAIL_TYPE_DEPOT_WAYPOINT);

   278

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

   279

}

   280

   281

/**

   282

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

   283

 * tiles RailTileType is RAIL_TYPE_NORMAL or RAIL_TYPE_SIGNALS.

   284

 */

   285

static inline bool IsPlainRailTile(TileIndex tile)

   286

{

   287

	RailTileType rtt = GetRailTileType(tile);

   288

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

   289

}

   290

   291

/**

   292

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

   293

 */

   294

static inline TrackBits GetTrackBits(TileIndex tile)

   295

{

   296

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

   297

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

   298

}

   299

   300

/**

   301

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

   302

 * a plain rail tile (IsPlainRailTile()).

   303

 */

   304

static inline bool HasTrack(TileIndex tile, Track track)

   305

{

   306

	assert(IsValidTrack(track));

   307

	return HASBIT(GetTrackBits(tile), track);

   308

}

   309

   310

/*

   311

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   312

 * TrackdirBits, Direction and DiagDirections.

   313

 *

   314

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

   315

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

   316

 */

   317

   318

/**

   319

 * Maps a trackdir to the reverse trackdir.

   320

 */

   321

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   322

	extern const Trackdir _reverse_trackdir[TRACKDIR_END];

   323

	return _reverse_trackdir[trackdir];

   324

}

   325

   326

/*

   327

 * Maps a Track to the corresponding TrackBits value

   328

 */

   329

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

   330

   331

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

   332

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

   333

   334

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

   335

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

   336

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

   337

 * in the future.

   338

 */

   339

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

   340

   341

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

   342

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

   343

 */

   344

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

   345

   346

/**

   347

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

   348

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

   349

 * different (alternating) one for straight trackdirs

   350

 */

   351

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   352

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   353

	return _next_trackdir[trackdir];

   354

}

   355

   356

/**

   357

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

   358

 */

   359

static inline TrackBits TrackCrossesTracks(Track track) {

   360

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   361

	return _track_crosses_tracks[track];

   362

}

   363

   364

/**

   365

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

   366

 * that trackdir.

   367

 */

   368

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   369

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   370

	return _trackdir_to_exitdir[trackdir];

   371

}

   372

   373

/**

   374

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

   375

 * with the exit in the given direction.

   376

 */

   377

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

   378

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   379

	return _track_exitdir_to_trackdir[track][diagdir];

   380

}

   381

   382

/**

   383

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

   384

 * with the exit in the given direction.

   385

 */

   386

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

   387

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   388

	return _track_enterdir_to_trackdir[track][diagdir];

   389

}

   390

   391

/**

   392

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

   393

 * the track running in the given direction.

   394

 */

   395

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

   396

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   397

	return _track_direction_to_trackdir[track][dir];

   398

}

   399

   400

/**

   401

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

   402

 * direction.

   403

 */

   404

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) {

   405

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   406

	return _dir_to_diag_trackdir[diagdir];

   407

}

   408

   409

/**

   410

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

   411

 * entering the next tile. This

   412

 */

   413

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   414

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

   415

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

   416

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

   417

   418

/**

   419

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

   420

 */

   421

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   422

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   423

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   424

}

   425

   426

/**

   427

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

   428

 */

   429

static inline DiagDirection ReverseDiagdir(DiagDirection diagdir) {

   430

	extern const DiagDirection _reverse_diagdir[DIAGDIR_END];

   431

	return _reverse_diagdir[diagdir];

   432

}

   433

   434

/**

   435

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

   436

 */

   437

static inline DiagDirection DirToDiagdir(Direction dir) {

   438

	assert(dir < DIR_END);

   439

	return (DiagDirection)(dir >> 1);

   440

}

   441

   442

/* Checks if a given Track is diagonal */

   443

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

   444

   445

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

   446

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

   447

   448

/*

   449

 * Functions quering signals on tiles.

   450

 */

   451

   452

/**

   453

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

   454

 * given rail tile.

   455

 */

   456

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   457

{

   458

	assert(IsValidTrack(track));

   459

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

   460

}

   461

   462

/**

   463

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

   464

 * rail tile.

   465

 *

   466

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

   467

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

   468

 */

   469

static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)

   470

{

   471

	assert (IsValidTrackdir(trackdir));

   472

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

   473

}

   474

   475

/**

   476

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

   477

 *

   478

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

   479

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

   480

 */

   481

static inline SignalState GetSignalState(TileIndex tile, Trackdir trackdir)

   482

{

   483

	assert(IsValidTrackdir(trackdir));

   484

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

   485

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

   486

}

   487

   488

/**

   489

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

   490

 *

   491

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

   492

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

   493

 * future-compatible, though.

   494

 */

   495

static inline SignalType GetSignalType(TileIndex tile, Track track)

   496

{

   497

	assert(IsValidTrack(track));

   498

	assert(GetRailTileType(tile) == RAIL_TYPE_SIGNALS);

   499

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

   500

}

   501

   502

/**

   503

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

   504

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

   505

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

   506

 *

   507

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

   508

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

   509