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

typedef enum RailTypes {

    12

	RAILTYPE_RAIL     = 0,

    13

	RAILTYPE_ELECTRIC = 1,

    14

	RAILTYPE_MONO     = 2,

    15

	RAILTYPE_MAGLEV   = 3,

    16

	RAILTYPE_END,

    17

	INVALID_RAILTYPE  = 0xFF

    18

} RailType;

    19

    20

typedef byte RailTypeMask;

    21

    22

    23

/** These are used to specify a single track.

    24

 * Can be translated to a trackbit with TrackToTrackbit */

    25

typedef enum Track {

    26

	TRACK_X     = 0,

    27

	TRACK_Y     = 1,

    28

	TRACK_UPPER = 2,

    29

	TRACK_LOWER = 3,

    30

	TRACK_LEFT  = 4,

    31

	TRACK_RIGHT = 5,

    32

	TRACK_END,

    33

	INVALID_TRACK = 0xFF

    34

} Track;

    35

    36

    37

/** Convert an Axis to the corresponding Track

    38

 * AXIS_X -> TRACK_X

    39

 * AXIS_Y -> TRACK_Y

    40

 * Uses the fact that they share the same internal encoding

    41

 */

    42

static inline Track AxisToTrack(Axis a)

    43

{

    44

	return (Track)a;

    45

}

    46

    47

    48

/** Bitfield corresponding to Track */

    49

typedef enum TrackBits {

    50

	TRACK_BIT_NONE    = 0U,

    51

	TRACK_BIT_X       = 1U << TRACK_X,

    52

	TRACK_BIT_Y       = 1U << TRACK_Y,

    53

	TRACK_BIT_UPPER   = 1U << TRACK_UPPER,

    54

	TRACK_BIT_LOWER   = 1U << TRACK_LOWER,

    55

	TRACK_BIT_LEFT    = 1U << TRACK_LEFT,

    56

	TRACK_BIT_RIGHT   = 1U << TRACK_RIGHT,

    57

	TRACK_BIT_CROSS   = TRACK_BIT_X     | TRACK_BIT_Y,

    58

	TRACK_BIT_HORZ    = TRACK_BIT_UPPER | TRACK_BIT_LOWER,

    59

	TRACK_BIT_VERT    = TRACK_BIT_LEFT  | TRACK_BIT_RIGHT,

    60

	TRACK_BIT_3WAY_NE = TRACK_BIT_X     | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

    61

	TRACK_BIT_3WAY_SE = TRACK_BIT_Y     | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

    62

	TRACK_BIT_3WAY_SW = TRACK_BIT_X     | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

    63

	TRACK_BIT_3WAY_NW = TRACK_BIT_Y     | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

    64

	TRACK_BIT_ALL     = TRACK_BIT_CROSS | TRACK_BIT_HORZ  | TRACK_BIT_VERT,

    65

	TRACK_BIT_MASK    = 0x3FU

    66

} TrackBits;

    67

    68

    69

/**

    70

 * Maps a Track to the corresponding TrackBits value

    71

 */

    72

static inline TrackBits TrackToTrackBits(Track track)

    73

{

    74

	return (TrackBits)(1 << track);

    75

}

    76

    77

    78

static inline TrackBits AxisToTrackBits(Axis a)

    79

{

    80

	return TrackToTrackBits(AxisToTrack(a));

    81

}

    82

    83

    84

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

    85

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

    86

typedef enum Trackdirs {

    87

	TRACKDIR_X_NE     =  0,

    88

	TRACKDIR_Y_SE     =  1,

    89

	TRACKDIR_UPPER_E  =  2,

    90

	TRACKDIR_LOWER_E  =  3,

    91

	TRACKDIR_LEFT_S   =  4,

    92

	TRACKDIR_RIGHT_S  =  5,

    93

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

    94

	 * conversion by doing (trackdir & 7) */

    95

	TRACKDIR_X_SW     =  8,

    96

	TRACKDIR_Y_NW     =  9,

    97

	TRACKDIR_UPPER_W  = 10,

    98

	TRACKDIR_LOWER_W  = 11,

    99

	TRACKDIR_LEFT_N   = 12,

   100

	TRACKDIR_RIGHT_N  = 13,

   101

	TRACKDIR_END,

   102

	INVALID_TRACKDIR  = 0xFF,

   103

} Trackdir;

   104

   105

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

   106

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

   107

