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

    13

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

    14

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

    15

typedef enum Trackdirs {

    16

	TRACKDIR_X_NE = 0,

    17

	TRACKDIR_Y_SE = 1,

    18

	TRACKDIR_UPPER_E  = 2,

    19

	TRACKDIR_LOWER_E  = 3,

    20

	TRACKDIR_LEFT_S   = 4,

    21

	TRACKDIR_RIGHT_S  = 5,

    22

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

    23

	 * conversion by doing (trackdir & 7) */

    24

	TRACKDIR_X_SW = 8,

    25

	TRACKDIR_Y_NW = 9,

    26

	TRACKDIR_UPPER_W  = 10,

    27

	TRACKDIR_LOWER_W  = 11,

    28

	TRACKDIR_LEFT_N   = 12,

    29

	TRACKDIR_RIGHT_N  = 13,

    30

	TRACKDIR_END,

    31

	INVALID_TRACKDIR  = 0xFF,

    32

} Trackdir;

    33

    34

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

    35

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

    36

typedef enum TrackdirBits {

    37

	TRACKDIR_BIT_X_NE     = 0x1,

    38

	TRACKDIR_BIT_Y_SE     = 0x2,

    39

	TRACKDIR_BIT_UPPER_E  = 0x4,

    40

	TRACKDIR_BIT_LOWER_E  = 0x8,

    41

	TRACKDIR_BIT_LEFT_S   = 0x10,

    42

	TRACKDIR_BIT_RIGHT_S  = 0x20,

    43

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

    44

	TRACKDIR_BIT_X_SW     = 0x0100,

    45

	TRACKDIR_BIT_Y_NW     = 0x0200,

    46

	TRACKDIR_BIT_UPPER_W  = 0x0400,

    47

	TRACKDIR_BIT_LOWER_W  = 0x0800,

    48

	TRACKDIR_BIT_LEFT_N   = 0x1000,

    49

	TRACKDIR_BIT_RIGHT_N  = 0x2000,

    50

	TRACKDIR_BIT_MASK			= 0x3F3F,

    51

	INVALID_TRACKDIR_BIT  = 0xFFFF,

    52

} TrackdirBits;

    53

    54

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

    55

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

    56

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

    57

 */

    58

typedef enum SignalStates {

    59

	SIGNAL_STATE_RED = 0,

    60

	SIGNAL_STATE_GREEN = 1,

    61

} SignalState;

    62

    63

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

    64

 */

    65

typedef struct RailtypeInfo {

    66

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

    67

	 *  the ones used directly in the code */

    68

	struct {

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

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

    76

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

    77

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

    78

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

    79

		SpriteID tunnel;       ///< tunnel sprites base

    80

	} base_sprites;

    81

    82

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

    83

	 * directly in the code are listed */

    84

	struct {

    85

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

    86

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

    87

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

    88

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

    89

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

    90

		SpriteID build_depot;        ///< button for building depots

    91

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

    92

		SpriteID convert_rail;       ///< button for converting rail

    93

	} gui_sprites;

    94

    95

	struct {

    96

		CursorID rail_ns;

    97

		CursorID rail_swne;

    98

		CursorID rail_ew;

    99

		CursorID rail_nwse;

   100

		CursorID autorail;

   101

		CursorID depot;

   102

		CursorID tunnel;

   103

		CursorID convert;

   104

	} cursor;

   105

   106

	struct {

   107

		StringID toolbar_caption;

   108

	} strings;

   109

   110

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

   111

	SpriteID snow_offset;

   112

   113

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

   114

	byte compatible_railtypes;

   115

   116

	/**

   117

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

   118

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

   119

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

   120

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

   121

	 *    the offset will fail.<p>

   122

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

   123

	 */

   124

	SpriteID total_offset;

   125

   126

	/**

   127

	  * Bridge offset

   128

	  */

   129

	SpriteID bridge_offset;

   130

} RailtypeInfo;

   131

   132

extern const RailtypeInfo _railtypes[RAILTYPE_END];

   133

   134

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

   135

