road_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 ROAD_MAP_H
#define ROAD_MAP_H
 
#include "track_func.h"
#include "depot_type.h"
#include "rail_type.h"
#include "road_func.h"
#include "tile_map.h"
#include "road_type.h"
 

enum class RoadTileType : uint8_t {
  Normal = 0, 
  Crossing = 1, 
  Depot = 2, 
};
 
bool MayHaveRoad(Tile t);

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

[[debug_inline]] inline static bool IsNormalRoad(Tile t)
{
  return GetRoadTileType(t) == RoadTileType::Normal;
}

[[debug_inline]] inline static bool IsNormalRoadTile(Tile t)
{
  return IsTileType(t, TileType::Road) && IsNormalRoad(t);
}

inline bool IsLevelCrossing(Tile t)
{
  return GetRoadTileType(t) == RoadTileType::Crossing;
}

inline bool IsLevelCrossingTile(Tile t)
{
  return IsTileType(t, TileType::Road) && IsLevelCrossing(t);
}

[[debug_inline]] inline static bool IsRoadDepot(Tile t)
{
  return GetRoadTileType(t) == RoadTileType::Depot;
}

[[debug_inline]] inline static bool IsRoadDepotTile(Tile t)
{
  return IsTileType(t, TileType::Road) && IsRoadDepot(t);
}

inline RoadBits GetRoadBits(Tile t, RoadTramType rtt)
{
  assert(IsNormalRoad(t));
  if (rtt == RoadTramType::Tram) return (RoadBits)GB(t.m3(), 0, 4);
  return (RoadBits)GB(t.m5(), 0, 4);
}

inline RoadBits GetAllRoadBits(Tile tile)
{
  return GetRoadBits(tile, RoadTramType::Road) | GetRoadBits(tile, RoadTramType::Tram);
}

inline void SetRoadBits(Tile t, RoadBits r, RoadTramType rtt)
{
  assert(IsNormalRoad(t)); // XXX incomplete
  if (rtt == RoadTramType::Tram) {
    SB(t.m3(), 0, 4, r.base());
  } else {
    SB(t.m5(), 0, 4, r.base());
  }
}

inline RoadType GetRoadTypeRoad(Tile t)
{
  assert(MayHaveRoad(t));
  return (RoadType)GB(t.m4(), 0, 6);
}

inline RoadType GetRoadTypeTram(Tile t)
{
  assert(MayHaveRoad(t));
  return (RoadType)GB(t.m8(), 6, 6);
}

inline RoadType GetRoadType(Tile t, RoadTramType rtt)
{
  return (rtt == RoadTramType::Tram) ? GetRoadTypeTram(t) : GetRoadTypeRoad(t);
}

inline RoadTypes GetPresentRoadTypes(Tile t)
{
  RoadTypes result{};
  if (MayHaveRoad(t)) {
    if (GetRoadTypeRoad(t) != INVALID_ROADTYPE) result.Set(GetRoadTypeRoad(t));
    if (GetRoadTypeTram(t) != INVALID_ROADTYPE) result.Set(GetRoadTypeTram(t));
  }
  return result;
}

inline bool HasRoadTypeRoad(Tile t)
{
  return GetRoadTypeRoad(t) != INVALID_ROADTYPE;
}

inline bool HasRoadTypeTram(Tile t)
{
  return GetRoadTypeTram(t) != INVALID_ROADTYPE;
}

inline bool HasTileRoadType(Tile t, RoadTramType rtt)
{
  return GetRoadType(t, rtt) != INVALID_ROADTYPE;
}

inline bool HasTileAnyRoadType(Tile t, RoadTypes rts)
{
  if (!MayHaveRoad(t)) return false;
  return GetPresentRoadTypes(t).Any(rts);
}

inline Owner GetRoadOwner(Tile t, RoadTramType rtt)
{
  assert(MayHaveRoad(t));
  if (rtt == RoadTramType::Road) return (Owner)GB(IsNormalRoadTile(t) ? t.m1() : t.m7(), 0, 5);
 
  /* Trams don't need OWNER_TOWN, and remapping OWNER_NONE
   * to OWNER_TOWN makes it use one bit less */
  Owner o = (Owner)GB(t.m3(), 4, 4);
  return o == OWNER_TOWN ? OWNER_NONE : o;
}

