Merge branch 'comments3'

This commit is contained in:
z7zmey
2018-06-07 15:06:54 +03:00
138 changed files with 17339 additions and 10027 deletions

30
parser/comments.go Normal file
View File

@@ -0,0 +1,30 @@
package parser
import (
"github.com/z7zmey/php-parser/comment"
"github.com/z7zmey/php-parser/node"
"github.com/z7zmey/php-parser/scanner"
)
// Comments a collection of comment groups assigned to nodes
type Comments map[node.Node][]*comment.Comment
// AddComments add comment group to the collection
func (c Comments) AddComments(node node.Node, comments []*comment.Comment) {
c[node] = append(c[node], comments...)
}
func (c Comments) AddFromToken(node node.Node, token *scanner.Token, tokenName comment.TokenName) {
comments := token.Comments()
for _, cmt := range comments {
cmt.SetTokenName(tokenName)
}
c.AddComments(node, comments)
}
func (c Comments) AddFromChildNode(n node.Node, ch node.Node) {
c.AddComments(n, c[ch])
delete(c, ch)
}

28
parser/comments_test.go Normal file
View File

@@ -0,0 +1,28 @@
package parser_test
import (
"testing"
"github.com/z7zmey/php-parser/comment"
"github.com/z7zmey/php-parser/node"
"github.com/z7zmey/php-parser/parser"
)
func TestComments(t *testing.T) {
n := node.NewIdentifier("test")
commentGroup := []*comment.Comment{
comment.NewComment("/** hello world */", nil),
comment.NewComment("// hello world", nil),
}
comments := parser.Comments{}
comments.AddComments(n, commentGroup)
if comments[n][0].String() != "/** hello world */" {
t.Errorf("expected and actual are not equal\n")
}
if comments[n][1].String() != "// hello world" {
t.Errorf("expected and actual are not equal\n")
}
}

View File

@@ -1,10 +1,8 @@
package parser
import (
"github.com/z7zmey/php-parser/comment"
"github.com/z7zmey/php-parser/errors"
"github.com/z7zmey/php-parser/node"
"github.com/z7zmey/php-parser/position"
)
// Parser interface
@@ -13,6 +11,6 @@ type Parser interface {
GetPath() string
GetRootNode() node.Node
GetErrors() []*errors.Error
GetComments() comment.Comments
GetPositions() position.Positions
GetComments() Comments
GetPositions() Positions
}

204
parser/position_builder.go Normal file
View File