enum {

   136

	NUM_SSD_ENTRY = 256, // max amount of blocks

   137

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

   138

};

   139

   140

/**

   141

 * Maps a Trackdir to the corresponding TrackdirBits value

   142

 */

   143

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

   144

   145

/**

   146

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

   147

 * them when convenient.

   148

 */

   149

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

   150

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

   151

   152

/**

   153

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

   154

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

   155

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

   156

 */

   157

   158

/**

   159

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

   160

 * direction along with the trackdir.

   161

 */

   162

extern const byte _signal_along_trackdir[TRACKDIR_END];

   163

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

   164

   165

/**

   166

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

   167

 * direction against the trackdir.

   168

 */

   169

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   170

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   171

	return _signal_against_trackdir[trackdir];

   172

}

   173

   174

/**

   175

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

   176

 * be present on the given track.

   177

 */

   178

static inline byte SignalOnTrack(Track track) {

   179

	extern const byte _signal_on_track[TRACK_END];

   180

	return _signal_on_track[track];

   181

}

   182

   183

/*

   184

 * Some functions to query rail tiles

   185

 */

   186

   187

   188

/**

   189

 * Checks if a rail tile has signals.

   190

 */

   191

static inline bool HasSignals(TileIndex tile)

   192

{

   193

	return GetRailTileType(tile) == RAIL_TYPE_SIGNALS;

   194

}

   195

   196

/**

   197

 * Returns the RailTileSubtype of a given rail tile with type

   198

 * RAIL_TYPE_DEPOT_WAYPOINT

   199

 */

   200

static inline RailTileSubtype GetRailTileSubtype(TileIndex tile)

   201

{

   202

	assert(GetRailTileType(tile) == RAIL_TYPE_DEPOT_WAYPOINT);

   203

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

   204

}

   205

   206

/**

   207

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

   208

 * tiles RailTileType is RAIL_TYPE_NORMAL or RAIL_TYPE_SIGNALS.

   209

 */

   210

static inline bool IsPlainRailTile(TileIndex tile)

   211

{

   212

	RailTileType rtt = GetRailTileType(tile);

   213

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

   214

}

   215

   216

/**

   217

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

   218

 */

   219

static inline TrackBits GetTrackBits(TileIndex tile)

   220

{

   221

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

   222

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

   223

}

   224

   225

/**

   226

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

   227

 * a plain rail tile (IsPlainRailTile()).

   228

 */

   229

static inline bool HasTrack(TileIndex tile, Track track)

   230

{

   231

	assert(IsValidTrack(track));

   232

	return HASBIT(GetTrackBits(tile), track);

   233

}

   234

   235

/*

   236

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   237

 * TrackdirBits, Direction and DiagDirections.

   238

 *

   239

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

   240

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

   241

 */

   242

   243

/**

   244

 * Maps a trackdir to the reverse trackdir.

   245

 */

   246

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   247

	extern const Trackdir _reverse_trackdir[TRACKDIR_END];

   248

	return _reverse_trackdir[trackdir];

   249

}

   250

   251

/**

   252

 * Maps a Track to the corresponding TrackBits value

   253

 */

   254

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

   255

   256

/**

   257

 * Returns the Track that a given Trackdir represents

   258

 */

   259

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

   260

   261

/**

   262

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

   263

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

   264

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

   265

 * in the future.

   266

 */

   267

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

   268

   269

/**

   270

 * Returns a TrackdirBit mask that contains the two TrackdirBits that

   271

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

   272

 */

   273

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

   274

   275

/**

   276

 * Discards all directional information from the given TrackdirBits. Any

   277

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

   278

 */

   279

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

   280

   281

/**

   282

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

   283

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

   284

 * different (alternating) one for straight trackdirs

   285

 */

   286

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   287

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   288

	return _next_trackdir[trackdir];

   289

}

   290

   291

/**

   292

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

   293

 */

   294