inline void SetRoadOwner(Tile t, RoadTramType rtt, Owner o)
{
  if (rtt == RoadTramType::Road) {
    SB(IsNormalRoadTile(t) ? t.m1() : t.m7(), 0, 5, o.base());
  } else {
    SB(t.m3(), 4, 4, (o == OWNER_NONE ? OWNER_TOWN : o).base());
  }
}

inline bool IsRoadOwner(Tile t, RoadTramType rtt, Owner o)
{
  assert(HasTileRoadType(t, rtt));
  return (GetRoadOwner(t, rtt) == o);
}

inline bool HasTownOwnedRoad(Tile t)
{
  return HasTileRoadType(t, RoadTramType::Road) && IsRoadOwner(t, RoadTramType::Road, OWNER_TOWN);
}

inline bool IsValidDisallowedRoadDirections(DisallowedRoadDirections drt)
{
  return drt.Reset({DisallowedRoadDirection::Northbound, DisallowedRoadDirection::Southbound}).None();
}

inline DisallowedRoadDirections GetDisallowedRoadDirections(Tile t)
{
  assert(IsNormalRoad(t));
  return static_cast<DisallowedRoadDirections>(GB(t.m5(), 4, 2));
}

inline void SetDisallowedRoadDirections(Tile t, DisallowedRoadDirections drd)
{
  assert(IsNormalRoad(t));
  assert(IsValidDisallowedRoadDirections(drd));
  SB(t.m5(), 4, 2, drd.base());
}

inline Axis GetCrossingRoadAxis(Tile t)
{
  assert(IsLevelCrossing(t));
  return static_cast<Axis>(GB(t.m5(), 0, 1));
}

inline Axis GetCrossingRailAxis(Tile t)
{
  assert(IsLevelCrossing(t));
  return OtherAxis(GetCrossingRoadAxis(t));
}

inline RoadBits GetCrossingRoadBits(Tile tile)
{
  return AxisToRoadBits(GetCrossingRoadAxis(tile));
}

inline Track GetCrossingRailTrack(Tile tile)
{
  return AxisToTrack(GetCrossingRailAxis(tile));
}

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

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

inline TrackBits GetCrossingReservationTrackBits(Tile t)
{
  return HasCrossingReservation(t) ? GetCrossingRailTrack(t) : TrackBits{};
}

inline bool IsCrossingBarred(Tile t)
{
  assert(IsLevelCrossing(t));
  return HasBit(t.m5(), 5);
}

inline void SetCrossingBarred(Tile t, bool barred)
{
  assert(IsLevelCrossing(t));
  AssignBit(t.m5(), 5, barred);
}

inline void UnbarCrossing(Tile t)
{
  SetCrossingBarred(t, false);
}

inline void BarCrossing(Tile t)
{
  SetCrossingBarred(t, true);
}

inline bool IsOnSnowOrDesert(Tile t)
{
  return HasBit(t.m7(), 5);
}

inline void ToggleSnowOrDesert(Tile t)
{
  ToggleBit(t.m7(), 5);
}
 

enum class Roadside : uint8_t {
  Barren = 0, 
  Grass = 1, 
  Paved = 2, 
  StreetLights = 3, 
  /* 4 is unused for historical reasons */
  Trees = 5, 
  GrassRoadWorks = 6, 
  PavedRoadWorks = 7, 
};

inline Roadside GetRoadside(Tile tile)
{
  return static_cast<Roadside>(GB(tile.m6(), 3, 3));
}

inline void SetRoadside(Tile tile, Roadside s)
{
  SB(tile.m6(), 3, 3, to_underlying(s));
}

inline bool HasRoadWorks(Tile t)
{
  return GetRoadside(t) >= Roadside::GrassRoadWorks;
}

inline bool IncreaseRoadWorksCounter(Tile t)
{
  AB(t.m7(), 0, 4, 1);
 
  return GB(t.m7(), 0, 4) == 15;
}