@@ -0,0 +1,204 @@
package parser
import (
"github.com/z7zmey/php-parser/node"
"github.com/z7zmey/php-parser/position"
"github.com/z7zmey/php-parser/scanner"
)
// PositionBuilder provide functions to constuct positions
type PositionBuilder struct {
Positions *Positions
}
type startPos struct {
startLine int
startPos int
}
type endPos struct {
endLine int
endPos int
}
func (b *PositionBuilder) getListStartPos(l []node.Node) startPos {
if l == nil {
return startPos{-1, -1}
}
if len(l) == 0 {
return startPos{-1, -1}
}
return b.getNodeStartPos(l[0])
}
func (b *PositionBuilder) getNodeStartPos(n node.Node) startPos {
sl := -1
sp := -1
if n == nil {
return startPos{-1, -1}
}
p := (*b.Positions)[n]
if p != nil {
sl = p.StartLine
sp = p.StartPos
}
return startPos{sl, sp}
}
func (b *PositionBuilder) getListEndPos(l []node.Node) endPos {
if l == nil {
return endPos{-1, -1}
}
if len(l) == 0 {
return endPos{-1, -1}
}
return b.getNodeEndPos(l[len(l)-1])
}
func (b *PositionBuilder) getNodeEndPos(n node.Node) endPos {
el := -1
ep := -1
if n == nil {
return endPos{-1, -1}
}
p := (*b.Positions)[n]
if p != nil {
el = p.EndLine
ep = p.EndPos
}
return endPos{el, ep}
}
// NewNodeListPosition returns new Position
func (b *PositionBuilder) NewNodeListPosition(list []node.Node) *position.Position {
return position.NewPosition(
b.getListStartPos(list).startLine,
b.getListEndPos(list).endLine,
b.getListStartPos(list).startPos,
b.getListEndPos(list).endPos,
)
}
// NewNodePosition returns new Position
func (b *PositionBuilder) NewNodePosition(n node.Node) *position.Position {
return position.NewPosition(
b.getNodeStartPos(n).startLine,
b.getNodeEndPos(n).endLine,
b.getNodeStartPos(n).startPos,
b.getNodeEndPos(n).endPos,
)
}
// NewTokenPosition returns new Position
func (b *PositionBuilder) NewTokenPosition(t *scanner.Token) *position.Position {
return t.Position()
}
// NewTokensPosition returns new Position
func (b *PositionBuilder) NewTokensPosition(startToken *scanner.Token, endToken *scanner.Token) *position.Position {
return position.NewPosition(
startToken.Position().StartLine,
endToken.Position().EndLine,
startToken.Position().StartPos,
endToken.Position().EndPos,
)
}
// NewTokenNodePosition returns new Position
func (b *PositionBuilder) NewTokenNodePosition(t *scanner.Token, n node.Node) *position.Position {
return position.NewPosition(
t.Position().StartLine,
b.getNodeEndPos(n).endLine,
t.Position().StartPos,
b.getNodeEndPos(n).endPos,
)
}
// NewNodeTokenPosition returns new Position
func (b *PositionBuilder) NewNodeTokenPosition(n node.Node, t *scanner.Token) *position.Position {
return position.NewPosition(
b.getNodeStartPos(n).startLine,
t.Position().EndLine,
b.getNodeStartPos(n).startPos,
t.Position().EndPos,
)
}
// NewNodesPosition returns new Position
func (b *PositionBuilder) NewNodesPosition(startNode node.Node, endNode node.Node) *position.Position {
return position.NewPosition(
b.getNodeStartPos(startNode).startLine,
b.getNodeEndPos(endNode).endLine,
b.getNodeStartPos(startNode).startPos,
b.getNodeEndPos(endNode).endPos,
)
}
// NewNodeListTokenPosition returns new Position
func (b *PositionBuilder) NewNodeListTokenPosition(list []node.Node, t *scanner.Token) *position.Position {
return position.NewPosition(
b.getListStartPos(list).startLine,
t.Position().EndLine,
b.getListStartPos(list).startPos,
t.Position().EndPos,
)
}
// NewTokenNodeListPosition returns new Position
func (b *PositionBuilder) NewTokenNodeListPosition(t *scanner.Token, list []node.Node) *position.Position {
return position.NewPosition(
t.Position().StartLine,
b.getListEndPos(list).endLine,
t.Position().StartPos,
b.getListEndPos(list).endPos,
)
}
// NewNodeNodeListPosition returns new Position
func (b *PositionBuilder) NewNodeNodeListPosition(n node.Node, list []node.Node) *position.Position {
return position.NewPosition(
b.getNodeStartPos(n).startLine,
b.getListEndPos(list).endLine,
b.getNodeStartPos(n).startPos,
b.getListEndPos(list).endPos,
)
}
// NewNodeListNodePosition returns new Position
func (b *PositionBuilder) NewNodeListNodePosition(list []node.Node, n node.Node) *position.Position {
return position.NewPosition(
b.getListStartPos(list).startLine,
b.getNodeEndPos(n).endLine,
b.getListStartPos(list).startPos,
b.getNodeEndPos(n).endPos,
)
}
// NewOptionalListTokensPosition returns new Position
func (b *PositionBuilder) NewOptionalListTokensPosition(list []node.Node, t *scanner.Token, endToken *scanner.Token) *position.Position {
if list == nil {
return position.NewPosition(
t.Position().StartLine,
endToken.Position().EndLine,
t.Position().StartPos,
endToken.Position().EndPos,
)
}
return position.NewPosition(
b.getListStartPos(list).startLine,
endToken.Position().EndLine,
b.getListStartPos(list).startPos,
endToken.Position().EndPos,
)
}

