src/pathfinder/yapf/yapf_type.hpp

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file yapf_type.hpp Types used by YAPF. */
   9
  10 #ifndef YAPF_TYPE_HPP
  11 #define YAPF_TYPE_HPP
  12
  13 #include <iomanip>
  14 #include <sstream>
  15
  16 #include "../../core/enum_type.hpp"
  17 #include "../../misc/dbg_helpers.h"
  18
  19 /* Enum used in PfCalcCost() to see why was the segment closed. */
  20 enum EndSegmentReason {
  21         /* The following reasons can be saved into cached segment */
  22         ESR_DEAD_END = 0,      ///< track ends here
  23         ESR_RAIL_TYPE,         ///< the next tile has a different rail type than our tiles
  24         ESR_INFINITE_LOOP,     ///< infinite loop detected
  25         ESR_SEGMENT_TOO_LONG,  ///< the segment is too long (possible infinite loop)
  26         ESR_CHOICE_FOLLOWS,    ///< the next tile contains a choice (the track splits to more than one segments)
  27         ESR_DEPOT,             ///< stop in the depot (could be a target next time)
  28         ESR_WAYPOINT,          ///< waypoint encountered (could be a target next time)
  29         ESR_STATION,           ///< station encountered (could be a target next time)
  30         ESR_SAFE_TILE,         ///< safe waiting position found (could be a target)
  31
  32         /* The following reasons are used only internally by PfCalcCost().
  33          *  They should not be found in the cached segment. */
  34         ESR_PATH_TOO_LONG,     ///< the path is too long (searching for the nearest depot in the given radius)
  35         ESR_FIRST_TWO_WAY_RED, ///< first signal was 2-way and it was red
  36         ESR_LOOK_AHEAD_END,    ///< we have just passed the last look-ahead signal
  37         ESR_TARGET_REACHED,    ///< we have just reached the destination
  38
  39         /* Special values */
  40         ESR_NONE = 0xFF,          ///< no reason to end the segment here
  41 };
  42
  43 enum EndSegmentReasonBits {
  44         ESRB_NONE = 0,
  45
  46         ESRB_DEAD_END          = 1 << ESR_DEAD_END,
  47         ESRB_RAIL_TYPE         = 1 << ESR_RAIL_TYPE,
  48         ESRB_INFINITE_LOOP     = 1 << ESR_INFINITE_LOOP,
  49         ESRB_SEGMENT_TOO_LONG  = 1 << ESR_SEGMENT_TOO_LONG,
  50         ESRB_CHOICE_FOLLOWS    = 1 << ESR_CHOICE_FOLLOWS,
  51         ESRB_DEPOT             = 1 << ESR_DEPOT,
  52         ESRB_WAYPOINT          = 1 << ESR_WAYPOINT,
  53         ESRB_STATION           = 1 << ESR_STATION,
  54         ESRB_SAFE_TILE         = 1 << ESR_SAFE_TILE,
  55
  56         ESRB_PATH_TOO_LONG     = 1 << ESR_PATH_TOO_LONG,
  57         ESRB_FIRST_TWO_WAY_RED = 1 << ESR_FIRST_TWO_WAY_RED,
  58         ESRB_LOOK_AHEAD_END    = 1 << ESR_LOOK_AHEAD_END,
  59         ESRB_TARGET_REACHED    = 1 << ESR_TARGET_REACHED,
  60
  61         /* Additional (composite) values. */
  62
  63         /* What reasons mean that the target can be found and needs to be detected. */
  64         ESRB_POSSIBLE_TARGET = ESRB_DEPOT | ESRB_WAYPOINT | ESRB_STATION | ESRB_SAFE_TILE,
  65
  66         /* What reasons can be stored back into cached segment. */
  67         ESRB_CACHED_MASK = ESRB_DEAD_END | ESRB_RAIL_TYPE | ESRB_INFINITE_LOOP | ESRB_SEGMENT_TOO_LONG | ESRB_CHOICE_FOLLOWS | ESRB_DEPOT | ESRB_WAYPOINT | ESRB_STATION | ESRB_SAFE_TILE,
  68
  69         /* Reasons to abort pathfinding in this direction. */
  70         ESRB_ABORT_PF_MASK = ESRB_DEAD_END | ESRB_PATH_TOO_LONG | ESRB_INFINITE_LOOP | ESRB_FIRST_TWO_WAY_RED,
  71 };
  72
  73 DECLARE_ENUM_AS_BIT_SET(EndSegmentReasonBits)
  74
  75 inline std::string ValueStr(EndSegmentReasonBits bits)
  76 {
  77         static const char * const end_segment_reason_names[] = {
  78                 "DEAD_END", "RAIL_TYPE", "INFINITE_LOOP", "SEGMENT_TOO_LONG", "CHOICE_FOLLOWS",
  79                 "DEPOT", "WAYPOINT", "STATION", "SAFE_TILE",
  80                 "PATH_TOO_LONG", "FIRST_TWO_WAY_RED", "LOOK_AHEAD_END", "TARGET_REACHED"
  81         };
  82
  83         std::stringstream ss;
  84         ss << "0x" << std::setfill('0') << std::setw(4) << std::hex << bits; // 0x%04X
  85         ss << " (" << ComposeNameT(bits, end_segment_reason_names, "UNK", ESRB_NONE, "NONE") << ")";
  86         return ss.str();
  87 }
  88
  89 #endif /* YAPF_TYPE_HPP */