1

/* $Id$ */

     2

     3

/** @file rail_map.h Hides the direct accesses to the map array with map accessors */

     4

     5

#ifndef RAIL_MAP_H

     6

#define RAIL_MAP_H

     7

     8

#include "rail_type.h"

     9

#include "signal_func.h"

    10

#include "direction_func.h"

    11

#include "track_func.h"

    12

#include "tile_map.h"

    13

#include "signal_type.h"

    14

#include "waypoint_type.h"

    15

    16

    17

/** Different types of Rail-related tiles */

    18

enum RailTileType {

    19

	RAIL_TILE_NORMAL   = 0, ///< Normal rail tile without signals

    20

	RAIL_TILE_SIGNALS  = 1, ///< Normal rail tile with signals

    21

	RAIL_TILE_WAYPOINT = 2, ///< Waypoint (X or Y direction)

    22

	RAIL_TILE_DEPOT    = 3, ///< Depot (one entrance)

    23

};

    24

    25

/**

    26

 * Returns the RailTileType (normal with or without signals,

    27

 * waypoint or depot).

    28

 * @param t the tile to get the information from

    29

 * @pre IsTileType(t, MP_RAILWAY)

    30

 * @return the RailTileType

    31

 */

    32

static inline RailTileType GetRailTileType(TileIndex t)

    33

{

    34

	assert(IsTileType(t, MP_RAILWAY));

    35

	return (RailTileType)GB(_m[t].m5, 6, 2);

    36

}

    37

    38

/**

    39

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

    40

 * tiles RailTileType is RAIL_TILE_NORMAL or RAIL_TILE_SIGNALS.

    41

 * @param t the tile to get the information from

    42

 * @pre IsTileType(t, MP_RAILWAY)

    43

 * @return true if and only if the tile is normal rail (with or without signals)

    44

 */

    45

static inline bool IsPlainRailTile(TileIndex t)

    46

{

    47

	RailTileType rtt = GetRailTileType(t);

    48

	return rtt == RAIL_TILE_NORMAL || rtt == RAIL_TILE_SIGNALS;

    49

}

    50

    51

/**

    52

 * Checks if a rail tile has signals.

    53

 * @param t the tile to get the information from

    54

 * @pre IsTileType(t, MP_RAILWAY)

    55

 * @return true if and only if the tile has signals

    56

 */

    57

static inline bool HasSignals(TileIndex t)

    58

{

    59

	return GetRailTileType(t) == RAIL_TILE_SIGNALS;

    60

}

    61

    62

/**

    63

 * Add/remove the 'has signal' bit from the RailTileType

    64

 * @param tile the tile to add/remove the signals to/from

    65

 * @param signals whether the rail tile should have signals or not

    66

 * @pre IsPlainRailTile(tile)

    67

 */

    68

static inline void SetHasSignals(TileIndex tile, bool signals)

    69

{

    70

	assert(IsPlainRailTile(tile));

    71

	SB(_m[tile].m5, 6, 1, signals);

    72

}

    73

    74

/**

    75

 * Is this tile a rail depot?

    76

 * @param t the tile to get the information from

    77

 * @pre IsTileType(t, MP_RAILWAY)

    78

 * @return true if and only if the tile is a rail depot

    79

 */

    80

static inline bool IsRailDepot(TileIndex t)

    81

{

    82

	return GetRailTileType(t) == RAIL_TILE_DEPOT;

    83

}

    84

    85

/**

    86

 * Is this tile a rail waypoint?

    87

 * @param t the tile to get the information from

    88

 * @pre IsTileType(t, MP_RAILWAY)

    89

 * @return true if and only if the tile is a rail waypoint

    90

 */

    91

static inline bool IsRailWaypoint(TileIndex t)

    92

{

    93

	return GetRailTileType(t) == RAIL_TILE_WAYPOINT;

    94

}

    95

    96

    97

/**

    98

 * Gets the rail type of the given tile

    99

 * @param t the tile to get the rail type from

   100

 * @return the rail type of the tile

   101

 */

   102

static inline RailType GetRailType(TileIndex t)

   103

{

   104

	return (RailType)GB(_m[t].m3, 0, 4);

   105

}

   106

   107

/**

   108

 * Sets the rail type of the given tile

   109

 * @param t the tile to set the rail type of

   110

 * @param r the new rail type for the tile

   111

 */

   112

static inline void SetRailType(TileIndex t, RailType r)

   113

{

   114

	SB(_m[t].m3, 0, 4, r);

   115

}

   116

   117

   118

