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 "tile_type.h"
  16 #include "direction_type.h"
  17 #include "track_type.h"
  18 #include "vehicle_type.h"
  19
  20 TrackBits GetReservedTrackbits(TileIndex t);
  21
  22 void SetRailStationPlatformReservation(TileIndex start, DiagDirection dir, bool b);
  23
  24 bool TryReserveRailTrack(TileIndex tile, Track t, bool trigger_stations = true);
  25 bool TryReserveRailTrackdir(TileIndex tile, Trackdir td, bool trigger_stations = true);
  26 void UnreserveRailTrack(TileIndex tile, Track t);
  27 void UnreserveRailTrackdir(TileIndex tile, Trackdir td);
  28
  29 /** This struct contains information about the end of a reserved path. */
  30 struct PBSTileInfo {
  31         TileIndex tile;      ///< Tile the path ends, INVALID_TILE if no valid path was found.
  32         Trackdir  trackdir;  ///< The reserved trackdir on the tile.
  33         bool      okay;      ///< True if tile is a safe waiting position, false otherwise.
  34
  35         /**
  36          * Create an empty PBSTileInfo.
  37          */
  38         PBSTileInfo() : tile(INVALID_TILE), trackdir(INVALID_TRACKDIR), okay(false) {}
  39
  40         /**
  41          * Create a PBSTileInfo with given tile, track direction and safe waiting position information.
  42          * @param _t The tile where the path ends.
  43          * @param _td The reserved track dir on the tile.
  44          * @param _okay Whether the tile is a safe waiting point or not.
  45          */
  46         PBSTileInfo(TileIndex _t, Trackdir _td, bool _okay) : tile(_t), trackdir(_td), okay(_okay) {}
  47 };
  48
  49 PBSTileInfo FollowTrainReservation(const Train *v, Vehicle **train_on_res = nullptr);
  50 bool IsSafeWaitingPosition(const Train *v, TileIndex tile, Trackdir trackdir, bool include_line_end, bool forbid_90deg = false);
  51 bool IsWaitingPositionFree(const Train *v, TileIndex tile, Trackdir trackdir, bool forbid_90deg = false);
  52
  53 Train *GetTrainForReservation(TileIndex tile, Track track);
  54
  55 /**
  56  * Check whether some of tracks is reserved on a tile.
  57  *
  58  * @param tile the tile
  59  * @param tracks the tracks to test
  60  * @return true if at least on of tracks is reserved
  61  */
  62 static inline bool HasReservedTracks(TileIndex tile, TrackBits tracks)
  63 {
  64         return (GetReservedTrackbits(tile) & tracks) != TRACK_BIT_NONE;
  65 }
  66
  67 #endif /* PBS_H */