dbg_helpers.h

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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef DBG_HELPERS_H
#define DBG_HELPERS_H
 
#include <stack>
 
#include "../direction_type.h"
#include "../signal_type.h"
#include "../tile_type.h"
#include "../track_type.h"
#include "../core/format.hpp"

template <typename E>
inline std::string_view ItemAt(E idx, std::span<const std::string_view> names, std::string_view unknown_name)
{
  if (static_cast<size_t>(idx) >= std::size(names)) {
    return unknown_name;
  }
  return names[idx];
}

template <typename E>
inline std::string_view ItemAt(E idx, std::span<const std::string_view> names, std::string_view unknown_name, E invalid_index, std::string_view invalid_name)
{
  if (idx == invalid_index) {
    return invalid_name;
  }
  return ItemAt(idx, names, unknown_name);
}

template <typename E>
inline std::string ComposeName(E value, std::span<const std::string_view> names, std::string_view unknown_name, E invalid_index, std::string_view invalid_name)
{
  std::string out;
  if (value == invalid_index) {
    out = invalid_name;
  } else if (value == 0) {
    out = "<none>";
  } else {
    for (size_t i = 0; i < std::size(names); i++) {
      if ((value & (1 << i)) == 0) continue;
      out += (!out.empty() ? "+" : "");
      out += names[i];
      value &= ~(E)(1 << i);
    }
    if (value != 0) {
      out += (!out.empty() ? "+" : "");
      out += unknown_name;
    }
  }
  return out;
}

template <typename E>
inline std::string ComposeName(E value, std::span<const std::string_view> names, std::string_view unknown_name)
{
  std::string out;
  if (value.base() == 0) {
    out = "<none>";
  } else {
    for (size_t i = 0; i < std::size(names); ++i) {
      if (!value.Test(static_cast<E::EnumType>(i))) continue;
      out += (!out.empty() ? "+" : "");
      out += names[i];
      value.Reset(static_cast<E::EnumType>(i));
    }
    if (value.base() != 0) {
      out += (!out.empty() ? "+" : "");
      out += unknown_name;
    }
  }
  return out;
}
 
std::string ValueStr(Trackdir td);
std::string ValueStr(TrackdirBits td_bits);
std::string ValueStr(DiagDirection dd);
std::string ValueStr(SignalType t);

struct DumpTarget {
  struct KnownStructKey {
    size_t type_id; 
    const void *ptr; 

    KnownStructKey(size_t type_id, const void *ptr) : type_id(type_id), ptr(ptr) {}
 
    bool operator<(const KnownStructKey &other) const
    {
      if (reinterpret_cast<size_t>(this->ptr) < reinterpret_cast<size_t>(other.ptr)) return true;
      if (reinterpret_cast<size_t>(this->ptr) > reinterpret_cast<size_t>(other.ptr)) return false;
      if (this->type_id < other.type_id) return true;
      return false;
    }
  };

  using KnownNamesMap = std::map<KnownStructKey, std::string>;
 
  std::string output_buffer; 
  int indent = 0; 
  std::stack<std::string> cur_struct; 
  KnownNamesMap known_names; 
 
  static size_t NewTypeId();
  std::string GetCurrentStructName();
  std::optional<std::string> FindKnownAsName(size_t type_id, const void *ptr);
 
  void WriteIndent();

  void WriteValue(std::string_view name, const auto &value)
  {
    this->WriteIndent();
    format_append(this->output_buffer, "{} = {}\n", name, value);
  }
 
  void WriteTile(std::string_view name, TileIndex t);

  template <typename E> void WriteEnumT(std::string_view name, E e)
  {
    this->WriteValue(name, ValueStr(e));
  }
 
  void BeginStruct(size_t type_id, std::string_view name, const void *ptr);
  void EndStruct();

  template <typename S> void WriteStructT(std::string_view name, const S *s)
  {
    static const size_t type_id = this->NewTypeId();
 
    if (s == nullptr) {
      /* No need to dump nullptr struct. */
      this->WriteValue(name, "<null>");
      return;
    }
    if (auto known_as = this->FindKnownAsName(type_id, s); known_as.has_value()) {
      /* We already know this one, no need to dump it. */
      this->WriteValue(name, *known_as);
    } else {
      /* Still unknown, dump it */
      this->BeginStruct(type_id, name, s);
      s->Dump(*this);
      this->EndStruct();
    }
  }

  template <typename S> void WriteStructT(std::string_view name, const std::deque<S> *s)
  {
    static const size_t type_id = this->NewTypeId();
 
    if (s == nullptr) {
      /* No need to dump nullptr struct. */
      this->WriteValue(name, "<null>");
      return;
    }
    if (auto known_as = this->FindKnownAsName(type_id, s); known_as.has_value()) {
      /* We already know this one, no need to dump it. */
      this->WriteValue(name, *known_as);
    } else {
      /* Still unknown, dump it */
      this->BeginStruct(type_id, name, s);
      size_t num_items = s->size();
      this->WriteValue("num_items", num_items);
      for (size_t i = 0; i < num_items; i++) {
        const auto &item = (*s)[i];
        this->WriteStructT(fmt::format("item[{}]", i), &item);
      }
      this->EndStruct();
    }
  }
};
 
#endif /* DBG_HELPERS_H */