Skip to content

F
flatbuffers
Commit 7b805357 authored by Wouter van Oortmerssen's avatar Wouter van Oortmerssen
Browse files
Options

Enums in C++ are now strongly typed. 

Accessors and constructors now take enum types rather than ints.

Bug: 16570507
Change-Id: I4b50fd64ad2e662ea2481bc0ccea784326fb31c0
Tested: on Linux and Windows.
parent 85c9c838
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 58 additions and 37 deletions
CMakeLists.txt
View file @ 7b805357
......@@ -71,7 +71,7 @@ add_executable(flatc ${FlatBuffers_Compiler_SRCS})
function(compile_flatbuffers_schema_to_cpp SRC_FBS)
get_filename_component(SRC_FBS_DIR ${SRC_FBS} DIRECTORY)
string(REGEX REPLACE ".fbs$" "_generated.h" GEN_HEADER ${SRC_FBS})
string(REGEX REPLACE "\\.fbs$" "_generated.h" GEN_HEADER ${SRC_FBS})
add_custom_command(
OUTPUT ${GEN_HEADER}
COMMAND flatc -c -o "${SRC_FBS_DIR}" "${CMAKE_CURRENT_SOURCE_DIR}/${SRC_FBS}"
......@@ -97,6 +97,7 @@ endif()
if(FLATBUFFERS_BUILD_TESTS)
enable_testing()
file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/tests" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}")
file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/tests" DESTINATION
"${CMAKE_CURRENT_BINARY_DIR}")
add_test(NAME flattests COMMAND flattests)
endif()
include/flatbuffers/flatbuffers.h
View file @ 7b805357
......@@ -259,6 +259,13 @@ public:
return IndirectHelper<T>::Read(Data(), i);
}
// If this is a Vector of enums, T will be its storage type, not the enum
// type. This function makes it convenient to retrieve value with enum
// type E.
template<typename E> E GetEnum(uoffset_t i) const {
return static_cast<E>(Get(i));
}
const void *GetStructFromOffset(size_t o) const {
return reinterpret_cast<const void *>(Data() + o);
}
......
include/flatbuffers/idl.h
View file @ 7b805357
......@@ -175,12 +175,13 @@ struct Namespace {
// Base class for all definition types (fields, structs_, enums_).
struct Definition {
Definition() : generated(false) {}
Definition() : generated(false), defined_namespace(nullptr) {}
std::string name;
std::string doc_comment;
SymbolTable<Value> attributes;
bool generated; // did we already output code for this definition?
Namespace *defined_namespace; // Where it was defined.
};
struct FieldDef : public Definition {
......@@ -199,8 +200,7 @@ struct StructDef : public Definition {
predecl(true),
sortbysize(true),
minalign(1),
bytesize(0),
defined_namespace(nullptr)
bytesize(0)
{}
void PadLastField(size_t minalign) {
......@@ -215,7 +215,6 @@ struct StructDef : public Definition {
bool sortbysize; // Whether fields come in the declaration or size order.
size_t minalign; // What the whole object needs to be aligned to.
size_t bytesize; // Size if fixed.
Namespace *defined_namespace; // Where it was defined.
};
inline bool IsStruct(const Type &type) {
......@@ -243,8 +242,9 @@ struct EnumVal {
struct EnumDef : public Definition {
EnumDef() : is_union(false) {}
EnumVal *ReverseLookup(int enum_idx) {
for (auto it = vals.vec.begin() + static_cast<int>(is_union);
EnumVal *ReverseLookup(int enum_idx, bool skip_union_default = true) {
for (auto it = vals.vec.begin() + static_cast<int>(is_union &&
skip_union_default);
it != vals.vec.end(); ++it) {
if ((*it)->value == enum_idx) {
return *it;
......
samples/monster_generated.h
View file @ 7b805357
......@@ -12,7 +12,7 @@ namespace Sample {
struct Vec3;
struct Monster;
enum {
enum Color {
Color_Red = 0,
Color_Green = 1,
Color_Blue = 2
......@@ -23,9 +23,9 @@ inline const char **EnumNamesColor() {
return names;
}
inline const char *EnumNameColor(int e) { return EnumNamesColor()[e]; }
inline const char *EnumNameColor(Color e) { return EnumNamesColor()[e]; }
enum {
enum Any {
Any_NONE = 0,
Any_Monster = 1
};
......@@ -35,7 +35,7 @@ inline const char **EnumNamesAny() {
return names;
}
inline const char *EnumNameAny(int e) { return EnumNamesAny()[e]; }
inline const char *EnumNameAny(Any e) { return EnumNamesAny()[e]; }
inline bool VerifyAny(flatbuffers::Verifier &verifier, const void *union_obj, uint8_t type);
......@@ -61,7 +61,7 @@ struct Monster : private flatbuffers::Table {
int16_t hp() const { return GetField<int16_t>(8, 100); }
const flatbuffers::String *name() const { return GetPointer<const flatbuffers::String *>(10); }
const flatbuffers::Vector<uint8_t> *inventory() const { return GetPointer<const flatbuffers::Vector<uint8_t> *>(14); }
int8_t color() const { return GetField<int8_t>(16, 2); }
Color color() const { return static_cast<Color>(GetField<int8_t>(16, 2)); }
bool Verify(flatbuffers::Verifier &verifier) const {
return VerifyTableStart(verifier) &&
VerifyField<Vec3>(verifier, 4 /* pos */) &&
......@@ -84,10 +84,13 @@ struct MonsterBuilder {
void add_hp(int16_t hp) { fbb_.AddElement<int16_t>(8, hp, 100); }
void add_name(flatbuffers::Offset<flatbuffers::String> name) { fbb_.AddOffset(10, name); }
void add_inventory(flatbuffers::Offset<flatbuffers::Vector<uint8_t>> inventory) { fbb_.AddOffset(14, inventory); }
void add_color(int8_t color) { fbb_.AddElement<int8_t>(16, color, 2); }
void add_color(Color color) { fbb_.AddElement<int8_t>(16, static_cast<int8_t>(color), 2); }
MonsterBuilder(flatbuffers::FlatBufferBuilder &_fbb) : fbb_(_fbb) { start_ = fbb_.StartTable(); }
MonsterBuilder &operator=(const MonsterBuilder &);
flatbuffers::Offset<Monster> Finish() { return flatbuffers::Offset<Monster>(fbb_.EndTable(start_, 7)); }
flatbuffers::Offset<Monster> Finish() {
auto o = flatbuffers::Offset<Monster>(fbb_.EndTable(start_, 7));
return o;
}
};
inline flatbuffers::Offset<Monster> CreateMonster(flatbuffers::FlatBufferBuilder &_fbb,
......@@ -96,7 +99,7 @@ inline flatbuffers::Offset<Monster> CreateMonster(flatbuffers::FlatBufferBuilder
int16_t hp = 100,
flatbuffers::Offset<flatbuffers::String> name = 0,
flatbuffers::Offset<flatbuffers::Vector<uint8_t>> inventory = 0,
int8_t color = 2) {
Color color = Color_Blue) {
MonsterBuilder builder_(_fbb);
builder_.add_inventory(inventory);
builder_.add_name(name);
......
src/idl_gen_cpp.cpp
View file @ 7b805357
This diff is collapsed.
src/idl_parser.cpp
View file @ 7b805357
......@@ -371,6 +371,15 @@ void Parser::ParseField(StructDef &struct_def) {
ParseSingleValue(field.value);
}
if (type.enum_def &&
IsScalar(type.base_type) &&
!struct_def.fixed &&
!type.enum_def->attributes.Lookup("bit_flags") &&
!type.enum_def->ReverseLookup(StringToInt(field.value.constant.c_str())))
Error("enum " + type.enum_def->name +
" does not have a declaration for this field\'s default of " +
field.value.constant);
field.doc_comment = dc;
ParseMetaData(field);
field.deprecated = field.attributes.Lookup("deprecated") != nullptr;
......@@ -703,6 +712,7 @@ void Parser::ParseEnum(bool is_union) {
enum_def.name = name;
enum_def.doc_comment = dc;
enum_def.is_union = is_union;
enum_def.defined_namespace = namespaces_.back();
if (enums_.Add(name, &enum_def)) Error("enum already exists: " + name);
if (is_union) {
enum_def.underlying_type.base_type = BASE_TYPE_UTYPE;
......
tests/FlatBuffers.Test/FlatBuffersExampleTests.cs
View file @ 7b805357
......@@ -68,7 +68,7 @@ namespace FlatBuffers.Test
Monster.StartMonster(fbb);
Monster.AddPos(fbb, Vec3.CreateVec3(fbb, 1.0f, 2.0f, 3.0f, 3.0,
(sbyte)4, (short)5, (sbyte)6));
Color.Green, (short)5, (sbyte)6));
Monster.AddHp(fbb, (short)80);
Monster.AddName(fbb, str);
Monster.AddInventory(fbb, inv);
......@@ -105,7 +105,7 @@ namespace FlatBuffers.Test
Assert.AreEqual(3.0f, pos.Z());
Assert.AreEqual(3.0f, pos.Test1());
Assert.AreEqual((sbyte)4, pos.Test2());
Assert.AreEqual(Color.Green, pos.Test2());
var t = pos.Test3();
Assert.AreEqual((short)5, t.A());
Assert.AreEqual((sbyte)6, t.B());
......
tests/JavaTest.java
View file @ 7b805357
......@@ -72,7 +72,7 @@ class JavaTest {
Monster.startMonster(fbb);
Monster.addPos(fbb, Vec3.createVec3(fbb, 1.0f, 2.0f, 3.0f, 3.0,
(byte)4, (short)5, (byte)6));
Color.Green, (short)5, (byte)6));
Monster.addHp(fbb, (short)80);
Monster.addName(fbb, str);
Monster.addInventory(fbb, inv);
......@@ -135,7 +135,7 @@ class JavaTest {
TestEq(pos.y(), 2.0f);
TestEq(pos.z(), 3.0f);
TestEq(pos.test1(), 3.0);
TestEq(pos.test2(), (byte)4);
TestEq(pos.test2(), Color.Green);
Test t = pos.test3();
TestEq(t.a(), (short)5);
TestEq(t.b(), (byte)6);
......
tests/monster_test.fbs
View file @ 7b805357
......@@ -15,7 +15,7 @@ struct Vec3 (force_align: 16) {
y:float;
z:float;
test1:double;
test2:byte;
test2:Color;
test3:Test;
}
......
tests/monster_test_generated.h
View file @ 7b805357
......@@ -18,7 +18,7 @@ struct Test;
struct Vec3;
struct Monster;
enum {
enum Color {
Color_Red = 1,
Color_Green = 2,
Color_Blue = 8
......@@ -29,9 +29,9 @@ inline const char **EnumNamesColor() {
return names;
}
inline const char *EnumNameColor(int e) { return EnumNamesColor()[e - Color_Red]; }
inline const char *EnumNameColor(Color e) { return EnumNamesColor()[e - Color_Red]; }
enum {
enum Any {
Any_NONE = 0,
Any_Monster = 1
};
......@@ -41,7 +41,7 @@ inline const char **EnumNamesAny() {
return names;
}
inline const char *EnumNameAny(int e) { return EnumNamesAny()[e]; }
inline const char *EnumNameAny(Any e) { return EnumNamesAny()[e]; }
inline bool VerifyAny(flatbuffers::Verifier &verifier, const void *union_obj, uint8_t type);
......@@ -73,14 +73,14 @@ MANUALLY_ALIGNED_STRUCT(16) Vec3 {
int16_t __padding2;
public:
Vec3(float x, float y, float z, double test1, int8_t test2, const Test &test3)
: x_(flatbuffers::EndianScalar(x)), y_(flatbuffers::EndianScalar(y)), z_(flatbuffers::EndianScalar(z)), __padding0(0), test1_(flatbuffers::EndianScalar(test1)), test2_(flatbuffers::EndianScalar(test2)), __padding1(0), test3_(test3), __padding2(0) { (void)__padding0; (void)__padding1; (void)__padding2; }
Vec3(float x, float y, float z, double test1, Color test2, const Test &test3)
: x_(flatbuffers::EndianScalar(x)), y_(flatbuffers::EndianScalar(y)), z_(flatbuffers::EndianScalar(z)), __padding0(0), test1_(flatbuffers::EndianScalar(test1)), test2_(flatbuffers::EndianScalar(static_cast<int8_t>(test2))), __padding1(0), test3_(test3), __padding2(0) { (void)__padding0; (void)__padding1; (void)__padding2; }
float x() const { return flatbuffers::EndianScalar(x_); }
float y() const { return flatbuffers::EndianScalar(y_); }
float z() const { return flatbuffers::EndianScalar(z_); }
double test1() const { return flatbuffers::EndianScalar(test1_); }
int8_t test2() const { return flatbuffers::EndianScalar(test2_); }
Color test2() const { return static_cast<Color>(flatbuffers::EndianScalar(test2_)); }
const Test &test3() const { return test3_; }
};
STRUCT_END(Vec3, 32);
......@@ -91,8 +91,8 @@ struct Monster : private flatbuffers::Table {
int16_t hp() const { return GetField<int16_t>(8, 100); }
const flatbuffers::String *name() const { return GetPointer<const flatbuffers::String *>(10); }
const flatbuffers::Vector<uint8_t> *inventory() const { return GetPointer<const flatbuffers::Vector<uint8_t> *>(14); }
int8_t color() const { return GetField<int8_t>(16, 8); }
uint8_t test_type() const { return GetField<uint8_t>(18, 0); }
Color color() const { return static_cast<Color>(GetField<int8_t>(16, 8)); }
Any test_type() const { return static_cast<Any>(GetField<uint8_t>(18, 0)); }
const void *test() const { return GetPointer<const void *>(20); }
const flatbuffers::Vector<const Test *> *test4() const { return GetPointer<const flatbuffers::Vector<const Test *> *>(22); }
const flatbuffers::Vector<flatbuffers::Offset<flatbuffers::String>> *testarrayofstring() const { return GetPointer<const flatbuffers::Vector<flatbuffers::Offset<flatbuffers::String>> *>(24); }
......@@ -141,8 +141,8 @@ struct MonsterBuilder {
void add_hp(int16_t hp) { fbb_.AddElement<int16_t>(8, hp, 100); }
void add_name(flatbuffers::Offset<flatbuffers::String> name) { fbb_.AddOffset(10, name); }
void add_inventory(flatbuffers::Offset<flatbuffers::Vector<uint8_t>> inventory) { fbb_.AddOffset(14, inventory); }
void add_color(int8_t color) { fbb_.AddElement<int8_t>(16, color, 8); }
void add_test_type(uint8_t test_type) { fbb_.AddElement<uint8_t>(18, test_type, 0); }
void add_color(Color color) { fbb_.AddElement<int8_t>(16, static_cast<int8_t>(color), 8); }
void add_test_type(Any test_type) { fbb_.AddElement<uint8_t>(18, static_cast<uint8_t>(test_type), 0); }
void add_test(flatbuffers::Offset<void> test) { fbb_.AddOffset(20, test); }
void add_test4(flatbuffers::Offset<flatbuffers::Vector<const Test *>> test4) { fbb_.AddOffset(22, test4); }
void add_testarrayofstring(flatbuffers::Offset<flatbuffers::Vector<flatbuffers::Offset<flatbuffers::String>>> testarrayofstring) { fbb_.AddOffset(24, testarrayofstring); }
......@@ -165,8 +165,8 @@ inline flatbuffers::Offset<Monster> CreateMonster(flatbuffers::FlatBufferBuilder
int16_t hp = 100,
flatbuffers::Offset<flatbuffers::String> name = 0,
flatbuffers::Offset<flatbuffers::Vector<uint8_t>> inventory = 0,
int8_t color = 8,
uint8_t test_type = 0,
Color color = Color_Blue,
Any test_type = Any_NONE,
flatbuffers::Offset<void> test = 0,
flatbuffers::Offset<flatbuffers::Vector<const Test *>> test4 = 0,
flatbuffers::Offset<flatbuffers::Vector<flatbuffers::Offset<flatbuffers::String>>> testarrayofstring = 0,
......
tests/monsterdata_test.golden
View file @ 7b805357
......@@ -4,7 +4,7 @@
y: 2,
z: 3,
test1: 3,
test2: 4,
test2: Green,
test3: {
a: 5,
b: 6
......
tests/monsterdata_test.json
View file @ 7b805357
......@@ -4,7 +4,7 @@
y: 2,
z: 3,
test1: 3,
test2: 4,
test2: Green,
test3: {
a: 5,
b: 6
......
tests/test.cpp
View file @ 7b805357
......@@ -63,7 +63,7 @@ void lcg_reset() { lcg_seed = 48271; }
std::string CreateFlatBufferTest() {
flatbuffers::FlatBufferBuilder builder;
auto vec = Vec3(1, 2, 3, 0, 0, Test(10, 20));
auto vec = Vec3(1, 2, 3, 0, Color_Red, Test(10, 20));
auto name = builder.CreateString("MyMonster");
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment