summaryrefslogtreecommitdiff
path: root/vendor/github.com/mmcloughlin/avo/src/src.go
blob: 3a47886e659cdc20b40bff66b52312400a4fb0bd (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
// Package src provides types for working with source files.
package src

import (
	"os"
	"path/filepath"
	"runtime"
	"strconv"
)

// Position represents a position in a source file.
type Position struct {
	Filename string
	Line     int // 1-up
}

// FramePosition returns the Position of the given stack frame.
func FramePosition(f runtime.Frame) Position {
	return Position{
		Filename: f.File,
		Line:     f.Line,
	}
}

// IsValid reports whether the position is valid: Line must be positive, but
// Filename may be empty.
func (p Position) IsValid() bool {
	return p.Line > 0
}

// String represents Position as a string.
func (p Position) String() string {
	if !p.IsValid() {
		return "-"
	}
	var s string
	if p.Filename != "" {
		s += p.Filename + ":"
	}
	s += strconv.Itoa(p.Line)
	return s
}

// Rel returns Position relative to basepath. If the given filename cannot be
// expressed relative to basepath the position will be returned unchanged.
func (p Position) Rel(basepath string) Position {
	q := p
	if rel, err := filepath.Rel(basepath, q.Filename); err == nil {
		q.Filename = rel
	}
	return q
}

// Relwd returns Position relative to the current working directory. Returns p
// unchanged if the working directory cannot be determined, or the filename
// cannot be expressed relative to the working directory.
func (p Position) Relwd() Position {
	if wd, err := os.Getwd(); err == nil {
		return p.Rel(wd)
	}
	return p
}