1

/* $Id$ */

     2

     3

/** @file rail.h */

     4

     5

#ifndef RAIL_H

     6

#define RAIL_H

     7

     8

#include "direction.h"

    10

#include "tile.h"

    11

    12

/*

    13

 * Some enums for accesing the map bytes for rail tiles

    14

 */

    15

    16

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

    17

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

    18

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

    19

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

    20

														 * containing a value from RailTileTypes above.

    21

														 * This value is only maintained for backwards

    22

														 * compatibility */

    23

    24

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

    25

	 * TRACK_BIT_* */

    26

};

    27

    28

    29

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

    30

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

    31

typedef enum Trackdirs {

    32

	TRACKDIR_X_NE = 0,

    33

	TRACKDIR_Y_SE = 1,

    34

	TRACKDIR_UPPER_E  = 2,

    35

	TRACKDIR_LOWER_E  = 3,

    36

	TRACKDIR_LEFT_S   = 4,

    37

	TRACKDIR_RIGHT_S  = 5,

    38

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

    39

	 * conversion by doing (trackdir & 7) */

    40

	TRACKDIR_X_SW = 8,

    41

	TRACKDIR_Y_NW = 9,

    42

	TRACKDIR_UPPER_W  = 10,

    43

	TRACKDIR_LOWER_W  = 11,

    44

	TRACKDIR_LEFT_N   = 12,

    45

	TRACKDIR_RIGHT_N  = 13,

    46

	TRACKDIR_END,

    47

	INVALID_TRACKDIR  = 0xFF,

    48

} Trackdir;

    49

    50

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

    51

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

    52

typedef enum TrackdirBits {

    53

	TRACKDIR_BIT_X_NE     = 0x1,

    54

	TRACKDIR_BIT_Y_SE     = 0x2,

    55

	TRACKDIR_BIT_UPPER_E  = 0x4,

    56

	TRACKDIR_BIT_LOWER_E  = 0x8,

    57

	TRACKDIR_BIT_LEFT_S   = 0x10,

    58

	TRACKDIR_BIT_RIGHT_S  = 0x20,

    59

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

    60

	TRACKDIR_BIT_X_SW     = 0x0100,

    61

	TRACKDIR_BIT_Y_NW     = 0x0200,

    62

	TRACKDIR_BIT_UPPER_W  = 0x0400,

    63

	TRACKDIR_BIT_LOWER_W  = 0x0800,

    64

	TRACKDIR_BIT_LEFT_N   = 0x1000,

    65

	TRACKDIR_BIT_RIGHT_N  = 0x2000,

    66

	TRACKDIR_BIT_MASK			= 0x3F3F,

    67

	INVALID_TRACKDIR_BIT  = 0xFFFF,

    68

} TrackdirBits;

    69

    70

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

    71

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

    72

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

    73

 */

    74

typedef enum SignalStates {

    75

	SIGNAL_STATE_RED = 0,

    76

	SIGNAL_STATE_GREEN = 1,

    77

} SignalState;

    78

    79

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

    80

 */

    81

typedef struct RailtypeInfo {

    82

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

    83

	 *  the ones used directly in the code */

    84

	struct {

    85

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

    86

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

    87

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

    88

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

    89

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

    90

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

    91

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

    92

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

    93

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

    94

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

    95

		SpriteID tunnel;       ///< tunnel sprites base

    96

	} base_sprites;

    97

    98

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

    99

	 * directly in the code are listed */

   100

	struct {

   101

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

   102

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

   103

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

   104

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

   105

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

   106

		SpriteID build_depot;        ///< button for building depots

   107

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

   108

		SpriteID convert_rail;       ///< button for converting rail

   109

	} gui_sprites;

   110

   111

	struct {

   112

		CursorID rail_ns;

   113

		CursorID rail_swne;

   114

		CursorID rail_ew;

   115

		CursorID rail_nwse;

   116

		CursorID autorail;

   117

		CursorID depot;

   118

		CursorID tunnel;

   119

		CursorID convert;

   120

	} cursor;

   121

   122

	struct {

   123

		StringID toolbar_caption;

   124

	} strings;

   125

   126

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

   127

	SpriteID snow_offset;

   128

   129

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

   130

	byte compatible_railtypes;

   131

   132

	/**

   133

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

   134

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

   135

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

   136

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

   137

	 *    the offset will fail.<p>

   138

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

   139

	 */

   140

	SpriteID total_offset;

   141

   142

	/**

   143

	  * Bridge offset

   144

	  */

   145

	SpriteID bridge_offset;

   146

} RailtypeInfo;

   147

   148

