rail_map.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef RAIL_MAP_H
#define RAIL_MAP_H
 
#include "rail_type.h"
#include "depot_type.h"
#include "signal_func.h"
#include "track_func.h"
#include "tile_map.h"
#include "water_map.h"
#include "signal_type.h"
 

enum class RailTileType : uint8_t {
  Normal = 0, 
  Signals = 1, 
  Depot = 3, 
};

[[debug_inline]] inline static RailTileType GetRailTileType(Tile t)
{
  assert(IsTileType(t, TileType::Railway));
  return static_cast<RailTileType>(GB(t.m5(), 6, 2));
}

[[debug_inline]] inline static bool IsPlainRail(Tile t)
{
  RailTileType rtt = GetRailTileType(t);
  return rtt == RailTileType::Normal || rtt == RailTileType::Signals;
}

[[debug_inline]] inline static bool IsPlainRailTile(Tile t)
{
  return IsTileType(t, TileType::Railway) && IsPlainRail(t);
}
 

inline bool HasSignals(Tile t)
{
  return GetRailTileType(t) == RailTileType::Signals;
}

inline void SetHasSignals(Tile tile, bool signals)
{
  assert(IsPlainRailTile(tile));
  SB(tile.m5(), 6, 2, to_underlying(signals ? RailTileType::Signals : RailTileType::Normal));
}

[[debug_inline]] inline static bool IsRailDepot(Tile t)
{
  return GetRailTileType(t) == RailTileType::Depot;
}

[[debug_inline]] inline static bool IsRailDepotTile(Tile t)
{
  return IsTileType(t, TileType::Railway) && IsRailDepot(t);
}

inline RailType GetRailType(Tile t)
{
  return (RailType)GB(t.m8(), 0, 6);
}

inline void SetRailType(Tile t, RailType r)
{
  SB(t.m8(), 0, 6, r);
}
 

inline TrackBits GetTrackBits(Tile tile)
{
  assert(IsPlainRailTile(tile));
  return static_cast<TrackBits>(GB(tile.m5(), 0, 6));
}

inline void SetTrackBits(Tile t, TrackBits b)
{
  assert(IsPlainRailTile(t));
  SB(t.m5(), 0, 6, b.base());
}

inline bool HasTrack(Tile tile, Track track)
{
  return GetTrackBits(tile).Test(track);
}

inline DiagDirection GetRailDepotDirection(Tile t)
{
  return (DiagDirection)GB(t.m5(), 0, 2);
}

inline Track GetRailDepotTrack(Tile t)
{
  return DiagDirToDiagTrack(GetRailDepotDirection(t));
}
 

inline TrackBits GetRailReservationTrackBits(Tile t)
{
  assert(IsPlainRailTile(t));
  uint8_t track_b = GB(t.m2(), 8, 3);
  if (track_b == 0) return {};
  Track track = static_cast<Track>(track_b - 1); // map array saves Track+1
  return (HasBit(t.m2(), 11) ? TrackToOppositeTrack(track) : TrackBits{}) | track;
}

inline void SetTrackReservation(Tile t, TrackBits b)
{
  assert(IsPlainRailTile(t));
  assert(!TracksOverlap(b));
  Track track = RemoveFirstTrack(b);
  SB(t.m2(), 8, 3, IsValidTrack(track) ? to_underlying(track) + 1 : 0);
  AssignBit(t.m2(), 11, b.Any());
}

inline bool TryReserveTrack(Tile tile, Track t)
{
  assert(HasTrack(tile, t));
  TrackBits res = GetRailReservationTrackBits(tile);
  if (res.Test(t)) return false;  // already reserved
  res.Set(t);
  if (TracksOverlap(res)) return false;  // crossing reservation present
  SetTrackReservation(tile, res);
  return true;
}

inline void UnreserveTrack(Tile tile, Track t)
{
  assert(HasTrack(tile, t));
  TrackBits res = GetRailReservationTrackBits(tile);
  res.Reset(t);
  SetTrackReservation(tile, res);
}

