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.
8 "cmd/compile/internal/syntax"
17 // A declInfo describes a package-level const, type, var, or func declaration.
18 type declInfo struct {
19 file *Scope // scope of file containing this declaration
20 lhs []*Var // lhs of n:1 variable declarations, or nil
21 vtyp syntax.Expr // type, or nil (for const and var declarations only)
22 init syntax.Expr // init/orig expression, or nil (for const and var declarations only)
23 inherited bool // if set, the init expression is inherited from a previous constant declaration
24 tdecl *syntax.TypeDecl // type declaration, or nil
25 fdecl *syntax.FuncDecl // func declaration, or nil
27 // The deps field tracks initialization expression dependencies.
28 deps map[Object]bool // lazily initialized
31 // hasInitializer reports whether the declared object has an initialization
32 // expression or function body.
33 func (d *declInfo) hasInitializer() bool {
34 return d.init != nil || d.fdecl != nil && d.fdecl.Body != nil
37 // addDep adds obj to the set of objects d's init expression depends on.
38 func (d *declInfo) addDep(obj Object) {
41 m = make(map[Object]bool)
47 // arity checks that the lhs and rhs of a const or var decl
48 // have a matching number of names and initialization values.
49 // If inherited is set, the initialization values are from
50 // another (constant) declaration.
51 func (check *Checker) arity(pos syntax.Pos, names []*syntax.Name, inits []syntax.Expr, constDecl, inherited bool) {
59 check.errorf(pos, "extra init expr at %s", n.Pos())
61 check.errorf(n, "extra init expr %s", n)
63 case l > r && (constDecl || r != 1): // if r == 1 it may be a multi-valued function and we can't say anything yet
65 check.errorf(n, "missing init expr for %s", n.Value)
69 func validatedImportPath(path string) (string, error) {
70 s, err := strconv.Unquote(path)
75 return "", fmt.Errorf("empty string")
77 const illegalChars = `!"#$%&'()*,:;<=>?[\]^{|}` + "`\uFFFD"
79 if !unicode.IsGraphic(r) || unicode.IsSpace(r) || strings.ContainsRune(illegalChars, r) {
80 return s, fmt.Errorf("invalid character %#U", r)
86 // declarePkgObj declares obj in the package scope, records its ident -> obj mapping,
87 // and updates check.objMap. The object must not be a function or method.
88 func (check *Checker) declarePkgObj(ident *syntax.Name, obj Object, d *declInfo) {
89 assert(ident.Value == obj.Name())
91 // spec: "A package-scope or file-scope identifier with name init
92 // may only be declared to be a function with this (func()) signature."
93 if ident.Value == "init" {
94 check.error(ident, "cannot declare init - must be func")
98 // spec: "The main package must have package name main and declare
99 // a function main that takes no arguments and returns no value."
100 if ident.Value == "main" && check.pkg.name == "main" {
101 check.error(ident, "cannot declare main - must be func")
105 check.declare(check.pkg.scope, ident, obj, nopos)
106 check.objMap[obj] = d
107 obj.setOrder(uint32(len(check.objMap)))
110 // filename returns a filename suitable for debugging output.
111 func (check *Checker) filename(fileNo int) string {
112 file := check.files[fileNo]
113 if pos := file.Pos(); pos.IsKnown() {
114 // return check.fset.File(pos).Name()
115 // TODO(gri) do we need the actual file name here?
116 return pos.RelFilename()
118 return fmt.Sprintf("file[%d]", fileNo)
121 func (check *Checker) importPackage(pos syntax.Pos, path, dir string) *Package {
122 // If we already have a package for the given (path, dir)
123 // pair, use it instead of doing a full import.
124 // Checker.impMap only caches packages that are marked Complete
125 // or fake (dummy packages for failed imports). Incomplete but
126 // non-fake packages do require an import to complete them.
127 key := importKey{path, dir}
128 imp := check.impMap[key]
133 // no package yet => import it
134 if path == "C" && (check.conf.FakeImportC || check.conf.go115UsesCgo) {
135 imp = NewPackage("C", "C")
136 imp.fake = true // package scope is not populated
137 imp.cgo = check.conf.go115UsesCgo
141 if importer := check.conf.Importer; importer == nil {
142 err = fmt.Errorf("Config.Importer not installed")
143 } else if importerFrom, ok := importer.(ImporterFrom); ok {
144 imp, err = importerFrom.ImportFrom(path, dir, 0)
145 if imp == nil && err == nil {
146 err = fmt.Errorf("Config.Importer.ImportFrom(%s, %s, 0) returned nil but no error", path, dir)
149 imp, err = importer.Import(path)
150 if imp == nil && err == nil {
151 err = fmt.Errorf("Config.Importer.Import(%s) returned nil but no error", path)
154 // make sure we have a valid package name
155 // (errors here can only happen through manipulation of packages after creation)
156 if err == nil && imp != nil && (imp.name == "_" || imp.name == "") {
157 err = fmt.Errorf("invalid package name: %q", imp.name)
158 imp = nil // create fake package below
161 check.errorf(pos, "could not import %s (%s)", path, err)
163 // create a new fake package
164 // come up with a sensible package name (heuristic)
166 if i := len(name); i > 0 && name[i-1] == '/' {
169 if i := strings.LastIndex(name, "/"); i >= 0 {
172 imp = NewPackage(path, name)
174 // continue to use the package as best as we can
175 imp.fake = true // avoid follow-up lookup failures
179 // package should be complete or marked fake, but be cautious
180 if imp.complete || imp.fake {
181 check.impMap[key] = imp
182 // Once we've formatted an error message, keep the pkgPathMap
183 // up-to-date on subsequent imports. It is used for package
184 // qualification in error messages.
185 if check.pkgPathMap != nil {
186 check.markImports(imp)
191 // something went wrong (importer may have returned incomplete package without error)
195 // collectObjects collects all file and package objects and inserts them
196 // into their respective scopes. It also performs imports and associates
197 // methods with receiver base type names.
198 func (check *Checker) collectObjects() {
201 // pkgImports is the set of packages already imported by any package file seen
202 // so far. Used to avoid duplicate entries in pkg.imports. Allocate and populate
203 // it (pkg.imports may not be empty if we are checking test files incrementally).
204 // Note that pkgImports is keyed by package (and thus package path), not by an
205 // importKey value. Two different importKey values may map to the same package
206 // which is why we cannot use the check.impMap here.
207 var pkgImports = make(map[*Package]bool)
208 for _, imp := range pkg.imports {
209 pkgImports[imp] = true
212 type methodInfo struct {
214 ptr bool // true if pointer receiver
215 recv *syntax.Name // receiver type name
217 var methods []methodInfo // collected methods with valid receivers and non-blank _ names
218 var fileScopes []*Scope
219 for fileNo, file := range check.files {
220 // The package identifier denotes the current package,
221 // but there is no corresponding package object.
222 check.recordDef(file.PkgName, nil)
224 fileScope := NewScope(check.pkg.scope, syntax.StartPos(file), syntax.EndPos(file), check.filename(fileNo))
225 fileScopes = append(fileScopes, fileScope)
226 check.recordScope(file, fileScope)
228 // determine file directory, necessary to resolve imports
229 // FileName may be "" (typically for tests) in which case
230 // we get "." as the directory which is what we would want.
231 fileDir := dir(file.PkgName.Pos().RelFilename()) // TODO(gri) should this be filename?
233 first := -1 // index of first ConstDecl in the current group, or -1
234 var last *syntax.ConstDecl // last ConstDecl with init expressions, or nil
235 for index, decl := range file.DeclList {
236 if _, ok := decl.(*syntax.ConstDecl); !ok {
237 first = -1 // we're not in a constant declaration
240 switch s := decl.(type) {
241 case *syntax.ImportDecl:
243 if s.Path == nil || s.Path.Bad {
244 continue // error reported during parsing
246 path, err := validatedImportPath(s.Path.Value)
248 check.errorf(s.Path, "invalid import path (%s)", err)
252 imp := check.importPackage(s.Path.Pos(), path, fileDir)
257 // local name overrides imported package name
259 if s.LocalPkgName != nil {
260 name = s.LocalPkgName.Value
262 // match 1.17 cmd/compile (not prescribed by spec)
263 check.error(s.LocalPkgName, `cannot rename import "C"`)
269 check.error(s, "cannot import package as init - init must be a func")
273 // add package to list of explicit imports
274 // (this functionality is provided as a convenience
275 // for clients; it is not needed for type-checking)
276 if !pkgImports[imp] {
277 pkgImports[imp] = true
278 pkg.imports = append(pkg.imports, imp)
281 pkgName := NewPkgName(s.Pos(), pkg, name, imp)
282 if s.LocalPkgName != nil {
283 // in a dot-import, the dot represents the package
284 check.recordDef(s.LocalPkgName, pkgName)
286 check.recordImplicit(s, pkgName)
290 // match 1.17 cmd/compile (not prescribed by spec)
294 // add import to file scope
295 check.imports = append(check.imports, pkgName)
298 if check.dotImportMap == nil {
299 check.dotImportMap = make(map[dotImportKey]*PkgName)
301 // merge imported scope with file scope
302 for name, obj := range imp.scope.elems {
303 // Note: Avoid eager resolve(name, obj) here, so we only
304 // resolve dot-imported objects as needed.
306 // A package scope may contain non-exported objects,
307 // do not import them!
308 if isExported(name) {
309 // declare dot-imported object
310 // (Do not use check.declare because it modifies the object
311 // via Object.setScopePos, which leads to a race condition;
312 // the object may be imported into more than one file scope
313 // concurrently. See issue #32154.)
314 if alt := fileScope.Lookup(name); alt != nil {
316 err.errorf(s.LocalPkgName, "%s redeclared in this block", alt.Name())
317 err.recordAltDecl(alt)
320 fileScope.insert(name, obj)
321 check.dotImportMap[dotImportKey{fileScope, name}] = pkgName
326 // declare imported package object in file scope
327 // (no need to provide s.LocalPkgName since we called check.recordDef earlier)
328 check.declare(fileScope, nil, pkgName, nopos)
331 case *syntax.ConstDecl:
332 // iota is the index of the current constDecl within the group
333 if first < 0 || s.Group == nil || file.DeclList[index-1].(*syntax.ConstDecl).Group != s.Group {
337 iota := constant.MakeInt64(int64(index - first))
339 // determine which initialization expressions to use
342 case s.Type != nil || s.Values != nil:
346 last = new(syntax.ConstDecl) // make sure last exists
350 // declare all constants
351 values := unpackExpr(last.Values)
352 for i, name := range s.NameList {
353 obj := NewConst(name.Pos(), pkg, name.Value, nil, iota)
360 d := &declInfo{file: fileScope, vtyp: last.Type, init: init, inherited: inherited}
361 check.declarePkgObj(name, obj, d)
364 // Constants must always have init values.
365 check.arity(s.Pos(), s.NameList, values, true, inherited)
367 case *syntax.VarDecl:
368 lhs := make([]*Var, len(s.NameList))
369 // If there's exactly one rhs initializer, use
370 // the same declInfo d1 for all lhs variables
371 // so that each lhs variable depends on the same
372 // rhs initializer (n:1 var declaration).
374 if _, ok := s.Values.(*syntax.ListExpr); !ok {
375 // The lhs elements are only set up after the for loop below,
376 // but that's ok because declarePkgObj only collects the declInfo
377 // for a later phase.
378 d1 = &declInfo{file: fileScope, lhs: lhs, vtyp: s.Type, init: s.Values}
381 // declare all variables
382 values := unpackExpr(s.Values)
383 for i, name := range s.NameList {
384 obj := NewVar(name.Pos(), pkg, name.Value, nil)
389 // individual assignments
394 d = &declInfo{file: fileScope, vtyp: s.Type, init: init}
397 check.declarePkgObj(name, obj, d)
400 // If we have no type, we must have values.
401 if s.Type == nil || values != nil {
402 check.arity(s.Pos(), s.NameList, values, false, false)
405 case *syntax.TypeDecl:
406 if len(s.TParamList) != 0 && !check.allowVersion(pkg, 1, 18) {
407 check.versionErrorf(s.TParamList[0], "go1.18", "type parameter")
409 obj := NewTypeName(s.Name.Pos(), pkg, s.Name.Value, nil)
410 check.declarePkgObj(s.Name, obj, &declInfo{file: fileScope, tdecl: s})
412 case *syntax.FuncDecl:
414 obj := NewFunc(s.Name.Pos(), pkg, name, nil)
415 hasTParamError := false // avoid duplicate type parameter errors
418 if name == "init" || name == "main" && pkg.name == "main" {
419 if len(s.TParamList) != 0 {
420 check.softErrorf(s.TParamList[0], "func %s must have no type parameters", name)
421 hasTParamError = true
423 if t := s.Type; len(t.ParamList) != 0 || len(t.ResultList) != 0 {
424 check.softErrorf(s, "func %s must have no arguments and no return values", name)
427 // don't declare init functions in the package scope - they are invisible
429 obj.parent = pkg.scope
430 check.recordDef(s.Name, obj)
431 // init functions must have a body
433 // TODO(gri) make this error message consistent with the others above
434 check.softErrorf(obj.pos, "missing function body")
437 check.declare(pkg.scope, s.Name, obj, nopos)
442 ptr, recv, _ := check.unpackRecv(s.Recv.Type, false)
443 // Methods with invalid receiver cannot be associated to a type, and
444 // methods with blank _ names are never found; no need to collect any
445 // of them. They will still be type-checked with all the other functions.
446 if recv != nil && name != "_" {
447 methods = append(methods, methodInfo{obj, ptr, recv})
449 check.recordDef(s.Name, obj)
451 if len(s.TParamList) != 0 && !check.allowVersion(pkg, 1, 18) && !hasTParamError {
452 check.versionErrorf(s.TParamList[0], "go1.18", "type parameter")
454 info := &declInfo{file: fileScope, fdecl: s}
455 // Methods are not package-level objects but we still track them in the
456 // object map so that we can handle them like regular functions (if the
457 // receiver is invalid); also we need their fdecl info when associating
458 // them with their receiver base type, below.
459 check.objMap[obj] = info
460 obj.setOrder(uint32(len(check.objMap)))
463 check.errorf(s, invalidAST+"unknown syntax.Decl node %T", s)
468 // verify that objects in package and file scopes have different names
469 for _, scope := range fileScopes {
470 for name, obj := range scope.elems {
471 if alt := pkg.scope.Lookup(name); alt != nil {
472 obj = resolve(name, obj)
474 if pkg, ok := obj.(*PkgName); ok {
475 err.errorf(alt, "%s already declared through import of %s", alt.Name(), pkg.Imported())
476 err.recordAltDecl(pkg)
478 err.errorf(alt, "%s already declared through dot-import of %s", alt.Name(), obj.Pkg())
479 // TODO(gri) dot-imported objects don't have a position; recordAltDecl won't print anything
480 err.recordAltDecl(obj)
487 // Now that we have all package scope objects and all methods,
488 // associate methods with receiver base type name where possible.
489 // Ignore methods that have an invalid receiver. They will be
490 // type-checked later, with regular functions.
492 check.methods = make(map[*TypeName][]*Func)
493 for i := range methods {
495 // Determine the receiver base type and associate m with it.
496 ptr, base := check.resolveBaseTypeName(m.ptr, m.recv)
498 m.obj.hasPtrRecv_ = ptr
499 check.methods[base] = append(check.methods[base], m.obj)
505 // unpackRecv unpacks a receiver type and returns its components: ptr indicates whether
506 // rtyp is a pointer receiver, rname is the receiver type name, and tparams are its
507 // type parameters, if any. The type parameters are only unpacked if unpackParams is
508 // set. If rname is nil, the receiver is unusable (i.e., the source has a bug which we
509 // cannot easily work around).
510 func (check *Checker) unpackRecv(rtyp syntax.Expr, unpackParams bool) (ptr bool, rname *syntax.Name, tparams []*syntax.Name) {
511 L: // unpack receiver type
512 // This accepts invalid receivers such as ***T and does not
513 // work for other invalid receivers, but we don't care. The
514 // validity of receiver expressions is checked elsewhere.
516 switch t := rtyp.(type) {
517 case *syntax.ParenExpr:
519 // case *ast.StarExpr:
522 case *syntax.Operation:
523 if t.Op != syntax.Mul || t.Y != nil {
533 // unpack type parameters, if any
534 if ptyp, _ := rtyp.(*syntax.IndexExpr); ptyp != nil {
537 for _, arg := range unpackExpr(ptyp.Index) {
539 switch arg := arg.(type) {
542 case *syntax.BadExpr:
543 // ignore - error already reported by parser
545 check.error(ptyp, invalidAST+"parameterized receiver contains nil parameters")
547 check.errorf(arg, "receiver type parameter %s must be an identifier", arg)
550 par = syntax.NewName(arg.Pos(), "_")
552 tparams = append(tparams, par)
558 // unpack receiver name
559 if name, _ := rtyp.(*syntax.Name); name != nil {
566 // resolveBaseTypeName returns the non-alias base type name for typ, and whether
567 // there was a pointer indirection to get to it. The base type name must be declared
568 // in package scope, and there can be at most one pointer indirection. If no such type
569 // name exists, the returned base is nil.
570 func (check *Checker) resolveBaseTypeName(seenPtr bool, typ syntax.Expr) (ptr bool, base *TypeName) {
571 // Algorithm: Starting from a type expression, which may be a name,
572 // we follow that type through alias declarations until we reach a
573 // non-alias type name. If we encounter anything but pointer types or
574 // parentheses we're done. If we encounter more than one pointer type
577 var seen map[*TypeName]bool
581 // check if we have a pointer type
582 // if pexpr, _ := typ.(*ast.StarExpr); pexpr != nil {
583 if pexpr, _ := typ.(*syntax.Operation); pexpr != nil && pexpr.Op == syntax.Mul && pexpr.Y == nil {
584 // if we've already seen a pointer, we're done
589 typ = unparen(pexpr.X) // continue with pointer base type
592 // typ must be a name
593 name, _ := typ.(*syntax.Name)
598 // name must denote an object found in the current package scope
599 // (note that dot-imported objects are not in the package scope!)
600 obj := check.pkg.scope.Lookup(name.Value)
605 // the object must be a type name...
606 tname, _ := obj.(*TypeName)
611 // ... which we have not seen before
616 // we're done if tdecl defined tname as a new type
617 // (rather than an alias)
618 tdecl := check.objMap[tname].tdecl // must exist for objects in package scope
623 // otherwise, continue resolving
626 seen = make(map[*TypeName]bool)
632 // packageObjects typechecks all package objects, but not function bodies.
633 func (check *Checker) packageObjects() {
634 // process package objects in source order for reproducible results
635 objList := make([]Object, len(check.objMap))
637 for obj := range check.objMap {
641 sort.Sort(inSourceOrder(objList))
643 // add new methods to already type-checked types (from a prior Checker.Files call)
644 for _, obj := range objList {
645 if obj, _ := obj.(*TypeName); obj != nil && obj.typ != nil {
646 check.collectMethods(obj)
650 // We process non-alias type declarations first, followed by alias declarations,
651 // and then everything else. This appears to avoid most situations where the type
652 // of an alias is needed before it is available.
653 // There may still be cases where this is not good enough (see also issue #25838).
654 // In those cases Checker.ident will report an error ("invalid use of type alias").
655 var aliasList []*TypeName
656 var othersList []Object // everything that's not a type
657 // phase 1: non-alias type declarations
658 for _, obj := range objList {
659 if tname, _ := obj.(*TypeName); tname != nil {
660 if check.objMap[tname].tdecl.Alias {
661 aliasList = append(aliasList, tname)
663 check.objDecl(obj, nil)
666 othersList = append(othersList, obj)
669 // phase 2: alias type declarations
670 for _, obj := range aliasList {
671 check.objDecl(obj, nil)
673 // phase 3: all other declarations
674 for _, obj := range othersList {
675 check.objDecl(obj, nil)
678 // At this point we may have a non-empty check.methods map; this means that not all
679 // entries were deleted at the end of typeDecl because the respective receiver base
680 // types were not found. In that case, an error was reported when declaring those
681 // methods. We can now safely discard this map.
685 // inSourceOrder implements the sort.Sort interface.
686 type inSourceOrder []Object
688 func (a inSourceOrder) Len() int { return len(a) }
689 func (a inSourceOrder) Less(i, j int) bool { return a[i].order() < a[j].order() }
690 func (a inSourceOrder) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
692 // unusedImports checks for unused imports.
693 func (check *Checker) unusedImports() {
694 // If function bodies are not checked, packages' uses are likely missing - don't check.
695 if check.conf.IgnoreFuncBodies {
699 // spec: "It is illegal (...) to directly import a package without referring to
700 // any of its exported identifiers. To import a package solely for its side-effects
701 // (initialization), use the blank identifier as explicit package name."
703 for _, obj := range check.imports {
704 if !obj.used && obj.name != "_" {
705 check.errorUnusedPkg(obj)
710 func (check *Checker) errorUnusedPkg(obj *PkgName) {
711 // If the package was imported with a name other than the final
712 // import path element, show it explicitly in the error message.
713 // Note that this handles both renamed imports and imports of
714 // packages containing unconventional package declarations.
715 // Note that this uses / always, even on Windows, because Go import
716 // paths always use forward slashes.
717 path := obj.imported.path
719 if i := strings.LastIndex(elem, "/"); i >= 0 {
722 if obj.name == "" || obj.name == "." || obj.name == elem {
723 if check.conf.CompilerErrorMessages {
724 check.softErrorf(obj, "imported and not used: %q", path)
726 check.softErrorf(obj, "%q imported but not used", path)
729 if check.conf.CompilerErrorMessages {
730 check.softErrorf(obj, "imported and not used: %q as %s", path, obj.name)
732 check.softErrorf(obj, "%q imported but not used as %s", path, obj.name)
737 // dir makes a good-faith attempt to return the directory
738 // portion of path. If path is empty, the result is ".".
739 // (Per the go/build package dependency tests, we cannot import
740 // path/filepath and simply use filepath.Dir.)
741 func dir(path string) string {
742 if i := strings.LastIndexAny(path, `/\`); i > 0 {