Loading...
Searching...
No Matches
filter.hpp
Go to the documentation of this file.
#ifndef OSMIUM_TAGS_FILTER_HPP
#define OSMIUM_TAGS_FILTER_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/memory/collection.hpp>
#include <osmium/osm/tag.hpp>
#include <cstddef>
#include <cstring>
#include <string>
#include <type_traits>
#include <vector>
namespace osmium {
namespace tags {
template <typename TKey>
struct match_key {
bool operator()(const TKey& rule_key, const char* tag_key) const {
return rule_key == tag_key;
}
}; // struct match_key
template <>
struct match_key<std::string> {
bool operator()(const std::string& rule_key, const char* tag_key) const {
return !std::strcmp(rule_key.c_str(), tag_key);
}
}; // struct match_key
struct match_key_prefix {
bool operator()(const std::string& rule_key, const char* tag_key) const {
return rule_key.compare(0, std::string::npos, tag_key, 0, rule_key.size()) == 0;
}
}; // struct match_key_prefix
template <typename TValue>
struct match_value {
bool operator()(const TValue& rule_value, const char* tag_value) const {
return rule_value == tag_value;
}
}; // struct match_value
template <>
struct match_value<std::string> {
bool operator()(const std::string& rule_value, const char* tag_value) const {
return !std::strcmp(rule_value.c_str(), tag_value);
}
}; // struct match_value
template <>
struct match_value<void> {
bool operator()(const bool /*rule_value*/, const char* /*tag_value*/) const noexcept {
return true;
}
}; // struct match_value<void>
template <typename TKey, typename TValue = void, typename TKeyComp = match_key<TKey>, typename TValueComp = match_value<TValue>>
class Filter {
using key_type = TKey;
using value_type = std::conditional_t<std::is_void<TValue>::value, bool, TValue>;
struct Rule {
key_type key;
value_type value;
bool ignore_value;
bool result;
explicit Rule(bool r, bool ignore, key_type k, value_type v) :
key(std::move(k)),
value(std::move(v)),
ignore_value(ignore),
result(r) {
}
explicit Rule(bool r, bool ignore, key_type k) :
key(std::move(k)),
value(),
ignore_value(ignore),
result(r) {
}
}; // struct Rule
std::vector<Rule> m_rules;
bool m_default_result;
public:
using filter_type = Filter<TKey, TValue, TKeyComp, TValueComp>;
using argument_type = const osmium::Tag&;
using result_type = bool;
using iterator = osmium::memory::CollectionFilterIterator<filter_type, const osmium::Tag>;
explicit Filter(bool default_result = false) :
m_default_result(default_result) {
}
template <typename V = TValue, typename std::enable_if_t<!std::is_void<V>::value, int> = 0>
Filter& add(bool result, const key_type& key, const value_type& value) {
m_rules.emplace_back(result, false, key, value);
return *this;
}
Filter& add(bool result, const key_type& key) {
m_rules.emplace_back(result, true, key);
return *this;
}
bool operator()(const osmium::Tag& tag) const {
for (const Rule& rule : m_rules) {
if (TKeyComp()(rule.key, tag.key()) && (rule.ignore_value || TValueComp()(rule.value, tag.value()))) {
return rule.result;
}
}
return m_default_result;
}
size_t count() const noexcept {
return m_rules.size();
}
bool empty() const noexcept {
return m_rules.empty();
}
}; // class Filter
using KeyValueFilter = Filter<std::string, std::string>;
using KeyFilter = Filter<std::string>;
using KeyPrefixFilter = Filter<std::string, void, match_key_prefix>;
} // namespace tags
} // namespace osmium
#endif // OSMIUM_TAGS_FILTER_HPP
osmium::Tag
Definition tag.hpp:48
osmium::Tag::key
const char * key() const noexcept
Definition tag.hpp:86
osmium::Tag::value
const char * value() const noexcept
Definition tag.hpp:95
osmium::memory::CollectionFilterIterator
Definition collection.hpp:118
osmium::tags::Filter
Definition filter.hpp:92
osmium::tags::Filter< TKey, TValue, TKeyComp, TValueComp >::iterator
osmium::memory::CollectionFilterIterator< filter_type, const osmium::Tag > iterator
Definition filter.hpp:127
osmium::tags::Filter::Filter
Filter(bool default_result=false)
Definition filter.hpp:129
osmium::tags::Filter< TKey, TValue, TKeyComp, TValueComp >::m_default_result
bool m_default_result
Definition filter.hpp:120
osmium::tags::Filter::value_type
std::conditional_t< std::is_void< TValue >::value, bool, TValue > value_type
Definition filter.hpp:95
osmium::tags::Filter::empty
bool empty() const noexcept
Definition filter.hpp:167
osmium::tags::Filter< TKey, TValue, TKeyComp, TValueComp >::m_rules
std::vector< Rule > m_rules
Definition filter.hpp:119
osmium::tags::Filter::operator()
bool operator()(const osmium::Tag &tag) const
Definition filter.hpp:144
osmium::tags::Filter::filter_type
Filter< TKey, TValue, TKeyComp, TValueComp > filter_type
Definition filter.hpp:124
osmium::tags::Filter< TKey, TValue, TKeyComp, TValueComp >::result_type
bool result_type
Definition filter.hpp:126
osmium::tags::Filter::count
size_t count() const noexcept
Definition filter.hpp:158
osmium::tags::Filter::add
Filter & add(bool result, const key_type &key)
Definition filter.hpp:139
osmium::tags::Filter::add
Filter & add(bool result, const key_type &key, const value_type &value)
Definition filter.hpp:134
osmium::tags::Filter::key_type
TKey key_type
Definition filter.hpp:94
osmium::tags::Filter< TKey, TValue, TKeyComp, TValueComp >::argument_type
const osmium::Tag & argument_type
Definition filter.hpp:125
collection.hpp
osmium::tags
Code related to working with OSM tags.
Definition filter.hpp:47
osmium::tags::KeyFilter
Filter< std::string > KeyFilter
Definition filter.hpp:177
osmium::tags::KeyPrefixFilter
Filter< std::string, void, match_key_prefix > KeyPrefixFilter
Definition filter.hpp:180
osmium::tags::KeyValueFilter
Filter< std::string, std::string > KeyValueFilter
Definition filter.hpp:174
osmium
Namespace for everything in the Osmium library.
Definition assembler.hpp:53
std
Definition location.hpp:654
osmium::tags::Filter::Rule::key
key_type key
Definition filter.hpp:98
osmium::tags::Filter::Rule::value
value_type value
Definition filter.hpp:99
osmium::tags::Filter::Rule::Rule
Rule(bool r, bool ignore, key_type k, value_type v)
Definition filter.hpp:103
osmium::tags::Filter::Rule::ignore_value
bool ignore_value
Definition filter.hpp:100
osmium::tags::Filter::Rule::result
bool result
Definition filter.hpp:101
osmium::tags::Filter::Rule::Rule
Rule(bool r, bool ignore, key_type k)
Definition filter.hpp:110
osmium::tags::match_key< std::string >::operator()
bool operator()(const std::string &rule_key, const char *tag_key) const
Definition filter.hpp:58
osmium::tags::match_key_prefix
Definition filter.hpp:63
osmium::tags::match_key_prefix::operator()
bool operator()(const std::string &rule_key, const char *tag_key) const
Definition filter.hpp:64
osmium::tags::match_key
Definition filter.hpp:50
osmium::tags::match_key::operator()
bool operator()(const TKey &rule_key, const char *tag_key) const
Definition filter.hpp:51
osmium::tags::match_value< std::string >::operator()
bool operator()(const std::string &rule_value, const char *tag_value) const
Definition filter.hpp:78
osmium::tags::match_value< void >::operator()
bool operator()(const bool, const char *) const noexcept
Definition filter.hpp:85
osmium::tags::match_value
Definition filter.hpp:70
osmium::tags::match_value::operator()
bool operator()(const TValue &rule_value, const char *tag_value) const
Definition filter.hpp:71
tag.hpp