src/go/types/check.go

   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.
   4
   5 // This file implements the Check function, which drives type-checking.
   6
   7 package types
   8
   9 import (
  10         "errors"
  11         "fmt"
  12         "go/ast"
  13         "go/constant"
  14         "go/token"
  15 )
  16
  17 // debugging/development support
  18 const (
  19         debug = false // leave on during development
  20         trace = false // turn on for detailed type resolution traces
  21 )
  22
  23 // If Strict 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:
  29 //
  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.
  33 //
  34 const strict = false
  35
  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
  39         mode  operandMode
  40         typ   *Basic
  41         val   constant.Value // constant value; or nil (if not a constant)
  42 }
  43
  44 // A context represents the context within which an object is type-checked.
  45 type context struct {
  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
  55 }
  56
  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)
  60         return obj
  61 }
  62
  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
  68 // paths).
  69 type importKey struct {
  70         path, dir string
  71 }
  72
  73 // A dotImportKey describes a dot-imported object in the given scope.
  74 type dotImportKey struct {
  75         scope *Scope
  76         obj   Object
  77 }
  78
  79 // A Checker maintains the state of the type checker.
  80 // It must be created with NewChecker.
  81 type Checker struct {
  82         // package information
  83         // (initialized by NewChecker, valid for the life-time of checker)
  84         conf *Config
  85         fset *token.FileSet
  86         pkg  *Package
  87         *Info
  88         version version                    // accepted language version
  89         objMap  map[Object]*declInfo       // maps package-level objects and (non-interface) methods to declaration info
  90         impMap  map[importKey]*Package     // maps (import path, source directory) to (complete or fake) package
  91         posMap  map[*Interface][]token.Pos // maps interface types to lists of embedded interface positions
  92         pkgCnt  map[string]int             // counts number of imported packages with a given name (for better error messages)
  93
  94         // information collected during type-checking of a set of package files
  95         // (initialized by Files, valid only for the duration of check.Files;
  96         // maps and lists are allocated on demand)
  97         files        []*ast.File               // package files
  98         imports      []*PkgName                // list of imported packages
  99         dotImportMap map[dotImportKey]*PkgName // maps dot-imported objects to the package they were dot-imported through
 100
 101         firstErr error                 // first error encountered
 102         methods  map[*TypeName][]*Func // maps package scope type names to associated non-blank (non-interface) methods
 103         untyped  map[ast.Expr]exprInfo // map of expressions without final type
 104         delayed  []func()              // stack of delayed action segments; segments are processed in FIFO order
 105         finals   []func()              // list of final actions; processed at the end of type-checking the current set of files
 106         objPath  []Object              // path of object dependencies during type inference (for cycle reporting)
 107
 108         // context within which the current object is type-checked
 109         // (valid only for the duration of type-checking a specific object)
 110         context
 111
 112         // debugging
 113         indent int // indentation for tracing
 114 }
 115
 116 // addDeclDep adds the dependency edge (check.decl -> to) if check.decl exists
 117 func (check *Checker) addDeclDep(to Object) {
 118         from := check.decl
 119         if from == nil {
 120                 return // not in a package-level init expression
 121         }
 122         if _, found := check.objMap[to]; !found {
 123                 return // to is not a package-level object
 124         }
 125         from.addDep(to)
 126 }
 127
 128 func (check *Checker) rememberUntyped(e ast.Expr, lhs bool, mode operandMode, typ *Basic, val constant.Value) {
 129         m := check.untyped
 130         if m == nil {
 131                 m = make(map[ast.Expr]exprInfo)
 132                 check.untyped = m
 133         }
 134         m[e] = exprInfo{lhs, mode, typ, val}
 135 }
 136
 137 // later pushes f on to the stack of actions that will be processed later;
 138 // either at the end of the current statement, or in case of a local constant
 139 // or variable declaration, before the constant or variable is in scope
 140 // (so that f still sees the scope before any new declarations).
 141 func (check *Checker) later(f func()) {
 142         check.delayed = append(check.delayed, f)
 143 }
 144
 145 // atEnd adds f to the list of actions processed at the end
 146 // of type-checking, before initialization order computation.
 147 // Actions added by atEnd are processed after any actions
 148 // added by later.
 149 func (check *Checker) atEnd(f func()) {
 150         check.finals = append(check.finals, f)
 151 }
 152
 153 // push pushes obj onto the object path and returns its index in the path.
 154 func (check *Checker) push(obj Object) int {
 155         check.objPath = append(check.objPath, obj)
 156         return len(check.objPath) - 1
 157 }
 158
 159 // pop pops and returns the topmost object from the object path.
 160 func (check *Checker) pop() Object {
 161         i := len(check.objPath) - 1
 162         obj := check.objPath[i]
 163         check.objPath[i] = nil
 164         check.objPath = check.objPath[:i]
 165         return obj
 166 }
 167
 168 // NewChecker returns a new Checker instance for a given package.
 169 // Package files may be added incrementally via checker.Files.
 170 func NewChecker(conf *Config, fset *token.FileSet, pkg *Package, info *Info) *Checker {
 171         // make sure we have a configuration
 172         if conf == nil {
 173                 conf = new(Config)
 174         }
 175
 176         // make sure we have an info struct
 177         if info == nil {
 178                 info = new(Info)
 179         }
 180
 181         version, err := parseGoVersion(conf.GoVersion)
 182         if err != nil {
 183                 panic(fmt.Sprintf("invalid Go version %q (%v)", conf.GoVersion, err))
 184         }
 185
 186         return &Checker{
 187                 conf:    conf,
 188                 fset:    fset,
 189                 pkg:     pkg,
 190                 Info:    info,
 191                 version: version,
 192                 objMap:  make(map[Object]*declInfo),
 193                 impMap:  make(map[importKey]*Package),
 194                 posMap:  make(map[*Interface][]token.Pos),
 195                 pkgCnt:  make(map[string]int),
 196         }
 197 }
 198
 199 // initFiles initializes the files-specific portion of checker.
 200 // The provided files must all belong to the same package.
 201 func (check *Checker) initFiles(files []*ast.File) {
 202         // start with a clean slate (check.Files may be called multiple times)
 203         check.files = nil
 204         check.imports = nil
 205         check.dotImportMap = nil
 206
 207         check.firstErr = nil
 208         check.methods = nil
 209         check.untyped = nil
 210         check.delayed = nil
 211         check.finals = nil
 212
 213         // determine package name and collect valid files
 214         pkg := check.pkg
 215         for _, file := range files {
 216                 switch name := file.Name.Name; pkg.name {
 217                 case "":
 218                         if name != "_" {
 219                                 pkg.name = name
 220                         } else {
 221                                 check.errorf(file.Name, _BlankPkgName, "invalid package name _")
 222                         }
 223                         fallthrough
 224
 225                 case name:
 226                         check.files = append(check.files, file)
 227
 228                 default:
 229                         check.errorf(atPos(file.Package), _MismatchedPkgName, "package %s; expected %s", name, pkg.name)
 230                         // ignore this file
 231                 }
 232         }
 233 }
 234
 235 // A bailout panic is used for early termination.
 236 type bailout struct{}
 237
 238 func (check *Checker) handleBailout(err *error) {
 239         switch p := recover().(type) {
 240         case nil, bailout:
 241                 // normal return or early exit
 242                 *err = check.firstErr
 243         default:
 244                 // re-panic
 245                 panic(p)
 246         }
 247 }
 248
 249 // Files checks the provided files as part of the checker's package.
 250 func (check *Checker) Files(files []*ast.File) error { return check.checkFiles(files) }
 251
 252 var errBadCgo = errors.New("cannot use FakeImportC and go115UsesCgo together")
 253
 254 func (check *Checker) checkFiles(files []*ast.File) (err error) {
 255         if check.conf.FakeImportC && check.conf.go115UsesCgo {
 256                 return errBadCgo
 257         }
 258
 259         defer check.handleBailout(&err)
 260
 261         check.initFiles(files)
 262
 263         check.collectObjects()
 264
 265         check.packageObjects()
 266
 267         check.processDelayed(0) // incl. all functions
 268         check.processFinals()
 269
 270         check.initOrder()
 271
 272         if !check.conf.DisableUnusedImportCheck {
 273                 check.unusedImports()
 274         }
 275         // no longer needed - release memory
 276         check.imports = nil
 277         check.dotImportMap = nil
 278
 279         check.recordUntyped()
 280
 281         check.pkg.complete = true
 282
 283         // TODO(rFindley) There's more memory we should release at this point.
 284
 285         return
 286 }
 287
 288 // processDelayed processes all delayed actions pushed after top.
 289 func (check *Checker) processDelayed(top int) {
 290         // If each delayed action pushes a new action, the
 291         // stack will continue to grow during this loop.
 292         // However, it is only processing functions (which
 293         // are processed in a delayed fashion) that may
 294         // add more actions (such as nested functions), so
 295         // this is a sufficiently bounded process.
 296         for i := top; i < len(check.delayed); i++ {
 297                 check.delayed[i]() // may append to check.delayed
 298         }
 299         assert(top <= len(check.delayed)) // stack must not have shrunk
 300         check.delayed = check.delayed[:top]
 301 }
 302
 303 func (check *Checker) processFinals() {
 304         n := len(check.finals)
 305         for _, f := range check.finals {
 306                 f() // must not append to check.finals
 307         }
 308         if len(check.finals) != n {
 309                 panic("internal error: final action list grew")
 310         }
 311 }
 312
 313 func (check *Checker) recordUntyped() {
 314         if !debug && check.Types == nil {
 315                 return // nothing to do
 316         }
 317
 318         for x, info := range check.untyped {
 319                 if debug && isTyped(info.typ) {
 320                         check.dump("%v: %s (type %s) is typed", x.Pos(), x, info.typ)
 321                         unreachable()
 322                 }
 323                 check.recordTypeAndValue(x, info.mode, info.typ, info.val)
 324         }
 325 }
 326
 327 func (check *Checker) recordTypeAndValue(x ast.Expr, mode operandMode, typ Type, val constant.Value) {
 328         assert(x != nil)
 329         assert(typ != nil)
 330         if mode == invalid {
 331                 return // omit
 332         }
 333         if mode == constant_ {
 334                 assert(val != nil)
 335                 assert(typ == Typ[Invalid] || isConstType(typ))
 336         }
 337         if m := check.Types; m != nil {
 338                 m[x] = TypeAndValue{mode, typ, val}
 339         }
 340 }
 341
 342 func (check *Checker) recordBuiltinType(f ast.Expr, sig *Signature) {
 343         // f must be a (possibly parenthesized) identifier denoting a built-in
 344         // (built-ins in package unsafe always produce a constant result and
 345         // we don't record their signatures, so we don't see qualified idents
 346         // here): record the signature for f and possible children.
 347         for {
 348                 check.recordTypeAndValue(f, builtin, sig, nil)
 349                 switch p := f.(type) {
 350                 case *ast.Ident:
 351                         return // we're done
 352                 case *ast.ParenExpr:
 353                         f = p.X
 354                 default:
 355                         unreachable()
 356                 }
 357         }
 358 }
 359
 360 func (check *Checker) recordCommaOkTypes(x ast.Expr, a [2]Type) {
 361         assert(x != nil)
 362         if a[0] == nil || a[1] == nil {
 363                 return
 364         }
 365         assert(isTyped(a[0]) && isTyped(a[1]) && (isBoolean(a[1]) || a[1] == universeError))
 366         if m := check.Types; m != nil {
 367                 for {
 368                         tv := m[x]
 369                         assert(tv.Type != nil) // should have been recorded already
 370                         pos := x.Pos()
 371                         tv.Type = NewTuple(
 372                                 NewVar(pos, check.pkg, "", a[0]),
 373                                 NewVar(pos, check.pkg, "", a[1]),
 374                         )
 375                         m[x] = tv
 376                         // if x is a parenthesized expression (p.X), update p.X
 377                         p, _ := x.(*ast.ParenExpr)
 378                         if p == nil {
 379                                 break
 380                         }
 381                         x = p.X
 382                 }
 383         }
 384 }
 385
 386 func (check *Checker) recordDef(id *ast.Ident, obj Object) {
 387         assert(id != nil)
 388         if m := check.Defs; m != nil {
 389                 m[id] = obj
 390         }
 391 }
 392
 393 func (check *Checker) recordUse(id *ast.Ident, obj Object) {
 394         assert(id != nil)
 395         assert(obj != nil)
 396         if m := check.Uses; m != nil {
 397                 m[id] = obj
 398         }
 399 }
 400
 401 func (check *Checker) recordImplicit(node ast.Node, obj Object) {
 402         assert(node != nil)
 403         assert(obj != nil)
 404         if m := check.Implicits; m != nil {
 405                 m[node] = obj
 406         }
 407 }
 408
 409 func (check *Checker) recordSelection(x *ast.SelectorExpr, kind SelectionKind, recv Type, obj Object, index []int, indirect bool) {
 410         assert(obj != nil && (recv == nil || len(index) > 0))
 411         check.recordUse(x.Sel, obj)
 412         if m := check.Selections; m != nil {
 413                 m[x] = &Selection{kind, recv, obj, index, indirect}
 414         }
 415 }
 416
 417 func (check *Checker) recordScope(node ast.Node, scope *Scope) {
 418         assert(node != nil)
 419         assert(scope != nil)
 420         if m := check.Scopes; m != nil {
 421                 m[node] = scope
 422         }
 423 }