check_order.hpp

Go to the documentation of this file.

#ifndef OSMIUM_HANDLER_CHECK_ORDER_HPP
#define OSMIUM_HANDLER_CHECK_ORDER_HPP
 
/*
 
This file is part of Osmium (https://osmcode.org/libosmium).
 
Copyright 2013-2026 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/osm/node.hpp>
#include <osmium/osm/object_comparisons.hpp>
#include <osmium/osm/relation.hpp>
#include <osmium/osm/types.hpp>
#include <osmium/osm/way.hpp>
#include <osmium/util/compatibility.hpp>
 
#include <stdexcept>
#include <string>
 
namespace osmium {

    struct OSMIUM_EXPORT out_of_order_error : public std::runtime_error {
 
        osmium::object_id_type object_id;
 
        explicit out_of_order_error(const std::string& what, osmium::object_id_type id) :
            std::runtime_error(what),
            object_id(id) {
        }
 
        explicit out_of_order_error(const char* what, osmium::object_id_type id) :
            std::runtime_error(what),
            object_id(id) {
        }
 
    }; // struct out_of_order_error
 
    namespace handler {

        class CheckOrder : public osmium::handler::Handler {
 
            osmium::object_id_type m_max_node_id = 0;
            osmium::object_id_type m_max_way_id = 0;
            osmium::object_id_type m_max_relation_id = 0;
            osmium::object_version_type m_last_version = 0;
            bool m_has_node = false;
            bool m_has_way = false;
            bool m_has_relation = false;
            bool m_with_history;
 
        public:
 
            CheckOrder(bool with_history = false) : m_with_history(with_history) {
            }
 
            void node(const osmium::Node& node) {
                if (m_has_way) {
                    throw out_of_order_error{"Found a node after a way.", node.id()};
                }
                if (m_has_relation) {
                    throw out_of_order_error{"Found a node after a relation.", node.id()};
                }
 
                if (m_has_node) {
                    if (m_max_node_id == node.id()) {
                        if (m_with_history) {
                            if (node.version() <= m_last_version) {
                                throw out_of_order_error{"Versions out of order", node.id()};
                            }
                        } else {
                            throw out_of_order_error{"Node ID twice in input. Maybe you are using a history or change file?", node.id()};
                        }
                    }
                    if (id_order{}(node.id(), m_max_node_id)) {
                        throw out_of_order_error{"Node IDs out of order: " + std::to_string(node.id()), node.id()};
                    }
                    m_max_node_id = node.id();
                } else {
                    m_max_node_id = node.id();
                    m_has_node = true;
                }
 
                if (m_with_history) {
                    m_last_version = node.version();
                }
            }
 
            void way(const osmium::Way& way) {
                if (m_has_relation) {
                    throw out_of_order_error{"Found a way after a relation.", way.id()};
                }
 
                if (m_has_way) {
                    if (m_max_way_id == way.id()) {
                        if (m_with_history) {
                            if (way.version() <= m_last_version) {
                                throw out_of_order_error{"Versions out of order", way.id()};
                            }
                        } else {
                            throw out_of_order_error{"Way ID twice in input. Maybe you are using a history or change file?", way.id()};
                        }
                    }
                    if (id_order{}(way.id(), m_max_way_id)) {
                        throw out_of_order_error{"Way IDs out of order: " + std::to_string(way.id()), way.id()};
                    }
                    m_max_way_id = way.id();
                } else {
                    m_max_way_id = way.id();
                    m_has_way = true;
                }
 
                if (m_with_history) {
                    m_last_version = way.version();
                }
            }
 
            void relation(const osmium::Relation& relation) {
                if (m_has_relation) {
                    if (m_max_relation_id == relation.id()) {
                        if (m_with_history) {
                            if (relation.version() <= m_last_version) {
                                throw out_of_order_error{"Versions out of order", relation.id()};
                            }
                        } else {
                            throw out_of_order_error{"Relation ID twice in input. Maybe you are using a history or change file?", relation.id()};
                        }
                    }
                    if (id_order{}(relation.id(), m_max_relation_id)) {
                        throw out_of_order_error{"Relation IDs out of order: " + std::to_string(relation.id()), relation.id()};
                    }
                    m_max_relation_id = relation.id();
                } else {
                    m_max_relation_id = relation.id();
                    m_has_relation = true;
                }
 
                if (m_with_history) {
                    m_last_version = relation.version();
                }
            }
 
            osmium::object_id_type max_node_id() const noexcept {
                return m_max_node_id;
            }
 
            osmium::object_id_type max_way_id() const noexcept {
                return m_max_way_id;
            }
 
            osmium::object_id_type max_relation_id() const noexcept {
                return m_max_relation_id;
            }
 
        }; // class CheckOrder
 
    } // namespace handler
 
} // namespace osmium
 
#endif // OSMIUM_HANDLER_CHECK_ORDER_HPP