Libosmium  2.13.1
Fast and flexible C++ library for working with OpenStreetMap data
builder.hpp
Go to the documentation of this file.
1 #ifndef OSMIUM_BUILDER_BUILDER_HPP
2 #define OSMIUM_BUILDER_BUILDER_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 <cassert>
38 #include <cstddef>
39 #include <cstdint>
40 #include <cstring>
41 
42 #include <osmium/memory/buffer.hpp>
43 #include <osmium/memory/item.hpp>
45 
46 namespace osmium {
47 
51  namespace builder {
52 
57  class Builder {
58 
61  std::size_t m_item_offset;
62 
63  Builder(const Builder&) = delete;
64  Builder(Builder&&) = delete;
65 
66  Builder& operator=(const Builder&) = delete;
67  Builder& operator=(Builder&&) = delete;
68 
69  protected:
70 
72  m_buffer(buffer),
73  m_parent(parent),
74  m_item_offset(buffer.written()) {
75  reserve_space(size);
76  assert(buffer.is_aligned());
77  if (m_parent) {
78  assert(m_buffer.builder_count() == 1 && "Only one sub-builder can be open at any time.");
79  m_parent->add_size(size);
80  } else {
81  assert(m_buffer.builder_count() == 0 && "Only one builder can be open at any time.");
82  }
83 #ifndef NDEBUG
84  m_buffer.increment_builder_count();
85 #endif
86  }
87 
88 #ifdef NDEBUG
89  ~Builder() = default;
90 #else
91  ~Builder() noexcept {
92  m_buffer.decrement_builder_count();
93  }
94 #endif
95 
97  return *reinterpret_cast<osmium::memory::Item*>(m_buffer.data() + m_item_offset);
98  }
99 
100  unsigned char* reserve_space(std::size_t size) {
101  return m_buffer.reserve_space(size);
102  }
103 
117  void add_padding(bool self = false) {
118  // We know the padding is only a very small number, so it will
119  // always fit.
121  if (padding != osmium::memory::align_bytes) {
122  std::fill_n(reserve_space(padding), padding, 0);
123  if (self) {
124  add_size(padding);
125  } else if (m_parent) {
126  m_parent->add_size(padding);
127  assert(m_parent->size() % osmium::memory::align_bytes == 0);
128  }
129  }
130  }
131 
133  item().add_size(size);
134  if (m_parent) {
135  m_parent->add_size(size);
136  }
137  }
138 
139  uint32_t size() const noexcept {
140  return item().byte_size();
141  }
142 
147  template <typename T>
149  assert(m_buffer.is_aligned());
150  return reinterpret_cast<T*>(reserve_space(sizeof(T)));
151  }
152 
163  unsigned char* target = reserve_space(length);
164  std::copy_n(reinterpret_cast<const unsigned char*>(data), length, target);
165  return length;
166  }
167 
176  unsigned char* target = reserve_space(length + 1);
177  std::copy_n(reinterpret_cast<const unsigned char*>(data), length, target);
178  target[length] = '\0';
179  return length + 1;
180  }
181 
189  return append(str, static_cast<osmium::memory::item_size_type>(std::strlen(str) + 1));
190  }
191 
200  *reserve_space(1) = '\0';
201  return 1;
202  }
203 
204  public:
205 
208  return m_buffer;
209  }
210 
216  m_buffer.add_item(item);
217  add_size(item.padded_size());
218  }
219 
225  assert(item);
226  add_item(*item);
227  }
228 
229  }; // class Builder
230 
231  } // namespace builder
232 
233 } // namespace osmium
234 
235 #endif // OSMIUM_BUILDER_BUILDER_HPP
Builder * m_parent
Definition: builder.hpp:60
Builder(osmium::memory::Buffer &buffer, Builder *parent, osmium::memory::item_size_type size)
Definition: builder.hpp:71
OSMIUM_DEPRECATED osmium::memory::item_size_type append_zero()
Definition: builder.hpp:199
#define OSMIUM_DEPRECATED
Definition: compatibility.hpp:50
bool is_aligned() const noexcept
Definition: buffer.hpp:287
osmium::memory::Buffer & buffer() noexcept
Return the buffer this builder is using.
Definition: builder.hpp:207
void add_item(const osmium::memory::Item &item)
Definition: builder.hpp:215
void add_size(osmium::memory::item_size_type size)
Definition: builder.hpp:132
uint32_t item_size_type
Definition: item.hpp:59
osmium::memory::item_size_type append_with_zero(const char *data, const osmium::memory::item_size_type length)
Definition: builder.hpp:175
void increment_builder_count() noexcept
Definition: buffer.hpp:232
OSMIUM_DEPRECATED void add_item(const osmium::memory::Item *item)
Definition: builder.hpp:224
constexpr const std::size_t align_bytes
Definition: item.hpp:62
item_size_type padded_size() const
Definition: item.hpp:165
Definition: item.hpp:105
Namespace for everything in the Osmium library.
Definition: assembler.hpp:53
T & add_item(const T &item)
Definition: buffer.hpp:483
Item & add_size(const item_size_type size) noexcept
Definition: item.hpp:121
T * reserve_space_for()
Definition: builder.hpp:148
uint8_t builder_count() const noexcept
Definition: buffer.hpp:241
unsigned char * reserve_space(std::size_t size)
Definition: builder.hpp:100
unsigned char * data() const noexcept
Definition: buffer.hpp:251
osmium::memory::item_size_type append(const char *str)
Definition: builder.hpp:188
unsigned char * reserve_space(const std::size_t size)
Definition: buffer.hpp:443
std::size_t m_item_offset
Definition: builder.hpp:61
item_size_type byte_size() const noexcept
Definition: item.hpp:161
~Builder() noexcept
Definition: builder.hpp:91
osmium::memory::Buffer & m_buffer
Definition: builder.hpp:59
Definition: buffer.hpp:98
void decrement_builder_count() noexcept
Definition: buffer.hpp:236
osmium::memory::item_size_type append(const char *data, const osmium::memory::item_size_type length)
Definition: builder.hpp:162
Builder(const Builder &)=delete
uint32_t size() const noexcept
Definition: builder.hpp:139
Definition: builder.hpp:57
Builder & operator=(const Builder &)=delete
void add_padding(bool self=false)
Definition: builder.hpp:117
osmium::memory::Item & item() const
Definition: builder.hpp:96