2020-03-18 17:28:57 +01:00
|
|
|
// 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 model
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
|
|
|
|
"github.com/hashicorp/hcl/v2"
|
|
|
|
"github.com/hashicorp/hcl/v2/hclsyntax"
|
2021-03-17 14:20:05 +01:00
|
|
|
"github.com/pulumi/pulumi/pkg/v3/codegen/hcl2/syntax"
|
2020-03-18 17:28:57 +01:00
|
|
|
)
|
|
|
|
|
|
|
|
// MapType represents maps from strings to particular element types.
|
|
|
|
type MapType struct {
|
|
|
|
// ElementType is the element type of the map.
|
|
|
|
ElementType Type
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewMapType creates a new map type with the given element type.
|
|
|
|
func NewMapType(elementType Type) *MapType {
|
2020-05-22 11:47:34 +02:00
|
|
|
return &MapType{ElementType: elementType}
|
2020-03-18 17:28:57 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Traverse attempts to traverse the optional type with the given traverser. The result type of traverse(map(T))
|
|
|
|
// is T; the traversal fails if the traverser is not a string.
|
|
|
|
func (t *MapType) Traverse(traverser hcl.Traverser) (Traversable, hcl.Diagnostics) {
|
|
|
|
_, keyType := GetTraverserKey(traverser)
|
|
|
|
|
|
|
|
var diagnostics hcl.Diagnostics
|
|
|
|
if !InputType(StringType).ConversionFrom(keyType).Exists() {
|
|
|
|
diagnostics = hcl.Diagnostics{unsupportedMapKey(traverser.SourceRange())}
|
|
|
|
}
|
|
|
|
return t.ElementType, diagnostics
|
|
|
|
}
|
|
|
|
|
|
|
|
// SyntaxNode returns the syntax node for the type. This is always syntax.None.
|
|
|
|
func (*MapType) SyntaxNode() hclsyntax.Node {
|
|
|
|
return syntax.None
|
|
|
|
}
|
|
|
|
|
2020-05-22 11:47:34 +02:00
|
|
|
// Equals returns true if this type has the same identity as the given type.
|
|
|
|
func (t *MapType) Equals(other Type) bool {
|
2020-09-19 02:29:21 +02:00
|
|
|
return t.equals(other, nil)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (t *MapType) equals(other Type, seen map[Type]struct{}) bool {
|
2020-05-22 11:47:34 +02:00
|
|
|
if t == other {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
|
|
|
otherMap, ok := other.(*MapType)
|
2020-09-19 02:29:21 +02:00
|
|
|
return ok && t.ElementType.equals(otherMap.ElementType, seen)
|
2020-05-22 11:47:34 +02:00
|
|
|
}
|
|
|
|
|
2020-03-18 17:28:57 +01:00
|
|
|
// AssignableFrom returns true if this type is assignable from the indicated source type. A map(T) is assignable
|
|
|
|
// from values of type map(U) where T is assignable from U or object(K_0=U_0, ..., K_N=U_N) if T is assignable from the
|
|
|
|
// unified type of U_0 through U_N.
|
|
|
|
func (t *MapType) AssignableFrom(src Type) bool {
|
|
|
|
return assignableFrom(t, src, func() bool {
|
|
|
|
switch src := src.(type) {
|
|
|
|
case *MapType:
|
|
|
|
return t.ElementType.AssignableFrom(src.ElementType)
|
|
|
|
case *ObjectType:
|
|
|
|
for _, src := range src.Properties {
|
|
|
|
if !t.ElementType.AssignableFrom(src) {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2020-05-22 11:47:34 +02:00
|
|
|
// ConversionFrom returns the kind of conversion (if any) that is possible from the source type to this type. A map(T)
|
|
|
|
// is safely convertible from map(U) or object({K_0 = U_0 ... K_N = U_N}) if the element type(s) U is/are safely
|
|
|
|
// convertible to T. If any element type is unsafely convertible to T and no element type is safely convertible to T,
|
|
|
|
// the conversion is unsafe. Otherwise, no conversion exists.
|
2020-03-18 17:28:57 +01:00
|
|
|
func (t *MapType) ConversionFrom(src Type) ConversionKind {
|
2021-06-24 18:17:55 +02:00
|
|
|
kind, _ := t.conversionFrom(src, false, nil)
|
|
|
|
return kind
|
2020-03-18 17:28:57 +01:00
|
|
|
}
|
|
|
|
|
2021-07-16 18:56:26 +02:00
|
|
|
func (t *MapType) conversionFrom(src Type, unifying bool, seen map[Type]struct{}) (ConversionKind, lazyDiagnostics) {
|
|
|
|
return conversionFrom(t, src, unifying, seen, func() (ConversionKind, lazyDiagnostics) {
|
2020-03-18 17:28:57 +01:00
|
|
|
switch src := src.(type) {
|
|
|
|
case *MapType:
|
2021-02-04 15:44:20 +01:00
|
|
|
return t.ElementType.conversionFrom(src.ElementType, unifying, seen)
|
2020-03-18 17:28:57 +01:00
|
|
|
case *ObjectType:
|
|
|
|
conversionKind := SafeConversion
|
2021-07-16 18:56:26 +02:00
|
|
|
var diags lazyDiagnostics
|
2020-03-18 17:28:57 +01:00
|
|
|
for _, src := range src.Properties {
|
2021-06-24 18:17:55 +02:00
|
|
|
if ck, _ := t.ElementType.conversionFrom(src, unifying, seen); ck < conversionKind {
|
2020-03-18 17:28:57 +01:00
|
|
|
conversionKind = ck
|
2021-06-24 18:17:55 +02:00
|
|
|
if conversionKind == NoConversion {
|
|
|
|
break
|
|
|
|
}
|
2020-03-18 17:28:57 +01:00
|
|
|
}
|
|
|
|
}
|
2021-06-24 18:17:55 +02:00
|
|
|
return conversionKind, diags
|
2020-03-18 17:28:57 +01:00
|
|
|
}
|
2021-07-16 18:56:26 +02:00
|
|
|
return NoConversion, func() hcl.Diagnostics { return hcl.Diagnostics{typeNotConvertible(t, src)} }
|
2020-03-18 17:28:57 +01:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
func (t *MapType) String() string {
|
2021-02-04 15:44:20 +01:00
|
|
|
return t.string(nil)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (t *MapType) string(seen map[Type]struct{}) string {
|
|
|
|
return fmt.Sprintf("map(%s)", t.ElementType.string(seen))
|
2020-03-18 17:28:57 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
func (t *MapType) unify(other Type) (Type, ConversionKind) {
|
|
|
|
return unify(t, other, func() (Type, ConversionKind) {
|
|
|
|
switch other := other.(type) {
|
|
|
|
case *MapType:
|
|
|
|
// If the other type is a map type, unify based on the element type.
|
|
|
|
elementType, conversionKind := t.ElementType.unify(other.ElementType)
|
|
|
|
return NewMapType(elementType), conversionKind
|
|
|
|
case *ObjectType:
|
|
|
|
// If the other type is an object type, prefer the map type, but unify the property types.
|
|
|
|
elementType, conversionKind := t.ElementType, SafeConversion
|
|
|
|
for _, other := range other.Properties {
|
|
|
|
element, ck := elementType.unify(other)
|
|
|
|
if ck < conversionKind {
|
|
|
|
conversionKind = ck
|
|
|
|
}
|
|
|
|
elementType = element
|
|
|
|
}
|
|
|
|
return NewMapType(elementType), conversionKind
|
|
|
|
default:
|
|
|
|
// Prefer the map type.
|
2021-06-24 18:17:55 +02:00
|
|
|
kind, _ := t.conversionFrom(other, true, nil)
|
|
|
|
return t, kind
|
2020-03-18 17:28:57 +01:00
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
func (*MapType) isType() {}
|