Libosmium  2.15.5
Fast and flexible C++ library for working with OpenStreetMap data
collection.hpp
Go to the documentation of this file.
1 #ifndef OSMIUM_MEMORY_COLLECTION_HPP
2 #define OSMIUM_MEMORY_COLLECTION_HPP
3 
4 /*
5 
6 This file is part of Osmium (https://osmcode.org/libosmium).
7 
8 Copyright 2013-2020 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 <osmium/memory/item.hpp>
37 
38 #include <iosfwd>
39 #include <iterator>
40 #include <type_traits>
41 
42 namespace osmium {
43 
44  namespace memory {
45 
46  template <typename TMember>
48 
49  // This data_type is either 'unsigned char*' or 'const unsigned
50  // char*' depending on whether TMember is const. This allows this
51  // class to be used as an iterator and as a const_iterator.
52  using data_type = typename std::conditional<std::is_const<TMember>::value, const unsigned char*, unsigned char*>::type;
53 
55 
56  public:
57 
58  using iterator_category = std::forward_iterator_tag;
59  using value_type = TMember;
60  using difference_type = std::ptrdiff_t;
61  using pointer = value_type*;
63 
64  CollectionIterator() noexcept :
65  m_data(nullptr) {
66  }
67 
68  explicit CollectionIterator(data_type data) noexcept :
69  m_data(data) {
70  }
71 
73  m_data = reinterpret_cast<TMember*>(m_data)->next();
74  return *static_cast<CollectionIterator<TMember>*>(this);
75  }
76 
78  CollectionIterator<TMember> tmp{*this};
79  operator++();
80  return tmp;
81  }
82 
83  bool operator==(const CollectionIterator<TMember>& rhs) const noexcept {
84  return m_data == rhs.m_data;
85  }
86 
87  bool operator!=(const CollectionIterator<TMember>& rhs) const noexcept {
88  return !(*this == rhs);
89  }
90 
91  unsigned char* data() const noexcept {
92  return m_data;
93  }
94 
95  TMember& operator*() const noexcept {
96  return *reinterpret_cast<TMember*>(m_data);
97  }
98 
99  TMember* operator->() const noexcept {
100  return reinterpret_cast<TMember*>(m_data);
101  }
102 
103  template <typename TChar, typename TTraits>
104  void print(std::basic_ostream<TChar, TTraits>& out) const {
105  out << static_cast<const void*>(m_data);
106  }
107 
108  }; // class CollectionIterator
109 
110  template <typename TChar, typename TTraits, typename TMember>
111  inline std::basic_ostream<TChar, TTraits>& operator<<(std::basic_ostream<TChar, TTraits>& out, const CollectionIterator<TMember>& iter) {
112  iter.print(out);
113  return out;
114  }
115 
116  template <typename TMember, osmium::item_type TCollectionItemType>
117  class Collection : public Item {
118 
119  public:
120 
121  using value_type = TMember;
122  using reference = TMember&;
123  using const_reference = const TMember&;
126  using size_type = std::size_t;
127 
128  static constexpr osmium::item_type itemtype = TCollectionItemType;
129 
130  constexpr static bool is_compatible_to(const osmium::item_type t) noexcept {
131  return t == itemtype;
132  }
133 
134  Collection() noexcept :
135  Item(sizeof(Collection<TMember, TCollectionItemType>), TCollectionItemType) {
136  }
137 
143  bool empty() const noexcept {
145  }
146 
152  size_type size() const noexcept {
153  return static_cast<size_type>(std::distance(begin(), end()));
154  }
155 
156  iterator begin() noexcept {
157  return iterator{data() + sizeof(Collection<TMember, TCollectionItemType>)};
158  }
159 
160  iterator end() noexcept {
161  return iterator{data() + byte_size()};
162  }
163 
164  const_iterator cbegin() const noexcept {
166  }
167 
168  const_iterator cend() const noexcept {
169  return const_iterator{data() + byte_size()};
170  }
171 
172  const_iterator begin() const noexcept {
173  return cbegin();
174  }
175 
176  const_iterator end() const noexcept {
177  return cend();
178  }
179 
180  }; // class Collection
181 
182  } // namespace memory
183 
184 } // namespace osmium
185 
186 #endif // OSMIUM_MEMORY_COLLECTION_HPP
osmium::memory::Collection::size
size_type size() const noexcept
Definition: collection.hpp:152
osmium::memory::Collection::end
const_iterator end() const noexcept
Definition: collection.hpp:176
osmium::memory::CollectionIterator::value_type
TMember value_type
Definition: collection.hpp:59
osmium::memory::Collection::begin
const_iterator begin() const noexcept
Definition: collection.hpp:172
item.hpp
osmium::memory::CollectionIterator::operator==
bool operator==(const CollectionIterator< TMember > &rhs) const noexcept
Definition: collection.hpp:83
osmium::memory::CollectionIterator::operator++
CollectionIterator< TMember > operator++(int)
Definition: collection.hpp:77
osmium::memory::CollectionIterator::operator*
TMember & operator*() const noexcept
Definition: collection.hpp:95
osmium::memory::CollectionIterator::data_type
typename std::conditional< std::is_const< TMember >::value, const unsigned char *, unsigned char * >::type data_type
Definition: collection.hpp:52
osmium::memory::CollectionIterator::difference_type
std::ptrdiff_t difference_type
Definition: collection.hpp:60
osmium::memory::Collection::itemtype
static constexpr osmium::item_type itemtype
Definition: collection.hpp:128
osmium::memory::Collection::Collection
Collection() noexcept
Definition: collection.hpp:134
osmium::memory::CollectionIterator::operator!=
bool operator!=(const CollectionIterator< TMember > &rhs) const noexcept
Definition: collection.hpp:87
osmium::memory::operator<<
std::basic_ostream< TChar, TTraits > & operator<<(std::basic_ostream< TChar, TTraits > &out, const CollectionIterator< TMember > &iter)
Definition: collection.hpp:111
osmium::memory::CollectionIterator
Definition: collection.hpp:47
osmium::memory::CollectionIterator::CollectionIterator
CollectionIterator(data_type data) noexcept
Definition: collection.hpp:68
osmium::memory::Collection::cbegin
const_iterator cbegin() const noexcept
Definition: collection.hpp:164
osmium::memory::Collection::empty
bool empty() const noexcept
Definition: collection.hpp:143
osmium
Namespace for everything in the Osmium library.
Definition: assembler.hpp:53
osmium::memory::Item
Definition: item.hpp:105
osmium::memory::CollectionIterator::m_data
data_type m_data
Definition: collection.hpp:54
osmium::memory::Collection::cend
const_iterator cend() const noexcept
Definition: collection.hpp:168
osmium::memory::Item::byte_size
item_size_type byte_size() const noexcept
Definition: item.hpp:163
osmium::memory::Collection::end
iterator end() noexcept
Definition: collection.hpp:160
osmium::memory::CollectionIterator::iterator_category
std::forward_iterator_tag iterator_category
Definition: collection.hpp:58
osmium::memory::Collection::is_compatible_to
constexpr static bool is_compatible_to(const osmium::item_type t) noexcept
Definition: collection.hpp:130
osmium::RelationMember
Definition: relation.hpp:57
osmium::memory::Collection::begin
iterator begin() noexcept
Definition: collection.hpp:156
osmium::geom::haversine::distance
double distance(const osmium::geom::Coordinates &c1, const osmium::geom::Coordinates &c2) noexcept
Definition: haversine.hpp:66
osmium::memory::CollectionIterator::operator++
CollectionIterator< TMember > & operator++()
Definition: collection.hpp:72
osmium::memory::CollectionIterator::pointer
value_type * pointer
Definition: collection.hpp:61
osmium::memory::CollectionIterator::operator->
TMember * operator->() const noexcept
Definition: collection.hpp:99
osmium::memory::CollectionIterator::print
void print(std::basic_ostream< TChar, TTraits > &out) const
Definition: collection.hpp:104
osmium::memory::Collection< RelationMember, osmium::item_type::relation_member_list >::size_type
std::size_t size_type
Definition: collection.hpp:126
osmium::memory::CollectionIterator::CollectionIterator
CollectionIterator() noexcept
Definition: collection.hpp:64
osmium::memory::Collection
Definition: collection.hpp:117
osmium::memory::CollectionIterator::data
unsigned char * data() const noexcept
Definition: collection.hpp:91
osmium::osm_entity_bits::type
type
Definition: entity_bits.hpp:63
osmium::memory::CollectionIterator::reference
value_type & reference
Definition: collection.hpp:62
osmium::item_type
item_type
Definition: item_type.hpp:43