yapf_type.hpp

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 YAPF_TYPE_HPP
#define YAPF_TYPE_HPP
 
#include <iomanip>
#include <sstream>
 
#include "../../core/enum_type.hpp"
#include "../../misc/dbg_helpers.h"
 
/* Enum used in PfCalcCost() to see why was the segment closed. */
enum class EndSegmentReason : uint8_t {
  /* The following reasons can be saved into cached segment */
  DeadEnd, 
  RailType, 
  InfiniteLoop, 
  SegmentTooLong, 
  ChoiceFollows, 
  Depot, 
  Waypoint, 
  Station, 
  SafeTile, 
 
  /* The following reasons are used only internally by PfCalcCost().
   *  They should not be found in the cached segment. */
  PathTooLong, 
  FirstTwoWayRed, 
  LookAheadEnd, 
  TargetReached, 
};
using EndSegmentReasons = EnumBitSet<EndSegmentReason, uint16_t>;
 
/* What reasons mean that the target can be found and needs to be detected. */
static constexpr EndSegmentReasons ESRF_POSSIBLE_TARGET = {
  EndSegmentReason::Depot,
  EndSegmentReason::Waypoint,
  EndSegmentReason::Station,
  EndSegmentReason::SafeTile,
};
 
/* What reasons can be stored back into cached segment. */
static constexpr EndSegmentReasons ESRF_CACHED_MASK = {
  EndSegmentReason::DeadEnd,
  EndSegmentReason::RailType,
  EndSegmentReason::InfiniteLoop,
  EndSegmentReason::SegmentTooLong,
  EndSegmentReason::ChoiceFollows,
  EndSegmentReason::Depot,
  EndSegmentReason::Waypoint,
  EndSegmentReason::Station,
  EndSegmentReason::SafeTile,
};
 
/* Reasons to abort pathfinding in this direction. */
static constexpr EndSegmentReasons ESRF_ABORT_PF_MASK = {
  EndSegmentReason::DeadEnd,
  EndSegmentReason::PathTooLong,
  EndSegmentReason::InfiniteLoop,
  EndSegmentReason::FirstTwoWayRed,
};
 
inline std::string ValueStr(EndSegmentReasons flags)
{
  static const std::initializer_list<std::string_view> end_segment_reason_names = {
    "DEAD_END", "RAIL_TYPE", "INFINITE_LOOP", "SEGMENT_TOO_LONG", "CHOICE_FOLLOWS",
    "DEPOT", "WAYPOINT", "STATION", "SAFE_TILE",
    "PATH_TOO_LONG", "FIRST_TWO_WAY_RED", "LOOK_AHEAD_END", "TARGET_REACHED"
  };
 
  std::stringstream ss;
  ss << "0x" << std::setfill('0') << std::setw(4) << std::hex << flags.base(); // 0x%04X
  ss << " (" << ComposeNameT(flags, end_segment_reason_names, "UNK") << ")";
  return ss.str();
}
 
#endif /* YAPF_TYPE_HPP */