Merge pull request #75 from yoheimuta/parse-rpc-trailing-comment

feat: parsing the rpc's trailing comment followed by the left curly brace

Author: yoheimuta

parser/service.go

@@ -34,6 +34,8 @@ type RPC struct {
 	Comments []*Comment
 	// InlineComment is the optional one placed at the ending.
 	InlineComment *Comment
+	// InlineCommentBehindLeftCurly is the optional one placed behind a left curly.
+	InlineCommentBehindLeftCurly *Comment
 	// Meta is the meta information.
 	Meta meta.Meta
 }
@@ -99,7 +101,8 @@ func (s *Service) Accept(v Visitor) {
 }
 
 // ParseService parses the service.
-//  service = "service" serviceName "{" { option | rpc | emptyStatement } "}"
+//
+//	service = "service" serviceName "{" { option | rpc | emptyStatement } "}"
 //
 // See https://developers.google.com/protocol-buffers/docs/reference/proto3-spec#service_definition
 func (p *Parser) ParseService() (*Service, error) {
@@ -235,12 +238,13 @@ func (p *Parser) parseRPC() (*RPC, error) {
 	}
 
 	var opts []*Option
+	var inlineLeftCurly *Comment
 	p.lex.Next()
 	lastPos := p.lex.Pos
 	switch p.lex.Token {
 	case scanner.TLEFTCURLY:
 		p.lex.UnNext()
-		opts, err = p.parseRPCOptions()
+		opts, inlineLeftCurly, err = p.parseRPCOptions()
 		if err != nil {
 			return nil, err
 		}
@@ -259,10 +263,11 @@ func (p *Parser) parseRPC() (*RPC, error) {
 	}
 
 	return &RPC{
-		RPCName:     rpcName,
-		RPCRequest:  rpcRequest,
-		RPCResponse: rpcResponse,
-		Options:     opts,
+		RPCName:                      rpcName,
+		RPCRequest:                   rpcRequest,
+		RPCResponse:                  rpcResponse,
+		Options:                      opts,
+		InlineCommentBehindLeftCurly: inlineLeftCurly,
 		Meta: meta.Meta{
 			Pos:     startPos.Position,
 			LastPos: lastPos.Position,
@@ -338,12 +343,14 @@ func (p *Parser) parseRPCResponse() (*RPCResponse, error) {
 
 // rpcOptions = ( "{" {option | emptyStatement } "}" )
 // See https://developers.google.com/protocol-buffers/docs/reference/proto3-spec#service_definition
-func (p *Parser) parseRPCOptions() ([]*Option, error) {
+func (p *Parser) parseRPCOptions() ([]*Option, *Comment, error) {
 	p.lex.Next()
 	if p.lex.Token != scanner.TLEFTCURLY {
-		return nil, p.unexpected("{")
+		return nil, nil, p.unexpected("{")
 	}
 
+	inlineLeftCurly := p.parseInlineComment()
+
 	var options []*Option
 	for {
 		p.lex.NextKeyword()
@@ -354,7 +361,7 @@ func (p *Parser) parseRPCOptions() ([]*Option, error) {
 		case scanner.TOPTION:
 			option, err := p.ParseOption()
 			if err != nil {
-				return nil, err
+				return nil, nil, err
 			}
 			options = append(options, option)
 		case scanner.TRIGHTCURLY:
@@ -363,13 +370,13 @@ func (p *Parser) parseRPCOptions() ([]*Option, error) {
 		default:
 			err := p.lex.ReadEmptyStatement()
 			if err != nil {
-				return nil, err
+				return nil, nil, err
 			}
 		}
 
 		p.lex.Next()
 		if p.lex.Token == scanner.TRIGHTCURLY {
-			return options, nil
+			return options, inlineLeftCurly, nil
 		}
 		p.lex.UnNext()
 	}

parser/service_test.go

@@ -759,6 +759,101 @@ service SearchService {
 				},
 			},
 		},
+		{
+			name: "parsing the rpc with a trailing comment followd by the left curly",
+			input: `
+service SearchService {
+  rpc GetAll(GetRequest) returns(GetReply) { // get the global address table
+    option(requestreply.Nats).Subject = "get.addrs";
+  }
+}
+`,
+			wantService: &parser.Service{
+				ServiceName: "SearchService",
+				ServiceBody: []parser.Visitee{
+					&parser.RPC{
+						RPCName: "GetAll",
+						RPCRequest: &parser.RPCRequest{
+							MessageType: "GetRequest",
+							Meta: meta.Meta{
+								Pos: meta.Position{
+									Offset: 37,
+									Line:   3,
+									Column: 13,
+								},
+							},
+						},
+						RPCResponse: &parser.RPCResponse{
+							MessageType: "GetReply",
+							Meta: meta.Meta{
+								Pos: meta.Position{
+									Offset: 57,
+									Line:   3,
+									Column: 33,
+								},
+							},
+						},
+						Options: []*parser.Option{
+							{
+								OptionName: "(requestreply.Nats).Subject",
+								Constant:   `"get.addrs"`,
+								Meta: meta.Meta{
+									Pos: meta.Position{
+										Offset: 106,
+										Line:   4,
+										Column: 5,
+									},
+									LastPos: meta.Position{
+										Offset: 153,
+										Line:   4,
+										Column: 52,
+									},
+								},
+							},
+						},
+						InlineCommentBehindLeftCurly: &parser.Comment{
+							Raw: "// get the global address table",
+							Meta: meta.Meta{
+								Pos: meta.Position{
+									Offset: 70,
+									Line:   3,
+									Column: 46,
+								},
+								LastPos: meta.Position{
+									Offset: 100,
+									Line:   3,
+									Column: 76,
+								},
+							},
+						},
+						Meta: meta.Meta{
+							Pos: meta.Position{
+								Offset: 27,
+								Line:   3,
+								Column: 3,
+							},
+							LastPos: meta.Position{
+								Offset: 157,
+								Line:   5,
+								Column: 3,
+							},
+						},
+					},
+				},
+				Meta: meta.Meta{
+					Pos: meta.Position{
+						Offset: 1,
+						Line:   2,
+						Column: 1,
+					},
+					LastPos: meta.Position{
+						Offset: 159,
+						Line:   6,
+						Column: 1,
+					},
+				},
+			},
+		},
 	}
 
 	for _, test := range tests {