1

/* $Id$ */

     2

     3

/** @file rail.h */

     4

     5

#ifndef RAIL_H

     6

#define RAIL_H

     7

     8

#include "direction.h"

     9

#include "tile.h"

    10

    11

/*

    12

 * Some enums for accesing the map bytes for rail tiles

    13

 */

    14

    15

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

    16

 * get these values */

    17

typedef enum RailTileTypes {

    18

	RAIL_TYPE_NORMAL         = 0x0,

    19

	RAIL_TYPE_SIGNALS        = 0x40,

    20

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

    21

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

    22

	RAIL_TILE_TYPE_MASK      = 0xC0,

    23

} RailTileType;

    24

    25

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

    26

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

    27

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

    28

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

    29

														 * containing a value from RailTileTypes above.

    30

														 * This value is only maintained for backwards

    31

														 * compatibility */

    32

    33

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

    34

	 * TRACK_BIT_* */

    35

};

    36

    37

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

    38

 * RAIL_TYPE_DEPOT_WAYPOINT */

    39

typedef enum RailTileSubtypes {

    40

	RAIL_SUBTYPE_DEPOT    = 0x00,

    41

	RAIL_SUBTYPE_WAYPOINT = 0x04,

    42

	RAIL_SUBTYPE_MASK     = 0x3C,

    43

} RailTileSubtype;

    44

    45

    46

typedef enum RailTypes {

    47

	RAILTYPE_RAIL   = 0,

    48

	RAILTYPE_MONO   = 1,

    49

	RAILTYPE_MAGLEV = 2,

    50

	RAILTYPE_END,

    51

	RAILTYPE_MASK   = 0x3,

    52

	INVALID_RAILTYPE = 0xFF,

    53

} RailType;

    54

    55

    56

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

    57

 * with TrackToTrackbit */

    58

typedef enum Tracks {

    59

	TRACK_X     = 0,

    60

	TRACK_Y     = 1,

    61

	TRACK_UPPER = 2,

    62

	TRACK_LOWER = 3,

    63

	TRACK_LEFT  = 4,

    64

	TRACK_RIGHT = 5,

    65

	TRACK_END,

    66

	INVALID_TRACK = 0xFF,

    67

} Track;

    68

    69

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

    70

typedef enum TrackBits {

    71

	TRACK_BIT_X     = 1U,    // 0

    72

	TRACK_BIT_Y     = 2U,    // 1

    73

	TRACK_BIT_UPPER = 4U,    // 2

    74

	TRACK_BIT_LOWER = 8U,    // 3

    75

	TRACK_BIT_LEFT  = 16U,   // 4

    76

	TRACK_BIT_RIGHT = 32U,   // 5

    77

	TRACK_BIT_MASK  = 0x3FU,

    78

} TrackBits;

    79

    80

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

    81

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

    82

typedef enum Trackdirs {

    83

	TRACKDIR_X_NE = 0,

    84

	TRACKDIR_Y_SE = 1,

    85

	TRACKDIR_UPPER_E  = 2,

    86

	TRACKDIR_LOWER_E  = 3,

    87

	TRACKDIR_LEFT_S   = 4,

    88

	TRACKDIR_RIGHT_S  = 5,

    89

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

    90

	 * conversion by doing (trackdir & 7) */

    91

	TRACKDIR_X_SW = 8,

    92

	TRACKDIR_Y_NW = 9,

    93

	TRACKDIR_UPPER_W  = 10,

    94

	TRACKDIR_LOWER_W  = 11,

    95

	TRACKDIR_LEFT_N   = 12,

    96

	TRACKDIR_RIGHT_N  = 13,

    97

	TRACKDIR_END,

    98

	INVALID_TRACKDIR  = 0xFF,

    99

} Trackdir;

   100

   101

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

   102

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

   103

typedef enum TrackdirBits {

   104

	TRACKDIR_BIT_X_NE     = 0x1,

   105

	TRACKDIR_BIT_Y_SE     = 0x2,

   106

	TRACKDIR_BIT_UPPER_E  = 0x4,

   107

	TRACKDIR_BIT_LOWER_E  = 0x8,

   108

	TRACKDIR_BIT_LEFT_S   = 0x10,

   109

	TRACKDIR_BIT_RIGHT_S  = 0x20,

   110

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

   111

	TRACKDIR_BIT_X_SW     = 0x0100,

   112

	TRACKDIR_BIT_Y_NW     = 0x0200,

   113

	TRACKDIR_BIT_UPPER_W  = 0x0400,

   114

	TRACKDIR_BIT_LOWER_W  = 0x0800,

   115

	TRACKDIR_BIT_LEFT_N   = 0x1000,

   116

	TRACKDIR_BIT_RIGHT_N  = 0x2000,

   117

	TRACKDIR_BIT_MASK			= 0x3F3F,

   118

	INVALID_TRACKDIR_BIT  = 0xFFFF,

   119

} TrackdirBits;

   120

   121

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

   122

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

   123

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

   124

 */

   125

