summaryrefslogtreecommitdiff
path: root/pkgtools/pkglint/files/paragraph.go
blob: fa6359923026153640ec91869d4f775a968acd85 (plain)
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
package pkglint

import "strings"

// Paragraph is a slice of Makefile lines that is surrounded by empty lines.
//
// All variable assignments in a paragraph should be aligned in the same column.
type Paragraph struct {
	mklines *MkLines
	from    int
	to      int
}

func NewParagraph(mklines *MkLines, from, to int) *Paragraph {
	for i := from; i < to; i++ {
		assert(!mklines.mklines[i].IsEmpty())
	}
	return &Paragraph{mklines, from, to}
}

func (p *Paragraph) FirstLine() *MkLine { return p.mklines.mklines[p.from] }
func (p *Paragraph) LastLine() *MkLine  { return p.mklines.mklines[p.to-1] }

func (p *Paragraph) MkLines() []*MkLine { return p.mklines.mklines[p.from:p.to] }

func (p *Paragraph) ForEach(action func(mkline *MkLine)) {
	for _, mkline := range p.MkLines() {
		action(mkline)
	}
}

func (p *Paragraph) Align() {
	var align VaralignBlock
	p.ForEach(align.Process)
	align.Finish()
}

// AlignTo realigns all variable assignments in the paragraph so that their
// values start in the same column. Variable assignments that are commented
// out are also realigned.
//
// No warning or note is logged. Therefore this method must only be used to
// realign the whole paragraph after one of its lines has been modified.
func (p *Paragraph) AlignTo(column int) {
	p.ForEach(func(mkline *MkLine) {
		if !mkline.IsVarassign() {
			return
		}

		align := mkline.ValueAlign()
		oldWidth := tabWidth(align)
		if tabWidth(rtrimHspace(align)) > column {
			return
		}
		if oldWidth == column && !hasSuffix(strings.TrimRight(align, "\t"), " ") {
			return
		}
		if mkline.IsMultiline() && !mkline.FirstLineContainsValue() {
			return
		}

		trimmed := rtrimHspace(align)
		newSpace := alignmentAfter(trimmed, column)

		fix := mkline.Autofix()
		fix.Notef(SilentAutofixFormat)
		fix.ReplaceAfter(trimmed, align[len(trimmed):], newSpace)
		fix.Apply()
	})
}