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 <http://www.gnu.org/licenses/>.
 */
 
#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 RoadTileType {
  ROAD_TILE_NORMAL,   
  ROAD_TILE_CROSSING, 
  ROAD_TILE_DEPOT,    
};
 
static inline bool MayHaveRoad(TileIndex t)
{
  switch (GetTileType(t)) {
    case MP_ROAD:
    case MP_STATION:
    case MP_TUNNELBRIDGE:
      return true;
 
    default:
      return false;
  }
}
 
static inline RoadTileType GetRoadTileType(TileIndex t)
{
  assert(IsTileType(t, MP_ROAD));
  return (RoadTileType)GB(_m[t].m5, 6, 2);
}
 
static inline bool IsNormalRoad(TileIndex t)
{
  return GetRoadTileType(t) == ROAD_TILE_NORMAL;
}
 
static inline bool IsNormalRoadTile(TileIndex t)
{
  return IsTileType(t, MP_ROAD) && IsNormalRoad(t);
}
 
static inline bool IsLevelCrossing(TileIndex t)
{
  return GetRoadTileType(t) == ROAD_TILE_CROSSING;
}
 
static inline bool IsLevelCrossingTile(TileIndex t)
{
  return IsTileType(t, MP_ROAD) && IsLevelCrossing(t);
}
 
static inline bool IsRoadDepot(TileIndex t)
{
  return GetRoadTileType(t) == ROAD_TILE_DEPOT;
}
 
static inline bool IsRoadDepotTile(TileIndex t)
{
  return IsTileType(t, MP_ROAD) && IsRoadDepot(t);
}
 
static inline RoadBits GetRoadBits(TileIndex t, RoadTramType rtt)
{
  assert(IsNormalRoad(t));
  if (rtt == RTT_TRAM) return (RoadBits)GB(_m[t].m3, 0, 4);
  return (RoadBits)GB(_m[t].m5, 0, 4);
}
 
static inline RoadBits GetAllRoadBits(TileIndex tile)
{
  return GetRoadBits(tile, RTT_ROAD) | GetRoadBits(tile, RTT_TRAM);
}
 
static inline void SetRoadBits(TileIndex t, RoadBits r, RoadTramType rtt)
{
  assert(IsNormalRoad(t)); // XXX incomplete
  if (rtt == RTT_TRAM) {
    SB(_m[t].m3, 0, 4, r);
  } else {
    SB(_m[t].m5, 0, 4, r);
  }
}
 
static inline RoadType GetRoadTypeRoad(TileIndex t)
{
  assert(MayHaveRoad(t));
  return (RoadType)GB(_m[t].m4, 0, 6);
}
 
static inline RoadType GetRoadTypeTram(TileIndex t)
{
  assert(MayHaveRoad(t));
  return (RoadType)GB(_me[t].m8, 6, 6);
}
 
static inline RoadType GetRoadType(TileIndex t, RoadTramType rtt)
{
  return (rtt == RTT_TRAM) ? GetRoadTypeTram(t) : GetRoadTypeRoad(t);
}
 
static inline RoadTypes GetPresentRoadTypes(TileIndex t)
{
  RoadTypes result = ROADTYPES_NONE;
  if (MayHaveRoad(t)) {
    if (GetRoadTypeRoad(t) != INVALID_ROADTYPE) SetBit(result, GetRoadTypeRoad(t));
    if (GetRoadTypeTram(t) != INVALID_ROADTYPE) SetBit(result, GetRoadTypeTram(t));
  }
  return result;
}
 
static inline bool HasRoadTypeRoad(TileIndex t)
{
  return GetRoadTypeRoad(t) != INVALID_ROADTYPE;
}
 
static inline bool HasRoadTypeTram(TileIndex t)
{
  return GetRoadTypeTram(t) != INVALID_ROADTYPE;
}
 
static inline bool HasTileRoadType(TileIndex t, RoadTramType rtt)
{
  return GetRoadType(t, rtt) != INVALID_ROADTYPE;
}
 
static inline bool HasTileAnyRoadType(TileIndex t, RoadTypes rts)
{
  if (!MayHaveRoad(t)) return false;
  return (GetPresentRoadTypes(t) & rts);
}
 
