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_END,

    51

	SIGTYPE_MASK    = 3,

    52

} SignalType;

    53

    54

typedef enum RailTypes {

    55

	RAILTYPE_RAIL   = 0,

    56

	RAILTYPE_MONO   = 1,

    57

	RAILTYPE_MAGLEV = 2,

    58

	RAILTYPE_END,

    59

	RAILTYPE_MASK   = 0x3,

    60

	INVALID_RAILTYPE = 0xFF,

    61

} RailType;

    62

    63

enum {

    64

	SIG_SEMAPHORE_MASK = 1 << 2,

    65

};

    66

    67

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

    68

 * with TrackToTrackbit */

    69

typedef enum Tracks {

    70

	TRACK_DIAG1 = 0,

    71

	TRACK_DIAG2 = 1,

    72

	TRACK_UPPER = 2,

    73

	TRACK_LOWER = 3,

    74

	TRACK_LEFT  = 4,

    75

	TRACK_RIGHT = 5,

    76

	TRACK_END,

    77

	INVALID_TRACK = 0xFF,

    78

} Track;

    79

    80

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

    81

typedef enum TrackBits {

    82

	TRACK_BIT_DIAG1 = 1U,    // 0

    83

	TRACK_BIT_DIAG2 = 2U,    // 1

    84

	TRACK_BIT_UPPER = 4U,    // 2

    85

	TRACK_BIT_LOWER = 8U,    // 3

    86

	TRACK_BIT_LEFT  = 16U,   // 4

    87

	TRACK_BIT_RIGHT = 32U,   // 5

    88

	TRACK_BIT_MASK  = 0x3FU,

    89

} TrackBits;

    90

    91

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

    92

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

    93

typedef enum Trackdirs {

    94

	TRACKDIR_DIAG1_NE = 0,

    95

	TRACKDIR_DIAG2_SE = 1,

    96

	TRACKDIR_UPPER_E  = 2,

    97

	TRACKDIR_LOWER_E  = 3,

    98

	TRACKDIR_LEFT_S   = 4,

    99

	TRACKDIR_RIGHT_S  = 5,

   100

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

   101

	 * conversion by doing (trackdir & 7) */

   102

	TRACKDIR_DIAG1_SW = 8,

   103

	TRACKDIR_DIAG2_NW = 9,

   104

	TRACKDIR_UPPER_W  = 10,

   105

	TRACKDIR_LOWER_W  = 11,

   106

	TRACKDIR_LEFT_N   = 12,

   107

	TRACKDIR_RIGHT_N  = 13,

   108

	TRACKDIR_END,

   109

	INVALID_TRACKDIR  = 0xFF,

   110

} Trackdir;

   111

   112

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

   113

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

   114

typedef enum TrackdirBits {

   115

	TRACKDIR_BIT_DIAG1_NE = 0x1,

   116

	TRACKDIR_BIT_DIAG2_SE = 0x2,

   117

	TRACKDIR_BIT_UPPER_E  = 0x4,

   118

	TRACKDIR_BIT_LOWER_E  = 0x8,

   119

	TRACKDIR_BIT_LEFT_S   = 0x10,

   120

	TRACKDIR_BIT_RIGHT_S  = 0x20,

   121

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

   122

	TRACKDIR_BIT_DIAG1_SW = 0x0100,

   123

	TRACKDIR_BIT_DIAG2_NW = 0x0200,

   124

	TRACKDIR_BIT_UPPER_W  = 0x0400,

   125

	TRACKDIR_BIT_LOWER_W  = 0x0800,

   126

	TRACKDIR_BIT_LEFT_N   = 0x1000,

   127

	TRACKDIR_BIT_RIGHT_N  = 0x2000,

   128

	TRACKDIR_BIT_MASK			= 0x3F3F,

   129

	INVALID_TRACKDIR_BIT  = 0xFFFF,

   130

} TrackdirBits;

   131

   132

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

   133

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

   134

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

   135

 */

   136

typedef enum SignalStates {

   137

	SIGNAL_STATE_RED = 0,

   138

	SIGNAL_STATE_GREEN = 1,

   139

} SignalState;

   140

   141

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

   142

 */

   143

