17 #ifndef FLATBUFFERS_H_
18 #define FLATBUFFERS_H_
28 #include <type_traits>
34 #ifdef _STLPORT_VERSION
35 #define FLATBUFFERS_CPP98_STL
37 #ifndef FLATBUFFERS_CPP98_STL
42 #if __cplusplus <= 199711L && \
43 (!defined(_MSC_VER) || _MSC_VER < 1600) && \
44 (!defined(__GNUC__) || \
45 (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__ < 40400))
46 #error A C++11 compatible compiler with support for the auto typing is \
47 required for FlatBuffers.
48 #error __cplusplus _MSC_VER __GNUC__ __GNUC_MINOR__ __GNUC_PATCHLEVEL__
51 #if !defined(__clang__) && \
52 defined(__GNUC__) && \
53 (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__ < 40600)
58 const class nullptr_t {
60 template<
class T>
inline operator T*()
const {
return 0; }
62 void operator&()
const;
66 #define constexpr const
72 #if !defined(FLATBUFFERS_LITTLEENDIAN)
73 #if defined(__GNUC__) || defined(__clang__)
75 #define FLATBUFFERS_LITTLEENDIAN 0
77 #define FLATBUFFERS_LITTLEENDIAN 1
78 #endif // __BIG_ENDIAN__
79 #elif defined(_MSC_VER)
81 #define FLATBUFFERS_LITTLEENDIAN 0
83 #define FLATBUFFERS_LITTLEENDIAN 1
86 #error Unable to determine endianness, define FLATBUFFERS_LITTLEENDIAN.
88 #endif // !defined(FLATBUFFERS_LITTLEENDIAN)
90 #define FLATBUFFERS_VERSION_MAJOR 1
91 #define FLATBUFFERS_VERSION_MINOR 5
92 #define FLATBUFFERS_VERSION_REVISION 0
93 #define FLATBUFFERS_STRING_EXPAND(X) #X
94 #define FLATBUFFERS_STRING(X) FLATBUFFERS_STRING_EXPAND(X)
96 #if (!defined(_MSC_VER) || _MSC_VER > 1600) && \
97 (!defined(__GNUC__) || (__GNUC__ * 100 + __GNUC_MINOR__ >= 407))
98 #define FLATBUFFERS_FINAL_CLASS final
100 #define FLATBUFFERS_FINAL_CLASS
103 #if (!defined(_MSC_VER) || _MSC_VER >= 1900) && \
104 (!defined(__GNUC__) || (__GNUC__ * 100 + __GNUC_MINOR__ >= 406))
105 #define FLATBUFFERS_CONSTEXPR constexpr
107 #define FLATBUFFERS_CONSTEXPR
113 namespace flatbuffers {
119 typedef uint32_t uoffset_t;
122 typedef int32_t soffset_t;
126 typedef uint16_t voffset_t;
128 typedef uintmax_t largest_scalar_t;
131 #define FLATBUFFERS_MAX_BUFFER_SIZE ((1ULL << (sizeof(soffset_t) * 8 - 1)) - 1)
134 #define FLATBUFFERS_MAX_ALIGNMENT 16
136 #ifndef FLATBUFFERS_CPP98_STL
138 typedef std::unique_ptr<uint8_t, std::function<void(uint8_t * )>>
143 template<
typename T>
struct Offset {
146 Offset(uoffset_t _o) : o(_o) {}
147 Offset<void> Union()
const {
return Offset<void>(o); }
150 inline void EndianCheck() {
153 assert(*reinterpret_cast<char *>(&endiantest) == FLATBUFFERS_LITTLEENDIAN);
157 template<
typename T> T EndianSwap(T t) {
158 #if defined(_MSC_VER)
159 #define FLATBUFFERS_BYTESWAP16 _byteswap_ushort
160 #define FLATBUFFERS_BYTESWAP32 _byteswap_ulong
161 #define FLATBUFFERS_BYTESWAP64 _byteswap_uint64
163 #if defined(__GNUC__) && __GNUC__ * 100 + __GNUC_MINOR__ < 408
165 #define FLATBUFFERS_BYTESWAP16(x) \
166 static_cast<uint16_t>(__builtin_bswap32(static_cast<uint32_t>(x) << 16))
168 #define FLATBUFFERS_BYTESWAP16 __builtin_bswap16
170 #define FLATBUFFERS_BYTESWAP32 __builtin_bswap32
171 #define FLATBUFFERS_BYTESWAP64 __builtin_bswap64
173 if (
sizeof(T) == 1) {
175 }
else if (
sizeof(T) == 2) {
176 auto r = FLATBUFFERS_BYTESWAP16(*reinterpret_cast<uint16_t *>(&t));
177 return *
reinterpret_cast<T *
>(&r);
178 }
else if (
sizeof(T) == 4) {
179 auto r = FLATBUFFERS_BYTESWAP32(*reinterpret_cast<uint32_t *>(&t));
180 return *
reinterpret_cast<T *
>(&r);
181 }
else if (
sizeof(T) == 8) {
182 auto r = FLATBUFFERS_BYTESWAP64(*reinterpret_cast<uint64_t *>(&t));
183 return *
reinterpret_cast<T *
>(&r);
189 template<
typename T> T EndianScalar(T t) {
190 #if FLATBUFFERS_LITTLEENDIAN
193 return EndianSwap(t);
197 template<
typename T> T ReadScalar(
const void *p) {
198 return EndianScalar(*reinterpret_cast<const T *>(p));
201 template<
typename T>
void WriteScalar(
void *p, T t) {
202 *
reinterpret_cast<T *
>(p) = EndianScalar(t);
205 template<
typename T>
size_t AlignOf() {
210 return __alignof__(T);
225 template<
typename T>
struct IndirectHelper {
226 typedef T return_type;
227 typedef T mutable_return_type;
228 static const size_t element_stride =
sizeof(T);
229 static return_type Read(
const uint8_t *p, uoffset_t i) {
230 return EndianScalar((reinterpret_cast<const T *>(p))[i]);
233 template<
typename T>
struct IndirectHelper<Offset<T>> {
234 typedef const T *return_type;
235 typedef T *mutable_return_type;
236 static const size_t element_stride =
sizeof(uoffset_t);
237 static return_type Read(
const uint8_t *p, uoffset_t i) {
238 p += i *
sizeof(uoffset_t);
239 return reinterpret_cast<return_type
>(p + ReadScalar<uoffset_t>(p));
242 template<
typename T>
struct IndirectHelper<const T *> {
243 typedef const T *return_type;
244 typedef T *mutable_return_type;
245 static const size_t element_stride =
sizeof(T);
246 static return_type Read(
const uint8_t *p, uoffset_t i) {
247 return reinterpret_cast<const T *
>(p + i *
sizeof(T));
253 template<
typename T,
typename IT>
254 struct VectorIterator
255 :
public std::iterator<std::random_access_iterator_tag, IT, uoffset_t> {
257 typedef std::iterator<std::random_access_iterator_tag, IT, uoffset_t> super_type;
260 VectorIterator(
const uint8_t *data, uoffset_t i) :
261 data_(data + IndirectHelper<T>::element_stride * i) {}
262 VectorIterator(
const VectorIterator &other) : data_(other.data_) {}
263 #ifndef FLATBUFFERS_CPP98_STL
264 VectorIterator(VectorIterator &&other) : data_(std::move(other.data_)) {}
267 VectorIterator &operator=(
const VectorIterator &other) {
272 VectorIterator &operator=(VectorIterator &&other) {
277 bool operator==(
const VectorIterator &other)
const {
278 return data_ == other.data_;
281 bool operator!=(
const VectorIterator &other)
const {
282 return data_ != other.data_;
285 ptrdiff_t operator-(
const VectorIterator &other)
const {
286 return (data_ - other.data_) / IndirectHelper<T>::element_stride;
289 typename super_type::value_type operator *()
const {
290 return IndirectHelper<T>::Read(data_, 0);
293 typename super_type::value_type operator->()
const {
294 return IndirectHelper<T>::Read(data_, 0);
297 VectorIterator &operator++() {
298 data_ += IndirectHelper<T>::element_stride;
302 VectorIterator operator++(
int) {
303 VectorIterator temp(data_, 0);
304 data_ += IndirectHelper<T>::element_stride;
308 VectorIterator operator+(
const uoffset_t &offset) {
309 return VectorIterator(data_ + offset * IndirectHelper<T>::element_stride, 0);
312 VectorIterator& operator+=(
const uoffset_t &offset) {
313 data_ += offset * IndirectHelper<T>::element_stride;
317 VectorIterator &operator--() {
318 data_ -= IndirectHelper<T>::element_stride;
322 VectorIterator operator--(
int) {
323 VectorIterator temp(data_, 0);
324 data_ -= IndirectHelper<T>::element_stride;
328 VectorIterator operator-(
const uoffset_t &offset) {
329 return VectorIterator(data_ - offset * IndirectHelper<T>::element_stride, 0);
332 VectorIterator& operator-=(
const uoffset_t &offset) {
333 data_ -= offset * IndirectHelper<T>::element_stride;
338 const uint8_t *data_;
343 template<
typename T>
class Vector {
345 typedef VectorIterator<T, typename IndirectHelper<T>::mutable_return_type>
347 typedef VectorIterator<T, typename IndirectHelper<T>::return_type>
350 uoffset_t size()
const {
return EndianScalar(length_); }
353 uoffset_t Length()
const {
return size(); }
355 typedef typename IndirectHelper<T>::return_type return_type;
356 typedef typename IndirectHelper<T>::mutable_return_type mutable_return_type;
358 return_type Get(uoffset_t i)
const {
360 return IndirectHelper<T>::Read(Data(), i);
363 return_type operator[](uoffset_t i)
const {
return Get(i); }
368 template<
typename E> E GetEnum(uoffset_t i)
const {
369 return static_cast<E
>(Get(i));
372 const void *GetStructFromOffset(
size_t o)
const {
373 return reinterpret_cast<const void *
>(Data() + o);
376 iterator begin() {
return iterator(Data(), 0); }
377 const_iterator begin()
const {
return const_iterator(Data(), 0); }
379 iterator end() {
return iterator(Data(), size()); }
380 const_iterator end()
const {
return const_iterator(Data(), size()); }
384 void Mutate(uoffset_t i,
const T& val) {
386 WriteScalar(data() + i, val);
392 void MutateOffset(uoffset_t i,
const uint8_t *val) {
394 assert(
sizeof(T) ==
sizeof(uoffset_t));
395 WriteScalar(data() + i,
396 static_cast<uoffset_t>(val - (Data() + i *
sizeof(uoffset_t))));
400 mutable_return_type GetMutableObject(uoffset_t i)
const {
402 return const_cast<mutable_return_type
>(IndirectHelper<T>::Read(Data(), i));
406 const uint8_t *Data()
const {
407 return reinterpret_cast<const uint8_t *
>(&length_ + 1);
411 return reinterpret_cast<uint8_t *
>(&length_ + 1);
415 const T *data()
const {
return reinterpret_cast<const T *
>(Data()); }
416 T *data() {
return reinterpret_cast<T *
>(Data()); }
418 template<
typename K> return_type LookupByKey(K key)
const {
419 void *search_result = std::bsearch(&key, Data(), size(),
420 IndirectHelper<T>::element_stride, KeyCompare<K>);
422 if (!search_result) {
426 const uint8_t *element =
reinterpret_cast<const uint8_t *
>(search_result);
428 return IndirectHelper<T>::Read(element, 0);
439 template<
typename K>
static int KeyCompare(
const void *ap,
const void *bp) {
440 const K *key =
reinterpret_cast<const K *
>(ap);
441 const uint8_t *data =
reinterpret_cast<const uint8_t *
>(bp);
442 auto table = IndirectHelper<T>::Read(data, 0);
446 return -table->KeyCompareWithValue(*key);
454 uoffset_t size()
const {
return EndianScalar(length_); }
456 const uint8_t *Data()
const {
457 return reinterpret_cast<const uint8_t *
>(&length_ + 1);
460 return reinterpret_cast<uint8_t *
>(&length_ + 1);
470 template<
typename T>
static inline size_t VectorLength(
const Vector<T> *v) {
471 return v ? v->Length() : 0;
474 struct String :
public Vector<char> {
475 const char *c_str()
const {
return reinterpret_cast<const char *
>(Data()); }
476 std::string str()
const {
return std::string(c_str(), Length()); }
478 bool operator <(
const String &o)
const {
479 return strcmp(c_str(), o.c_str()) < 0;
485 class simple_allocator {
487 virtual ~simple_allocator() {}
488 virtual uint8_t *allocate(
size_t size)
const {
return new uint8_t[size]; }
489 virtual void deallocate(uint8_t *p)
const {
delete[] p; }
495 class vector_downward {
497 explicit vector_downward(
size_t initial_size,
498 const simple_allocator &allocator)
499 : reserved_(initial_size),
500 buf_(allocator.allocate(reserved_)),
501 cur_(buf_ + reserved_),
502 allocator_(allocator) {
503 assert((initial_size & (
sizeof(largest_scalar_t) - 1)) == 0);
508 allocator_.deallocate(buf_);
513 buf_ = allocator_.allocate(reserved_);
515 cur_ = buf_ + reserved_;
518 #ifndef FLATBUFFERS_CPP98_STL
520 unique_ptr_t release() {
522 std::function<void(uint8_t *)> deleter(
523 std::bind(&simple_allocator::deallocate, allocator_, buf_));
526 unique_ptr_t retval(data(), deleter);
536 size_t growth_policy(
size_t bytes) {
537 return (bytes / 2) & ~(
sizeof(largest_scalar_t) - 1);
540 uint8_t *make_space(
size_t len) {
541 if (len > static_cast<size_t>(cur_ - buf_)) {
542 auto old_size = size();
543 auto largest_align = AlignOf<largest_scalar_t>();
544 reserved_ += (std::max)(len, growth_policy(reserved_));
546 reserved_ = (reserved_ + (largest_align - 1)) & ~(largest_align - 1);
547 auto new_buf = allocator_.allocate(reserved_);
548 auto new_cur = new_buf + reserved_ - old_size;
549 memcpy(new_cur, cur_, old_size);
551 allocator_.deallocate(buf_);
557 assert(size() < FLATBUFFERS_MAX_BUFFER_SIZE);
561 uoffset_t size()
const {
562 assert(cur_ !=
nullptr && buf_ !=
nullptr);
563 return static_cast<uoffset_t
>(reserved_ - (cur_ - buf_));
566 uint8_t *data()
const {
567 assert(cur_ !=
nullptr);
571 uint8_t *data_at(
size_t offset)
const {
return buf_ + reserved_ - offset; }
575 void push(
const uint8_t *bytes,
size_t num) {
576 auto dest = make_space(num);
577 for (
size_t i = 0; i < num; i++) dest[i] = bytes[i];
580 void fill(
size_t zero_pad_bytes) {
581 auto dest = make_space(zero_pad_bytes);
582 for (
size_t i = 0; i < zero_pad_bytes; i++) dest[i] = 0;
585 void pop(
size_t bytes_to_remove) { cur_ += bytes_to_remove; }
589 vector_downward(
const vector_downward &);
590 vector_downward &operator=(
const vector_downward &);
595 const simple_allocator &allocator_;
599 inline voffset_t FieldIndexToOffset(voffset_t field_id) {
601 const int fixed_fields = 2;
602 return static_cast<voffset_t
>((field_id + fixed_fields) *
sizeof(voffset_t));
608 inline size_t PaddingBytes(
size_t buf_size,
size_t scalar_size) {
609 return ((~buf_size) + 1) & (scalar_size - 1);
612 template <
typename T>
const T* data(
const std::vector<T> &v) {
613 return v.empty() ?
nullptr : &v.front();
615 template <
typename T> T* data(std::vector<T> &v) {
616 return v.empty() ?
nullptr : &v.front();
632 FLATBUFFERS_FINAL_CLASS
643 const simple_allocator *allocator =
nullptr)
644 : buf_(initial_size, allocator ? *allocator : default_allocator),
645 nested(false), finished(false), minalign_(1), force_defaults_(false),
646 string_pool(nullptr) {
647 offsetbuf_.reserve(16);
648 vtables_.reserve(16);
653 if (string_pool)
delete string_pool;
665 if (string_pool) string_pool->clear();
670 uoffset_t
GetSize()
const {
return buf_.size(); }
684 #ifndef FLATBUFFERS_CPP98_STL
693 return buf_.release();
708 void Finished()
const {
724 void Pad(
size_t num_bytes) { buf_.fill(num_bytes); }
726 void Align(
size_t elem_size) {
727 if (elem_size > minalign_) minalign_ = elem_size;
728 buf_.fill(PaddingBytes(buf_.size(), elem_size));
731 void PushFlatBuffer(
const uint8_t *bytes,
size_t size) {
732 PushBytes(bytes, size);
736 void PushBytes(
const uint8_t *bytes,
size_t size) {
737 buf_.push(bytes, size);
740 void PopBytes(
size_t amount) { buf_.pop(amount); }
742 template<
typename T>
void AssertScalarT() {
743 #ifndef FLATBUFFERS_CPP98_STL
745 static_assert(std::is_scalar<T>::value
747 ||
sizeof(T) ==
sizeof(Offset<void>),
748 "T must be a scalar type");
753 template<
typename T> uoffset_t PushElement(T element) {
755 T litle_endian_element = EndianScalar(element);
757 PushBytes(reinterpret_cast<uint8_t *>(&litle_endian_element),
sizeof(T));
761 template<
typename T> uoffset_t PushElement(Offset<T> off) {
763 return PushElement(ReferTo(off.o));
768 void TrackField(voffset_t field, uoffset_t off) {
769 FieldLoc fl = { off, field };
770 offsetbuf_.push_back(fl);
774 template<
typename T>
void AddElement(voffset_t field, T e, T def) {
776 if (e == def && !force_defaults_)
return;
777 auto off = PushElement(e);
778 TrackField(field, off);
781 template<
typename T>
void AddOffset(voffset_t field, Offset<T> off) {
783 AddElement(field, ReferTo(off.o), static_cast<uoffset_t>(0));
786 template<
typename T>
void AddStruct(voffset_t field,
const T *structptr) {
787 if (!structptr)
return;
789 PushBytes(reinterpret_cast<const uint8_t *>(structptr),
sizeof(T));
793 void AddStructOffset(voffset_t field, uoffset_t off) {
794 TrackField(field, off);
800 uoffset_t ReferTo(uoffset_t off) {
802 Align(
sizeof(uoffset_t));
804 assert(off && off <=
GetSize());
805 return GetSize() - off +
static_cast<uoffset_t
>(
sizeof(uoffset_t));
822 uoffset_t StartTable() {
831 uoffset_t EndTable(uoffset_t start, voffset_t numfields) {
836 auto vtableoffsetloc = PushElement<soffset_t>(0);
840 buf_.fill(numfields *
sizeof(voffset_t));
841 auto table_object_size = vtableoffsetloc - start;
842 assert(table_object_size < 0x10000);
843 PushElement<voffset_t>(
static_cast<voffset_t
>(table_object_size));
844 PushElement<voffset_t>(FieldIndexToOffset(numfields));
846 for (
auto field_location = offsetbuf_.begin();
847 field_location != offsetbuf_.end();
849 auto pos =
static_cast<voffset_t
>(vtableoffsetloc - field_location->off);
851 assert(!ReadScalar<voffset_t>(buf_.data() + field_location->id));
852 WriteScalar<voffset_t>(buf_.data() + field_location->id, pos);
855 auto vt1 =
reinterpret_cast<voffset_t *
>(buf_.data());
856 auto vt1_size = ReadScalar<voffset_t>(vt1);
860 for (
auto it = vtables_.begin(); it != vtables_.end(); ++it) {
861 auto vt2 =
reinterpret_cast<voffset_t *
>(buf_.data_at(*it));
862 auto vt2_size = *vt2;
863 if (vt1_size != vt2_size || memcmp(vt2, vt1, vt1_size))
continue;
865 buf_.pop(
GetSize() - vtableoffsetloc);
870 vtables_.push_back(vt_use);
877 WriteScalar(buf_.data_at(vtableoffsetloc),
878 static_cast<soffset_t
>(vt_use) -
879 static_cast<soffset_t>(vtableoffsetloc));
882 return vtableoffsetloc;
887 template<
typename T>
void Required(Offset<T> table, voffset_t field) {
888 auto table_ptr = buf_.data_at(table.o);
889 auto vtable_ptr = table_ptr - ReadScalar<soffset_t>(table_ptr);
890 bool ok = ReadScalar<voffset_t>(vtable_ptr + field) != 0;
896 uoffset_t StartStruct(
size_t alignment) {
901 uoffset_t EndStruct() {
return GetSize(); }
903 void ClearOffsets() { offsetbuf_.clear(); }
907 void PreAlign(
size_t len,
size_t alignment) {
908 buf_.fill(PaddingBytes(
GetSize() + len, alignment));
910 template<
typename T>
void PreAlign(
size_t len) {
912 PreAlign(len,
sizeof(T));
922 PreAlign<uoffset_t>(len + 1);
924 PushBytes(reinterpret_cast<const uint8_t *>(str), len);
925 PushElement(static_cast<uoffset_t>(len));
926 return Offset<String>(
GetSize());
947 return str ?
CreateString(str->c_str(), str->Length()) : 0;
958 string_pool =
new StringOffsetMap(StringOffsetCompare(buf_));
959 auto size_before_string = buf_.size();
963 auto it = string_pool->find(off);
965 if (it != string_pool->end()) {
967 buf_.pop(buf_.size() - size_before_string);
971 string_pool->insert(off);
1003 uoffset_t EndVector(
size_t len) {
1006 return PushElement(static_cast<uoffset_t>(len));
1009 void StartVector(
size_t len,
size_t elemsize) {
1012 PreAlign<uoffset_t>(len * elemsize);
1013 PreAlign(len * elemsize, elemsize);
1021 void ForceVectorAlignment(
size_t len,
size_t elemsize,
size_t alignment) {
1022 PreAlign(len * elemsize, alignment);
1025 uint8_t *ReserveElements(
size_t len,
size_t elemsize) {
1026 return buf_.make_space(len * elemsize);
1037 template<
typename T> Offset<Vector<T>>
CreateVector(
const T *v,
size_t len) {
1038 StartVector(len,
sizeof(T));
1039 for (
auto i = len; i > 0; ) {
1040 PushElement(v[--i]);
1042 return Offset<Vector<T>>(EndVector(len));
1051 template<
typename T> Offset<Vector<T>>
CreateVector(
const std::vector<T> &v) {
1058 Offset<Vector<uint8_t>>
CreateVector(
const std::vector<bool> &v) {
1059 StartVector(v.size(),
sizeof(uint8_t));
1060 for (
auto i = v.size(); i > 0; ) {
1061 PushElement(static_cast<uint8_t>(v[--i]));
1063 return Offset<Vector<uint8_t>>(EndVector(v.size()));
1066 #ifndef FLATBUFFERS_CPP98_STL
1075 const std::function<T (
size_t i)> &f) {
1076 std::vector<T> elems(vector_size);
1077 for (
size_t i = 0; i < vector_size; i++) elems[i] = f(i);
1089 const std::vector<std::string> &v) {
1090 std::vector<Offset<String>> offsets(v.size());
1091 for (
size_t i = 0; i < v.size(); i++) offsets[i] =
CreateString(v[i]);
1103 const T *v,
size_t len) {
1104 StartVector(len *
sizeof(T) / AlignOf<T>(), AlignOf<T>());
1105 PushBytes(reinterpret_cast<const uint8_t *>(v),
sizeof(T) * len);
1106 return Offset<Vector<const T *>>(EndVector(len));
1116 const std::vector<T> &v) {
1121 template<
typename T>
1122 struct TableKeyComparator {
1123 TableKeyComparator(vector_downward& buf) : buf_(buf) {}
1124 bool operator()(
const Offset<T> &a,
const Offset<T> &b)
const {
1125 auto table_a =
reinterpret_cast<T *
>(buf_.data_at(a.o));
1126 auto table_b =
reinterpret_cast<T *
>(buf_.data_at(b.o));
1127 return table_a->KeyCompareLessThan(table_b);
1129 vector_downward& buf_;
1132 TableKeyComparator& operator= (
const TableKeyComparator&);
1145 Offset<T> *v,
size_t len) {
1146 std::sort(v, v + len, TableKeyComparator<T>(buf_));
1158 std::vector<Offset<T>> *v) {
1172 StartVector(len, elemsize);
1173 buf_.make_space(len * elemsize);
1175 auto vec_end = EndVector(len);
1176 *buf = buf_.data_at(vec_start);
1189 size_t len, T **buf) {
1191 reinterpret_cast<uint8_t **>(buf));
1200 template<
typename T>
void Finish(Offset<T> root,
1201 const char *file_identifier =
nullptr) {
1203 Finish(root.o, file_identifier,
false);
1214 const char *file_identifier =
nullptr) {
1215 Finish(root.o, file_identifier,
true);
1223 void Finish(uoffset_t root,
const char *file_identifier,
bool size_prefix) {
1226 PreAlign((size_prefix ?
sizeof(uoffset_t) : 0) +
1230 if (file_identifier) {
1232 buf_.push(reinterpret_cast<const uint8_t *>(file_identifier),
1235 PushElement(ReferTo(root));
1247 simple_allocator default_allocator;
1249 vector_downward buf_;
1252 std::vector<FieldLoc> offsetbuf_;
1260 std::vector<uoffset_t> vtables_;
1264 bool force_defaults_;
1266 struct StringOffsetCompare {
1267 StringOffsetCompare(
const vector_downward &buf) : buf_(&buf) {}
1268 bool operator() (
const Offset<String> &a,
const Offset<String> &b)
const {
1269 auto stra =
reinterpret_cast<const String *
>(buf_->data_at(a.o));
1270 auto strb =
reinterpret_cast<const String *
>(buf_->data_at(b.o));
1271 return strncmp(stra->c_str(), strb->c_str(),
1272 std::min(stra->size(), strb->size()) + 1) < 0;
1274 const vector_downward *buf_;
1278 typedef std::set<Offset<String>, StringOffsetCompare> StringOffsetMap;
1279 StringOffsetMap *string_pool;
1285 template<
typename T> T *GetMutableRoot(
void *buf) {
1287 return reinterpret_cast<T *
>(
reinterpret_cast<uint8_t *
>(buf) +
1288 EndianScalar(*reinterpret_cast<uoffset_t *>(buf)));
1291 template<
typename T>
const T *GetRoot(
const void *buf) {
1292 return GetMutableRoot<T>(
const_cast<void *
>(buf));
1295 template<
typename T>
const T *GetSizePrefixedRoot(
const void *buf) {
1296 return GetRoot<T>(
reinterpret_cast<const uint8_t *
>(buf) +
sizeof(uoffset_t));
1302 template<
typename T> T *GetMutableTemporaryPointer(FlatBufferBuilder &fbb,
1304 return reinterpret_cast<T *
>(fbb.GetCurrentBufferPointer() +
1305 fbb.GetSize() - offset.o);
1308 template<
typename T>
const T *GetTemporaryPointer(FlatBufferBuilder &fbb,
1310 return GetMutableTemporaryPointer<T>(fbb, offset);
1314 inline bool BufferHasIdentifier(
const void *buf,
const char *identifier) {
1315 return strncmp(reinterpret_cast<const char *>(buf) +
sizeof(uoffset_t),
1320 class Verifier FLATBUFFERS_FINAL_CLASS {
1322 Verifier(
const uint8_t *buf,
size_t buf_len,
size_t _max_depth = 64,
1323 size_t _max_tables = 1000000)
1324 : buf_(buf), end_(buf + buf_len), depth_(0), max_depth_(_max_depth),
1325 num_tables_(0), max_tables_(_max_tables)
1326 #ifdef FLATBUFFERS_TRACK_VERIFIER_BUFFER_SIZE
1332 bool Check(
bool ok)
const {
1333 #ifdef FLATBUFFERS_DEBUG_VERIFICATION_FAILURE
1336 #ifdef FLATBUFFERS_TRACK_VERIFIER_BUFFER_SIZE
1338 upper_bound_ = buf_;
1344 bool Verify(
const void *elem,
size_t elem_len)
const {
1345 #ifdef FLATBUFFERS_TRACK_VERIFIER_BUFFER_SIZE
1346 auto upper_bound =
reinterpret_cast<const uint8_t *
>(elem) + elem_len;
1347 if (upper_bound_ < upper_bound)
1348 upper_bound_ = upper_bound;
1350 return Check(elem_len <= (
size_t) (end_ - buf_) &&
1352 elem <= end_ - elem_len);
1356 template<
typename T>
bool Verify(
const void *elem)
const {
1357 return Verify(elem,
sizeof(T));
1361 template<
typename T>
bool VerifyTable(
const T *table) {
1362 return !table || table->Verify(*
this);
1366 template<
typename T>
bool Verify(
const Vector<T> *vec)
const {
1369 VerifyVector(reinterpret_cast<const uint8_t *>(vec),
sizeof(T),
1374 template<
typename T>
bool Verify(
const Vector<const T *> *vec)
const {
1375 return Verify(
reinterpret_cast<const Vector<T> *
>(vec));
1379 bool Verify(
const String *str)
const {
1382 (VerifyVector(reinterpret_cast<const uint8_t *>(str), 1, &end) &&
1384 Check(*end ==
'\0'));
1388 bool VerifyVector(
const uint8_t *vec,
size_t elem_size,
1389 const uint8_t **end)
const {
1391 if (!Verify<uoffset_t>(vec))
return false;
1394 auto size = ReadScalar<uoffset_t>(vec);
1395 auto max_elems = FLATBUFFERS_MAX_BUFFER_SIZE / elem_size;
1396 if (!Check(size < max_elems))
1398 auto byte_size =
sizeof(size) + elem_size * size;
1399 *end = vec + byte_size;
1400 return Verify(vec, byte_size);
1404 bool VerifyVectorOfStrings(
const Vector<Offset<String>> *vec)
const {
1406 for (uoffset_t i = 0; i < vec->size(); i++) {
1407 if (!Verify(vec->Get(i)))
return false;
1414 template<
typename T>
bool VerifyVectorOfTables(
const Vector<Offset<T>> *vec) {
1416 for (uoffset_t i = 0; i < vec->size(); i++) {
1417 if (!vec->Get(i)->Verify(*
this))
return false;
1423 template<
typename T>
bool VerifyBufferFromStart(
const char *identifier,
1424 const uint8_t *start) {
1426 (
size_t(end_ - start) < 2 *
sizeof(flatbuffers::uoffset_t) ||
1427 !BufferHasIdentifier(start, identifier))) {
1432 return Verify<uoffset_t>(start) &&
1433 reinterpret_cast<const T *>(start + ReadScalar<uoffset_t>(start))->
1435 #ifdef FLATBUFFERS_TRACK_VERIFIER_BUFFER_SIZE
1436 && GetComputedSize()
1442 template<
typename T>
bool VerifyBuffer(
const char *identifier) {
1443 return VerifyBufferFromStart<T>(identifier, buf_);
1446 template<
typename T>
bool VerifySizePrefixedBuffer(
const char *identifier) {
1447 return Verify<uoffset_t>(buf_) &&
1448 ReadScalar<uoffset_t>(buf_) == end_ - buf_ -
sizeof(uoffset_t) &&
1449 VerifyBufferFromStart<T>(identifier, buf_ +
sizeof(uoffset_t));
1456 bool VerifyComplexity() {
1459 return Check(depth_ <= max_depth_ && num_tables_ <= max_tables_);
1468 #ifdef FLATBUFFERS_TRACK_VERIFIER_BUFFER_SIZE
1470 size_t GetComputedSize()
const {
1471 uintptr_t size = upper_bound_ - buf_;
1473 size = (size - 1 +
sizeof(uoffset_t)) & ~(
sizeof(uoffset_t) - 1);
1474 return (buf_ + size > end_) ? 0 : size;
1479 const uint8_t *buf_;
1480 const uint8_t *end_;
1485 #ifdef FLATBUFFERS_TRACK_VERIFIER_BUFFER_SIZE
1486 mutable const uint8_t *upper_bound_;
1493 struct BufferRefBase {};
1494 template<
typename T>
struct BufferRef : BufferRefBase {
1495 BufferRef() : buf(nullptr), len(0), must_free(false) {}
1496 BufferRef(uint8_t *_buf, uoffset_t _len)
1497 : buf(_buf), len(_len), must_free(false) {}
1499 ~BufferRef() {
if (must_free) free(buf); }
1501 const T *GetRoot()
const {
return flatbuffers::GetRoot<T>(buf); }
1504 Verifier verifier(buf, len);
1505 return verifier.VerifyBuffer<T>(
nullptr);
1517 class Struct FLATBUFFERS_FINAL_CLASS {
1519 template<
typename T> T GetField(uoffset_t o)
const {
1520 return ReadScalar<T>(&data_[o]);
1523 template<
typename T> T GetStruct(uoffset_t o)
const {
1524 return reinterpret_cast<T
>(&data_[o]);
1527 const uint8_t *GetAddressOf(uoffset_t o)
const {
return &data_[o]; }
1528 uint8_t *GetAddressOf(uoffset_t o) {
return &data_[o]; }
1538 const uint8_t *GetVTable()
const {
1539 return data_ - ReadScalar<soffset_t>(data_);
1544 voffset_t GetOptionalFieldOffset(voffset_t field)
const {
1546 auto vtable = GetVTable();
1548 auto vtsize = ReadScalar<voffset_t>(vtable);
1551 return field < vtsize ? ReadScalar<voffset_t>(vtable + field) : 0;
1554 template<
typename T> T GetField(voffset_t field, T defaultval)
const {
1555 auto field_offset = GetOptionalFieldOffset(field);
1556 return field_offset ? ReadScalar<T>(data_ + field_offset) : defaultval;
1559 template<
typename P> P GetPointer(voffset_t field) {
1560 auto field_offset = GetOptionalFieldOffset(field);
1561 auto p = data_ + field_offset;
1563 ?
reinterpret_cast<P
>(p + ReadScalar<uoffset_t>(p))
1566 template<
typename P> P GetPointer(voffset_t field)
const {
1567 return const_cast<Table *
>(
this)->GetPointer<P>(field);
1570 template<
typename P> P GetStruct(voffset_t field)
const {
1571 auto field_offset = GetOptionalFieldOffset(field);
1572 auto p =
const_cast<uint8_t *
>(data_ + field_offset);
1573 return field_offset ?
reinterpret_cast<P
>(p) :
nullptr;
1576 template<
typename T>
bool SetField(voffset_t field, T val) {
1577 auto field_offset = GetOptionalFieldOffset(field);
1578 if (!field_offset)
return false;
1579 WriteScalar(data_ + field_offset, val);
1583 bool SetPointer(voffset_t field,
const uint8_t *val) {
1584 auto field_offset = GetOptionalFieldOffset(field);
1585 if (!field_offset)
return false;
1586 WriteScalar(data_ + field_offset,
1587 static_cast<uoffset_t>(val - (data_ + field_offset)));
1591 uint8_t *GetAddressOf(voffset_t field) {
1592 auto field_offset = GetOptionalFieldOffset(field);
1593 return field_offset ? data_ + field_offset :
nullptr;
1595 const uint8_t *GetAddressOf(voffset_t field)
const {
1596 return const_cast<Table *
>(
this)->GetAddressOf(field);
1599 bool CheckField(voffset_t field)
const {
1600 return GetOptionalFieldOffset(field) != 0;
1605 bool VerifyTableStart(Verifier &verifier)
const {
1607 if (!verifier.Verify<soffset_t>(data_))
return false;
1608 auto vtable = GetVTable();
1610 return verifier.VerifyComplexity() &&
1611 verifier.Verify<voffset_t>(vtable) &&
1612 (ReadScalar<voffset_t>(vtable) & (
sizeof(voffset_t) - 1)) == 0 &&
1613 verifier.Verify(vtable, ReadScalar<voffset_t>(vtable));
1617 template<
typename T>
bool VerifyField(
const Verifier &verifier,
1618 voffset_t field)
const {
1621 auto field_offset = GetOptionalFieldOffset(field);
1623 return !field_offset || verifier.Verify<T>(data_ + field_offset);
1627 template<
typename T>
bool VerifyFieldRequired(
const Verifier &verifier,
1628 voffset_t field)
const {
1629 auto field_offset = GetOptionalFieldOffset(field);
1630 return verifier.Check(field_offset != 0) &&
1631 verifier.Verify<T>(data_ + field_offset);
1638 Table(
const Table &other);
1647 inline const uint8_t *GetBufferStartFromRootPointer(
const void *root) {
1648 auto table =
reinterpret_cast<const Table *
>(root);
1649 auto vtable = table->GetVTable();
1651 auto start = std::min(vtable, reinterpret_cast<const uint8_t *>(root));
1653 start =
reinterpret_cast<const uint8_t *
>(
1654 reinterpret_cast<uintptr_t
>(start) & ~(
sizeof(uoffset_t) - 1));
1665 "file_identifier is assumed to be the same size as uoffset_t");
1666 for (
auto possible_roots = FLATBUFFERS_MAX_ALIGNMENT /
sizeof(uoffset_t) + 1;
1669 start -=
sizeof(uoffset_t);
1670 if (ReadScalar<uoffset_t>(start) + start ==
1671 reinterpret_cast<const uint8_t *
>(root))
return start;
1684 struct NativeTable {
1695 typedef uint64_t hash_value_t;
1696 #ifdef FLATBUFFERS_CPP98_STL
1697 typedef void (*resolver_function_t)(
void **pointer_adr, hash_value_t hash);
1698 typedef hash_value_t (*rehasher_function_t)(
void *pointer);
1700 typedef std::function<void (void **pointer_adr, hash_value_t hash)>
1701 resolver_function_t;
1702 typedef std::function<hash_value_t (void *pointer)> rehasher_function_t;
1712 template<
typename T>
bool IsFieldPresent(
const T *table, voffset_t field) {
1714 return reinterpret_cast<const Table *
>(table)->CheckField(field);
1720 inline int LookupEnum(
const char **names,
const char *name) {
1721 for (
const char **p = names; *p; p++)
1722 if (!strcmp(*p, name))
1723 return static_cast<int>(p - names);
1737 #if defined(_MSC_VER)
1738 #define MANUALLY_ALIGNED_STRUCT(alignment) \
1739 __pragma(pack(1)); \
1740 struct __declspec(align(alignment))
1741 #define STRUCT_END(name, size) \
1743 static_assert(sizeof(name) == size, "compiler breaks packing rules")
1744 #elif defined(__GNUC__) || defined(__clang__)
1745 #define MANUALLY_ALIGNED_STRUCT(alignment) \
1746 _Pragma("pack(1)") \
1747 struct __attribute__((aligned(alignment)))
1748 #define STRUCT_END(name, size) \
1750 static_assert(sizeof(name) == size, "compiler breaks packing rules")
1752 #error Unknown compiler, please define structure alignment macros
1765 #if !defined(_WIN32) && !defined(__CYGWIN__)
1767 extern volatile __attribute__((weak)) const
char *flatbuffer_version_string;
1768 volatile __attribute__((weak)) const
char *flatbuffer_version_string =
1770 FLATBUFFERS_STRING(FLATBUFFERS_VERSION_MAJOR) "."
1771 FLATBUFFERS_STRING(FLATBUFFERS_VERSION_MINOR) "."
1772 FLATBUFFERS_STRING(FLATBUFFERS_VERSION_REVISION);
1774 #endif // !defined(_WIN32) && !defined(__CYGWIN__)
1776 #define DEFINE_BITMASK_OPERATORS(E, T)\
1777 inline E operator | (E lhs, E rhs){\
1778 return E(T(lhs) | T(rhs));\
1780 inline E operator & (E lhs, E rhs){\
1781 return E(T(lhs) & T(rhs));\
1783 inline E operator ^ (E lhs, E rhs){\
1784 return E(T(lhs) ^ T(rhs));\
1786 inline E operator ~ (E lhs){\
1789 inline E operator |= (E &lhs, E rhs){\
1793 inline E operator &= (E &lhs, E rhs){\
1797 inline E operator ^= (E &lhs, E rhs){\
1801 inline bool operator !(E rhs) \
1803 return !bool(T(rhs)); \
1808 #endif // FLATBUFFERS_H_
Offset< Vector< T > > CreateVector(size_t vector_size, const std::function< T(size_t i)> &f)
Serialize values returned by a function into a FlatBuffer vector.
Definition: flatbuffers.h:1074
uoffset_t CreateUninitializedVector(size_t len, size_t elemsize, uint8_t **buf)
Specialized version of CreateVector for non-copying use cases.
Definition: flatbuffers.h:1169
Offset< Vector< Offset< T > > > CreateVectorOfSortedTables(std::vector< Offset< T >> *v)
Serialize an array of table offsets as a vector in the buffer in sorted order.
Definition: flatbuffers.h:1157
Helper class to hold data needed in creation of a FlatBuffer.
Definition: flatbuffers.h:630
uoffset_t GetSize() const
The current size of the serialized buffer, counting from the end.
Definition: flatbuffers.h:670
FlatBufferBuilder(uoffset_t initial_size=1024, const simple_allocator *allocator=nullptr)
Default constructor for FlatBufferBuilder.
Definition: flatbuffers.h:642
void Clear()
Reset all the state in this FlatBufferBuilder so it can be reused to construct another buffer...
Definition: flatbuffers.h:658
unique_ptr_t ReleaseBufferPointer()
Get the released pointer to the serialized buffer.
Definition: flatbuffers.h:691
void FinishSizePrefixed(Offset< T > root, const char *file_identifier=nullptr)
Finish a buffer with a 32 bit size field pre-fixed (size of the buffer following the size field)...
Definition: flatbuffers.h:1213
Offset< String > CreateSharedString(const char *str)
Store a string in the buffer, which null-terminated.
Definition: flatbuffers.h:980
Offset< String > CreateString(const char *str, size_t len)
Store a string in the buffer, which can contain any binary data.
Definition: flatbuffers.h:920
void ForceDefaults(bool fd)
In order to save space, fields that are set to their default value don't get serialized into the buff...
Definition: flatbuffers.h:721
static const size_t kFileIdentifierLength
The length of a FlatBuffer file header.
Definition: flatbuffers.h:1195
Offset< String > CreateString(const String *str)
Store a string in the buffer, which can contain any binary data.
Definition: flatbuffers.h:946
Offset< String > CreateSharedString(const String *str)
Store a string in the buffer, which can contain any binary data.
Definition: flatbuffers.h:998
Offset< Vector< Offset< String > > > CreateVectorOfStrings(const std::vector< std::string > &v)
Serialize a std::vector into a FlatBuffer vector.
Definition: flatbuffers.h:1088
size_t GetBufferMinAlignment()
get the minimum alignment this buffer needs to be accessed properly.
Definition: flatbuffers.h:702
Offset< Vector< const T * > > CreateVectorOfStructs(const T *v, size_t len)
Serialize an array of structs into a FlatBuffer vector.
Definition: flatbuffers.h:1102
Offset< String > CreateString(const char *str)
Store a string in the buffer, which is null-terminated.
Definition: flatbuffers.h:932
Offset< String > CreateString(const std::string &str)
Store a string in the buffer, which can contain any binary data.
Definition: flatbuffers.h:939
Offset< Vector< T > > CreateVector(const std::vector< T > &v)
Serialize a std::vector into a FlatBuffer vector.
Definition: flatbuffers.h:1051
Offset< Vector< T > > CreateUninitializedVector(size_t len, T **buf)
Specialized version of CreateVector for non-copying use cases.
Definition: flatbuffers.h:1188
uint8_t * GetCurrentBufferPointer() const
Get a pointer to an unfinished buffer.
Definition: flatbuffers.h:682
Offset< Vector< T > > CreateVector(const T *v, size_t len)
Serialize an array into a FlatBuffer vector.
Definition: flatbuffers.h:1037
Offset< String > CreateSharedString(const std::string &str)
Store a string in the buffer, which can contain any binary data.
Definition: flatbuffers.h:989
Offset< Vector< Offset< T > > > CreateVectorOfSortedTables(Offset< T > *v, size_t len)
Serialize an array of table offsets as a vector in the buffer in sorted order.
Definition: flatbuffers.h:1144
Offset< String > CreateSharedString(const char *str, size_t len)
Store a string in the buffer, which can contain any binary data.
Definition: flatbuffers.h:956
Offset< Vector< const T * > > CreateVectorOfStructs(const std::vector< T > &v)
Serialize a std::vector of structs into a FlatBuffer vector.
Definition: flatbuffers.h:1115
void Finish(Offset< T > root, const char *file_identifier=nullptr)
Finish serializing a buffer by writing the root offset.
Definition: flatbuffers.h:1200
uint8_t * GetBufferPointer() const
Get the serialized buffer (after you call Finish()).
Definition: flatbuffers.h:675