1

/* $Id$ */

     2

     3

/** @file rail.h */

     4

     5

#ifndef RAIL_H

     6

#define RAIL_H

     7

     8

#include "direction.h"

     9

#include "rail_map.h"

    10

#include "tile.h"

    11

    12

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

    13

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

    14

typedef enum Trackdirs {

    15

	TRACKDIR_X_NE = 0,

    16

	TRACKDIR_Y_SE = 1,

    17

	TRACKDIR_UPPER_E  = 2,

    18

	TRACKDIR_LOWER_E  = 3,

    19

	TRACKDIR_LEFT_S   = 4,

    20

	TRACKDIR_RIGHT_S  = 5,

    21

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

    22

	 * conversion by doing (trackdir & 7) */

    23

	TRACKDIR_X_SW = 8,

    24

	TRACKDIR_Y_NW = 9,

    25

	TRACKDIR_UPPER_W  = 10,

    26

	TRACKDIR_LOWER_W  = 11,

    27

	TRACKDIR_LEFT_N   = 12,

    28

	TRACKDIR_RIGHT_N  = 13,

    29

	TRACKDIR_END,

    30

	INVALID_TRACKDIR  = 0xFF,

    31

} Trackdir;

    32

    33

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

    34

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

    35

typedef enum TrackdirBits {

    36

	TRACKDIR_BIT_X_NE     = 0x1,

    37

	TRACKDIR_BIT_Y_SE     = 0x2,

    38

	TRACKDIR_BIT_UPPER_E  = 0x4,

    39

	TRACKDIR_BIT_LOWER_E  = 0x8,

    40

	TRACKDIR_BIT_LEFT_S   = 0x10,

    41

	TRACKDIR_BIT_RIGHT_S  = 0x20,

    42

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

    43

	TRACKDIR_BIT_X_SW     = 0x0100,

    44

	TRACKDIR_BIT_Y_NW     = 0x0200,

    45

	TRACKDIR_BIT_UPPER_W  = 0x0400,

    46

	TRACKDIR_BIT_LOWER_W  = 0x0800,

    47

	TRACKDIR_BIT_LEFT_N   = 0x1000,

    48

	TRACKDIR_BIT_RIGHT_N  = 0x2000,

    49

	TRACKDIR_BIT_MASK			= 0x3F3F,

    50

	INVALID_TRACKDIR_BIT  = 0xFFFF,

    51

} TrackdirBits;

    52

    53

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

    54

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

    55

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

    56

 */

    57

typedef enum SignalStates {

    58

	SIGNAL_STATE_RED = 0,

    59

	SIGNAL_STATE_GREEN = 1,

    60

} SignalState;

    61

    62

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

    63

 */

    64

typedef struct RailtypeInfo {

    65

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

    66

	 *  the ones used directly in the code */

    67

	struct {

    68

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

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

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

    76

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

    77

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

    78

		SpriteID tunnel;       ///< tunnel sprites base

    79

	} base_sprites;

    80

    81

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

    82

	 * directly in the code are listed */

    83

	struct {

    84

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

    85

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

    86

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

    87

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

    88

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

    89

		SpriteID build_depot;        ///< button for building depots

    90

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

    91

		SpriteID convert_rail;       ///< button for converting rail

    92

	} gui_sprites;

    93

    94

	struct {

    95

		CursorID rail_ns;

    96

		CursorID rail_swne;

    97

		CursorID rail_ew;

    98

		CursorID rail_nwse;

    99

		CursorID autorail;

   100

		CursorID depot;

   101

		CursorID tunnel;

   102

		CursorID convert;

   103

	} cursor;

   104

   105

	struct {

   106

		StringID toolbar_caption;

   107

	} strings;

   108

   109

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

   110

	SpriteID snow_offset;

   111

   112

	/** bitmask to the OTHER railtypes on which an engine of THIS railtype generates power */

   113

	RailTypeMask powered_railtypes;

   114

   115

	/** bitmask to the OTHER railtypes on which an engine of THIS railtype can physically travel */

   116

	RailTypeMask compatible_railtypes;

   117

   118

	/**

   119

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

   120

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

   121

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

   122

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

   123

	 *    the offset will fail.<p>

   124

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

   125

	 */

   126

	SpriteID total_offset;

   127

   128

	/**

   129

	  * Bridge offset

   130

	  */

   131

	SpriteID bridge_offset;

   132

   133

	/**

   134

	 * Offset to add to ground sprite when drawing custom waypoints / stations

   135

	 */

   136

	byte custom_ground_offset;

   137

} RailtypeInfo;

   138

   139

