1
// Copyright 2018 The Go Authors. All rights reserved.
2
// Use of this source code is governed by a BSD-style
3
// license that can be found in the LICENSE file.
12
"google.golang.org/protobuf/encoding/prototext"
13
"google.golang.org/protobuf/internal/errors"
14
"google.golang.org/protobuf/proto"
15
"google.golang.org/protobuf/reflect/protoreflect"
16
"google.golang.org/protobuf/runtime/protoiface"
19
// Export is a zero-length named type that exists only to export a set of
20
// functions that we do not want to appear in godoc.
23
// NewError formats a string according to the format specifier and arguments and
24
// returns an error that has a "proto" prefix.
25
func (Export) NewError(f string, x ...interface{}) error {
26
return errors.New(f, x...)
29
// enum is any enum type generated by protoc-gen-go
30
// and must be a named int32 type.
31
type enum = interface{}
33
// EnumOf returns the protoreflect.Enum interface over e.
34
// It returns nil if e is nil.
35
func (Export) EnumOf(e enum) protoreflect.Enum {
36
switch e := e.(type) {
39
case protoreflect.Enum:
42
return legacyWrapEnum(reflect.ValueOf(e))
46
// EnumDescriptorOf returns the protoreflect.EnumDescriptor for e.
47
// It returns nil if e is nil.
48
func (Export) EnumDescriptorOf(e enum) protoreflect.EnumDescriptor {
49
switch e := e.(type) {
52
case protoreflect.Enum:
55
return LegacyLoadEnumDesc(reflect.TypeOf(e))
59
// EnumTypeOf returns the protoreflect.EnumType for e.
60
// It returns nil if e is nil.
61
func (Export) EnumTypeOf(e enum) protoreflect.EnumType {
62
switch e := e.(type) {
65
case protoreflect.Enum:
68
return legacyLoadEnumType(reflect.TypeOf(e))
72
// EnumStringOf returns the enum value as a string, either as the name if
73
// the number is resolvable, or the number formatted as a string.
74
func (Export) EnumStringOf(ed protoreflect.EnumDescriptor, n protoreflect.EnumNumber) string {
75
ev := ed.Values().ByNumber(n)
77
return string(ev.Name())
79
return strconv.Itoa(int(n))
82
// message is any message type generated by protoc-gen-go
83
// and must be a pointer to a named struct type.
84
type message = interface{}
86
// legacyMessageWrapper wraps a v2 message as a v1 message.
87
type legacyMessageWrapper struct{ m protoreflect.ProtoMessage }
89
func (m legacyMessageWrapper) Reset() { proto.Reset(m.m) }
90
func (m legacyMessageWrapper) String() string { return Export{}.MessageStringOf(m.m) }
91
func (m legacyMessageWrapper) ProtoMessage() {}
93
// ProtoMessageV1Of converts either a v1 or v2 message to a v1 message.
94
// It returns nil if m is nil.
95
func (Export) ProtoMessageV1Of(m message) protoiface.MessageV1 {
96
switch mv := m.(type) {
99
case protoiface.MessageV1:
102
return Export{}.ProtoMessageV1Of(mv.protoUnwrap())
103
case protoreflect.ProtoMessage:
104
return legacyMessageWrapper{mv}
106
panic(fmt.Sprintf("message %T is neither a v1 or v2 Message", m))
110
func (Export) protoMessageV2Of(m message) protoreflect.ProtoMessage {
111
switch mv := m.(type) {
114
case protoreflect.ProtoMessage:
116
case legacyMessageWrapper:
118
case protoiface.MessageV1:
121
panic(fmt.Sprintf("message %T is neither a v1 or v2 Message", m))
125
// ProtoMessageV2Of converts either a v1 or v2 message to a v2 message.
126
// It returns nil if m is nil.
127
func (Export) ProtoMessageV2Of(m message) protoreflect.ProtoMessage {
131
if mv := (Export{}).protoMessageV2Of(m); mv != nil {
134
return legacyWrapMessage(reflect.ValueOf(m)).Interface()
137
// MessageOf returns the protoreflect.Message interface over m.
138
// It returns nil if m is nil.
139
func (Export) MessageOf(m message) protoreflect.Message {
143
if mv := (Export{}).protoMessageV2Of(m); mv != nil {
144
return mv.ProtoReflect()
146
return legacyWrapMessage(reflect.ValueOf(m))
149
// MessageDescriptorOf returns the protoreflect.MessageDescriptor for m.
150
// It returns nil if m is nil.
151
func (Export) MessageDescriptorOf(m message) protoreflect.MessageDescriptor {
155
if mv := (Export{}).protoMessageV2Of(m); mv != nil {
156
return mv.ProtoReflect().Descriptor()
158
return LegacyLoadMessageDesc(reflect.TypeOf(m))
161
// MessageTypeOf returns the protoreflect.MessageType for m.
162
// It returns nil if m is nil.
163
func (Export) MessageTypeOf(m message) protoreflect.MessageType {
167
if mv := (Export{}).protoMessageV2Of(m); mv != nil {
168
return mv.ProtoReflect().Type()
170
return legacyLoadMessageType(reflect.TypeOf(m), "")
173
// MessageStringOf returns the message value as a string,
174
// which is the message serialized in the protobuf text format.
175
func (Export) MessageStringOf(m protoreflect.ProtoMessage) string {
176
return prototext.MarshalOptions{Multiline: false}.Format(m)