typedef enum SignalStates {

   126

	SIGNAL_STATE_RED = 0,

   127

	SIGNAL_STATE_GREEN = 1,

   128

} SignalState;

   129

   130

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

   131

 */

   132

typedef struct RailtypeInfo {

   133

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

   134

	 *  the ones used directly in the code */

   135

	struct {

   136

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

   137

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

   138

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

   139

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

   140

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

   141

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

   142

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

   143

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

   144

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

   145

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

   146

		SpriteID tunnel;       ///< tunnel sprites base

   147

	} base_sprites;

   148

   149

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

   150

	 * directly in the code are listed */

   151

	struct {

   152

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

   153

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

   154

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

   155

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

   156

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

   157

		SpriteID build_depot;        ///< button for building depots

   158

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

   159

		SpriteID convert_rail;       ///< button for converting rail

   160

	} gui_sprites;

   161

   162

	struct {

   163

		CursorID rail_ns;

   164

		CursorID rail_swne;

   165

		CursorID rail_ew;

   166

		CursorID rail_nwse;

   167

		CursorID autorail;

   168

		CursorID depot;

   169

		CursorID tunnel;

   170

		CursorID convert;

   171

	} cursor;

   172

   173

	struct {

   174

		StringID toolbar_caption;

   175

	} strings;

   176

   177

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

   178

	SpriteID snow_offset;

   179

   180

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

   181

	byte compatible_railtypes;

   182

   183

	/**

   184

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

   185

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

   186

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

   187

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

   188

	 *    the offset will fail.<p>

   189

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

   190

	 */

   191

	SpriteID total_offset;

   192

   193

	/**

   194

	  * Bridge offset

   195

	  */

   196

	SpriteID bridge_offset;

   197

} RailtypeInfo;

   198

   199

extern const RailtypeInfo _railtypes[RAILTYPE_END];

   200

   201

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

   202

enum {

   203

	NUM_SSD_ENTRY = 256, // max amount of blocks

   204

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

   205

};

   206

   207

/**

   208

 * Maps a Trackdir to the corresponding TrackdirBits value

   209

 */

   210

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

   211

   212

/**

   213

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

   214

 * them when convenient.

   215

 */

   216

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

   217

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

   218

   219

/**

   220

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

   221

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

   222

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

   223

 */

   224

   225

/**

   226

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

   227

 * direction along with the trackdir.

   228

 */

   229

extern const byte _signal_along_trackdir[TRACKDIR_END];

   230

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

   231

   232

/**

   233

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

   234

 * direction against the trackdir.

   235

 */

   236

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   237

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   238

	return _signal_against_trackdir[trackdir];

   239

}

   240

   241

/**

   242

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

   243

 * be present on the given track.

   244

 */

   245

static inline byte SignalOnTrack(Track track) {

   246

	extern const byte _signal_on_track[TRACK_END];

   247

	return _signal_on_track[track];

   248

}

   249

   250

/*

   251

 * Some functions to query rail tiles

   252

 */

   253

   254

/**

   255

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

   256

 * depot, etc.)

   257

 */

   258

static inline RailTileType GetRailTileType(TileIndex tile)

   259

{

   260

	assert(IsTileType(tile, MP_RAILWAY));

   261

	return _m[tile].m5 & RAIL_TILE_TYPE_MASK;

   262

}

   263

   264

/**

   265

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

   266

 */

   267

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

   268

   269

/**

   270

 * Checks if a rail tile has signals.

   271

 */

   272

static inline bool HasSignals(TileIndex tile)

   273

{

   274

	return GetRailTileType(tile) == RAIL_TYPE_SIGNALS;

   275

}

   276

   277

/**

   278

 * Returns the RailTileSubtype of a given rail tile with type

   279

 * RAIL_TYPE_DEPOT_WAYPOINT

   280

 */

   281

static inline RailTileSubtype GetRailTileSubtype(TileIndex tile)

   282

{

   283

	assert(GetRailTileType(tile) == RAIL_TYPE_DEPOT_WAYPOINT);

   284

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

   285

}

   286

   287