static inline TrackBits TrackCrossesTracks(Track track) {

   295

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   296

	return _track_crosses_tracks[track];

   297

}

   298

   299

/**

   300

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

   301

 * that trackdir.

   302

 */

   303

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   304

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   305

	return _trackdir_to_exitdir[trackdir];

   306

}

   307

   308

/**

   309

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

   310

 * with the exit in the given direction.

   311

 */

   312

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

   313

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   314

	return _track_exitdir_to_trackdir[track][diagdir];

   315

}

   316

   317

/**

   318

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

   319

 * with the exit in the given direction.

   320

 */

   321

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

   322

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   323

	return _track_enterdir_to_trackdir[track][diagdir];

   324

}

   325

   326

/**

   327

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

   328

 * the track running in the given direction.

   329

 */

   330

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

   331

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   332

	return _track_direction_to_trackdir[track][dir];

   333

}

   334

   335

/**

   336

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

   337

 * direction.

   338

 */

   339

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) {

   340

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   341

	return _dir_to_diag_trackdir[diagdir];

   342

}

   343

   344

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   345

   346

/**

   347

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

   348

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

   349

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

   350

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

   351

   352

/**

   353

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

   354

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

   355

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

   356

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

   357

   358

/**

   359

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

   360

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

   361

 */

   362

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

   363

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

   364

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

   365

   366

   367

/**

   368

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

   369

 */

   370

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   371

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   372

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   373

}

   374

   375

   376

/* Checks if a given Track is diagonal */

   377

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

   378

   379

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

   380

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

   381

   382

/*

   383

 * Functions quering signals on tiles.

   384

 */

   385

   386

/**

   387

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

   388

 * given rail tile.

   389

 */

   390

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   391

{

   392

	assert(IsValidTrack(track));

   393

	return

   394

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   395

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

   396

}

   397

   398

/**

   399

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

   400

 * rail tile.

   401

 *

   402

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

   403

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

   404

 */

   405

static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)

   406

{

   407

	assert (IsValidTrackdir(trackdir));

   408

	return

   409

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   410

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

   411

}

   412

   413

/**

   414

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

   415

 *

   416

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

   417

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

   418

 */

   419

static inline SignalState GetSignalState(TileIndex tile, Trackdir trackdir)

   420

{

   421

	assert(IsValidTrackdir(trackdir));

   422

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

   423

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

   424

		SIGNAL_STATE_GREEN : SIGNAL_STATE_RED;

   425

}

   426

   427

   428

/**

   429

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

   430

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

   431

 * the tile!

   432

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

   433

 * one tile.

   434

 */

   435

RailType GetTileRailType(TileIndex tile, Trackdir trackdir);

   436

   437

/**

   438

 * Returns whether the given tile is a level crossing.

   439

 */

   440

static inline bool IsLevelCrossing(TileIndex tile)

   441

{

   442

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

   443

}

   444

   445

/**

   446

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

   447

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

   448

 * TRANSPORT_RAIL.

   449

 */

   450

static inline TransportType GetCrossingTransportType(TileIndex tile, Track track)

   451

{

   452

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

   453

	switch (track) {

   454

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

   455

		case TRACK_X:

   456

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

   457

		case TRACK_Y:

   458

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

   459

		default:

   460

			assert(0);

   461

	}

   462

	return INVALID_TRANSPORT;

   463

}

   464

   465

/**

   466

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

   467

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

   468

 * @return The pointer to the RailtypeInfo

   469

 */

   470

static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)

   471

{

   472

	assert(railtype < RAILTYPE_END);

   473

	return &_railtypes[railtype];

   474

}

   475

   476

/**

   477

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

   478

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

   479

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

   480

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

   481

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

   482

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

   483

 */

   484

static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)

   485

{

   486

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

   487

}

   488

   489

/**

   490

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

   491

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

   492

 * two parallel tracks.

   493

 * @param  bits The tracks present.

   494

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

   495

 */

   496

static inline bool TracksOverlap(TrackBits bits)

   497

{

   498

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

   499

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