]> Cypherpunks.ru repositories - gostls13.git/blob - src/go/types/resolver.go
[dev.typeparams] all: merge dev.regabi (d1d1099) into dev.typeparams
[gostls13.git] / src / go / types / resolver.go
1 // Copyright 2013 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
4
5 package types
6
7 import (
8         "fmt"
9         "go/ast"
10         "go/constant"
11         "go/token"
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      ast.Expr      // type, or nil (for const and var declarations only)
23         init      ast.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     *ast.TypeSpec // type declaration, or nil
26         fdecl     *ast.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 // arityMatch checks that the lhs and rhs of a const or var decl
49 // have the appropriate number of names and init exprs. For const
50 // decls, init is the value spec providing the init exprs; for
51 // var decls, init is nil (the init exprs are in s in this case).
52 func (check *Checker) arityMatch(s, init *ast.ValueSpec) {
53         l := len(s.Names)
54         r := len(s.Values)
55         if init != nil {
56                 r = len(init.Values)
57         }
58
59         const code = _WrongAssignCount
60         switch {
61         case init == nil && r == 0:
62                 // var decl w/o init expr
63                 if s.Type == nil {
64                         check.errorf(s, code, "missing type or init expr")
65                 }
66         case l < r:
67                 if l < len(s.Values) {
68                         // init exprs from s
69                         n := s.Values[l]
70                         check.errorf(n, code, "extra init expr %s", n)
71                         // TODO(gri) avoid declared but not used error here
72                 } else {
73                         // init exprs "inherited"
74                         check.errorf(s, code, "extra init expr at %s", check.fset.Position(init.Pos()))
75                         // TODO(gri) avoid declared but not used error here
76                 }
77         case l > r && (init != nil || r != 1):
78                 n := s.Names[r]
79                 check.errorf(n, code, "missing init expr for %s", n)
80         }
81 }
82
83 func validatedImportPath(path string) (string, error) {
84         s, err := strconv.Unquote(path)
85         if err != nil {
86                 return "", err
87         }
88         if s == "" {
89                 return "", fmt.Errorf("empty string")
90         }
91         const illegalChars = `!"#$%&'()*,:;<=>?[\]^{|}` + "`\uFFFD"
92         for _, r := range s {
93                 if !unicode.IsGraphic(r) || unicode.IsSpace(r) || strings.ContainsRune(illegalChars, r) {
94                         return s, fmt.Errorf("invalid character %#U", r)
95                 }
96         }
97         return s, nil
98 }
99
100 // declarePkgObj declares obj in the package scope, records its ident -> obj mapping,
101 // and updates check.objMap. The object must not be a function or method.
102 func (check *Checker) declarePkgObj(ident *ast.Ident, obj Object, d *declInfo) {
103         assert(ident.Name == obj.Name())
104
105         // spec: "A package-scope or file-scope identifier with name init
106         // may only be declared to be a function with this (func()) signature."
107         if ident.Name == "init" {
108                 check.errorf(ident, _InvalidInitDecl, "cannot declare init - must be func")
109                 return
110         }
111
112         // spec: "The main package must have package name main and declare
113         // a function main that takes no arguments and returns no value."
114         if ident.Name == "main" && check.pkg.name == "main" {
115                 check.errorf(ident, _InvalidMainDecl, "cannot declare main - must be func")
116                 return
117         }
118
119         check.declare(check.pkg.scope, ident, obj, token.NoPos)
120         check.objMap[obj] = d
121         obj.setOrder(uint32(len(check.objMap)))
122 }
123
124 // filename returns a filename suitable for debugging output.
125 func (check *Checker) filename(fileNo int) string {
126         file := check.files[fileNo]
127         if pos := file.Pos(); pos.IsValid() {
128                 return check.fset.File(pos).Name()
129         }
130         return fmt.Sprintf("file[%d]", fileNo)
131 }
132
133 func (check *Checker) importPackage(pos token.Pos, path, dir string) *Package {
134         // If we already have a package for the given (path, dir)
135         // pair, use it instead of doing a full import.
136         // Checker.impMap only caches packages that are marked Complete
137         // or fake (dummy packages for failed imports). Incomplete but
138         // non-fake packages do require an import to complete them.
139         key := importKey{path, dir}
140         imp := check.impMap[key]
141         if imp != nil {
142                 return imp
143         }
144
145         // no package yet => import it
146         if path == "C" && (check.conf.FakeImportC || check.conf.go115UsesCgo) {
147                 imp = NewPackage("C", "C")
148                 imp.fake = true // package scope is not populated
149                 imp.cgo = check.conf.go115UsesCgo
150         } else {
151                 // ordinary import
152                 var err error
153                 if importer := check.conf.Importer; importer == nil {
154                         err = fmt.Errorf("Config.Importer not installed")
155                 } else if importerFrom, ok := importer.(ImporterFrom); ok {
156                         imp, err = importerFrom.ImportFrom(path, dir, 0)
157                         if imp == nil && err == nil {
158                                 err = fmt.Errorf("Config.Importer.ImportFrom(%s, %s, 0) returned nil but no error", path, dir)
159                         }
160                 } else {
161                         imp, err = importer.Import(path)
162                         if imp == nil && err == nil {
163                                 err = fmt.Errorf("Config.Importer.Import(%s) returned nil but no error", path)
164                         }
165                 }
166                 // make sure we have a valid package name
167                 // (errors here can only happen through manipulation of packages after creation)
168                 if err == nil && imp != nil && (imp.name == "_" || imp.name == "") {
169                         err = fmt.Errorf("invalid package name: %q", imp.name)
170                         imp = nil // create fake package below
171                 }
172                 if err != nil {
173                         check.errorf(atPos(pos), _BrokenImport, "could not import %s (%s)", path, err)
174                         if imp == nil {
175                                 // create a new fake package
176                                 // come up with a sensible package name (heuristic)
177                                 name := path
178                                 if i := len(name); i > 0 && name[i-1] == '/' {
179                                         name = name[:i-1]
180                                 }
181                                 if i := strings.LastIndex(name, "/"); i >= 0 {
182                                         name = name[i+1:]
183                                 }
184                                 imp = NewPackage(path, name)
185                         }
186                         // continue to use the package as best as we can
187                         imp.fake = true // avoid follow-up lookup failures
188                 }
189         }
190
191         // package should be complete or marked fake, but be cautious
192         if imp.complete || imp.fake {
193                 check.impMap[key] = imp
194                 check.pkgCnt[imp.name]++
195                 return imp
196         }
197
198         // something went wrong (importer may have returned incomplete package without error)
199         return nil
200 }
201
202 // collectObjects collects all file and package objects and inserts them
203 // into their respective scopes. It also performs imports and associates
204 // methods with receiver base type names.
205 func (check *Checker) collectObjects() {
206         pkg := check.pkg
207
208         // pkgImports is the set of packages already imported by any package file seen
209         // so far. Used to avoid duplicate entries in pkg.imports. Allocate and populate
210         // it (pkg.imports may not be empty if we are checking test files incrementally).
211         // Note that pkgImports is keyed by package (and thus package path), not by an
212         // importKey value. Two different importKey values may map to the same package
213         // which is why we cannot use the check.impMap here.
214         var pkgImports = make(map[*Package]bool)
215         for _, imp := range pkg.imports {
216                 pkgImports[imp] = true
217         }
218
219         type methodInfo struct {
220                 obj  *Func      // method
221                 ptr  bool       // true if pointer receiver
222                 recv *ast.Ident // receiver type name
223         }
224         var methods []methodInfo // collected methods with valid receivers and non-blank _ names
225         var fileScopes []*Scope
226         for fileNo, file := range check.files {
227                 // The package identifier denotes the current package,
228                 // but there is no corresponding package object.
229                 check.recordDef(file.Name, nil)
230
231                 // Use the actual source file extent rather than *ast.File extent since the
232                 // latter doesn't include comments which appear at the start or end of the file.
233                 // Be conservative and use the *ast.File extent if we don't have a *token.File.
234                 pos, end := file.Pos(), file.End()
235                 if f := check.fset.File(file.Pos()); f != nil {
236                         pos, end = token.Pos(f.Base()), token.Pos(f.Base()+f.Size())
237                 }
238                 fileScope := NewScope(check.pkg.scope, pos, end, check.filename(fileNo))
239                 fileScopes = append(fileScopes, fileScope)
240                 check.recordScope(file, fileScope)
241
242                 // determine file directory, necessary to resolve imports
243                 // FileName may be "" (typically for tests) in which case
244                 // we get "." as the directory which is what we would want.
245                 fileDir := dir(check.fset.Position(file.Name.Pos()).Filename)
246
247                 check.walkDecls(file.Decls, func(d decl) {
248                         switch d := d.(type) {
249                         case importDecl:
250                                 // import package
251                                 path, err := validatedImportPath(d.spec.Path.Value)
252                                 if err != nil {
253                                         check.errorf(d.spec.Path, _BadImportPath, "invalid import path (%s)", err)
254                                         return
255                                 }
256
257                                 imp := check.importPackage(d.spec.Path.Pos(), path, fileDir)
258                                 if imp == nil {
259                                         return
260                                 }
261
262                                 // add package to list of explicit imports
263                                 // (this functionality is provided as a convenience
264                                 // for clients; it is not needed for type-checking)
265                                 if !pkgImports[imp] {
266                                         pkgImports[imp] = true
267                                         pkg.imports = append(pkg.imports, imp)
268                                 }
269
270                                 // local name overrides imported package name
271                                 name := imp.name
272                                 if d.spec.Name != nil {
273                                         name = d.spec.Name.Name
274                                         if path == "C" {
275                                                 // match cmd/compile (not prescribed by spec)
276                                                 check.errorf(d.spec.Name, _ImportCRenamed, `cannot rename import "C"`)
277                                                 return
278                                         }
279                                         if name == "init" {
280                                                 check.errorf(d.spec.Name, _InvalidInitDecl, "cannot declare init - must be func")
281                                                 return
282                                         }
283                                 }
284
285                                 obj := NewPkgName(d.spec.Pos(), pkg, name, imp)
286                                 if d.spec.Name != nil {
287                                         // in a dot-import, the dot represents the package
288                                         check.recordDef(d.spec.Name, obj)
289                                 } else {
290                                         check.recordImplicit(d.spec, obj)
291                                 }
292
293                                 if path == "C" {
294                                         // match cmd/compile (not prescribed by spec)
295                                         obj.used = true
296                                 }
297
298                                 // add import to file scope
299                                 if name == "." {
300                                         // merge imported scope with file scope
301                                         for _, obj := range imp.scope.elems {
302                                                 // A package scope may contain non-exported objects,
303                                                 // do not import them!
304                                                 if obj.Exported() {
305                                                         // declare dot-imported object
306                                                         // (Do not use check.declare because it modifies the object
307                                                         // via Object.setScopePos, which leads to a race condition;
308                                                         // the object may be imported into more than one file scope
309                                                         // concurrently. See issue #32154.)
310                                                         if alt := fileScope.Insert(obj); alt != nil {
311                                                                 check.errorf(d.spec.Name, _DuplicateDecl, "%s redeclared in this block", obj.Name())
312                                                                 check.reportAltDecl(alt)
313                                                         }
314                                                 }
315                                         }
316                                         // add position to set of dot-import positions for this file
317                                         // (this is only needed for "imported but not used" errors)
318                                         check.addUnusedDotImport(fileScope, imp, d.spec)
319                                 } else {
320                                         // declare imported package object in file scope
321                                         // (no need to provide s.Name since we called check.recordDef earlier)
322                                         check.declare(fileScope, nil, obj, token.NoPos)
323                                 }
324                         case constDecl:
325                                 // declare all constants
326                                 for i, name := range d.spec.Names {
327                                         obj := NewConst(name.Pos(), pkg, name.Name, nil, constant.MakeInt64(int64(d.iota)))
328
329                                         var init ast.Expr
330                                         if i < len(d.init) {
331                                                 init = d.init[i]
332                                         }
333
334                                         d := &declInfo{file: fileScope, vtyp: d.typ, init: init, inherited: d.inherited}
335                                         check.declarePkgObj(name, obj, d)
336                                 }
337
338                         case varDecl:
339                                 lhs := make([]*Var, len(d.spec.Names))
340                                 // If there's exactly one rhs initializer, use
341                                 // the same declInfo d1 for all lhs variables
342                                 // so that each lhs variable depends on the same
343                                 // rhs initializer (n:1 var declaration).
344                                 var d1 *declInfo
345                                 if len(d.spec.Values) == 1 {
346                                         // The lhs elements are only set up after the for loop below,
347                                         // but that's ok because declareVar only collects the declInfo
348                                         // for a later phase.
349                                         d1 = &declInfo{file: fileScope, lhs: lhs, vtyp: d.spec.Type, init: d.spec.Values[0]}
350                                 }
351
352                                 // declare all variables
353                                 for i, name := range d.spec.Names {
354                                         obj := NewVar(name.Pos(), pkg, name.Name, nil)
355                                         lhs[i] = obj
356
357                                         di := d1
358                                         if di == nil {
359                                                 // individual assignments
360                                                 var init ast.Expr
361                                                 if i < len(d.spec.Values) {
362                                                         init = d.spec.Values[i]
363                                                 }
364                                                 di = &declInfo{file: fileScope, vtyp: d.spec.Type, init: init}
365                                         }
366
367                                         check.declarePkgObj(name, obj, di)
368                                 }
369                         case typeDecl:
370                                 obj := NewTypeName(d.spec.Name.Pos(), pkg, d.spec.Name.Name, nil)
371                                 check.declarePkgObj(d.spec.Name, obj, &declInfo{file: fileScope, tdecl: d.spec})
372                         case funcDecl:
373                                 info := &declInfo{file: fileScope, fdecl: d.decl}
374                                 name := d.decl.Name.Name
375                                 obj := NewFunc(d.decl.Name.Pos(), pkg, name, nil)
376                                 if !d.decl.IsMethod() {
377                                         // regular function
378                                         if d.decl.Recv != nil {
379                                                 check.error(d.decl.Recv, _BadRecv, "method is missing receiver")
380                                                 // treat as function
381                                         }
382                                         if name == "init" {
383                                                 if d.decl.Type.TParams != nil {
384                                                         check.softErrorf(d.decl.Type.TParams, _InvalidInitSig, "func init must have no type parameters")
385                                                 }
386                                                 if t := d.decl.Type; t.Params.NumFields() != 0 || t.Results != nil {
387                                                         // TODO(rFindley) Should this be a hard error?
388                                                         check.softErrorf(d.decl, _InvalidInitSig, "func init must have no arguments and no return values")
389                                                 }
390                                                 // don't declare init functions in the package scope - they are invisible
391                                                 obj.parent = pkg.scope
392                                                 check.recordDef(d.decl.Name, obj)
393                                                 // init functions must have a body
394                                                 if d.decl.Body == nil {
395                                                         // TODO(gri) make this error message consistent with the others above
396                                                         check.softErrorf(obj, _MissingInitBody, "missing function body")
397                                                 }
398                                         } else {
399                                                 check.declare(pkg.scope, d.decl.Name, obj, token.NoPos)
400                                         }
401                                 } else {
402                                         // method
403                                         if d.decl.Type.TParams != nil {
404                                                 check.invalidAST(d.decl.Type.TParams, "method must have no type parameters")
405                                         }
406                                         ptr, recv, _ := check.unpackRecv(d.decl.Recv.List[0].Type, false)
407                                         // (Methods with invalid receiver cannot be associated to a type, and
408                                         // methods with blank _ names are never found; no need to collect any
409                                         // of them. They will still be type-checked with all the other functions.)
410                                         if recv != nil && name != "_" {
411                                                 methods = append(methods, methodInfo{obj, ptr, recv})
412                                         }
413                                         check.recordDef(d.decl.Name, obj)
414                                 }
415                                 // Methods are not package-level objects but we still track them in the
416                                 // object map so that we can handle them like regular functions (if the
417                                 // receiver is invalid); also we need their fdecl info when associating
418                                 // them with their receiver base type, below.
419                                 check.objMap[obj] = info
420                                 obj.setOrder(uint32(len(check.objMap)))
421                         }
422                 })
423         }
424
425         // verify that objects in package and file scopes have different names
426         for _, scope := range fileScopes {
427                 for _, obj := range scope.elems {
428                         if alt := pkg.scope.Lookup(obj.Name()); alt != nil {
429                                 if pkg, ok := obj.(*PkgName); ok {
430                                         check.errorf(alt, _DuplicateDecl, "%s already declared through import of %s", alt.Name(), pkg.Imported())
431                                         check.reportAltDecl(pkg)
432                                 } else {
433                                         check.errorf(alt, _DuplicateDecl, "%s already declared through dot-import of %s", alt.Name(), obj.Pkg())
434                                         // TODO(gri) dot-imported objects don't have a position; reportAltDecl won't print anything
435                                         check.reportAltDecl(obj)
436                                 }
437                         }
438                 }
439         }
440
441         // Now that we have all package scope objects and all methods,
442         // associate methods with receiver base type name where possible.
443         // Ignore methods that have an invalid receiver. They will be
444         // type-checked later, with regular functions.
445         if methods == nil {
446                 return // nothing to do
447         }
448         check.methods = make(map[*TypeName][]*Func)
449         for i := range methods {
450                 m := &methods[i]
451                 // Determine the receiver base type and associate m with it.
452                 ptr, base := check.resolveBaseTypeName(m.ptr, m.recv)
453                 if base != nil {
454                         m.obj.hasPtrRecv = ptr
455                         check.methods[base] = append(check.methods[base], m.obj)
456                 }
457         }
458 }
459
460 // unpackRecv unpacks a receiver type and returns its components: ptr indicates whether
461 // rtyp is a pointer receiver, rname is the receiver type name, and tparams are its
462 // type parameters, if any. The type parameters are only unpacked if unpackParams is
463 // set. If rname is nil, the receiver is unusable (i.e., the source has a bug which we
464 // cannot easily work around).
465 func (check *Checker) unpackRecv(rtyp ast.Expr, unpackParams bool) (ptr bool, rname *ast.Ident, tparams []*ast.Ident) {
466 L: // unpack receiver type
467         // This accepts invalid receivers such as ***T and does not
468         // work for other invalid receivers, but we don't care. The
469         // validity of receiver expressions is checked elsewhere.
470         for {
471                 switch t := rtyp.(type) {
472                 case *ast.ParenExpr:
473                         rtyp = t.X
474                 case *ast.StarExpr:
475                         ptr = true
476                         rtyp = t.X
477                 default:
478                         break L
479                 }
480         }
481
482         // unpack type parameters, if any
483         switch ptyp := rtyp.(type) {
484         case *ast.IndexExpr:
485                 panic("unimplemented")
486         case *ast.CallExpr:
487                 rtyp = ptyp.Fun
488                 if unpackParams {
489                         for _, arg := range ptyp.Args {
490                                 var par *ast.Ident
491                                 switch arg := arg.(type) {
492                                 case *ast.Ident:
493                                         par = arg
494                                 case *ast.BadExpr:
495                                         // ignore - error already reported by parser
496                                 case nil:
497                                         check.invalidAST(ptyp, "parameterized receiver contains nil parameters")
498                                 default:
499                                         check.errorf(arg, 0, "receiver type parameter %s must be an identifier", arg)
500                                 }
501                                 if par == nil {
502                                         par = &ast.Ident{NamePos: arg.Pos(), Name: "_"}
503                                 }
504                                 tparams = append(tparams, par)
505                         }
506                 }
507         }
508
509         // unpack receiver name
510         if name, _ := rtyp.(*ast.Ident); name != nil {
511                 rname = name
512         }
513
514         return
515 }
516
517 // resolveBaseTypeName returns the non-alias base type name for typ, and whether
518 // there was a pointer indirection to get to it. The base type name must be declared
519 // in package scope, and there can be at most one pointer indirection. If no such type
520 // name exists, the returned base is nil.
521 func (check *Checker) resolveBaseTypeName(seenPtr bool, name *ast.Ident) (ptr bool, base *TypeName) {
522         // Algorithm: Starting from a type expression, which may be a name,
523         // we follow that type through alias declarations until we reach a
524         // non-alias type name. If we encounter anything but pointer types or
525         // parentheses we're done. If we encounter more than one pointer type
526         // we're done.
527         ptr = seenPtr
528         var seen map[*TypeName]bool
529         var typ ast.Expr = name
530         for {
531                 typ = unparen(typ)
532
533                 // check if we have a pointer type
534                 if pexpr, _ := typ.(*ast.StarExpr); pexpr != nil {
535                         // if we've already seen a pointer, we're done
536                         if ptr {
537                                 return false, nil
538                         }
539                         ptr = true
540                         typ = unparen(pexpr.X) // continue with pointer base type
541                 }
542
543                 // typ must be a name
544                 name, _ := typ.(*ast.Ident)
545                 if name == nil {
546                         return false, nil
547                 }
548
549                 // name must denote an object found in the current package scope
550                 // (note that dot-imported objects are not in the package scope!)
551                 obj := check.pkg.scope.Lookup(name.Name)
552                 if obj == nil {
553                         return false, nil
554                 }
555
556                 // the object must be a type name...
557                 tname, _ := obj.(*TypeName)
558                 if tname == nil {
559                         return false, nil
560                 }
561
562                 // ... which we have not seen before
563                 if seen[tname] {
564                         return false, nil
565                 }
566
567                 // we're done if tdecl defined tname as a new type
568                 // (rather than an alias)
569                 tdecl := check.objMap[tname].tdecl // must exist for objects in package scope
570                 if !tdecl.Assign.IsValid() {
571                         return ptr, tname
572                 }
573
574                 // otherwise, continue resolving
575                 typ = tdecl.Type
576                 if seen == nil {
577                         seen = make(map[*TypeName]bool)
578                 }
579                 seen[tname] = true
580         }
581 }
582
583 // packageObjects typechecks all package objects, but not function bodies.
584 func (check *Checker) packageObjects() {
585         // process package objects in source order for reproducible results
586         objList := make([]Object, len(check.objMap))
587         i := 0
588         for obj := range check.objMap {
589                 objList[i] = obj
590                 i++
591         }
592         sort.Sort(inSourceOrder(objList))
593
594         // add new methods to already type-checked types (from a prior Checker.Files call)
595         for _, obj := range objList {
596                 if obj, _ := obj.(*TypeName); obj != nil && obj.typ != nil {
597                         check.collectMethods(obj)
598                 }
599         }
600
601         // We process non-alias declarations first, in order to avoid situations where
602         // the type of an alias declaration is needed before it is available. In general
603         // this is still not enough, as it is possible to create sufficiently convoluted
604         // recursive type definitions that will cause a type alias to be needed before it
605         // is available (see issue #25838 for examples).
606         // As an aside, the cmd/compiler suffers from the same problem (#25838).
607         var aliasList []*TypeName
608         // phase 1
609         for _, obj := range objList {
610                 // If we have a type alias, collect it for the 2nd phase.
611                 if tname, _ := obj.(*TypeName); tname != nil && check.objMap[tname].tdecl.Assign.IsValid() {
612                         aliasList = append(aliasList, tname)
613                         continue
614                 }
615
616                 check.objDecl(obj, nil)
617         }
618         // phase 2
619         for _, obj := range aliasList {
620                 check.objDecl(obj, nil)
621         }
622
623         // At this point we may have a non-empty check.methods map; this means that not all
624         // entries were deleted at the end of typeDecl because the respective receiver base
625         // types were not found. In that case, an error was reported when declaring those
626         // methods. We can now safely discard this map.
627         check.methods = nil
628 }
629
630 // inSourceOrder implements the sort.Sort interface.
631 type inSourceOrder []Object
632
633 func (a inSourceOrder) Len() int           { return len(a) }
634 func (a inSourceOrder) Less(i, j int) bool { return a[i].order() < a[j].order() }
635 func (a inSourceOrder) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
636
637 // unusedImports checks for unused imports.
638 func (check *Checker) unusedImports() {
639         // if function bodies are not checked, packages' uses are likely missing - don't check
640         if check.conf.IgnoreFuncBodies {
641                 return
642         }
643
644         // spec: "It is illegal (...) to directly import a package without referring to
645         // any of its exported identifiers. To import a package solely for its side-effects
646         // (initialization), use the blank identifier as explicit package name."
647
648         // check use of regular imported packages
649         for _, scope := range check.pkg.scope.children /* file scopes */ {
650                 for _, obj := range scope.elems {
651                         if obj, ok := obj.(*PkgName); ok {
652                                 // Unused "blank imports" are automatically ignored
653                                 // since _ identifiers are not entered into scopes.
654                                 if !obj.used {
655                                         path := obj.imported.path
656                                         base := pkgName(path)
657                                         if obj.name == base {
658                                                 check.softErrorf(obj, _UnusedImport, "%q imported but not used", path)
659                                         } else {
660                                                 check.softErrorf(obj, _UnusedImport, "%q imported but not used as %s", path, obj.name)
661                                         }
662                                 }
663                         }
664                 }
665         }
666
667         // check use of dot-imported packages
668         for _, unusedDotImports := range check.unusedDotImports {
669                 for pkg, pos := range unusedDotImports {
670                         check.softErrorf(pos, _UnusedImport, "%q imported but not used", pkg.path)
671                 }
672         }
673 }
674
675 // pkgName returns the package name (last element) of an import path.
676 func pkgName(path string) string {
677         if i := strings.LastIndex(path, "/"); i >= 0 {
678                 path = path[i+1:]
679         }
680         return path
681 }
682
683 // dir makes a good-faith attempt to return the directory
684 // portion of path. If path is empty, the result is ".".
685 // (Per the go/build package dependency tests, we cannot import
686 // path/filepath and simply use filepath.Dir.)
687 func dir(path string) string {
688         if i := strings.LastIndexAny(path, `/\`); i > 0 {
689                 return path[:i]
690         }
691         // i <= 0
692         return "."
693 }