resolver.go

Documentation: cmd/compile/internal/types2

     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  package types2
     6  
     7  import (
     8  	"cmd/compile/internal/syntax"
     9  	"fmt"
    10  	"go/constant"
    11  	. "internal/types/errors"
    12  	"sort"
    13  	"strconv"
    14  	"strings"
    15  	"unicode"
    16  )
    17  
    18  // A declInfo describes a package-level const, type, var, or func declaration.
    19  type declInfo struct {
    20  	file      *Scope           // scope of file containing this declaration
    21  	lhs       []*Var           // lhs of n:1 variable declarations, or nil
    22  	vtyp      syntax.Expr      // type, or nil (for const and var declarations only)
    23  	init      syntax.Expr      // init/orig expression, or nil (for const and var declarations only)
    24  	inherited bool             // if set, the init expression is inherited from a previous constant declaration
    25  	tdecl     *syntax.TypeDecl // type declaration, or nil
    26  	fdecl     *syntax.FuncDecl // func declaration, or nil
    27  
    28  	// The deps field tracks initialization expression dependencies.
    29  	deps map[Object]bool // lazily initialized
    30  }
    31  
    32  // hasInitializer reports whether the declared object has an initialization
    33  // expression or function body.
    34  func (d *declInfo) hasInitializer() bool {
    35  	return d.init != nil || d.fdecl != nil && d.fdecl.Body != nil
    36  }
    37  
    38  // addDep adds obj to the set of objects d's init expression depends on.
    39  func (d *declInfo) addDep(obj Object) {
    40  	m := d.deps
    41  	if m == nil {
    42  		m = make(map[Object]bool)
    43  		d.deps = m
    44  	}
    45  	m[obj] = true
    46  }
    47  
    48  // arity checks that the lhs and rhs of a const or var decl
    49  // have a matching number of names and initialization values.
    50  // If inherited is set, the initialization values are from
    51  // another (constant) declaration.
    52  func (check *Checker) arity(pos syntax.Pos, names []*syntax.Name, inits []syntax.Expr, constDecl, inherited bool) {
    53  	l := len(names)
    54  	r := len(inits)
    55  
    56  	const code = WrongAssignCount
    57  	switch {
    58  	case l < r:
    59  		n := inits[l]
    60  		if inherited {
    61  			check.errorf(pos, code, "extra init expr at %s", n.Pos())
    62  		} else {
    63  			check.errorf(n, code, "extra init expr %s", n)
    64  		}
    65  	case l > r && (constDecl || r != 1): // if r == 1 it may be a multi-valued function and we can't say anything yet
    66  		n := names[r]
    67  		check.errorf(n, code, "missing init expr for %s", n.Value)
    68  	}
    69  }
    70  
    71  func validatedImportPath(path string) (string, error) {
    72  	s, err := strconv.Unquote(path)
    73  	if err != nil {
    74  		return "", err
    75  	}
    76  	if s == "" {
    77  		return "", fmt.Errorf("empty string")
    78  	}
    79  	const illegalChars = `!"#$%&'()*,:;<=>?[\]^{|}` + "`\uFFFD"
    80  	for _, r := range s {
    81  		if !unicode.IsGraphic(r) || unicode.IsSpace(r) || strings.ContainsRune(illegalChars, r) {
    82  			return s, fmt.Errorf("invalid character %#U", r)
    83  		}
    84  	}
    85  	return s, nil
    86  }
    87  
    88  // declarePkgObj declares obj in the package scope, records its ident -> obj mapping,
    89  // and updates check.objMap. The object must not be a function or method.
    90  func (check *Checker) declarePkgObj(ident *syntax.Name, obj Object, d *declInfo) {
    91  	assert(ident.Value == obj.Name())
    92  
    93  	// spec: "A package-scope or file-scope identifier with name init
    94  	// may only be declared to be a function with this (func()) signature."
    95  	if ident.Value == "init" {
    96  		check.error(ident, InvalidInitDecl, "cannot declare init - must be func")
    97  		return
    98  	}
    99  
   100  	// spec: "The main package must have package name main and declare
   101  	// a function main that takes no arguments and returns no value."
   102  	if ident.Value == "main" && check.pkg.name == "main" {
   103  		check.error(ident, InvalidMainDecl, "cannot declare main - must be func")
   104  		return
   105  	}
   106  
   107  	check.declare(check.pkg.scope, ident, obj, nopos)
   108  	check.objMap[obj] = d
   109  	obj.setOrder(uint32(len(check.objMap)))
   110  }
   111  
   112  // filename returns a filename suitable for debugging output.
   113  func (check *Checker) filename(fileNo int) string {
   114  	file := check.files[fileNo]
   115  	if pos := file.Pos(); pos.IsKnown() {
   116  		// return check.fset.File(pos).Name()
   117  		// TODO(gri) do we need the actual file name here?
   118  		return pos.RelFilename()
   119  	}
   120  	return fmt.Sprintf("file[%d]", fileNo)
   121  }
   122  
   123  func (check *Checker) importPackage(pos syntax.Pos, path, dir string) *Package {
   124  	// If we already have a package for the given (path, dir)
   125  	// pair, use it instead of doing a full import.
   126  	// Checker.impMap only caches packages that are marked Complete
   127  	// or fake (dummy packages for failed imports). Incomplete but
   128  	// non-fake packages do require an import to complete them.
   129  	key := importKey{path, dir}
   130  	imp := check.impMap[key]
   131  	if imp != nil {
   132  		return imp
   133  	}
   134  
   135  	// no package yet => import it
   136  	if path == "C" && (check.conf.FakeImportC || check.conf.go115UsesCgo) {
   137  		imp = NewPackage("C", "C")
   138  		imp.fake = true // package scope is not populated
   139  		imp.cgo = check.conf.go115UsesCgo
   140  	} else {
   141  		// ordinary import
   142  		var err error
   143  		if importer := check.conf.Importer; importer == nil {
   144  			err = fmt.Errorf("Config.Importer not installed")
   145  		} else if importerFrom, ok := importer.(ImporterFrom); ok {
   146  			imp, err = importerFrom.ImportFrom(path, dir, 0)
   147  			if imp == nil && err == nil {
   148  				err = fmt.Errorf("Config.Importer.ImportFrom(%s, %s, 0) returned nil but no error", path, dir)
   149  			}
   150  		} else {
   151  			imp, err = importer.Import(path)
   152  			if imp == nil && err == nil {
   153  				err = fmt.Errorf("Config.Importer.Import(%s) returned nil but no error", path)
   154  			}
   155  		}
   156  		// make sure we have a valid package name
   157  		// (errors here can only happen through manipulation of packages after creation)
   158  		if err == nil && imp != nil && (imp.name == "_" || imp.name == "") {
   159  			err = fmt.Errorf("invalid package name: %q", imp.name)
   160  			imp = nil // create fake package below
   161  		}
   162  		if err != nil {
   163  			check.errorf(pos, BrokenImport, "could not import %s (%s)", path, err)
   164  			if imp == nil {
   165  				// create a new fake package
   166  				// come up with a sensible package name (heuristic)
   167  				name := path
   168  				if i := len(name); i > 0 && name[i-1] == '/' {
   169  					name = name[:i-1]
   170  				}
   171  				if i := strings.LastIndex(name, "/"); i >= 0 {
   172  					name = name[i+1:]
   173  				}
   174  				imp = NewPackage(path, name)
   175  			}
   176  			// continue to use the package as best as we can
   177  			imp.fake = true // avoid follow-up lookup failures
   178  		}
   179  	}
   180  
   181  	// package should be complete or marked fake, but be cautious
   182  	if imp.complete || imp.fake {
   183  		check.impMap[key] = imp
   184  		// Once we've formatted an error message, keep the pkgPathMap
   185  		// up-to-date on subsequent imports. It is used for package
   186  		// qualification in error messages.
   187  		if check.pkgPathMap != nil {
   188  			check.markImports(imp)
   189  		}
   190  		return imp
   191  	}
   192  
   193  	// something went wrong (importer may have returned incomplete package without error)
   194  	return nil
   195  }
   196  
   197  // collectObjects collects all file and package objects and inserts them
   198  // into their respective scopes. It also performs imports and associates
   199  // methods with receiver base type names.
   200  func (check *Checker) collectObjects() {
   201  	pkg := check.pkg
   202  
   203  	// pkgImports is the set of packages already imported by any package file seen
   204  	// so far. Used to avoid duplicate entries in pkg.imports. Allocate and populate
   205  	// it (pkg.imports may not be empty if we are checking test files incrementally).
   206  	// Note that pkgImports is keyed by package (and thus package path), not by an
   207  	// importKey value. Two different importKey values may map to the same package
   208  	// which is why we cannot use the check.impMap here.
   209  	var pkgImports = make(map[*Package]bool)
   210  	for _, imp := range pkg.imports {
   211  		pkgImports[imp] = true
   212  	}
   213  
   214  	type methodInfo struct {
   215  		obj  *Func        // method
   216  		ptr  bool         // true if pointer receiver
   217  		recv *syntax.Name // receiver type name
   218  	}
   219  	var methods []methodInfo // collected methods with valid receivers and non-blank _ names
   220  	var fileScopes []*Scope
   221  	for fileNo, file := range check.files {
   222  		// The package identifier denotes the current package,
   223  		// but there is no corresponding package object.
   224  		check.recordDef(file.PkgName, nil)
   225  
   226  		fileScope := NewScope(pkg.scope, syntax.StartPos(file), syntax.EndPos(file), check.filename(fileNo))
   227  		fileScopes = append(fileScopes, fileScope)
   228  		check.recordScope(file, fileScope)
   229  
   230  		// determine file directory, necessary to resolve imports
   231  		// FileName may be "" (typically for tests) in which case
   232  		// we get "." as the directory which is what we would want.
   233  		fileDir := dir(file.PkgName.Pos().RelFilename()) // TODO(gri) should this be filename?
   234  
   235  		first := -1                // index of first ConstDecl in the current group, or -1
   236  		var last *syntax.ConstDecl // last ConstDecl with init expressions, or nil
   237  		for index, decl := range file.DeclList {
   238  			if _, ok := decl.(*syntax.ConstDecl); !ok {
   239  				first = -1 // we're not in a constant declaration
   240  			}
   241  
   242  			switch s := decl.(type) {
   243  			case *syntax.ImportDecl:
   244  				// import package
   245  				if s.Path == nil || s.Path.Bad {
   246  					continue // error reported during parsing
   247  				}
   248  				path, err := validatedImportPath(s.Path.Value)
   249  				if err != nil {
   250  					check.errorf(s.Path, BadImportPath, "invalid import path (%s)", err)
   251  					continue
   252  				}
   253  
   254  				imp := check.importPackage(s.Path.Pos(), path, fileDir)
   255  				if imp == nil {
   256  					continue
   257  				}
   258  
   259  				// local name overrides imported package name
   260  				name := imp.name
   261  				if s.LocalPkgName != nil {
   262  					name = s.LocalPkgName.Value
   263  					if path == "C" {
   264  						// match 1.17 cmd/compile (not prescribed by spec)
   265  						check.error(s.LocalPkgName, ImportCRenamed, `cannot rename import "C"`)
   266  						continue
   267  					}
   268  				}
   269  
   270  				if name == "init" {
   271  					check.error(s, InvalidInitDecl, "cannot import package as init - init must be a func")
   272  					continue
   273  				}
   274  
   275  				// add package to list of explicit imports
   276  				// (this functionality is provided as a convenience
   277  				// for clients; it is not needed for type-checking)
   278  				if !pkgImports[imp] {
   279  					pkgImports[imp] = true
   280  					pkg.imports = append(pkg.imports, imp)
   281  				}
   282  
   283  				pkgName := NewPkgName(s.Pos(), pkg, name, imp)
   284  				if s.LocalPkgName != nil {
   285  					// in a dot-import, the dot represents the package
   286  					check.recordDef(s.LocalPkgName, pkgName)
   287  				} else {
   288  					check.recordImplicit(s, pkgName)
   289  				}
   290  
   291  				if imp.fake {
   292  					// match 1.17 cmd/compile (not prescribed by spec)
   293  					pkgName.used = true
   294  				}
   295  
   296  				// add import to file scope
   297  				check.imports = append(check.imports, pkgName)
   298  				if name == "." {
   299  					// dot-import
   300  					if check.dotImportMap == nil {
   301  						check.dotImportMap = make(map[dotImportKey]*PkgName)
   302  					}
   303  					// merge imported scope with file scope
   304  					for name, obj := range imp.scope.elems {
   305  						// Note: Avoid eager resolve(name, obj) here, so we only
   306  						// resolve dot-imported objects as needed.
   307  
   308  						// A package scope may contain non-exported objects,
   309  						// do not import them!
   310  						if isExported(name) {
   311  							// declare dot-imported object
   312  							// (Do not use check.declare because it modifies the object
   313  							// via Object.setScopePos, which leads to a race condition;
   314  							// the object may be imported into more than one file scope
   315  							// concurrently. See go.dev/issue/32154.)
   316  							if alt := fileScope.Lookup(name); alt != nil {
   317  								var err error_
   318  								err.code = DuplicateDecl
   319  								err.errorf(s.LocalPkgName, "%s redeclared in this block", alt.Name())
   320  								err.recordAltDecl(alt)
   321  								check.report(&err)
   322  							} else {
   323  								fileScope.insert(name, obj)
   324  								check.dotImportMap[dotImportKey{fileScope, name}] = pkgName
   325  							}
   326  						}
   327  					}
   328  				} else {
   329  					// declare imported package object in file scope
   330  					// (no need to provide s.LocalPkgName since we called check.recordDef earlier)
   331  					check.declare(fileScope, nil, pkgName, nopos)
   332  				}
   333  
   334  			case *syntax.ConstDecl:
   335  				// iota is the index of the current constDecl within the group
   336  				if first < 0 || s.Group == nil || file.DeclList[index-1].(*syntax.ConstDecl).Group != s.Group {
   337  					first = index
   338  					last = nil
   339  				}
   340  				iota := constant.MakeInt64(int64(index - first))
   341  
   342  				// determine which initialization expressions to use
   343  				inherited := true
   344  				switch {
   345  				case s.Type != nil || s.Values != nil:
   346  					last = s
   347  					inherited = false
   348  				case last == nil:
   349  					last = new(syntax.ConstDecl) // make sure last exists
   350  					inherited = false
   351  				}
   352  
   353  				// declare all constants
   354  				values := syntax.UnpackListExpr(last.Values)
   355  				for i, name := range s.NameList {
   356  					obj := NewConst(name.Pos(), pkg, name.Value, nil, iota)
   357  
   358  					var init syntax.Expr
   359  					if i < len(values) {
   360  						init = values[i]
   361  					}
   362  
   363  					d := &declInfo{file: fileScope, vtyp: last.Type, init: init, inherited: inherited}
   364  					check.declarePkgObj(name, obj, d)
   365  				}
   366  
   367  				// Constants must always have init values.
   368  				check.arity(s.Pos(), s.NameList, values, true, inherited)
   369  
   370  			case *syntax.VarDecl:
   371  				lhs := make([]*Var, len(s.NameList))
   372  				// If there's exactly one rhs initializer, use
   373  				// the same declInfo d1 for all lhs variables
   374  				// so that each lhs variable depends on the same
   375  				// rhs initializer (n:1 var declaration).
   376  				var d1 *declInfo
   377  				if _, ok := s.Values.(*syntax.ListExpr); !ok {
   378  					// The lhs elements are only set up after the for loop below,
   379  					// but that's ok because declarePkgObj only collects the declInfo
   380  					// for a later phase.
   381  					d1 = &declInfo{file: fileScope, lhs: lhs, vtyp: s.Type, init: s.Values}
   382  				}
   383  
   384  				// declare all variables
   385  				values := syntax.UnpackListExpr(s.Values)
   386  				for i, name := range s.NameList {
   387  					obj := NewVar(name.Pos(), pkg, name.Value, nil)
   388  					lhs[i] = obj
   389  
   390  					d := d1
   391  					if d == nil {
   392  						// individual assignments
   393  						var init syntax.Expr
   394  						if i < len(values) {
   395  							init = values[i]
   396  						}
   397  						d = &declInfo{file: fileScope, vtyp: s.Type, init: init}
   398  					}
   399  
   400  					check.declarePkgObj(name, obj, d)
   401  				}
   402  
   403  				// If we have no type, we must have values.
   404  				if s.Type == nil || values != nil {
   405  					check.arity(s.Pos(), s.NameList, values, false, false)
   406  				}
   407  
   408  			case *syntax.TypeDecl:
   409  				_ = len(s.TParamList) != 0 && check.verifyVersionf(s.TParamList[0], go1_18, "type parameter")
   410  				obj := NewTypeName(s.Name.Pos(), pkg, s.Name.Value, nil)
   411  				check.declarePkgObj(s.Name, obj, &declInfo{file: fileScope, tdecl: s})
   412  
   413  			case *syntax.FuncDecl:
   414  				name := s.Name.Value
   415  				obj := NewFunc(s.Name.Pos(), pkg, name, nil)
   416  				hasTParamError := false // avoid duplicate type parameter errors
   417  				if s.Recv == nil {
   418  					// regular function
   419  					if name == "init" || name == "main" && pkg.name == "main" {
   420  						code := InvalidInitDecl
   421  						if name == "main" {
   422  							code = InvalidMainDecl
   423  						}
   424  						if len(s.TParamList) != 0 {
   425  							check.softErrorf(s.TParamList[0], code, "func %s must have no type parameters", name)
   426  							hasTParamError = true
   427  						}
   428  						if t := s.Type; len(t.ParamList) != 0 || len(t.ResultList) != 0 {
   429  							check.softErrorf(s.Name, code, "func %s must have no arguments and no return values", name)
   430  						}
   431  					}
   432  					// don't declare init functions in the package scope - they are invisible
   433  					if name == "init" {
   434  						obj.parent = pkg.scope
   435  						check.recordDef(s.Name, obj)
   436  						// init functions must have a body
   437  						if s.Body == nil {
   438  							// TODO(gri) make this error message consistent with the others above
   439  							check.softErrorf(obj.pos, MissingInitBody, "missing function body")
   440  						}
   441  					} else {
   442  						check.declare(pkg.scope, s.Name, obj, nopos)
   443  					}
   444  				} else {
   445  					// method
   446  					// d.Recv != nil
   447  					ptr, recv, _ := check.unpackRecv(s.Recv.Type, false)
   448  					// Methods with invalid receiver cannot be associated to a type, and
   449  					// methods with blank _ names are never found; no need to collect any
   450  					// of them. They will still be type-checked with all the other functions.
   451  					if recv != nil && name != "_" {
   452  						methods = append(methods, methodInfo{obj, ptr, recv})
   453  					}
   454  					check.recordDef(s.Name, obj)
   455  				}
   456  				_ = len(s.TParamList) != 0 && !hasTParamError && check.verifyVersionf(s.TParamList[0], go1_18, "type parameter")
   457  				info := &declInfo{file: fileScope, fdecl: s}
   458  				// Methods are not package-level objects but we still track them in the
   459  				// object map so that we can handle them like regular functions (if the
   460  				// receiver is invalid); also we need their fdecl info when associating
   461  				// them with their receiver base type, below.
   462  				check.objMap[obj] = info
   463  				obj.setOrder(uint32(len(check.objMap)))
   464  
   465  			default:
   466  				check.errorf(s, InvalidSyntaxTree, "unknown syntax.Decl node %T", s)
   467  			}
   468  		}
   469  	}
   470  
   471  	// verify that objects in package and file scopes have different names
   472  	for _, scope := range fileScopes {
   473  		for name, obj := range scope.elems {
   474  			if alt := pkg.scope.Lookup(name); alt != nil {
   475  				obj = resolve(name, obj)
   476  				var err error_
   477  				err.code = DuplicateDecl
   478  				if pkg, ok := obj.(*PkgName); ok {
   479  					err.errorf(alt, "%s already declared through import of %s", alt.Name(), pkg.Imported())
   480  					err.recordAltDecl(pkg)
   481  				} else {
   482  					err.errorf(alt, "%s already declared through dot-import of %s", alt.Name(), obj.Pkg())
   483  					// TODO(gri) dot-imported objects don't have a position; recordAltDecl won't print anything
   484  					err.recordAltDecl(obj)
   485  				}
   486  				check.report(&err)
   487  			}
   488  		}
   489  	}
   490  
   491  	// Now that we have all package scope objects and all methods,
   492  	// associate methods with receiver base type name where possible.
   493  	// Ignore methods that have an invalid receiver. They will be
   494  	// type-checked later, with regular functions.
   495  	if methods != nil {
   496  		check.methods = make(map[*TypeName][]*Func)
   497  		for i := range methods {
   498  			m := &methods[i]
   499  			// Determine the receiver base type and associate m with it.
   500  			ptr, base := check.resolveBaseTypeName(m.ptr, m.recv, fileScopes)
   501  			if base != nil {
   502  				m.obj.hasPtrRecv_ = ptr
   503  				check.methods[base] = append(check.methods[base], m.obj)
   504  			}
   505  		}
   506  	}
   507  }
   508  
   509  // unpackRecv unpacks a receiver type and returns its components: ptr indicates whether
   510  // rtyp is a pointer receiver, rname is the receiver type name, and tparams are its
   511  // type parameters, if any. The type parameters are only unpacked if unpackParams is
   512  // set. If rname is nil, the receiver is unusable (i.e., the source has a bug which we
   513  // cannot easily work around).
   514  func (check *Checker) unpackRecv(rtyp syntax.Expr, unpackParams bool) (ptr bool, rname *syntax.Name, tparams []*syntax.Name) {
   515  L: // unpack receiver type
   516  	// This accepts invalid receivers such as ***T and does not
   517  	// work for other invalid receivers, but we don't care. The
   518  	// validity of receiver expressions is checked elsewhere.
   519  	for {
   520  		switch t := rtyp.(type) {
   521  		case *syntax.ParenExpr:
   522  			rtyp = t.X
   523  		// case *ast.StarExpr:
   524  		//      ptr = true
   525  		// 	rtyp = t.X
   526  		case *syntax.Operation:
   527  			if t.Op != syntax.Mul || t.Y != nil {
   528  				break
   529  			}
   530  			ptr = true
   531  			rtyp = t.X
   532  		default:
   533  			break L
   534  		}
   535  	}
   536  
   537  	// unpack type parameters, if any
   538  	if ptyp, _ := rtyp.(*syntax.IndexExpr); ptyp != nil {
   539  		rtyp = ptyp.X
   540  		if unpackParams {
   541  			for _, arg := range syntax.UnpackListExpr(ptyp.Index) {
   542  				var par *syntax.Name
   543  				switch arg := arg.(type) {
   544  				case *syntax.Name:
   545  					par = arg
   546  				case *syntax.BadExpr:
   547  					// ignore - error already reported by parser
   548  				case nil:
   549  					check.error(ptyp, InvalidSyntaxTree, "parameterized receiver contains nil parameters")
   550  				default:
   551  					check.errorf(arg, BadDecl, "receiver type parameter %s must be an identifier", arg)
   552  				}
   553  				if par == nil {
   554  					par = syntax.NewName(arg.Pos(), "_")
   555  				}
   556  				tparams = append(tparams, par)
   557  			}
   558  
   559  		}
   560  	}
   561  
   562  	// unpack receiver name
   563  	if name, _ := rtyp.(*syntax.Name); name != nil {
   564  		rname = name
   565  	}
   566  
   567  	return
   568  }
   569  
   570  // resolveBaseTypeName returns the non-alias base type name for typ, and whether
   571  // there was a pointer indirection to get to it. The base type name must be declared
   572  // in package scope, and there can be at most one pointer indirection. If no such type
   573  // name exists, the returned base is nil.
   574  func (check *Checker) resolveBaseTypeName(seenPtr bool, typ syntax.Expr, fileScopes []*Scope) (ptr bool, base *TypeName) {
   575  	// Algorithm: Starting from a type expression, which may be a name,
   576  	// we follow that type through alias declarations until we reach a
   577  	// non-alias type name. If we encounter anything but pointer types or
   578  	// parentheses we're done. If we encounter more than one pointer type
   579  	// we're done.
   580  	ptr = seenPtr
   581  	var seen map[*TypeName]bool
   582  	for {
   583  		// check if we have a pointer type
   584  		// if pexpr, _ := typ.(*ast.StarExpr); pexpr != nil {
   585  		if pexpr, _ := typ.(*syntax.Operation); pexpr != nil && pexpr.Op == syntax.Mul && pexpr.Y == nil {
   586  			// if we've already seen a pointer, we're done
   587  			if ptr {
   588  				return false, nil
   589  			}
   590  			ptr = true
   591  			typ = syntax.Unparen(pexpr.X) // continue with pointer base type
   592  		}
   593  
   594  		// typ must be a name, or a C.name cgo selector.
   595  		var name string
   596  		switch typ := typ.(type) {
   597  		case *syntax.Name:
   598  			name = typ.Value
   599  		case *syntax.SelectorExpr:
   600  			// C.struct_foo is a valid type name for packages using cgo.
   601  			//
   602  			// Detect this case, and adjust name so that the correct TypeName is
   603  			// resolved below.
   604  			if ident, _ := typ.X.(*syntax.Name); ident != nil && ident.Value == "C" {
   605  				// Check whether "C" actually resolves to an import of "C", by looking
   606  				// in the appropriate file scope.
   607  				var obj Object
   608  				for _, scope := range fileScopes {
   609  					if scope.Contains(ident.Pos()) {
   610  						obj = scope.Lookup(ident.Value)
   611  					}
   612  				}
   613  				// If Config.go115UsesCgo is set, the typechecker will resolve Cgo
   614  				// selectors to their cgo name. We must do the same here.
   615  				if pname, _ := obj.(*PkgName); pname != nil {
   616  					if pname.imported.cgo { // only set if Config.go115UsesCgo is set
   617  						name = "_Ctype_" + typ.Sel.Value
   618  					}
   619  				}
   620  			}
   621  			if name == "" {
   622  				return false, nil
   623  			}
   624  		default:
   625  			return false, nil
   626  		}
   627  
   628  		// name must denote an object found in the current package scope
   629  		// (note that dot-imported objects are not in the package scope!)
   630  		obj := check.pkg.scope.Lookup(name)
   631  		if obj == nil {
   632  			return false, nil
   633  		}
   634  
   635  		// the object must be a type name...
   636  		tname, _ := obj.(*TypeName)
   637  		if tname == nil {
   638  			return false, nil
   639  		}
   640  
   641  		// ... which we have not seen before
   642  		if seen[tname] {
   643  			return false, nil
   644  		}
   645  
   646  		// we're done if tdecl defined tname as a new type
   647  		// (rather than an alias)
   648  		tdecl := check.objMap[tname].tdecl // must exist for objects in package scope
   649  		if !tdecl.Alias {
   650  			return ptr, tname
   651  		}
   652  
   653  		// otherwise, continue resolving
   654  		typ = tdecl.Type
   655  		if seen == nil {
   656  			seen = make(map[*TypeName]bool)
   657  		}
   658  		seen[tname] = true
   659  	}
   660  }
   661  
   662  // packageObjects typechecks all package objects, but not function bodies.
   663  func (check *Checker) packageObjects() {
   664  	// process package objects in source order for reproducible results
   665  	objList := make([]Object, len(check.objMap))
   666  	i := 0
   667  	for obj := range check.objMap {
   668  		objList[i] = obj
   669  		i++
   670  	}
   671  	sort.Sort(inSourceOrder(objList))
   672  
   673  	// add new methods to already type-checked types (from a prior Checker.Files call)
   674  	for _, obj := range objList {
   675  		if obj, _ := obj.(*TypeName); obj != nil && obj.typ != nil {
   676  			check.collectMethods(obj)
   677  		}
   678  	}
   679  
   680  	if check.enableAlias {
   681  		// With Alias nodes we can process declarations in any order.
   682  		for _, obj := range objList {
   683  			check.objDecl(obj, nil)
   684  		}
   685  	} else {
   686  		// Without Alias nodes, we process non-alias type declarations first, followed by
   687  		// alias declarations, and then everything else. This appears to avoid most situations
   688  		// where the type of an alias is needed before it is available.
   689  		// There may still be cases where this is not good enough (see also go.dev/issue/25838).
   690  		// In those cases Checker.ident will report an error ("invalid use of type alias").
   691  		var aliasList []*TypeName
   692  		var othersList []Object // everything that's not a type
   693  		// phase 1: non-alias type declarations
   694  		for _, obj := range objList {
   695  			if tname, _ := obj.(*TypeName); tname != nil {
   696  				if check.objMap[tname].tdecl.Alias {
   697  					aliasList = append(aliasList, tname)
   698  				} else {
   699  					check.objDecl(obj, nil)
   700  				}
   701  			} else {
   702  				othersList = append(othersList, obj)
   703  			}
   704  		}
   705  		// phase 2: alias type declarations
   706  		for _, obj := range aliasList {
   707  			check.objDecl(obj, nil)
   708  		}
   709  		// phase 3: all other declarations
   710  		for _, obj := range othersList {
   711  			check.objDecl(obj, nil)
   712  		}
   713  	}
   714  
   715  	// At this point we may have a non-empty check.methods map; this means that not all
   716  	// entries were deleted at the end of typeDecl because the respective receiver base
   717  	// types were not found. In that case, an error was reported when declaring those
   718  	// methods. We can now safely discard this map.
   719  	check.methods = nil
   720  }
   721  
   722  // inSourceOrder implements the sort.Sort interface.
   723  type inSourceOrder []Object
   724  
   725  func (a inSourceOrder) Len() int           { return len(a) }
   726  func (a inSourceOrder) Less(i, j int) bool { return a[i].order() < a[j].order() }
   727  func (a inSourceOrder) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
   728  
   729  // unusedImports checks for unused imports.
   730  func (check *Checker) unusedImports() {
   731  	// If function bodies are not checked, packages' uses are likely missing - don't check.
   732  	if check.conf.IgnoreFuncBodies {
   733  		return
   734  	}
   735  
   736  	// spec: "It is illegal (...) to directly import a package without referring to
   737  	// any of its exported identifiers. To import a package solely for its side-effects
   738  	// (initialization), use the blank identifier as explicit package name."
   739  
   740  	for _, obj := range check.imports {
   741  		if !obj.used && obj.name != "_" {
   742  			check.errorUnusedPkg(obj)
   743  		}
   744  	}
   745  }
   746  
   747  func (check *Checker) errorUnusedPkg(obj *PkgName) {
   748  	// If the package was imported with a name other than the final
   749  	// import path element, show it explicitly in the error message.
   750  	// Note that this handles both renamed imports and imports of
   751  	// packages containing unconventional package declarations.
   752  	// Note that this uses / always, even on Windows, because Go import
   753  	// paths always use forward slashes.
   754  	path := obj.imported.path
   755  	elem := path
   756  	if i := strings.LastIndex(elem, "/"); i >= 0 {
   757  		elem = elem[i+1:]
   758  	}
   759  	if obj.name == "" || obj.name == "." || obj.name == elem {
   760  		check.softErrorf(obj, UnusedImport, "%q imported and not used", path)
   761  	} else {
   762  		check.softErrorf(obj, UnusedImport, "%q imported as %s and not used", path, obj.name)
   763  	}
   764  }
   765  
   766  // dir makes a good-faith attempt to return the directory
   767  // portion of path. If path is empty, the result is ".".
   768  // (Per the go/build package dependency tests, we cannot import
   769  // path/filepath and simply use filepath.Dir.)
   770  func dir(path string) string {
   771  	if i := strings.LastIndexAny(path, `/\`); i > 0 {
   772  		return path[:i]
   773  	}
   774  	// i <= 0
   775  	return "."
   776  }
   777
View as plain text