/**

   288

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

   289

 * tiles RailTileType is RAIL_TYPE_NORMAL or RAIL_TYPE_SIGNALS.

   290

 */

   291

static inline bool IsPlainRailTile(TileIndex tile)

   292

{

   293

	RailTileType rtt = GetRailTileType(tile);

   294

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

   295

}

   296

   297

/**

   298

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

   299

 */

   300

static inline TrackBits GetTrackBits(TileIndex tile)

   301

{

   302

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

   303

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

   304

}

   305

   306

/**

   307

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

   308

 * a plain rail tile (IsPlainRailTile()).

   309

 */

   310

static inline bool HasTrack(TileIndex tile, Track track)

   311

{

   312

	assert(IsValidTrack(track));

   313

	return HASBIT(GetTrackBits(tile), track);

   314

}

   315

   316

/*

   317

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   318

 * TrackdirBits, Direction and DiagDirections.

   319

 *

   320

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

   321

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

   322

 */

   323

   324

/**

   325

 * Maps a trackdir to the reverse trackdir.

   326

 */

   327

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   328

	extern const Trackdir _reverse_trackdir[TRACKDIR_END];

   329

	return _reverse_trackdir[trackdir];

   330

}

   331

   332

/**

   333

 * Maps a Track to the corresponding TrackBits value

   334

 */

   335

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

   336

   337

/**

   338

 * Returns the Track that a given Trackdir represents

   339

 */

   340

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

   341

   342

/**

   343

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

   344

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

   345

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

   346

 * in the future.

   347

 */

   348

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

   349

   350

/**

   351

 * Returns a TrackdirBit mask that contains the two TrackdirBits that

   352

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

   353

 */

   354

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

   355

   356

/**

   357

 * Discards all directional information from the given TrackdirBits. Any

   358

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

   359

 */

   360

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

   361

   362

/**

   363

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

   364

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

   365

 * different (alternating) one for straight trackdirs

   366

 */

   367

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   368

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   369

	return _next_trackdir[trackdir];

   370

}

   371

   372

/**

   373

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

   374

 */

   375

static inline TrackBits TrackCrossesTracks(Track track) {

   376

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   377

	return _track_crosses_tracks[track];

   378

}

   379

   380

/**

   381

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

   382

 * that trackdir.

   383

 */

   384

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   385

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   386

	return _trackdir_to_exitdir[trackdir];

   387

}

   388

   389

/**

   390

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

   391

 * with the exit in the given direction.

   392

 */

   393

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

   394

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   395

	return _track_exitdir_to_trackdir[track][diagdir];

   396

}

   397

   398

/**

   399

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

   400

 * with the exit in the given direction.

   401

 */

   402

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

   403

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   404

	return _track_enterdir_to_trackdir[track][diagdir];

   405

}

   406

   407

/**

   408

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

   409

 * the track running in the given direction.

   410

 */

   411

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

   412

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   413

	return _track_direction_to_trackdir[track][dir];

   414

}

   415

   416

/**

   417

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

   418

 * direction.

   419

 */

   420

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) {

   421

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   422

	return _dir_to_diag_trackdir[diagdir];

   423

}

   424

   425

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   426

   427

/**

   428

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

   429

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

   430

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

   431

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

   432

   433

/**

   434

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

   435

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

   436

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

   437

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

   438

   439

/**

   440

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

   441

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

   442

 */

   443

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

   444

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

   445

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

   446

   447

   448

/**

   449

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

   450

 */

   451

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   452

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   453

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   454

}

   455

   456

   457

/* Checks if a given Track is diagonal */

   458

static inline bool IsDiagonalTrack(Track track) { return (track == TRACK_X) || (track == TRACK_Y); }

   459

   460

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

   461

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

   462

   463

/*

   464

 * Functions quering signals on tiles.

   465

 */

   466

   467

/**

   468

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

   469

 * given rail tile.

   470

 */

   471

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   472

{

   473

	assert(IsValidTrack(track));

   474

	return

   475

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   476

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

   477

}

   478

   479

/**

   480

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

   481

 * rail tile.

   482

 *

   483

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

   484

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

   485

 */

   486

static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)

   487

{

   488

	assert (IsValidTrackdir(trackdir));

   489

	return

   490

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   491

		_m[tile].m3 & SignalAlongTrackdir(trackdir);

   492

}

   493

   494

/**

   495

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

   496

 *

   497

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

   498

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

   499

 */

   500

static inline SignalState GetSignalState(TileIndex tile, Trackdir trackdir)

   501

{

   502

	assert(IsValidTrackdir(trackdir));