This repository has been archived by the owner on Oct 21, 2022. It is now read-only.
forked from bufbuild/protocompile
/
resolve.go
724 lines (674 loc) · 22.3 KB
/
resolve.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
package linker
import (
"fmt"
"strings"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protoreflect"
"google.golang.org/protobuf/types/descriptorpb"
"google.golang.org/protobuf/types/dynamicpb"
"github.com/jhump/protocompile/ast"
"github.com/jhump/protocompile/internal"
"github.com/jhump/protocompile/reporter"
"github.com/jhump/protocompile/walk"
)
func (r *result) ResolveMessageType(name protoreflect.FullName) protoreflect.MessageDescriptor {
d := r.resolveElement(name)
if md, ok := d.(protoreflect.MessageDescriptor); ok {
return md
}
return nil
}
func (r *result) ResolveEnumType(name protoreflect.FullName) protoreflect.EnumDescriptor {
d := r.resolveElement(name)
if ed, ok := d.(protoreflect.EnumDescriptor); ok {
return ed
}
return nil
}
func (r *result) ResolveExtension(name protoreflect.FullName) protoreflect.ExtensionTypeDescriptor {
d := r.resolveElement(name)
if ed, ok := d.(protoreflect.ExtensionDescriptor); ok {
if !ed.IsExtension() {
return nil
}
if td, ok := ed.(protoreflect.ExtensionTypeDescriptor); ok {
return td
}
return dynamicpb.NewExtensionType(ed).TypeDescriptor()
}
return nil
}
func (r *result) resolveElement(name protoreflect.FullName) protoreflect.Descriptor {
if len(name) > 0 && name[0] == '.' {
name = name[1:]
}
importedFd, res := resolveElement(r, name, false, nil)
if importedFd != nil {
r.markUsed(importedFd.Path())
}
return res
}
func (r *result) markUsed(importPath string) {
r.usedImports[importPath] = struct{}{}
}
func (r *result) CheckForUnusedImports(handler *reporter.Handler) {
fd := r.Proto()
file, _ := r.FileNode().(*ast.FileNode)
for i, dep := range fd.Dependency {
if _, ok := r.usedImports[dep]; !ok {
isPublic := false
// it's fine if it's a public import
for _, j := range fd.PublicDependency {
if i == int(j) {
isPublic = true
break
}
}
if isPublic {
continue
}
pos := ast.UnknownPos(fd.GetName())
if file != nil {
for _, decl := range file.Decls {
imp, ok := decl.(*ast.ImportNode)
if ok && imp.Name.AsString() == dep {
pos = file.NodeInfo(imp).Start()
}
}
}
handler.HandleWarning(pos, errUnusedImport(dep))
}
}
}
func resolveElement(f File, fqn protoreflect.FullName, publicImportsOnly bool, checked []string) (imported File, d protoreflect.Descriptor) {
path := f.Path()
for _, str := range checked {
if str == path {
// already checked
return nil, nil
}
}
checked = append(checked, path)
r := resolveElementInFile(fqn, f)
if r != nil {
// not imported, but present in f
return nil, r
}
// When publicImportsOnly = false, we are searching only directly imported symbols. But
// we also need to search transitive public imports due to semantics of public imports.
for i := 0; i < f.Imports().Len(); i++ {
dep := f.Imports().Get(i)
if dep.IsPublic || !publicImportsOnly {
depFile := f.FindImportByPath(dep.Path())
_, d := resolveElement(depFile, fqn, true, checked)
if d != nil {
return depFile, d
}
}
}
return nil, nil
}
func (r *result) toDescriptor(fqn string, d proto.Message) protoreflect.Descriptor {
if ret := r.descriptors[d]; ret != nil {
// don't bother searching for parent if we don't need it...
return ret
}
parent, index := r.findParent(fqn)
switch d := d.(type) {
case *descriptorpb.DescriptorProto:
return r.asMessageDescriptor(d, r, parent, index, fqn)
case *descriptorpb.FieldDescriptorProto:
return r.asFieldDescriptor(d, r, parent, index, fqn)
case *descriptorpb.OneofDescriptorProto:
return r.asOneOfDescriptor(d, r, parent.(*msgDescriptor), index, fqn)
case *descriptorpb.EnumDescriptorProto:
return r.asEnumDescriptor(d, r, parent, index, fqn)
case *descriptorpb.EnumValueDescriptorProto:
return r.asEnumValueDescriptor(d, r, parent.(*enumDescriptor), index, fqn)
case *descriptorpb.ServiceDescriptorProto:
return r.asServiceDescriptor(d, r, index, fqn)
case *descriptorpb.MethodDescriptorProto:
return r.asMethodDescriptor(d, r, parent.(*svcDescriptor), index, fqn)
default:
// WTF? panic?
return nil
}
}
func (r *result) findParent(fqn string) (protoreflect.Descriptor, int) {
names := strings.Split(strings.TrimPrefix(fqn, r.prefix), ".")
if len(names) == 1 {
for i, en := range r.Proto().EnumType {
if en.GetName() == names[0] {
return r, i
}
for j, env := range en.Value {
if env.GetName() == names[0] {
return r.asEnumDescriptor(en, r, r, i, r.prefix+en.GetName()), j
}
}
}
for i, ext := range r.Proto().Extension {
if ext.GetName() == names[0] {
return r, i
}
}
}
for i, svc := range r.Proto().Service {
if svc.GetName() == names[0] {
if len(names) == 1 {
return r, i
} else {
if len(names) != 2 {
return nil, 0
}
sd := r.asServiceDescriptor(svc, r, i, r.prefix+svc.GetName())
for j, mtd := range svc.Method {
if mtd.GetName() == names[1] {
return sd, j
}
}
}
}
}
for i, msg := range r.Proto().MessageType {
if msg.GetName() == names[0] {
if len(names) == 1 {
return r, i
}
md := r.asMessageDescriptor(msg, r, r, i, r.prefix+msg.GetName())
return r.findParentInMessage(md, names[1:])
}
}
return nil, 0
}
func (r *result) findParentInMessage(msg *msgDescriptor, names []string) (protoreflect.Descriptor, int) {
if len(names) == 1 {
for i, en := range msg.proto.EnumType {
if en.GetName() == names[0] {
return msg, i
}
for j, env := range en.Value {
if env.GetName() == names[0] {
return r.asEnumDescriptor(en, msg.file, msg, i, msg.fqn+"."+en.GetName()), j
}
}
}
for i, ext := range msg.proto.Extension {
if ext.GetName() == names[0] {
return msg, i
}
}
for i, fld := range msg.proto.Field {
if fld.GetName() == names[0] {
return msg, i
}
}
for i, ood := range msg.proto.OneofDecl {
if ood.GetName() == names[0] {
return msg, i
}
}
}
for i, nested := range msg.proto.NestedType {
if nested.GetName() == names[0] {
if len(names) == 1 {
return msg, i
}
md := r.asMessageDescriptor(nested, msg.file, msg, i, msg.fqn+"."+nested.GetName())
return r.findParentInMessage(md, names[1:])
}
}
return nil, 0
}
func descriptorType(d protoreflect.Descriptor) string {
switch d := d.(type) {
case protoreflect.MessageDescriptor:
return "message"
case protoreflect.FieldDescriptor:
if d.IsExtension() {
return "extension"
}
return "field"
case protoreflect.EnumDescriptor:
return "enum"
case protoreflect.EnumValueDescriptor:
return "enum value"
case protoreflect.ServiceDescriptor:
return "service"
case protoreflect.MethodDescriptor:
return "method"
case protoreflect.FileDescriptor:
return "file"
default:
// shouldn't be possible
return fmt.Sprintf("%T", d)
}
}
func (r *result) resolveReferences(handler *reporter.Handler, s *Symbols) error {
fd := r.Proto()
scopes := []scope{fileScope(r)}
if fd.Options != nil {
if err := r.resolveOptions(handler, "file", protoreflect.FullName(fd.GetName()), fd.Options.UninterpretedOption, scopes); err != nil {
return err
}
}
return walk.DescriptorProtosEnterAndExit(fd,
func(fqn protoreflect.FullName, d proto.Message) error {
switch d := d.(type) {
case *descriptorpb.DescriptorProto:
scopes = append(scopes, messageScope(r, fqn)) // push new scope on entry
if d.Options != nil {
if err := r.resolveOptions(handler, "message", fqn, d.Options.UninterpretedOption, scopes); err != nil {
return err
}
}
// walk only visits descriptors, so we need to loop over extension ranges ourselves
for _, er := range d.ExtensionRange {
if er.Options != nil {
erName := protoreflect.FullName(fmt.Sprintf("%s:%d-%d", fqn, er.GetStart(), er.GetEnd()-1))
if err := r.resolveOptions(handler, "extension range", erName, er.Options.UninterpretedOption, scopes); err != nil {
return err
}
}
}
case *descriptorpb.FieldDescriptorProto:
elemType := "field"
if d.GetExtendee() != "" {
elemType = "extension"
}
if d.Options != nil {
if err := r.resolveOptions(handler, elemType, fqn, d.Options.UninterpretedOption, scopes); err != nil {
return err
}
}
if err := r.resolveFieldTypes(handler, s, fqn, d, scopes); err != nil {
return err
}
case *descriptorpb.OneofDescriptorProto:
if d.Options != nil {
if err := r.resolveOptions(handler, "one-of", fqn, d.Options.UninterpretedOption, scopes); err != nil {
return err
}
}
case *descriptorpb.EnumDescriptorProto:
if d.Options != nil {
if err := r.resolveOptions(handler, "enum", fqn, d.Options.UninterpretedOption, scopes); err != nil {
return err
}
}
case *descriptorpb.EnumValueDescriptorProto:
if d.Options != nil {
if err := r.resolveOptions(handler, "enum value", fqn, d.Options.UninterpretedOption, scopes); err != nil {
return err
}
}
case *descriptorpb.ServiceDescriptorProto:
// not a message, but same scoping rules for nested elements as if it were
scopes = append(scopes, messageScope(r, fqn)) // push new scope on entry
if d.Options != nil {
if err := r.resolveOptions(handler, "service", fqn, d.Options.UninterpretedOption, scopes); err != nil {
return err
}
}
case *descriptorpb.MethodDescriptorProto:
if d.Options != nil {
if err := r.resolveOptions(handler, "method", fqn, d.Options.UninterpretedOption, scopes); err != nil {
return err
}
}
if err := r.resolveMethodTypes(handler, fqn, d, scopes); err != nil {
return err
}
}
return nil
},
func(fqn protoreflect.FullName, d proto.Message) error {
switch d.(type) {
case *descriptorpb.DescriptorProto, *descriptorpb.ServiceDescriptorProto:
// pop message scope on exit
scopes = scopes[:len(scopes)-1]
}
return nil
})
}
func (r *result) resolveFieldTypes(handler *reporter.Handler, s *Symbols, fqn protoreflect.FullName, fld *descriptorpb.FieldDescriptorProto, scopes []scope) error {
scope := fmt.Sprintf("field %s", fqn)
file := r.FileNode()
node := r.FieldNode(fld)
elemType := "field"
if fld.GetExtendee() != "" {
elemType = "extension"
dsc := r.resolve(fld.GetExtendee(), true, scopes)
if dsc == nil {
return handler.HandleErrorf(file.NodeInfo(node.FieldExtendee()).Start(), "unknown extendee type %s", fld.GetExtendee())
}
if isSentinelDescriptor(dsc) {
return handler.HandleErrorf(file.NodeInfo(node.FieldExtendee()).Start(), "unknown extendee type %s; resolved to %s which is not defined; consider using a leading dot", fld.GetExtendee(), dsc.FullName())
}
extd, ok := dsc.(protoreflect.MessageDescriptor)
if !ok {
otherType := descriptorType(dsc)
return handler.HandleErrorf(file.NodeInfo(node.FieldExtendee()).Start(), "extendee is invalid: %s is a %s, not a message", dsc.FullName(), otherType)
}
fld.Extendee = proto.String("." + string(dsc.FullName()))
// make sure the tag number is in range
found := false
tag := protoreflect.FieldNumber(fld.GetNumber())
for i := 0; i < extd.ExtensionRanges().Len(); i++ {
rng := extd.ExtensionRanges().Get(i)
if tag >= rng[0] && tag < rng[1] {
found = true
break
}
}
if !found {
if err := handler.HandleErrorf(file.NodeInfo(node.FieldTag()).Start(), "%s: tag %d is not in valid range for extended type %s", scope, tag, dsc.FullName()); err != nil {
return err
}
} else {
// make sure tag is not a duplicate
if err := s.addExtension(dsc.FullName(), tag, file.NodeInfo(node.FieldTag()).Start(), handler); err != nil {
return err
}
}
}
if fld.Options != nil {
if err := r.resolveOptions(handler, elemType, fqn, fld.Options.UninterpretedOption, scopes); err != nil {
return err
}
}
if fld.GetTypeName() == "" {
// scalar type; no further resolution required
return nil
}
dsc := r.resolve(fld.GetTypeName(), true, scopes)
if dsc == nil {
return handler.HandleErrorf(file.NodeInfo(node.FieldType()).Start(), "%s: unknown type %s", scope, fld.GetTypeName())
}
if isSentinelDescriptor(dsc) {
return handler.HandleErrorf(file.NodeInfo(node.FieldType()).Start(), "%s: unknown type %s; resolved to %s which is not defined; consider using a leading dot", scope, fld.GetTypeName(), dsc.FullName())
}
switch dsc := dsc.(type) {
case protoreflect.MessageDescriptor:
fld.TypeName = proto.String("." + string(dsc.FullName()))
// if type was tentatively unset, we now know it's actually a message
if fld.Type == nil {
fld.Type = descriptorpb.FieldDescriptorProto_TYPE_MESSAGE.Enum()
}
case protoreflect.EnumDescriptor:
proto3 := r.Syntax() == protoreflect.Proto3
enumIsProto3 := dsc.ParentFile().Syntax() == protoreflect.Proto3
if fld.GetExtendee() == "" && proto3 && !enumIsProto3 {
// fields in a proto3 message cannot refer to proto2 enums
return handler.HandleErrorf(file.NodeInfo(node.FieldType()).Start(), "%s: cannot use proto2 enum %s in a proto3 message", scope, fld.GetTypeName())
}
fld.TypeName = proto.String("." + string(dsc.FullName()))
// the type was tentatively unset, but now we know it's actually an enum
fld.Type = descriptorpb.FieldDescriptorProto_TYPE_ENUM.Enum()
default:
otherType := descriptorType(dsc)
return handler.HandleErrorf(file.NodeInfo(node.FieldType()).Start(), "%s: invalid type: %s is a %s, not a message or enum", scope, dsc.FullName(), otherType)
}
return nil
}
func (r *result) resolveMethodTypes(handler *reporter.Handler, fqn protoreflect.FullName, mtd *descriptorpb.MethodDescriptorProto, scopes []scope) error {
scope := fmt.Sprintf("method %s", fqn)
file := r.FileNode()
node := r.MethodNode(mtd)
dsc := r.resolve(mtd.GetInputType(), false, scopes)
if dsc == nil {
if err := handler.HandleErrorf(file.NodeInfo(node.GetInputType()).Start(), "%s: unknown request type %s", scope, mtd.GetInputType()); err != nil {
return err
}
} else if isSentinelDescriptor(dsc) {
if err := handler.HandleErrorf(file.NodeInfo(node.GetInputType()).Start(), "%s: unknown request type %s; resolved to %s which is not defined; consider using a leading dot", scope, mtd.GetInputType(), dsc.FullName()); err != nil {
return err
}
} else if _, ok := dsc.(protoreflect.MessageDescriptor); !ok {
otherType := descriptorType(dsc)
if err := handler.HandleErrorf(file.NodeInfo(node.GetInputType()).Start(), "%s: invalid request type: %s is a %s, not a message", scope, dsc.FullName(), otherType); err != nil {
return err
}
} else {
mtd.InputType = proto.String("." + string(dsc.FullName()))
}
// TODO: make input and output type resolution more DRY
dsc = r.resolve(mtd.GetOutputType(), false, scopes)
if dsc == nil {
if err := handler.HandleErrorf(file.NodeInfo(node.GetOutputType()).Start(), "%s: unknown response type %s", scope, mtd.GetOutputType()); err != nil {
return err
}
} else if isSentinelDescriptor(dsc) {
if err := handler.HandleErrorf(file.NodeInfo(node.GetInputType()).Start(), "%s: unknown response type %s; resolved to %s which is not defined; consider using a leading dot", scope, mtd.GetOutputType(), dsc.FullName()); err != nil {
return err
}
} else if _, ok := dsc.(protoreflect.MessageDescriptor); !ok {
otherType := descriptorType(dsc)
if err := handler.HandleErrorf(file.NodeInfo(node.GetOutputType()).Start(), "%s: invalid response type: %s is a %s, not a message", scope, dsc.FullName(), otherType); err != nil {
return err
}
} else {
mtd.OutputType = proto.String("." + string(dsc.FullName()))
}
return nil
}
func (r *result) resolveOptions(handler *reporter.Handler, elemType string, elemName protoreflect.FullName, opts []*descriptorpb.UninterpretedOption, scopes []scope) error {
var scope string
if elemType != "file" {
scope = fmt.Sprintf("%s %s: ", elemType, elemName)
}
file := r.FileNode()
opts:
for _, opt := range opts {
for _, nm := range opt.Name {
if nm.GetIsExtension() {
node := r.OptionNamePartNode(nm)
dsc := r.resolve(nm.GetNamePart(), false, scopes)
if dsc == nil {
if err := handler.HandleErrorf(file.NodeInfo(node).Start(), "%sunknown extension %s", scope, nm.GetNamePart()); err != nil {
return err
}
continue opts
}
if isSentinelDescriptor(dsc) {
if err := handler.HandleErrorf(file.NodeInfo(node).Start(), "%sunknown extension %s; resolved to %s which is not defined; consider using a leading dot", scope, nm.GetNamePart(), dsc.FullName()); err != nil {
return err
}
continue opts
}
if ext, ok := dsc.(protoreflect.FieldDescriptor); !ok {
otherType := descriptorType(dsc)
if err := handler.HandleErrorf(file.NodeInfo(node).Start(), "%sinvalid extension: %s is a %s, not an extension", scope, nm.GetNamePart(), otherType); err != nil {
return err
}
continue opts
} else if !ext.IsExtension() {
if err := handler.HandleErrorf(file.NodeInfo(node).Start(), "%sinvalid extension: %s is a field but not an extension", scope, nm.GetNamePart()); err != nil {
return err
}
continue opts
}
nm.NamePart = proto.String("." + string(dsc.FullName()))
}
}
}
return nil
}
func (r *result) resolve(name string, onlyTypes bool, scopes []scope) protoreflect.Descriptor {
if strings.HasPrefix(name, ".") {
// already fully-qualified
return r.resolveElement(protoreflect.FullName(name[1:]))
}
// unqualified, so we look in the enclosing (last) scope first and move
// towards outermost (first) scope, trying to resolve the symbol
pos := strings.IndexByte(name, '.')
firstName := name
if pos > 0 {
firstName = name[:pos]
}
var bestGuess protoreflect.Descriptor
for i := len(scopes) - 1; i >= 0; i-- {
d := scopes[i](firstName, name)
if d != nil {
if !onlyTypes || isType(d) {
return d
} else if bestGuess == nil {
bestGuess = d
}
}
}
// we return best guess, even though it was not an allowed kind of
// descriptor, so caller can print a better error message (e.g.
// indicating that the name was found but that it's the wrong type)
return bestGuess
}
func isType(d protoreflect.Descriptor) bool {
switch d.(type) {
case protoreflect.MessageDescriptor, protoreflect.EnumDescriptor:
return true
}
return false
}
// scope represents a lexical scope in a proto file in which messages and enums
// can be declared.
type scope func(firstName, fullName string) protoreflect.Descriptor
func fileScope(r *result) scope {
// we search symbols in this file, but also symbols in other files that have
// the same package as this file or a "parent" package (in protobuf,
// packages are a hierarchy like C++ namespaces)
prefixes := internal.CreatePrefixList(r.Proto().GetPackage())
querySymbol := func(n string) protoreflect.Descriptor {
return r.resolveElement(protoreflect.FullName(n))
}
return func(firstName, fullName string) protoreflect.Descriptor {
for _, prefix := range prefixes {
var n1, n string
if prefix == "" {
// exhausted all prefixes, so it must be in this one
n1, n = fullName, fullName
} else {
n = prefix + "." + fullName
n1 = prefix + "." + firstName
}
d := resolveElementRelative(n1, n, querySymbol)
if d != nil {
return d
}
}
return nil
}
}
func messageScope(r *result, messageName protoreflect.FullName) scope {
querySymbol := func(n string) protoreflect.Descriptor {
return resolveElementInFile(protoreflect.FullName(n), r)
}
return func(firstName, fullName string) protoreflect.Descriptor {
n1 := string(messageName) + "." + firstName
n := string(messageName) + "." + fullName
return resolveElementRelative(n1, n, querySymbol)
}
}
func resolveElementRelative(firstName, fullName string, query func(name string) protoreflect.Descriptor) protoreflect.Descriptor {
d := query(firstName)
if d == nil {
return nil
}
if firstName == fullName {
return d
}
if !isAggregateDescriptor(d) {
// can't possibly find the rest of full name if
// the first name indicated a leaf descriptor
return nil
}
d = query(fullName)
if d == nil {
return newSentinelDescriptor(fullName)
}
return d
}
func resolveElementInFile(name protoreflect.FullName, f File) protoreflect.Descriptor {
d := f.FindDescriptorByName(name)
if d != nil {
return d
}
if matchesPkgNamespace(name, f.Package()) {
// this sentinel means the name is a valid namespace but
// does not refer to a descriptor
return newSentinelDescriptor(string(name))
}
return nil
}
func matchesPkgNamespace(fqn, pkg protoreflect.FullName) bool {
if pkg == "" {
return false
}
if fqn == pkg {
return true
}
if len(pkg) > len(fqn) && strings.HasPrefix(string(pkg), string(fqn)) {
// if char after fqn is a dot, then fqn is a namespace
if pkg[len(fqn)] == '.' {
return true
}
}
return false
}
func isAggregateDescriptor(d protoreflect.Descriptor) bool {
if isSentinelDescriptor(d) {
// this indicates the name matched a package, not a
// descriptor, but a package is an aggregate so
// we return true
return true
}
switch d.(type) {
case protoreflect.MessageDescriptor, protoreflect.EnumDescriptor, protoreflect.ServiceDescriptor:
return true
default:
return false
}
}
func isSentinelDescriptor(d protoreflect.Descriptor) bool {
_, ok := d.(*sentinelDescriptor)
return ok
}
func newSentinelDescriptor(name string) protoreflect.Descriptor {
return &sentinelDescriptor{name: name}
}
// sentinelDescriptor is a placeholder descriptor. It is used instead of nil to
// distinguish between two situations:
// 1. The given name could not be found.
// 2. The given name *cannot* be a valid result so stop seraching.
// In these cases, attempts to resolve an element name will return nil for the
// first case and will return a sentinelDescriptor in the second. The sentinel
// contains the fully-qualified name which caused the search to stop (which may
// be a prefix of the actual name being resolved).
type sentinelDescriptor struct {
protoreflect.Descriptor
name string
}
func (p *sentinelDescriptor) ParentFile() protoreflect.FileDescriptor {
return nil
}
func (p *sentinelDescriptor) Parent() protoreflect.Descriptor {
return nil
}
func (p *sentinelDescriptor) Index() int {
return 0
}
func (p *sentinelDescriptor) Syntax() protoreflect.Syntax {
return 0
}
func (p *sentinelDescriptor) Name() protoreflect.Name {
return protoreflect.Name(p.name)
}
func (p *sentinelDescriptor) FullName() protoreflect.FullName {
return protoreflect.FullName(p.name)
}
func (p sentinelDescriptor) IsPlaceholder() bool {
return false
}
func (p sentinelDescriptor) Options() protoreflect.ProtoMessage {
return nil
}
var _ protoreflect.Descriptor = (*sentinelDescriptor)(nil)