1 // Copyright 2011 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.
5 // This file implements the Check function, which drives type-checking.
17 // debugging/development support
19 debug = false // leave on during development
20 trace = false // turn on for detailed type resolution traces
23 // If forceStrict is set, the type-checker enforces additional
24 // rules not specified by the Go 1 spec, but which will
25 // catch guaranteed run-time errors if the respective
26 // code is executed. In other words, programs passing in
27 // strict mode are Go 1 compliant, but not all Go 1 programs
28 // will pass in strict mode. The additional rules are:
30 // - A type assertion x.(T) where T is an interface type
31 // is invalid if any (statically known) method that exists
32 // for both x and T have different signatures.
34 const forceStrict = false
36 // exprInfo stores information about an untyped expression.
37 type exprInfo struct {
38 isLhs bool // expression is lhs operand of a shift with delayed type-check
41 val constant.Value // constant value; or nil (if not a constant)
44 // A context represents the context within which an object is type-checked.
46 decl *declInfo // package-level declaration whose init expression/function body is checked
47 scope *Scope // top-most scope for lookups
48 pos token.Pos // if valid, identifiers are looked up as if at position pos (used by Eval)
49 iota constant.Value // value of iota in a constant declaration; nil otherwise
50 errpos positioner // if set, identifier position of a constant with inherited initializer
51 sig *Signature // function signature if inside a function; nil otherwise
52 isPanic map[*ast.CallExpr]bool // set of panic call expressions (used for termination check)
53 hasLabel bool // set if a function makes use of labels (only ~1% of functions); unused outside functions
54 hasCallOrRecv bool // set if an expression contains a function call or channel receive operation
57 // lookup looks up name in the current context and returns the matching object, or nil.
58 func (ctxt *context) lookup(name string) Object {
59 _, obj := ctxt.scope.LookupParent(name, ctxt.pos)
63 // An importKey identifies an imported package by import path and source directory
64 // (directory containing the file containing the import). In practice, the directory
65 // may always be the same, or may not matter. Given an (import path, directory), an
66 // importer must always return the same package (but given two different import paths,
67 // an importer may still return the same package by mapping them to the same package
69 type importKey struct {
73 // A dotImportKey describes a dot-imported object in the given scope.
74 type dotImportKey struct {
79 // A Checker maintains the state of the type checker.
80 // It must be created with NewChecker.
82 // package information
83 // (initialized by NewChecker, valid for the life-time of checker)
88 version version // accepted language version
89 nextID uint64 // unique Id for type parameters (first valid Id is 1)
90 objMap map[Object]*declInfo // maps package-level objects and (non-interface) methods to declaration info
91 impMap map[importKey]*Package // maps (import path, source directory) to (complete or fake) package
93 // pkgPathMap maps package names to the set of distinct import paths we've
94 // seen for that name, anywhere in the import graph. It is used for
95 // disambiguating package names in error messages.
97 // pkgPathMap is allocated lazily, so that we don't pay the price of building
98 // it on the happy path. seenPkgMap tracks the packages that we've already
100 pkgPathMap map[string]map[string]bool
101 seenPkgMap map[*Package]bool
103 // information collected during type-checking of a set of package files
104 // (initialized by Files, valid only for the duration of check.Files;
105 // maps and lists are allocated on demand)
106 files []*ast.File // package files
107 imports []*PkgName // list of imported packages
108 dotImportMap map[dotImportKey]*PkgName // maps dot-imported objects to the package they were dot-imported through
109 recvTParamMap map[*ast.Ident]*TypeParam // maps blank receiver type parameters to their type
111 firstErr error // first error encountered
112 methods map[*TypeName][]*Func // maps package scope type names to associated non-blank (non-interface) methods
113 untyped map[ast.Expr]exprInfo // map of expressions without final type
114 delayed []func() // stack of delayed action segments; segments are processed in FIFO order
115 objPath []Object // path of object dependencies during type inference (for cycle reporting)
116 defTypes []*Named // defined types created during type checking, for final validation.
118 // context within which the current object is type-checked
119 // (valid only for the duration of type-checking a specific object)
123 indent int // indentation for tracing
126 // addDeclDep adds the dependency edge (check.decl -> to) if check.decl exists
127 func (check *Checker) addDeclDep(to Object) {
130 return // not in a package-level init expression
132 if _, found := check.objMap[to]; !found {
133 return // to is not a package-level object
138 func (check *Checker) rememberUntyped(e ast.Expr, lhs bool, mode operandMode, typ *Basic, val constant.Value) {
141 m = make(map[ast.Expr]exprInfo)
144 m[e] = exprInfo{lhs, mode, typ, val}
147 // later pushes f on to the stack of actions that will be processed later;
148 // either at the end of the current statement, or in case of a local constant
149 // or variable declaration, before the constant or variable is in scope
150 // (so that f still sees the scope before any new declarations).
151 func (check *Checker) later(f func()) {
152 check.delayed = append(check.delayed, f)
155 // push pushes obj onto the object path and returns its index in the path.
156 func (check *Checker) push(obj Object) int {
157 check.objPath = append(check.objPath, obj)
158 return len(check.objPath) - 1
161 // pop pops and returns the topmost object from the object path.
162 func (check *Checker) pop() Object {
163 i := len(check.objPath) - 1
164 obj := check.objPath[i]
165 check.objPath[i] = nil
166 check.objPath = check.objPath[:i]
170 // NewChecker returns a new Checker instance for a given package.
171 // Package files may be added incrementally via checker.Files.
172 func NewChecker(conf *Config, fset *token.FileSet, pkg *Package, info *Info) *Checker {
173 // make sure we have a configuration
178 // make sure we have a context
179 if conf.Context == nil {
180 conf.Context = NewContext()
183 // make sure we have an info struct
188 version, err := parseGoVersion(conf.GoVersion)
190 panic(fmt.Sprintf("invalid Go version %q (%v)", conf.GoVersion, err))
199 objMap: make(map[Object]*declInfo),
200 impMap: make(map[importKey]*Package),
204 // initFiles initializes the files-specific portion of checker.
205 // The provided files must all belong to the same package.
206 func (check *Checker) initFiles(files []*ast.File) {
207 // start with a clean slate (check.Files may be called multiple times)
210 check.dotImportMap = nil
217 // determine package name and collect valid files
219 for _, file := range files {
220 switch name := file.Name.Name; pkg.name {
225 check.errorf(file.Name, _BlankPkgName, "invalid package name _")
230 check.files = append(check.files, file)
233 check.errorf(atPos(file.Package), _MismatchedPkgName, "package %s; expected %s", name, pkg.name)
239 // A bailout panic is used for early termination.
240 type bailout struct{}
242 func (check *Checker) handleBailout(err *error) {
243 switch p := recover().(type) {
245 // normal return or early exit
246 *err = check.firstErr
253 // Files checks the provided files as part of the checker's package.
254 func (check *Checker) Files(files []*ast.File) error { return check.checkFiles(files) }
256 var errBadCgo = errors.New("cannot use FakeImportC and go115UsesCgo together")
258 func (check *Checker) checkFiles(files []*ast.File) (err error) {
259 if check.conf.FakeImportC && check.conf.go115UsesCgo {
263 defer check.handleBailout(&err)
265 check.initFiles(files)
267 check.collectObjects()
269 check.packageObjects()
271 check.processDelayed(0) // incl. all functions
273 check.expandDefTypes()
277 if !check.conf.DisableUnusedImportCheck {
278 check.unusedImports()
281 check.recordUntyped()
283 check.pkg.complete = true
285 // no longer needed - release memory
287 check.dotImportMap = nil
288 check.pkgPathMap = nil
289 check.seenPkgMap = nil
290 check.recvTParamMap = nil
293 // TODO(rFindley) There's more memory we should release at this point.
298 // processDelayed processes all delayed actions pushed after top.
299 func (check *Checker) processDelayed(top int) {
300 // If each delayed action pushes a new action, the
301 // stack will continue to grow during this loop.
302 // However, it is only processing functions (which
303 // are processed in a delayed fashion) that may
304 // add more actions (such as nested functions), so
305 // this is a sufficiently bounded process.
306 for i := top; i < len(check.delayed); i++ {
307 check.delayed[i]() // may append to check.delayed
309 assert(top <= len(check.delayed)) // stack must not have shrunk
310 check.delayed = check.delayed[:top]
313 func (check *Checker) expandDefTypes() {
314 // Ensure that every defined type created in the course of type-checking has
315 // either non-*Named underlying, or is unresolved.
317 // This guarantees that we don't leak any types whose underlying is *Named,
318 // because any unresolved instances will lazily compute their underlying by
319 // substituting in the underlying of their origin. The origin must have
320 // either been imported or type-checked and expanded here, and in either case
321 // its underlying will be fully expanded.
322 for i := 0; i < len(check.defTypes); i++ {
323 n := check.defTypes[i]
324 switch n.underlying.(type) {
326 if n.resolver == nil {
327 panic("nil underlying")
330 n.under() // n.under may add entries to check.defTypes
336 func (check *Checker) record(x *operand) {
337 // convert x into a user-friendly set of values
338 // TODO(gri) this code can be simplified
340 var val constant.Value
352 assert(x.expr != nil && typ != nil)
355 // delay type and value recording until we know the type
356 // or until the end of type checking
357 check.rememberUntyped(x.expr, false, x.mode, typ.(*Basic), val)
359 check.recordTypeAndValue(x.expr, x.mode, typ, val)
363 func (check *Checker) recordUntyped() {
364 if !debug && check.Types == nil {
365 return // nothing to do
368 for x, info := range check.untyped {
369 if debug && isTyped(info.typ) {
370 check.dump("%v: %s (type %s) is typed", x.Pos(), x, info.typ)
373 check.recordTypeAndValue(x, info.mode, info.typ, info.val)
377 func (check *Checker) recordTypeAndValue(x ast.Expr, mode operandMode, typ Type, val constant.Value) {
383 if mode == constant_ {
385 // We check is(typ, IsConstType) here as constant expressions may be
386 // recorded as type parameters.
387 assert(typ == Typ[Invalid] || is(typ, IsConstType))
389 if m := check.Types; m != nil {
390 m[x] = TypeAndValue{mode, typ, val}
394 func (check *Checker) recordBuiltinType(f ast.Expr, sig *Signature) {
395 // f must be a (possibly parenthesized, possibly qualified)
396 // identifier denoting a built-in (including unsafe's non-constant
397 // functions Add and Slice): record the signature for f and possible
400 check.recordTypeAndValue(f, builtin, sig, nil)
401 switch p := f.(type) {
402 case *ast.Ident, *ast.SelectorExpr:
412 func (check *Checker) recordCommaOkTypes(x ast.Expr, a [2]Type) {
414 if a[0] == nil || a[1] == nil {
417 assert(isTyped(a[0]) && isTyped(a[1]) && (isBoolean(a[1]) || a[1] == universeError))
418 if m := check.Types; m != nil {
421 assert(tv.Type != nil) // should have been recorded already
424 NewVar(pos, check.pkg, "", a[0]),
425 NewVar(pos, check.pkg, "", a[1]),
428 // if x is a parenthesized expression (p.X), update p.X
429 p, _ := x.(*ast.ParenExpr)
438 // recordInstance records instantiation information into check.Info, if the
439 // Instances map is non-nil. The given expr must be an ident, selector, or
440 // index (list) expr with ident or selector operand.
442 // TODO(rfindley): the expr parameter is fragile. See if we can access the
443 // instantiated identifier in some other way.
444 func (check *Checker) recordInstance(expr ast.Expr, targs []Type, typ Type) {
445 ident := instantiatedIdent(expr)
448 if m := check.Instances; m != nil {
449 m[ident] = Instance{NewTypeList(targs), typ}
453 func instantiatedIdent(expr ast.Expr) *ast.Ident {
454 var selOrIdent ast.Expr
455 switch e := expr.(type) {
458 case *ast.IndexListExpr:
460 case *ast.SelectorExpr, *ast.Ident:
463 switch x := selOrIdent.(type) {
466 case *ast.SelectorExpr:
469 panic("instantiated ident not found")
472 func (check *Checker) recordDef(id *ast.Ident, obj Object) {
474 if m := check.Defs; m != nil {
479 func (check *Checker) recordUse(id *ast.Ident, obj Object) {
482 if m := check.Uses; m != nil {
487 func (check *Checker) recordImplicit(node ast.Node, obj Object) {
490 if m := check.Implicits; m != nil {
495 func (check *Checker) recordSelection(x *ast.SelectorExpr, kind SelectionKind, recv Type, obj Object, index []int, indirect bool) {
496 assert(obj != nil && (recv == nil || len(index) > 0))
497 check.recordUse(x.Sel, obj)
498 if m := check.Selections; m != nil {
499 m[x] = &Selection{kind, recv, obj, index, indirect}
503 func (check *Checker) recordScope(node ast.Node, scope *Scope) {
506 if m := check.Scopes; m != nil {