-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Upgrade to protozero 1.7.1 * Bump version number
- Loading branch information
Showing
19 changed files
with
2,650 additions
and
1,387 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,266 @@ | ||
#ifndef PROTOZERO_BASIC_PBF_BUILDER_HPP | ||
#define PROTOZERO_BASIC_PBF_BUILDER_HPP | ||
|
||
/***************************************************************************** | ||
protozero - Minimalistic protocol buffer decoder and encoder in C++. | ||
This file is from https://github.com/mapbox/protozero where you can find more | ||
documentation. | ||
*****************************************************************************/ | ||
|
||
/** | ||
* @file basic_pbf_builder.hpp | ||
* | ||
* @brief Contains the basic_pbf_builder template class. | ||
*/ | ||
|
||
#include "basic_pbf_writer.hpp" | ||
#include "types.hpp" | ||
|
||
#include <type_traits> | ||
|
||
namespace protozero { | ||
|
||
/** | ||
* The basic_pbf_builder is used to write PBF formatted messages into a buffer. | ||
* It is based on the basic_pbf_writer class and has all the same methods. The | ||
* difference is that while the pbf_writer class takes an integer tag, | ||
* this template class takes a tag of the template type T. The idea is that | ||
* T will be an enumeration value and this helps reduce the possibility of | ||
* programming errors. | ||
* | ||
* Almost all methods in this class can throw an std::bad_alloc exception if | ||
* the underlying buffer class wants to resize. | ||
* | ||
* Read the tutorial to understand how this class is used. In most cases you | ||
* want to use the pbf_builder class which uses a std::string as buffer type. | ||
*/ | ||
template <typename TBuffer, typename T> | ||
class basic_pbf_builder : public basic_pbf_writer<TBuffer> { | ||
|
||
static_assert(std::is_same<pbf_tag_type, typename std::underlying_type<T>::type>::value, | ||
"T must be enum with underlying type protozero::pbf_tag_type"); | ||
|
||
public: | ||
|
||
/// The type of messages this class will build. | ||
using enum_type = T; | ||
|
||
basic_pbf_builder() = default; | ||
|
||
/** | ||
* Create a builder using the given string as a data store. The object | ||
* stores a reference to that string and adds all data to it. The string | ||
* doesn't have to be empty. The pbf_message object will just append data. | ||
*/ | ||
explicit basic_pbf_builder(TBuffer& data) noexcept : | ||
basic_pbf_writer<TBuffer>{data} { | ||
} | ||
|
||
/** | ||
* Construct a pbf_builder for a submessage from the pbf_message or | ||
* pbf_writer of the parent message. | ||
* | ||
* @param parent_writer The parent pbf_message or pbf_writer | ||
* @param tag Tag of the field that will be written | ||
*/ | ||
template <typename P> | ||
basic_pbf_builder(basic_pbf_writer<TBuffer>& parent_writer, P tag) noexcept : | ||
basic_pbf_writer<TBuffer>{parent_writer, pbf_tag_type(tag)} { | ||
} | ||
|
||
/// @cond INTERNAL | ||
#define PROTOZERO_WRITER_WRAP_ADD_SCALAR(name, type) \ | ||
void add_##name(T tag, type value) { \ | ||
basic_pbf_writer<TBuffer>::add_##name(pbf_tag_type(tag), value); \ | ||
} | ||
|
||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(bool, bool) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(enum, int32_t) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(int32, int32_t) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(sint32, int32_t) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(uint32, uint32_t) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(int64, int64_t) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(sint64, int64_t) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(uint64, uint64_t) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(fixed32, uint32_t) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(sfixed32, int32_t) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(fixed64, uint64_t) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(sfixed64, int64_t) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(float, float) | ||
PROTOZERO_WRITER_WRAP_ADD_SCALAR(double, double) | ||
|
||
#undef PROTOZERO_WRITER_WRAP_ADD_SCALAR | ||
/// @endcond | ||
|
||
/** | ||
* Add "bytes" field to data. | ||
* | ||
* @param tag Tag of the field | ||
* @param value Pointer to value to be written | ||
* @param size Number of bytes to be written | ||
*/ | ||
void add_bytes(T tag, const char* value, std::size_t size) { | ||
basic_pbf_writer<TBuffer>::add_bytes(pbf_tag_type(tag), value, size); | ||
} | ||
|
||
/** | ||
* Add "bytes" field to data. | ||
* | ||
* @param tag Tag of the field | ||
* @param value Value to be written | ||
*/ | ||
void add_bytes(T tag, const data_view& value) { | ||
basic_pbf_writer<TBuffer>::add_bytes(pbf_tag_type(tag), value); | ||
} | ||
|
||
/** | ||
* Add "bytes" field to data. | ||
* | ||
* @param tag Tag of the field | ||
* @param value Value to be written | ||
*/ | ||
void add_bytes(T tag, const std::string& value) { | ||
basic_pbf_writer<TBuffer>::add_bytes(pbf_tag_type(tag), value); | ||
} | ||
|
||
/** | ||
* Add "bytes" field to data. Bytes from the value are written until | ||
* a null byte is encountered. The null byte is not added. | ||
* | ||
* @param tag Tag of the field | ||
* @param value Pointer to zero-delimited value to be written | ||
*/ | ||
void add_bytes(T tag, const char* value) { | ||
basic_pbf_writer<TBuffer>::add_bytes(pbf_tag_type(tag), value); | ||
} | ||
|
||
/** | ||
* Add "bytes" field to data using vectored input. All the data in the | ||
* 2nd and further arguments is "concatenated" with only a single copy | ||
* into the final buffer. | ||
* | ||
* This will work with objects of any type supporting the data() and | ||
* size() methods like std::string or protozero::data_view. | ||
* | ||
* Example: | ||
* @code | ||
* std::string data1 = "abc"; | ||
* std::string data2 = "xyz"; | ||
* builder.add_bytes_vectored(1, data1, data2); | ||
* @endcode | ||
* | ||
* @tparam Ts List of types supporting data() and size() methods. | ||
* @param tag Tag of the field | ||
* @param values List of objects of types Ts with data to be appended. | ||
*/ | ||
template <typename... Ts> | ||
void add_bytes_vectored(T tag, Ts&&... values) { | ||
basic_pbf_writer<TBuffer>::add_bytes_vectored(pbf_tag_type(tag), std::forward<Ts>(values)...); | ||
} | ||
|
||
/** | ||
* Add "string" field to data. | ||
* | ||
* @param tag Tag of the field | ||
* @param value Pointer to value to be written | ||
* @param size Number of bytes to be written | ||
*/ | ||
void add_string(T tag, const char* value, std::size_t size) { | ||
basic_pbf_writer<TBuffer>::add_string(pbf_tag_type(tag), value, size); | ||
} | ||
|
||
/** | ||
* Add "string" field to data. | ||
* | ||
* @param tag Tag of the field | ||
* @param value Value to be written | ||
*/ | ||
void add_string(T tag, const data_view& value) { | ||
basic_pbf_writer<TBuffer>::add_string(pbf_tag_type(tag), value); | ||
} | ||
|
||
/** | ||
* Add "string" field to data. | ||
* | ||
* @param tag Tag of the field | ||
* @param value Value to be written | ||
*/ | ||
void add_string(T tag, const std::string& value) { | ||
basic_pbf_writer<TBuffer>::add_string(pbf_tag_type(tag), value); | ||
} | ||
|
||
/** | ||
* Add "string" field to data. Bytes from the value are written until | ||
* a null byte is encountered. The null byte is not added. | ||
* | ||
* @param tag Tag of the field | ||
* @param value Pointer to value to be written | ||
*/ | ||
void add_string(T tag, const char* value) { | ||
basic_pbf_writer<TBuffer>::add_string(pbf_tag_type(tag), value); | ||
} | ||
|
||
/** | ||
* Add "message" field to data. | ||
* | ||
* @param tag Tag of the field | ||
* @param value Pointer to message to be written | ||
* @param size Length of the message | ||
*/ | ||
void add_message(T tag, const char* value, std::size_t size) { | ||
basic_pbf_writer<TBuffer>::add_message(pbf_tag_type(tag), value, size); | ||
} | ||
|
||
/** | ||
* Add "message" field to data. | ||
* | ||
* @param tag Tag of the field | ||
* @param value Value to be written. The value must be a complete message. | ||
*/ | ||
void add_message(T tag, const data_view& value) { | ||
basic_pbf_writer<TBuffer>::add_message(pbf_tag_type(tag), value); | ||
} | ||
|
||
/** | ||
* Add "message" field to data. | ||
* | ||
* @param tag Tag of the field | ||
* @param value Value to be written. The value must be a complete message. | ||
*/ | ||
void add_message(T tag, const std::string& value) { | ||
basic_pbf_writer<TBuffer>::add_message(pbf_tag_type(tag), value); | ||
} | ||
|
||
/// @cond INTERNAL | ||
#define PROTOZERO_WRITER_WRAP_ADD_PACKED(name) \ | ||
template <typename InputIterator> \ | ||
void add_packed_##name(T tag, InputIterator first, InputIterator last) { \ | ||
basic_pbf_writer<TBuffer>::add_packed_##name(pbf_tag_type(tag), first, last); \ | ||
} | ||
|
||
PROTOZERO_WRITER_WRAP_ADD_PACKED(bool) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(enum) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(int32) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(sint32) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(uint32) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(int64) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(sint64) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(uint64) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(fixed32) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(sfixed32) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(fixed64) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(sfixed64) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(float) | ||
PROTOZERO_WRITER_WRAP_ADD_PACKED(double) | ||
|
||
#undef PROTOZERO_WRITER_WRAP_ADD_PACKED | ||
/// @endcond | ||
|
||
}; // class basic_pbf_builder | ||
|
||
} // end namespace protozero | ||
|
||
#endif // PROTOZERO_BASIC_PBF_BUILDER_HPP |
Oops, something went wrong.