diff --git a/0001-generate-gcc-pragmas-to-ignore-Wclass-memaccess.patch b/0001-generate-gcc-pragmas-to-ignore-Wclass-memaccess.patch new file mode 100644 index 0000000000000000000000000000000000000000..f56ec5fddf603146146795582ed575befa68a150 --- /dev/null +++ b/0001-generate-gcc-pragmas-to-ignore-Wclass-memaccess.patch @@ -0,0 +1,156 @@ +From c80316a3efc9244af035e1ebfe2b4df15d691c96 Mon Sep 17 00:00:00 2001 +From: Sergey Avseyev +Date: Thu, 10 Jan 2019 07:37:09 +0300 +Subject: [PATCH] generate gcc pragmas to ignore -Wclass-memaccess + +--- + samples/monster_generated.h | 7 +++++++ + src/idl_gen_cpp.cpp | 7 +++++++ + tests/monster_test_generated.h | 21 +++++++++++++++++++ + .../namespace_test1_generated.h | 7 +++++++ + tests/union_vector/union_vector_generated.h | 14 +++++++++++++ + 5 files changed, 56 insertions(+) + +diff --git a/samples/monster_generated.h b/samples/monster_generated.h +index 5ac4be3..ae1fd04 100644 +--- a/samples/monster_generated.h ++++ b/samples/monster_generated.h +@@ -164,7 +164,14 @@ FLATBUFFERS_MANUALLY_ALIGNED_STRUCT(4) Vec3 FLATBUFFERS_FINAL_CLASS { + + public: + Vec3() { ++#if defined(__GNUC__) ++#pragma GCC diagnostic push ++#pragma GCC diagnostic ignored "-Wclass-memaccess" ++#endif + memset(this, 0, sizeof(Vec3)); ++#if defined(__GNUC__) ++#pragma GCC diagnostic pop ++#endif + } + Vec3(float _x, float _y, float _z) + : x_(flatbuffers::EndianScalar(_x)), +diff --git a/src/idl_gen_cpp.cpp b/src/idl_gen_cpp.cpp +index a0abfdd..8d35673 100644 +--- a/src/idl_gen_cpp.cpp ++++ b/src/idl_gen_cpp.cpp +@@ -2585,7 +2585,14 @@ class CppGenerator : public BaseGenerator { + + // Generate a default constructor. + code_ += " {{STRUCT_NAME}}() {"; ++ code_ += "#if defined(__GNUC__)"; ++ code_ += "#pragma GCC diagnostic push"; ++ code_ += "#pragma GCC diagnostic ignored \"-Wclass-memaccess\""; ++ code_ += "#endif"; + code_ += " memset(this, 0, sizeof({{STRUCT_NAME}}));"; ++ code_ += "#if defined(__GNUC__)"; ++ code_ += "#pragma GCC diagnostic pop"; ++ code_ += "#endif"; + code_ += " }"; + + // Generate a constructor that takes all fields as arguments. +diff --git a/tests/monster_test_generated.h b/tests/monster_test_generated.h +index 0f5e252..4b0aa9f 100644 +--- a/tests/monster_test_generated.h ++++ b/tests/monster_test_generated.h +@@ -269,7 +269,14 @@ FLATBUFFERS_MANUALLY_ALIGNED_STRUCT(2) Test FLATBUFFERS_FINAL_CLASS { + + public: + Test() { ++#if defined(__GNUC__) ++#pragma GCC diagnostic push ++#pragma GCC diagnostic ignored "-Wclass-memaccess" ++#endif + memset(this, 0, sizeof(Test)); ++#if defined(__GNUC__) ++#pragma GCC diagnostic pop ++#endif + } + Test(int16_t _a, int8_t _b) + : a_(flatbuffers::EndianScalar(_a)), +@@ -312,7 +319,14 @@ FLATBUFFERS_MANUALLY_ALIGNED_STRUCT(16) Vec3 FLATBUFFERS_FINAL_CLASS { + + public: + Vec3() { ++#if defined(__GNUC__) ++#pragma GCC diagnostic push ++#pragma GCC diagnostic ignored "-Wclass-memaccess" ++#endif + memset(this, 0, sizeof(Vec3)); ++#if defined(__GNUC__) ++#pragma GCC diagnostic pop ++#endif + } + Vec3(float _x, float _y, float _z, double _test1, Color _test2, const Test &_test3) + : x_(flatbuffers::EndianScalar(_x)), +@@ -384,7 +398,14 @@ FLATBUFFERS_MANUALLY_ALIGNED_STRUCT(4) Ability FLATBUFFERS_FINAL_CLASS { + + public: + Ability() { ++#if defined(__GNUC__) ++#pragma GCC diagnostic push ++#pragma GCC diagnostic ignored "-Wclass-memaccess" ++#endif + memset(this, 0, sizeof(Ability)); ++#if defined(__GNUC__) ++#pragma GCC diagnostic pop ++#endif + } + Ability(uint32_t _id, uint32_t _distance) + : id_(flatbuffers::EndianScalar(_id)), +diff --git a/tests/namespace_test/namespace_test1_generated.h b/tests/namespace_test/namespace_test1_generated.h +index d82a577..a7637bc 100644 +--- a/tests/namespace_test/namespace_test1_generated.h ++++ b/tests/namespace_test/namespace_test1_generated.h +@@ -56,7 +56,14 @@ FLATBUFFERS_MANUALLY_ALIGNED_STRUCT(4) StructInNestedNS FLATBUFFERS_FINAL_CLASS + + public: + StructInNestedNS() { ++#if defined(__GNUC__) ++#pragma GCC diagnostic push ++#pragma GCC diagnostic ignored "-Wclass-memaccess" ++#endif + memset(this, 0, sizeof(StructInNestedNS)); ++#if defined(__GNUC__) ++#pragma GCC diagnostic pop ++#endif + } + StructInNestedNS(int32_t _a, int32_t _b) + : a_(flatbuffers::EndianScalar(_a)), +diff --git a/tests/union_vector/union_vector_generated.h b/tests/union_vector/union_vector_generated.h +index c5b2250..57d208e 100644 +--- a/tests/union_vector/union_vector_generated.h ++++ b/tests/union_vector/union_vector_generated.h +@@ -188,7 +188,14 @@ FLATBUFFERS_MANUALLY_ALIGNED_STRUCT(4) Rapunzel FLATBUFFERS_FINAL_CLASS { + + public: + Rapunzel() { ++#if defined(__GNUC__) ++#pragma GCC diagnostic push ++#pragma GCC diagnostic ignored "-Wclass-memaccess" ++#endif + memset(this, 0, sizeof(Rapunzel)); ++#if defined(__GNUC__) ++#pragma GCC diagnostic pop ++#endif + } + Rapunzel(int32_t _hair_length) + : hair_length_(flatbuffers::EndianScalar(_hair_length)) { +@@ -213,7 +220,14 @@ FLATBUFFERS_MANUALLY_ALIGNED_STRUCT(4) BookReader FLATBUFFERS_FINAL_CLASS { + + public: + BookReader() { ++#if defined(__GNUC__) ++#pragma GCC diagnostic push ++#pragma GCC diagnostic ignored "-Wclass-memaccess" ++#endif + memset(this, 0, sizeof(BookReader)); ++#if defined(__GNUC__) ++#pragma GCC diagnostic pop ++#endif + } + BookReader(int32_t _books_read) + : books_read_(flatbuffers::EndianScalar(_books_read)) { +-- +2.20.1 + diff --git a/Handle-git-program-or-.git-folder-absence.patch b/Handle-git-program-or-.git-folder-absence.patch new file mode 100644 index 0000000000000000000000000000000000000000..da60829cad9199cef561dac765b0bf9b47548d45 --- /dev/null +++ b/Handle-git-program-or-.git-folder-absence.patch @@ -0,0 +1,53 @@ +From 7e4124d6e6ccafb267f80f3e57e3780913d5cbe5 Mon Sep 17 00:00:00 2001 +From: Dmitry Volosnykh +Date: Mon, 4 May 2020 23:23:41 +0300 +Subject: [PATCH] Handle git program or .git folder absence (#5878) + +Assume version is 0.0.0.0 in such cases. +--- + CMake/Version.cmake | 37 +++++++++++++++++++++++++++---------- + 1 file changed, 27 insertions(+), 10 deletions(-) + +diff --git a/CMake/Version.cmake b/CMake/Version.cmake +index db6613b840..0bed50f6e2 100644 +--- a/CMake/Version.cmake ++++ b/CMake/Version.cmake +@@ -1,11 +1,28 @@ ++set(VERSION_MAJOR 1) ++set(VERSION_MINOR 10) ++set(VERSION_PATCH 0) ++set(VERSION_COMMIT 0) ++ + find_program(GIT git) +-execute_process( +- COMMAND ${GIT} describe +- WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} +- OUTPUT_VARIABLE GIT_DESCRIBE_DIRTY +- OUTPUT_STRIP_TRAILING_WHITESPACE +-) +-string(REGEX REPLACE "^v([0-9]+)\\..*" "\\1" VERSION_MAJOR "${GIT_DESCRIBE_DIRTY}") +-string(REGEX REPLACE "^v[0-9]+\\.([0-9]+).*" "\\1" VERSION_MINOR "${GIT_DESCRIBE_DIRTY}") +-string(REGEX REPLACE "^v[0-9]+\\.[0-9]+\\.([0-9]+).*" "\\1" VERSION_PATCH "${GIT_DESCRIBE_DIRTY}") +-string(REGEX REPLACE "^v[0-9]+\\.[0-9]+\\.[0-9]+\\-([0-9]+).*" "\\1" VERSION_COMMIT "${GIT_DESCRIBE_DIRTY}") ++if(GIT) ++ execute_process( ++ COMMAND ${GIT} describe ++ WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} ++ OUTPUT_VARIABLE GIT_DESCRIBE_DIRTY ++ OUTPUT_STRIP_TRAILING_WHITESPACE ++ RESULT_VARIABLE GIT_DESCRIBE_RESULT ++ ) ++ ++ if(GIT_DESCRIBE_RESULT EQUAL 0) ++ string(REGEX REPLACE "^v([0-9]+)\\..*" "\\1" VERSION_MAJOR "${GIT_DESCRIBE_DIRTY}") ++ string(REGEX REPLACE "^v[0-9]+\\.([0-9]+).*" "\\1" VERSION_MINOR "${GIT_DESCRIBE_DIRTY}") ++ string(REGEX REPLACE "^v[0-9]+\\.[0-9]+\\.([0-9]+).*" "\\1" VERSION_PATCH "${GIT_DESCRIBE_DIRTY}") ++ string(REGEX REPLACE "^v[0-9]+\\.[0-9]+\\.[0-9]+\\-([0-9]+).*" "\\1" VERSION_COMMIT "${GIT_DESCRIBE_DIRTY}") ++ else() ++ message(WARNING "git describe failed with exit code: ${GIT_DESCRIBE_RESULT}") ++ endif() ++else() ++ message(WARNING "git is not found") ++endif() ++ ++message("Proceeding with version: ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}.${VERSION_COMMIT}") diff --git a/flatbuffers-1.10.0.tar.gz b/flatbuffers-1.10.0.tar.gz new file mode 100644 index 0000000000000000000000000000000000000000..34ada24bdd35e785df11093bad6042285d3ed092 Binary files /dev/null and b/flatbuffers-1.10.0.tar.gz differ diff --git a/flatbuffers.7 b/flatbuffers.7 new file mode 100644 index 0000000000000000000000000000000000000000..1ccbe150463f63ffa957af9d2ea0afb526611447 --- /dev/null +++ b/flatbuffers.7 @@ -0,0 +1,461 @@ +.TH FLATBUFFERS 7 "APRIL 2018" Linux "User Manuals" +.SH NAME +.PP +flatbuffers \- memory efficient serialization library +.SH DESCRIPTION +.TP +\fBBefore you get started\fP +Before diving into the FlatBuffers usage in C++, it should be noted that the +Tutorial \[la]http://google.github.io/flatbuffers/flatbuffers_guide_tutorial.html\[ra] page has a complete guide to general +FlatBuffers usage in all of the supported languages (including C++). This page is designed to cover the nuances of +FlatBuffers usage, specific to C++. +.IP +This page assumes you have written a FlatBuffers schema and compiled it with the Schema Compiler. If you have not, +please see Using the schema +compiler \[la]http://google.github.io/flatbuffers/flatbuffers_guide_using_schema_compiler.html\[ra] and Writing a +schema \[la]http://google.github.io/flatbuffers/flatbuffers_guide_writing_schema.html\[ra]\&. +.IP +Assuming you wrote a schema, say \fB\fCmygame.fbs\fR (though the extension doesn't matter), you've generated a C++ header +called \fB\fCmygame_generated.h\fR using the compiler (e.g. \fB\fCflatc \-c mygame.fbs\fR), you can now start using this in your +program by including the header. As noted, this header relies on \fB\fCflatbuffers/flatbuffers.h\fR, which should be in your +include path. +.TP +\fBFlatBuffers C++ library code location\fP +The code for the FlatBuffers C++ library can be found at \fB\fCflatbuffers/include/flatbuffers\fR\&. You can browse the library +code on the FlatBuffers GitHub page \[la]https://github.com/google/flatbuffers/tree/master/include/flatbuffers\[ra]\&. +.TP +\fBTesting the FlatBuffers C++ library\fP +The code to test the C++ library can be found at \fB\fCflatbuffers/tests\fR\&. The test code itself is located in +test.cpp \[la]https://github.com/google/flatbuffers/blob/master/tests/test.cpp\[ra]\&. +.IP +This test file is built alongside \fB\fCflatc\fR\&. To review how to build the project, please read the +Building \[la]http://google.github.io/flatbuffers/flatbuffers_guide_building.html\[ra] documenation. +.IP +To run the tests, execute \fB\fCflattests\fR from the root \fB\fCflatbuffers/\fR directory. For example, on +Linux \[la]https://en.wikipedia.org/wiki/Linux\[ra], you would simply run: \fB\fC\&./flattests\fR\&. +.TP +\fBUsing the FlatBuffers C++ library\fP +Note: See Tutorial \[la]http://google.github.io/flatbuffers/flatbuffers_guide_tutorial.html\[ra] for a more in\-depth example +of how to use FlatBuffers in C++. +.IP +FlatBuffers supports both reading and writing FlatBuffers in C++. +.IP +To use FlatBuffers in your code, first generate the C++ classes from your schema with the \fB\fC\-\-cpp\fR option to +\fB\fCflatc\fR\&. Then you can include both FlatBuffers and the generated code to read or write FlatBuffers. +.IP +For example, here is how you would read a FlatBuffer binary file in C++: First, include the library and generated +code. Then read the file into a \fB\fCchar *\fR array, which you pass to \fB\fCGetMonster()\fR\&. +.PP +.RS +.nf + #include "flatbuffers/flatbuffers.h" + #include "monster_test_generate.h" + #include // C++ header file for printing + #include // C++ header file for file access + + + std::ifstream infile; + infile.open("monsterdata_test.mon", std::ios::binary | std::ios::in); + infile.seekg(0,std::ios::end); + int length = infile.tellg(); + infile.seekg(0,std::ios::beg); + char *data = new char[length]; + infile.read(data, length); + infile.close(); + + auto monster = GetMonster(data); +.fi +.RE +.IP +\fB\fCmonster\fR is of type \fB\fCMonster *\fR, and points to somewhere \fIinside\fP your buffer (root object pointers are not the same +as \fB\fCbuffer_pointer\fR !). If you look in your generated header, you'll see it has convenient accessors for all fields, +e.g. \fB\fChp()\fR, \fB\fCmana()\fR, etc: +.PP +.RS +.nf + std::cout << "hp : " << monster\->hp() << std::endl; // `80` + std::cout << "mana : " << monster\->mana() << std::endl; // default value of `150` + std::cout << "name : " << monster\->name()\->c_str() << std::endl; // "MyMonster" +.fi +.RE +.IP +Note: That we never stored a \fB\fCmana\fR value, so it will return the default. +.TP +\fBObject based API\fP +FlatBuffers is all about memory efficiency, which is why its base API is written around using as little as possible of +it. This does make the API clumsier (requiring pre\-order construction of all data, and making mutation harder). +.IP +For times when efficiency is less important a more convenient object based API can be used (through +\fB\fC\-\-gen\-object\-api\fR) that is able to unpack & pack a FlatBuffer into objects and standard STL containers, allowing for +convenient construction, access and mutation. +.IP +To use: +.PP +.RS +.nf + // Autogenerated class from table Monster. + MonsterT monsterobj; + + // Deserialize from buffer into object. + UnPackTo(&monsterobj, flatbuffer); + + // Update object directly like a C++ class instance. + cout << monsterobj\->name; // This is now a std::string! + monsterobj\->name = "Bob"; // Change the name. + + // Serialize into new flatbuffer. + FlatBufferBuilder fbb; + Pack(fbb, &monsterobj); +.fi +.RE +.IP +The following attributes are specific to the object\-based API code generation: +.RS +.IP \(bu 2 +\fB\fCnative_inline\fR: (on a field): Because FlatBuffer tables and structs are optionally present in a given buffer, they +are best represented as pointers (specifically std::unique\fIptrs) in the native class since they can be null. This +attribute changes the member declaration to use the type directly rather than wrapped in a unique\fPptr. +.IP \(bu 2 +\fB\fCnative_default\fR: "value" (on a field): For members that are declared "native_inline", the value specified with this +attribute will be included verbatim in the class constructor initializer list for this member. +.IP \(bu 2 +\fB\fCnative_custom_alloc\fR:"custom\fIallocator" (on a table or struct): When using the +object\-based API all generated NativeTables that are allocated when unpacking +your flatbuffer will use "custom allocator". The allocator is also used by +any std::vector that appears in a table defined with `native\fPcustom_alloc`. +This can be used to provide allocation from a pool for example, for faster +unpacking when using the object\-based API. +.PP +Minimal Example: +.PP +schema: +.PP +.RS +.nf +table mytable(native_custom_alloc:"custom_allocator") { + ... +} +.fi +.RE +.PP +with custom_allocator defined before flatbuffers.h is included, as: +.PP +.RS +.nf +template struct custom_allocator : public std::allocator { + + typedef T *pointer; + + template + struct rebind { + typedef custom_allocator other; + }; + + pointer allocate(const std::size_t n) { + return std::allocator::allocate(n); + } + + void deallocate(T* ptr, std::size_t n) { + return std::allocator::deallocate(ptr,n); + } + + custom_allocator() throw() {} + template + custom_allocator(const custom_allocator&) throw() {} +}; +.fi +.RE +.IP \(bu 2 +\fB\fCnative_type\fR: "type" (on a struct): In some cases, a more optimal C++ data type exists for a given struct. For +example, the following schema: +.PP +.RS +.nf +struct Vec2 { + x: float; + y: float; +} +.fi +.RE +.IP +generates the following Object\-Based API class: +.PP +.RS +.nf +struct Vec2T : flatbuffers::NativeTable { + float x; + float y; +}; +.fi +.RE +.IP +However, it can be useful to instead use a user\-defined C++ type since it can provide more functionality, eg. +.PP +.RS +.nf +struct vector2 { + float x = 0, y = 0; + vector2 operator+(vector2 rhs) const { ... } + vector2 operator\-(vector2 rhs) const { ... } + float length() const { ... } + // etc. +}; +.fi +.RE +.IP +The \fB\fCnative_type\fR attribute will replace the usage of the generated class with the given type. So, continuing with +the example, the generated code would use |vector2| in place of |Vec2T| for all generated code. +.IP +However, because the native_type is unknown to flatbuffers, the user must provide the following functions to aide +in the serialization process: +.PP +.RS +.nf +namespace flatbuffers { + FlatbufferStruct Pack(const native_type& obj); + native_type UnPack(const FlatbufferStruct& obj); +} +.fi +.RE +.IP \(bu 2 +\fB\fCnative_include\fR: "path" (at file level): Because the \fB\fCnative_type\fR attribute can be used to introduce types that +are unknown to flatbuffers, it may be necessary to include "external" header files in the generated code. This +attribute can be used to directly add an #include directive to the top of the generated code that includes the +specified path directly. +.RE +.TP +\fBExternal references\fP +An additional feature of the object API is the ability to allow you to load multiple independent FlatBuffers, and have +them refer to eachothers objects using hashes which are then represented as typed pointers in the object API. +.IP +To make this work have a field in the objects you want to referred to which is using the string hashing feature (see +\fB\fChash\fR attribute in the schema \[la]http://google.github.io/flatbuffers/flatbuffers_guide_writing_schema.html\[ra] +documentation). Then you have a similar hash in the field referring to it, along with a \fB\fCcpp_type\fR attribute +specifying the C++ type this will refer to (this can be any C++ type, and will get a \fB\fC*\fR added). +.IP +Then, in JSON or however you create these buffers, make sure they use the same string (or hash). +.IP +When you call \fB\fCUnPack\fR (or \fB\fCCreate\fR), you'll need a function that maps from hash to the object (see +\fB\fCresolver_function_t\fR for details). +.TP +\fBUsing different pointer types\fP +By default the object tree is built out of \fB\fCstd::unique_ptr\fR, but you can influence this either globally (using the +\fB\fC\-\-cpp\-ptr\-type\fR argument to \fB\fCflatc\fR) or per field (using the \fB\fCcpp_ptr_type\fR attribute) to by any smart pointer type +(\fB\fCmy_ptr\fR), or by specifying \fB\fCnaked\fR as the type to get \fB\fCT *\fR pointers. Unlike the smart pointers, naked pointers +do not manage memory for you, so you'll have to manage their lifecycles manually. +.TP +\fBUsing different string type\fP +By default the object tree is built out of \fB\fCstd::string\fR, but you can influence this either globally (using the +\fB\fC\-\-cpp\-str\-type\fR argument to \fB\fCflatc\fR) or per field using the \fB\fCcpp_str_type\fR attribute. +.IP +The type must support \fB\fCT::c_str()\fR and \fB\fCT::length()\fR as member functions. +.TP +\fBReflection (& Resizing)\fP +There is experimental support for reflection in FlatBuffers, allowing you to read and write data even if you don't +know the exact format of a buffer, and even allows you to change sizes of strings and vectors in\-place. +.IP +The way this works is very elegant; there is actually a FlatBuffer schema that describes schemas (!) which you can +find in \fB\fCreflection/reflection.fbs\fR\&. The compiler, \fB\fCflatc\fR, can write out any schemas it has just parsed as a binary +FlatBuffer, corresponding to this meta\-schema. +.IP +Loading in one of these binary schemas at runtime allows you traverse any FlatBuffer data that corresponds to it +without knowing the exact format. You can query what fields are present, and then read/write them after. +.IP +For convenient field manipulation, you can include the header \fB\fCflatbuffers/reflection.h\fR which includes both the +generated code from the meta schema, as well as a lot of helper functions. +.IP +And example of usage, for the time being, can be found in \fB\fCtest.cpp/ReflectionTest()\fR\&. +.PP +\fBMini Reflection\fP +.IP +A more limited form of reflection is available for direct inclusion in generated code, which doesn't any (binary) +schema access at all. It was designed to keep the overhead of reflection as low as possible (on the order of 2\-6 +bytes per field added to your executable), but doesn't contain all the information the (binary) schema contains. +.IP +You add this information to your generated code by specifying \fB\fC\-\-reflect\-types\fR (or instead \fB\fC\-\-reflect\-names\fR if you +also want field / enum names). +.IP +You can now use this information, for example to print a FlatBuffer to text: +.PP +.RS +.nf + auto s = flatbuffers::FlatBufferToString(flatbuf, MonsterTypeTable()); +.fi +.RE +.IP +\fB\fCMonsterTypeTable()\fR is declared in the generated code for each type. The string produced is very similar to the JSON +produced by the \fB\fCParser\fR based text generator. +.IP +You'll need \fB\fCflatbuffers/minireflect.h\fR for this functionality. In there is also a convenient visitor/iterator so you +can write your own output / functionality based on the mini reflection tables without having to know the FlatBuffers +or reflection encoding. +.TP +\fBStoring maps / dictionaries in a FlatBuffer\fP +FlatBuffers doesn't support maps natively, but there is support to emulate their behavior with vectors and binary +search, which means you can have fast lookups directly from a FlatBuffer without having to unpack your data into a +\fB\fCstd::map\fR or similar. +.IP +To use it: +.RS +.IP \(bu 2 +Designate one of the fields in a table as they "key" field. You do this by setting the \fB\fCkey\fR attribute on this +field, e.g. \fB\fCname:string (key)\fR\&. +.IP +You may only have one key field, and it must be of string or scalar type. +.IP \(bu 2 +Write out tables of this type as usual, collect their offsets in an array or vector. +.IP \(bu 2 +Instead of \fB\fCCreateVector\fR, call \fB\fCCreateVectorOfSortedTables\fR, which will first sort all offsets such that the tables +they refer to are sorted by the key field, then serialize it. +.IP \(bu 2 +Now when you're accessing the FlatBuffer, you can use \fB\fCVector::LookupByKey\fR instead of just \fB\fCVector::Get\fR to access +elements of the vector, e.g.: \fB\fCmyvector\->LookupByKey("Fred")\fR, which returns a pointer to the corresponding table +type, or \fB\fCnullptr\fR if not found. \fB\fCLookupByKey\fR performs a binary search, so should have a similar speed to +\fB\fCstd::map\fR, though may be faster because of better caching. \fB\fCLookupByKey\fR only works if the vector has been sorted, +it will likely not find elements if it hasn't been sorted. +.RE +.TP +\fBDirect memory access\fP +As you can see from the above examples, all elements in a buffer are accessed through generated accessors. This is +because everything is stored in little endian format on all platforms (the accessor performs a swap operation on big +endian machines), and also because the layout of things is generally not known to the user. +.IP +For structs, layout is deterministic and guaranteed to be the same across platforms (scalars are aligned to their own +size, and structs themselves to their largest member), and you are allowed to access this memory directly by using +\fB\fCsizeof()\fR and \fB\fCmemcpy\fR on the pointer to a struct, or even an array of structs. +.IP +To compute offsets to sub\-elements of a struct, make sure they are a structs themselves, as then you can use the +pointers to figure out the offset without having to hardcode it. This is handy for use of arrays of structs with calls +like \fB\fCglVertexAttribPointer\fR in OpenGL or similar APIs. +.IP +It is important to note is that structs are still little endian on all machines, so only use tricks like this if you +can guarantee you're not shipping on a big endian machine (an \fB\fCassert(FLATBUFFERS_LITTLEENDIAN)\fR would be wise). +.TP +\fBAccess of untrusted buffers\fP +The generated accessor functions access fields over offsets, which is very quick. These offsets are not verified at +run\-time, so a malformed buffer could cause a program to crash by accessing random memory. +.IP +When you're processing large amounts of data from a source you know (e.g. your own generated data on disk), this is +acceptable, but when reading data from the network that can potentially have been modified by an attacker, this is +undesirable. +.IP +For this reason, you can optionally use a buffer verifier before you access the data. This verifier will check all +offsets, all sizes of fields, and null termination of strings to ensure that when a buffer is accessed, all reads will +end up inside the buffer. +.IP +Each root type will have a verification function generated for it, e.g. for \fB\fCMonster\fR, you can call: +.PP +.RS +.nf + bool ok = VerifyMonsterBuffer(Verifier(buf, len)); +.fi +.RE +.IP +if \fB\fCok\fR is true, the buffer is safe to read. +.IP +Besides untrusted data, this function may be useful to call in debug mode, as extra insurance against data being +corrupted somewhere along the way. +.IP +While verifying a buffer isn't "free", it is typically faster than a full traversal (since any scalar data is not +actually touched), and since it may cause the buffer to be brought into cache before reading, the actual overhead may +be even lower than expected. +.IP +In specialized cases where a denial of service attack is possible, the verifier has two additional constructor +arguments that allow you to limit the nesting depth and total amount of tables the verifier may encounter before +declaring the buffer malformed. The default is \fB\fCVerifier(buf, len, 64 /* max depth */, 1000000, /* max tables */)\fR +which should be sufficient for most uses. +.TP +\fBText & schema parsing\fP +Using binary buffers with the generated header provides a super low overhead use of FlatBuffer data. There are, +however, times when you want to use text formats, for example because it interacts better with source control, or you +want to give your users easy access to data. +.IP +Another reason might be that you already have a lot of data in JSON format, or a tool that generates JSON, and if you +can write a schema for it, this will provide you an easy way to use that data directly. +.IP +(see the schema documentation for some specifics on the JSON format accepted). +.IP +There are two ways to use text formats: +.RS +.IP \(bu 2 +Using the compiler as a conversion tool. +.PP + This is the preferred path, as it doesn't require you to add any new code to your program, and is maximally + efficient since you can ship with binary data. The disadvantage is that it is an extra step for your + users/developers to perform, though you might be able to automate it. +.PP +.RS +.nf +flatc \-b myschema.fbs mydata.json +.fi +.RE +.PP + This will generate the binary file \fB\fCmydata_wire.bin\fR which can be loaded as before. +.IP \(bu 2 +Making your program capable of loading text directly. +.PP + This gives you maximum flexibility. You could even opt to support both, i.e. check for both files, and regenerate + the binary from text when required, otherwise just load the binary. This option is currently only available for + C++, or Java through JNI. +.PP + As mentioned in the section "Building" above, this technique requires you to link a few more files into your + program, and you'll want to include \fB\fCflatbuffers/idl.h\fR\&. +.PP + Load text (either a schema or json) into an in\-memory buffer (there is a convenient \fB\fCLoadFile()\fR utility function + in \fB\fCflatbuffers/util.h\fR if you wish). Construct a parser: +.PP +.RS +.nf +flatbuffers::Parser parser; +.fi +.RE +.PP + Now you can parse any number of text files in sequence: +.PP +.RS +.nf +parser.Parse(text_file.c_str()); +.fi +.RE +.PP + This works similarly to how the command\-line compiler works: a sequence of files parsed by the same \fB\fCParser\fR object + allow later files to reference definitions in earlier files. Typically this means you first load a schema file + (which populates \fB\fCParser\fR with definitions), followed by one or more JSON files. +.PP + As optional argument to \fB\fCParse\fR, you may specify a null\-terminated list of include paths. If not specified, any + include statements try to resolve from the current directory. +.PP + If there were any parsing errors, \fB\fCParse\fR will return \fB\fCfalse\fR, and \fB\fCParser::err\fR contains a human readable error + string with a line number etc, which you should present to the creator of that file. +.PP + After each JSON file, the \fB\fCParser::fbb\fR member variable is the \fB\fCFlatBufferBuilder\fR that contains the binary buffer + version of that file, that you can access as described above. \fB\fCsamples/sample_text.cpp\fR is a code sample showing + the above operations. +.RE +.TP +\fBThreading\fP +Reading a FlatBuffer does not touch any memory outside the original buffer, and is entirely read\-only (all const), so +is safe to access from multiple threads even without synchronisation primitives. +.IP +Creating a FlatBuffer is not thread safe. All state related to building a FlatBuffer is contained in a +FlatBufferBuilder instance, and no memory outside of it is touched. To make this thread safe, either do not share +instances of FlatBufferBuilder between threads (recommended), or manually wrap it in synchronisation primites. There's +no automatic way to accomplish this, by design, as we feel multithreaded construction of a single buffer will be rare, +and synchronisation overhead would be costly. +.TP +\fBAdvanced union features\fP +The C++ implementation currently supports vectors of unions (i.e. you can declare a field as \fB\fC[T]\fR where \fB\fCT\fR is a +union type instead of a table type). It also supports structs and strings in unions, besides tables. +.IP +For an example of these features, see \fB\fCtests/union_vector\fR, and \fB\fCUnionVectorTest\fR in \fB\fCtest.cpp\fR\&. +.IP +Since these features haven't been ported to other languages yet, if you choose to use them, you won't be able to use +these buffers in other languages (\fB\fCflatc\fR will refuse to compile a schema that uses these features). +.IP +These features reduce the amount of "table wrapping" that was previously needed to use unions. +.IP +To use scalars, simply wrap them in a struct. +.SH SEE ALSO +.PP +.BR flatc (1), +Official documentation \[la]http://google.github.io/flatbuffers\[ra] diff --git a/flatbuffers.spec b/flatbuffers.spec new file mode 100644 index 0000000000000000000000000000000000000000..a8f4fe0e836e6588030112ea1eb5b72ead488a33 --- /dev/null +++ b/flatbuffers.spec @@ -0,0 +1,74 @@ +%ifarch ppc64 s390x %{arm} +%bcond_with tests +%else +%bcond_without tests +%endif +Name: flatbuffers +Version: 1.10.0 +Release: 1 +Summary: Memory efficient serialization library +License: Apache-2.0 +URL: https://github.com/google/flatbuffers +Source0: https://github.com/google/flatbuffers/archive/v%{version}/%{name}-%{version}.tar.gz +Source1: flatc.1 +Source2: flatbuffers.7 +Patch0: 0001-generate-gcc-pragmas-to-ignore-Wclass-memaccess.patch +Patch1: Handle-git-program-or-.git-folder-absence.patch +BuildRequires: gcc-c++ cmake >= 2.8.9 +Provides: bundled(grpc) +%description +FlatBuffers is a serialization library for games and other memory constrained +apps. FlatBuffers allows you to directly access serialized data without +unpacking/parsing it first, while still having great forwards/backwards +compatibility. + +%package devel +Summary: Development files for %{name} +Requires: %{name}%{?_isa} = %{version}-%{release} +%description devel +%{summary}. + +%prep +%autosetup -p1 +rm -rf js net php python docs go java js biicode {samples/,}android +chmod -x readme.md +%cmake -DCMAKE_BUILD_TYPE=Release \ + -DFLATBUFFERS_BUILD_SHAREDLIB=ON \ + -DFLATBUFFERS_BUILD_FLATLIB=OFF \ + -DFLATBUFFERS_BUILD_FLATC=ON \ + -DFLATBUFFERS_BUILD_TESTS=%{?with_tests:ON}%{!?with_tests:OFF} + +%build +%make_build + +%install +%make_install +mkdir -p %{buildroot}%{_mandir}/man{1,7} +cp -p %SOURCE1 %{buildroot}%{_mandir}/man1/flatc.1 +cp -p %SOURCE2 %{buildroot}%{_mandir}/man7/flatbuffers.7 + +%check +%if %{with tests} +make test +%endif + +%post -p /sbin/ldconfig + +%postun -p /sbin/ldconfig + +%files +%license LICENSE.txt +%doc readme.md +%{_bindir}/flatc +%{_libdir}/libflatbuffers.so.* +%{_mandir}/man1/flatc.1* + +%files devel +%{_includedir}/flatbuffers +%{_libdir}/libflatbuffers.so +%{_mandir}/man7/flatbuffers.7* +%{_libdir}/cmake/flatbuffers/*.cmake + +%changelog +* Mon Jan 11 2021 yanan li - 1.10.0-1 +- Package init diff --git a/flatbuffers.yaml b/flatbuffers.yaml new file mode 100644 index 0000000000000000000000000000000000000000..3337f1f9cb69b71b6966aff0e114085c7794eb24 --- /dev/null +++ b/flatbuffers.yaml @@ -0,0 +1,4 @@ +version_control: github +src_repo: google/flatbuffers +tag_prefix: "^v" +separator: "." diff --git a/flatc.1 b/flatc.1 new file mode 100644 index 0000000000000000000000000000000000000000..f5f13a57ae5c50064b6cd5727ce82d6fbca5364d --- /dev/null +++ b/flatc.1 @@ -0,0 +1,154 @@ +.TH FLATC 1 "APRIL 2018" Linux "User Manuals" +.SH NAME +.PP +flatc \- flatbuffers compiler +.SH SYNOPSIS +.PP +\fB\fCflatc\fR [\fIgenerator\-options\fP] [\fB\fC\-o\fR PATH] [\fB\fC\-I\fR=path] [\fB\fC\-S\fR] files... [\fB\fC\-\-\fR files...] +.PP +The files are read and parsed in order, and can contain either schemas or data (see below). Data files are processed according to the definitions of the most recent schema specified. \fB\fC\-\-\fR indicates that the following files are binary files in FlatBuffer format conforming to the schema indicated before it. Depending on the flags passed, additional files may be generated for each file processed. +.SH OPTIONS +.PP +For any schema input files, one or more generators can be specified: +.PP +\fB\fC\-\-cpp\fR, \fB\fC\-c\fR + Generate a C++ header for all definitions in this file (as \fB\fCfilename_generated.h\fR). +.PP +\fB\fC\-\-java\fR, \fB\fC\-j\fR + Generate Java code. +.PP +\fB\fC\-\-csharp\fR, \fB\fC\-n\fR + Generate C# code. +.PP +\fB\fC\-\-go\fR, \fB\fC\-g\fR + Generate Go code. +.PP +\fB\fC\-\-python\fR, \fB\fC\-p\fR + Generate Python code. +.PP +\fB\fC\-\-js\fR, \fB\fC\-s\fR + Generate JavaScript code. +.PP +\fB\fC\-\-ts\fR + Generate TypeScript code. +.PP +\fB\fC\-\-php\fR + Generate PHP code. +.PP +\fB\fC\-\-grpc\fR + Generate RPC stub code for GRPC. +.PP +\fB\fC\-\-dart\fR + Generate Dart code. +.PP +\fB\fC\-\-lua\fR + Generate Lua code. +.PP +\fB\fC\-\-lobster\fR + Generate Lobster code. +.PP +\fB\fC\-\-rust\fR, \fB\fC\-r\fR + Generate Rust code. +.PP +For any data input files: +.PP +\fB\fC\-\-binary\fR, \fB\fC\-b\fR + If data is contained in this file, generate a \fB\fCfilename.bin\fR containing the binary flatbuffer (or a different extension if one is specified in the schema). +.PP +\fB\fC\-\-json\fR, \fB\fC\-t\fR + If data is contained in this file, generate a \fB\fCfilename.json\fR representing the data in the flatbuffer. +.PP +Additional options: +.PP +\fB\fC\-o PATH\fR + Output all generated files to PATH (either absolute, or relative to the current directory). If omitted, PATH will be the current directory. PATH should end in your systems path separator, e.g. \fB\fC/\fR or \fB\fC\\\fR\&. +.PP +\fB\fC\-I PATH\fR + when encountering \fB\fCinclude\fR statements, attempt to load the files from this path. Paths will be tried in the order given, and if all fail (or none are specified) it will try to load relative to the path of the schema file being parsed. +.PP +\fB\fC\-M\fR + Print make rules for generated files. +.PP +\fB\fC\-\-strict\-json\fR + Require & generate strict JSON (field names are enclosed in quotes, no trailing commas in tables/vectors). By default, no quotes are required/generated, and trailing commas are allowed. +.PP +\fB\fC\-\-defaults\-json\fR + Output fields whose value is equal to the default value when writing JSON text. +.PP +\fB\fC\-\-no\-prefix\fR + Don't prefix enum values in generated C++ by their enum type. +.PP +\fB\fC\-\-scoped\-enums\fR + Use C++11 style scoped and strongly typed enums in generated C++. This also implies \fB\fC\-\-no\-prefix\fR\&. +.PP +\fB\fC\-\-gen\-includes\fR + (deprecated), this is the default behavior. If the original behavior is required (no include statements) use \fB\fC\-\-no\-includes.\fR +.PP +\fB\fC\-\-no\-includes\fR + Don't generate include statements for included schemas the generated file depends on (C++). +.PP +\fB\fC\-\-gen\-mutable\fR + Generate additional non\-const accessors for mutating FlatBuffers in\-place. +.PP +\fB\fC\-\-gen\-object\-api\fR + Generate an additional object\-based API. This API is more convenient for object construction and mutation than the base API, at the cost of efficiency (object allocation). Recommended only to be used if other options are insufficient. +.PP +\fB\fC\-\-gen\-compare\fR + Generate operator== for object\-based API types. +.PP +\fB\fC\-\-gen\-onefile\fR + Generate single output file (useful for C#) +.PP +\fB\fC\-\-gen\-all\fR + Generate not just code for the current schema files, but for all files it includes as well. If the language uses a single file for output (by default the case for C++ and JS), all code will end up in this one file. +.PP +\fB\fC\-\-no\-js\-exports\fR + Removes Node.js style export lines (useful for JS) +.PP +\fB\fC\-\-goog\-js\-export\fR + Uses goog.exportsSymbol and goog.exportsProperty instead of Node.js style exporting. Needed for compatibility with the Google closure compiler (useful for JS). +.PP +\fB\fC\-\-es6\-js\-export\fR + Generates ECMAScript v6 style export definitions instead of Node.js style exporting. Useful when integrating flatbuffers with modern Javascript projects. +.PP +\fB\fC\-\-raw\-binary\fR + Allow binaries without a \fB\fCfile_indentifier\fR to be read. This may crash flatc given a mismatched schema. +.PP +\fB\fC\-\-proto\fR + Expect input files to be .proto files (protocol buffers). Output the corresponding .fbs file. Currently supports: \fB\fCpackage\fR, \fB\fCmessage\fR, \fB\fCenum\fR, nested declarations, \fB\fCimport\fR (use \fB\fC\-I\fR for paths), \fB\fCextend\fR, \fB\fConeof\fR, \fB\fCgroup\fR\&. Does not support, but will skip without error: \fB\fCoption\fR, \fB\fCservice\fR, \fB\fCextensions\fR, and most everything else. +.PP +\fB\fC\-\-schema\fR + Serialize schemas instead of JSON (use with \-b). This will output a binary version of the specified schema that itself corresponds to the reflection/reflection.fbs schema. Loading this binary file is the basis for reflection functionality. +.PP +\fB\fC\-\-bfbs\-comments\fR + Add doc comments to the binary schema files. +.PP +\fB\fC\-\-conform FILE\fR + Specify a schema the following schemas should be an evolution of. Gives errors if not. Useful to check if schema modifications don't break schema evolution rules. +.PP +\fB\fC\-\-include\-prefix PATH\fR + Prefix this path to any generated include statements. +.PP +\fB\fC\-\-keep\-prefix\fR + Keep original prefix of schema include statement. +.PP +\fB\fC\-\-reflect\-types\fR + Add minimal type reflection to code generation. +.PP +\fB\fC\-\-reflect\-names\fR + Add minimal type/name reflection. +.PP +\fB\fC\-\-root\-type T\fR + Select or override the default root_type. +.PP +\fB\fC\-\-force\-defaults\fR + Emit default values in binary output from JSON. +.PP +\fB\fC\-\-force\-empty\fR + When serializing from object API representation, force strings and vectors to empty rather than null. +.PP +NOTE: short\-form options for generators are deprecated, use the long form whenever possible. +.SH SEE ALSO +.PP +.BR flatbuffers (7), +Official documentation \[la]http://google.github.io/flatbuffers\[ra]