typedef enum TrackdirBits {

   108

	TRACKDIR_BIT_NONE     = 0x0000,

   109

	TRACKDIR_BIT_X_NE     = 0x0001,

   110

	TRACKDIR_BIT_Y_SE     = 0x0002,

   111

	TRACKDIR_BIT_UPPER_E  = 0x0004,

   112

	TRACKDIR_BIT_LOWER_E  = 0x0008,

   113

	TRACKDIR_BIT_LEFT_S   = 0x0010,

   114

	TRACKDIR_BIT_RIGHT_S  = 0x0020,

   115

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

   116

	TRACKDIR_BIT_X_SW     = 0x0100,

   117

	TRACKDIR_BIT_Y_NW     = 0x0200,

   118

	TRACKDIR_BIT_UPPER_W  = 0x0400,

   119

	TRACKDIR_BIT_LOWER_W  = 0x0800,

   120

	TRACKDIR_BIT_LEFT_N   = 0x1000,

   121

	TRACKDIR_BIT_RIGHT_N  = 0x2000,

   122

	TRACKDIR_BIT_MASK     = 0x3F3F,

   123

	INVALID_TRACKDIR_BIT  = 0xFFFF,

   124

} TrackdirBits;

   125

   126

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

   127

 */

   128

typedef struct RailtypeInfo {

   129

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

   130

	 *  the ones used directly in the code */

   131

	struct {

   132

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

   133

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

   134

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

   135

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

   136

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

   137

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

   138

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

   139

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

   140

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

   141

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

   142

		SpriteID tunnel;       ///< tunnel sprites base

   143

	} base_sprites;

   144

   145

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

   146

	 * directly in the code are listed */

   147

	struct {

   148

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

   149

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

   150

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

   151

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

   152

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

   153

		SpriteID build_depot;        ///< button for building depots

   154

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

   155

		SpriteID convert_rail;       ///< button for converting rail

   156

	} gui_sprites;

   157

   158

	struct {

   159

		CursorID rail_ns;

   160

		CursorID rail_swne;

   161

		CursorID rail_ew;

   162

		CursorID rail_nwse;

   163

		CursorID autorail;

   164

		CursorID depot;

   165

		CursorID tunnel;

   166

		CursorID convert;

   167

	} cursor;

   168

   169

	struct {

   170

		StringID toolbar_caption;

   171

	} strings;

   172

   173

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

   174

	SpriteID snow_offset;

   175

   176

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

   177

	RailTypeMask powered_railtypes;

   178

   179

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

   180

	RailTypeMask compatible_railtypes;

   181

   182

	/**

   183

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

   184

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

   185

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

   186

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

   187

	 *    the offset will fail.<p>

   188

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

   189

	 */

   190

	SpriteID total_offset;

   191

   192

	/**

   193

	 * Bridge offset

   194

	 */

   195

	SpriteID bridge_offset;

   196

   197

	/**

   198

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

   199

	 */

   200

	byte custom_ground_offset;

   201

} RailtypeInfo;

   202

   203

extern RailtypeInfo _railtypes[RAILTYPE_END];

   204

   205

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

   206

enum {

   207

	NUM_SSD_ENTRY = 256, // max amount of blocks

   208

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

   209

};

   210

   211

/**

   212

 * Maps a Trackdir to the corresponding TrackdirBits value

   213

 */

   214

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

   215

   216

/**

   217

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

   218

 * them when convenient.

   219

 */

   220

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

   221

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

   222

   223

/**

   224

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

   225

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

   226

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

   227

 */

   228

   229

/**

   230

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

   231

 * direction along with the trackdir.

   232

 */

   233

extern const byte _signal_along_trackdir[TRACKDIR_END];

   234

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

   235

   236

/**

   237

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

   238

 * direction against the trackdir.

   239

 */

   240

static inline byte SignalAgainstTrackdir(Trackdir trackdir) {

   241

	extern const byte _signal_against_trackdir[TRACKDIR_END];

   242

	return _signal_against_trackdir[trackdir];

   243

}

   244

   245

/**

   246

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

   247

 * be present on the given track.

   248

 */

   249

static inline byte SignalOnTrack(Track track) {

   250

	extern const byte _signal_on_track[TRACK_END];

   251

	return _signal_on_track[track];

   252

}

   253

   254

   255

/*

   256

 * Functions describing logical relations between Tracks, TrackBits, Trackdirs

   257

 * TrackdirBits, Direction and DiagDirections.

   258

 *

   259

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

   260

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

   261

 */

   262

   263

/**

   264

 * Maps a trackdir to the reverse trackdir.

   265

 */

   266

static inline Trackdir ReverseTrackdir(Trackdir trackdir) {

   267

	return (Trackdir)(trackdir ^ 8);

   268

}

   269

   270

/**

   271

 * Returns the Track that a given Trackdir represents

   272

 */

   273

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

   274

   275

/**

   276

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

   277

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

   278

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

   279

 * in the future.

   280

 */

   281

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

   282

   283

