src/go/types/typexpr.go

   1 // Copyright 2013 The Go Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style
   3 // license that can be found in the LICENSE file.
   4
   5 // This file implements type-checking of identifiers and type expressions.
   6
   7 package types
   8
   9 import (
  10         "fmt"
  11         "go/ast"
  12         "go/constant"
  13         "go/internal/typeparams"
  14         . "internal/types/errors"
  15         "strings"
  16 )
  17
  18 // ident type-checks identifier e and initializes x with the value or type of e.
  19 // If an error occurred, x.mode is set to invalid.
  20 // For the meaning of def, see Checker.definedType, below.
  21 // If wantType is set, the identifier e is expected to denote a type.
  22 func (check *Checker) ident(x *operand, e *ast.Ident, def *TypeName, wantType bool) {
  23         x.mode = invalid
  24         x.expr = e
  25
  26         // Note that we cannot use check.lookup here because the returned scope
  27         // may be different from obj.Parent(). See also Scope.LookupParent doc.
  28         scope, obj := check.scope.LookupParent(e.Name, check.pos)
  29         switch obj {
  30         case nil:
  31                 if e.Name == "_" {
  32                         // Blank identifiers are never declared, but the current identifier may
  33                         // be a placeholder for a receiver type parameter. In this case we can
  34                         // resolve its type and object from Checker.recvTParamMap.
  35                         if tpar := check.recvTParamMap[e]; tpar != nil {
  36                                 x.mode = typexpr
  37                                 x.typ = tpar
  38                         } else {
  39                                 check.error(e, InvalidBlank, "cannot use _ as value or type")
  40                         }
  41                 } else {
  42                         check.errorf(e, UndeclaredName, "undefined: %s", e.Name)
  43                 }
  44                 return
  45         case universeAny, universeComparable:
  46                 if !check.verifyVersionf(e, go1_18, "predeclared %s", e.Name) {
  47                         return // avoid follow-on errors
  48                 }
  49         }
  50         check.recordUse(e, obj)
  51
  52         // Type-check the object.
  53         // Only call Checker.objDecl if the object doesn't have a type yet
  54         // (in which case we must actually determine it) or the object is a
  55         // TypeName and we also want a type (in which case we might detect
  56         // a cycle which needs to be reported). Otherwise we can skip the
  57         // call and avoid a possible cycle error in favor of the more
  58         // informative "not a type/value" error that this function's caller
  59         // will issue (see go.dev/issue/25790).
  60         typ := obj.Type()
  61         if _, gotType := obj.(*TypeName); typ == nil || gotType && wantType {
  62                 check.objDecl(obj, def)
  63                 typ = obj.Type() // type must have been assigned by Checker.objDecl
  64         }
  65         assert(typ != nil)
  66
  67         // The object may have been dot-imported.
  68         // If so, mark the respective package as used.
  69         // (This code is only needed for dot-imports. Without them,
  70         // we only have to mark variables, see *Var case below).
  71         if pkgName := check.dotImportMap[dotImportKey{scope, obj.Name()}]; pkgName != nil {
  72                 pkgName.used = true
  73         }
  74
  75         switch obj := obj.(type) {
  76         case *PkgName:
  77                 check.errorf(e, InvalidPkgUse, "use of package %s not in selector", obj.name)
  78                 return
  79
  80         case *Const:
  81                 check.addDeclDep(obj)
  82                 if !isValid(typ) {
  83                         return
  84                 }
  85                 if obj == universeIota {
  86                         if check.iota == nil {
  87                                 check.error(e, InvalidIota, "cannot use iota outside constant declaration")
  88                                 return
  89                         }
  90                         x.val = check.iota
  91                 } else {
  92                         x.val = obj.val
  93                 }
  94                 assert(x.val != nil)
  95                 x.mode = constant_
  96
  97         case *TypeName:
  98                 if !check.enableAlias && check.isBrokenAlias(obj) {
  99                         check.errorf(e, InvalidDeclCycle, "invalid use of type alias %s in recursive type (see go.dev/issue/50729)", obj.name)
 100                         return
 101                 }
 102                 x.mode = typexpr
 103
 104         case *Var:
 105                 // It's ok to mark non-local variables, but ignore variables
 106                 // from other packages to avoid potential race conditions with
 107                 // dot-imported variables.
 108                 if obj.pkg == check.pkg {
 109                         obj.used = true
 110                 }
 111                 check.addDeclDep(obj)
 112                 if !isValid(typ) {
 113                         return
 114                 }
 115                 x.mode = variable
 116
 117         case *Func:
 118                 check.addDeclDep(obj)
 119                 x.mode = value
 120
 121         case *Builtin:
 122                 x.id = obj.id
 123                 x.mode = builtin
 124
 125         case *Nil:
 126                 x.mode = value
 127
 128         default:
 129                 unreachable()
 130         }
 131
 132         x.typ = typ
 133 }
 134
 135 // typ type-checks the type expression e and returns its type, or Typ[Invalid].
 136 // The type must not be an (uninstantiated) generic type.
 137 func (check *Checker) typ(e ast.Expr) Type {
 138         return check.definedType(e, nil)
 139 }
 140
 141 // varType type-checks the type expression e and returns its type, or Typ[Invalid].
 142 // The type must not be an (uninstantiated) generic type and it must not be a
 143 // constraint interface.
 144 func (check *Checker) varType(e ast.Expr) Type {
 145         typ := check.definedType(e, nil)
 146         check.validVarType(e, typ)
 147         return typ
 148 }
 149
 150 // validVarType reports an error if typ is a constraint interface.
 151 // The expression e is used for error reporting, if any.
 152 func (check *Checker) validVarType(e ast.Expr, typ Type) {
 153         // If we have a type parameter there's nothing to do.
 154         if isTypeParam(typ) {
 155                 return
 156         }
 157
 158         // We don't want to call under() or complete interfaces while we are in
 159         // the middle of type-checking parameter declarations that might belong
 160         // to interface methods. Delay this check to the end of type-checking.
 161         check.later(func() {
 162                 if t, _ := under(typ).(*Interface); t != nil {
 163                         tset := computeInterfaceTypeSet(check, e.Pos(), t) // TODO(gri) is this the correct position?
 164                         if !tset.IsMethodSet() {
 165                                 if tset.comparable {
 166                                         check.softErrorf(e, MisplacedConstraintIface, "cannot use type %s outside a type constraint: interface is (or embeds) comparable", typ)
 167                                 } else {
 168                                         check.softErrorf(e, MisplacedConstraintIface, "cannot use type %s outside a type constraint: interface contains type constraints", typ)
 169                                 }
 170                         }
 171                 }
 172         }).describef(e, "check var type %s", typ)
 173 }
 174
 175 // definedType is like typ but also accepts a type name def.
 176 // If def != nil, e is the type specification for the type named def, declared
 177 // in a type declaration, and def.typ.underlying will be set to the type of e
 178 // before any components of e are type-checked.
 179 func (check *Checker) definedType(e ast.Expr, def *TypeName) Type {
 180         typ := check.typInternal(e, def)
 181         assert(isTyped(typ))
 182         if isGeneric(typ) {
 183                 check.errorf(e, WrongTypeArgCount, "cannot use generic type %s without instantiation", typ)
 184                 typ = Typ[Invalid]
 185         }
 186         check.recordTypeAndValue(e, typexpr, typ, nil)
 187         return typ
 188 }
 189
 190 // genericType is like typ but the type must be an (uninstantiated) generic
 191 // type. If cause is non-nil and the type expression was a valid type but not
 192 // generic, cause will be populated with a message describing the error.
 193 func (check *Checker) genericType(e ast.Expr, cause *string) Type {
 194         typ := check.typInternal(e, nil)
 195         assert(isTyped(typ))
 196         if isValid(typ) && !isGeneric(typ) {
 197                 if cause != nil {
 198                         *cause = check.sprintf("%s is not a generic type", typ)
 199                 }
 200                 typ = Typ[Invalid]
 201         }
 202         // TODO(gri) what is the correct call below?
 203         check.recordTypeAndValue(e, typexpr, typ, nil)
 204         return typ
 205 }
 206
 207 // goTypeName returns the Go type name for typ and
 208 // removes any occurrences of "types." from that name.
 209 func goTypeName(typ Type) string {
 210         return strings.ReplaceAll(fmt.Sprintf("%T", typ), "types.", "")
 211 }
 212
 213 // typInternal drives type checking of types.
 214 // Must only be called by definedType or genericType.
 215 func (check *Checker) typInternal(e0 ast.Expr, def *TypeName) (T Type) {
 216         if check.conf._Trace {
 217                 check.trace(e0.Pos(), "-- type %s", e0)
 218                 check.indent++
 219                 defer func() {
 220                         check.indent--
 221                         var under Type
 222                         if T != nil {
 223                                 // Calling under() here may lead to endless instantiations.
 224                                 // Test case: type T[P any] *T[P]
 225                                 under = safeUnderlying(T)
 226                         }
 227                         if T == under {
 228                                 check.trace(e0.Pos(), "=> %s // %s", T, goTypeName(T))
 229                         } else {
 230                                 check.trace(e0.Pos(), "=> %s (under = %s) // %s", T, under, goTypeName(T))
 231                         }
 232                 }()
 233         }
 234
 235         switch e := e0.(type) {
 236         case *ast.BadExpr:
 237                 // ignore - error reported before
 238
 239         case *ast.Ident:
 240                 var x operand
 241                 check.ident(&x, e, def, true)
 242
 243                 switch x.mode {
 244                 case typexpr:
 245                         typ := x.typ
 246                         setDefType(def, typ)
 247                         return typ
 248                 case invalid:
 249                         // ignore - error reported before
 250                 case novalue:
 251                         check.errorf(&x, NotAType, "%s used as type", &x)
 252                 default:
 253                         check.errorf(&x, NotAType, "%s is not a type", &x)
 254                 }
 255
 256         case *ast.SelectorExpr:
 257                 var x operand
 258                 check.selector(&x, e, def, true)
 259
 260                 switch x.mode {
 261                 case typexpr:
 262                         typ := x.typ
 263                         setDefType(def, typ)
 264                         return typ
 265                 case invalid:
 266                         // ignore - error reported before
 267                 case novalue:
 268                         check.errorf(&x, NotAType, "%s used as type", &x)
 269                 default:
 270                         check.errorf(&x, NotAType, "%s is not a type", &x)
 271                 }
 272
 273         case *ast.IndexExpr, *ast.IndexListExpr:
 274                 ix := typeparams.UnpackIndexExpr(e)
 275                 check.verifyVersionf(inNode(e, ix.Lbrack), go1_18, "type instantiation")
 276                 return check.instantiatedType(ix, def)
 277
 278         case *ast.ParenExpr:
 279                 // Generic types must be instantiated before they can be used in any form.
 280                 // Consequently, generic types cannot be parenthesized.
 281                 return check.definedType(e.X, def)
 282
 283         case *ast.ArrayType:
 284                 if e.Len == nil {
 285                         typ := new(Slice)
 286                         setDefType(def, typ)
 287                         typ.elem = check.varType(e.Elt)
 288                         return typ
 289                 }
 290
 291                 typ := new(Array)
 292                 setDefType(def, typ)
 293                 // Provide a more specific error when encountering a [...] array
 294                 // rather than leaving it to the handling of the ... expression.
 295                 if _, ok := e.Len.(*ast.Ellipsis); ok {
 296                         check.error(e.Len, BadDotDotDotSyntax, "invalid use of [...] array (outside a composite literal)")
 297                         typ.len = -1
 298                 } else {
 299                         typ.len = check.arrayLength(e.Len)
 300                 }
 301                 typ.elem = check.varType(e.Elt)
 302                 if typ.len >= 0 {
 303                         return typ
 304                 }
 305                 // report error if we encountered [...]
 306
 307         case *ast.Ellipsis:
 308                 // dots are handled explicitly where they are legal
 309                 // (array composite literals and parameter lists)
 310                 check.error(e, InvalidDotDotDot, "invalid use of '...'")
 311                 check.use(e.Elt)
 312
 313         case *ast.StructType:
 314                 typ := new(Struct)
 315                 setDefType(def, typ)
 316                 check.structType(typ, e)
 317                 return typ
 318
 319         case *ast.StarExpr:
 320                 typ := new(Pointer)
 321                 typ.base = Typ[Invalid] // avoid nil base in invalid recursive type declaration
 322                 setDefType(def, typ)
 323                 typ.base = check.varType(e.X)
 324                 return typ
 325
 326         case *ast.FuncType:
 327                 typ := new(Signature)
 328                 setDefType(def, typ)
 329                 check.funcType(typ, nil, e)
 330                 return typ
 331
 332         case *ast.InterfaceType:
 333                 typ := check.newInterface()
 334                 setDefType(def, typ)
 335                 check.interfaceType(typ, e, def)
 336                 return typ
 337
 338         case *ast.MapType:
 339                 typ := new(Map)
 340                 setDefType(def, typ)
 341
 342                 typ.key = check.varType(e.Key)
 343                 typ.elem = check.varType(e.Value)
 344
 345                 // spec: "The comparison operators == and != must be fully defined
 346                 // for operands of the key type; thus the key type must not be a
 347                 // function, map, or slice."
 348                 //
 349                 // Delay this check because it requires fully setup types;
 350                 // it is safe to continue in any case (was go.dev/issue/6667).
 351                 check.later(func() {
 352                         if !Comparable(typ.key) {
 353                                 var why string
 354                                 if isTypeParam(typ.key) {
 355                                         why = " (missing comparable constraint)"
 356                                 }
 357                                 check.errorf(e.Key, IncomparableMapKey, "invalid map key type %s%s", typ.key, why)
 358                         }
 359                 }).describef(e.Key, "check map key %s", typ.key)
 360
 361                 return typ
 362
 363         case *ast.ChanType:
 364                 typ := new(Chan)
 365                 setDefType(def, typ)
 366
 367                 dir := SendRecv
 368                 switch e.Dir {
 369                 case ast.SEND | ast.RECV:
 370                         // nothing to do
 371                 case ast.SEND:
 372                         dir = SendOnly
 373                 case ast.RECV:
 374                         dir = RecvOnly
 375                 default:
 376                         check.errorf(e, InvalidSyntaxTree, "unknown channel direction %d", e.Dir)
 377                         // ok to continue
 378                 }
 379
 380                 typ.dir = dir
 381                 typ.elem = check.varType(e.Value)
 382                 return typ
 383
 384         default:
 385                 check.errorf(e0, NotAType, "%s is not a type", e0)
 386                 check.use(e0)
 387         }
 388
 389         typ := Typ[Invalid]
 390         setDefType(def, typ)
 391         return typ
 392 }
 393
 394 func setDefType(def *TypeName, typ Type) {
 395         if def != nil {
 396                 switch t := def.typ.(type) {
 397                 case *Alias:
 398                         // t.fromRHS should always be set, either to an invalid type
 399                         // in the beginning, or to typ in certain cyclic declarations.
 400                         if t.fromRHS != Typ[Invalid] && t.fromRHS != typ {
 401                                 panic(sprintf(nil, nil, true, "t.fromRHS = %s, typ = %s\n", t.fromRHS, typ))
 402                         }
 403                         t.fromRHS = typ
 404                 case *Basic:
 405                         assert(t == Typ[Invalid])
 406                 case *Named:
 407                         t.underlying = typ
 408                 default:
 409                         panic(fmt.Sprintf("unexpected type %T", t))
 410                 }
 411         }
 412 }
 413
 414 func (check *Checker) instantiatedType(ix *typeparams.IndexExpr, def *TypeName) (res Type) {
 415         if check.conf._Trace {
 416                 check.trace(ix.Pos(), "-- instantiating type %s with %s", ix.X, ix.Indices)
 417                 check.indent++
 418                 defer func() {
 419                         check.indent--
 420                         // Don't format the underlying here. It will always be nil.
 421                         check.trace(ix.Pos(), "=> %s", res)
 422                 }()
 423         }
 424
 425         var cause string
 426         gtyp := check.genericType(ix.X, &cause)
 427         if cause != "" {
 428                 check.errorf(ix.Orig, NotAGenericType, invalidOp+"%s (%s)", ix.Orig, cause)
 429         }
 430         if !isValid(gtyp) {
 431                 return gtyp // error already reported
 432         }
 433
 434         orig := asNamed(gtyp)
 435         if orig == nil {
 436                 panic(fmt.Sprintf("%v: cannot instantiate %v", ix.Pos(), gtyp))
 437         }
 438
 439         // evaluate arguments
 440         targs := check.typeList(ix.Indices)
 441         if targs == nil {
 442                 setDefType(def, Typ[Invalid]) // avoid errors later due to lazy instantiation
 443                 return Typ[Invalid]
 444         }
 445
 446         // create the instance
 447         inst := asNamed(check.instance(ix.Pos(), orig, targs, nil, check.context()))
 448         setDefType(def, inst)
 449
 450         // orig.tparams may not be set up, so we need to do expansion later.
 451         check.later(func() {
 452                 // This is an instance from the source, not from recursive substitution,
 453                 // and so it must be resolved during type-checking so that we can report
 454                 // errors.
 455                 check.recordInstance(ix.Orig, inst.TypeArgs().list(), inst)
 456
 457                 if check.validateTArgLen(ix.Pos(), inst.TypeParams().Len(), inst.TypeArgs().Len()) {
 458                         if i, err := check.verify(ix.Pos(), inst.TypeParams().list(), inst.TypeArgs().list(), check.context()); err != nil {
 459                                 // best position for error reporting
 460                                 pos := ix.Pos()
 461                                 if i < len(ix.Indices) {
 462                                         pos = ix.Indices[i].Pos()
 463                                 }
 464                                 check.softErrorf(atPos(pos), InvalidTypeArg, err.Error())
 465                         } else {
 466                                 check.mono.recordInstance(check.pkg, ix.Pos(), inst.TypeParams().list(), inst.TypeArgs().list(), ix.Indices)
 467                         }
 468                 }
 469
 470                 // TODO(rfindley): remove this call: we don't need to call validType here,
 471                 // as cycles can only occur for types used inside a Named type declaration,
 472                 // and so it suffices to call validType from declared types.
 473                 check.validType(inst)
 474         }).describef(ix, "resolve instance %s", inst)
 475
 476         return inst
 477 }
 478
 479 // arrayLength type-checks the array length expression e
 480 // and returns the constant length >= 0, or a value < 0
 481 // to indicate an error (and thus an unknown length).
 482 func (check *Checker) arrayLength(e ast.Expr) int64 {
 483         // If e is an identifier, the array declaration might be an
 484         // attempt at a parameterized type declaration with missing
 485         // constraint. Provide an error message that mentions array
 486         // length.
 487         if name, _ := e.(*ast.Ident); name != nil {
 488                 obj := check.lookup(name.Name)
 489                 if obj == nil {
 490                         check.errorf(name, InvalidArrayLen, "undefined array length %s or missing type constraint", name.Name)
 491                         return -1
 492                 }
 493                 if _, ok := obj.(*Const); !ok {
 494                         check.errorf(name, InvalidArrayLen, "invalid array length %s", name.Name)
 495                         return -1
 496                 }
 497         }
 498
 499         var x operand
 500         check.expr(nil, &x, e)
 501         if x.mode != constant_ {
 502                 if x.mode != invalid {
 503                         check.errorf(&x, InvalidArrayLen, "array length %s must be constant", &x)
 504                 }
 505                 return -1
 506         }
 507
 508         if isUntyped(x.typ) || isInteger(x.typ) {
 509                 if val := constant.ToInt(x.val); val.Kind() == constant.Int {
 510                         if representableConst(val, check, Typ[Int], nil) {
 511                                 if n, ok := constant.Int64Val(val); ok && n >= 0 {
 512                                         return n
 513                                 }
 514                         }
 515                 }
 516         }
 517
 518         var msg string
 519         if isInteger(x.typ) {
 520                 msg = "invalid array length %s"
 521         } else {
 522                 msg = "array length %s must be integer"
 523         }
 524         check.errorf(&x, InvalidArrayLen, msg, &x)
 525         return -1
 526 }
 527
 528 // typeList provides the list of types corresponding to the incoming expression list.
 529 // If an error occurred, the result is nil, but all list elements were type-checked.
 530 func (check *Checker) typeList(list []ast.Expr) []Type {
 531         res := make([]Type, len(list)) // res != nil even if len(list) == 0
 532         for i, x := range list {
 533                 t := check.varType(x)
 534                 if !isValid(t) {
 535                         res = nil
 536                 }
 537                 if res != nil {
 538                         res[i] = t
 539                 }
 540         }
 541         return res
 542 }