extern const RailtypeInfo _railtypes[RAILTYPE_END];

   149

   150

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

   151

enum {

   152

	NUM_SSD_ENTRY = 256, // max amount of blocks

   153

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

   154

};

   155

   156

/**

   157

 * Maps a Trackdir to the corresponding TrackdirBits value

   158

 */

   159

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

   160

   161

/**

   162

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

   163

 * them when convenient.

   164

 */

   165

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

   166

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

   167

   168

/**

   169

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

   170

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

   171

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

   172

 */

   173

   174

/**

   175

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

   176

 * direction along with the trackdir.

   177

 */

   178

extern const byte _signal_along_trackdir[TRACKDIR_END];

   179

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

   180

   181

/**

   182

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

   183

 * direction against the trackdir.

   184

 */

   185

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   186

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   187

	return _signal_against_trackdir[trackdir];

   188

}

   189

   190

/**

   191

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

   192

 * be present on the given track.

   193

 */

   194

static inline byte SignalOnTrack(Track track) {

   195

	extern const byte _signal_on_track[TRACK_END];

   196

	return _signal_on_track[track];

   197

}

   198

   199

/*

   200

 * Some functions to query rail tiles

   201

 */

   202

   203

   204

/**

   205

 * Checks if a rail tile has signals.

   206

 */

   207

static inline bool HasSignals(TileIndex tile)

   208

{

   209

	return GetRailTileType(tile) == RAIL_TYPE_SIGNALS;

   210

}

   211

   212

/**

   213

 * Returns the RailTileSubtype of a given rail tile with type

   214

 * RAIL_TYPE_DEPOT_WAYPOINT

   215

 */

   216

static inline RailTileSubtype GetRailTileSubtype(TileIndex tile)

   217

{

   218

	assert(GetRailTileType(tile) == RAIL_TYPE_DEPOT_WAYPOINT);

   219

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

   220

}

   221

   222

/**

   223

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

   224

 * tiles RailTileType is RAIL_TYPE_NORMAL or RAIL_TYPE_SIGNALS.

   225

 */

   226

static inline bool IsPlainRailTile(TileIndex tile)

   227

{

   228

	RailTileType rtt = GetRailTileType(tile);

   229

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

   230

}

   231

   232

/**

   233

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

   234

 */

   235

static inline TrackBits GetTrackBits(TileIndex tile)

   236

{

   237

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

   238

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

   239

}

   240

   241

/**

   242

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

   243

 * a plain rail tile (IsPlainRailTile()).

   244

 */

   245

static inline bool HasTrack(TileIndex tile, Track track)

   246

{

   247

	assert(IsValidTrack(track));

   248

	return HASBIT(GetTrackBits(tile), track);

   249

}

   250

   251

/*

   252

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   253

 * TrackdirBits, Direction and DiagDirections.

   254

 *

   255

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

   256

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

   257

 */

   258

   259

/**

   260

 * Maps a trackdir to the reverse trackdir.

   261

 */

   262

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   263

	extern const Trackdir _reverse_trackdir[TRACKDIR_END];

   264

	return _reverse_trackdir[trackdir];

   265

}

   266

   267

/**

   268

 * Maps a Track to the corresponding TrackBits value

   269

 */

   270

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

   271

   272

/**

   273

 * Returns the Track that a given Trackdir represents

   274

 */

   275

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

   276

   277

/**

   278

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

   279

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

   280

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

   281

 * in the future.

   282

 */

   283

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

   284

   285

/**

   286

 * Returns a TrackdirBit mask that contains the two TrackdirBits that

   287

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

   288

 */

   289

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

   290

   291

/**

   292

 * Discards all directional information from the given TrackdirBits. Any

   293

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

   294

 */

   295

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

   296

   297

