relations_manager.hpp

Go to the documentation of this file.

#ifndef OSMIUM_RELATIONS_RELATIONS_MANAGER_HPP
#define OSMIUM_RELATIONS_RELATIONS_MANAGER_HPP
 
/*
 
This file is part of Osmium (https://osmcode.org/libosmium).
 
Copyright 2013-2023 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/handler.hpp>
#include <osmium/handler/check_order.hpp>
#include <osmium/memory/buffer.hpp>
#include <osmium/memory/callback_buffer.hpp>
#include <osmium/osm/item_type.hpp>
#include <osmium/osm/relation.hpp>
#include <osmium/osm/tag.hpp>
#include <osmium/osm/way.hpp>
#include <osmium/relations/manager_util.hpp>
#include <osmium/relations/members_database.hpp>
#include <osmium/relations/relations_database.hpp>
#include <osmium/storage/item_stash.hpp>
#include <osmium/tags/taglist.hpp>
#include <osmium/tags/tags_filter.hpp>
 
#include <algorithm>
#include <cassert>
#include <cstddef>
#include <cstdint>
#include <cstring>
#include <stdexcept>
#include <type_traits>
#include <vector>
 
namespace osmium {
 
    namespace relations {
 
        class RelationsManagerBase : public osmium::handler::Handler {
 
            // All relations and members we are interested in will be kept
            // in here.
            osmium::ItemStash m_stash{};
 
            relations::RelationsDatabase m_relations_db;
 
            relations::MembersDatabase<osmium::Node>     m_member_nodes_db;
            relations::MembersDatabase<osmium::Way>      m_member_ways_db;
            relations::MembersDatabase<osmium::Relation> m_member_relations_db;
 
            osmium::memory::CallbackBuffer m_output{};
 
        public:
 
            RelationsManagerBase() :
                m_relations_db(m_stash),
                m_member_nodes_db(m_stash, m_relations_db),
                m_member_ways_db(m_stash, m_relations_db),
                m_member_relations_db(m_stash, m_relations_db) {
            }
 
            osmium::relations::RelationsDatabase& relations_database() noexcept {
                return m_relations_db;
            }
 
            osmium::relations::MembersDatabase<osmium::Node>& member_nodes_database() noexcept {
                return m_member_nodes_db;
            }
 
            const osmium::relations::MembersDatabase<osmium::Node>& member_nodes_database() const noexcept {
                return m_member_nodes_db;
            }
 
            osmium::relations::MembersDatabase<osmium::Way>& member_ways_database() noexcept {
                return m_member_ways_db;
            }
 
            const osmium::relations::MembersDatabase<osmium::Way>& member_ways_database() const noexcept {
                return m_member_ways_db;
            }
 
            osmium::relations::MembersDatabase<osmium::Relation>& member_relations_database() noexcept {
                return m_member_relations_db;
            }
 
            const osmium::relations::MembersDatabase<osmium::Relation>& member_relations_database() const noexcept {
                return m_member_relations_db;
            }
 
            relations::MembersDatabaseCommon& member_database(osmium::item_type type) noexcept {
                switch (type) {
                    case osmium::item_type::node:
                        return m_member_nodes_db;
                    case osmium::item_type::way:
                        return m_member_ways_db;
                    case osmium::item_type::relation:
                        return m_member_relations_db;
                    default:
                        break;
                }
 
                assert(false && "Should not be here");
                return m_member_nodes_db;
            }
 
            const relations::MembersDatabaseCommon& member_database(osmium::item_type type) const noexcept {
                switch (type) {
                    case osmium::item_type::node:
                        return m_member_nodes_db;
                    case osmium::item_type::way:
                        return m_member_ways_db;
                    case osmium::item_type::relation:
                        return m_member_relations_db;
                    default:
                        break;
                }
 
                assert(false && "Should not be here");
                return m_member_nodes_db;
            }
 
            const osmium::OSMObject* get_member_object(const osmium::RelationMember& member) const noexcept {
                if (member.ref() == 0) {
                    return nullptr;
                }
                return member_database(member.type()).get_object(member.ref());
            }
 
            const osmium::Node* get_member_node(osmium::object_id_type id) const noexcept {
                if (id == 0) {
                    return nullptr;
                }
                return member_nodes_database().get(id);
            }
 
            const osmium::Way* get_member_way(osmium::object_id_type id) const noexcept {
                if (id == 0) {
                    return nullptr;
                }
                return member_ways_database().get(id);
            }
 
            const osmium::Relation* get_member_relation(osmium::object_id_type id) const noexcept {
                if (id == 0) {
                    return nullptr;
                }
                return member_relations_database().get(id);
            }
 
            void prepare_for_lookup() {
                m_member_nodes_db.prepare_for_lookup();
                m_member_ways_db.prepare_for_lookup();
                m_member_relations_db.prepare_for_lookup();
            }
 
            relations_manager_memory_usage used_memory() const noexcept {
                return {
                    m_relations_db.used_memory(),
                      m_member_nodes_db.used_memory()
                    + m_member_ways_db.used_memory()
                    + m_member_relations_db.used_memory(),
                    m_stash.used_memory()
                };
            }
 
            osmium::memory::Buffer& buffer() noexcept {
                return m_output.buffer();
            }
 
            void set_callback(const std::function<void(osmium::memory::Buffer&&)>& callback) {
                m_output.set_callback(callback);
            }
 
            void flush_output() {
                m_output.flush();
            }
 
            void possibly_flush() {
                m_output.possibly_flush();
            }
 
            osmium::memory::Buffer read() {
                return m_output.read();
            }
 
        }; // class RelationsManagerBase
 
        template <typename TManager, bool TNodes, bool TWays, bool TRelations, bool TCheckOrder = true>
        class RelationsManager : public RelationsManagerBase {
 
            using check_order_handler = typename std::conditional<TCheckOrder, osmium::handler::CheckOrder, osmium::handler::Handler>::type;
 
            check_order_handler m_check_order_handler;
 
            SecondPassHandler<RelationsManager> m_handler_pass2;
 
            static bool wanted_type(osmium::item_type type) noexcept {
                return (TNodes     && type == osmium::item_type::node) ||
                       (TWays      && type == osmium::item_type::way) ||
                       (TRelations && type == osmium::item_type::relation);
            }
 
            bool new_relation(const osmium::Relation& /*relation*/) const noexcept {
                return true;
            }
 
            bool new_member(const osmium::Relation& /*relation*/, const osmium::RelationMember& /*member*/, std::size_t /*n*/) const noexcept {
                return true;
            }
 
            void complete_relation(const osmium::Relation& /*relation*/) const noexcept {
            }
 
            void before_node(const osmium::Node& /*node*/) const noexcept {
            }
 
            void node_not_in_any_relation(const osmium::Node& /*node*/) const noexcept {
            }
 
            void after_node(const osmium::Node& /*node*/) const noexcept {
            }
 
            void before_way(const osmium::Way& /*way*/) const noexcept {
            }
 
            void way_not_in_any_relation(const osmium::Way& /*way*/) const noexcept {
            }
 
            void after_way(const osmium::Way& /*way*/) const noexcept {
            }
 
            void before_relation(const osmium::Relation& /*relation*/) const noexcept {
            }
 
            void relation_not_in_any_relation(const osmium::Relation& /*relation*/) const noexcept {
            }
 
            void after_relation(const osmium::Relation& /*relation*/) const noexcept {
            }
 
            TManager& derived() noexcept {
                return *static_cast<TManager*>(this);
            }
 
            void handle_complete_relation(RelationHandle& rel_handle) {
                derived().complete_relation(*rel_handle);
                possibly_flush();
 
                for (const auto& member : rel_handle->members()) {
                    if (member.ref() != 0) {
                        member_database(member.type()).remove(member.ref(), rel_handle->id());
                    }
                }
 
                rel_handle.remove();
            }
 
        public:
 
            RelationsManager() :
                RelationsManagerBase(),
                m_check_order_handler(),
                m_handler_pass2(*this) {
            }
 
            SecondPassHandler<RelationsManager>& handler(const std::function<void(osmium::memory::Buffer&&)>& callback = nullptr) {
                set_callback(callback);
                return m_handler_pass2;
            }
 
            void relation(const osmium::Relation& relation) {
                if (derived().new_relation(relation)) {
                    auto rel_handle = relations_database().add(relation);
 
                    std::size_t n = 0;
                    for (auto& member : rel_handle->members()) {
                        if (wanted_type(member.type()) &&
                            derived().new_member(relation, member, n)) {
                            member_database(member.type()).track(rel_handle, member.ref(), n);
                        } else {
                            member.set_ref(0); // set member id to zero to indicate we are not interested
                        }
                        ++n;
                    }
                }
            }
 
            void handle_node(const osmium::Node& node) {
                if (TNodes) {
                    m_check_order_handler.node(node);
                    derived().before_node(node);
                    const bool added = member_nodes_database().add(node, [this](RelationHandle& rel_handle) {
                        handle_complete_relation(rel_handle);
                    });
                    if (!added) {
                        derived().node_not_in_any_relation(node);
                    }
                    derived().after_node(node);
                    possibly_flush();
                }
            }
 
            void handle_way(const osmium::Way& way) {
                if (TWays) {
                    m_check_order_handler.way(way);
                    derived().before_way(way);
                    const bool added = member_ways_database().add(way, [this](RelationHandle& rel_handle) {
                        handle_complete_relation(rel_handle);
                    });
                    if (!added) {
                        derived().way_not_in_any_relation(way);
                    }
                    derived().after_way(way);
                    possibly_flush();
                }
            }
 
            void handle_relation(const osmium::Relation& relation) {
                if (TRelations) {
                    m_check_order_handler.relation(relation);
                    derived().before_relation(relation);
                    const bool added = member_relations_database().add(relation, [this](RelationHandle& rel_handle) {
                        handle_complete_relation(rel_handle);
                    });
                    if (!added) {
                        derived().relation_not_in_any_relation(relation);
                    }
                    derived().after_relation(relation);
                    possibly_flush();
                }
            }
 
            template <typename TFunc>
            void for_each_incomplete_relation(TFunc&& func) {
                relations_database().for_each_relation(std::forward<TFunc>(func));
            }
 
        }; // class RelationsManager
 
    } // namespace relations
 
} // namespace osmium
 
#endif // OSMIUM_RELATIONS_RELATIONS_MANAGER_HPP