Default Vector Support C++ (#8870)

This commit is contained in:
Derek Bailey
2025-12-19 14:32:51 -08:00
committed by GitHub
parent 8cb53ccc95
commit 57fdd4f995
12 changed files with 526 additions and 31 deletions

View File

@@ -33,6 +33,8 @@ cc_test(
"alignment_test.cpp",
"alignment_test.h",
"alignment_test_generated.h",
"default_vectors_strings_test.cpp",
"default_vectors_strings_test.h",
"evolution_test.cpp",
"evolution_test.h",
"evolution_test/evolution_v1_generated.h",
@@ -134,6 +136,7 @@ cc_test(
deps = [
":alignment_test_cc_fbs",
":arrays_test_cc_fbs",
":default_vectors_strings_test_cc_fbs",
":monster_extra_cc_fbs",
":monster_test_cc_fbs",
":native_type_test_cc_fbs",
@@ -272,3 +275,16 @@ flatbuffer_cc_library(
name = "alignment_test_cc_fbs",
srcs = ["alignment_test.fbs"],
)
flatbuffer_cc_library(
name = "default_vectors_strings_test_cc_fbs",
srcs = ["default_vectors_strings_test.fbs"],
flatc_args = [
"--gen-compare",
"--gen-mutable",
"--gen-object-api",
"--reflect-names",
"--filename-suffix .fbs",
],
filename_suffix = ".fbs"
)

View File

@@ -0,0 +1,249 @@
#include "tests/default_vectors_strings_test.h"
#include <cstdint>
#include <vector>
#include "include/flatbuffers/buffer.h"
#include "include/flatbuffers/flatbuffer_builder.h"
#include "include/flatbuffers/string.h"
#include "include/flatbuffers/vector.h"
#include "include/flatbuffers/verifier.h"
#include "tests/default_vectors_strings_test.fbs.h"
#include "tests/test_assert.h"
namespace flatbuffers {
namespace tests {
using flatbuffers::FlatBufferBuilder64;
using flatbuffers::Offset;
using flatbuffers::String;
using flatbuffers::Verifier;
void DefaultVectorsStringsTest_EmptyOnDefault_Const() {
FlatBufferBuilder64 builder;
// Create table without providing the fields with defaults.
DefaultVectorsStringsTest::TableWithDefaultVectorsBuilder tbl_builder(
builder);
tbl_builder.add_regular_int(100);
auto offset = tbl_builder.Finish();
builder.Finish(offset);
Verifier verifier(builder.GetBufferPointer(), builder.GetSize());
TEST_ASSERT(
DefaultVectorsStringsTest::VerifyTableWithDefaultVectorsBuffer(verifier));
const auto* table = DefaultVectorsStringsTest::GetTableWithDefaultVectors(
builder.GetBufferPointer());
TEST_NOTNULL(table);
// Verify default scalar vectors.
TEST_NOTNULL(table->int_vec());
TEST_EQ(table->int_vec()->size(), 0);
TEST_NOTNULL(table->bool_vec());
TEST_EQ(table->bool_vec()->size(), 0);
TEST_NOTNULL(table->char_vec());
TEST_EQ(table->char_vec()->size(), 0);
TEST_NOTNULL(table->uchar_vec());
TEST_EQ(table->uchar_vec()->size(), 0);
TEST_NOTNULL(table->short_vec());
TEST_EQ(table->short_vec()->size(), 0);
TEST_NOTNULL(table->ushort_vec());
TEST_EQ(table->ushort_vec()->size(), 0);
TEST_NOTNULL(table->uint_vec());
TEST_EQ(table->uint_vec()->size(), 0);
TEST_NOTNULL(table->long_vec());
TEST_EQ(table->long_vec()->size(), 0);
TEST_NOTNULL(table->ulong_vec());
TEST_EQ(table->ulong_vec()->size(), 0);
TEST_NOTNULL(table->float_vec());
TEST_EQ(table->float_vec()->size(), 0);
TEST_NOTNULL(table->double_vec());
TEST_EQ(table->double_vec()->size(), 0);
// Verify default string_vec.
TEST_NOTNULL(table->string_vec());
TEST_EQ(table->string_vec()->size(), 0);
// Verify default string fields.
TEST_NOTNULL(table->empty_string());
TEST_EQ_STR(table->empty_string()->c_str(), "");
TEST_NOTNULL(table->some_string());
TEST_EQ_STR(table->some_string()->c_str(), "some");
// Verify default struct_vec.
TEST_NOTNULL(table->struct_vec());
TEST_EQ(table->struct_vec()->size(), 0);
// Verify default table_vec.
TEST_NOTNULL(table->table_vec());
TEST_EQ(table->table_vec()->size(), 0);
// Verify default enum_vec.
TEST_NOTNULL(table->enum_vec());
TEST_EQ(table->enum_vec()->size(), 0);
// Verify non-default vector field.
TEST_NULL(table->regular_int_vec());
// Verify pointer and offset64 combinations.
TEST_NOTNULL(table->int_vec64());
TEST_EQ(table->int_vec64()->size(), 0);
TEST_NOTNULL(table->int_vec_offset64());
TEST_EQ(table->int_vec_offset64()->size(), 0);
// Verify non-default field.
TEST_EQ(table->regular_int(), 100);
}
void DefaultVectorsStringsTest_EmptyOnDefault_Mutable() {
FlatBufferBuilder64 builder;
// Create table without providing the fields with defaults.
DefaultVectorsStringsTest::TableWithDefaultVectorsBuilder tbl_builder(
builder);
tbl_builder.add_regular_int(100);
auto offset = tbl_builder.Finish();
builder.Finish(offset);
Verifier verifier(builder.GetBufferPointer(), builder.GetSize());
TEST_ASSERT(
DefaultVectorsStringsTest::VerifyTableWithDefaultVectorsBuffer(verifier));
auto* mutable_table =
DefaultVectorsStringsTest::GetMutableTableWithDefaultVectors(
builder.GetBufferPointer());
TEST_NOTNULL(mutable_table);
// Verify default scalar vectors.
TEST_NOTNULL(mutable_table->mutable_int_vec());
TEST_EQ(mutable_table->mutable_int_vec()->size(), 0);
TEST_NOTNULL(mutable_table->mutable_bool_vec());
TEST_EQ(mutable_table->mutable_bool_vec()->size(), 0);
TEST_NOTNULL(mutable_table->mutable_char_vec());
TEST_EQ(mutable_table->mutable_char_vec()->size(), 0);
TEST_NOTNULL(mutable_table->mutable_uchar_vec());
TEST_EQ(mutable_table->mutable_uchar_vec()->size(), 0);
TEST_NOTNULL(mutable_table->mutable_short_vec());
TEST_EQ(mutable_table->mutable_short_vec()->size(), 0);
TEST_NOTNULL(mutable_table->mutable_ushort_vec());
TEST_EQ(mutable_table->mutable_ushort_vec()->size(), 0);
TEST_NOTNULL(mutable_table->mutable_uint_vec());
TEST_EQ(mutable_table->mutable_uint_vec()->size(), 0);
TEST_NOTNULL(mutable_table->mutable_long_vec());
TEST_EQ(mutable_table->mutable_long_vec()->size(), 0);
TEST_NOTNULL(mutable_table->mutable_ulong_vec());
TEST_EQ(mutable_table->mutable_ulong_vec()->size(), 0);
TEST_NOTNULL(mutable_table->mutable_float_vec());
TEST_EQ(mutable_table->mutable_float_vec()->size(), 0);
TEST_NOTNULL(mutable_table->mutable_double_vec());
TEST_EQ(mutable_table->mutable_double_vec()->size(), 0);
// Verify default struct_vec.
TEST_NOTNULL(mutable_table->mutable_struct_vec());
TEST_EQ(mutable_table->mutable_struct_vec()->size(), 0);
// Verify default table_vec.
TEST_NOTNULL(mutable_table->mutable_table_vec());
TEST_EQ(mutable_table->mutable_table_vec()->size(), 0);
// Verify default enum_vec.
TEST_NOTNULL(mutable_table->mutable_enum_vec());
TEST_EQ(mutable_table->mutable_enum_vec()->size(), 0);
// Verify non-default vector field.
TEST_NULL(mutable_table->mutable_regular_int_vec());
// Verify pointer and offset64 combinations.
TEST_NOTNULL(mutable_table->mutable_int_vec64());
TEST_EQ(mutable_table->mutable_int_vec64()->size(), 0);
TEST_NOTNULL(mutable_table->mutable_int_vec_offset64());
TEST_EQ(mutable_table->mutable_int_vec_offset64()->size(), 0);
}
void DefaultVectorsStringsTest_WithValues() {
// Create a table with values for the defaulted vector fields.
FlatBufferBuilder64 builder;
auto int_vec64 = builder.CreateVector64(std::vector<int>({30, 40}));
auto int_vec_offset64 =
builder.CreateVector64<flatbuffers::Vector>(std::vector<int>({50, 60}));
auto int_vec = builder.CreateVector(std::vector<int>({1, 2}));
auto bool_vec = builder.CreateVector(std::vector<uint8_t>({true, false}));
auto string_vec = builder.CreateVector(std::vector<Offset<String>>(
{builder.CreateString("a"), builder.CreateString("b")}));
auto empty_string = builder.CreateString("not empty");
auto some_string = builder.CreateString("not some");
DefaultVectorsStringsTest::MyStruct structs[] = {
DefaultVectorsStringsTest::MyStruct(1, 2),
DefaultVectorsStringsTest::MyStruct(3, 4)};
auto struct_vec = builder.CreateVectorOfStructs(structs, 2);
auto regular_int_vec = builder.CreateVector(std::vector<int>({10, 20}));
DefaultVectorsStringsTest::TableWithDefaultVectorsBuilder tbl_builder(
builder);
tbl_builder.add_int_vec(int_vec);
tbl_builder.add_int_vec64(int_vec64);
tbl_builder.add_int_vec_offset64(int_vec_offset64);
tbl_builder.add_bool_vec(bool_vec);
tbl_builder.add_string_vec(string_vec);
tbl_builder.add_empty_string(empty_string);
tbl_builder.add_some_string(some_string);
tbl_builder.add_struct_vec(struct_vec);
tbl_builder.add_regular_int_vec(regular_int_vec);
auto offset = tbl_builder.Finish();
builder.Finish(offset);
Verifier verifier(builder.GetBufferPointer(), builder.GetSize());
TEST_ASSERT(
DefaultVectorsStringsTest::VerifyTableWithDefaultVectorsBuffer(verifier));
const auto* table = DefaultVectorsStringsTest::GetTableWithDefaultVectors(
builder.GetBufferPointer());
TEST_EQ(table->int_vec()->size(), 2);
TEST_EQ(table->int_vec()->Get(1), 2);
TEST_EQ(table->bool_vec()->size(), 2);
TEST_EQ(table->bool_vec()->Get(0), true);
TEST_EQ(table->string_vec()->size(), 2);
TEST_EQ_STR(table->string_vec()->Get(1)->c_str(), "b");
TEST_EQ_STR(table->empty_string()->c_str(), "not empty");
TEST_EQ_STR(table->some_string()->c_str(), "not some");
TEST_EQ(table->struct_vec()->size(), 2);
TEST_EQ(table->struct_vec()->Get(1)->b(), 4);
TEST_EQ(table->regular_int_vec()->size(), 2);
TEST_EQ(table->regular_int_vec()->Get(1), 20);
TEST_EQ(table->int_vec64()->size(), 2);
TEST_EQ(table->int_vec64()->Get(1), 40);
TEST_EQ(table->int_vec_offset64()->size(), 2);
TEST_EQ(table->int_vec_offset64()->Get(1), 60);
}
void DefaultVectorsStringsTest_BufferSize() {
FlatBufferBuilder64 builder;
// Create a table where all fields with default values are omitted.
DefaultVectorsStringsTest::TableWithDefaultVectorsBuilder tbl_builder(
builder);
auto offset = tbl_builder.Finish();
builder.Finish(offset);
Verifier verifier(builder.GetBufferPointer(), builder.GetSize());
TEST_ASSERT(
DefaultVectorsStringsTest::VerifyTableWithDefaultVectorsBuffer(verifier));
// The buffer should be small when only defaults are used.
// This value can be adjusted if the schema changes.
constexpr unsigned int buffer_size_threshold_in_bytes = 12;
TEST_ASSERT(builder.GetSize() <= buffer_size_threshold_in_bytes);
}
void DefaultVectorsStringsTest() {
DefaultVectorsStringsTest_EmptyOnDefault_Const();
DefaultVectorsStringsTest_EmptyOnDefault_Mutable();
DefaultVectorsStringsTest_WithValues();
DefaultVectorsStringsTest_BufferSize();
}
} // namespace tests
} // namespace flatbuffers

View File

@@ -0,0 +1,39 @@
// C++ Only Schema for Default Vectors Test
namespace DefaultVectorsStringsTest;
struct MyStruct {
a:int;
b:int;
}
table MyTable {
a:int;
}
enum MyEnum:byte { A, B }
table TableWithDefaultVectors {
int_vec:[int] = [];
bool_vec:[bool] = [];
char_vec:[byte] = [];
uchar_vec:[ubyte] = [];
short_vec:[short] = [];
ushort_vec:[ushort] = [];
uint_vec:[uint] = [];
long_vec:[long] = [];
ulong_vec:[ulong] = [];
float_vec:[float] = [];
double_vec:[double] = [];
string_vec:[string] = [];
empty_string:string = "";
some_string:string = "some";
struct_vec:[MyStruct] = [];
table_vec:[MyTable] = [];
enum_vec:[MyEnum] = [];
regular_int_vec:[int];
regular_int:int;
int_vec_offset64:[int] = [] (offset64);
int_vec64:[int]= [] (vector64);
}
root_type TableWithDefaultVectors;

View File

@@ -0,0 +1,17 @@
#ifndef THIRDPARTY_FLATBUFFERS_TESTS_DEFAULT_VECTORS_STRINGS_TEST_H_
#define THIRDPARTY_FLATBUFFERS_TESTS_DEFAULT_VECTORS_STRINGS_TEST_H_
namespace flatbuffers {
namespace tests {
void DefaultVectorsStringsTest_EmptyOnDefault_Const();
void DefaultVectorsStringsTest_EmptyOnDefault_Mutable();
void DefaultVectorsStringsTest_EmptyOnDefault();
void DefaultVectorsStringsTest_WithValues();
void DefaultVectorsStringsTest_BufferSize();
void DefaultVectorsStringsTest();
} // namespace tests
} // namespace flatbuffers
#endif // THIRDPARTY_FLATBUFFERS_TESTS_DEFAULT_VECTORS_STRINGS_TEST_H_

View File

@@ -34,6 +34,7 @@
#include "third_party/absl/container/flat_hash_set.h"
#endif
#include "alignment_test.h"
#include "default_vectors_strings_test.h"
#include "evolution_test.h"
#include "flatbuffers/flatbuffers.h"
#include "flatbuffers/idl.h"
@@ -1836,6 +1837,7 @@ int FlatBufferTests(const std::string& tests_data_path) {
Offset64Tests();
UnionUnderlyingTypeTest();
StructsInHashTableTest();
DefaultVectorsStringsTest();
return 0;
}
} // namespace