/**

   298

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

   299

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

   300

 * different (alternating) one for straight trackdirs

   301

 */

   302

static inline Trackdir NextTrackdir(Trackdir trackdir) {

   303

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   304

	return _next_trackdir[trackdir];

   305

}

   306

   307

/**

   308

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

   309

 */

   310

static inline TrackBits TrackCrossesTracks(Track track) {

   311

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   312

	return _track_crosses_tracks[track];

   313

}

   314

   315

/**

   316

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

   317

 * that trackdir.

   318

 */

   319

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) {

   320

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   321

	return _trackdir_to_exitdir[trackdir];

   322

}

   323

   324

/**

   325

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

   326

 * with the exit in the given direction.

   327

 */

   328

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

   329

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   330

	return _track_exitdir_to_trackdir[track][diagdir];

   331

}

   332

   333

/**

   334

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

   335

 * with the exit in the given direction.

   336

 */

   337

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

   338

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   339

	return _track_enterdir_to_trackdir[track][diagdir];

   340

}

   341

   342

/**

   343

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

   344

 * the track running in the given direction.

   345

 */

   346

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

   347

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   348

	return _track_direction_to_trackdir[track][dir];

   349

}

   350

   351

/**

   352

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

   353

 * direction.

   354

 */

   355

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) {

   356

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   357

	return _dir_to_diag_trackdir[diagdir];

   358

}

   359

   360

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   361

   362

/**

   363

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

   364

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

   365

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

   366

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

   367

   368

/**

   369

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

   370

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

   371

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

   372

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

   373

   374

/**

   375

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

   376

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

   377

 */

   378

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

   379

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

   380

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

   381

   382

   383

/**

   384

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

   385

 */

   386

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   387

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   388

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   389

}

   390

   391

   392

/* Checks if a given Track is diagonal */

   393

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

   394

   395

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

   396

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

   397

   398

/*

   399

 * Functions quering signals on tiles.

   400

 */

   401

   402

/**

   403

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

   404

 * given rail tile.

   405

 */

   406

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   407

{

   408

	assert(IsValidTrack(track));

   409

	return

   410

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   411

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

   412

}

   413

   414

/**

   415

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

   416

 * rail tile.

   417

 *

   418

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

   419

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

   420

 */

   421

static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)

   422

{

   423

	assert (IsValidTrackdir(trackdir));

   424

	return

   425

		GetRailTileType(tile) == RAIL_TYPE_SIGNALS &&

   426

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

   427

}

   428

   429

/**

   430

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

   431

 *

   432

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

   433

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

   434

 */

   435

static inline SignalState GetSignalState(TileIndex tile, Trackdir trackdir)

   436

{

   437

	assert(IsValidTrackdir(trackdir));

   438

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

   439

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

   440

		SIGNAL_STATE_GREEN : SIGNAL_STATE_RED;

   441

}

   442

   443

   444

/**

   445

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

   446

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

   447

 * the tile!

   448

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

   449

 * one tile.

   450

 */

   451

RailType GetTileRailType(TileIndex tile, Trackdir trackdir);

   452

   453

/**

   454

 * Returns whether the given tile is a level crossing.

   455

 */

   456

static inline bool IsLevelCrossing(TileIndex tile)

   457

{

   458

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

   459

}

   460

   461

/**

   462

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

   463

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

   464

 * TRANSPORT_RAIL.

   465

 */

   466

static inline TransportType GetCrossingTransportType(TileIndex tile, Track track)

   467

{

   468

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

   469

	switch (track) {

   470

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

   471

		case TRACK_X:

   472

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

   473

		case TRACK_Y:

   474

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

   475

		default:

   476

			assert(0);

   477

	}

   478

	return INVALID_TRANSPORT;

   479

}

   480

   481

/**

   482

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

   483

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

   484

 * @return The pointer to the RailtypeInfo

   485

 */

   486

static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)

   487

{

   488

	assert(railtype < RAILTYPE_END);

   489

	return &_railtypes[railtype];

   490

}

   491

   492

/**

   493

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

   494

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

   495

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

   496

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

   497

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

   498

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

   499

 */

   500

static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)