static inline Owner GetRoadOwner(TileIndex t, RoadTramType rtt)
{
  assert(MayHaveRoad(t));
  if (rtt == RTT_ROAD) return (Owner)GB(IsNormalRoadTile(t) ? _m[t].m1 : _me[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(_m[t].m3, 4, 4);
  return o == OWNER_TOWN ? OWNER_NONE : o;
}
 
static inline void SetRoadOwner(TileIndex t, RoadTramType rtt, Owner o)
{
  if (rtt == RTT_ROAD) {
    SB(IsNormalRoadTile(t) ? _m[t].m1 : _me[t].m7, 0, 5, o);
  } else {
    SB(_m[t].m3, 4, 4, o == OWNER_NONE ? OWNER_TOWN : o);
  }
}
 
static inline bool IsRoadOwner(TileIndex t, RoadTramType rtt, Owner o)
{
  assert(HasTileRoadType(t, rtt));
  return (GetRoadOwner(t, rtt) == o);
}
 
static inline bool HasTownOwnedRoad(TileIndex t)
{
  return HasTileRoadType(t, RTT_ROAD) && IsRoadOwner(t, RTT_ROAD, OWNER_TOWN);
}
 
static inline bool IsValidDisallowedRoadDirections(DisallowedRoadDirections drt)
{
  return drt < DRD_END;
}
 
static inline DisallowedRoadDirections GetDisallowedRoadDirections(TileIndex t)
{
  assert(IsNormalRoad(t));
  return (DisallowedRoadDirections)GB(_m[t].m5, 4, 2);
}
 
static inline void SetDisallowedRoadDirections(TileIndex t, DisallowedRoadDirections drd)
{
  assert(IsNormalRoad(t));
  assert(drd < DRD_END);
  SB(_m[t].m5, 4, 2, drd);
}
 
static inline Axis GetCrossingRoadAxis(TileIndex t)
{
  assert(IsLevelCrossing(t));
  return (Axis)GB(_m[t].m5, 0, 1);
}
 
static inline Axis GetCrossingRailAxis(TileIndex t)
{
  assert(IsLevelCrossing(t));
  return OtherAxis((Axis)GetCrossingRoadAxis(t));
}
 
static inline RoadBits GetCrossingRoadBits(TileIndex tile)
{
  return GetCrossingRoadAxis(tile) == AXIS_X ? ROAD_X : ROAD_Y;
}
 
static inline Track GetCrossingRailTrack(TileIndex tile)
{
  return AxisToTrack(GetCrossingRailAxis(tile));
}
 
static inline TrackBits GetCrossingRailBits(TileIndex tile)
{
  return AxisToTrackBits(GetCrossingRailAxis(tile));
}
 
 
static inline bool HasCrossingReservation(TileIndex t)
{
  assert(IsLevelCrossingTile(t));
  return HasBit(_m[t].m5, 4);
}
 
static inline void SetCrossingReservation(TileIndex t, bool b)
{
  assert(IsLevelCrossingTile(t));
  SB(_m[t].m5, 4, 1, b ? 1 : 0);
}
 
static inline TrackBits GetCrossingReservationTrackBits(TileIndex t)
{
  return HasCrossingReservation(t) ? GetCrossingRailBits(t) : TRACK_BIT_NONE;
}
 
static inline bool IsCrossingBarred(TileIndex t)
{
  assert(IsLevelCrossing(t));
  return HasBit(_m[t].m5, 5);
}
 
static inline void SetCrossingBarred(TileIndex t, bool barred)
{
  assert(IsLevelCrossing(t));
  SB(_m[t].m5, 5, 1, barred ? 1 : 0);
}
 
static inline void UnbarCrossing(TileIndex t)
{
  SetCrossingBarred(t, false);
}
 
static inline void BarCrossing(TileIndex t)
{
  SetCrossingBarred(t, true);
}
 
#define IsOnDesert IsOnSnow
 
static inline bool IsOnSnow(TileIndex t)
{
  return HasBit(_me[t].m7, 5);
}
 
#define ToggleDesert ToggleSnow
 
static inline void ToggleSnow(TileIndex t)
{
  ToggleBit(_me[t].m7, 5);
}
 
 
enum Roadside {
  ROADSIDE_BARREN           = 0, 
  ROADSIDE_GRASS            = 1, 
  ROADSIDE_PAVED            = 2, 
  ROADSIDE_STREET_LIGHTS    = 3, 
  // 4 is unused for historical reasons
  ROADSIDE_TREES            = 5, 
  ROADSIDE_GRASS_ROAD_WORKS = 6, 
  ROADSIDE_PAVED_ROAD_WORKS = 7, 
};
 
static inline Roadside GetRoadside(TileIndex tile)
{
  return (Roadside)GB(_me[tile].m6, 3, 3);
}
 
static inline void SetRoadside(TileIndex tile, Roadside s)
{
  SB(_me[tile].m6, 3, 3, s);
}
 
static inline bool HasRoadWorks(TileIndex t)
{
  return GetRoadside(t) >= ROADSIDE_GRASS_ROAD_WORKS;
}
 
static inline bool IncreaseRoadWorksCounter(TileIndex t)
{
  AB(_me[t].m7, 0, 4, 1);
 
  return GB(_me[t].m7, 0, 4) == 15;
}
 
static inline void StartRoadWorks(TileIndex 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_GRASS_ROAD_WORKS); break;
    default:              SetRoadside(t, ROADSIDE_PAVED_ROAD_WORKS); break;
  }
}
 