/**

   284

 * Returns a TrackdirBit mask that contains the two TrackdirBits that

   285

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

   286

 */

   287

static inline TrackdirBits TrackToTrackdirBits(Track track)

   288

{

   289

	Trackdir td = TrackToTrackdir(track);

   290

	return (TrackdirBits)(TrackdirToTrackdirBits(td) | TrackdirToTrackdirBits(ReverseTrackdir(td)));

   291

}

   292

   293

/**

   294

 * Discards all directional information from the given TrackdirBits. Any

   295

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

   296

 */

   297

static inline TrackBits TrackdirBitsToTrackBits(TrackdirBits bits)

   298

{

   299

	return (TrackBits)((bits | (bits >> 8)) & TRACK_BIT_MASK);

   300

}

   301

   302

/**

   303

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

   304

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

   305

 * different (alternating) one for straight trackdirs

   306

 */

   307

static inline Trackdir NextTrackdir(Trackdir trackdir)

   308

{

   309

	extern const Trackdir _next_trackdir[TRACKDIR_END];

   310

	return _next_trackdir[trackdir];

   311

}

   312

   313

/**

   314

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

   315

 */

   316

static inline TrackBits TrackCrossesTracks(Track track)

   317

{

   318

	extern const TrackBits _track_crosses_tracks[TRACK_END];

   319

	return _track_crosses_tracks[track];

   320

}

   321

   322

/**

   323

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

   324

 * that trackdir.

   325

 */

   326

static inline DiagDirection TrackdirToExitdir(Trackdir trackdir)

   327

{

   328

	extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END];

   329

	return _trackdir_to_exitdir[trackdir];

   330

}

   331

   332

/**

   333

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

   334

 * with the exit in the given direction.

   335

 */

   336

static inline Trackdir TrackExitdirToTrackdir(Track track, DiagDirection diagdir)

   337

{

   338

	extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END];

   339

	return _track_exitdir_to_trackdir[track][diagdir];

   340

}

   341

   342

/**

   343

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

   344

 * with the exit in the given direction.

   345

 */

   346

static inline Trackdir TrackEnterdirToTrackdir(Track track, DiagDirection diagdir)

   347

{

   348

	extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END];

   349

	return _track_enterdir_to_trackdir[track][diagdir];

   350

}

   351

   352

/**

   353

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

   354

 * the track running in the given direction.

   355

 */

   356

static inline Trackdir TrackDirectionToTrackdir(Track track, Direction dir)

   357

{

   358

	extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END];

   359

	return _track_direction_to_trackdir[track][dir];

   360

}

   361

   362

/**

   363

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

   364

 * direction.

   365

 */

   366

static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir)

   367

{

   368

	extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END];

   369

	return _dir_to_diag_trackdir[diagdir];

   370

}

   371

   372

extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END];

   373

   374

/**

   375

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

   376

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

   377

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

   378

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

   379

   380

/**

   381

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

   382

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

   383

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

   384

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

   385

   386

/**

   387

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

   388

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

   389

 */

   390

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

   391

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

   392

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

   393

   394

   395

/**

   396

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

   397

 */

   398

static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) {

   399

	extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END];

   400

	return _track_crosses_trackdirs[TrackdirToTrack(trackdir)];

   401

}

   402

   403

   404

/* Checks if a given Track is diagonal */

   405

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

   406

   407

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

   408

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

   409

   410

   411

/**

   412

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

   413

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

   414

 * @return The pointer to the RailtypeInfo

   415

 */

   416

static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)

   417

{

   418

	assert(railtype < RAILTYPE_END);

   419

	return &_railtypes[railtype];

   420

}

   421

   422

/**

   423

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

   424

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

   425

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

   426

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

   427

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

   428

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

   429

 */

   430

static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)

   431

{

   432

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

   433

}

   434

   435

static inline bool HasPowerOnRail(RailType enginetype, RailType tiletype)

   436

{

   437

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

   438

}

   439

   440

/**

   441

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

   442

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

   443

 * two parallel tracks.

   444

 * @param  bits The tracks present.

   445

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

   446

 */

   447

static inline bool TracksOverlap(TrackBits bits)

   448

{

   449

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

   450

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

   451

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

   452

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

   453

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

   454

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

   455

}

   456

   457

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

   458

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

   459

   460

/**

   461

 * Draws overhead wires and pylons for electric railways.

   462

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

   463

 * @see DrawCatenaryRailway

   464

 */

   465

void DrawCatenary(const TileInfo *ti);

   466

   467

uint GetRailFoundation(Slope tileh, TrackBits bits);

   468

   469

int32 SettingsDisableElrail(int32 p1); ///< _patches.disable_elrail callback

   470

   471

#endif /* RAIL_H */