typedef struct RailtypeInfo {

   144

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

   145

	 *  the ones used directly in the code */

   146

	struct {

   147

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

   148

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

   149

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

   150

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

   151

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

   152

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

   153

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

   154

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

   155

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

   156

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

   157

		SpriteID tunnel;       ///< tunnel sprites base

   158

	} base_sprites;

   159

   160

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

   161

	 * directly in the code are listed */

   162

	struct {

   163

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

   164

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

   165

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

   166

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

   167

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

   168

		SpriteID build_depot;        ///< button for building depots

   169

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

   170

		SpriteID convert_rail;       ///< button for converting rail

   171

	} gui_sprites;

   172

   173

	struct {

   174

		CursorID rail_ns;

   175

		CursorID rail_swne;

   176

		CursorID rail_ew;

   177

		CursorID rail_nwse;

   178

		CursorID autorail;

   179

		CursorID depot;

   180

		CursorID tunnel;

   181

		CursorID convert;

   182

	} cursor;

   183

   184

	struct {

   185

		StringID toolbar_caption;

   186

	} strings;

   187

   188

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

   189

	SpriteID snow_offset;

   190

   191

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

   192

	byte compatible_railtypes;

   193

   194

	/**

   195

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

   196

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

   197

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

   198

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

   199

	 *    the offset will fail.<p>

   200

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

   201

	 */

   202

	SpriteID total_offset;

   203

   204

	/**

   205

	  * Bridge offset

   206

	  */

   207

	SpriteID bridge_offset;

   208

} RailtypeInfo;

   209

   210

extern const RailtypeInfo _railtypes[RAILTYPE_END];

   211

   212

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

   213

enum {

   214

	NUM_SSD_ENTRY = 256, // max amount of blocks

   215

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

   216

};

   217

   218

/**

   219

 * Maps a Trackdir to the corresponding TrackdirBits value

   220

 */

   221

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

   222

   223

/**

   224

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

   225

 * them when convenient.

   226

 */

   227

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

   228

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

   229

   230

/**

   231

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

   232

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

   233

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

   234

 */

   235

   236

/**

   237

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

   238

 * direction along with the trackdir.

   239

 */

   240

extern const byte _signal_along_trackdir[TRACKDIR_END];

   241

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

   242

   243

/**

   244

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

   245

 * direction against the trackdir.

   246

 */

   247

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   248

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   249

	return _signal_against_trackdir[trackdir];

   250

}

   251

   252

/**

   253

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

   254

 * be present on the given track.

   255

 */

   256

static inline byte SignalOnTrack(Track track) {

   257

	extern const byte _signal_on_track[TRACK_END];

   258

	return _signal_on_track[track];

   259

}

   260

   261

/*

   262

 * Some functions to query rail tiles

   263

 */

   264

   265

/**

   266

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

   267

 * depot, etc.)

   268

 */

   269

static inline RailTileType GetRailTileType(TileIndex tile)

   270

{

   271

	assert(IsTileType(tile, MP_RAILWAY));

   272

	return _m[tile].m5 & RAIL_TILE_TYPE_MASK;

   273

}

   274

   275

/**

   276

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

   277

 */

   278

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

   279

   280

/**

   281

 * Checks if a rail tile has signals.

   282

 */

   283

static inline bool HasSignals(TileIndex tile)

   284

{

   285

	return GetRailTileType(tile) == RAIL_TYPE_SIGNALS;

   286

}

   287

   288

/**

   289

 * Returns the RailTileSubtype of a given rail tile with type

   290

 * RAIL_TYPE_DEPOT_WAYPOINT

   291

 */

   292

static inline RailTileSubtype GetRailTileSubtype(TileIndex tile)

   293

{

   294

	assert(GetRailTileType(tile) == RAIL_TYPE_DEPOT_WAYPOINT);

   295

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

   296

}

   297

   298

/**

   299

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

   300

 * tiles RailTileType is RAIL_TYPE_NORMAL or RAIL_TYPE_SIGNALS.

   301

 */

   302

static inline bool IsPlainRailTile(TileIndex tile)

   303

