pulumi/pkg/codegen/hcl2/program.go
Pat Gavlin b4daf94c2f
[codegen] Add support for caching package schemas. (#4534)
If a single process is going to bind and generate multiple programs, it
is useful to be able to cache package schemas in order to avoid the
(large) overhead of deserializing schemas multiple times.
2020-04-30 13:22:24 -07:00

105 lines
2.6 KiB
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 (
"io"
"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"
"github.com/pulumi/pulumi/pkg/v2/codegen/schema"
)
// Node represents a single definition in a program or component. Nodes may be config, locals, resources, or outputs.
type Node interface {
model.Definition
// Name returns the name of the node.
Name() string
// Type returns the type of the node.
Type() model.Type
// VisitExpressions visits the expressions that make up the node's body.
VisitExpressions(pre, post model.ExpressionVisitor) hcl.Diagnostics
markBinding()
markBound()
isBinding() bool
isBound() bool
getDependencies() []Node
setDependencies(nodes []Node)
isNode()
}
type node struct {
binding bool
bound bool
deps []Node
}
func (r *node) markBinding() {
r.binding = true
}
func (r *node) markBound() {
r.bound = true
}
func (r *node) isBinding() bool {
return r.binding && !r.bound
}
func (r *node) isBound() bool {
return r.bound
}
func (r *node) getDependencies() []Node {
return r.deps
}
func (r *node) setDependencies(nodes []Node) {
r.deps = nodes
}
func (*node) isNode() {}
// Program represents a semantically-analyzed Pulumi HCL2 program.
type Program struct {
Nodes []Node
files []*syntax.File
binder *binder
}
// NewDiagnosticWriter creates a new hcl.DiagnosticWriter for use with diagnostics generated by the program.
func (p *Program) NewDiagnosticWriter(w io.Writer, width uint, color bool) hcl.DiagnosticWriter {
return syntax.NewDiagnosticWriter(w, p.files, width, color)
}
// BindExpression binds an HCL2 expression in the top-level context of the program.
func (p *Program) BindExpression(node hclsyntax.Node) (model.Expression, hcl.Diagnostics) {
return p.binder.bindExpression(node)
}
// Packages returns the list of package schemas used by this program.
func (p *Program) Packages() []*schema.Package {
return p.binder.referencedPackages
}