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