/**

   119

 * Gets the track bits of the given tile

   120

 * @param t the tile to get the track bits from

   121

 * @return the track bits of the tile

   122

 */

   123

static inline TrackBits GetTrackBits(TileIndex tile)

   124

{

   125

	return (TrackBits)GB(_m[tile].m5, 0, 6);

   126

}

   127

   128

/**

   129

 * Sets the track bits of the given tile

   130

 * @param t the tile to set the track bits of

   131

 * @param b the new track bits for the tile

   132

 */

   133

static inline void SetTrackBits(TileIndex t, TrackBits b)

   134

{

   135

	SB(_m[t].m5, 0, 6, b);

   136

}

   137

   138

/**

   139

 * Returns whether the given track is present on the given tile.

   140

 * @param tile  the tile to check the track presence of

   141

 * @param track the track to search for on the tile

   142

 * @pre IsPlainRailTile(tile)

   143

 * @return true if and only if the given track exists on the tile

   144

 */

   145

static inline bool HasTrack(TileIndex tile, Track track)

   146

{

   147

	return HasBit(GetTrackBits(tile), track);

   148

}

   149

   150

/**

   151

 * Returns the direction the depot is facing to

   152

 * @param t the tile to get the depot facing from

   153

 * @pre IsRailDepotTile(t)

   154

 * @return the direction the depot is facing

   155

 */

   156

static inline DiagDirection GetRailDepotDirection(TileIndex t)

   157

{

   158

	return (DiagDirection)GB(_m[t].m5, 0, 2);

   159

}

   160

   161

   162

/**

   163

 * Returns the axis of the waypoint

   164

 * @param t the tile to get the waypoint axis from

   165

 * @pre IsRailWaypointTile(t)

   166

 * @return the axis of the waypoint

   167

 */

   168

static inline Axis GetWaypointAxis(TileIndex t)

   169

{

   170

	return (Axis)GB(_m[t].m5, 0, 1);

   171

}

   172

   173

/**

   174

 * Returns the track of the waypoint

   175

 * @param t the tile to get the waypoint track from

   176

 * @pre IsRailWaypointTile(t)

   177

 * @return the track of the waypoint

   178

 */

   179

static inline Track GetRailWaypointTrack(TileIndex t)

   180

{

   181

	return AxisToTrack(GetWaypointAxis(t));

   182

}

   183

   184

/**

   185

 * Returns the track bits of the waypoint

   186

 * @param t the tile to get the waypoint track bits from

   187

 * @pre IsRailWaypointTile(t)

   188

 * @return the track bits of the waypoint

   189

 */

   190

static inline TrackBits GetRailWaypointBits(TileIndex t)

   191

{

   192

	return TrackToTrackBits(GetRailWaypointTrack(t));

   193

}

   194

   195

/**

   196

 * Returns waypoint index (for the waypoint pool)

   197

 * @param t the tile to get the waypoint index from

   198

 * @pre IsRailWaypointTile(t)

   199

 * @return the waypoint index

   200

 */

   201

static inline WaypointID GetWaypointIndex(TileIndex t)

   202

{

   203

	return (WaypointID)_m[t].m2;

   204

}

   205

   206

static inline SignalType GetSignalType(TileIndex t, Track track)

   207

{

   208

	assert(GetRailTileType(t) == RAIL_TILE_SIGNALS);

   209

	byte pos = (track == TRACK_LOWER || track == TRACK_RIGHT) ? 4 : 0;

   210

	return (SignalType)GB(_m[t].m2, pos, 2);

   211

}

   212

   213

static inline void SetSignalType(TileIndex t, Track track, SignalType s)

   214

{

   215

	assert(GetRailTileType(t) == RAIL_TILE_SIGNALS);

   216

	byte pos = (track == TRACK_LOWER || track == TRACK_RIGHT) ? 4 : 0;

   217

	SB(_m[t].m2, pos, 2, s);

   218

	if (track == INVALID_TRACK) SB(_m[t].m2, 4, 2, s);

   219

}

   220

   221

static inline bool IsPresignalEntry(TileIndex t, Track track)

   222

{

   223

	return GetSignalType(t, track) == SIGTYPE_ENTRY || GetSignalType(t, track) == SIGTYPE_COMBO;

   224

}

   225

   226

static inline bool IsPresignalExit(TileIndex t, Track track)

   227

{

   228

	return GetSignalType(t, track) == SIGTYPE_EXIT || GetSignalType(t, track) == SIGTYPE_COMBO;

   229

}

   230

   231

static inline void CycleSignalSide(TileIndex t, Track track)

   232