inline bool HasDepotReservation(Tile t)
{
  assert(IsRailDepot(t));
  return HasBit(t.m5(), 4);
}

inline void SetDepotReservation(Tile t, bool b)
{
  assert(IsRailDepot(t));
  AssignBit(t.m5(), 4, b);
}

inline TrackBits GetDepotReservationTrackBits(Tile t)
{
  return HasDepotReservation(t) ? GetRailDepotTrack(t) : TrackBits{};
}
 

inline bool IsPbsSignal(SignalType s)
{
  return s == SignalType::Path || s == SignalType::PathOneWay;
}

inline SignalType GetSignalType(Tile t, Track track)
{
  assert(GetRailTileType(t) == RailTileType::Signals);
  uint8_t pos = (track == Track::Lower || track == Track::Right) ? 4 : 0;
  return static_cast<SignalType>(GB(t.m2(), pos, 3));
}

inline void SetSignalType(Tile t, Track track, SignalType s)
{
  assert(GetRailTileType(t) == RailTileType::Signals);
  uint8_t pos = (track == Track::Lower || track == Track::Right) ? 4 : 0;
  SB(t.m2(), pos, 3, to_underlying(s));
  if (!IsValidTrack(track)) SB(t.m2(), 4, 3, to_underlying(s));
}

inline bool IsPresignalEntry(Tile t, Track track)
{
  return GetSignalType(t, track) == SignalType::Entry || GetSignalType(t, track) == SignalType::Combo;
}

inline bool IsPresignalExit(Tile t, Track track)
{
  return GetSignalType(t, track) == SignalType::Exit || GetSignalType(t, track) == SignalType::Combo;
}

inline bool IsOnewaySignal(Tile t, Track track)
{
  return GetSignalType(t, track) != SignalType::Path;
}

inline void CycleSignalSide(Tile t, Track track)
{
  uint8_t sig;
  uint8_t pos = (track == Track::Lower || track == Track::Right) ? 4 : 6;
 
  sig = GB(t.m3(), pos, 2);
  if (--sig == 0) sig = IsPbsSignal(GetSignalType(t, track)) ? 2 : 3;
  SB(t.m3(), pos, 2, sig);
}

inline SignalVariant GetSignalVariant(Tile t, Track track)
{
  uint8_t pos = (track == Track::Lower || track == Track::Right) ? 7 : 3;
  return static_cast<SignalVariant>(GB(t.m2(), pos, 1));
}

inline void SetSignalVariant(Tile t, Track track, SignalVariant v)
{
  uint8_t pos = (track == Track::Lower || track == Track::Right) ? 7 : 3;
  SB(t.m2(), pos, 1, to_underlying(v));
  if (!IsValidTrack(track)) SB(t.m2(), 7, 1, to_underlying(v));
}

inline void SetSignalStates(Tile tile, uint state)
{
  SB(tile.m4(), 4, 4, state);
}

inline uint GetSignalStates(Tile tile)
{
  return GB(tile.m4(), 4, 4);
}

inline SignalState GetSingleSignalState(Tile t, uint8_t signalbit)
{
  return static_cast<SignalState>(HasBit(GetSignalStates(t), signalbit));
}

inline void SetPresentSignals(Tile tile, uint signals)
{
  SB(tile.m3(), 4, 4, signals);
}

inline uint GetPresentSignals(Tile tile)
{
  return GB(tile.m3(), 4, 4);
}

inline bool IsSignalPresent(Tile t, uint8_t signalbit)
{
  return HasBit(GetPresentSignals(t), signalbit);
}

inline bool HasSignalOnTrack(Tile tile, Track track)
{
  assert(IsValidTrack(track));
  return GetRailTileType(tile) == RailTileType::Signals && (GetPresentSignals(tile) & SignalOnTrack(track)) != 0;
}

inline bool HasSignalOnTrackdir(Tile tile, Trackdir trackdir)
{
  assert (IsValidTrackdir(trackdir));
  return GetRailTileType(tile) == RailTileType::Signals && GetPresentSignals(tile) & SignalAlongTrackdir(trackdir);
}