{

   304

	RailTileType rtt = GetRailTileType(tile);

   305

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

   306

}

   307

   308

/**

   309

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

   310

 */

   311

static inline TrackBits GetTrackBits(TileIndex tile)

   312

{

   313

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

   314

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

   315

}

   316

   317

/**

   318

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

   319

 * a plain rail tile (IsPlainRailTile()).

   320

 */

   321

static inline bool HasTrack(TileIndex tile, Track track)

   322

{

   323

	assert(IsValidTrack(track));

   324

	return HASBIT(GetTrackBits(tile), track);

   325

}

   326

   327

/*

   328

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   329

 * TrackdirBits, Direction and DiagDirections.

   330

 *

   331

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

   332

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

   333

 */

   334

   335

/**

   336

 * Maps a trackdir to the reverse trackdir.

   337

 */

   338

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   339

	extern const Trackdir _reverse_trackdir[TRACKDIR_END];

   340

	return _reverse_trackdir[trackdir];

   341

}

   342

   343

/**

   344

 * Maps a Track to the corresponding TrackBits value

   345

 */

   346

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

   347

   348

/**

   349

 * Returns the Track that a given Trackdir represents

   350

 */

   351

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

   352

   353

/**

   354

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

   355

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

   356

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

   357

 * in the future.

   358

 */

   359

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

   360

   361

/**

   362

 * Returns a TrackdirBit mask that contains the two TrackdirBits that

   363

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

   364

 */

   365

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

   366

   367

/**

   368

 * Discards all directional information from the given TrackdirBits. Any

   369

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

   370

 */

   371

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

   372

   373

/**

   374

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

   375

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

   376

 * different (alternating) one for straight trackdirs

   377

 */

   378

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   379

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   380

	return _next_trackdir[trackdir];

   381

}

   382

   383

/**

   384

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

   385

 */

   386

static inline TrackBits TrackCrossesTracks(Track track) {

   387

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   388

	return _track_crosses_tracks[track];

   389

}

   390

   391

/**

   392

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

   393

 * that trackdir.

   394

 */

   395

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   396

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   397

	return _trackdir_to_exitdir[trackdir];

   398

}

   399

   400

/**

   401

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

   402

 * with the exit in the given direction.

   403

 */

   404

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

   405

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   406

	return _track_exitdir_to_trackdir[track][diagdir];

   407

}

   408

   409

/**

   410

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

   411

 * with the exit in the given direction.

   412

 */

   413

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

   414

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   415

	return _track_enterdir_to_trackdir[track][diagdir];

   416

}

   417

   418

/**

   419

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

   420

 * the track running in the given direction.

   421

 */

   422

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

   423

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   424

	return _track_direction_to_trackdir[track][dir];

   425

}

   426

   427

/**

   428

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

   429

 * direction.

   430

 */

   431

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) {

   432

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   433

	return _dir_to_diag_trackdir[diagdir];

   434

}

   435

   436

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   437

   438

/**

   439

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

   440

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

   441

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

   442

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

   443

   444

/**

   445

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

   446

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

   447

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

   448

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

   449

   450

/**

   451

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

   452

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

   453

 */

   454

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

   455

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

   456

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

   457

   458

   459

/**

   460

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

   461

 */

   462

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   463

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   464

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   465

}

   466

   467

/**

   468

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

   469

 */

   470

static inline DiagDirection ReverseDiagdir(DiagDirection diagdir) {

   471

	extern const DiagDirection _reverse_diagdir[DIAGDIR_END];

   472

	return _reverse_diagdir[diagdir];

   473

}

   474

   475

/**

   476

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

   477

 */

   478

static inline DiagDirection DirToDiagdir(Direction dir) {

   479

	assert(dir < DIR_END);

   480

	return (DiagDirection)(dir >> 1);

   481

}

   482

   483

/* Checks if a given Track is diagonal */

   484

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

   485

   486

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

   487

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

   488

   489

/*

   490

 * Functions quering signals on tiles.

   491

 */

   492

   493

/**

   494

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

   495

 * given rail tile.

   496

 */

   497

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   498

{

   499

	assert(IsValidTrack(track));

   500

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

   501

}

   502