reflect/prototype: add NewGoEnum and NewGoMessage constructors
Add constructors for creating protoreflect.{Enum,Message}Type,
which extend the protobuf descriptor with Go type information.
Rationale for API:
* NewGoEnum and NewGoMessage take in a struct instead of multiple
function parameters to provide future flexibility in adding more parameters.
* NewGoEnum and NewGoMessage take in a pointer to a struct so that generated
code can batch allocate these structs and convert them to them to EnumTypes
or MessageTypes efficiently. In other words, allocations are entirely in the
control of the caller.
* The user provides a New function as opposed to a reflect.Type or pointer to
the concrete type to support dynamic protobufs, where a single Go type may be
used to represent multiple protobuf types.
* The New functions take in an EnumType or MessageType since an implementation
for dynamic protobufs would need to close over these types. All statically
generated messages can ignore that argument.
There are no tests added since these are just wrappers;
they will be heavily exercised by other code.
Change-Id: I9fca44e06f3388375be7eaca94f8fd75c17233a3
Reviewed-on: https://go-review.googlesource.com/135356
Reviewed-by: Damien Neil <dneil@google.com>
diff --git a/reflect/prototype/go_type.go b/reflect/prototype/go_type.go
new file mode 100644
index 0000000..0b8ee41
--- /dev/null
+++ b/reflect/prototype/go_type.go
@@ -0,0 +1,93 @@
+// Copyright 2018 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package prototype
+
+import (
+ "fmt"
+ "reflect"
+ "sync"
+
+ "google.golang.org/proto/reflect/protoreflect"
+)
+
+// GoEnum is a constructor for a protoreflect.EnumType.
+type GoEnum struct {
+ protoreflect.EnumDescriptor
+
+ // New returns a concrete proto.Enum value with the given enum number.
+ // The constructor must return the same concrete type for each invocation.
+ New func(protoreflect.EnumType, protoreflect.EnumNumber) protoreflect.ProtoEnum
+
+ once sync.Once
+ goType reflect.Type
+}
+type goEnum struct{ *GoEnum }
+
+// NewGoEnum creates a new protoreflect.EnumType.
+//
+// The caller must relinquish full ownership of the input t and must not
+// access or mutate any fields.
+func NewGoEnum(t *GoEnum) protoreflect.EnumType {
+ if t.IsPlaceholder() {
+ panic("enum descriptor must not be a placeholder")
+ }
+ if t.New == nil {
+ panic("invalid nil constructor for enum kind")
+ }
+ return goEnum{t}
+}
+func (p goEnum) GoNew(n protoreflect.EnumNumber) protoreflect.ProtoEnum {
+ e := p.New(p, n)
+ p.once.Do(func() { p.goType = reflect.TypeOf(e) })
+ if p.goType != reflect.TypeOf(e) {
+ panic(fmt.Sprintf("mismatching types for enum: got %T, want %v", e, p.goType))
+ }
+ return e
+}
+func (p goEnum) GoType() reflect.Type {
+ p.once.Do(func() { p.goType = reflect.TypeOf(p.New(p, 0)) })
+ return p.goType
+}
+
+// GoMessage is a constructor for a protoreflect.MessageType.
+type GoMessage struct {
+ protoreflect.MessageDescriptor
+
+ // New returns a new empty proto.Message instance.
+ // The constructor must return the same concrete type for each invocation.
+ New func(protoreflect.MessageType) protoreflect.ProtoMessage
+
+ once sync.Once
+ goType reflect.Type
+}
+type goMessage struct{ *GoMessage }
+
+// NewGoMessage creates a new protoreflect.MessageType.
+//
+// The caller must relinquish full ownership of the input t and must not
+// access or mutate any fields.
+func NewGoMessage(t *GoMessage) protoreflect.MessageType {
+ if t.IsPlaceholder() {
+ panic("message descriptor must not be a placeholder")
+ }
+ if t.New == nil {
+ panic("invalid nil constructor for message kind")
+ }
+ return goMessage{t}
+}
+func (p goMessage) GoNew() protoreflect.ProtoMessage {
+ m := p.New(p)
+ p.once.Do(func() { p.goType = reflect.TypeOf(m) })
+ if p.goType != reflect.TypeOf(m) {
+ panic(fmt.Sprintf("mismatching types for message: got %T, want %v", m, p.goType))
+ }
+ return m
+}
+func (p goMessage) GoType() reflect.Type {
+ p.once.Do(func() { p.goType = reflect.TypeOf(p.New(p)) })
+ return p.goType
+}
+
+// TODO: add extension support.