inline SignalState GetSignalStateByTrackdir(Tile tile, Trackdir trackdir)
{
  assert(IsValidTrackdir(trackdir));
  assert(HasSignalOnTrack(tile, TrackdirToTrack(trackdir)));
  return GetSignalStates(tile) & SignalAlongTrackdir(trackdir) ?
    SignalState::Green : SignalState::Red;
}

inline void SetSignalStateByTrackdir(Tile tile, Trackdir trackdir, SignalState state)
{
  if (state == SignalState::Green) { // set 1
    SetSignalStates(tile, GetSignalStates(tile) | SignalAlongTrackdir(trackdir));
  } else {
    SetSignalStates(tile, GetSignalStates(tile) & ~SignalAlongTrackdir(trackdir));
  }
}

inline bool HasPbsSignalOnTrackdir(Tile tile, Trackdir td)
{
  return IsTileType(tile, TileType::Railway) && HasSignalOnTrackdir(tile, td) &&
      IsPbsSignal(GetSignalType(tile, TrackdirToTrack(td)));
}

inline bool HasOnewaySignalBlockingTrackdir(Tile tile, Trackdir td)
{
  return IsTileType(tile, TileType::Railway) && HasSignalOnTrackdir(tile, ReverseTrackdir(td)) &&
      !HasSignalOnTrackdir(tile, td) && IsOnewaySignal(tile, TrackdirToTrack(td));
}

inline bool HasBlockSignalOnTrackdir(Tile tile, Trackdir td)
{
  return IsTileType(tile, TileType::Railway) && HasSignalOnTrackdir(tile, td) &&
    !IsPbsSignal(GetSignalType(tile, TrackdirToTrack(td)));
}
 
RailType GetTileRailType(Tile tile);

enum class RailGroundType : uint8_t {
  Barren = 0, 
  Grass = 1, 
  FenceNW = 2, 
  FenceSE = 3, 
  FenceSENW = 4, 
  FenceNE = 5, 
  FenceSW = 6, 
  FenceNESW = 7, 
  FenceVert1 = 8, 
  FenceVert2 = 9, 
  FenceHoriz1 = 10, 
  FenceHoriz2 = 11, 
  SnowOrDesert = 12, 
  HalfTileWater = 13, 
  HalfTileSnow = 14, 
};

inline void SetRailGroundType(Tile t, RailGroundType rgt)
{
  SB(t.m4(), 0, 4, to_underlying(rgt));
}

inline RailGroundType GetRailGroundType(Tile t)
{
  return static_cast<RailGroundType>(GB(t.m4(), 0, 4));
}

inline bool IsSnowOrDesertRailGround(Tile t)
{
  return GetRailGroundType(t) == RailGroundType::SnowOrDesert;
}
 

inline void MakeRailNormal(Tile t, Owner o, TrackBits b, RailType r)
{
  SetTileType(t, TileType::Railway);
  SetTileOwner(t, o);
  SetDockingTile(t, false);
  t.m2() = 0;
  t.m3() = 0;
  t.m4() = 0;
  t.m5() = to_underlying(RailTileType::Normal) << 6 | b.base();
  SB(t.m6(), 2, 6, 0);
  t.m7() = 0;
  t.m8() = r;
}

inline void SetRailDepotExitDirection(Tile tile, DiagDirection dir)
{
  assert(IsRailDepotTile(tile));
  SB(tile.m5(), 0, 2, to_underlying(dir));
}

inline void MakeRailDepot(Tile tile, Owner owner, DepotID depot_id, DiagDirection dir, RailType rail_type)
{
  SetTileType(tile, TileType::Railway);
  SetTileOwner(tile, owner);
  SetDockingTile(tile, false);
  tile.m2() = depot_id.base();
  tile.m3() = 0;
  tile.m4() = 0;
  tile.m5() = to_underlying(RailTileType::Depot) << 6 | to_underlying(dir);
  SB(tile.m6(), 2, 6, 0);
  tile.m7() = 0;
  tile.m8() = rail_type;
}
 
#endif /* RAIL_MAP_H */