{

   233

	byte sig;

   234

	byte pos = (track == TRACK_LOWER || track == TRACK_RIGHT) ? 4 : 6;

   235

   236

	sig = GB(_m[t].m3, pos, 2);

   237

	if (--sig == 0) sig = 3;

   238

	SB(_m[t].m3, pos, 2, sig);

   239

}

   240

   241

static inline SignalVariant GetSignalVariant(TileIndex t, Track track)

   242

{

   243

	byte pos = (track == TRACK_LOWER || track == TRACK_RIGHT) ? 6 : 2;

   244

	return (SignalVariant)GB(_m[t].m2, pos, 1);

   245

}

   246

   247

static inline void SetSignalVariant(TileIndex t, Track track, SignalVariant v)

   248

{

   249

	byte pos = (track == TRACK_LOWER || track == TRACK_RIGHT) ? 6 : 2;

   250

	SB(_m[t].m2, pos, 1, v);

   251

	if (track == INVALID_TRACK) SB(_m[t].m2, 6, 1, v);

   252

}

   253

   254

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

   255

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

   256

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

   257

 */

   258

enum SignalState {

   259

	SIGNAL_STATE_RED   = 0, ///< The signal is red

   260

	SIGNAL_STATE_GREEN = 1, ///< The signal is green

   261

};

   262

   263

/**

   264

 * Set the states of the signals (Along/AgainstTrackDir)

   265

 * @param tile  the tile to set the states for

   266

 * @param state the new state

   267

 */

   268

static inline void SetSignalStates(TileIndex tile, uint state)

   269

{

   270

	SB(_m[tile].m4, 4, 4, state);

   271

}

   272

   273

/**

   274

 * Set the states of the signals (Along/AgainstTrackDir)

   275

 * @param tile  the tile to set the states for

   276

 * @param state the new state

   277

 */

   278

static inline uint GetSignalStates(TileIndex tile)

   279

{

   280

	return GB(_m[tile].m4, 4, 4);

   281

}

   282

   283

/**

   284

 * Get the state of a single signal

   285

 * @param t         the tile to get the signal state for

   286

 * @param signalbit the signal

   287

 * @return the state of the signal

   288

 */

   289

static inline SignalState GetSingleSignalState(TileIndex t, byte signalbit)

   290

{

   291

	return (SignalState)HasBit(GetSignalStates(t), signalbit);

   292

}

   293

   294

/**

   295

 * Set whether the given signals are present (Along/AgainstTrackDir)

   296

 * @param tile    the tile to set the present signals for

   297

 * @param signals the signals that have to be present

   298

 */

   299

static inline void SetPresentSignals(TileIndex tile, uint signals)

   300

{

   301

	SB(_m[tile].m3, 4, 4, signals);

   302

}

   303

   304

/**

   305

 * Get whether the given signals are present (Along/AgainstTrackDir)

   306

 * @param tile the tile to get the present signals for

   307

 * @return the signals that are present

   308

 */

   309

static inline uint GetPresentSignals(TileIndex tile)

   310

{

   311

	return GB(_m[tile].m3, 4, 4);

   312

}

   313

   314

/**

   315

 * Checks whether the given signals is present

   316

 * @param t         the tile to check on

   317

 * @param signalbit the signal

   318

 * @return true if and only if the signal is present

   319

 */

   320

static inline bool IsSignalPresent(TileIndex t, byte signalbit)

   321

{

   322

	return HasBit(GetPresentSignals(t), signalbit);

   323

}

   324

   325

/**

   326

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

   327

 * given rail tile.

   328

 */

   329

static inline bool HasSignalOnTrack(TileIndex tile, Track track)

   330

{

   331

	assert(IsValidTrack(track));

   332

	return

   333

		GetRailTileType(tile) == RAIL_TILE_SIGNALS &&

   334

		(GetPresentSignals(tile) & SignalOnTrack(track)) != 0;

   335

}

   336

   337

/**

   338

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

   339

 * rail tile.

   340

 *

   341

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

   342

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

   343

 */

   344

static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)

   345

{

   346

	assert (IsValidTrackdir(trackdir));

   347

	return

   348

		GetRailTileType(tile) == RAIL_TILE_SIGNALS &&

   349

		GetPresentSignals(tile) & SignalAlongTrackdir(trackdir);

   350

}

   351

   352

/**

   353

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

   354

 *

   355

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

   356

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

   357

 */

   358

static inline SignalState GetSignalStateByTrackdir(TileIndex tile, Trackdir trackdir)

   359

