Libosmium  2.13.1
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 (http://osmcode.org/libosmium).
7 
8 Copyright 2013-2017 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 
36 #include <algorithm>
37 #include <cstddef>
38 #include <functional>
39 #include <map>
40 #include <memory>
41 #include <stdexcept>
42 #include <string>
43 #include <type_traits>
44 #include <vector>
45 
46 #include <osmium/util/string.hpp>
47 
48 namespace osmium {
49 
50  struct map_factory_error : public std::runtime_error {
51 
52  explicit map_factory_error(const char* message) :
53  std::runtime_error(message) {
54  }
55 
56  explicit map_factory_error(const std::string& message) :
57  std::runtime_error(message) {
58  }
59 
60  }; // struct map_factory_error
61 
62  namespace index {
63 
67  namespace map {
68 
95  template <typename TId, typename TValue>
96  class Map {
97 
98  "TId template parameter for class Map must be unsigned integral type");
99 
100  Map(const Map&) = delete;
101  Map& operator=(const Map&) = delete;
102 
103  protected:
104 
105  Map(Map&&) = default;
106  Map& operator=(Map&&) = default;
107 
108  public:
109 
111  using key_type = TId;
112 
114  using value_type = TValue;
115 
116  Map() = default;
117 
118  virtual ~Map() noexcept = default;
119 
120  virtual void reserve(const size_t) {
121  // default implementation is empty
122  }
123 
125  virtual void set(const TId id, const TValue value) = 0;
126 
134  virtual TValue get(const TId id) const = 0;
135 
145  virtual TValue get_noexcept(const TId id) const noexcept = 0;
146 
153  virtual size_t size() const = 0;
154 
162  virtual size_t used_memory() const = 0;
163 
168  virtual void clear() = 0;
169 
174  virtual void sort() {
175  // default implementation is empty
176  }
177 
178  // This function can usually be const in derived classes,
179  // but not always. It could, for instance, sort internal data.
180  // This is why it is not declared const here.
181  virtual void dump_as_list(const int /*fd*/) {
182  throw std::runtime_error{"can't dump as list"};
183  }
184 
185  // This function can usually be const in derived classes,
186  // but not always. It could, for instance, sort internal data.
187  // This is why it is not declared const here.
188  virtual void dump_as_array(const int /*fd*/) {
189  throw std::runtime_error{"can't dump as array"};
190  }
191 
192  }; // class Map
193 
194  } // namespace map
195 
196  template <typename TId, typename TValue>
197  class MapFactory {
198 
199  public:
200 
201  using id_type = TId;
202  using value_type = TValue;
204  using create_map_func = std::function<map_type*(const std::vector<std::string>&)>;
205 
206  private:
207 
208  std::map<const std::string, create_map_func> m_callbacks;
209 
210  MapFactory() = default;
211 
212  MapFactory(const MapFactory&) = delete;
213  MapFactory& operator=(const MapFactory&) = delete;
214 
215  MapFactory(MapFactory&&) = delete;
216  MapFactory& operator=(MapFactory&&) = delete;
217 
218  public:
219 
221  static MapFactory<id_type, value_type> factory;
222  return factory;
223  }
224 
225  bool register_map(const std::string& map_type_name, create_map_func func) {
226  return m_callbacks.emplace(map_type_name, func).second;
227  }
228 
229  bool has_map_type(const std::string& map_type_name) const {
230  return m_callbacks.count(map_type_name) != 0;
231  }
232 
233  std::vector<std::string> map_types() const {
234  std::vector<std::string> result;
235 
236  for (const auto& cb : m_callbacks) {
237  result.push_back(cb.first);
238  }
239 
240  std::sort(result.begin(), result.end());
241 
242  return result;
243  }
244 
245  std::unique_ptr<map_type> create_map(const std::string& config_string) const {
246  std::vector<std::string> config{osmium::split_string(config_string, ',')};
247 
248  if (config.empty()) {
249  throw map_factory_error{"Need non-empty map type name"};
250  }
251 
252  const auto it = m_callbacks.find(config[0]);
253  if (it != m_callbacks.end()) {
254  return std::unique_ptr<map_type>((it->second)(config));
255  }
256 
257  throw map_factory_error{std::string{"Support for map type '"} + config[0] + "' not compiled into this binary"};
258  }
259 
260  }; // class MapFactory
261 
262  namespace map {
263 
264  template <typename TId, typename TValue, template<typename, typename> class TMap>
265  struct create_map {
266  TMap<TId, TValue>* operator()(const std::vector<std::string>&) {
267  return new TMap<TId, TValue>();
268  }
269  };
270 
271  } // namespace map
272 
273  template <typename TId, typename TValue, template<typename, typename> class TMap>
274  inline bool register_map(const std::string& name) {
275  return osmium::index::MapFactory<TId, TValue>::instance().register_map(name, [](const std::vector<std::string>& config) {
276  return map::create_map<TId, TValue, TMap>()(config);
277  });
278  }
279 
280 #define OSMIUM_CONCATENATE_DETAIL_(x, y) x##y
281 #define OSMIUM_CONCATENATE_(x, y) OSMIUM_CONCATENATE_DETAIL_(x, y)
282 
283 #define REGISTER_MAP(id, value, klass, name) \
284 namespace osmium { namespace index { namespace detail { \
285  const bool OSMIUM_CONCATENATE_(registered_, name) = osmium::index::register_map<id, value, klass>(#name); \
286  inline bool OSMIUM_CONCATENATE_(get_registered_, name)() noexcept { \
287  return OSMIUM_CONCATENATE_(registered_, name); \
288  } \
289 } } }
290 
291  } // namespace index
292 
293 } // namespace osmium
294 
295 #endif // OSMIUM_INDEX_MAP_HPP
std::map< const std::string, create_map_func > m_callbacks
Definition: map.hpp:208
std::unique_ptr< map_type > create_map(const std::string &config_string) const
Definition: map.hpp:245
TId id_type
Definition: map.hpp:201
TValue value_type
Definition: map.hpp:202
Definition: reader_iterator.hpp:39
Definition: map.hpp:265
TId key_type
The "key" type, usually osmium::unsigned_object_id_type.
Definition: map.hpp:111
Definition: map.hpp:50
bool register_map(const std::string &map_type_name, create_map_func func)
Definition: map.hpp:225
TMap< TId, TValue > * operator()(const std::vector< std::string > &)
Definition: map.hpp:266
bool register_map(const std::string &name)
Definition: map.hpp:274
Definition: map.hpp:197
TValue value_type
The "value" type, usually a Location or size_t.
Definition: map.hpp:114
bool has_map_type(const std::string &map_type_name) const
Definition: map.hpp:229
Namespace for everything in the Osmium library.
Definition: assembler.hpp:53
virtual void dump_as_array(const int)
Definition: map.hpp:188
std::vector< std::string > map_types() const
Definition: map.hpp:233
virtual void dump_as_list(const int)
Definition: map.hpp:181
virtual void sort()
Definition: map.hpp:174
static MapFactory< id_type, value_type > & instance()
Definition: map.hpp:220
std::function< map_type *(const std::vector< std::string > &)> create_map_func
Definition: map.hpp:204
map_factory_error(const std::string &message)
Definition: map.hpp:56
map_factory_error(const char *message)
Definition: map.hpp:52
std::vector< std::string > split_string(const std::string &str, const char sep, bool compact=false)
Definition: string.hpp:50
Definition: map.hpp:96