/
targets.go
239 lines (193 loc) · 6.14 KB
/
targets.go
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package reference
import (
"context"
"errors"
"strings"
"github.com/hashicorp/hcl-lang/schema"
"github.com/hashicorp/hcl/v2"
)
type Targets []Target
func (refs Targets) Copy() Targets {
if refs == nil {
return nil
}
newRefs := make(Targets, len(refs))
for i, ref := range refs {
newRefs[i] = ref.Copy()
}
return newRefs
}
func (r Targets) Len() int {
return len(r)
}
func (r Targets) Less(i, j int) bool {
return r[i].LocalAddr.String() < r[j].LocalAddr.String() ||
r[i].Addr.String() < r[j].Addr.String()
}
func (r Targets) Swap(i, j int) {
r[i], r[j] = r[j], r[i]
}
type TargetWalkFunc func(Target) error
var stopWalking error = errors.New("stop walking")
const InfiniteDepth = -1
func (refs Targets) deepWalk(f TargetWalkFunc, depth int) {
w := refTargetDeepWalker{
WalkFunc: f,
Depth: depth,
}
w.walk(refs)
}
type refTargetDeepWalker struct {
WalkFunc TargetWalkFunc
Depth int
currentDepth int
}
func (w refTargetDeepWalker) walk(refTargets Targets) {
for _, ref := range refTargets {
err := w.WalkFunc(ref)
if err == stopWalking {
return
}
if len(ref.NestedTargets) > 0 && (w.Depth == InfiniteDepth || w.Depth > w.currentDepth) {
w.currentDepth++
w.walk(ref.NestedTargets)
w.currentDepth--
}
}
}
func (targets Targets) MatchWalk(ctx context.Context, ref schema.Reference, prefix string, outermostBodyRng, originRng hcl.Range, f TargetWalkFunc) {
for _, target := range targets {
if localTargetMatches(ctx, target, ref, prefix, outermostBodyRng, originRng) ||
absTargetMatches(ctx, target, ref, prefix, outermostBodyRng, originRng) {
f(target)
continue
}
target.NestedTargets.MatchWalk(ctx, ref, prefix, outermostBodyRng, originRng, f)
}
}
func localTargetMatches(ctx context.Context, target Target, ref schema.Reference, prefix string, outermostBodyRng, originRng hcl.Range) bool {
if len(target.LocalAddr) > 0 && strings.HasPrefix(target.LocalAddr.String(), prefix) {
// reject self references if not enabled
if !schema.ActiveSelfRefsFromContext(ctx) && target.LocalAddr[0].String() == "self" {
return false
}
hasNestedMatches := target.NestedTargets.containsMatch(ctx, ref, prefix, outermostBodyRng, originRng)
// Avoid suggesting cyclical reference to the same attribute
// unless it has nested matches - i.e. still consider reference
// to the outside block/body as valid.
//
// For example, block { foo = self } where "self" refers to the "block"
// is considered valid. The use case this is important for is
// Terraform's self references inside nested block such as "connection".
if target.RangePtr != nil && !hasNestedMatches {
if rangeOverlaps(*target.RangePtr, originRng) {
return false
}
// We compare line in case the (incomplete) attribute
// ends w/ whitespace which wouldn't be included in the range
if target.RangePtr.Filename == originRng.Filename &&
target.RangePtr.End.Line == originRng.Start.Line {
return false
}
}
// Reject origins which are outside the targetable range
if target.TargetableFromRangePtr != nil && !rangeOverlaps(*target.TargetableFromRangePtr, originRng) {
return false
}
if target.MatchesConstraint(ref) || hasNestedMatches {
return true
}
}
return false
}
func absTargetMatches(ctx context.Context, target Target, ref schema.Reference, prefix string, outermostBodyRng, originRng hcl.Range) bool {
if len(target.Addr) > 0 && strings.HasPrefix(target.Addr.String(), prefix) {
// Reject references to block's own fields from within the body
if referenceTargetIsInRange(target, outermostBodyRng) {
return false
}
if target.MatchesConstraint(ref) || target.NestedTargets.containsMatch(ctx, ref, prefix, outermostBodyRng, originRng) {
return true
}
}
return false
}
func (targets Targets) containsMatch(ctx context.Context, ref schema.Reference, prefix string, outermostBodyRng, originRng hcl.Range) bool {
for _, target := range targets {
if localTargetMatches(ctx, target, ref, prefix, outermostBodyRng, originRng) {
return true
}
if absTargetMatches(ctx, target, ref, prefix, outermostBodyRng, originRng) {
return true
}
if len(target.NestedTargets) > 0 {
if match := target.NestedTargets.containsMatch(ctx, ref, prefix, outermostBodyRng, originRng); match {
return true
}
}
}
return false
}
func referenceTargetIsInRange(target Target, bodyRange hcl.Range) bool {
return target.RangePtr != nil &&
bodyRange.Filename == target.RangePtr.Filename &&
(bodyRange.ContainsPos(target.RangePtr.Start) ||
posEqual(bodyRange.End, target.RangePtr.End))
}
func posEqual(pos, other hcl.Pos) bool {
return pos.Line == other.Line &&
pos.Column == other.Column &&
pos.Byte == other.Byte
}
func (refs Targets) Match(origin MatchableOrigin) (Targets, bool) {
matchingReferences := make(Targets, 0)
refs.deepWalk(func(ref Target) error {
if ref.Matches(origin) {
matchingReferences = append(matchingReferences, ref)
}
return nil
}, InfiniteDepth)
return matchingReferences, len(matchingReferences) > 0
}
func (refs Targets) OutermostInFile(file string) Targets {
targets := make(Targets, 0)
for _, target := range refs {
if target.RangePtr == nil {
continue
}
if target.RangePtr.Filename == file {
targets = append(targets, target)
}
}
return targets
}
func (refs Targets) InnermostAtPos(file string, pos hcl.Pos) (Targets, bool) {
matchingTargets := make(Targets, 0)
for _, target := range refs {
if target.RangePtr == nil {
continue
}
if target.RangePtr.Filename == file && target.RangePtr.ContainsPos(pos) {
matchingTargets = append(matchingTargets, target)
}
}
innermostTargets := make(Targets, 0)
for _, target := range matchingTargets {
if target.DefRangePtr != nil {
if target.DefRangePtr.Filename == file &&
target.DefRangePtr.ContainsPos(pos) {
innermostTargets = append(innermostTargets, target)
continue
}
}
nestedTargets, ok := target.NestedTargets.InnermostAtPos(file, pos)
if ok {
innermostTargets = nestedTargets
continue
}
innermostTargets = append(innermostTargets, target)
}
return innermostTargets, len(innermostTargets) > 0
}