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