Libosmium  2.20.0
Fast and flexible C++ library for working with OpenStreetMap data
map.hpp
Go to the documentation of this file.
1 #ifndef OSMIUM_INDEX_MAP_HPP
2 #define OSMIUM_INDEX_MAP_HPP
3 
4 /*
5 
6 This file is part of Osmium (https://osmcode.org/libosmium).
7 
8 Copyright 2013-2023 Jochen Topf <jochen@topf.org> and others (see README).
9 
10 Boost Software License - Version 1.0 - August 17th, 2003
11 
12 Permission is hereby granted, free of charge, to any person or organization
13 obtaining a copy of the software and accompanying documentation covered by
14 this license (the "Software") to use, reproduce, display, distribute,
15 execute, and transmit the Software, and to prepare derivative works of the
16 Software, and to permit third-parties to whom the Software is furnished to
17 do so, all subject to the following:
18 
19 The copyright notices in the Software and this entire statement, including
20 the above license grant, this restriction and the following disclaimer,
21 must be included in all copies of the Software, in whole or in part, and
22 all derivative works of the Software, unless such copies or derivative
23 works are solely in the form of machine-executable object code generated by
24 a source language processor.
25 
26 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
29 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
30 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
31 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
32 DEALINGS IN THE SOFTWARE.
33 
34 */
35 
37 #include <osmium/util/string.hpp>
38 
39 #include <algorithm>
40 #include <cstddef>
41 #include <functional>
42 #include <map>
43 #include <memory>
44 #include <stdexcept>
45 #include <string>
46 #include <type_traits>
47 #include <vector>
48 
49 namespace osmium {
50 
51  struct OSMIUM_EXPORT map_factory_error : public std::runtime_error {
52 
53  explicit map_factory_error(const char* message) :
54  std::runtime_error(message) {
55  }
56 
57  explicit map_factory_error(const std::string& message) :
58  std::runtime_error(message) {
59  }
60 
61  }; // struct map_factory_error
62 
63  namespace index {
64 
68  namespace map {
69 
96  template <typename TId, typename TValue>
97  class Map {
98 
99  "TId template parameter for class Map must be unsigned integral type");
100 
101  protected:
102 
103  Map(Map&&) noexcept = default;
104  Map& operator=(Map&&) noexcept = default;
105 
106  public:
107 
109  using key_type = TId;
110 
112  using value_type = TValue;
113 
114  Map() noexcept = default;
115 
116  Map(const Map&) = delete;
117  Map& operator=(const Map&) = delete;
118 
119  virtual ~Map() noexcept = default;
120 
121  virtual void reserve(const std::size_t /*size*/) {
122  // default implementation is empty
123  }
124 
126  virtual void set(const TId id, const TValue value) = 0;
127 
135  virtual TValue get(const TId id) const = 0;
136 
146  virtual TValue get_noexcept(const TId id) const noexcept = 0;
147 
154  virtual std::size_t size() const = 0;
155 
163  virtual std::size_t used_memory() const = 0;
164 
169  virtual void clear() = 0;
170 
175  virtual void sort() {
176  // default implementation is empty
177  }
178 
179  // This function can usually be const in derived classes,
180  // but not always. It could, for instance, sort internal data.
181  // This is why it is not declared const here.
182  virtual void dump_as_list(const int /*fd*/) {
183  throw std::runtime_error{"can't dump as list"};
184  }
185 
186  // This function can usually be const in derived classes,
187  // but not always. It could, for instance, sort internal data.
188  // This is why it is not declared const here.
189  virtual void dump_as_array(const int /*fd*/) {
190  throw std::runtime_error{"can't dump as array"};
191  }
192 
193  }; // class Map
194 
195  } // namespace map
196 
197  template <typename TId, typename TValue>
198  class MapFactory {
199 
200  public:
201 
202  using id_type = TId;
203  using value_type = TValue;
205  using create_map_func = std::function<map_type*(const std::vector<std::string>&)>;
206 
207  private:
208 
209  std::map<const std::string, create_map_func> m_callbacks;
210 
211  MapFactory() = default;
212 
213  public:
214 
215  MapFactory(const MapFactory&) = delete;
216  MapFactory& operator=(const MapFactory&) = delete;
217 
218  MapFactory(MapFactory&&) = delete;
220 
221  ~MapFactory() noexcept = default;
222 
224  static MapFactory<id_type, value_type> factory;
225  return factory;
226  }
227 
228  bool register_map(const std::string& map_type_name, create_map_func func) {
229  return m_callbacks.emplace(map_type_name, func).second;
230  }
231 
232  bool has_map_type(const std::string& map_type_name) const {
233  return m_callbacks.count(map_type_name) != 0;
234  }
235 
236  std::vector<std::string> map_types() const {
237  std::vector<std::string> result;
238  result.reserve(m_callbacks.size());
239 
240  for (const auto& cb : m_callbacks) {
241  result.push_back(cb.first);
242  }
243 
244  std::sort(result.begin(), result.end());
245 
246  return result;
247  }
248 
249  std::unique_ptr<map_type> create_map(const std::string& config_string) const {
250  std::vector<std::string> config{osmium::split_string(config_string, ',')};
251 
252  if (config.empty()) {
253  throw map_factory_error{"Need non-empty map type name"};
254  }
255 
256  const auto it = m_callbacks.find(config[0]);
257  if (it != m_callbacks.end()) {
258  return std::unique_ptr<map_type>((it->second)(config));
259  }
260 
261  throw map_factory_error{std::string{"Support for map type '"} + config[0] + "' not compiled into this binary"};
262  }
263 
264  }; // class MapFactory
265 
266  namespace map {
267 
268  template <typename TId, typename TValue, template <typename, typename> class TMap>
269  struct create_map {
270  TMap<TId, TValue>* operator()(const std::vector<std::string>& /*config_string*/) {
271  return new TMap<TId, TValue>();
272  }
273  };
274 
275  } // namespace map
276 
277  template <typename TId, typename TValue, template <typename, typename> class TMap>
278  inline bool register_map(const std::string& name) {
279  return osmium::index::MapFactory<TId, TValue>::instance().register_map(name, [](const std::vector<std::string>& config) {
280  return map::create_map<TId, TValue, TMap>()(config);
281  });
282  }
283 
284 #define OSMIUM_CONCATENATE_DETAIL_(x, y) x##y
285 #define OSMIUM_CONCATENATE_(x, y) OSMIUM_CONCATENATE_DETAIL_(x, y)
286 
287 #define REGISTER_MAP(id, value, klass, name) \
288 namespace osmium { namespace index { namespace detail { \
289  namespace OSMIUM_CONCATENATE_(register_map_, __COUNTER__) { \
290  const bool registered = osmium::index::register_map<id, value, klass>(#name); \
291  inline bool get_registered() noexcept { \
292  return registered; \
293  } } \
294 } } }
295 
296  } // namespace index
297 
298 } // namespace osmium
299 
300 #endif // OSMIUM_INDEX_MAP_HPP
Definition: map.hpp:198
TValue value_type
Definition: map.hpp:203
bool register_map(const std::string &map_type_name, create_map_func func)
Definition: map.hpp:228
~MapFactory() noexcept=default
MapFactory(MapFactory &&)=delete
static MapFactory< id_type, value_type > & instance()
Definition: map.hpp:223
MapFactory & operator=(MapFactory &&)=delete
MapFactory(const MapFactory &)=delete
std::vector< std::string > map_types() const
Definition: map.hpp:236
std::unique_ptr< map_type > create_map(const std::string &config_string) const
Definition: map.hpp:249
TId id_type
Definition: map.hpp:202
std::map< const std::string, create_map_func > m_callbacks
Definition: map.hpp:209
bool has_map_type(const std::string &map_type_name) const
Definition: map.hpp:232
std::function< map_type *(const std::vector< std::string > &)> create_map_func
Definition: map.hpp:205
MapFactory & operator=(const MapFactory &)=delete
Definition: map.hpp:97
virtual TValue get_noexcept(const TId id) const noexcept=0
TId key_type
The "key" type, usually osmium::unsigned_object_id_type.
Definition: map.hpp:109
virtual std::size_t used_memory() const =0
virtual void dump_as_array(const int)
Definition: map.hpp:189
virtual void sort()
Definition: map.hpp:175
TValue value_type
The "value" type, usually a Location or size_t.
Definition: map.hpp:112
virtual TValue get(const TId id) const =0
virtual void clear()=0
virtual void reserve(const std::size_t)
Definition: map.hpp:121
Map(Map &&) noexcept=default
virtual void dump_as_list(const int)
Definition: map.hpp:182
virtual void set(const TId id, const TValue value)=0
Set the field with id to value.
virtual std::size_t size() const =0
#define OSMIUM_EXPORT
Definition: compatibility.hpp:54
bool register_map(const std::string &name)
Definition: map.hpp:278
Namespace for everything in the Osmium library.
Definition: assembler.hpp:53
std::vector< std::string > split_string(const std::string &str, const char sep, bool compact=false)
Definition: string.hpp:50
Definition: location.hpp:555
Definition: map.hpp:269
TMap< TId, TValue > * operator()(const std::vector< std::string > &)
Definition: map.hpp:270
Definition: map.hpp:51
map_factory_error(const std::string &message)
Definition: map.hpp:57
map_factory_error(const char *message)
Definition: map.hpp:53