cmd/protoc-gen-go: additional conflict resolution for oneof field types
This is purely for consistent output with the previous protoc-gen-go.
Consider this message:
message M {
oneof union { string conflict = 1; }
message Conflict {}
}
The type for the wrapper of M.conflict will have the same name as the
embedded message type for M.Conflict.
The previous protoc-gen-go performs a disambiguation step where it adds
_s to the names of oneof field types until they have no conflicts with
nested messages or enums in the same message as the field.
There are a number of ways in which this can fail, of course. Preserve
the behavior for now.
Change-Id: I78a1c6588b577324e003b8bc337b75bb363432ba
Reviewed-on: https://go-review.googlesource.com/136357
Reviewed-by: Joe Tsai <thebrokentoaster@gmail.com>
diff --git a/cmd/protoc-gen-go/main.go b/cmd/protoc-gen-go/main.go
index 8c73c0c..2c94298 100644
--- a/cmd/protoc-gen-go/main.go
+++ b/cmd/protoc-gen-go/main.go
@@ -526,7 +526,7 @@
defaultValue := fieldDefaultValue(g, message, field)
g.P("func (m *", message.GoIdent, ") Get", field.GoName, "() ", goType, " {")
if field.OneofType != nil {
- g.P("if x, ok := m.Get", field.OneofType.GoName, "().(*", message.GoIdent.GoName, "_", field.GoName, "); ok {")
+ g.P("if x, ok := m.Get", field.OneofType.GoName, "().(*", fieldOneofType(field), "); ok {")
g.P("return x.", field.GoName)
g.P("}")
} else {
diff --git a/cmd/protoc-gen-go/oneof.go b/cmd/protoc-gen-go/oneof.go
index 98880ec..2e788fe 100644
--- a/cmd/protoc-gen-go/oneof.go
+++ b/cmd/protoc-gen-go/oneof.go
@@ -339,8 +339,32 @@
// fieldOneofType returns the wrapper type used to represent a field in a oneof.
func fieldOneofType(field *protogen.Field) protogen.GoIdent {
- return protogen.GoIdent{
+ ident := protogen.GoIdent{
GoImportPath: field.ParentMessage.GoIdent.GoImportPath,
GoName: field.ParentMessage.GoIdent.GoName + "_" + field.GoName,
}
+ // Check for collisions with nested messages or enums.
+ //
+ // This conflict resolution is incomplete: Among other things, it
+ // does not consider collisions with other oneof field types.
+ //
+ // TODO: Consider dropping this entirely. Detecting conflicts and
+ // producing an error is almost certainly better than permuting
+ // field and type names in mostly unpredictable ways.
+Loop:
+ for {
+ for _, message := range field.ParentMessage.Messages {
+ if message.GoIdent == ident {
+ ident.GoName += "_"
+ continue Loop
+ }
+ }
+ for _, enum := range field.ParentMessage.Enums {
+ if enum.GoIdent == ident {
+ ident.GoName += "_"
+ continue Loop
+ }
+ }
+ return ident
+ }
}
diff --git a/cmd/protoc-gen-go/testdata/fieldnames/fieldnames.pb.go b/cmd/protoc-gen-go/testdata/fieldnames/fieldnames.pb.go
index 570e348..6e6e84c 100644
--- a/cmd/protoc-gen-go/testdata/fieldnames/fieldnames.pb.go
+++ b/cmd/protoc-gen-go/testdata/fieldnames/fieldnames.pb.go
@@ -54,7 +54,12 @@
// Types that are valid to be assigned to OneofConflictB:
// *Message_OneofNoConflict
// *Message_OneofConflictB_
- OneofConflictB isMessage_OneofConflictB `protobuf_oneof:"oneof_conflict_b"`
+ OneofConflictB isMessage_OneofConflictB `protobuf_oneof:"oneof_conflict_b"`
+ // Oneof with a field name that conflicts with a nested message.
+ //
+ // Types that are valid to be assigned to OneofConflictC:
+ // *Message_OneofMessageConflict_
+ OneofConflictC isMessage_OneofConflictC `protobuf_oneof:"oneof_conflict_c"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
@@ -244,12 +249,37 @@
return ""
}
+type isMessage_OneofConflictC interface {
+ isMessage_OneofConflictC()
+}
+
+type Message_OneofMessageConflict_ struct {
+ OneofMessageConflict string `protobuf:"bytes,60,opt,name=oneof_message_conflict,json=oneofMessageConflict,oneof"`
+}
+
+func (*Message_OneofMessageConflict_) isMessage_OneofConflictC() {}
+
+func (m *Message) GetOneofConflictC() isMessage_OneofConflictC {
+ if m != nil {
+ return m.OneofConflictC
+ }
+ return nil
+}
+
+func (m *Message) GetOneofMessageConflict() string {
+ if x, ok := m.GetOneofConflictC().(*Message_OneofMessageConflict_); ok {
+ return x.OneofMessageConflict
+ }
+ return ""
+}
+
// XXX_OneofFuncs is for the internal use of the proto package.
func (*Message) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{}) {
return _Message_OneofMarshaler, _Message_OneofUnmarshaler, _Message_OneofSizer, []interface{}{
(*Message_OneofConflictA)(nil),
(*Message_OneofNoConflict)(nil),
(*Message_OneofConflictB_)(nil),
+ (*Message_OneofMessageConflict_)(nil),
}
}
@@ -276,6 +306,15 @@
default:
return fmt.Errorf("Message.OneofConflictB has unexpected type %T", x)
}
+ // oneof_conflict_c
+ switch x := m.OneofConflictC.(type) {
+ case *Message_OneofMessageConflict_:
+ b.EncodeVarint(60<<3 | proto.WireBytes)
+ b.EncodeStringBytes(x.OneofMessageConflict)
+ case nil:
+ default:
+ return fmt.Errorf("Message.OneofConflictC has unexpected type %T", x)
+ }
return nil
}
@@ -303,6 +342,13 @@
x, err := b.DecodeStringBytes()
m.OneofConflictB = &Message_OneofConflictB_{x}
return true, err
+ case 60: // oneof_conflict_c.oneof_message_conflict
+ if wire != proto.WireBytes {
+ return true, proto.ErrInternalBadWireType
+ }
+ x, err := b.DecodeStringBytes()
+ m.OneofConflictC = &Message_OneofMessageConflict_{x}
+ return true, err
default:
return false, nil
}
@@ -334,39 +380,83 @@
default:
panic(fmt.Sprintf("proto: unexpected type %T in oneof", x))
}
+ // oneof_conflict_c
+ switch x := m.OneofConflictC.(type) {
+ case *Message_OneofMessageConflict_:
+ n += 2 // tag and wire
+ n += proto.SizeVarint(uint64(len(x.OneofMessageConflict)))
+ n += len(x.OneofMessageConflict)
+ case nil:
+ default:
+ panic(fmt.Sprintf("proto: unexpected type %T in oneof", x))
+ }
return n
}
+type Message_OneofMessageConflict struct {
+ XXX_NoUnkeyedLiteral struct{} `json:"-"`
+ XXX_unrecognized []byte `json:"-"`
+ XXX_sizecache int32 `json:"-"`
+}
+
+func (m *Message_OneofMessageConflict) Reset() { *m = Message_OneofMessageConflict{} }
+func (m *Message_OneofMessageConflict) String() string { return proto.CompactTextString(m) }
+func (*Message_OneofMessageConflict) ProtoMessage() {}
+func (*Message_OneofMessageConflict) Descriptor() ([]byte, []int) {
+ return fileDescriptor_6bbe3f70febb9403, []int{0, 0}
+}
+
+func (m *Message_OneofMessageConflict) XXX_Unmarshal(b []byte) error {
+ return xxx_messageInfo_Message_OneofMessageConflict.Unmarshal(m, b)
+}
+func (m *Message_OneofMessageConflict) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) {
+ return xxx_messageInfo_Message_OneofMessageConflict.Marshal(b, m, deterministic)
+}
+func (m *Message_OneofMessageConflict) XXX_Merge(src proto.Message) {
+ xxx_messageInfo_Message_OneofMessageConflict.Merge(m, src)
+}
+func (m *Message_OneofMessageConflict) XXX_Size() int {
+ return xxx_messageInfo_Message_OneofMessageConflict.Size(m)
+}
+func (m *Message_OneofMessageConflict) XXX_DiscardUnknown() {
+ xxx_messageInfo_Message_OneofMessageConflict.DiscardUnknown(m)
+}
+
+var xxx_messageInfo_Message_OneofMessageConflict proto.InternalMessageInfo
+
func init() {
proto.RegisterType((*Message)(nil), "goproto.protoc.fieldnames.Message")
+ proto.RegisterType((*Message_OneofMessageConflict)(nil), "goproto.protoc.fieldnames.Message.OneofMessageConflict")
}
func init() { proto.RegisterFile("fieldnames/fieldnames.proto", fileDescriptor_6bbe3f70febb9403) }
var fileDescriptor_6bbe3f70febb9403 = []byte{
- // 382 bytes of a gzipped FileDescriptorProto
- 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x6c, 0x92, 0x4b, 0x6f, 0xd3, 0x40,
- 0x10, 0xc7, 0x09, 0x44, 0x6a, 0x3c, 0x69, 0x79, 0xac, 0x78, 0x6c, 0x69, 0x31, 0x08, 0x2e, 0x39,
- 0x50, 0x5b, 0x82, 0x33, 0x42, 0x24, 0x52, 0xc5, 0x85, 0x56, 0x8a, 0x72, 0xe2, 0xb2, 0x5a, 0xd6,
- 0xe3, 0x4d, 0x24, 0x7b, 0x27, 0x5a, 0x6f, 0xc4, 0x17, 0xe5, 0x03, 0x21, 0xcf, 0xc6, 0x76, 0x94,
- 0xe6, 0x36, 0xf3, 0xfb, 0x3f, 0xac, 0xb1, 0x0d, 0x57, 0xe5, 0x06, 0xab, 0xc2, 0xe9, 0x1a, 0x9b,
- 0x7c, 0x18, 0xb3, 0xad, 0xa7, 0x40, 0xe2, 0xd2, 0x12, 0x0f, 0x71, 0x35, 0xd9, 0x60, 0xf8, 0xf8,
- 0x6f, 0x0c, 0x67, 0xbf, 0xb0, 0x69, 0xb4, 0x45, 0x71, 0x05, 0x09, 0x2b, 0x8a, 0x1c, 0xca, 0xd1,
- 0x87, 0xd1, 0x2c, 0x59, 0x4e, 0x18, 0xdc, 0x3b, 0x14, 0x6f, 0x61, 0x72, 0xdb, 0xce, 0xab, 0xbf,
- 0x24, 0x1f, 0x47, 0xad, 0xdb, 0x45, 0x0a, 0xc0, 0xbe, 0xd5, 0xda, 0x23, 0xca, 0x27, 0xac, 0x1e,
- 0x10, 0x91, 0xc2, 0x34, 0x16, 0xab, 0x92, 0x76, 0x5e, 0x8e, 0xd9, 0x10, 0x9f, 0x75, 0x4b, 0x3b,
- 0xdf, 0xe6, 0x0b, 0x6c, 0x8c, 0xdf, 0x6c, 0x03, 0x79, 0x09, 0x31, 0x3f, 0x10, 0x21, 0xe1, 0xac,
- 0xd6, 0xbe, 0x59, 0xeb, 0x4a, 0x4e, 0x59, 0xec, 0x56, 0x71, 0x0d, 0xc9, 0xce, 0x75, 0xda, 0x79,
- 0xec, 0xed, 0x81, 0xf8, 0x04, 0x17, 0x7c, 0xb1, 0xaa, 0xe3, 0x85, 0xf2, 0x82, 0x1d, 0xe7, 0x0c,
- 0xbb, 0xab, 0xaf, 0x21, 0x59, 0xe8, 0x1a, 0xab, 0x85, 0x6e, 0x50, 0xbe, 0x8c, 0x15, 0x3d, 0x10,
- 0xef, 0x00, 0xfa, 0x45, 0xc9, 0x57, 0x27, 0x64, 0xd3, 0x2e, 0xca, 0xb4, 0xe9, 0xd7, 0x51, 0x36,
- 0xbd, 0x9c, 0xc2, 0x74, 0x48, 0x2b, 0xf9, 0xe6, 0x38, 0x7e, 0x09, 0x13, 0x8b, 0x41, 0xb5, 0x9f,
- 0x42, 0xa6, 0xf1, 0x32, 0x8b, 0xe1, 0x4e, 0xd7, 0x28, 0x04, 0x8c, 0x19, 0xbf, 0x67, 0xcc, 0xb3,
- 0x98, 0xc1, 0xd3, 0x7b, 0x87, 0x54, 0x2e, 0xc8, 0x95, 0xd5, 0xc6, 0x84, 0x1f, 0x72, 0xd6, 0xaa,
- 0x3f, 0x1f, 0x2d, 0x8f, 0xb8, 0xf8, 0x0c, 0x2f, 0xa8, 0x25, 0xca, 0x91, 0x32, 0x7b, 0x2a, 0xbf,
- 0xb0, 0x79, 0xb4, 0x7c, 0xc6, 0xd2, 0x1d, 0x75, 0xf6, 0x07, 0xbd, 0x73, 0xf9, 0x75, 0x6f, 0x3d,
- 0xe2, 0x73, 0x01, 0xcf, 0x63, 0x6f, 0x57, 0xaa, 0xf4, 0x09, 0xf6, 0x67, 0xfe, 0xfd, 0xf7, 0x37,
- 0x4b, 0x64, 0x2b, 0xcc, 0x2c, 0x55, 0xda, 0xd9, 0x8c, 0xbc, 0xcd, 0xf9, 0xb5, 0xe7, 0xa6, 0x2e,
- 0xe2, 0x64, 0x6e, 0x2c, 0xba, 0x1b, 0x4b, 0x79, 0xc0, 0x26, 0x14, 0x3a, 0xe8, 0x83, 0x1f, 0xf7,
- 0x7f, 0x00, 0x00, 0x00, 0xff, 0xff, 0x92, 0xbf, 0xac, 0x4e, 0xd0, 0x02, 0x00, 0x00,
+ // 411 bytes of a gzipped FileDescriptorProto
+ 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x6c, 0x93, 0x4b, 0x8b, 0x13, 0x41,
+ 0x10, 0xc7, 0xcd, 0xba, 0xb2, 0x49, 0x65, 0xd7, 0x47, 0x13, 0x63, 0xef, 0xc3, 0x28, 0x7a, 0xc9,
+ 0xc1, 0x4d, 0x40, 0xc1, 0x93, 0x22, 0x26, 0xb0, 0x78, 0x71, 0x03, 0xc3, 0x9e, 0xbc, 0x34, 0x6d,
+ 0x4f, 0x4d, 0x6f, 0x60, 0xa6, 0x6b, 0xe9, 0xe9, 0xe0, 0x57, 0xf3, 0xe3, 0xc9, 0x54, 0xcf, 0x23,
+ 0xc4, 0xb9, 0x55, 0xfd, 0xfe, 0x8f, 0x50, 0xd3, 0x04, 0x2e, 0xb3, 0x2d, 0xe6, 0xa9, 0xd3, 0x05,
+ 0x96, 0xcb, 0x6e, 0x5c, 0x3c, 0x78, 0x0a, 0x24, 0xce, 0x2d, 0xf1, 0x10, 0x57, 0xb3, 0xe8, 0x0c,
+ 0xef, 0xfe, 0x3e, 0x81, 0x93, 0x9f, 0x58, 0x96, 0xda, 0xa2, 0xb8, 0x84, 0x11, 0x2b, 0x8a, 0x1c,
+ 0xca, 0xc1, 0xdb, 0xc1, 0x7c, 0x94, 0x0c, 0x19, 0x6c, 0x1c, 0x8a, 0x0b, 0x18, 0xde, 0x54, 0xf3,
+ 0xdd, 0x1f, 0x92, 0x47, 0x51, 0x6b, 0x76, 0x31, 0x03, 0x60, 0xdf, 0xdd, 0xbd, 0x47, 0x94, 0x8f,
+ 0x59, 0xdd, 0x23, 0x62, 0x06, 0xe3, 0x58, 0xac, 0x32, 0xda, 0x79, 0x79, 0xcc, 0x86, 0xf8, 0x5b,
+ 0x37, 0xb4, 0xf3, 0x55, 0x3e, 0xc5, 0xd2, 0xf8, 0xed, 0x43, 0x20, 0x2f, 0x21, 0xe6, 0x3b, 0x22,
+ 0x24, 0x9c, 0x14, 0xda, 0x97, 0xf7, 0x3a, 0x97, 0x63, 0x16, 0x9b, 0x55, 0x5c, 0xc1, 0x68, 0xe7,
+ 0x1a, 0xed, 0x34, 0xf6, 0xb6, 0x40, 0xbc, 0x87, 0x33, 0xbe, 0x58, 0x15, 0xf1, 0x42, 0x79, 0xc6,
+ 0x8e, 0x53, 0x86, 0xcd, 0xd5, 0x57, 0x30, 0x5a, 0xeb, 0x02, 0xf3, 0xb5, 0x2e, 0x51, 0x4e, 0x62,
+ 0x45, 0x0b, 0xc4, 0x6b, 0x80, 0x76, 0x51, 0xf2, 0x65, 0x8f, 0x6c, 0xaa, 0x45, 0x99, 0x2a, 0x3d,
+ 0x8d, 0xb2, 0x69, 0xe5, 0x19, 0x8c, 0xbb, 0xb4, 0x92, 0xaf, 0x0e, 0xe3, 0xe7, 0x30, 0xb4, 0x18,
+ 0x54, 0xf5, 0x14, 0x72, 0x16, 0x2f, 0xb3, 0x18, 0x6e, 0x75, 0x81, 0x42, 0xc0, 0x31, 0xe3, 0x37,
+ 0x8c, 0x79, 0x16, 0x73, 0x78, 0xba, 0x71, 0x48, 0xd9, 0x9a, 0x5c, 0x96, 0x6f, 0x4d, 0xf8, 0x2e,
+ 0xe7, 0x95, 0xfa, 0xe3, 0x51, 0x72, 0xc0, 0xc5, 0x07, 0x78, 0x41, 0x15, 0x51, 0x8e, 0x94, 0xa9,
+ 0xa9, 0xfc, 0xc8, 0xe6, 0x41, 0xf2, 0x8c, 0xa5, 0x5b, 0x6a, 0xec, 0xff, 0xf5, 0xae, 0xe4, 0xa7,
+ 0xda, 0x7a, 0xc0, 0xc5, 0x67, 0x98, 0xc6, 0xde, 0xfa, 0x8b, 0x76, 0xe5, 0x5f, 0x38, 0x71, 0x94,
+ 0x4c, 0x58, 0xaf, 0x3f, 0x6e, 0x13, 0xbc, 0x98, 0xc2, 0x64, 0xd3, 0xc3, 0x57, 0x02, 0x9e, 0xc7,
+ 0xbe, 0xa6, 0x47, 0xe9, 0x1e, 0xf6, 0xbb, 0x87, 0x99, 0xd5, 0xb7, 0x5f, 0x5f, 0x2d, 0x91, 0xcd,
+ 0x71, 0x61, 0x29, 0xd7, 0xce, 0x2e, 0xc8, 0xdb, 0x25, 0x3f, 0xed, 0xd2, 0x14, 0x69, 0x9c, 0xcc,
+ 0xb5, 0x45, 0x77, 0x6d, 0x69, 0x19, 0xb0, 0x0c, 0xa9, 0x0e, 0x7a, 0xef, 0xcf, 0xf1, 0x2f, 0x00,
+ 0x00, 0xff, 0xff, 0xe0, 0x4d, 0xd2, 0x82, 0x34, 0x03, 0x00, 0x00,
}
diff --git a/cmd/protoc-gen-go/testdata/fieldnames/fieldnames.proto b/cmd/protoc-gen-go/testdata/fieldnames/fieldnames.proto
index 9b4b917..4301804 100644
--- a/cmd/protoc-gen-go/testdata/fieldnames/fieldnames.proto
+++ b/cmd/protoc-gen-go/testdata/fieldnames/fieldnames.proto
@@ -46,4 +46,10 @@
string oneof_no_conflict = 50;
string OneofConflictB = 51;
}
+
+ // Oneof with a field name that conflicts with a nested message.
+ oneof oneof_conflict_c {
+ string oneof_message_conflict = 60;
+ }
+ message OneofMessageConflict {}
}