static inline void TerminateRoadWorks(TileIndex t)
{
  assert(HasRoadWorks(t));
  SetRoadside(t, (Roadside)(GetRoadside(t) - ROADSIDE_GRASS_ROAD_WORKS + ROADSIDE_GRASS));
  /* Stop the counter */
  SB(_me[t].m7, 0, 4, 0);
}
 
 
static inline DiagDirection GetRoadDepotDirection(TileIndex t)
{
  assert(IsRoadDepot(t));
  return (DiagDirection)GB(_m[t].m5, 0, 2);
}
 
 
RoadBits GetAnyRoadBits(TileIndex tile, RoadTramType rtt, bool straight_tunnel_bridge_entrance = false);
 
static inline void SetRoadTypeRoad(TileIndex t, RoadType rt)
{
  assert(MayHaveRoad(t));
  assert(rt == INVALID_ROADTYPE || RoadTypeIsRoad(rt));
  SB(_m[t].m4, 0, 6, rt);
}
 
static inline void SetRoadTypeTram(TileIndex t, RoadType rt)
{
  assert(MayHaveRoad(t));
  assert(rt == INVALID_ROADTYPE || RoadTypeIsTram(rt));
  SB(_me[t].m8, 6, 6, rt);
}
 
static inline void SetRoadType(TileIndex t, RoadTramType rtt, RoadType rt)
{
  if (rtt == RTT_TRAM) {
    SetRoadTypeTram(t, rt);
  } else {
    SetRoadTypeRoad(t, rt);
  }
}
 
static inline void SetRoadTypes(TileIndex t, RoadType road_rt, RoadType tram_rt)
{
  SetRoadTypeRoad(t, road_rt);
  SetRoadTypeTram(t, tram_rt);
}
 
static inline void MakeRoadNormal(TileIndex t, RoadBits bits, RoadType road_rt, RoadType tram_rt, TownID town, Owner road, Owner tram)
{
  SetTileType(t, MP_ROAD);
  SetTileOwner(t, road);
  _m[t].m2 = town;
  _m[t].m3 = (tram_rt != INVALID_ROADTYPE ? bits : 0);
  _m[t].m5 = (road_rt != INVALID_ROADTYPE ? bits : 0) | ROAD_TILE_NORMAL << 6;
  SB(_me[t].m6, 2, 4, 0);
  _me[t].m7 = 0;
  SetRoadTypes(t, road_rt, tram_rt);
  SetRoadOwner(t, RTT_TRAM, tram);
}
 
static inline void MakeRoadCrossing(TileIndex t, Owner road, Owner tram, Owner rail, Axis roaddir, RailType rat, RoadType road_rt, RoadType tram_rt, uint town)
{
  SetTileType(t, MP_ROAD);
  SetTileOwner(t, rail);
  _m[t].m2 = town;
  _m[t].m3 = 0;
  _m[t].m4 = INVALID_ROADTYPE;
  _m[t].m5 = ROAD_TILE_CROSSING << 6 | roaddir;
  SB(_me[t].m6, 2, 4, 0);
  _me[t].m7 = road;
  _me[t].m8 = INVALID_ROADTYPE << 6 | rat;
  SetRoadTypes(t, road_rt, tram_rt);
  SetRoadOwner(t, RTT_TRAM, tram);
}
 
static inline void MakeRoadDepot(TileIndex t, Owner owner, DepotID did, DiagDirection dir, RoadType rt)
{
  SetTileType(t, MP_ROAD);
  SetTileOwner(t, owner);
  _m[t].m2 = did;
  _m[t].m3 = 0;
  _m[t].m4 = INVALID_ROADTYPE;
  _m[t].m5 = ROAD_TILE_DEPOT << 6 | dir;
  SB(_me[t].m6, 2, 4, 0);
  _me[t].m7 = owner;
  _me[t].m8 = INVALID_ROADTYPE << 6;
  SetRoadType(t, GetRoadTramType(rt), rt);
  SetRoadOwner(t, RTT_TRAM, owner);
}
 
#endif /* ROAD_MAP_H */