pulumi/pkg/codegen/hcl2/local.go

// Copyright 2016-2020, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package hcl2

import (
	"github.com/hashicorp/hcl/v2"
	"github.com/hashicorp/hcl/v2/hclsyntax"
	"github.com/pulumi/pulumi/pkg/v2/codegen/hcl2/model"
	"github.com/pulumi/pulumi/pkg/v2/codegen/hcl2/syntax"
)

// LocalVariable represents a program- or component-scoped local variable.
type LocalVariable struct {
	node

	// The syntax node associated with the local variable, if any.
	Syntax *hclsyntax.Attribute
	// The syntax tokens associated with the local variable, if any.
	Tokens *syntax.AttributeTokens

	// The name of the local variable.
	VariableName string
	// The type of the local variable.
	VariableType model.Type
	// The value of the local variable.
	Value model.Expression
}

// SyntaxNode returns the syntax node associated with the local variable.
func (lv *LocalVariable) SyntaxNode() hclsyntax.Node {
	return lv.Syntax
}

func (lv *LocalVariable) Traverse(traverser hcl.Traverser) (model.Traversable, hcl.Diagnostics) {
	return lv.VariableType.Traverse(traverser)
}

func (lv *LocalVariable) Name() string {
	return lv.VariableName
}

// Type returns the type of the local variable.
func (lv *LocalVariable) Type() model.Type {
	return lv.VariableType
}

func (*LocalVariable) isNode() {}