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