Loading...
Searching...
No Matches
collection.hpp
Go to the documentation of this file.
#ifndef OSMIUM_MEMORY_COLLECTION_HPP
#define OSMIUM_MEMORY_COLLECTION_HPP
/*
This file is part of Osmium (https://osmcode.org/libosmium).
Copyright 2013-2025 Jochen Topf <jochen@topf.org> and others (see README).
Boost Software License - Version 1.0 - August 17th, 2003
Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:
The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.
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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
#include <osmium/memory/item.hpp>
#include <iosfwd>
#include <iterator>
#include <type_traits>
namespace osmium {
namespace memory {
template <typename TMember>
class CollectionIterator {
// This data_type is either 'unsigned char*' or 'const unsigned
// char*' depending on whether TMember is const. This allows this
// class to be used as an iterator and as a const_iterator.
using data_type = std::conditional_t<std::is_const<TMember>::value, const unsigned char*, unsigned char*>;
data_type m_data;
public:
using iterator_category = std::forward_iterator_tag;
using value_type = TMember;
using difference_type = std::ptrdiff_t;
using pointer = value_type*;
using reference = value_type&;
CollectionIterator() noexcept :
m_data(nullptr) {
}
explicit CollectionIterator(data_type data) noexcept :
m_data(data) {
}
CollectionIterator<TMember>& operator++() {
m_data = reinterpret_cast<TMember*>(m_data)->next();
return *static_cast<CollectionIterator<TMember>*>(this);
}
CollectionIterator<TMember> operator++(int) {
CollectionIterator<TMember> tmp{*this};
operator++();
return tmp;
}
bool operator==(const CollectionIterator<TMember>& rhs) const noexcept {
return m_data == rhs.m_data;
}
bool operator!=(const CollectionIterator<TMember>& rhs) const noexcept {
return !(*this == rhs);
}
unsigned char* data() const noexcept {
return m_data;
}
TMember& operator*() const noexcept {
return *reinterpret_cast<TMember*>(m_data);
}
TMember* operator->() const noexcept {
return reinterpret_cast<TMember*>(m_data);
}
template <typename TChar, typename TTraits>
void print(std::basic_ostream<TChar, TTraits>& out) const {
out << static_cast<const void*>(m_data);
}
}; // class CollectionIterator
template <typename TChar, typename TTraits, typename TMember>
inline std::basic_ostream<TChar, TTraits>& operator<<(std::basic_ostream<TChar, TTraits>& out, const CollectionIterator<TMember>& iter) {
iter.print(out);
return out;
}
template <typename TFilter, typename TMember>
class CollectionFilterIterator {
TFilter m_filter;
CollectionIterator<TMember> m_it;
CollectionIterator<TMember> m_end;
void advance() {
while (m_it != m_end) {
if (m_filter(*m_it)) {
break;
}
++m_it;
}
}
public:
using iterator_category = std::forward_iterator_tag;
using value_type = const TMember;
using difference_type = std::ptrdiff_t;
using pointer = value_type*;
using reference = value_type&;
CollectionFilterIterator(TFilter filter, CollectionIterator<TMember> begin, CollectionIterator<TMember> end) :
m_filter(std::move(filter)),
m_it(begin),
m_end(end) {
advance();
}
CollectionFilterIterator& operator++() {
assert(m_it != m_end);
++m_it;
advance();
return *this;
}
CollectionFilterIterator operator++(int) const {
CollectionFilterIterator tmp{*this};
operator++();
return tmp;
}
bool operator==(const CollectionFilterIterator& rhs) const noexcept {
return m_it == rhs.m_it && m_end == rhs.m_end;
}
bool operator!=(const CollectionFilterIterator& rhs) const noexcept {
return !(*this == rhs);
}
reference operator*() const noexcept {
assert(m_it != m_end);
return *m_it;
}
pointer operator->() const noexcept {
assert(m_it != m_end);
return &*m_it;
}
}; // class CollectionFilterIterator
template <typename TMember, osmium::item_type TCollectionItemType>
class Collection : public Item {
public:
using value_type = TMember;
using reference = TMember&;
using const_reference = const TMember&;
using iterator = CollectionIterator<TMember>;
using const_iterator = CollectionIterator<const TMember>;
using size_type = std::size_t;
static constexpr osmium::item_type itemtype = TCollectionItemType;
constexpr static bool is_compatible_to(const osmium::item_type t) noexcept {
return t == itemtype;
}
Collection() noexcept :
Item(sizeof(Collection<TMember, TCollectionItemType>), TCollectionItemType) {
}
bool empty() const noexcept {
return sizeof(Collection<TMember, TCollectionItemType>) == byte_size();
}
size_type size() const noexcept {
return static_cast<size_type>(std::distance(begin(), end()));
}
iterator begin() noexcept {
return iterator{data() + sizeof(Collection<TMember, TCollectionItemType>)};
}
iterator end() noexcept {
return iterator{data() + byte_size()};
}
const_iterator cbegin() const noexcept {
return const_iterator{data() + sizeof(Collection<TMember, TCollectionItemType>)};
}
const_iterator cend() const noexcept {
return const_iterator{data() + byte_size()};
}
const_iterator begin() const noexcept {
return cbegin();
}
const_iterator end() const noexcept {
return cend();
}
}; // class Collection
} // namespace memory
} // namespace osmium
#endif // OSMIUM_MEMORY_COLLECTION_HPP
osmium::memory::CollectionFilterIterator
Definition collection.hpp:117
osmium::memory::CollectionFilterIterator::iterator_category
std::forward_iterator_tag iterator_category
Definition collection.hpp:134
osmium::memory::CollectionFilterIterator::operator==
bool operator==(const CollectionFilterIterator &rhs) const noexcept
Definition collection.hpp:160
osmium::memory::CollectionFilterIterator::operator->
pointer operator->() const noexcept
Definition collection.hpp:173
osmium::memory::CollectionFilterIterator::value_type
const TMember value_type
Definition collection.hpp:135
osmium::memory::CollectionFilterIterator::CollectionFilterIterator
CollectionFilterIterator(TFilter filter, CollectionIterator< TMember > begin, CollectionIterator< TMember > end)
Definition collection.hpp:140
osmium::memory::CollectionFilterIterator::m_it
CollectionIterator< TMember > m_it
Definition collection.hpp:120
osmium::memory::CollectionFilterIterator::operator!=
bool operator!=(const CollectionFilterIterator &rhs) const noexcept
Definition collection.hpp:164
osmium::memory::CollectionFilterIterator::pointer
value_type * pointer
Definition collection.hpp:137
osmium::memory::CollectionFilterIterator::operator++
CollectionFilterIterator operator++(int) const
Definition collection.hpp:154
osmium::memory::CollectionFilterIterator::operator*
reference operator*() const noexcept
Definition collection.hpp:168
osmium::memory::CollectionFilterIterator::m_filter
TFilter m_filter
Definition collection.hpp:119
osmium::memory::CollectionFilterIterator::reference
value_type & reference
Definition collection.hpp:138
osmium::memory::CollectionFilterIterator::m_end
CollectionIterator< TMember > m_end
Definition collection.hpp:121
osmium::memory::CollectionFilterIterator::operator++
CollectionFilterIterator & operator++()
Definition collection.hpp:147
osmium::memory::CollectionFilterIterator::difference_type
std::ptrdiff_t difference_type
Definition collection.hpp:136
osmium::memory::CollectionFilterIterator::advance
void advance()
Definition collection.hpp:123
osmium::memory::CollectionIterator
Definition collection.hpp:47
osmium::memory::CollectionIterator::operator==
bool operator==(const CollectionIterator< TMember > &rhs) const noexcept
Definition collection.hpp:83
osmium::memory::CollectionIterator::CollectionIterator
CollectionIterator(data_type data) noexcept
Definition collection.hpp:68
osmium::memory::CollectionIterator::data_type
std::conditional_t< std::is_const< TMember >::value, const unsigned char *, unsigned char * > data_type
Definition collection.hpp:52
osmium::memory::CollectionIterator::reference
value_type & reference
Definition collection.hpp:62
osmium::memory::CollectionIterator::operator*
TMember & operator*() const noexcept
Definition collection.hpp:95
osmium::memory::CollectionIterator::data
unsigned char * data() const noexcept
Definition collection.hpp:91
osmium::memory::CollectionIterator::iterator_category
std::forward_iterator_tag iterator_category
Definition collection.hpp:58
osmium::memory::CollectionIterator::m_data
data_type m_data
Definition collection.hpp:54
osmium::memory::CollectionIterator::pointer
value_type * pointer
Definition collection.hpp:61
osmium::memory::CollectionIterator::operator++
CollectionIterator< TMember > & operator++()
Definition collection.hpp:72
osmium::memory::CollectionIterator::print
void print(std::basic_ostream< TChar, TTraits > &out) const
Definition collection.hpp:104
osmium::memory::CollectionIterator::CollectionIterator
CollectionIterator() noexcept
Definition collection.hpp:64
osmium::memory::CollectionIterator::operator->
TMember * operator->() const noexcept
Definition collection.hpp:99
osmium::memory::CollectionIterator::value_type
TMember value_type
Definition collection.hpp:59
osmium::memory::CollectionIterator::operator!=
bool operator!=(const CollectionIterator< TMember > &rhs) const noexcept
Definition collection.hpp:87
osmium::memory::CollectionIterator::operator++
CollectionIterator< TMember > operator++(int)
Definition collection.hpp:77
osmium::memory::CollectionIterator::difference_type
std::ptrdiff_t difference_type
Definition collection.hpp:60
osmium::memory::Collection
Definition collection.hpp:181
osmium::memory::Collection::empty
bool empty() const noexcept
Definition collection.hpp:207
osmium::memory::Collection::reference
TMember & reference
Definition collection.hpp:186
osmium::memory::Collection::size_type
std::size_t size_type
Definition collection.hpp:190
osmium::memory::Collection::end
const_iterator end() const noexcept
Definition collection.hpp:240
osmium::memory::Collection::is_compatible_to
static constexpr bool is_compatible_to(const osmium::item_type t) noexcept
Definition collection.hpp:194
osmium::memory::Collection::itemtype
static constexpr osmium::item_type itemtype
Definition collection.hpp:192
osmium::memory::Collection::value_type
TMember value_type
Definition collection.hpp:185
osmium::memory::Collection::begin
const_iterator begin() const noexcept
Definition collection.hpp:236
osmium::memory::Collection::end
iterator end() noexcept
Definition collection.hpp:224
osmium::memory::Collection::size
size_type size() const noexcept
Definition collection.hpp:216
osmium::memory::Collection::cend
const_iterator cend() const noexcept
Definition collection.hpp:232
osmium::memory::Collection::cbegin
const_iterator cbegin() const noexcept
Definition collection.hpp:228
osmium::memory::Collection::begin
iterator begin() noexcept
Definition collection.hpp:220
osmium::memory::Collection::Collection
Collection() noexcept
Definition collection.hpp:198
osmium::memory::Collection::const_reference
const TMember & const_reference
Definition collection.hpp:187
osmium::memory::Item
Definition item.hpp:105
osmium::memory::Item::byte_size
item_size_type byte_size() const noexcept
Definition item.hpp:163
item.hpp
osmium::memory::operator<<
std::basic_ostream< TChar, TTraits > & operator<<(std::basic_ostream< TChar, TTraits > &out, const CollectionIterator< TMember > &iter)
Definition collection.hpp:111
osmium
Namespace for everything in the Osmium library.
Definition assembler.hpp:53
osmium::item_type
item_type
Definition item_type.hpp:45
std
Definition location.hpp:555