1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
|
// Copyright 2020 CUE Authors
//
// 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 export
import (
"cmp"
"fmt"
"slices"
"cuelang.org/go/cue/ast"
"cuelang.org/go/cue/token"
"cuelang.org/go/internal"
"cuelang.org/go/internal/core/adt"
)
// Modes:
// raw: as is
// def: merge structs, print reset as is.
//
// Possible simplifications in def mode:
// - merge contents of multiple _literal_ structs.
// - this is not possible if some of the elements are bulk optional
// (or is it?).
// - still do not ever resolve references.
// - to do this, fields must be pre-linked to their destinations.
// - use astutil.Sanitize to resolve shadowing and imports.
//
//
// Categories of printing:
// - concrete
// - optionals
// - references
// - constraints
//
// Mixed mode is also not supported in the old implementation (at least not
// correctly). It requires references to resolve properly, backtracking to
// a common root and prefixing that to the reference. This is now possible
// with the Environment construct and could be done later.
var empty *adt.Vertex
func init() {
// TODO: Consider setting a non-nil BaseValue.
empty = &adt.Vertex{}
empty.ForceDone()
}
// innerExpr is like expr, but prohibits inlining in certain cases.
func (e *exporter) innerExpr(env *adt.Environment, v adt.Elem) (result ast.Expr) {
e.inExpression++
r := e.expr(env, v)
e.inExpression--
return r
}
// expr converts an ADT expression to an AST expression.
// The env is used for resolution and does not need to be given if v is known
// to not contain any references.
func (e *exporter) expr(env *adt.Environment, v adt.Elem) (result ast.Expr) {
switch x := v.(type) {
case nil:
return nil
case *adt.Vertex:
if x.IsData() {
// Treat as literal value.
return e.value(x)
} // Should this be the arcs label?
a := []conjunct{}
x.VisitLeafConjuncts(func(c adt.Conjunct) bool {
if c, ok := c.Elem().(*adt.Comprehension); ok && !c.DidResolve() {
return true
}
a = append(a, conjunct{c, 0})
return true
})
return e.mergeValues(adt.InvalidLabel, x, a, x.Conjuncts...)
case *adt.StructLit:
c := adt.MakeRootConjunct(env, x)
return e.mergeValues(adt.InvalidLabel, nil, []conjunct{{c: c, up: 0}}, c)
case adt.Value:
return e.value(x) // Use conjuncts.
default:
return e.adt(env, v)
}
}
// Piece out values:
// For a struct, piece out conjuncts that are already values. Those can be
// unified. All other conjuncts are added verbatim.
func (x *exporter) mergeValues(label adt.Feature, src *adt.Vertex, a []conjunct, orig ...adt.Conjunct) (expr ast.Expr) {
e := conjuncts{
exporter: x,
values: &adt.Vertex{},
fields: map[adt.Feature]field{},
attrs: []*ast.Attribute{},
}
s, saved := e.pushFrame(src, orig)
defer e.popFrame(saved)
// Handle value aliases and lets
var valueAlias *ast.Alias
for _, c := range a {
if f, ok := c.c.Field().Source().(*ast.Field); ok {
if a, ok := f.Value.(*ast.Alias); ok {
if valueAlias == nil {
if e.valueAlias == nil {
e.valueAlias = map[*ast.Alias]*ast.Alias{}
}
name := a.Ident.Name
name = e.uniqueAlias(name)
valueAlias = &ast.Alias{Ident: ast.NewIdent(name)}
}
e.valueAlias[a] = valueAlias
}
}
x.markLets(c.c.Expr().Source(), s)
}
defer filterUnusedLets(s)
defer func() {
if valueAlias != nil {
valueAlias.Expr = expr
expr = valueAlias
}
}()
hasAlias := len(s.Elts) > 0
for _, c := range a {
e.top().upCount = c.up
x := c.c.Elem()
e.addExpr(c.c.Env, src, x, false)
}
if src != nil {
for _, a := range src.Arcs {
if x, ok := e.fields[a.Label]; ok {
x.arc = a
x.arcType = a.ArcType
e.fields[a.Label] = x
}
}
}
for _, a := range e.attrs {
s.Elts = append(s.Elts, a)
}
// Unify values only for one level.
if e.values.HasConjuncts() {
e.values.Finalize(e.ctx)
e.embed = append(e.embed, e.value(e.values, e.values.Conjuncts...))
}
// Collect and order set of fields.
fields := []adt.Feature{}
for f := range e.fields {
fields = append(fields, f)
}
// Sort fields in case features lists are missing to ensure
// predictability. Also sort in reverse order, so that bugs
// are more likely exposed.
slices.SortFunc(fields, func(f1, f2 adt.Feature) int {
return -cmp.Compare(f1, f2)
})
m := sortArcs(extractFeatures(e.structs))
slices.SortStableFunc(fields, func(f1, f2 adt.Feature) int {
if m[f2] == 0 {
if m[f1] == 0 {
return +1
}
return -1
}
return -cmp.Compare(m[f1], m[f2])
})
if len(e.fields) == 0 && !e.hasEllipsis {
switch len(e.embed) + len(e.conjuncts) {
case 0:
if len(e.attrs) > 0 {
break
}
if len(e.structs) > 0 || e.isData {
return e.wrapCloseIfNecessary(s, src)
}
return ast.NewIdent("_")
case 1:
var x ast.Expr
if len(e.conjuncts) == 1 {
x = e.conjuncts[0]
} else {
x = e.embed[0]
}
if len(e.attrs) == 0 && !hasAlias {
return x
}
if st, ok := x.(*ast.StructLit); ok {
s.Elts = append(s.Elts, st.Elts...)
return e.wrapCloseIfNecessary(s, src)
}
}
}
for _, x := range e.embed {
s.Elts = append(s.Elts, &ast.EmbedDecl{Expr: x})
}
for _, f := range fields {
if f.IsLet() {
continue
}
field := e.getField(f)
c := field.conjuncts
label := e.stringLabel(f)
if f.IsDef() {
x.inDefinition++
}
a := []adt.Conjunct{}
for _, cc := range c {
a = append(a, cc.c)
}
d := &ast.Field{Label: label}
top := e.frame(0)
if fr, ok := top.fields[f]; ok && fr.alias != "" {
setFieldAlias(d, fr.alias)
fr.node = d
top.fields[f] = fr
}
d.Value = e.mergeValues(f, field.arc, c, a...)
e.linkField(field.arc, d)
if f.IsDef() {
x.inDefinition--
}
internal.SetConstraint(d, field.arcType.Token())
if x.cfg.ShowDocs {
v := &adt.Vertex{Conjuncts: a}
docs := extractDocs(v)
ast.SetComments(d, docs)
}
if x.cfg.ShowAttributes {
for _, c := range a {
d.Attrs = extractFieldAttrs(d.Attrs, c.Field())
}
}
s.Elts = append(s.Elts, d)
}
if e.hasEllipsis {
s.Elts = append(s.Elts, &ast.Ellipsis{})
}
ws := e.wrapCloseIfNecessary(s, src)
switch {
case len(e.conjuncts) == 0:
return ws
case len(e.structs) > 0, len(s.Elts) > 0:
e.conjuncts = append(e.conjuncts, ws)
}
return ast.NewBinExpr(token.AND, e.conjuncts...)
}
func (e *conjuncts) wrapCloseIfNecessary(s *ast.StructLit, v *adt.Vertex) ast.Expr {
if !e.hasEllipsis && v != nil {
if v.ClosedNonRecursive {
// Eval V3 logic
return ast.NewCall(ast.NewIdent("close"), s)
}
if st, ok := v.BaseValue.(*adt.StructMarker); ok && st.NeedClose {
// Eval V2 logic
return ast.NewCall(ast.NewIdent("close"), s)
}
}
return s
}
// Conjuncts if for collecting values of a single vertex.
type conjuncts struct {
*exporter
// Values is used to collect non-struct values.
values *adt.Vertex
embed []ast.Expr
conjuncts []ast.Expr
structs []*adt.StructInfo
fields map[adt.Feature]field
attrs []*ast.Attribute
hasEllipsis bool
// A value is a struct if it has a non-zero structs slice or if isData is
// set to true. Data vertices may not have conjuncts associated with them.
isData bool
}
func (c *conjuncts) getField(label adt.Feature) field {
f, ok := c.fields[label]
if !ok {
f.arcType = adt.ArcNotPresent
}
return f
}
func (c *conjuncts) addValueConjunct(src *adt.Vertex, env *adt.Environment, x adt.Elem) {
switch b, ok := x.(adt.BaseValue); {
case ok && src != nil && isTop(b) && !isTop(src.BaseValue):
// drop top
default:
c.values.AddConjunct(adt.MakeRootConjunct(env, x))
}
}
func (c *conjuncts) addConjunct(f adt.Feature, t adt.ArcType, env *adt.Environment, n adt.Node) {
x := c.getField(f)
if t < x.arcType {
x.arcType = t
}
v := adt.MakeRootConjunct(env, n)
x.conjuncts = append(x.conjuncts, conjunct{
c: v,
up: c.top().upCount,
})
// x.upCounts = append(x.upCounts, c.top().upCount)
c.fields[f] = x
}
type field struct {
arcType adt.ArcType
arc *adt.Vertex
conjuncts []conjunct
}
type conjunct struct {
c adt.Conjunct
up int32
}
func (e *conjuncts) addExpr(env *adt.Environment, src *adt.Vertex, x adt.Elem, isEmbed bool) {
switch x := x.(type) {
case *adt.StructLit:
e.top().upCount++
if e.cfg.ShowAttributes {
e.attrs = extractDeclAttrs(e.attrs, x.Src)
}
// Only add if it only has no bulk fields or ellipsis.
if isComplexStruct(x) {
_, saved := e.pushFrame(src, nil)
e.embed = append(e.embed, e.adt(env, x))
e.top().upCount-- // not necessary, but for proper form
e.popFrame(saved)
return
}
// Used for sorting.
e.structs = append(e.structs, &adt.StructInfo{StructLit: x, Env: env})
env = &adt.Environment{Up: env, Vertex: e.node()}
for _, d := range x.Decls {
var label adt.Feature
t := adt.ArcNotPresent
switch f := d.(type) {
case *adt.Field:
label = f.Label
t = f.ArcType
// TODO: mark optional here, if needed.
case *adt.LetField:
continue
case *adt.Ellipsis:
e.hasEllipsis = true
continue
case adt.Expr:
e.addExpr(env, nil, f, true)
continue
// TODO: also handle dynamic fields
default:
panic(fmt.Sprintf("Unexpected type %T", d))
}
e.addConjunct(label, t, env, d)
}
e.top().upCount--
case adt.Value: // other values.
switch v := x.(type) {
case nil:
default:
e.addValueConjunct(src, env, x)
case *adt.Vertex:
if b := v.Bottom(); b != nil {
if !b.IsIncomplete() || e.cfg.Final {
e.addExpr(env, v, b, false)
return
}
}
switch {
default:
v.VisitLeafConjuncts(func(c adt.Conjunct) bool {
e.addExpr(c.Env, v, c.Elem(), false)
return true
})
case v.IsData():
e.structs = append(e.structs, v.Structs...)
e.isData = true
if y, ok := v.BaseValue.(adt.Value); ok {
e.addValueConjunct(src, env, y)
}
for _, a := range v.Arcs {
a.Finalize(e.ctx) // TODO: should we do this?
if !a.IsDefined(e.ctx) {
continue
}
e.addConjunct(a.Label, a.ArcType, env, a)
}
}
}
case *adt.BinaryExpr:
switch {
case x.Op == adt.AndOp && !isEmbed:
e.addExpr(env, src, x.X, false)
e.addExpr(env, src, x.Y, false)
case isSelfContained(x):
e.addValueConjunct(src, env, x)
default:
if isEmbed {
e.embed = append(e.embed, e.expr(env, x))
} else {
e.conjuncts = append(e.conjuncts, e.expr(env, x))
}
}
default:
switch {
case isSelfContained(x):
e.addValueConjunct(src, env, x)
case isEmbed:
e.embed = append(e.embed, e.expr(env, x))
default:
if x := e.expr(env, x); x != dummyTop {
e.conjuncts = append(e.conjuncts, x)
}
}
}
}
func isTop(x adt.BaseValue) bool {
switch v := x.(type) {
case *adt.Top:
return true
case *adt.BasicType:
return v.K == adt.TopKind
default:
return false
}
}
func isComplexStruct(s *adt.StructLit) bool {
for _, d := range s.Decls {
switch x := d.(type) {
case *adt.Field:
// TODO: remove this and also handle field annotation in expr().
// This allows structs to be merged. Ditto below.
if x.Src != nil {
if _, ok := x.Src.Label.(*ast.Alias); ok {
return ok
}
}
case *adt.LetField:
case adt.Expr:
case *adt.Ellipsis:
if x.Value != nil {
return true
}
default:
return true
}
}
return false
}
func isSelfContained(expr adt.Elem) bool {
switch x := expr.(type) {
case *adt.BinaryExpr:
return isSelfContained(x.X) && isSelfContained(x.Y)
case *adt.UnaryExpr:
return isSelfContained(x.X)
case *adt.BoundExpr:
return isSelfContained(x.Expr)
case adt.Value:
return true
}
return false
}
|