Expand VisitDescriptor to support mutable access to the proto.

PiperOrigin-RevId: 547625871
pull/13316/head
Mike Kruskal 1 year ago committed by Mike Kruskal
parent 4018fa893e
commit b81d2cc8c5
  1. 74
      src/google/protobuf/descriptor_visitor.h
  2. 18
      src/google/protobuf/descriptor_visitor_test.cc

@ -46,6 +46,10 @@ template <typename Visitor>
void VisitDescriptors(const FileDescriptor& file, void VisitDescriptors(const FileDescriptor& file,
const FileDescriptorProto& proto, Visitor visitor); const FileDescriptorProto& proto, Visitor visitor);
template <typename Visitor>
void VisitDescriptors(const FileDescriptor& file, FileDescriptorProto& proto,
Visitor visitor);
// Visit just the descriptors, without a corresponding proto tree. // Visit just the descriptors, without a corresponding proto tree.
template <typename Visitor> template <typename Visitor>
void VisitDescriptors(const FileDescriptor& file, Visitor visitor); void VisitDescriptors(const FileDescriptor& file, Visitor visitor);
@ -54,92 +58,111 @@ template <typename Visitor>
struct VisitImpl { struct VisitImpl {
Visitor visitor; Visitor visitor;
template <typename... Proto> template <typename... Proto>
void Visit(const FieldDescriptor& descriptor, const Proto&... proto) { void Visit(const FieldDescriptor& descriptor, Proto&... proto) {
visitor(descriptor, proto...); visitor(descriptor, proto...);
} }
template <typename... Proto> template <typename... Proto>
void Visit(const EnumValueDescriptor& descriptor, const Proto&... proto) { void Visit(const EnumValueDescriptor& descriptor, Proto&... proto) {
visitor(descriptor, proto...); visitor(descriptor, proto...);
} }
template <typename... Proto> template <typename... Proto>
void Visit(const EnumDescriptor& descriptor, const Proto&... proto) { void Visit(const EnumDescriptor& descriptor, Proto&... proto) {
visitor(descriptor, proto...); visitor(descriptor, proto...);
for (int i = 0; i < descriptor.value_count(); i++) { for (int i = 0; i < descriptor.value_count(); i++) {
Visit(*descriptor.value(i), proto.value(i)...); Visit(*descriptor.value(i), value(proto, i)...);
} }
} }
template <typename... Proto> template <typename... Proto>
void Visit(const Descriptor::ExtensionRange& descriptor, void Visit(const Descriptor::ExtensionRange& descriptor, Proto&... proto) {
const Proto&... proto) {
visitor(descriptor, proto...); visitor(descriptor, proto...);
} }
template <typename... Proto> template <typename... Proto>
void Visit(const OneofDescriptor& descriptor, const Proto&... proto) { void Visit(const OneofDescriptor& descriptor, Proto&... proto) {
visitor(descriptor, proto...); visitor(descriptor, proto...);
} }
template <typename... Proto> template <typename... Proto>
void Visit(const Descriptor& descriptor, const Proto&... proto) { void Visit(const Descriptor& descriptor, Proto&... proto) {
visitor(descriptor, proto...); visitor(descriptor, proto...);
for (int i = 0; i < descriptor.enum_type_count(); i++) { for (int i = 0; i < descriptor.enum_type_count(); i++) {
Visit(*descriptor.enum_type(i), proto.enum_type(i)...); Visit(*descriptor.enum_type(i), enum_type(proto, i)...);
} }
for (int i = 0; i < descriptor.oneof_decl_count(); i++) { for (int i = 0; i < descriptor.oneof_decl_count(); i++) {
Visit(*descriptor.oneof_decl(i), proto.oneof_decl(i)...); Visit(*descriptor.oneof_decl(i), oneof_decl(proto, i)...);
} }
for (int i = 0; i < descriptor.field_count(); i++) { for (int i = 0; i < descriptor.field_count(); i++) {
Visit(*descriptor.field(i), proto.field(i)...); Visit(*descriptor.field(i), field(proto, i)...);
} }
for (int i = 0; i < descriptor.nested_type_count(); i++) { for (int i = 0; i < descriptor.nested_type_count(); i++) {
Visit(*descriptor.nested_type(i), proto.nested_type(i)...); Visit(*descriptor.nested_type(i), nested_type(proto, i)...);
} }
for (int i = 0; i < descriptor.extension_count(); i++) { for (int i = 0; i < descriptor.extension_count(); i++) {
Visit(*descriptor.extension(i), proto.extension(i)...); Visit(*descriptor.extension(i), extension(proto, i)...);
} }
for (int i = 0; i < descriptor.extension_range_count(); i++) { for (int i = 0; i < descriptor.extension_range_count(); i++) {
Visit(*descriptor.extension_range(i), proto.extension_range(i)...); Visit(*descriptor.extension_range(i), extension_range(proto, i)...);
} }
} }
template <typename... Proto> template <typename... Proto>
void Visit(const MethodDescriptor& method, const Proto&... proto) { void Visit(const MethodDescriptor& method, Proto&... proto) {
visitor(method, proto...); visitor(method, proto...);
} }
template <typename... Proto> template <typename... Proto>
void Visit(const ServiceDescriptor& descriptor, const Proto&... proto) { void Visit(const ServiceDescriptor& descriptor, Proto&... proto) {
visitor(descriptor, proto...); visitor(descriptor, proto...);
for (int i = 0; i < descriptor.method_count(); i++) { for (int i = 0; i < descriptor.method_count(); i++) {
Visit(*descriptor.method(i), proto.method(i)...); Visit(*descriptor.method(i), method(proto, i)...);
} }
} }
template <typename... Proto> template <typename... Proto>
void Visit(const FileDescriptor& descriptor, const Proto&... proto) { void Visit(const FileDescriptor& descriptor, Proto&... proto) {
visitor(descriptor, proto...); visitor(descriptor, proto...);
for (int i = 0; i < descriptor.message_type_count(); i++) { for (int i = 0; i < descriptor.message_type_count(); i++) {
Visit(*descriptor.message_type(i), proto.message_type(i)...); Visit(*descriptor.message_type(i), message_type(proto, i)...);
} }
for (int i = 0; i < descriptor.enum_type_count(); i++) { for (int i = 0; i < descriptor.enum_type_count(); i++) {
Visit(*descriptor.enum_type(i), proto.enum_type(i)...); Visit(*descriptor.enum_type(i), enum_type(proto, i)...);
} }
for (int i = 0; i < descriptor.extension_count(); i++) { for (int i = 0; i < descriptor.extension_count(); i++) {
Visit(*descriptor.extension(i), proto.extension(i)...); Visit(*descriptor.extension(i), extension(proto, i)...);
} }
for (int i = 0; i < descriptor.service_count(); i++) { for (int i = 0; i < descriptor.service_count(); i++) {
Visit(*descriptor.service(i), proto.service(i)...); Visit(*descriptor.service(i), service(proto, i)...);
} }
} }
private:
#define CREATE_NESTED_GETTER(TYPE, NESTED) \
inline auto& NESTED(TYPE& desc, int i) { return *desc.mutable_##NESTED(i); } \
inline auto& NESTED(const TYPE& desc, int i) { return desc.NESTED(i); }
CREATE_NESTED_GETTER(DescriptorProto, enum_type);
CREATE_NESTED_GETTER(DescriptorProto, extension);
CREATE_NESTED_GETTER(DescriptorProto, extension_range);
CREATE_NESTED_GETTER(DescriptorProto, field);
CREATE_NESTED_GETTER(DescriptorProto, nested_type);
CREATE_NESTED_GETTER(DescriptorProto, oneof_decl);
CREATE_NESTED_GETTER(EnumDescriptorProto, value);
CREATE_NESTED_GETTER(FileDescriptorProto, enum_type);
CREATE_NESTED_GETTER(FileDescriptorProto, extension);
CREATE_NESTED_GETTER(FileDescriptorProto, message_type);
CREATE_NESTED_GETTER(FileDescriptorProto, service);
CREATE_NESTED_GETTER(ServiceDescriptorProto, method);
#undef CREATE_NESTED_GETTER
}; };
// Provide a fallback to ignore all the nodes that are not interesting to the // Provide a fallback to ignore all the nodes that are not interesting to the
@ -167,6 +190,13 @@ void VisitDescriptors(const FileDescriptor& file,
internal::VisitImpl<VisitorImpl>{VisitorImpl(visitor)}.Visit(file, proto); internal::VisitImpl<VisitorImpl>{VisitorImpl(visitor)}.Visit(file, proto);
} }
template <typename Visitor>
void VisitDescriptors(const FileDescriptor& file, FileDescriptorProto& proto,
Visitor visitor) {
using VisitorImpl = internal::VisitorImpl<Visitor>;
internal::VisitImpl<VisitorImpl>{VisitorImpl(visitor)}.Visit(file, proto);
}
template <typename Visitor> template <typename Visitor>
void VisitDescriptors(const FileDescriptor& file, Visitor visitor) { void VisitDescriptors(const FileDescriptor& file, Visitor visitor) {
using VisitorImpl = internal::VisitorImpl<Visitor>; using VisitorImpl = internal::VisitorImpl<Visitor>;

@ -78,6 +78,24 @@ TEST(VisitDescriptorsTest, SingleTypeWithProto) {
"protobuf_unittest.TestAllTypes.NestedMessage"})); "protobuf_unittest.TestAllTypes.NestedMessage"}));
} }
TEST(VisitDescriptorsTest, SingleTypeMutableProto) {
const FileDescriptor& file =
*protobuf_unittest::TestAllTypes::GetDescriptor()->file();
FileDescriptorProto proto;
file.CopyTo(&proto);
std::vector<std::string> descriptors;
VisitDescriptors(file, proto,
[&](const Descriptor& descriptor, DescriptorProto& proto) {
descriptors.push_back(descriptor.full_name());
EXPECT_EQ(descriptor.name(), proto.name());
proto.set_name("<redacted>");
});
EXPECT_THAT(descriptors,
IsSupersetOf({"protobuf_unittest.TestAllTypes",
"protobuf_unittest.TestAllTypes.NestedMessage"}));
EXPECT_EQ(proto.message_type(0).name(), "<redacted>");
}
TEST(VisitDescriptorsTest, AllTypesDeduce) { TEST(VisitDescriptorsTest, AllTypesDeduce) {
const FileDescriptor& file = const FileDescriptor& file =
*protobuf_unittest::TestAllTypes::GetDescriptor()->file(); *protobuf_unittest::TestAllTypes::GetDescriptor()->file();

Loading…
Cancel
Save