enum_for_each.hpp

/*
MIT License
 
Copyright (c) 2024 mguludag
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#ifndef DETAIL_ENUM_FOR_EACH_HPP
#define DETAIL_ENUM_FOR_EACH_HPP
 
#include "meta.hpp"
#include "mgutility/std/fixed_string.hpp"
 
// NOLINTNEXTLINE [unused-includes]
#include <cstdint>
#include <utility>
 
namespace mgutility {
namespace detail {
 
template <typename T>
// NOLINTNEXTLINE [modernize-type-traits]
using string_or_view_t = typename std::conditional<
    has_bit_or<T>::value, mgutility::fixed_string<enum_name_buffer<T>::size>,
    mgutility::string_view>::type;
 
template <typename Enum>
using enum_pair = std::pair<Enum, detail::string_or_view_t<Enum>>;
} // namespace detail
 
template <typename Enum> class enum_for_each {
  using value_type = const detail::enum_pair<Enum>;
  using size_type = std::size_t;
 
  struct enum_iter {
    using const_iter_type = int;
    using iter_type = detail::remove_const_t<const_iter_type>;
    using iterator_category = std::forward_iterator_tag;
    using value_type = const detail::enum_pair<Enum>;
    using difference_type = std::ptrdiff_t;
    using pointer = value_type *;
    using reference = value_type &;
 
    enum_iter() : m_pos{} {}
 
    explicit enum_iter(iter_type value) : m_pos{value} {}
 
    auto operator++() -> enum_iter & {
      ++m_pos;
      return *this;
    }
 
    auto operator++(int) -> enum_iter {
      m_pos++;
      return *this;
    }
 
    auto operator!=(const enum_iter &other) const -> bool {
      return m_pos != other.m_pos;
    }
 
    auto operator==(const enum_iter &other) const -> bool {
      return m_pos == other.m_pos;
    }
 
    auto operator*() const -> value_type;
 
  private:
    iter_type m_pos; 
  };
 
public:
  enum_for_each() = default;
 
  auto begin() -> enum_iter & { return m_begin; }
 
  auto end() -> enum_iter & { return m_end; }
 
  auto size() -> std::size_t {
    return static_cast<int>(enum_range<Enum>::max) -
           static_cast<int>(enum_range<Enum>::min) + 1;
  }
 
private:
  enum_iter m_begin{
      static_cast<int>(enum_range<Enum>::min)}; 
  enum_iter m_end{static_cast<int>(enum_range<Enum>::max) +
                  1}; 
};
} // namespace mgutility
 
#endif // DETAIL_ENUM_FOR_EACH_HPP