decoder: Account for attribute (Def)Ranges in Object/Map

hashicorp · Mar 22, 2023 · 9ce64af · 9ce64af
1 parent 71ae3ab
commit 9ce64af
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 9 deletions.
diff --git a/decoder/expr_map_ref_targets.go b/decoder/expr_map_ref_targets.go
@@ -6,6 +6,7 @@ import (
 	"github.com/hashicorp/hcl-lang/lang"
 	"github.com/hashicorp/hcl-lang/reference"
 	"github.com/hashicorp/hcl-lang/schema"
+	"github.com/hashicorp/hcl/v2"
 	"github.com/hashicorp/hcl/v2/hclsyntax"
 	"github.com/zclconf/go-cty/cty"
 )
@@ -39,6 +40,10 @@ func (m Map) ReferenceTargets(ctx context.Context, targetCtx *TargetContext) ref
 			}
 
 			elemCtx := targetCtx.Copy()
+
+			elemCtx.ParentDefRangePtr = item.KeyExpr.Range().Ptr()
+			elemCtx.ParentRangePtr = hcl.RangeBetween(item.KeyExpr.Range(), item.ValueExpr.Range()).Ptr()
+
 			elemCtx.ParentAddress = append(elemCtx.ParentAddress, lang.IndexStep{
 				Key: cty.StringVal(keyName),
 			})

diff --git a/decoder/expr_object_ref_targets.go b/decoder/expr_object_ref_targets.go
@@ -42,8 +42,8 @@ func (obj Object) ReferenceTargets(ctx context.Context, targetCtx *TargetContext
 	attrNames := sortedAttributeNames(obj.cons.Attributes)
 	for _, name := range attrNames {
 		var valueExpr hcl.Expression
-		item, ok := declaredAttributes[name]
-		if ok {
+		item, attrDeclared := declaredAttributes[name]
+		if attrDeclared {
 			valueExpr = item.ValueExpr
 		} else {
 			valueExpr = newEmptyExpressionAtPos(eType.Range().Filename, eType.Range().Start)
@@ -61,6 +61,11 @@ func (obj Object) ReferenceTargets(ctx context.Context, targetCtx *TargetContext
 
 			elemCtx := targetCtx.Copy()
 
+			if attrDeclared {
+				elemCtx.ParentDefRangePtr = item.KeyExpr.Range().Ptr()
+				elemCtx.ParentRangePtr = hcl.RangeBetween(item.KeyExpr.Range(), item.ValueExpr.Range()).Ptr()
+			}
+
 			if hclsyntax.ValidIdentifier(name) {
 				// Prefer simpler syntax - e.g. myobj.attribute if possible
 				elemCtx.ParentAddress = append(elemCtx.ParentAddress, lang.AttrStep{
@@ -93,6 +98,10 @@ func (obj Object) ReferenceTargets(ctx context.Context, targetCtx *TargetContext
 
 	if targetCtx != nil {
 		// collect target for the whole object
+		rangePtr := obj.expr.Range().Ptr()
+		if targetCtx.ParentRangePtr != nil {
+			rangePtr = targetCtx.ParentRangePtr
+		}
 
 		// type-aware
 		if targetCtx.AsExprType {
@@ -103,7 +112,8 @@ func (obj Object) ReferenceTargets(ctx context.Context, targetCtx *TargetContext
 					Name:                   targetCtx.FriendlyName,
 					Type:                   objType,
 					ScopeId:                targetCtx.ScopeId,
-					RangePtr:               obj.expr.Range().Ptr(),
+					DefRangePtr:            targetCtx.ParentDefRangePtr,
+					RangePtr:               rangePtr,
 					NestedTargets:          attrTargets,
 					LocalAddr:              targetCtx.ParentLocalAddress,
 					TargetableFromRangePtr: targetCtx.TargetableFromRangePtr,
@@ -117,7 +127,8 @@ func (obj Object) ReferenceTargets(ctx context.Context, targetCtx *TargetContext
 				Addr:                   targetCtx.ParentAddress,
 				Name:                   targetCtx.FriendlyName,
 				ScopeId:                targetCtx.ScopeId,
-				RangePtr:               obj.expr.Range().Ptr(),
+				DefRangePtr:            targetCtx.ParentDefRangePtr,
+				RangePtr:               rangePtr,
 				NestedTargets:          attrTargets,
 				LocalAddr:              targetCtx.ParentLocalAddress,
 				TargetableFromRangePtr: targetCtx.TargetableFromRangePtr,

diff --git a/decoder/expression.go b/decoder/expression.go
@@ -66,6 +66,11 @@ type TargetContext struct {
 	// TargetableFromRangePtr defines where the target is locally targetable
 	// from via the ParentLocalAddress.
 	TargetableFromRangePtr *hcl.Range
+
+	// TODO: Comment
+	ParentRangePtr *hcl.Range
+	// TODO: Comment
+	ParentDefRangePtr *hcl.Range
 }
 
 func (tctx *TargetContext) Copy() *TargetContext {

diff --git a/decoder/reference_targets.go b/decoder/reference_targets.go
@@ -279,11 +279,13 @@ func (d *PathDecoder) decodeReferenceTargetsForAttribute(attr *hcl.Attribute, at
 				attrAddr, ok := resolveAttributeAddress(attr, attrSchema.Address.Steps)
 				if ok {
 					targetCtx = &TargetContext{
-						FriendlyName:  attrSchema.Address.FriendlyName,
-						ScopeId:       attrSchema.Address.ScopeId,
-						AsExprType:    attrSchema.Address.AsExprType,
-						AsReference:   attrSchema.Address.AsReference,
-						ParentAddress: attrAddr,
+						FriendlyName:      attrSchema.Address.FriendlyName,
+						ScopeId:           attrSchema.Address.ScopeId,
+						AsExprType:        attrSchema.Address.AsExprType,
+						AsReference:       attrSchema.Address.AsReference,
+						ParentAddress:     attrAddr,
+						ParentRangePtr:    attr.Range.Ptr(),
+						ParentDefRangePtr: attr.NameRange.Ptr(),
 					}
 				}
 			}