map.hpp
Go to the documentation of this file.
#ifndef OSMIUM_INDEX_MAP_HPP
#define OSMIUM_INDEX_MAP_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 <algorithm>
#include <cstddef>
#include <functional>
#include <map>
#include <memory>
#include <stdexcept>
#include <string>
#include <type_traits>
#include <vector>
#include <osmium/util/compatibility.hpp>
#include <osmium/util/string.hpp>
namespace osmium {
namespace index {
namespace map {
template <typename TId, typename TValue>
class Map {
"TId template parameter for class Map must be unsigned integral type");
Map(const Map&) = delete;
Map& operator=(const Map&) = delete;
protected:
Map(Map&&) = default;
Map& operator=(Map&&) = default;
public:
typedef TId key_type;
typedef TValue value_type;
Map() = default;
virtual ~Map() noexcept = default;
virtual void reserve(const size_t) {
// default implementation is empty
}
virtual void set(const TId id, const TValue value) = 0;
virtual const TValue get(const TId id) const = 0;
virtual size_t size() const = 0;
virtual size_t used_memory() const = 0;
virtual void clear() = 0;
virtual void sort() {
// default implementation is empty
}
// This function could usually be const in derived classes,
// but not always. It could, for instance, sort internal data.
// This is why it is not declared const here.
virtual void dump_as_list(const int /*fd*/) {
throw std::runtime_error("can't dump as list");
}
// This function could usually be const in derived classes,
// but not always. It could, for instance, sort internal data.
// This is why it is not declared const here.
virtual void dump_as_array(const int /*fd*/) {
throw std::runtime_error("can't dump as array");
}
}; // class Map
} // namespace map
template <typename TId, typename TValue>
class MapFactory {
public:
typedef TId id_type;
typedef TValue value_type;
typedef osmium::index::map::Map<id_type, value_type> map_type;
typedef std::function<map_type*(const std::vector<std::string>&)> create_map_func;
private:
std::map<const std::string, create_map_func> m_callbacks;
MapFactory() = default;
MapFactory(const MapFactory&) = delete;
MapFactory& operator=(const MapFactory&) = delete;
MapFactory(MapFactory&&) = delete;
MapFactory& operator=(MapFactory&&) = delete;
OSMIUM_NORETURN static void error(const std::string& map_type_name) {
std::string error_message {"Support for map type '"};
error_message += map_type_name;
error_message += "' not compiled into this binary.";
throw std::runtime_error(error_message);
}
public:
static MapFactory<id_type, value_type>& instance() {
static MapFactory<id_type, value_type> factory;
return factory;
}
bool register_map(const std::string& map_type_name, create_map_func func) {
return m_callbacks.emplace(map_type_name, func).second;
}
bool has_map_type(const std::string& map_type_name) const {
return m_callbacks.count(map_type_name);
}
std::vector<std::string> map_types() const {
std::vector<std::string> result;
for (const auto& cb : m_callbacks) {
result.push_back(cb.first);
}
std::sort(result.begin(), result.end());
return result;
}
std::unique_ptr<map_type> create_map(const std::string& config_string) const {
std::vector<std::string> config = osmium::split_string(config_string, ',');
if (config.empty()) {
throw std::runtime_error("Need non-empty map type name.");
}
auto it = m_callbacks.find(config[0]);
if (it != m_callbacks.end()) {
return std::unique_ptr<map_type>((it->second)(config));
}
error(config[0]);
}
}; // class MapFactory
namespace map {
template <typename TId, typename TValue, template<typename, typename> class TMap>
struct create_map {
TMap<TId, TValue>* operator()(const std::vector<std::string>&) {
return new TMap<TId, TValue>();
}
};
} // namespace map
template <typename TId, typename TValue, template<typename, typename> class TMap>
inline bool register_map(const std::string& name) {
return osmium::index::MapFactory<TId, TValue>::instance().register_map(name, [](const std::vector<std::string>& config) {
return map::create_map<TId, TValue, TMap>()(config);
});
}
#define OSMIUM_CONCATENATE_DETAIL_(x, y) x##y
#define OSMIUM_CONCATENATE_(x, y) OSMIUM_CONCATENATE_DETAIL_(x, y)
#define REGISTER_MAP(id, value, klass, name) \
namespace osmium { namespace index { namespace detail { \
const bool OSMIUM_CONCATENATE_(registered_, name) = osmium::index::register_map<id, value, klass>(#name); \
inline bool OSMIUM_CONCATENATE_(get_registered_, name)() noexcept { \
return OSMIUM_CONCATENATE_(registered_, name); \
} \
} } }
} // namespace index
} // namespace osmium
#endif // OSMIUM_INDEX_MAP_HPP
osmium::index::MapFactory::map_type
osmium::index::map::Map< id_type, value_type > map_type
Definition: map.hpp:175
osmium::index::MapFactory::m_callbacks
std::map< const std::string, create_map_func > m_callbacks
Definition: map.hpp:180
OSMIUM_NORETURN
#define OSMIUM_NORETURN
Definition: compatibility.hpp:41
osmium::index::map::Map::size
virtual size_t size() const =0
osmium::index::map::Map::used_memory
virtual size_t used_memory() const =0
osmium::index::map::create_map
Definition: map.hpp:244
osmium::index::MapFactory::register_map
bool register_map(const std::string &map_type_name, create_map_func func)
Definition: map.hpp:204
osmium::index::map::create_map::operator()
TMap< TId, TValue > * operator()(const std::vector< std::string > &)
Definition: map.hpp:245
osmium::index::register_map
bool register_map(const std::string &name)
Definition: map.hpp:253
osmium::index::MapFactory
Definition: map.hpp:169
osmium::index::map::Map::reserve
virtual void reserve(const size_t)
Definition: map.hpp:109
osmium
Namespace for everything in the Osmium library.
Definition: assembler.hpp:59
osmium::index::map::Map::dump_as_array
virtual void dump_as_array(const int)
Definition: map.hpp:160
osmium::index::MapFactory::create_map
std::unique_ptr< map_type > create_map(const std::string &config_string) const
Definition: map.hpp:224
osmium::index::map::Map::key_type
TId key_type
The "key" type, usually osmium::unsigned_object_id_type.
Definition: map.hpp:100
osmium::index::MapFactory::id_type
TId id_type
Definition: map.hpp:173
osmium::index::MapFactory::error
static OSMIUM_NORETURN void error(const std::string &map_type_name)
Definition: map.hpp:190
osmium::index::map::Map::Map
Map()=default
osmium::index::map::Map::dump_as_list
virtual void dump_as_list(const int)
Definition: map.hpp:153
string.hpp
osmium::index::map::Map::sort
virtual void sort()
Definition: map.hpp:146
osmium::index::map::Map::~Map
virtual ~Map() noexcept=default
osmium::index::MapFactory::has_map_type
bool has_map_type(const std::string &map_type_name) const
Definition: map.hpp:208
osmium::index::MapFactory::instance
static MapFactory< id_type, value_type > & instance()
Definition: map.hpp:199
osmium::index::map::Map::operator=
Map & operator=(const Map &)=delete
osmium::index::map::Map::value_type
TValue value_type
The "value" type, usually a Location or size_t.
Definition: map.hpp:103
osmium::index::MapFactory::map_types
std::vector< std::string > map_types() const
Definition: map.hpp:212
osmium::index::map::Map::clear
virtual void clear()=0
osmium::index::MapFactory::value_type
TValue value_type
Definition: map.hpp:174
osmium::split_string
std::vector< std::string > split_string(const std::string &str, const char sep, bool compact=false)
Definition: string.hpp:50
osmium::index::map::Map
Definition: map.hpp:85
compatibility.hpp
osmium::index::MapFactory::create_map_func
std::function< map_type *(const std::vector< std::string > &)> create_map_func
Definition: map.hpp:176