extern const RailtypeInfo _railtypes[RAILTYPE_END];

   140

   141

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

   142

enum {

   143

	NUM_SSD_ENTRY = 256, // max amount of blocks

   144

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

   145

};

   146

   147

/**

   148

 * Maps a Trackdir to the corresponding TrackdirBits value

   149

 */

   150

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

   151

   152

/**

   153

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

   154

 * them when convenient.

   155

 */

   156

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

   157

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

   158

   159

/**

   160

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

   161

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

   162

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

   163

 */

   164

   165

/**

   166

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

   167

 * direction along with the trackdir.

   168

 */

   169

extern const byte _signal_along_trackdir[TRACKDIR_END];

   170

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

   171

   172

/**

   173

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

   174

 * direction against the trackdir.

   175

 */

   176

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   177

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   178

	return _signal_against_trackdir[trackdir];

   179

}

   180

   181

/**

   182

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

   183

 * be present on the given track.

   184

 */

   185

static inline byte SignalOnTrack(Track track) {

   186

	extern const byte _signal_on_track[TRACK_END];

   187

	return _signal_on_track[track];

   188

}

   189

   190

/*

   191

 * Some functions to query rail tiles

   192

 */

   193

   194

   195

/**

   196

 * Checks if a rail tile has signals.

   197

 */

   198

static inline bool HasSignals(TileIndex tile)

   199

{

   200

	return GetRailTileType(tile) == RAIL_TYPE_SIGNALS;

   201

}

   202

   203

/**

   204

 * Returns the RailTileSubtype of a given rail tile with type

   205

 * RAIL_TYPE_DEPOT_WAYPOINT

   206

 */

   207

static inline RailTileSubtype GetRailTileSubtype(TileIndex tile)

   208

{

   209

	assert(GetRailTileType(tile) == RAIL_TYPE_DEPOT_WAYPOINT);

   210

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

   211

}

   212

   213

/**

   214

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

   215

 * tiles RailTileType is RAIL_TYPE_NORMAL or RAIL_TYPE_SIGNALS.

   216

 */

   217

static inline bool IsPlainRailTile(TileIndex tile)

   218

{

   219

	RailTileType rtt = GetRailTileType(tile);

   220

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

   221

}

   222

   223

   224

/**

   225

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

   226

 * a plain rail tile (IsPlainRailTile()).

   227

 */

   228

static inline bool HasTrack(TileIndex tile, Track track)

   229

{

   230

	assert(IsValidTrack(track));

   231

	return HASBIT(GetTrackBits(tile), track);

   232

}

   233

   234

/*

   235

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   236

 * TrackdirBits, Direction and DiagDirections.

   237

 *

   238

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

   239

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

   240

 */

   241

   242

/**

   243

 * Maps a trackdir to the reverse trackdir.

   244

 */

   245

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   246

	return (Trackdir)(trackdir ^ 8);

   247

}

   248

   249

/**

   250

 * Maps a Track to the corresponding TrackBits value

   251

 */

   252

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

   253

   254

/**

   255

 * Returns the Track that a given Trackdir represents

   256

 */

   257

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

   258

   259

/**

   260

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

   261

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

   262

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

   263

 * in the future.

   264

 */

   265

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

   266

   267

/**

   268

 * Returns a TrackdirBit mask that contains the two TrackdirBits that

   269

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

   270

 */

   271

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

   272

   273

/**

   274

 * Discards all directional information from the given TrackdirBits. Any

   275

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

   276

 */

   277

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

   278

   279

/**

   280

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

   281

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

   282

 * different (alternating) one for straight trackdirs

   283

 */

   284

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   285

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   286

	return _next_trackdir[trackdir];

   287

}

   288

   289

/**

   290

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

   291

 */

   292

static inline TrackBits TrackCrossesTracks(Track track) {

   293

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   294

	return _track_crosses_tracks[track];

   295

}

   296

   297

/**

   298

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

   299

 * that trackdir.

   300

 */

   301

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   302

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   303

	return _trackdir_to_exitdir[trackdir];

   304

}

   305

   306

/**

   307

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

   308

 * with the exit in the given direction.

   309

 */

   310

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

   311

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   312

	return _track_exitdir_to_trackdir[track][diagdir];

   313

}

   314

   315