inline void StartRoadWorks(Tile t)
{
  assert(!HasRoadWorks(t));
  /* Remove any trees or lamps in case or roadwork */
  switch (GetRoadside(t)) {
    case Roadside::Barren:
    case Roadside::Grass:
      SetRoadside(t, Roadside::GrassRoadWorks);
      break;
 
    default:
      SetRoadside(t, Roadside::PavedRoadWorks);
      break;
  }
}

inline void TerminateRoadWorks(Tile t)
{
  assert(HasRoadWorks(t));
  SetRoadside(t, GetRoadside(t) == Roadside::GrassRoadWorks ? Roadside::Grass : Roadside::Paved);
  /* Stop the counter */
  SB(t.m7(), 0, 4, 0);
}
 

inline DiagDirection GetRoadDepotDirection(Tile t)
{
  assert(IsRoadDepot(t));
  return static_cast<DiagDirection>(GB(t.m5(), 0, 2));
}
 
 
RoadBits GetAnyRoadBits(Tile tile, RoadTramType rtt, bool straight_tunnel_bridge_entrance = false);

inline void SetRoadTypeRoad(Tile t, RoadType rt)
{
  assert(MayHaveRoad(t));
  assert(rt == INVALID_ROADTYPE || RoadTypeIsRoad(rt));
  SB(t.m4(), 0, 6, rt);
}

inline void SetRoadTypeTram(Tile t, RoadType rt)
{
  assert(MayHaveRoad(t));
  assert(rt == INVALID_ROADTYPE || RoadTypeIsTram(rt));
  SB(t.m8(), 6, 6, rt);
}

inline void SetRoadType(Tile t, RoadTramType rtt, RoadType rt)
{
  if (rtt == RoadTramType::Tram) {
    SetRoadTypeTram(t, rt);
  } else {
    SetRoadTypeRoad(t, rt);
  }
}

inline void SetRoadTypes(Tile t, RoadType road_rt, RoadType tram_rt)
{
  SetRoadTypeRoad(t, road_rt);
  SetRoadTypeTram(t, tram_rt);
}

inline void MakeRoadNormal(Tile t, RoadBits bits, RoadType road_rt, RoadType tram_rt, TownID town, Owner road, Owner tram)
{
  SetTileType(t, TileType::Road);
  SetTileOwner(t, road);
  t.m2() = town.base();
  t.m3() = (tram_rt != INVALID_ROADTYPE ? bits.base() : 0);
  t.m5() = (road_rt != INVALID_ROADTYPE ? bits.base() : 0) | to_underlying(RoadTileType::Normal) << 6;
  SB(t.m6(), 2, 6, 0);
  t.m7() = 0;
  t.m8() = 0;
  SetRoadTypes(t, road_rt, tram_rt);
  SetRoadOwner(t, RoadTramType::Tram, tram);
}

inline void MakeRoadCrossing(Tile t, Owner road, Owner tram, Owner rail, Axis roaddir, RailType rat, RoadType road_rt, RoadType tram_rt, TownID town)
{
  SetTileType(t, TileType::Road);
  SetTileOwner(t, rail);
  t.m2() = town.base();
  t.m3() = 0;
  t.m4() = INVALID_ROADTYPE;
  t.m5() = to_underlying(RoadTileType::Crossing) << 6 | to_underlying(roaddir);
  SB(t.m6(), 2, 6, 0);
  t.m7() = road.base();
  t.m8() = INVALID_ROADTYPE << 6 | rat;
  SetRoadTypes(t, road_rt, tram_rt);
  SetRoadOwner(t, RoadTramType::Tram, tram);
}

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

inline void MakeRoadDepot(Tile tile, Owner owner, DepotID depot_id, DiagDirection dir, RoadType rt)
{
  SetTileType(tile, TileType::Road);
  SetTileOwner(tile, owner);
  tile.m2() = depot_id.base();
  tile.m3() = 0;
  tile.m4() = INVALID_ROADTYPE;
  tile.m5() = to_underlying(RoadTileType::Depot) << 6 | to_underlying(dir);
  SB(tile.m6(), 2, 6, 0);
  tile.m7() = owner.base();
  tile.m8() = INVALID_ROADTYPE << 6;
  SetRoadType(tile, GetRoadTramType(rt), rt);
  SetRoadOwner(tile, RoadTramType::Tram, owner);
}
 
#endif /* ROAD_MAP_H */