Libosmium  2.3.0
Fast and flexible C++ library for working with OpenStreetMap data
osm_object_builder.hpp
Go to the documentation of this file.
1 #ifndef OSMIUM_BUILDER_OSM_OBJECT_BUILDER_HPP
2 #define OSMIUM_BUILDER_OSM_OBJECT_BUILDER_HPP
3 
4 /*
5 
6 This file is part of Osmium (http://osmcode.org/libosmium).
7 
8 Copyright 2013-2015 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 <cstring>
37 #include <initializer_list>
38 #include <new>
39 #include <string>
40 #include <utility>
41 
43 #include <osmium/osm.hpp>
44 #include <osmium/osm/item_type.hpp>
45 #include <osmium/osm/location.hpp>
46 #include <osmium/osm/node_ref.hpp>
47 #include <osmium/osm/object.hpp>
48 #include <osmium/osm/tag.hpp>
49 #include <osmium/osm/types.hpp>
50 #include <osmium/util/cast.hpp>
51 
52 namespace osmium {
53 
54  namespace memory {
55  class Buffer;
56  }
57 
58  namespace builder {
59 
60  class TagListBuilder : public ObjectBuilder<TagList> {
61 
62  public:
63 
64  explicit TagListBuilder(osmium::memory::Buffer& buffer, Builder* parent = nullptr) :
65  ObjectBuilder<TagList>(buffer, parent) {
66  }
67 
69  add_padding();
70  }
71 
78  void add_tag(const char* key, const char* value) {
79  add_size(append(key) + append(value));
80  }
81 
90  void add_tag(const char* key, const string_size_type key_length, const char* value, const string_size_type value_length) {
91  add_size(append(key, key_length) + append_zero() + append(value, value_length) + append_zero());
92  }
93 
100  void add_tag(const std::string& key, const std::string& value) {
101  add_size(append(key.data(), static_cast_with_assert<string_size_type>(key.size() + 1)) +
102  append(value.data(), static_cast_with_assert<string_size_type>(value.size() + 1)));
103  }
104 
105  }; // class TagListBuilder
106 
107  template <class T>
108  class NodeRefListBuilder : public ObjectBuilder<T> {
109 
110  public:
111 
112  explicit NodeRefListBuilder(osmium::memory::Buffer& buffer, Builder* parent = nullptr) :
113  ObjectBuilder<T>(buffer, parent) {
114  }
115 
117  static_cast<Builder*>(this)->add_padding();
118  }
119 
120  void add_node_ref(const NodeRef& node_ref) {
121  new (static_cast<Builder*>(this)->reserve_space_for<osmium::NodeRef>()) osmium::NodeRef(node_ref);
122  static_cast<Builder*>(this)->add_size(sizeof(osmium::NodeRef));
123  }
124 
125  void add_node_ref(const object_id_type ref, const osmium::Location location = Location()) {
126  add_node_ref(NodeRef(ref, location));
127  }
128 
129  }; // class NodeRefListBuilder
130 
134 
135  class RelationMemberListBuilder : public ObjectBuilder<RelationMemberList> {
136 
145  void add_role(osmium::RelationMember& member, const char* role, const string_size_type length) {
146  member.set_role_size(length + 1);
147  add_size(append(role, length) + append_zero());
148  add_padding(true);
149  }
150 
158  void add_role(osmium::RelationMember& member, const char* role) {
159  add_role(member, role, static_cast_with_assert<string_size_type>(std::strlen(role)));
160  }
161 
169  void add_role(osmium::RelationMember& member, const std::string& role) {
170  add_role(member, role.data(), static_cast_with_assert<string_size_type>(role.size()));
171  }
172 
173  public:
174 
176  ObjectBuilder<RelationMemberList>(buffer, parent) {
177  }
178 
180  add_padding();
181  }
182 
194  void add_member(osmium::item_type type, object_id_type ref, const char* role, const string_size_type role_length, const osmium::OSMObject* full_member = nullptr) {
195  osmium::RelationMember* member = reserve_space_for<osmium::RelationMember>();
196  new (member) osmium::RelationMember(ref, type, full_member != nullptr);
197  add_size(sizeof(RelationMember));
198  add_role(*member, role, role_length);
199  if (full_member) {
200  add_item(full_member);
201  }
202  }
203 
214  void add_member(osmium::item_type type, object_id_type ref, const char* role, const osmium::OSMObject* full_member = nullptr) {
215  add_member(type, ref, role, strlen(role), full_member);
216  }
217 
228  void add_member(osmium::item_type type, object_id_type ref, const std::string& role, const osmium::OSMObject* full_member = nullptr) {
229  add_member(type, ref, role.data(), role.size(), full_member);
230  }
231 
232  }; // class RelationMemberListBuilder
233 
234  template <class T>
235  class OSMObjectBuilder : public ObjectBuilder<T> {
236 
237  public:
238 
239  explicit OSMObjectBuilder(osmium::memory::Buffer& buffer, Builder* parent = nullptr) :
240  ObjectBuilder<T>(buffer, parent) {
241  static_cast<Builder*>(this)->reserve_space_for<string_size_type>();
242  static_cast<Builder*>(this)->add_size(sizeof(string_size_type));
243  }
244 
245  void add_tags(const std::initializer_list<std::pair<const char*, const char*>>& tags) {
246  osmium::builder::TagListBuilder tl_builder(static_cast<Builder*>(this)->buffer(), this);
247  for (const auto& p : tags) {
248  tl_builder.add_tag(p.first, p.second);
249  }
250  }
251 
252  }; // class OSMObjectBuilder
253 
256 
257  class WayBuilder : public OSMObjectBuilder<osmium::Way> {
258 
259  public:
260 
261  explicit WayBuilder(osmium::memory::Buffer& buffer, Builder* parent = nullptr) :
262  OSMObjectBuilder<osmium::Way>(buffer, parent) {
263  }
264 
265  void add_node_refs(const std::initializer_list<osmium::NodeRef>& nodes) {
267  for (const auto& node_ref : nodes) {
268  builder.add_node_ref(node_ref);
269  }
270  }
271 
272  }; // class WayBuilder
273 
274  class AreaBuilder : public OSMObjectBuilder<osmium::Area> {
275 
276  public:
277 
278  explicit AreaBuilder(osmium::memory::Buffer& buffer, Builder* parent = nullptr) :
279  OSMObjectBuilder<osmium::Area>(buffer, parent) {
280  }
281 
286  osmium::Area& area = object();
287  area.set_id(osmium::object_id_to_area_id(source.id(), source.type()));
288  area.set_version(source.version());
289  area.set_changeset(source.changeset());
290  area.set_timestamp(source.timestamp());
291  area.set_visible(source.visible());
292  area.set_uid(source.uid());
293 
294  add_user(source.user());
295  }
296 
297  }; // class AreaBuilder
298 
300 
301  } // namespace builder
302 
303 } // namespace osmium
304 
305 #endif // OSMIUM_BUILDER_OSM_OBJECT_BUILDER_HPP
Definition: osm_object_builder.hpp:235
NodeRefListBuilder< InnerRing > InnerRingBuilder
Definition: osm_object_builder.hpp:133
~TagListBuilder()
Definition: osm_object_builder.hpp:68
osmium::memory::Buffer & buffer() noexcept
Return the buffer this builder is using.
Definition: builder.hpp:179
Definition: tag.hpp:105
type
Definition: entity_bits.hpp:60
osmium::memory::item_size_type append_zero()
Definition: builder.hpp:173
WayBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:261
AreaBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:278
void add_member(osmium::item_type type, object_id_type ref, const char *role, const osmium::OSMObject *full_member=nullptr)
Definition: osm_object_builder.hpp:214
void initialize_from_object(const osmium::OSMObject &source)
Definition: osm_object_builder.hpp:285
void add_user(const char *user, const string_size_type length)
Definition: builder.hpp:206
OSMObjectBuilder< osmium::Node > NodeBuilder
Definition: osm_object_builder.hpp:254
item_type
Definition: item_type.hpp:43
~RelationMemberListBuilder()
Definition: osm_object_builder.hpp:179
void add_tag(const char *key, const string_size_type key_length, const char *value, const string_size_type value_length)
Definition: osm_object_builder.hpp:90
Definition: area.hpp:113
Definition: relation.hpp:150
OSMObject & set_id(object_id_type id) noexcept
Definition: object.hpp:124
Definition: way.hpp:65
RelationMemberListBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:175
void add_member(osmium::item_type type, object_id_type ref, const char *role, const string_size_type role_length, const osmium::OSMObject *full_member=nullptr)
Definition: osm_object_builder.hpp:194
osmium::object_id_type object_id_to_area_id(osmium::object_id_type id, osmium::item_type type) noexcept
Definition: area.hpp:92
NodeRefListBuilder< WayNodeList > WayNodeListBuilder
Definition: osm_object_builder.hpp:131
void add_role(osmium::RelationMember &member, const char *role)
Definition: osm_object_builder.hpp:158
Definition: osm_object_builder.hpp:108
Definition: relation.hpp:54
int64_t object_id_type
Type for OSM object (node, way, or relation) IDs.
Definition: types.hpp:45
Namespace for everything in the Osmium library.
Definition: assembler.hpp:55
void add_tags(const std::initializer_list< std::pair< const char *, const char * >> &tags)
Definition: osm_object_builder.hpp:245
void add_node_refs(const std::initializer_list< osmium::NodeRef > &nodes)
Definition: osm_object_builder.hpp:265
void add_role(osmium::RelationMember &member, const char *role, const string_size_type length)
Definition: osm_object_builder.hpp:145
OSMObjectBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:239
uint16_t string_size_type
Definition: types.hpp:58
NodeRefListBuilder< OuterRing > OuterRingBuilder
Definition: osm_object_builder.hpp:132
OSMObject & set_timestamp(const osmium::Timestamp timestamp) noexcept
Definition: object.hpp:284
void add_node_ref(const object_id_type ref, const osmium::Location location=Location())
Definition: osm_object_builder.hpp:125
user_id_type uid() const noexcept
Get user id of this object.
Definition: object.hpp:234
changeset_id_type changeset() const noexcept
Get changeset id of this object.
Definition: object.hpp:210
OSMObject & set_changeset(changeset_id_type changeset) noexcept
Definition: object.hpp:219
Definition: location.hpp:79
Definition: osm_object_builder.hpp:257
object_id_type id() const noexcept
Get ID of this object.
Definition: object.hpp:110
OSMObject & set_version(object_version_type version) noexcept
Definition: object.hpp:195
object_version_type version() const noexcept
Get version of this object.
Definition: object.hpp:186
void set_role_size(string_size_type size) noexcept
Definition: relation.hpp:96
void add_member(osmium::item_type type, object_id_type ref, const std::string &role, const osmium::OSMObject *full_member=nullptr)
Definition: osm_object_builder.hpp:228
NodeRefListBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:112
Definition: buffer.hpp:94
Definition: builder.hpp:186
OSMObject & set_visible(bool visible) noexcept
Definition: object.hpp:163
~NodeRefListBuilder()
Definition: osm_object_builder.hpp:116
osmium::memory::item_size_type append(const char *data, const osmium::memory::item_size_type length)
Definition: builder.hpp:152
ObjectBuilder< osmium::Changeset > ChangesetBuilder
Definition: osm_object_builder.hpp:299
bool visible() const noexcept
Is this object marked visible (ie not deleted)?
Definition: object.hpp:144
void add_role(osmium::RelationMember &member, const std::string &role)
Definition: osm_object_builder.hpp:169
void add_size(uint32_t size)
Definition: builder.hpp:116
void add_item(const osmium::memory::Item *item)
Definition: builder.hpp:127
OSMObjectBuilder< osmium::Relation > RelationBuilder
Definition: osm_object_builder.hpp:255
void add_tag(const std::string &key, const std::string &value)
Definition: osm_object_builder.hpp:100
Definition: node_ref.hpp:50
osmium::Area & object() noexcept
Definition: builder.hpp:196
const char * user() const noexcept
Get user name for this object.
Definition: object.hpp:290
item_type type() const noexcept
Definition: item.hpp:155
osmium::Timestamp timestamp() const noexcept
Get timestamp when this object last changed.
Definition: object.hpp:274
OSMObject & set_uid(user_id_type uid) noexcept
Definition: object.hpp:243
Definition: builder.hpp:57
Definition: osm_object_builder.hpp:135
TagListBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:64
void add_tag(const char *key, const char *value)
Definition: osm_object_builder.hpp:78
Definition: object.hpp:58
Definition: osm_object_builder.hpp:60
void add_node_ref(const NodeRef &node_ref)
Definition: osm_object_builder.hpp:120
Definition: osm_object_builder.hpp:274
void add_padding(bool self=false)
Definition: builder.hpp:103