decl.go

     1  // Copyright 2014 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  package types2
     6  
     7  import (
     8  	"cmd/compile/internal/syntax"
     9  	"fmt"
    10  	"go/constant"
    11  	"internal/buildcfg"
    12  	. "internal/types/errors"
    13  	"slices"
    14  )
    15  
    16  func (check *Checker) declare(scope *Scope, id *syntax.Name, obj Object, pos syntax.Pos) {
    17  	// spec: "The blank identifier, represented by the underscore
    18  	// character _, may be used in a declaration like any other
    19  	// identifier but the declaration does not introduce a new
    20  	// binding."
    21  	if obj.Name() != "_" {
    22  		if alt := scope.Insert(obj); alt != nil {
    23  			err := check.newError(DuplicateDecl)
    24  			err.addf(obj, "%s redeclared in this block", obj.Name())
    25  			err.addAltDecl(alt)
    26  			err.report()
    27  			return
    28  		}
    29  		obj.setScopePos(pos)
    30  	}
    31  	if id != nil {
    32  		check.recordDef(id, obj)
    33  	}
    34  }
    35  
    36  // pathString returns a string of the form a->b-> ... ->g for a path [a, b, ... g].
    37  func pathString(path []Object) string {
    38  	var s string
    39  	for i, p := range path {
    40  		if i > 0 {
    41  			s += "->"
    42  		}
    43  		s += p.Name()
    44  	}
    45  	return s
    46  }
    47  
    48  // objDecl type-checks the declaration of obj in its respective (file) environment.
    49  // For the meaning of def, see Checker.definedType, in typexpr.go.
    50  func (check *Checker) objDecl(obj Object, def *TypeName) {
    51  	if tracePos {
    52  		check.pushPos(obj.Pos())
    53  		defer func() {
    54  			// If we're panicking, keep stack of source positions.
    55  			if p := recover(); p != nil {
    56  				panic(p)
    57  			}
    58  			check.popPos()
    59  		}()
    60  	}
    61  
    62  	if check.conf.Trace && obj.Type() == nil {
    63  		if check.indent == 0 {
    64  			fmt.Println() // empty line between top-level objects for readability
    65  		}
    66  		check.trace(obj.Pos(), "-- checking %s (%s, objPath = %s)", obj, obj.color(), pathString(check.objPath))
    67  		check.indent++
    68  		defer func() {
    69  			check.indent--
    70  			check.trace(obj.Pos(), "=> %s (%s)", obj, obj.color())
    71  		}()
    72  	}
    73  
    74  	// Checking the declaration of obj means inferring its type
    75  	// (and possibly its value, for constants).
    76  	// An object's type (and thus the object) may be in one of
    77  	// three states which are expressed by colors:
    78  	//
    79  	// - an object whose type is not yet known is painted white (initial color)
    80  	// - an object whose type is in the process of being inferred is painted grey
    81  	// - an object whose type is fully inferred is painted black
    82  	//
    83  	// During type inference, an object's color changes from white to grey
    84  	// to black (pre-declared objects are painted black from the start).
    85  	// A black object (i.e., its type) can only depend on (refer to) other black
    86  	// ones. White and grey objects may depend on white and black objects.
    87  	// A dependency on a grey object indicates a cycle which may or may not be
    88  	// valid.
    89  	//
    90  	// When objects turn grey, they are pushed on the object path (a stack);
    91  	// they are popped again when they turn black. Thus, if a grey object (a
    92  	// cycle) is encountered, it is on the object path, and all the objects
    93  	// it depends on are the remaining objects on that path. Color encoding
    94  	// is such that the color value of a grey object indicates the index of
    95  	// that object in the object path.
    96  
    97  	// During type-checking, white objects may be assigned a type without
    98  	// traversing through objDecl; e.g., when initializing constants and
    99  	// variables. Update the colors of those objects here (rather than
   100  	// everywhere where we set the type) to satisfy the color invariants.
   101  	if obj.color() == white && obj.Type() != nil {
   102  		obj.setColor(black)
   103  		return
   104  	}
   105  
   106  	switch obj.color() {
   107  	case white:
   108  		assert(obj.Type() == nil)
   109  		// All color values other than white and black are considered grey.
   110  		// Because black and white are < grey, all values >= grey are grey.
   111  		// Use those values to encode the object's index into the object path.
   112  		obj.setColor(grey + color(check.push(obj)))
   113  		defer func() {
   114  			check.pop().setColor(black)
   115  		}()
   116  
   117  	case black:
   118  		assert(obj.Type() != nil)
   119  		return
   120  
   121  	default:
   122  		// Color values other than white or black are considered grey.
   123  		fallthrough
   124  
   125  	case grey:
   126  		// We have a (possibly invalid) cycle.
   127  		// In the existing code, this is marked by a non-nil type
   128  		// for the object except for constants and variables whose
   129  		// type may be non-nil (known), or nil if it depends on the
   130  		// not-yet known initialization value.
   131  		// In the former case, set the type to Typ[Invalid] because
   132  		// we have an initialization cycle. The cycle error will be
   133  		// reported later, when determining initialization order.
   134  		// TODO(gri) Report cycle here and simplify initialization
   135  		// order code.
   136  		switch obj := obj.(type) {
   137  		case *Const:
   138  			if !check.validCycle(obj) || obj.typ == nil {
   139  				obj.typ = Typ[Invalid]
   140  			}
   141  
   142  		case *Var:
   143  			if !check.validCycle(obj) || obj.typ == nil {
   144  				obj.typ = Typ[Invalid]
   145  			}
   146  
   147  		case *TypeName:
   148  			if !check.validCycle(obj) {
   149  				// break cycle
   150  				// (without this, calling underlying()
   151  				// below may lead to an endless loop
   152  				// if we have a cycle for a defined
   153  				// (*Named) type)
   154  				obj.typ = Typ[Invalid]
   155  			}
   156  
   157  		case *Func:
   158  			if !check.validCycle(obj) {
   159  				// Don't set obj.typ to Typ[Invalid] here
   160  				// because plenty of code type-asserts that
   161  				// functions have a *Signature type. Grey
   162  				// functions have their type set to an empty
   163  				// signature which makes it impossible to
   164  				// initialize a variable with the function.
   165  			}
   166  
   167  		default:
   168  			panic("unreachable")
   169  		}
   170  		assert(obj.Type() != nil)
   171  		return
   172  	}
   173  
   174  	d := check.objMap[obj]
   175  	if d == nil {
   176  		check.dump("%v: %s should have been declared", obj.Pos(), obj)
   177  		panic("unreachable")
   178  	}
   179  
   180  	// save/restore current environment and set up object environment
   181  	defer func(env environment) {
   182  		check.environment = env
   183  	}(check.environment)
   184  	check.environment = environment{scope: d.file, version: d.version}
   185  
   186  	// Const and var declarations must not have initialization
   187  	// cycles. We track them by remembering the current declaration
   188  	// in check.decl. Initialization expressions depending on other
   189  	// consts, vars, or functions, add dependencies to the current
   190  	// check.decl.
   191  	switch obj := obj.(type) {
   192  	case *Const:
   193  		check.decl = d // new package-level const decl
   194  		check.constDecl(obj, d.vtyp, d.init, d.inherited)
   195  	case *Var:
   196  		check.decl = d // new package-level var decl
   197  		check.varDecl(obj, d.lhs, d.vtyp, d.init)
   198  	case *TypeName:
   199  		// invalid recursive types are detected via path
   200  		check.typeDecl(obj, d.tdecl, def)
   201  		check.collectMethods(obj) // methods can only be added to top-level types
   202  	case *Func:
   203  		// functions may be recursive - no need to track dependencies
   204  		check.funcDecl(obj, d)
   205  	default:
   206  		panic("unreachable")
   207  	}
   208  }
   209  
   210  // validCycle reports whether the cycle starting with obj is valid and
   211  // reports an error if it is not.
   212  func (check *Checker) validCycle(obj Object) (valid bool) {
   213  	// The object map contains the package scope objects and the non-interface methods.
   214  	if debug {
   215  		info := check.objMap[obj]
   216  		inObjMap := info != nil && (info.fdecl == nil || info.fdecl.Recv == nil) // exclude methods
   217  		isPkgObj := obj.Parent() == check.pkg.scope
   218  		if isPkgObj != inObjMap {
   219  			check.dump("%v: inconsistent object map for %s (isPkgObj = %v, inObjMap = %v)", obj.Pos(), obj, isPkgObj, inObjMap)
   220  			panic("unreachable")
   221  		}
   222  	}
   223  
   224  	// Count cycle objects.
   225  	assert(obj.color() >= grey)
   226  	start := obj.color() - grey // index of obj in objPath
   227  	cycle := check.objPath[start:]
   228  	tparCycle := false // if set, the cycle is through a type parameter list
   229  	nval := 0          // number of (constant or variable) values in the cycle; valid if !generic
   230  	ndef := 0          // number of type definitions in the cycle; valid if !generic
   231  loop:
   232  	for _, obj := range cycle {
   233  		switch obj := obj.(type) {
   234  		case *Const, *Var:
   235  			nval++
   236  		case *TypeName:
   237  			// If we reach a generic type that is part of a cycle
   238  			// and we are in a type parameter list, we have a cycle
   239  			// through a type parameter list, which is invalid.
   240  			if check.inTParamList && isGeneric(obj.typ) {
   241  				tparCycle = true
   242  				break loop
   243  			}
   244  
   245  			// Determine if the type name is an alias or not. For
   246  			// package-level objects, use the object map which
   247  			// provides syntactic information (which doesn't rely
   248  			// on the order in which the objects are set up). For
   249  			// local objects, we can rely on the order, so use
   250  			// the object's predicate.
   251  			// TODO(gri) It would be less fragile to always access
   252  			// the syntactic information. We should consider storing
   253  			// this information explicitly in the object.
   254  			var alias bool
   255  			if check.conf.EnableAlias {
   256  				alias = obj.IsAlias()
   257  			} else {
   258  				if d := check.objMap[obj]; d != nil {
   259  					alias = d.tdecl.Alias // package-level object
   260  				} else {
   261  					alias = obj.IsAlias() // function local object
   262  				}
   263  			}
   264  			if !alias {
   265  				ndef++
   266  			}
   267  		case *Func:
   268  			// ignored for now
   269  		default:
   270  			panic("unreachable")
   271  		}
   272  	}
   273  
   274  	if check.conf.Trace {
   275  		check.trace(obj.Pos(), "## cycle detected: objPath = %s->%s (len = %d)", pathString(cycle), obj.Name(), len(cycle))
   276  		if tparCycle {
   277  			check.trace(obj.Pos(), "## cycle contains: generic type in a type parameter list")
   278  		} else {
   279  			check.trace(obj.Pos(), "## cycle contains: %d values, %d type definitions", nval, ndef)
   280  		}
   281  		defer func() {
   282  			if valid {
   283  				check.trace(obj.Pos(), "=> cycle is valid")
   284  			} else {
   285  				check.trace(obj.Pos(), "=> error: cycle is invalid")
   286  			}
   287  		}()
   288  	}
   289  
   290  	if !tparCycle {
   291  		// A cycle involving only constants and variables is invalid but we
   292  		// ignore them here because they are reported via the initialization
   293  		// cycle check.
   294  		if nval == len(cycle) {
   295  			return true
   296  		}
   297  
   298  		// A cycle involving only types (and possibly functions) must have at least
   299  		// one type definition to be permitted: If there is no type definition, we
   300  		// have a sequence of alias type names which will expand ad infinitum.
   301  		if nval == 0 && ndef > 0 {
   302  			return true
   303  		}
   304  	}
   305  
   306  	check.cycleError(cycle, firstInSrc(cycle))
   307  	return false
   308  }
   309  
   310  // cycleError reports a declaration cycle starting with the object at cycle[start].
   311  func (check *Checker) cycleError(cycle []Object, start int) {
   312  	// name returns the (possibly qualified) object name.
   313  	// This is needed because with generic types, cycles
   314  	// may refer to imported types. See go.dev/issue/50788.
   315  	// TODO(gri) This functionality is used elsewhere. Factor it out.
   316  	name := func(obj Object) string {
   317  		return packagePrefix(obj.Pkg(), check.qualifier) + obj.Name()
   318  	}
   319  
   320  	// If obj is a type alias, mark it as valid (not broken) in order to avoid follow-on errors.
   321  	obj := cycle[start]
   322  	tname, _ := obj.(*TypeName)
   323  	if tname != nil {
   324  		if check.conf.EnableAlias {
   325  			if a, ok := tname.Type().(*Alias); ok {
   326  				a.fromRHS = Typ[Invalid]
   327  			}
   328  		} else {
   329  			if tname.IsAlias() {
   330  				check.validAlias(tname, Typ[Invalid])
   331  			}
   332  		}
   333  	}
   334  
   335  	// report a more concise error for self references
   336  	if len(cycle) == 1 {
   337  		if tname != nil {
   338  			check.errorf(obj, InvalidDeclCycle, "invalid recursive type: %s refers to itself", name(obj))
   339  		} else {
   340  			check.errorf(obj, InvalidDeclCycle, "invalid cycle in declaration: %s refers to itself", name(obj))
   341  		}
   342  		return
   343  	}
   344  
   345  	err := check.newError(InvalidDeclCycle)
   346  	if tname != nil {
   347  		err.addf(obj, "invalid recursive type %s", name(obj))
   348  	} else {
   349  		err.addf(obj, "invalid cycle in declaration of %s", name(obj))
   350  	}
   351  	// "cycle[i] refers to cycle[j]" for (i,j) = (s,s+1), (s+1,s+2), ..., (n-1,0), (0,1), ..., (s-1,s) for len(cycle) = n, s = start.
   352  	for i := range cycle {
   353  		next := cycle[(start+i+1)%len(cycle)]
   354  		err.addf(obj, "%s refers to %s", name(obj), name(next))
   355  		obj = next
   356  	}
   357  	err.report()
   358  }
   359  
   360  // firstInSrc reports the index of the object with the "smallest"
   361  // source position in path. path must not be empty.
   362  func firstInSrc(path []Object) int {
   363  	fst, pos := 0, path[0].Pos()
   364  	for i, t := range path[1:] {
   365  		if cmpPos(t.Pos(), pos) < 0 {
   366  			fst, pos = i+1, t.Pos()
   367  		}
   368  	}
   369  	return fst
   370  }
   371  
   372  func (check *Checker) constDecl(obj *Const, typ, init syntax.Expr, inherited bool) {
   373  	assert(obj.typ == nil)
   374  
   375  	// use the correct value of iota and errpos
   376  	defer func(iota constant.Value, errpos syntax.Pos) {
   377  		check.iota = iota
   378  		check.errpos = errpos
   379  	}(check.iota, check.errpos)
   380  	check.iota = obj.val
   381  	check.errpos = nopos
   382  
   383  	// provide valid constant value under all circumstances
   384  	obj.val = constant.MakeUnknown()
   385  
   386  	// determine type, if any
   387  	if typ != nil {
   388  		t := check.typ(typ)
   389  		if !isConstType(t) {
   390  			// don't report an error if the type is an invalid C (defined) type
   391  			// (go.dev/issue/22090)
   392  			if isValid(under(t)) {
   393  				check.errorf(typ, InvalidConstType, "invalid constant type %s", t)
   394  			}
   395  			obj.typ = Typ[Invalid]
   396  			return
   397  		}
   398  		obj.typ = t
   399  	}
   400  
   401  	// check initialization
   402  	var x operand
   403  	if init != nil {
   404  		if inherited {
   405  			// The initialization expression is inherited from a previous
   406  			// constant declaration, and (error) positions refer to that
   407  			// expression and not the current constant declaration. Use
   408  			// the constant identifier position for any errors during
   409  			// init expression evaluation since that is all we have
   410  			// (see issues go.dev/issue/42991, go.dev/issue/42992).
   411  			check.errpos = obj.pos
   412  		}
   413  		check.expr(nil, &x, init)
   414  	}
   415  	check.initConst(obj, &x)
   416  }
   417  
   418  func (check *Checker) varDecl(obj *Var, lhs []*Var, typ, init syntax.Expr) {
   419  	assert(obj.typ == nil)
   420  
   421  	// determine type, if any
   422  	if typ != nil {
   423  		obj.typ = check.varType(typ)
   424  		// We cannot spread the type to all lhs variables if there
   425  		// are more than one since that would mark them as checked
   426  		// (see Checker.objDecl) and the assignment of init exprs,
   427  		// if any, would not be checked.
   428  		//
   429  		// TODO(gri) If we have no init expr, we should distribute
   430  		// a given type otherwise we need to re-evaluate the type
   431  		// expr for each lhs variable, leading to duplicate work.
   432  	}
   433  
   434  	// check initialization
   435  	if init == nil {
   436  		if typ == nil {
   437  			// error reported before by arityMatch
   438  			obj.typ = Typ[Invalid]
   439  		}
   440  		return
   441  	}
   442  
   443  	if lhs == nil || len(lhs) == 1 {
   444  		assert(lhs == nil || lhs[0] == obj)
   445  		var x operand
   446  		check.expr(newTarget(obj.typ, obj.name), &x, init)
   447  		check.initVar(obj, &x, "variable declaration")
   448  		return
   449  	}
   450  
   451  	if debug {
   452  		// obj must be one of lhs
   453  		if !slices.Contains(lhs, obj) {
   454  			panic("inconsistent lhs")
   455  		}
   456  	}
   457  
   458  	// We have multiple variables on the lhs and one init expr.
   459  	// Make sure all variables have been given the same type if
   460  	// one was specified, otherwise they assume the type of the
   461  	// init expression values (was go.dev/issue/15755).
   462  	if typ != nil {
   463  		for _, lhs := range lhs {
   464  			lhs.typ = obj.typ
   465  		}
   466  	}
   467  
   468  	check.initVars(lhs, []syntax.Expr{init}, nil)
   469  }
   470  
   471  // isImportedConstraint reports whether typ is an imported type constraint.
   472  func (check *Checker) isImportedConstraint(typ Type) bool {
   473  	named := asNamed(typ)
   474  	if named == nil || named.obj.pkg == check.pkg || named.obj.pkg == nil {
   475  		return false
   476  	}
   477  	u, _ := named.under().(*Interface)
   478  	return u != nil && !u.IsMethodSet()
   479  }
   480  
   481  func (check *Checker) typeDecl(obj *TypeName, tdecl *syntax.TypeDecl, def *TypeName) {
   482  	assert(obj.typ == nil)
   483  
   484  	// Only report a version error if we have not reported one already.
   485  	versionErr := false
   486  
   487  	var rhs Type
   488  	check.later(func() {
   489  		if t := asNamed(obj.typ); t != nil { // type may be invalid
   490  			check.validType(t)
   491  		}
   492  		// If typ is local, an error was already reported where typ is specified/defined.
   493  		_ = !versionErr && check.isImportedConstraint(rhs) && check.verifyVersionf(tdecl.Type, go1_18, "using type constraint %s", rhs)
   494  	}).describef(obj, "validType(%s)", obj.Name())
   495  
   496  	// First type parameter, or nil.
   497  	var tparam0 *syntax.Field
   498  	if len(tdecl.TParamList) > 0 {
   499  		tparam0 = tdecl.TParamList[0]
   500  	}
   501  
   502  	// alias declaration
   503  	if tdecl.Alias {
   504  		// Report highest version requirement first so that fixing a version issue
   505  		// avoids possibly two -lang changes (first to Go 1.9 and then to Go 1.23).
   506  		if !versionErr && tparam0 != nil && !check.verifyVersionf(tparam0, go1_23, "generic type alias") {
   507  			versionErr = true
   508  		}
   509  		if !versionErr && !check.verifyVersionf(tdecl, go1_9, "type alias") {
   510  			versionErr = true
   511  		}
   512  
   513  		if check.conf.EnableAlias {
   514  			alias := check.newAlias(obj, nil)
   515  			setDefType(def, alias)
   516  
   517  			// If we could not type the RHS, set it to invalid. This should
   518  			// only ever happen if we panic before setting.
   519  			defer func() {
   520  				if alias.fromRHS == nil {
   521  					alias.fromRHS = Typ[Invalid]
   522  					unalias(alias)
   523  				}
   524  			}()
   525  
   526  			// handle type parameters even if not allowed (Alias type is supported)
   527  			if tparam0 != nil {
   528  				if !versionErr && !buildcfg.Experiment.AliasTypeParams {
   529  					check.error(tdecl, UnsupportedFeature, "generic type alias requires GOEXPERIMENT=aliastypeparams")
   530  					versionErr = true
   531  				}
   532  				check.openScope(tdecl, "type parameters")
   533  				defer check.closeScope()
   534  				check.collectTypeParams(&alias.tparams, tdecl.TParamList)
   535  			}
   536  
   537  			rhs = check.definedType(tdecl.Type, obj)
   538  			assert(rhs != nil)
   539  
   540  			alias.fromRHS = rhs
   541  			unalias(alias) // resolve alias.actual
   542  		} else {
   543  			if !versionErr && tparam0 != nil {
   544  				check.error(tdecl, UnsupportedFeature, "generic type alias requires GODEBUG=gotypesalias=1 or unset")
   545  				versionErr = true
   546  			}
   547  
   548  			check.brokenAlias(obj)
   549  			rhs = check.typ(tdecl.Type)
   550  			check.validAlias(obj, rhs)
   551  		}
   552  		return
   553  	}
   554  
   555  	// type definition or generic type declaration
   556  	if !versionErr && tparam0 != nil && !check.verifyVersionf(tparam0, go1_18, "type parameter") {
   557  		versionErr = true
   558  	}
   559  
   560  	named := check.newNamed(obj, nil, nil)
   561  	setDefType(def, named)
   562  
   563  	if tdecl.TParamList != nil {
   564  		check.openScope(tdecl, "type parameters")
   565  		defer check.closeScope()
   566  		check.collectTypeParams(&named.tparams, tdecl.TParamList)
   567  	}
   568  
   569  	// determine underlying type of named
   570  	rhs = check.definedType(tdecl.Type, obj)
   571  	assert(rhs != nil)
   572  	named.fromRHS = rhs
   573  
   574  	// If the underlying type was not set while type-checking the right-hand
   575  	// side, it is invalid and an error should have been reported elsewhere.
   576  	if named.underlying == nil {
   577  		named.underlying = Typ[Invalid]
   578  	}
   579  
   580  	// Disallow a lone type parameter as the RHS of a type declaration (go.dev/issue/45639).
   581  	// We don't need this restriction anymore if we make the underlying type of a type
   582  	// parameter its constraint interface: if the RHS is a lone type parameter, we will
   583  	// use its underlying type (like we do for any RHS in a type declaration), and its
   584  	// underlying type is an interface and the type declaration is well defined.
   585  	if isTypeParam(rhs) {
   586  		check.error(tdecl.Type, MisplacedTypeParam, "cannot use a type parameter as RHS in type declaration")
   587  		named.underlying = Typ[Invalid]
   588  	}
   589  }
   590  
   591  func (check *Checker) collectTypeParams(dst **TypeParamList, list []*syntax.Field) {
   592  	tparams := make([]*TypeParam, len(list))
   593  
   594  	// Declare type parameters up-front.
   595  	// The scope of type parameters starts at the beginning of the type parameter
   596  	// list (so we can have mutually recursive parameterized type bounds).
   597  	if len(list) > 0 {
   598  		scopePos := list[0].Pos()
   599  		for i, f := range list {
   600  			tparams[i] = check.declareTypeParam(f.Name, scopePos)
   601  		}
   602  	}
   603  
   604  	// Set the type parameters before collecting the type constraints because
   605  	// the parameterized type may be used by the constraints (go.dev/issue/47887).
   606  	// Example: type T[P T[P]] interface{}
   607  	*dst = bindTParams(tparams)
   608  
   609  	// Signal to cycle detection that we are in a type parameter list.
   610  	// We can only be inside one type parameter list at any given time:
   611  	// function closures may appear inside a type parameter list but they
   612  	// cannot be generic, and their bodies are processed in delayed and
   613  	// sequential fashion. Note that with each new declaration, we save
   614  	// the existing environment and restore it when done; thus inTParamList
   615  	// is true exactly only when we are in a specific type parameter list.
   616  	assert(!check.inTParamList)
   617  	check.inTParamList = true
   618  	defer func() {
   619  		check.inTParamList = false
   620  	}()
   621  
   622  	// Keep track of bounds for later validation.
   623  	var bound Type
   624  	for i, f := range list {
   625  		// Optimization: Re-use the previous type bound if it hasn't changed.
   626  		// This also preserves the grouped output of type parameter lists
   627  		// when printing type strings.
   628  		if i == 0 || f.Type != list[i-1].Type {
   629  			bound = check.bound(f.Type)
   630  			if isTypeParam(bound) {
   631  				// We may be able to allow this since it is now well-defined what
   632  				// the underlying type and thus type set of a type parameter is.
   633  				// But we may need some additional form of cycle detection within
   634  				// type parameter lists.
   635  				check.error(f.Type, MisplacedTypeParam, "cannot use a type parameter as constraint")
   636  				bound = Typ[Invalid]
   637  			}
   638  		}
   639  		tparams[i].bound = bound
   640  	}
   641  }
   642  
   643  func (check *Checker) bound(x syntax.Expr) Type {
   644  	// A type set literal of the form ~T and A|B may only appear as constraint;
   645  	// embed it in an implicit interface so that only interface type-checking
   646  	// needs to take care of such type expressions.
   647  	if op, _ := x.(*syntax.Operation); op != nil && (op.Op == syntax.Tilde || op.Op == syntax.Or) {
   648  		t := check.typ(&syntax.InterfaceType{MethodList: []*syntax.Field{{Type: x}}})
   649  		// mark t as implicit interface if all went well
   650  		if t, _ := t.(*Interface); t != nil {
   651  			t.implicit = true
   652  		}
   653  		return t
   654  	}
   655  	return check.typ(x)
   656  }
   657  
   658  func (check *Checker) declareTypeParam(name *syntax.Name, scopePos syntax.Pos) *TypeParam {
   659  	// Use Typ[Invalid] for the type constraint to ensure that a type
   660  	// is present even if the actual constraint has not been assigned
   661  	// yet.
   662  	// TODO(gri) Need to systematically review all uses of type parameter
   663  	//           constraints to make sure we don't rely on them if they
   664  	//           are not properly set yet.
   665  	tname := NewTypeName(name.Pos(), check.pkg, name.Value, nil)
   666  	tpar := check.newTypeParam(tname, Typ[Invalid]) // assigns type to tname as a side-effect
   667  	check.declare(check.scope, name, tname, scopePos)
   668  	return tpar
   669  }
   670  
   671  func (check *Checker) collectMethods(obj *TypeName) {
   672  	// get associated methods
   673  	// (Checker.collectObjects only collects methods with non-blank names;
   674  	// Checker.resolveBaseTypeName ensures that obj is not an alias name
   675  	// if it has attached methods.)
   676  	methods := check.methods[obj]
   677  	if methods == nil {
   678  		return
   679  	}
   680  	delete(check.methods, obj)
   681  	assert(!check.objMap[obj].tdecl.Alias) // don't use TypeName.IsAlias (requires fully set up object)
   682  
   683  	// use an objset to check for name conflicts
   684  	var mset objset
   685  
   686  	// spec: "If the base type is a struct type, the non-blank method
   687  	// and field names must be distinct."
   688  	base := asNamed(obj.typ) // shouldn't fail but be conservative
   689  	if base != nil {
   690  		assert(base.TypeArgs().Len() == 0) // collectMethods should not be called on an instantiated type
   691  
   692  		// See go.dev/issue/52529: we must delay the expansion of underlying here, as
   693  		// base may not be fully set-up.
   694  		check.later(func() {
   695  			check.checkFieldUniqueness(base)
   696  		}).describef(obj, "verifying field uniqueness for %v", base)
   697  
   698  		// Checker.Files may be called multiple times; additional package files
   699  		// may add methods to already type-checked types. Add pre-existing methods
   700  		// so that we can detect redeclarations.
   701  		for i := 0; i < base.NumMethods(); i++ {
   702  			m := base.Method(i)
   703  			assert(m.name != "_")
   704  			assert(mset.insert(m) == nil)
   705  		}
   706  	}
   707  
   708  	// add valid methods
   709  	for _, m := range methods {
   710  		// spec: "For a base type, the non-blank names of methods bound
   711  		// to it must be unique."
   712  		assert(m.name != "_")
   713  		if alt := mset.insert(m); alt != nil {
   714  			if alt.Pos().IsKnown() {
   715  				check.errorf(m.pos, DuplicateMethod, "method %s.%s already declared at %v", obj.Name(), m.name, alt.Pos())
   716  			} else {
   717  				check.errorf(m.pos, DuplicateMethod, "method %s.%s already declared", obj.Name(), m.name)
   718  			}
   719  			continue
   720  		}
   721  
   722  		if base != nil {
   723  			base.AddMethod(m)
   724  		}
   725  	}
   726  }
   727  
   728  func (check *Checker) checkFieldUniqueness(base *Named) {
   729  	if t, _ := base.under().(*Struct); t != nil {
   730  		var mset objset
   731  		for i := 0; i < base.NumMethods(); i++ {
   732  			m := base.Method(i)
   733  			assert(m.name != "_")
   734  			assert(mset.insert(m) == nil)
   735  		}
   736  
   737  		// Check that any non-blank field names of base are distinct from its
   738  		// method names.
   739  		for _, fld := range t.fields {
   740  			if fld.name != "_" {
   741  				if alt := mset.insert(fld); alt != nil {
   742  					// Struct fields should already be unique, so we should only
   743  					// encounter an alternate via collision with a method name.
   744  					_ = alt.(*Func)
   745  
   746  					// For historical consistency, we report the primary error on the
   747  					// method, and the alt decl on the field.
   748  					err := check.newError(DuplicateFieldAndMethod)
   749  					err.addf(alt, "field and method with the same name %s", fld.name)
   750  					err.addAltDecl(fld)
   751  					err.report()
   752  				}
   753  			}
   754  		}
   755  	}
   756  }
   757  
   758  func (check *Checker) funcDecl(obj *Func, decl *declInfo) {
   759  	assert(obj.typ == nil)
   760  
   761  	// func declarations cannot use iota
   762  	assert(check.iota == nil)
   763  
   764  	sig := new(Signature)
   765  	obj.typ = sig // guard against cycles
   766  
   767  	// Avoid cycle error when referring to method while type-checking the signature.
   768  	// This avoids a nuisance in the best case (non-parameterized receiver type) and
   769  	// since the method is not a type, we get an error. If we have a parameterized
   770  	// receiver type, instantiating the receiver type leads to the instantiation of
   771  	// its methods, and we don't want a cycle error in that case.
   772  	// TODO(gri) review if this is correct and/or whether we still need this?
   773  	saved := obj.color_
   774  	obj.color_ = black
   775  	fdecl := decl.fdecl
   776  	check.funcType(sig, fdecl.Recv, fdecl.TParamList, fdecl.Type)
   777  	obj.color_ = saved
   778  
   779  	// Set the scope's extent to the complete "func (...) { ... }"
   780  	// so that Scope.Innermost works correctly.
   781  	sig.scope.pos = fdecl.Pos()
   782  	sig.scope.end = syntax.EndPos(fdecl)
   783  
   784  	if len(fdecl.TParamList) > 0 && fdecl.Body == nil {
   785  		check.softErrorf(fdecl, BadDecl, "generic function is missing function body")
   786  	}
   787  
   788  	// function body must be type-checked after global declarations
   789  	// (functions implemented elsewhere have no body)
   790  	if !check.conf.IgnoreFuncBodies && fdecl.Body != nil {
   791  		check.later(func() {
   792  			check.funcBody(decl, obj.name, sig, fdecl.Body, nil)
   793  		}).describef(obj, "func %s", obj.name)
   794  	}
   795  }
   796  
   797  func (check *Checker) declStmt(list []syntax.Decl) {
   798  	pkg := check.pkg
   799  
   800  	first := -1                // index of first ConstDecl in the current group, or -1
   801  	var last *syntax.ConstDecl // last ConstDecl with init expressions, or nil
   802  	for index, decl := range list {
   803  		if _, ok := decl.(*syntax.ConstDecl); !ok {
   804  			first = -1 // we're not in a constant declaration
   805  		}
   806  
   807  		switch s := decl.(type) {
   808  		case *syntax.ConstDecl:
   809  			top := len(check.delayed)
   810  
   811  			// iota is the index of the current constDecl within the group
   812  			if first < 0 || s.Group == nil || list[index-1].(*syntax.ConstDecl).Group != s.Group {
   813  				first = index
   814  				last = nil
   815  			}
   816  			iota := constant.MakeInt64(int64(index - first))
   817  
   818  			// determine which initialization expressions to use
   819  			inherited := true
   820  			switch {
   821  			case s.Type != nil || s.Values != nil:
   822  				last = s
   823  				inherited = false
   824  			case last == nil:
   825  				last = new(syntax.ConstDecl) // make sure last exists
   826  				inherited = false
   827  			}
   828  
   829  			// declare all constants
   830  			lhs := make([]*Const, len(s.NameList))
   831  			values := syntax.UnpackListExpr(last.Values)
   832  			for i, name := range s.NameList {
   833  				obj := NewConst(name.Pos(), pkg, name.Value, nil, iota)
   834  				lhs[i] = obj
   835  
   836  				var init syntax.Expr
   837  				if i < len(values) {
   838  					init = values[i]
   839  				}
   840  
   841  				check.constDecl(obj, last.Type, init, inherited)
   842  			}
   843  
   844  			// Constants must always have init values.
   845  			check.arity(s.Pos(), s.NameList, values, true, inherited)
   846  
   847  			// process function literals in init expressions before scope changes
   848  			check.processDelayed(top)
   849  
   850  			// spec: "The scope of a constant or variable identifier declared
   851  			// inside a function begins at the end of the ConstSpec or VarSpec
   852  			// (ShortVarDecl for short variable declarations) and ends at the
   853  			// end of the innermost containing block."
   854  			scopePos := syntax.EndPos(s)
   855  			for i, name := range s.NameList {
   856  				check.declare(check.scope, name, lhs[i], scopePos)
   857  			}
   858  
   859  		case *syntax.VarDecl:
   860  			top := len(check.delayed)
   861  
   862  			lhs0 := make([]*Var, len(s.NameList))
   863  			for i, name := range s.NameList {
   864  				lhs0[i] = newVar(LocalVar, name.Pos(), pkg, name.Value, nil)
   865  			}
   866  
   867  			// initialize all variables
   868  			values := syntax.UnpackListExpr(s.Values)
   869  			for i, obj := range lhs0 {
   870  				var lhs []*Var
   871  				var init syntax.Expr
   872  				switch len(values) {
   873  				case len(s.NameList):
   874  					// lhs and rhs match
   875  					init = values[i]
   876  				case 1:
   877  					// rhs is expected to be a multi-valued expression
   878  					lhs = lhs0
   879  					init = values[0]
   880  				default:
   881  					if i < len(values) {
   882  						init = values[i]
   883  					}
   884  				}
   885  				check.varDecl(obj, lhs, s.Type, init)
   886  				if len(values) == 1 {
   887  					// If we have a single lhs variable we are done either way.
   888  					// If we have a single rhs expression, it must be a multi-
   889  					// valued expression, in which case handling the first lhs
   890  					// variable will cause all lhs variables to have a type
   891  					// assigned, and we are done as well.
   892  					if debug {
   893  						for _, obj := range lhs0 {
   894  							assert(obj.typ != nil)
   895  						}
   896  					}
   897  					break
   898  				}
   899  			}
   900  
   901  			// If we have no type, we must have values.
   902  			if s.Type == nil || values != nil {
   903  				check.arity(s.Pos(), s.NameList, values, false, false)
   904  			}
   905  
   906  			// process function literals in init expressions before scope changes
   907  			check.processDelayed(top)
   908  
   909  			// declare all variables
   910  			// (only at this point are the variable scopes (parents) set)
   911  			scopePos := syntax.EndPos(s) // see constant declarations
   912  			for i, name := range s.NameList {
   913  				// see constant declarations
   914  				check.declare(check.scope, name, lhs0[i], scopePos)
   915  			}
   916  
   917  		case *syntax.TypeDecl:
   918  			obj := NewTypeName(s.Name.Pos(), pkg, s.Name.Value, nil)
   919  			// spec: "The scope of a type identifier declared inside a function
   920  			// begins at the identifier in the TypeSpec and ends at the end of
   921  			// the innermost containing block."
   922  			scopePos := s.Name.Pos()
   923  			check.declare(check.scope, s.Name, obj, scopePos)
   924  			// mark and unmark type before calling typeDecl; its type is still nil (see Checker.objDecl)
   925  			obj.setColor(grey + color(check.push(obj)))
   926  			check.typeDecl(obj, s, nil)
   927  			check.pop().setColor(black)
   928  
   929  		default:
   930  			check.errorf(s, InvalidSyntaxTree, "unknown syntax.Decl node %T", s)
   931  		}
   932  	}
   933  }
   934
View as plain text