{

   360

	assert(IsValidTrackdir(trackdir));

   361

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

   362

	return GetSignalStates(tile) & SignalAlongTrackdir(trackdir) ?

   363

		SIGNAL_STATE_GREEN : SIGNAL_STATE_RED;

   364

}

   365

   366

/**

   367

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

   368

 */

   369

static inline void SetSignalStateByTrackdir(TileIndex tile, Trackdir trackdir, SignalState state)

   370

{

   371

	if (state == SIGNAL_STATE_GREEN) { // set 1

   372

		SetSignalStates(tile, GetSignalStates(tile) | SignalAlongTrackdir(trackdir));

   373

	} else {

   374

		SetSignalStates(tile, GetSignalStates(tile) & ~SignalAlongTrackdir(trackdir));

   375

	}

   376

}

   377

   378

   379

/**

   380

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

   381

 */

   382

RailType GetTileRailType(TileIndex tile);

   383

   384

/** The ground 'under' the rail */

   385

enum RailGroundType {

   386

	RAIL_GROUND_BARREN       =  0, ///< Nothing (dirt)

   387

	RAIL_GROUND_GRASS        =  1, ///< Grassy

   388

	RAIL_GROUND_FENCE_NW     =  2, ///< Grass with a fence at the NW edge

   389

	RAIL_GROUND_FENCE_SE     =  3, ///< Grass with a fence at the SE edge

   390

	RAIL_GROUND_FENCE_SENW   =  4, ///< Grass with a fence at the NW and SE edges

   391

	RAIL_GROUND_FENCE_NE     =  5, ///< Grass with a fence at the NE edge

   392

	RAIL_GROUND_FENCE_SW     =  6, ///< Grass with a fence at the SW edge

   393

	RAIL_GROUND_FENCE_NESW   =  7, ///< Grass with a fence at the NE and SW edges

   394

	RAIL_GROUND_FENCE_VERT1  =  8, ///< Grass with a fence at the eastern side

   395

	RAIL_GROUND_FENCE_VERT2  =  9, ///< Grass with a fence at the western side

   396

	RAIL_GROUND_FENCE_HORIZ1 = 10, ///< Grass with a fence at the southern side

   397

	RAIL_GROUND_FENCE_HORIZ2 = 11, ///< Grass with a fence at the northern side

   398

	RAIL_GROUND_ICE_DESERT   = 12, ///< Icy or sandy

   399

	RAIL_GROUND_WATER        = 13, ///< Grass with a fence and shore or water on the free halftile

   400

	RAIL_GROUND_HALF_SNOW    = 14, ///< Snow only on higher part of slope (steep or one corner raised)

   401

};

   402

   403

static inline void SetRailGroundType(TileIndex t, RailGroundType rgt)

   404

{

   405

	SB(_m[t].m4, 0, 4, rgt);

   406

}

   407

   408

static inline RailGroundType GetRailGroundType(TileIndex t)

   409

{

   410

	return (RailGroundType)GB(_m[t].m4, 0, 4);

   411

}

   412

   413

static inline bool IsSnowRailGround(TileIndex t)

   414

{

   415

	return GetRailGroundType(t) == RAIL_GROUND_ICE_DESERT;

   416

}

   417

   418

   419

static inline void MakeRailNormal(TileIndex t, Owner o, TrackBits b, RailType r)

   420

{

   421

	SetTileType(t, MP_RAILWAY);

   422

	SetTileOwner(t, o);

   423

	_m[t].m2 = 0;

   424

	_m[t].m3 = r;

   425

	_m[t].m4 = 0;

   426

	_m[t].m5 = RAIL_TILE_NORMAL << 6 | b;

   427

}

   428

   429

   430

static inline void MakeRailDepot(TileIndex t, Owner o, DiagDirection d, RailType r)

   431

{

   432

	SetTileType(t, MP_RAILWAY);

   433

	SetTileOwner(t, o);

   434

	_m[t].m2 = 0;

   435

	_m[t].m3 = r;

   436

	_m[t].m4 = 0;

   437

	_m[t].m5 = RAIL_TILE_DEPOT << 6 | d;

   438

}

   439

   440

   441

static inline void MakeRailWaypoint(TileIndex t, Owner o, Axis a, RailType r, uint index)

   442

{

   443

	SetTileType(t, MP_RAILWAY);

   444

	SetTileOwner(t, o);

   445

	_m[t].m2 = index;

   446

	_m[t].m3 = r;

   447

	_m[t].m4 = 0;

   448

	_m[t].m5 = RAIL_TILE_WAYPOINT << 6 | a;

   449

}

   450

   451

#endif /* RAIL_MAP_H */