osrm-backend/include/osmium/memory/item_iterator.hpp

#ifndef OSMIUM_ITEM_ITERATOR_HPP
#define OSMIUM_ITEM_ITERATOR_HPP

/*

This file is part of Osmium (http://osmcode.org/libosmium).

Copyright 2013-2016 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 <cassert>
#include <cstddef>
#include <iterator>
#include <iosfwd>
#include <type_traits>

#include <osmium/memory/item.hpp>
#include <osmium/osm/item_type.hpp>

namespace osmium {

    class Area;
    class Changeset;
    class InnerRing;
    class Node;
    class OSMEntity;
    class OSMObject;
    class OuterRing;
    class Relation;
    class RelationMemberList;
    class TagList;
    class Way;
    class WayNodeList;

    namespace memory {

        namespace detail {

            template <typename T>
            inline bool type_is_compatible(osmium::item_type) noexcept {
                return true;
            }

            template <>
            inline bool type_is_compatible<osmium::Node>(osmium::item_type t) noexcept {
                return t == osmium::item_type::node;
            }

            template <>
            inline bool type_is_compatible<osmium::Way>(osmium::item_type t) noexcept {
                return t == osmium::item_type::way;
            }

            template <>
            inline bool type_is_compatible<osmium::Relation>(osmium::item_type t) noexcept {
                return t == osmium::item_type::relation;
            }

            template <>
            inline bool type_is_compatible<osmium::Area>(osmium::item_type t) noexcept {
                return t == osmium::item_type::area;
            }

            template <>
            inline bool type_is_compatible<osmium::Changeset>(osmium::item_type t) noexcept {
                return t == osmium::item_type::changeset;
            }

            template <>
            inline bool type_is_compatible<osmium::OSMObject>(osmium::item_type t) noexcept {
                return t == osmium::item_type::node || t == osmium::item_type::way || t == osmium::item_type::relation || t == osmium::item_type::area;
            }

            template <>
            inline bool type_is_compatible<osmium::OSMEntity>(osmium::item_type t) noexcept {
                return t == osmium::item_type::node || t == osmium::item_type::way || t == osmium::item_type::relation || t == osmium::item_type::area || t == osmium::item_type::changeset;
            }

            template <>
            inline bool type_is_compatible<osmium::TagList>(osmium::item_type t) noexcept {
                return t == osmium::item_type::tag_list;
            }

            template <>
            inline bool type_is_compatible<osmium::WayNodeList>(osmium::item_type t) noexcept {
                return t == osmium::item_type::way_node_list;
            }

            template <>
            inline bool type_is_compatible<osmium::RelationMemberList>(osmium::item_type t) noexcept {
                return t == osmium::item_type::relation_member_list || t == osmium::item_type::relation_member_list_with_full_members;
            }

            template <>
            inline bool type_is_compatible<osmium::OuterRing>(osmium::item_type t) noexcept {
                return t == osmium::item_type::outer_ring;
            }

            template <>
            inline bool type_is_compatible<osmium::InnerRing>(osmium::item_type t) noexcept {
                return t == osmium::item_type::inner_ring;
            }

        } // namespace detail

        template <typename TMember>
        class ItemIterator {

            static_assert(std::is_base_of<osmium::memory::Item, TMember>::value, "TMember must derive from osmium::memory::Item");

            // 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 = typename std::conditional<std::is_const<TMember>::value, const unsigned char*, unsigned char*>::type;

            data_type m_data;
            data_type m_end;

            void advance_to_next_item_of_right_type() noexcept {
                while (m_data != m_end &&
                       !detail::type_is_compatible<typename std::remove_const<TMember>::type>(reinterpret_cast<const osmium::memory::Item*>(m_data)->type())) {
                    m_data = reinterpret_cast<TMember*>(m_data)->next();
                }
            }

        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&;

            ItemIterator() noexcept :
                m_data(nullptr),
                m_end(nullptr) {
            }

            ItemIterator(data_type data, data_type end) noexcept :
                m_data(data),
                m_end(end) {
                advance_to_next_item_of_right_type();
            }

            template <typename T>
            ItemIterator<T> cast() const noexcept {
                return ItemIterator<T>(m_data, m_end);
            }

            ItemIterator<TMember>& operator++() noexcept {
                assert(m_data);
                assert(m_data != m_end);
                m_data = reinterpret_cast<TMember*>(m_data)->next();
                advance_to_next_item_of_right_type();
                return *static_cast<ItemIterator<TMember>*>(this);
            }

            /**
             * Like operator++() but will NOT skip items of unwanted
             * types. Do not use this unless you know what you are
             * doing.
             */
            ItemIterator<TMember>& advance_once() noexcept {
                assert(m_data);
                assert(m_data != m_end);
                m_data = reinterpret_cast<TMember*>(m_data)->next();
                return *static_cast<ItemIterator<TMember>*>(this);
            }

            ItemIterator<TMember> operator++(int) noexcept {
                ItemIterator<TMember> tmp(*this);
                operator++();
                return tmp;
            }

            bool operator==(const ItemIterator<TMember>& rhs) const noexcept {
                return m_data == rhs.m_data && m_end == rhs.m_end;
            }

            bool operator!=(const ItemIterator<TMember>& rhs) const noexcept {
                return !(*this == rhs);
            }

            data_type data() noexcept {
                assert(m_data);
                return m_data;
            }

            const unsigned char* data() const noexcept {
                assert(m_data);
                return m_data;
            }

            TMember& operator*() const noexcept {
                assert(m_data);
                assert(m_data != m_end);
                return *reinterpret_cast<TMember*>(m_data);
            }

            TMember* operator->() const noexcept {
                assert(m_data);
                assert(m_data != m_end);
                return reinterpret_cast<TMember*>(m_data);
            }

            explicit operator bool() const noexcept {
                return (m_data != nullptr) && (m_data != m_end);
            }

            template <typename TChar, typename TTraits>
            void print(std::basic_ostream<TChar, TTraits>& out) const {
                out << static_cast<const void*>(m_data);
            }

        }; // class ItemIterator

        template <typename TChar, typename TTraits, typename TMember>
        inline std::basic_ostream<TChar, TTraits>& operator<<(std::basic_ostream<TChar, TTraits>& out, const ItemIterator<TMember>& iter) {
            iter.print(out);
            return out;
        }

        template <typename T>
        class ItemIteratorRange {

            static_assert(std::is_base_of<osmium::memory::Item, T>::value, "Template parameter must derive from osmium::memory::Item");

            // This data_type is either 'unsigned char*' or
            // 'const unsigned char*' depending on whether T is const.
            using data_type = typename std::conditional<std::is_const<T>::value, const unsigned char*, unsigned char*>::type;

            data_type m_begin;
            data_type m_end;

        public:

            using iterator = ItemIterator<T>;
            using const_iterator = ItemIterator<const T>;

            ItemIteratorRange(data_type first, data_type last) noexcept :
                m_begin(first),
                m_end(last) {
            }

            iterator begin() noexcept {
                return iterator{m_begin, m_end};
            }

            iterator end() noexcept {
                return iterator{m_end, m_end};
            }

            const_iterator cbegin() const noexcept {
                return const_iterator{m_begin, m_end};
            }

            const_iterator cend() const noexcept {
                return const_iterator{m_end, m_end};
            }

            const_iterator begin() const noexcept {
                return cbegin();
            }

            const_iterator end() const noexcept {
                return cend();
            }

            /**
             * Return the number of items in this range.
             *
             * Note that this methods has worst-case complexity O(n) with n
             * being the number of items in the underlying range.
             */
            size_t size() const {
                if (m_begin == m_end) {
                    return 0;
                }
                return std::distance(cbegin(), cend());
            }

            /**
             * Is this range empty?
             *
             * Note that this methods has worst-case complexity O(n) with n
             * being the number of items in the underlying range.
             */
            bool empty() const {
                return size() == 0;
            }

        }; // class ItemIteratorRange

    } // namespace memory

} // namespace osmium

#endif // OSMIUM_ITEM_ITERATOR_HPP