Add PackageComments and SyntaxComments to FileDescriptor

fixtures/todo.proto

@@ -1,3 +1,4 @@
+// Top-level comments are attached to the syntax directive.
 syntax = "proto3";
 
 import "google/protobuf/any.proto";

parser.go

@@ -16,6 +16,7 @@ const (
 	enumCommentPath      = 5
 	serviceCommentPath   = 6
 	extensionCommentPath = 7
+	syntaxCommentPath    = 12
 
 	// tag numbers in DescriptorProto
 	messageFieldCommentPath     = 2 // field
@@ -59,6 +60,8 @@ func parseFile(ctx context.Context, fd *descriptor.FileDescriptorProto) *FileDes
 		comments:            comments,
 		FileDescriptorProto: fd,
 		Comments:            comments.Get(fmt.Sprintf("%d", packageCommentPath)),
+		PackageComments:     comments.Get(fmt.Sprintf("%d", packageCommentPath)),
+		SyntaxComments:      comments.Get(fmt.Sprintf("%d", syntaxCommentPath)),
 	}
 
 	fileCtx := ContextWithFileDescriptor(ctx, file)

parser_test.go

@@ -34,7 +34,8 @@ func (assert *ParserTest) SetupSuite() {
 
 func (assert *ParserTest) TestFileParsing() {
 	assert.True(proto3.IsProto3())
-	assert.Contains(proto3.GetComments().String(), "The official documentation for the Todo API.\n\n")
+	assert.Equal("Top-level comments are attached to the syntax directive.", proto3.GetSyntaxComments().String())
+	assert.Contains(proto3.GetPackageComments().String(), "The official documentation for the Todo API.\n\n")
 	assert.Len(proto3.GetExtensions(), 0) // no extensions in proto3
 
 	assert.False(proto2.IsProto3())

types.go

@@ -53,7 +53,10 @@ type FileDescriptor struct {
 	comments Comments
 	*descriptor.FileDescriptorProto
 
-	Comments   *Comment
+	Comments        *Comment // Deprecated: see PackageComments
+	PackageComments *Comment
+	SyntaxComments  *Comment
+
 	Enums      []*EnumDescriptor
 	Extensions []*ExtensionDescriptor
 	Imports    []*ImportedDescriptor
@@ -64,9 +67,17 @@ type FileDescriptor struct {
 // IsProto3 returns whether or not this file is a proto3 file
 func (f *FileDescriptor) IsProto3() bool { return f.GetSyntax() == "proto3" }
 
-// GetComments returns the file's package comments
+// GetComments returns the file's package comments.
+//
+// Deprecated: please see GetPackageComments
 func (f *FileDescriptor) GetComments() *Comment { return f.Comments }
 
+// GetPackageComments returns the file's package comments
+func (f *FileDescriptor) GetPackageComments() *Comment { return f.PackageComments }
+
+// GetSyntaxComments returns the file's syntax comments
+func (f *FileDescriptor) GetSyntaxComments() *Comment { return f.SyntaxComments }
+
 // GetEnums returns the top-level enumerations defined in this file
 func (f *FileDescriptor) GetEnums() []*EnumDescriptor { return f.Enums }