View File

@@ -0,0 +1,428 @@
package parser_test
import (
"testing"
"github.com/z7zmey/php-parser/node"
"github.com/z7zmey/php-parser/parser"
"github.com/z7zmey/php-parser/position"
"github.com/z7zmey/php-parser/scanner"
)
func TestNewTokenPosition(t *testing.T) {
builder := parser.PositionBuilder{}
tpos := position.NewPosition(1, 1, 0, 3)
tkn := scanner.NewToken(`foo`, tpos)
pos := builder.NewTokenPosition(tkn)
if pos.String() != `Pos{Line: 1-1 Pos: 0-3}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewTokensPosition(t *testing.T) {
builder := parser.PositionBuilder{}
tpos1 := position.NewPosition(1, 1, 0, 3)
token1 := scanner.NewToken(`foo`, tpos1)
tpos2 := position.NewPosition(2, 2, 4, 6)
token2 := scanner.NewToken(`foo`, tpos2)
pos := builder.NewTokensPosition(token1, token2)
if pos.String() != `Pos{Line: 1-2 Pos: 0-6}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewNodePosition(t *testing.T) {
n := node.NewIdentifier("test node")
p := &parser.Positions{}
p.AddPosition(n, &position.Position{
StartLine: 1,
EndLine: 1,
StartPos: 0,
EndPos: 3,
})
builder := parser.PositionBuilder{
Positions: p,
}
pos := builder.NewNodePosition(n)
if pos.String() != `Pos{Line: 1-1 Pos: 0-3}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewTokenNodePosition(t *testing.T) {
tpos := position.NewPosition(1, 1, 0, 3)
tkn := scanner.NewToken(`foo`, tpos)
n := node.NewIdentifier("test node")
p := &parser.Positions{}
p.AddPosition(n, &position.Position{
StartLine: 2,
EndLine: 2,
StartPos: 4,
EndPos: 12,
})
builder := parser.PositionBuilder{
Positions: p,
}
pos := builder.NewTokenNodePosition(tkn, n)
if pos.String() != `Pos{Line: 1-2 Pos: 0-12}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewNodeTokenPosition(t *testing.T) {
n := node.NewIdentifier("test node")
tpos := position.NewPosition(2, 2, 10, 12)
tkn := scanner.NewToken(`foo`, tpos)
p := &parser.Positions{}
p.AddPosition(n, &position.Position{
StartLine: 1,
EndLine: 1,
StartPos: 0,
EndPos: 9,
})
builder := parser.PositionBuilder{
Positions: p,
}
pos := builder.NewNodeTokenPosition(n, tkn)
if pos.String() != `Pos{Line: 1-2 Pos: 0-12}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewNodeListPosition(t *testing.T) {
n1 := node.NewIdentifier("test node")
n2 := node.NewIdentifier("test node")
builder := parser.PositionBuilder{
Positions: &parser.Positions{
n1: &position.Position{
StartLine: 1,
EndLine: 1,
StartPos: 0,
EndPos: 9,
},
n2: &position.Position{
StartLine: 2,
EndLine: 2,
StartPos: 10,
EndPos: 19,
},
},
}
pos := builder.NewNodeListPosition([]node.Node{n1, n2})
if pos.String() != `Pos{Line: 1-2 Pos: 0-19}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewNodesPosition(t *testing.T) {
n1 := node.NewIdentifier("test node")
n2 := node.NewIdentifier("test node")
builder := parser.PositionBuilder{
Positions: &parser.Positions{
n1: &position.Position{
StartLine: 1,
EndLine: 1,
StartPos: 0,
EndPos: 9,
},
n2: &position.Position{
StartLine: 2,
EndLine: 2,
StartPos: 10,
EndPos: 19,
},
},
}
pos := builder.NewNodesPosition(n1, n2)
if pos.String() != `Pos{Line: 1-2 Pos: 0-19}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewNodeListTokenPosition(t *testing.T) {
n1 := node.NewIdentifier("test node")
n2 := node.NewIdentifier("test node")
tpos := position.NewPosition(3, 3, 20, 22)
tkn := scanner.NewToken(`foo`, tpos)
builder := parser.PositionBuilder{
Positions: &parser.Positions{
n1: &position.Position{
StartLine: 1,
EndLine: 1,
StartPos: 0,
EndPos: 9,
},
n2: &position.Position{
StartLine: 2,
EndLine: 2,
StartPos: 10,
EndPos: 19,
},
},
}
pos := builder.NewNodeListTokenPosition([]node.Node{n1, n2}, tkn)
if pos.String() != `Pos{Line: 1-3 Pos: 0-22}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewTokenNodeListPosition(t *testing.T) {
tpos := position.NewPosition(1, 1, 0, 2)
tkn := scanner.NewToken(`foo`, tpos)
n1 := node.NewIdentifier("test node")
n2 := node.NewIdentifier("test node")
builder := parser.PositionBuilder{
Positions: &parser.Positions{
n1: &position.Position{
StartLine: 2,
EndLine: 2,
StartPos: 3,
EndPos: 10,
},
n2: &position.Position{
StartLine: 3,
EndLine: 3,
StartPos: 11,
EndPos: 20,
},
},
}
pos := builder.NewTokenNodeListPosition(tkn, []node.Node{n1, n2})
if pos.String() != `Pos{Line: 1-3 Pos: 0-20}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewNodeNodeListPosition(t *testing.T) {
n1 := node.NewIdentifier("test node")
n2 := node.NewIdentifier("test node")
n3 := node.NewIdentifier("test node")
builder := parser.PositionBuilder{
Positions: &parser.Positions{
n1: &position.Position{
StartLine: 1,
EndLine: 1,
StartPos: 0,
EndPos: 8,
},
n2: &position.Position{
StartLine: 2,
EndLine: 2,
StartPos: 9,
EndPos: 17,
},
n3: &position.Position{
StartLine: 3,
EndLine: 3,
StartPos: 18,
EndPos: 26,
},
},
}
pos := builder.NewNodeNodeListPosition(n1, []node.Node{n2, n3})
if pos.String() != `Pos{Line: 1-3 Pos: 0-26}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewNodeListNodePosition(t *testing.T) {
n1 := node.NewIdentifier("test node")
n2 := node.NewIdentifier("test node")
n3 := node.NewIdentifier("test node")
builder := parser.PositionBuilder{
Positions: &parser.Positions{
n1: &position.Position{
StartLine: 1,
EndLine: 1,
StartPos: 0,
EndPos: 8,
},
n2: &position.Position{
StartLine: 2,
EndLine: 2,
StartPos: 9,
EndPos: 17,
},
n3: &position.Position{
StartLine: 3,
EndLine: 3,
StartPos: 18,
EndPos: 26,
},
},
}
pos := builder.NewNodeListNodePosition([]node.Node{n1, n2}, n3)
if pos.String() != `Pos{Line: 1-3 Pos: 0-26}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewOptionalListTokensPosition(t *testing.T) {
builder := parser.PositionBuilder{}
tpos1 := position.NewPosition(1, 1, 0, 3)
token1 := scanner.NewToken(`foo`, tpos1)
tpos2 := position.NewPosition(2, 2, 4, 6)
token2 := scanner.NewToken(`foo`, tpos2)
pos := builder.NewOptionalListTokensPosition(nil, token1, token2)
if pos.String() != `Pos{Line: 1-2 Pos: 0-6}` {
t.Errorf("token value is not equal\n")
}
}
func TestNewOptionalListTokensPosition2(t *testing.T) {
n1 := node.NewIdentifier("test node")
n2 := node.NewIdentifier("test node")
n3 := node.NewIdentifier("test node")
builder := parser.PositionBuilder{
Positions: &parser.Positions{
n1: &position.Position{
StartLine: 1,
EndLine: 1,
StartPos: 0,
EndPos: 8,
},
n2: &position.Position{
StartLine: 2,
EndLine: 2,
StartPos: 9,
EndPos: 17,
},
n3: &position.Position{
StartLine: 3,
EndLine: 3,
StartPos: 18,
EndPos: 26,
},
},
}
tpos1 := position.NewPosition(4, 4, 27, 29)
token1 := scanner.NewToken(`foo`, tpos1)
tpos2 := position.NewPosition(5, 5, 30, 32)
token2 := scanner.NewToken(`foo`, tpos2)
pos := builder.NewOptionalListTokensPosition([]node.Node{n2, n3}, token1, token2)
if pos.String() != `Pos{Line: 2-5 Pos: 9-32}` {
t.Errorf("token value is not equal\n")
}
}
func TestNilNodePos(t *testing.T) {
builder := parser.PositionBuilder{}
pos := builder.NewNodesPosition(nil, nil)
if pos.String() != `Pos{Line: -1--1 Pos: -1--1}` {
t.Errorf("token value is not equal\n")
}
}
func TestNilNodeListPos(t *testing.T) {
n1 := node.NewIdentifier("test node")
builder := parser.PositionBuilder{
Positions: &parser.Positions{
n1: &position.Position{
StartLine: 1,
EndLine: 1,
StartPos: 0,
EndPos: 8,
},
},
}
pos := builder.NewNodeNodeListPosition(n1, nil)
if pos.String() != `Pos{Line: 1--1 Pos: 0--1}` {
t.Errorf("token value is not equal\n")
}
}
func TestNilNodeListTokenPos(t *testing.T) {
tpos := position.NewPosition(1, 1, 0, 3)
token1 := scanner.NewToken(`foo`, tpos)
builder := parser.PositionBuilder{}
pos := builder.NewNodeListTokenPosition(nil, token1)
if pos.String() != `Pos{Line: -1-1 Pos: -1-3}` {
t.Errorf("token value is not equal\n")
}
}
func TestEmptyNodeListPos(t *testing.T) {
n1 := node.NewIdentifier("test node")
builder := parser.PositionBuilder{
Positions: &parser.Positions{
n1: &position.Position{
StartLine: 1,
EndLine: 1,
StartPos: 0,
EndPos: 8,
},
},
}
pos := builder.NewNodeNodeListPosition(n1, []node.Node{})
if pos.String() != `Pos{Line: 1--1 Pos: 0--1}` {
t.Errorf("token value is not equal\n")
}
}
func TestEmptyNodeListTokenPos(t *testing.T) {
tpos := position.NewPosition(1, 1, 0, 3)
token1 := scanner.NewToken(`foo`, tpos)
builder := parser.PositionBuilder{}
pos := builder.NewNodeListTokenPosition([]node.Node{}, token1)
if pos.String() != `Pos{Line: -1-1 Pos: -1-3}` {
t.Errorf("token value is not equal\n")
}
}

14
parser/positions.go Normal file
View File

@@ -0,0 +1,14 @@
package parser
import (
"github.com/z7zmey/php-parser/node"
"github.com/z7zmey/php-parser/position"
)
// Positions a collection of positions attached to nodes
type Positions map[node.Node]*position.Position
// AddPosition attaches a position to a node
func (p Positions) AddPosition(node node.Node, position *position.Position) {
p[node] = position
}

25
parser/positions_test.go Normal file
View File

@@ -0,0 +1,25 @@
package parser_test
import (
"testing"
"github.com/z7zmey/php-parser/position"
"github.com/z7zmey/php-parser/node"
"github.com/z7zmey/php-parser/parser"
)
func TestPositions(t *testing.T) {
n := node.NewIdentifier("test")
expected := position.NewPosition(0, 0, 0, 0)
positions := parser.Positions{}
positions.AddPosition(n, expected)
actual := positions[n]
if actual != expected {
t.Errorf("expected and actual are not equal\n")
}
}