mirror of
https://github.com/protocolbuffers/protobuf-go.git
synced 2025-01-01 03:14:16 +00:00
784c482554
Change-Id: I62ec79419354a2c65ac69e4bcc1cc864a6a40a1a Reviewed-on: https://go-review.googlesource.com/c/protobuf/+/407934 Reviewed-by: Lasse Folger <lassefolger@google.com> Reviewed-by: Damien Neil <dneil@google.com>
90 lines
2.9 KiB
Go
90 lines
2.9 KiB
Go
// Copyright 2020 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 order
|
|
|
|
import (
|
|
"google.golang.org/protobuf/reflect/protoreflect"
|
|
)
|
|
|
|
// FieldOrder specifies the ordering to visit message fields.
|
|
// It is a function that reports whether x is ordered before y.
|
|
type FieldOrder func(x, y protoreflect.FieldDescriptor) bool
|
|
|
|
var (
|
|
// AnyFieldOrder specifies no specific field ordering.
|
|
AnyFieldOrder FieldOrder = nil
|
|
|
|
// LegacyFieldOrder sorts fields in the same ordering as emitted by
|
|
// wire serialization in the github.com/golang/protobuf implementation.
|
|
LegacyFieldOrder FieldOrder = func(x, y protoreflect.FieldDescriptor) bool {
|
|
ox, oy := x.ContainingOneof(), y.ContainingOneof()
|
|
inOneof := func(od protoreflect.OneofDescriptor) bool {
|
|
return od != nil && !od.IsSynthetic()
|
|
}
|
|
|
|
// Extension fields sort before non-extension fields.
|
|
if x.IsExtension() != y.IsExtension() {
|
|
return x.IsExtension() && !y.IsExtension()
|
|
}
|
|
// Fields not within a oneof sort before those within a oneof.
|
|
if inOneof(ox) != inOneof(oy) {
|
|
return !inOneof(ox) && inOneof(oy)
|
|
}
|
|
// Fields in disjoint oneof sets are sorted by declaration index.
|
|
if ox != nil && oy != nil && ox != oy {
|
|
return ox.Index() < oy.Index()
|
|
}
|
|
// Fields sorted by field number.
|
|
return x.Number() < y.Number()
|
|
}
|
|
|
|
// NumberFieldOrder sorts fields by their field number.
|
|
NumberFieldOrder FieldOrder = func(x, y protoreflect.FieldDescriptor) bool {
|
|
return x.Number() < y.Number()
|
|
}
|
|
|
|
// IndexNameFieldOrder sorts non-extension fields before extension fields.
|
|
// Non-extensions are sorted according to their declaration index.
|
|
// Extensions are sorted according to their full name.
|
|
IndexNameFieldOrder FieldOrder = func(x, y protoreflect.FieldDescriptor) bool {
|
|
// Non-extension fields sort before extension fields.
|
|
if x.IsExtension() != y.IsExtension() {
|
|
return !x.IsExtension() && y.IsExtension()
|
|
}
|
|
// Extensions sorted by fullname.
|
|
if x.IsExtension() && y.IsExtension() {
|
|
return x.FullName() < y.FullName()
|
|
}
|
|
// Non-extensions sorted by declaration index.
|
|
return x.Index() < y.Index()
|
|
}
|
|
)
|
|
|
|
// KeyOrder specifies the ordering to visit map entries.
|
|
// It is a function that reports whether x is ordered before y.
|
|
type KeyOrder func(x, y protoreflect.MapKey) bool
|
|
|
|
var (
|
|
// AnyKeyOrder specifies no specific key ordering.
|
|
AnyKeyOrder KeyOrder = nil
|
|
|
|
// GenericKeyOrder sorts false before true, numeric keys in ascending order,
|
|
// and strings in lexicographical ordering according to UTF-8 codepoints.
|
|
GenericKeyOrder KeyOrder = func(x, y protoreflect.MapKey) bool {
|
|
switch x.Interface().(type) {
|
|
case bool:
|
|
return !x.Bool() && y.Bool()
|
|
case int32, int64:
|
|
return x.Int() < y.Int()
|
|
case uint32, uint64:
|
|
return x.Uint() < y.Uint()
|
|
case string:
|
|
return x.String() < y.String()
|
|
default:
|
|
panic("invalid map key type")
|
|
}
|
|
}
|
|
)
|