Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parse docstrings for functions #246

Merged
merged 2 commits into from
Jul 20, 2020
Merged

Parse docstrings for functions #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8256d29
parse docstrings for functions
turbolent Jul 20, 2020
3360414
bring back skipSpaceAndComments
turbolent Jul 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions runtime/ast/function_declaration.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ type FunctionDeclaration struct {
ParameterList *ParameterList
ReturnTypeAnnotation *TypeAnnotation
FunctionBlock *FunctionBlock
DocString string
StartPos Position
}

Expand Down
22 changes: 14 additions & 8 deletions runtime/parser2/declaration.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ import (

func parseDeclarations(p *parser, endTokenType lexer.TokenType) (declarations []ast.Declaration) {
for {
p.skipSpaceAndComments(true)
_, docString := p.parseTrivia(triviaOptions{
skipNewlines: true,
parseDocStrings: true,
})

switch p.current.Type {
case lexer.TokenSemicolon:
Expand All @@ -44,7 +47,7 @@ func parseDeclarations(p *parser, endTokenType lexer.TokenType) (declarations []
return

default:
declaration := parseDeclaration(p)
declaration := parseDeclaration(p, docString)
if declaration == nil {
return
}
Expand All @@ -54,7 +57,7 @@ func parseDeclarations(p *parser, endTokenType lexer.TokenType) (declarations []
}
}

func parseDeclaration(p *parser) ast.Declaration {
func parseDeclaration(p *parser, docString string) ast.Declaration {

access := ast.AccessNotSpecified
var accessPos *ast.Position
Expand All @@ -71,7 +74,7 @@ func parseDeclaration(p *parser) ast.Declaration {
return parseVariableDeclaration(p, access, accessPos)

case keywordFun:
return parseFunctionDeclaration(p, false, access, accessPos)
return parseFunctionDeclaration(p, false, access, accessPos, docString)

case keywordImport:
return parseImportDeclaration(p)
Expand Down Expand Up @@ -840,7 +843,10 @@ func parseMembersAndNestedDeclarations(
members = &ast.Members{}

for {
p.skipSpaceAndComments(true)
_, docString := p.parseTrivia(triviaOptions{
skipNewlines: true,
parseDocStrings: true,
})

switch p.current.Type {
case lexer.TokenSemicolon:
Expand All @@ -852,7 +858,7 @@ func parseMembersAndNestedDeclarations(
return

default:
memberOrNestedDeclaration := parseMemberOrNestedDeclaration(p)
memberOrNestedDeclaration := parseMemberOrNestedDeclaration(p, docString)
if memberOrNestedDeclaration == nil {
return
}
Expand Down Expand Up @@ -892,7 +898,7 @@ func parseMembersAndNestedDeclarations(
// | compositeDeclaration
// | eventDeclaration
//
func parseMemberOrNestedDeclaration(p *parser) ast.Declaration {
func parseMemberOrNestedDeclaration(p *parser, docString string) ast.Declaration {

const functionBlockIsOptional = true

Expand All @@ -911,7 +917,7 @@ func parseMemberOrNestedDeclaration(p *parser) ast.Declaration {
return parseFieldWithVariableKind(p, access, accessPos)

case keywordFun:
return parseFunctionDeclaration(p, functionBlockIsOptional, access, accessPos)
return parseFunctionDeclaration(p, functionBlockIsOptional, access, accessPos, docString)

case keywordEvent:
return parseEventDeclaration(p, access, accessPos)
Expand Down
141 changes: 141 additions & 0 deletions runtime/parser2/declaration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,6 +724,147 @@ func TestParseFunctionDeclaration(t *testing.T) {
result,
)
})

t.Run("with docstring, single line comment", func(t *testing.T) {

t.Parallel()

result, errs := ParseDeclarations("/// Test\nfun foo() {}")
require.Empty(t, errs)

utils.AssertEqualWithDiff(t,
[]ast.Declaration{
&ast.FunctionDeclaration{
Identifier: ast.Identifier{
Identifier: "foo",
Pos: ast.Position{Line: 2, Column: 4, Offset: 13},
},
ParameterList: &ast.ParameterList{
Parameters: nil,
Range: ast.Range{
StartPos: ast.Position{Line: 2, Column: 7, Offset: 16},
EndPos: ast.Position{Line: 2, Column: 8, Offset: 17},
},
},
ReturnTypeAnnotation: &ast.TypeAnnotation{
IsResource: false,
Type: &ast.NominalType{
Identifier: ast.Identifier{
Identifier: "",
Pos: ast.Position{Line: 2, Column: 8, Offset: 17},
},
},
StartPos: ast.Position{Line: 2, Column: 8, Offset: 17},
},
FunctionBlock: &ast.FunctionBlock{
Block: &ast.Block{
Range: ast.Range{
StartPos: ast.Position{Line: 2, Column: 10, Offset: 19},
EndPos: ast.Position{Line: 2, Column: 11, Offset: 20},
},
},
},
DocString: " Test",
StartPos: ast.Position{Line: 2, Column: 0, Offset: 9},
},
},
result,
)
})

t.Run("with docstring, two line comments", func(t *testing.T) {

t.Parallel()

result, errs := ParseDeclarations("\n /// First line\n \n/// Second line\n\n\nfun foo() {}")
require.Empty(t, errs)

utils.AssertEqualWithDiff(t,
[]ast.Declaration{
&ast.FunctionDeclaration{
Identifier: ast.Identifier{
Identifier: "foo",
Pos: ast.Position{Line: 7, Column: 4, Offset: 43},
},
ParameterList: &ast.ParameterList{
Parameters: nil,
Range: ast.Range{
StartPos: ast.Position{Line: 7, Column: 7, Offset: 46},
EndPos: ast.Position{Line: 7, Column: 8, Offset: 47},
},
},
ReturnTypeAnnotation: &ast.TypeAnnotation{
IsResource: false,
Type: &ast.NominalType{
Identifier: ast.Identifier{
Identifier: "",
Pos: ast.Position{Line: 7, Column: 8, Offset: 47},
},
},
StartPos: ast.Position{Line: 7, Column: 8, Offset: 47},
},
FunctionBlock: &ast.FunctionBlock{
Block: &ast.Block{
Range: ast.Range{
StartPos: ast.Position{Line: 7, Column: 10, Offset: 49},
EndPos: ast.Position{Line: 7, Column: 11, Offset: 50},
},
},
},
DocString: " First line\n Second line",
StartPos: ast.Position{Line: 7, Column: 0, Offset: 39},
},
},
result,
)
})

t.Run("with docstring, block comment", func(t *testing.T) {

t.Parallel()

result, errs := ParseDeclarations("\n /** Cool dogs.\n\n Cool cats!! */\n\n\nfun foo() {}")
require.Empty(t, errs)

utils.AssertEqualWithDiff(t,
[]ast.Declaration{
&ast.FunctionDeclaration{
Identifier: ast.Identifier{
Identifier: "foo",
Pos: ast.Position{Line: 7, Column: 4, Offset: 43},
},
ParameterList: &ast.ParameterList{
Parameters: nil,
Range: ast.Range{
StartPos: ast.Position{Line: 7, Column: 7, Offset: 46},
EndPos: ast.Position{Line: 7, Column: 8, Offset: 47},
},
},
ReturnTypeAnnotation: &ast.TypeAnnotation{
IsResource: false,
Type: &ast.NominalType{
Identifier: ast.Identifier{
Identifier: "",
Pos: ast.Position{Line: 7, Column: 8, Offset: 47},
},
},
StartPos: ast.Position{Line: 7, Column: 8, Offset: 47},
},
FunctionBlock: &ast.FunctionBlock{
Block: &ast.Block{
Range: ast.Range{
StartPos: ast.Position{Line: 7, Column: 10, Offset: 49},
EndPos: ast.Position{Line: 7, Column: 11, Offset: 50},
},
},
},
DocString: " Cool dogs.\n\n Cool cats!! ",
StartPos: ast.Position{Line: 7, Column: 0, Offset: 39},
},
},
result,
)
})
}

func TestParseAccess(t *testing.T) {
Expand Down
3 changes: 3 additions & 0 deletions runtime/parser2/expression.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -999,6 +999,7 @@ func defineMemberExpression() {
}

func parseMemberAccess(p *parser, left ast.Expression, optional bool) ast.Expression {

p.skipSpaceAndComments(true)

// If there is an identifier, use it.
Expand Down Expand Up @@ -1039,7 +1040,9 @@ func exprLeftDenotationAllowsNewline(tokenType lexer.TokenType) bool {

// parseExpression uses "Top-Down operator precedence parsing" (TDOP) technique to
// parse expressions.
//
func parseExpression(p *parser, rightBindingPower int) ast.Expression {

p.skipSpaceAndComments(true)
t := p.current
p.next()
Expand Down
2 changes: 2 additions & 0 deletions runtime/parser2/function.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ func parseFunctionDeclaration(
functionBlockIsOptional bool,
access ast.Access,
accessPos *ast.Position,
docString string,
) *ast.FunctionDeclaration {

startPos := p.current.StartPos
Expand Down Expand Up @@ -200,6 +201,7 @@ func parseFunctionDeclaration(
ReturnTypeAnnotation: returnTypeAnnotation,
FunctionBlock: functionBlock,
StartPos: startPos,
DocString: docString,
}
}

Expand Down
Loading