hcl/ext/include/resolver.go

package include

import (
	"github.com/hashicorp/hcl2/zcl"
)

// A Resolver maps an include path (an arbitrary string, but usually something
// filepath-like) to a zcl.Body.
//
// The parameter "refRange" is the source range of the expression in the calling
// body that provided the given path, for use in generating "invalid path"-type
// diagnostics.
//
// If the returned body is nil, it will be ignored.
//
// Any returned diagnostics will be emitted when content is requested from the
// final composed body (after all includes have been dealt with).
type Resolver interface {
	ResolveBodyPath(path string, refRange zcl.Range) (zcl.Body, zcl.Diagnostics)
}

// ResolverFunc is a function type that implements Resolver.
type ResolverFunc func(path string, refRange zcl.Range) (zcl.Body, zcl.Diagnostics)

// ResolveBodyPath is an implementation of Resolver.ResolveBodyPath.
func (f ResolverFunc) ResolveBodyPath(path string, refRange zcl.Range) (zcl.Body, zcl.Diagnostics) {
	return f(path, refRange)
}