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

   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

} RailtypeInfo;

   133

   134

extern const RailtypeInfo _railtypes[RAILTYPE_END];

   135

   136

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

   137

enum {

   138

	NUM_SSD_ENTRY = 256, // max amount of blocks

   139

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

   140

};

   141

   142

/**

   143

 * Maps a Trackdir to the corresponding TrackdirBits value

   144

 */

   145

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

   146

   147

/**

   148

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

   149

 * them when convenient.

   150

 */

   151

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

   152

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

   153

   154

/**

   155

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

   156

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

   157

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

   158

 */

   159

   160

/**

   161

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

   162

 * direction along with the trackdir.

   163

 */

   164

extern const byte _signal_along_trackdir[TRACKDIR_END];

   165

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

   166

   167

/**

   168

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

   169

 * direction against the trackdir.

   170

 */

   171

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   172

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   173

	return _signal_against_trackdir[trackdir];

   174

}

   175

   176

/**

   177

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

   178

 * be present on the given track.

   179

 */

   180

static inline byte SignalOnTrack(Track track) {

   181

	extern const byte _signal_on_track[TRACK_END];

   182

	return _signal_on_track[track];

   183

}

   184

   185

/*

   186

 * Some functions to query rail tiles

   187

 */

   188

   189

   190

/**

   191

 * Checks if a rail tile has signals.

   192

 */

   193

static inline bool HasSignals(TileIndex tile)

   194

{

   195

	return GetRailTileType(tile) == RAIL_TYPE_SIGNALS;

   196

}

   197

   198

/**

   199

 * Returns the RailTileSubtype of a given rail tile with type

   200

 * RAIL_TYPE_DEPOT_WAYPOINT

   201

 */

   202

static inline RailTileSubtype GetRailTileSubtype(TileIndex tile)

   203

{

   204

	assert(GetRailTileType(tile) == RAIL_TYPE_DEPOT_WAYPOINT);

   205

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

   206

}

   207

   208

/**

   209

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

   210

 * tiles RailTileType is RAIL_TYPE_NORMAL or RAIL_TYPE_SIGNALS.

   211

 */

   212

static inline bool IsPlainRailTile(TileIndex tile)

   213

{

   214

	RailTileType rtt = GetRailTileType(tile);

   215

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

   216

}

   217

   218

   219

/**

   220

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

   221

 * a plain rail tile (IsPlainRailTile()).

   222

 */

   223

static inline bool HasTrack(TileIndex tile, Track track)

   224

{

   225

	assert(IsValidTrack(track));

   226

	return HASBIT(GetTrackBits(tile), track);

   227

}

   228

   229

/*

   230

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   231

 * TrackdirBits, Direction and DiagDirections.

   232

 *

   233

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

   234

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

   235

 */

   236

   237

/**

   238

 * Maps a trackdir to the reverse trackdir.

   239

 */

   240

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   241

	extern const Trackdir _reverse_trackdir[TRACKDIR_END];

   242

	return _reverse_trackdir[trackdir];

   243

}

   244

   245

/**

   246

 * Maps a Track to the corresponding TrackBits value

   247

 */

   248

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

   249

   250

/**

   251

 * Returns the Track that a given Trackdir represents

   252

 */

   253

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

   254

   255

/**

   256

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

   257

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

   258

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

   259

 * in the future.

   260

 */

   261

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

   262

   263

/**

   264

 * Returns a TrackdirBit mask that contains the two TrackdirBits that

   265

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

   266

 */

   267

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

   268

   269

/**

   270

 * Discards all directional information from the given TrackdirBits. Any

   271

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

   272

 */

   273

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

   274

   275

/**

   276

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

   277

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

   278

 * different (alternating) one for straight trackdirs

   279

 */

   280

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   281

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   282

	return _next_trackdir[trackdir];

   283

}

   284

   285

/**

   286

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

   287

 */

   288

static inline TrackBits TrackCrossesTracks(Track track) {

   289

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   290

	return _track_crosses_tracks[track];

   291

}

   292

   293

