iterator_adapters.h

Go to the documentation of this file.

// === iterator_adapters.h =============================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_CORE_BASE_ITERATOR_ADAPTERS_H
#define SEN_CORE_BASE_ITERATOR_ADAPTERS_H
 
// std
#include <cstddef>
#include <iterator>
 
namespace sen::util
{
 
//===--------------------------------------------------------------------------------------------------------------===//
// Base Definitions
//===--------------------------------------------------------------------------------------------------------------===//

template <typename IteratorType>
struct IteratorRange
{
  IteratorRange(IteratorType begin, IteratorType end): begin_(std::move(begin)), end_(std::move(end)) {}
 
  [[nodiscard]] IteratorType begin() const { return begin_; }
  [[nodiscard]] IteratorType end() const { return end_; }
  [[nodiscard]] bool empty() const { return begin_ == end_; }
 
private:
  IteratorType begin_;
  IteratorType end_;
};

template <typename IteratorType>
IteratorRange<IteratorType> makeRange(IteratorType begin, IteratorType end)
{
  return {std::move(begin), std::move(end)};
}

template <typename ContainerType>
auto makeRange(ContainerType& container)
{
  return makeRange(std::begin(container), std::end(container));
}
 
//===--------------------------------------------------------------------------------------------------------------===//
// Range Adapters
//===--------------------------------------------------------------------------------------------------------------===//

template <template <typename> typename LockType, typename IteratorType, typename MutexType>
class LockedRangeAdapter
{
public:
  template <typename ContainerType>
  LockedRangeAdapter(ContainerType& container, MutexType& m)
    : lock_(m), beginIterator_(std::begin(container)), endIterator_(std::end(container))
  {
  }
 
  LockedRangeAdapter(IteratorType begin, IteratorType end, MutexType& m)
    : lock_(m), beginIterator_(begin), endIterator_(end)
  {
  }
 
  [[nodiscard]] IteratorType begin() const noexcept(std::is_nothrow_copy_constructible_v<IteratorType>)
  {
    return beginIterator_;
  }
  [[nodiscard]] IteratorType end() const noexcept(std::is_nothrow_copy_constructible_v<IteratorType>)
  {
    return endIterator_;
  }
 
private:
  LockType<MutexType> lock_;
  IteratorType beginIterator_;
  IteratorType endIterator_;
};

template <template <typename> typename LockType, typename IteratorType, typename MutexType>
auto makeLockedRange(IteratorType begin, IteratorType end, MutexType& m)
{
  return LockedRangeAdapter<LockType, IteratorType, MutexType>(begin, end, m);
}

template <template <typename> typename LockType, typename ContainerType, typename MutexType>
auto makeLockedRange(ContainerType& container, MutexType& m)
{
  if constexpr (std::is_const_v<ContainerType>)
  {
    return LockedRangeAdapter<LockType, typename ContainerType::const_iterator, MutexType>(container, m);
  }
  else
  {
    return LockedRangeAdapter<LockType, typename ContainerType::iterator, MutexType>(container, m);
  }
}
 
//===--------------------------------------------------------------------------------------------------------------===//
// Iterator Adapters
//===--------------------------------------------------------------------------------------------------------------===//

template <typename IteratorType>
struct SmartPtrIteratorAdapter
{
  explicit SmartPtrIteratorAdapter(IteratorType iter): iter_(iter) {}
 
  // NOLINTBEGIN(readability-identifier-naming): iterator tags
  using iterator_category = typename IteratorType::iterator_category;
  using difference_type = std::ptrdiff_t;
  using value_type = typename IteratorType::value_type::element_type;
  using pointer = value_type*;
  using reference = value_type&;
  // NOLINTEND(readability-identifier-naming)
 
  pointer operator*() const { return iter_->get(); }
  reference operator->() const { return operator*(); }
 
  SmartPtrIteratorAdapter& operator++()
  {
    ++iter_;
    return *this;
  }
  SmartPtrIteratorAdapter operator++(int)
  {
    auto old = *this;
    operator++();
    return old;
  }
 
  friend bool operator==(const SmartPtrIteratorAdapter& lhs, const SmartPtrIteratorAdapter& rhs)
  {
    return lhs.iter_ == rhs.iter_;
  }
  friend bool operator!=(const SmartPtrIteratorAdapter& lhs, const SmartPtrIteratorAdapter& rhs)
  {
    return !(lhs == rhs);
  }
 
private:
  IteratorType iter_;
};
 
}  // namespace sen::util
 
#endif  // SEN_CORE_BASE_ITERATOR_ADAPTERS_H