OpenTTD-patches/src/road_map.h

699 lines
17 KiB
C

/*
* 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/>.
*/
/** @file road_map.h Map accessors for roads. */
#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"
/** The different types of road tiles. */
enum RoadTileType {
ROAD_TILE_NORMAL, ///< Normal road
ROAD_TILE_CROSSING, ///< Level crossing
ROAD_TILE_DEPOT, ///< Depot (one entrance)
};
/**
* Test whether a tile can have road/tram types.
* @param t Tile to query.
* @return true if tile can be queried about road/tram types.
*/
static inline bool MayHaveRoad(Tile t)
{
switch (GetTileType(t)) {
case MP_ROAD:
case MP_STATION:
case MP_TUNNELBRIDGE:
return true;
default:
return false;
}
}
/**
* Get the type of the road tile.
* @param t Tile to query.
* @pre IsTileType(t, MP_ROAD)
* @return The road tile type.
*/
debug_inline static RoadTileType GetRoadTileType(Tile t)
{
assert(IsTileType(t, MP_ROAD));
return (RoadTileType)GB(t.m5(), 6, 2);
}
/**
* Return whether a tile is a normal road.
* @param t Tile to query.
* @pre IsTileType(t, MP_ROAD)
* @return True if normal road.
*/
debug_inline static bool IsNormalRoad(Tile t)
{
return GetRoadTileType(t) == ROAD_TILE_NORMAL;
}
/**
* Return whether a tile is a normal road tile.
* @param t Tile to query.
* @return True if normal road tile.
*/
debug_inline static bool IsNormalRoadTile(Tile t)
{
return IsTileType(t, MP_ROAD) && IsNormalRoad(t);
}
/**
* Return whether a tile is a level crossing.
* @param t Tile to query.
* @pre IsTileType(t, MP_ROAD)
* @return True if level crossing.
*/
static inline bool IsLevelCrossing(Tile t)
{
return GetRoadTileType(t) == ROAD_TILE_CROSSING;
}
/**
* Return whether a tile is a level crossing tile.
* @param t Tile to query.
* @return True if level crossing tile.
*/
static inline bool IsLevelCrossingTile(Tile t)
{
return IsTileType(t, MP_ROAD) && IsLevelCrossing(t);
}
/**
* Return whether a tile is a road depot.
* @param t Tile to query.
* @pre IsTileType(t, MP_ROAD)
* @return True if road depot.
*/
debug_inline static bool IsRoadDepot(Tile t)
{
return GetRoadTileType(t) == ROAD_TILE_DEPOT;
}
/**
* Return whether a tile is a road depot tile.
* @param t Tile to query.
* @return True if road depot tile.
*/
debug_inline static bool IsRoadDepotTile(Tile t)
{
return IsTileType(t, MP_ROAD) && IsRoadDepot(t);
}
/**
* Get the present road bits for a specific road type.
* @param t The tile to query.
* @param rt Road type.
* @pre IsNormalRoad(t)
* @return The present road bits for the road type.
*/
static inline RoadBits GetRoadBits(Tile t, RoadTramType rtt)
{
assert(IsNormalRoad(t));
if (rtt == RTT_TRAM) return (RoadBits)GB(t.m3(), 0, 4);
return (RoadBits)GB(t.m5(), 0, 4);
}
/**
* Get all set RoadBits on the given tile
*
* @param tile The tile from which we want to get the RoadBits
* @return all set RoadBits of the tile
*/
static inline RoadBits GetAllRoadBits(Tile tile)
{
return GetRoadBits(tile, RTT_ROAD) | GetRoadBits(tile, RTT_TRAM);
}
/**
* Set the present road bits for a specific road type.
* @param t The tile to change.
* @param r The new road bits.
* @param rt Road type.
* @pre IsNormalRoad(t)
*/
static inline void SetRoadBits(Tile t, RoadBits r, RoadTramType rtt)
{
assert(IsNormalRoad(t)); // XXX incomplete
if (rtt == RTT_TRAM) {
SB(t.m3(), 0, 4, r);
} else {
SB(t.m5(), 0, 4, r);
}
}
static inline RoadType GetRoadTypeRoad(Tile t)
{
assert(MayHaveRoad(t));
return (RoadType)GB(t.m4(), 0, 6);
}
static inline RoadType GetRoadTypeTram(Tile t)
{
assert(MayHaveRoad(t));
return (RoadType)GB(t.m8(), 6, 6);
}
static inline RoadType GetRoadType(Tile t, RoadTramType rtt)
{
return (rtt == RTT_TRAM) ? GetRoadTypeTram(t) : GetRoadTypeRoad(t);
}
/**
* Get the present road types of a tile.
* @param t The tile to query.
* @return Present road types.
*/
static inline RoadTypes GetPresentRoadTypes(Tile 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(Tile t)
{
return GetRoadTypeRoad(t) != INVALID_ROADTYPE;
}
static inline bool HasRoadTypeTram(Tile t)
{
return GetRoadTypeTram(t) != INVALID_ROADTYPE;
}
/**
* Check if a tile has a road or a tram road type.
* @param t The tile to check.
* @param tram True to check tram, false to check road.
* @return True if the tile has the specified road type.
*/
static inline bool HasTileRoadType(Tile t, RoadTramType rtt)
{
return GetRoadType(t, rtt) != INVALID_ROADTYPE;
}
/**
* Check if a tile has one of the specified road types.
* @param t The tile to check.
* @param rts Allowed road types.
* @return True if the tile has one of the specified road types.
*/
static inline bool HasTileAnyRoadType(Tile t, RoadTypes rts)
{
if (!MayHaveRoad(t)) return false;
return (GetPresentRoadTypes(t) & rts);
}
/**
* Get the owner of a specific road type.
* @param t The tile to query.
* @param rtt RoadTramType.
* @return Owner of the given road type.
*/
static inline Owner GetRoadOwner(Tile t, RoadTramType rtt)
{
assert(MayHaveRoad(t));
if (rtt == RTT_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;
}
/**
* Set the owner of a specific road type.
* @param t The tile to change.
* @param rtt RoadTramType.
* @param o New owner of the given road type.
*/
static inline void SetRoadOwner(Tile t, RoadTramType rtt, Owner o)
{
if (rtt == RTT_ROAD) {
SB(IsNormalRoadTile(t) ? t.m1() : t.m7(), 0, 5, o);
} else {
SB(t.m3(), 4, 4, o == OWNER_NONE ? OWNER_TOWN : o);
}
}
/**
* Check if a specific road type is owned by an owner.
* @param t The tile to query.
* @param tram True to check tram, false to check road.
* @param o Owner to compare with.
* @pre HasTileRoadType(t, rt)
* @return True if the road type is owned by the given owner.
*/
static inline bool IsRoadOwner(Tile t, RoadTramType rtt, Owner o)
{
assert(HasTileRoadType(t, rtt));
return (GetRoadOwner(t, rtt) == o);
}
/**
* Checks if given tile has town owned road
* @param t tile to check
* @pre IsTileType(t, MP_ROAD)
* @return true iff tile has road and the road is owned by a town
*/
static inline bool HasTownOwnedRoad(Tile t)
{
return HasTileRoadType(t, RTT_ROAD) && IsRoadOwner(t, RTT_ROAD, OWNER_TOWN);
}
/**
* Checks if a DisallowedRoadDirections is valid.
*
* @param wc The value to check
* @return true if the given value is a valid DisallowedRoadDirections.
*/
static inline bool IsValidDisallowedRoadDirections(DisallowedRoadDirections drt)
{
return drt < DRD_END;
}
/**
* Gets the disallowed directions
* @param t the tile to get the directions from
* @return the disallowed directions
*/
static inline DisallowedRoadDirections GetDisallowedRoadDirections(Tile t)
{
assert(IsNormalRoad(t));
return (DisallowedRoadDirections)GB(t.m5(), 4, 2);
}
/**
* Sets the disallowed directions
* @param t the tile to set the directions for
* @param drd the disallowed directions
*/
static inline void SetDisallowedRoadDirections(Tile t, DisallowedRoadDirections drd)
{
assert(IsNormalRoad(t));
assert(drd < DRD_END);
SB(t.m5(), 4, 2, drd);
}
/**
* Get the road axis of a level crossing.
* @param t The tile to query.
* @pre IsLevelCrossing(t)
* @return The axis of the road.
*/
static inline Axis GetCrossingRoadAxis(Tile t)
{
assert(IsLevelCrossing(t));
return (Axis)GB(t.m5(), 0, 1);
}
/**
* Get the rail axis of a level crossing.
* @param t The tile to query.
* @pre IsLevelCrossing(t)
* @return The axis of the rail.
*/
static inline Axis GetCrossingRailAxis(Tile t)
{
assert(IsLevelCrossing(t));
return OtherAxis((Axis)GetCrossingRoadAxis(t));
}
/**
* Get the road bits of a level crossing.
* @param tile The tile to query.
* @return The present road bits.
*/
static inline RoadBits GetCrossingRoadBits(Tile tile)
{
return GetCrossingRoadAxis(tile) == AXIS_X ? ROAD_X : ROAD_Y;
}
/**
* Get the rail track of a level crossing.
* @param tile The tile to query.
* @return The rail track.
*/
static inline Track GetCrossingRailTrack(Tile tile)
{
return AxisToTrack(GetCrossingRailAxis(tile));
}
/**
* Get the rail track bits of a level crossing.
* @param tile The tile to query.
* @return The rail track bits.
*/
static inline TrackBits GetCrossingRailBits(Tile tile)
{
return AxisToTrackBits(GetCrossingRailAxis(tile));
}
/**
* Get the reservation state of the rail crossing
* @param t the crossing tile
* @return reservation state
* @pre IsLevelCrossingTile(t)
*/
static inline bool HasCrossingReservation(Tile t)
{
assert(IsLevelCrossingTile(t));
return HasBit(t.m5(), 4);
}
/**
* Set the reservation state of the rail crossing
* @note Works for both waypoints and rail depots
* @param t the crossing tile
* @param b the reservation state
* @pre IsLevelCrossingTile(t)
*/
static inline void SetCrossingReservation(Tile t, bool b)
{
assert(IsLevelCrossingTile(t));
SB(t.m5(), 4, 1, b ? 1 : 0);
}
/**
* Get the reserved track bits for a rail crossing
* @param t the tile
* @pre IsLevelCrossingTile(t)
* @return reserved track bits
*/
static inline TrackBits GetCrossingReservationTrackBits(Tile t)
{
return HasCrossingReservation(t) ? GetCrossingRailBits(t) : TRACK_BIT_NONE;
}
/**
* Check if the level crossing is barred.
* @param t The tile to query.
* @pre IsLevelCrossing(t)
* @return True if the level crossing is barred.
*/
static inline bool IsCrossingBarred(Tile t)
{
assert(IsLevelCrossing(t));
return HasBit(t.m5(), 5);
}
/**
* Set the bar state of a level crossing.
* @param t The tile to modify.
* @param barred True if the crossing should be barred, false otherwise.
* @pre IsLevelCrossing(t)
*/
static inline void SetCrossingBarred(Tile t, bool barred)
{
assert(IsLevelCrossing(t));
SB(t.m5(), 5, 1, barred ? 1 : 0);
}
/**
* Unbar a level crossing.
* @param t The tile to change.
*/
static inline void UnbarCrossing(Tile t)
{
SetCrossingBarred(t, false);
}
/**
* Bar a level crossing.
* @param t The tile to change.
*/
static inline void BarCrossing(Tile t)
{
SetCrossingBarred(t, true);
}
/** Check if a road tile has snow/desert. */
#define IsOnDesert IsOnSnow
/**
* Check if a road tile has snow/desert.
* @param t The tile to query.
* @return True if the tile has snow/desert.
*/
static inline bool IsOnSnow(Tile t)
{
return HasBit(t.m7(), 5);
}
/** Toggle the snow/desert state of a road tile. */
#define ToggleDesert ToggleSnow
/**
* Toggle the snow/desert state of a road tile.
* @param t The tile to change.
*/
static inline void ToggleSnow(Tile t)
{
ToggleBit(t.m7(), 5);
}
/** The possible road side decorations. */
enum Roadside {
ROADSIDE_BARREN = 0, ///< Road on barren land
ROADSIDE_GRASS = 1, ///< Road on grass
ROADSIDE_PAVED = 2, ///< Road with paved sidewalks
ROADSIDE_STREET_LIGHTS = 3, ///< Road with street lights on paved sidewalks
// 4 is unused for historical reasons
ROADSIDE_TREES = 5, ///< Road with trees on paved sidewalks
ROADSIDE_GRASS_ROAD_WORKS = 6, ///< Road on grass with road works
ROADSIDE_PAVED_ROAD_WORKS = 7, ///< Road with sidewalks and road works
};
/**
* Get the decorations of a road.
* @param tile The tile to query.
* @return The road decoration of the tile.
*/
static inline Roadside GetRoadside(Tile tile)
{
return (Roadside)GB(tile.m6(), 3, 3);
}
/**
* Set the decorations of a road.
* @param tile The tile to change.
* @param s The new road decoration of the tile.
*/
static inline void SetRoadside(Tile tile, Roadside s)
{
SB(tile.m6(), 3, 3, s);
}
/**
* Check if a tile has road works.
* @param t The tile to check.
* @return True if the tile has road works in progress.
*/
static inline bool HasRoadWorks(Tile t)
{
return GetRoadside(t) >= ROADSIDE_GRASS_ROAD_WORKS;
}
/**
* Increase the progress counter of road works.
* @param t The tile to modify.
* @return True if the road works are in the last stage.
*/
static inline bool IncreaseRoadWorksCounter(Tile t)
{
AB(t.m7(), 0, 4, 1);
return GB(t.m7(), 0, 4) == 15;
}
/**
* Start road works on a tile.
* @param t The tile to start the work on.
* @pre !HasRoadWorks(t)
*/
static 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_GRASS_ROAD_WORKS); break;
default: SetRoadside(t, ROADSIDE_PAVED_ROAD_WORKS); break;
}
}
/**
* Terminate road works on a tile.
* @param t Tile to stop the road works on.
* @pre HasRoadWorks(t)
*/
static inline void TerminateRoadWorks(Tile t)
{
assert(HasRoadWorks(t));
SetRoadside(t, (Roadside)(GetRoadside(t) - ROADSIDE_GRASS_ROAD_WORKS + ROADSIDE_GRASS));
/* Stop the counter */
SB(t.m7(), 0, 4, 0);
}
/**
* Get the direction of the exit of a road depot.
* @param t The tile to query.
* @return Diagonal direction of the depot exit.
*/
static inline DiagDirection GetRoadDepotDirection(Tile t)
{
assert(IsRoadDepot(t));
return (DiagDirection)GB(t.m5(), 0, 2);
}
RoadBits GetAnyRoadBits(Tile tile, RoadTramType rtt, bool straight_tunnel_bridge_entrance = false);
/**
* Set the road road type of a tile.
* @param t The tile to change.
* @param rt The road type to set.
*/
static inline void SetRoadTypeRoad(Tile t, RoadType rt)
{
assert(MayHaveRoad(t));
assert(rt == INVALID_ROADTYPE || RoadTypeIsRoad(rt));
SB(t.m4(), 0, 6, rt);
}
/**
* Set the tram road type of a tile.
* @param t The tile to change.
* @param rt The road type to set.
*/
static inline void SetRoadTypeTram(Tile t, RoadType rt)
{
assert(MayHaveRoad(t));
assert(rt == INVALID_ROADTYPE || RoadTypeIsTram(rt));
SB(t.m8(), 6, 6, rt);
}
/**
* Set the road type of a tile.
* @param t The tile to change.
* @param rtt Set road or tram type.
* @param rt The road type to set.
*/
static inline void SetRoadType(Tile t, RoadTramType rtt, RoadType rt)
{
if (rtt == RTT_TRAM) {
SetRoadTypeTram(t, rt);
} else {
SetRoadTypeRoad(t, rt);
}
}
/**
* Set the present road types of a tile.
* @param t The tile to change.
* @param road_rt The road roadtype to set for the tile.
* @param tram_rt The tram roadtype to set for the tile.
*/
static inline void SetRoadTypes(Tile t, RoadType road_rt, RoadType tram_rt)
{
SetRoadTypeRoad(t, road_rt);
SetRoadTypeTram(t, tram_rt);
}
/**
* Make a normal road tile.
* @param t Tile to make a normal road.
* @param bits Road bits to set for all present road types.
* @param road_rt The road roadtype to set for the tile.
* @param tram_rt The tram roadtype to set for the tile.
* @param town Town ID if the road is a town-owned road.
* @param road New owner of road.
* @param tram New owner of tram tracks.
*/
static inline void MakeRoadNormal(Tile t, RoadBits bits, RoadType road_rt, RoadType tram_rt, TownID town, Owner road, Owner tram)
{
SetTileType(t, MP_ROAD);
SetTileOwner(t, road);
t.m2() = town;
t.m3() = (tram_rt != INVALID_ROADTYPE ? bits : 0);
t.m5() = (road_rt != INVALID_ROADTYPE ? bits : 0) | ROAD_TILE_NORMAL << 6;
SB(t.m6(), 2, 4, 0);
t.m7() = 0;
SetRoadTypes(t, road_rt, tram_rt);
SetRoadOwner(t, RTT_TRAM, tram);
}
/**
* Make a level crossing.
* @param t Tile to make a level crossing.
* @param road New owner of road.
* @param tram New owner of tram tracks.
* @param rail New owner of the rail track.
* @param roaddir Axis of the road.
* @param rat New rail type.
* @param road_rt The road roadtype to set for the tile.
* @param tram_rt The tram roadtype to set for the tile.
* @param town Town ID if the road is a town-owned road.
*/
static inline void MakeRoadCrossing(Tile 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);
t.m2() = town;
t.m3() = 0;
t.m4() = INVALID_ROADTYPE;
t.m5() = ROAD_TILE_CROSSING << 6 | roaddir;
SB(t.m6(), 2, 4, 0);
t.m7() = road;
t.m8() = INVALID_ROADTYPE << 6 | rat;
SetRoadTypes(t, road_rt, tram_rt);
SetRoadOwner(t, RTT_TRAM, tram);
}
/**
* Make a road depot.
* @param t Tile to make a level crossing.
* @param owner New owner of the depot.
* @param did New depot ID.
* @param dir Direction of the depot exit.*
* @param rt Road type of the depot.
*/
static inline void MakeRoadDepot(Tile t, Owner owner, DepotID did, DiagDirection dir, RoadType rt)
{
SetTileType(t, MP_ROAD);
SetTileOwner(t, owner);
t.m2() = did;
t.m3() = 0;
t.m4() = INVALID_ROADTYPE;
t.m5() = ROAD_TILE_DEPOT << 6 | dir;
SB(t.m6(), 2, 4, 0);
t.m7() = owner;
t.m8() = INVALID_ROADTYPE << 6;
SetRoadType(t, GetRoadTramType(rt), rt);
SetRoadOwner(t, RTT_TRAM, owner);
}
#endif /* ROAD_MAP_H */