/**

   294

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

   295

 * that trackdir.

   296

 */

   297

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   298

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   299

	return _trackdir_to_exitdir[trackdir];

   300

}

   301

   302

/**

   303

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

   304

 * with the exit in the given direction.

   305

 */

   306

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

   307

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   308

	return _track_exitdir_to_trackdir[track][diagdir];

   309

}

   310

   311

/**

   312

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

   313

 * with the exit in the given direction.

   314

 */

   315

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

   316

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   317

	return _track_enterdir_to_trackdir[track][diagdir];

   318

}

   319

   320

/**

   321

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

   322

 * the track running in the given direction.

   323

 */

   324

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

   325

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   326

	return _track_direction_to_trackdir[track][dir];

   327

}

   328

   329

/**

   330

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

   331

 * direction.

   332

 */

   333

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) {

   334

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   335

	return _dir_to_diag_trackdir[diagdir];

   336

}

   337

   338

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   339

   340

/**

   341

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

   342

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

   343

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

   344

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

   345

   346

/**

   347

 * Returns all tracks 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 TrackBits DiagdirReachesTracks(DiagDirection diagdir) { return TrackdirBitsToTrackBits(DiagdirReachesTrackdirs(diagdir)); }

   351

   352

/**

   353

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

   354

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

   355

 */

   356

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

   357

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

   358

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

   359

   360

   361

/**

   362

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

   363

 */

   364

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   365

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   366

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   367

}

   368

   369

   370

/* Checks if a given Track is diagonal */

   371

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

   372

   373

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

   374

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

   375

   376

/*

   377

 * Functions quering signals on tiles.

   378

 */

   379

   380

/**

   381

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

   382

 * given rail tile.

   383

 */

   384

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   385

{

   386

	assert(IsValidTrack(track));

   387

	return

   388

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   389

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

   390

}

   391

   392

/**

   393

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

   394

 * rail tile.

   395

 *

   396

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

   397

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

   398

 */

   399

static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)

   400

{

   401

	assert (IsValidTrackdir(trackdir));

   402

	return

   403

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   404

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

   405

}

   406

   407

/**

   408

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

   409

 *

   410

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

   411

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

   412

 */

   413

static inline SignalState GetSignalState(TileIndex tile, Trackdir trackdir)

   414

{

   415

	assert(IsValidTrackdir(trackdir));

   416

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

   417

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

   418

		SIGNAL_STATE_GREEN : SIGNAL_STATE_RED;

   419

}

   420

   421

   422

/**

   423

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

   424

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

   425

 * the tile!

   426

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

   427

 * one tile.

   428

 */

   429

RailType GetTileRailType(TileIndex tile, Trackdir trackdir);

   430

   431

/**

   432

 * Returns whether the given tile is a level crossing.

   433

 */

   434

static inline bool IsLevelCrossing(TileIndex tile)

   435

{

   436

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

   437

}

   438

   439

/**

   440

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

   441

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

   442

 * TRANSPORT_RAIL.

   443

 */

   444

static inline TransportType GetCrossingTransportType(TileIndex tile, Track track)

   445

{

   446

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

   447

	switch (track) {

   448

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

   449

		case TRACK_X:

   450

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

   451

		case TRACK_Y:

   452

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

   453

		default:

   454

			assert(0);

   455

	}

   456

	return INVALID_TRANSPORT;

   457

}

   458

   459

/**

   460

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

   461

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

   462

 * @return The pointer to the RailtypeInfo

   463

 */

   464

static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)

   465

{

   466

	assert(railtype < RAILTYPE_END);

   467

	return &_railtypes[railtype];

   468

}

   469

   470

/**

   471

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

   472

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

   473

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

   474

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

   475

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

   476

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

   477

 */

   478

static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)

   479

{

   480

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

   481

}

   482

   488

/**

   489

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

   490

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

   491

 * two parallel tracks.

   492

 * @param  bits The tracks present.

   493

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

   494

 */

   495

static inline bool TracksOverlap(TrackBits bits)

   496

{

   497

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

   498

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