/**

   316

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

   317

 * with the exit in the given direction.

   318

 */

   319

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

   320

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   321

	return _track_enterdir_to_trackdir[track][diagdir];

   322

}

   323

   324

/**

   325

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

   326

 * the track running in the given direction.

   327

 */

   328

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

   329

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   330

	return _track_direction_to_trackdir[track][dir];

   331

}

   332

   333

/**

   334

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

   335

 * direction.

   336

 */

   337

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) {

   338

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   339

	return _dir_to_diag_trackdir[diagdir];

   340

}

   341

   342

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   343

   344

/**

   345

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

   346

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

   347

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

   348

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

   349

   350

/**

   351

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

   352

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

   353

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

   354

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

   355

   356

/**

   357

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

   358

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

   359

 */

   360

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

   361

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

   362

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

   363

   364

   365

/**

   366

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

   367

 */

   368

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   369

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   370

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   371

}

   372

   373

   374

/* Checks if a given Track is diagonal */

   375

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

   376

   377

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

   378

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

   379

   380

/*

   381

 * Functions quering signals on tiles.

   382

 */

   383

   384

/**

   385

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

   386

 * given rail tile.

   387

 */

   388

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   389

{

   390

	assert(IsValidTrack(track));

   391

	return

   392

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   393

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

   394

}

   395

   396

/**

   397

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

   398

 * rail tile.

   399

 *

   400

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

   401

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

   402

 */

   403

static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)

   404

{

   405

	assert (IsValidTrackdir(trackdir));

   406

	return

   407

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   408

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

   409

}

   410

   411

/**

   412

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

   413

 *

   414

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

   415

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

   416

 */

   417

static inline SignalState GetSignalState(TileIndex tile, Trackdir trackdir)

   418

{

   419

	assert(IsValidTrackdir(trackdir));

   420

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

   421

	return _m[tile].m2 & SignalAlongTrackdir(trackdir) ?

   422

		SIGNAL_STATE_GREEN : SIGNAL_STATE_RED;

   423

}

   424

   425

   426

/**

   427

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

   428

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

   429

 * the tile!

   430

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

   431

 * one tile.

   432

 */

   433

RailType GetTileRailType(TileIndex tile, Trackdir trackdir);

   434

   435

   436

/**

   437

 * Returns a pointer to the Railtype information for a given railtype

   438

 * @param railtype the rail type which the information is requested for

   439

 * @return The pointer to the RailtypeInfo

   440

 */

   441

static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)

   442

{

   443

	assert(railtype < RAILTYPE_END);

   444

	return &_railtypes[railtype];

   445

}

   446

   447

/**

   448

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

   449

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

   450

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

   451

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

   452

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

   453

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

   454

 */

   455

static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)

   456

{

   457

	return HASBIT(GetRailTypeInfo(enginetype)->compatible_railtypes, tiletype);

   458

}

   459

   460

static inline bool HasPowerOnRail(RailType enginetype, RailType tiletype)

   461

{

   462

	return HASBIT(GetRailTypeInfo(enginetype)->powered_railtypes, tiletype);

   463

}

   464

   465

/**

   466

 * Checks if the given tracks overlap, ie form a crossing. Basically this

   467

 * means when there is more than one track on the tile, exept when there are

   468

 * two parallel tracks.

   469

 * @param  bits The tracks present.

   470

 * @return Whether the tracks present overlap in any way.

   471

 */

   472

static inline bool TracksOverlap(TrackBits bits)

   473

{

   474

  /* With no, or only one track, there is no overlap */

   475

  if (bits == 0 || KILL_FIRST_BIT(bits) == 0) return false;

   476

  /* We know that there are at least two tracks present. When there are more

   477

   * than 2 tracks, they will surely overlap. When there are two, they will

   478

   * always overlap unless they are lower & upper or right & left. */

   479

	return bits != TRACK_BIT_HORZ && bits != TRACK_BIT_VERT;

   480

}

   481

   482

void DrawTrainDepotSprite(int x, int y, int image, RailType railtype);

   483

void DrawDefaultWaypointSprite(int x, int y, RailType railtype);

   484

   485

/**

   486

 * Draws overhead wires and pylons for electric railways.

   487

 * @param ti The TileInfo struct of the tile being drawn

   488

 * @see DrawCatenaryRailway

   489

 */

   490

void DrawCatenary(const TileInfo *ti);

   491

   492

uint GetRailFoundation(uint tileh, TrackBits bits);

   493

#endif /* RAIL_H */