src/pbs.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file pbs.h PBS support routines */
  11
  12 #ifndef PBS_H
  13 #define PBS_H
  14
  15 #include "map/coord.h"
  16 #include "direction_type.h"
  17 #include "track_type.h"
  18 #include "track_func.h"
  19 #include "vehicle_type.h"
  20 #include "pathfinder/railpos.h"
  21 #include "map/bridge.h"
  22 #include "map/tunnelbridge.h"
  23 #include "bridge.h"
  24
  25 TrackBits GetReservedTrackbits(TileIndex t);
  26
  27 bool HasReservedMapPos (const RailPathPos &pos);
  28
  29 /**
  30  * Check whether a position is reserved.
  31  * @param pos the position
  32  * @return true if the track is reserved
  33  */
  34 static inline bool HasReservedPos(const RailPathPos &pos)
  35 {
  36         return !pos.in_wormhole() ? HasReservedMapPos (pos) :
  37                 IsRailwayTile (pos.wormhole) ? HasBridgeMiddleReservation (pos.wormhole) : HasTunnelMiddleReservation (pos.wormhole);
  38 }
  39
  40 void SetRailStationPlatformReservation(TileIndex start, DiagDirection dir, bool b);
  41 void SetRailStationPlatformReservation(const RailPathPos &pos, bool b);
  42
  43 bool TryReserveRailTrack(TileIndex tile, Track t, bool trigger_stations = true);
  44 void UnreserveRailTrack(TileIndex tile, Track t);
  45
  46 static inline bool TryReserveRailTrack(const RailPathPos &pos)
  47 {
  48         if (!pos.in_wormhole()) {
  49                 return TryReserveRailTrack(pos.tile, TrackdirToTrack(pos.td));
  50         } else if (IsRailwayTile(pos.wormhole)) {
  51                 if (HasBridgeMiddleReservation(pos.wormhole)) return false;
  52                 SetBridgeMiddleReservation(pos.wormhole, true);
  53                 TileIndex end = GetOtherBridgeEnd (pos.wormhole);
  54                 SetBridgeMiddleReservation(end, true);
  55                 MarkBridgeTilesDirty (pos.wormhole, end, GetTunnelBridgeDirection (pos.wormhole), false);
  56                 return true;
  57         } else {
  58                 if (HasTunnelMiddleReservation(pos.wormhole)) return false;
  59                 SetTunnelMiddleReservation(pos.wormhole, true);
  60                 SetTunnelMiddleReservation(GetOtherTunnelEnd(pos.wormhole), true);
  61                 return true;
  62         }
  63 }
  64
  65 static inline void UnreserveRailTrack(const RailPathPos &pos)
  66 {
  67         if (!pos.in_wormhole()) {
  68                 UnreserveRailTrack(pos.tile, TrackdirToTrack(pos.td));
  69         } else if (IsRailwayTile(pos.wormhole)) {
  70                 SetBridgeMiddleReservation(pos.wormhole, false);
  71                 TileIndex end = GetOtherBridgeEnd (pos.wormhole);
  72                 SetBridgeMiddleReservation(end, false);
  73                 MarkBridgeTilesDirty (pos.wormhole, end, GetTunnelBridgeDirection (pos.wormhole), false);
  74         } else {
  75                 SetTunnelMiddleReservation(pos.wormhole, false);
  76                 SetTunnelMiddleReservation(GetOtherTunnelEnd(pos.wormhole), false);
  77         }
  78 }
  79
  80 bool FollowTrainReservation (const Train *v, RailPathPos *pos, bool check = false);
  81
  82 /** State of a waiting position wrt PBS. */
  83 enum PBSPositionState {
  84         PBS_UNSAFE, ///< Not a safe waiting position
  85         PBS_BUSY,   ///< Waiting position safe but busy
  86         PBS_FREE,   ///< Waiting position safe and free
  87 };
  88
  89 /** Checking behaviour for CheckWaitingPosition. */
  90 enum PBSCheckingBehaviour {
  91         PBS_CHECK_FULL,      ///< Do a full check of the waiting position
  92         PBS_CHECK_SAFE,      ///< Only check if the waiting position is safe
  93         PBS_CHECK_FREE,      ///< Assume that the waiting position is safe, and check if it is free
  94         PBS_CHECK_SAFE_FREE, ///< Check if the waiting position is both safe and free
  95 };
  96
  97 PBSPositionState CheckWaitingPosition(const Train *v, const RailPathPos &pos, bool forbid_90deg = false, PBSCheckingBehaviour cb = PBS_CHECK_FULL);
  98
  99 static inline bool IsSafeWaitingPosition(const Train *v, const RailPathPos &pos, bool forbid_90deg = false)
 100 {
 101         return CheckWaitingPosition(v, pos, forbid_90deg, PBS_CHECK_SAFE) != PBS_UNSAFE;
 102 }
 103
 104 static inline bool IsWaitingPositionFree(const Train *v, const RailPathPos &pos, bool forbid_90deg = false)
 105 {
 106         return CheckWaitingPosition(v, pos, forbid_90deg, PBS_CHECK_FREE) == PBS_FREE;
 107 }
 108
 109 static inline bool IsFreeSafeWaitingPosition(const Train *v, const RailPathPos &pos, bool forbid_90deg = false)
 110 {
 111         return CheckWaitingPosition(v, pos, forbid_90deg, PBS_CHECK_SAFE_FREE) == PBS_FREE;
 112 }
 113
 114 Train *GetTrainForReservation (TileIndex tile, Track track, bool free = false);
 115
 116 /**
 117  * Check whether some of tracks is reserved on a tile.
 118  *
 119  * @param tile the tile
 120  * @param tracks the tracks to test
 121  * @return true if at least on of tracks is reserved
 122  */
 123 static inline bool HasReservedTracks(TileIndex tile, TrackBits tracks)
 124 {
 125         return (GetReservedTrackbits(tile) & tracks) != TRACK_BIT_NONE;
 126 }
 127
 128 /**
 129  * Check whether a track is reserved on a tile.
 130  *
 131  * @param tile the tile
 132  * @param track the track to test
 133  * @return true if the track is reserved
 134  */
 135 static inline bool HasReservedTrack(TileIndex tile, Track track)
 136 {
 137         return HasReservedTracks(tile, TrackToTrackBits(track));
 138 }
 139
 140 #endif /* PBS_H */