mirror of
https://github.com/golang/go
synced 2024-11-19 02:54:42 -07:00
f119874203
Command set: - what: an extremely fast query that parses a single file and returns the AST stack, package name and the set of query modes that apply to the current selection. Intended for GUI tools that need to grey out UI elements. - definition: shows the definition of an identifier. - pointsto: the PTA features of 'describe' have been split out into their own command. - describe: with PTA stripped out, the cost is now bounded by type checking. Performance: - The importer.Config.TypeCheckFuncBodies predicate supports setting the 'IgnoreFuncBodies' typechecker flag on a per-package basis. This means we can load dependencies from source more quickly if we only need exported types. (We avoid gcimport data because it may be absent or stale.) This also means we can run type-based queries on packages that aren't part of the pointer analysis scope. (Yay.) - Modes that require only type analysis of the query package run a "what" query first, and restrict their analysis scope to just that package and its dependencies (sans func bodies), making them much faster. - We call newOracle not oracle.New in Query, so that the 'needs' bitset isn't ignored (oops!). This makes the non-PTA queries faster. Also: - removed vestigial timers junk. - pos.go: existing position utilties split out into own file. Added parsePosFlag utility. - numerous cosmetic tweaks. + very basic tests. To do in follow-ups: - sophisticated editor integration of "what". - better tests. - refactoring of control flow as described in comment. - changes to "implements", "describe" commands. - update design doc + user manual. R=crawshaw, dominik.honnef CC=golang-dev, gri https://golang.org/cl/40630043
111 lines
2.8 KiB
Go
111 lines
2.8 KiB
Go
// Copyright 2013 The Go Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package oracle
|
|
|
|
import (
|
|
"fmt"
|
|
"go/ast"
|
|
"go/token"
|
|
"sort"
|
|
|
|
"code.google.com/p/go.tools/go/types"
|
|
"code.google.com/p/go.tools/oracle/serial"
|
|
)
|
|
|
|
// Referrers reports all identifiers that resolve to the same object
|
|
// as the queried identifier, within any package in the analysis scope.
|
|
//
|
|
func referrers(o *Oracle, qpos *QueryPos) (queryResult, error) {
|
|
id, _ := qpos.path[0].(*ast.Ident)
|
|
if id == nil {
|
|
return nil, fmt.Errorf("no identifier here")
|
|
}
|
|
|
|
obj := qpos.info.ObjectOf(id)
|
|
if obj == nil {
|
|
// Happens for y in "switch y := x.(type)", but I think that's all.
|
|
return nil, fmt.Errorf("no object for identifier")
|
|
}
|
|
|
|
// Iterate over all go/types' resolver facts for the entire program.
|
|
var refs []*ast.Ident
|
|
for _, info := range o.typeInfo {
|
|
for id2, obj2 := range info.Objects {
|
|
if sameObj(obj, obj2) {
|
|
if id2.NamePos == obj.Pos() {
|
|
continue // skip defining ident
|
|
}
|
|
refs = append(refs, id2)
|
|
}
|
|
}
|
|
}
|
|
sort.Sort(byNamePos(refs))
|
|
|
|
return &referrersResult{
|
|
query: id,
|
|
obj: obj,
|
|
refs: refs,
|
|
}, nil
|
|
}
|
|
|
|
// same reports whether x and y are identical, or both are PkgNames
|
|
// referring to the same Package.
|
|
//
|
|
func sameObj(x, y types.Object) bool {
|
|
if x == y {
|
|
return true
|
|
}
|
|
if _, ok := x.(*types.PkgName); ok {
|
|
if _, ok := y.(*types.PkgName); ok {
|
|
return x.Pkg() == y.Pkg()
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// -------- utils --------
|
|
|
|
type byNamePos []*ast.Ident
|
|
|
|
func (p byNamePos) Len() int { return len(p) }
|
|
func (p byNamePos) Less(i, j int) bool { return p[i].NamePos < p[j].NamePos }
|
|
func (p byNamePos) Swap(i, j int) { p[i], p[j] = p[j], p[i] }
|
|
|
|
type referrersResult struct {
|
|
query *ast.Ident // identifer of query
|
|
obj types.Object // object it denotes
|
|
refs []*ast.Ident // set of all other references to it
|
|
}
|
|
|
|
func (r *referrersResult) display(printf printfFunc) {
|
|
if r.query.Pos() != r.obj.Pos() {
|
|
printf(r.query, "reference to %s", r.obj.Name())
|
|
}
|
|
// TODO(adonovan): pretty-print object using same logic as
|
|
// (*describeValueResult).display.
|
|
printf(r.obj, "defined here as %s", r.obj)
|
|
for _, ref := range r.refs {
|
|
if r.query != ref {
|
|
printf(ref, "referenced here")
|
|
}
|
|
}
|
|
}
|
|
|
|
// TODO(adonovan): encode extent, not just Pos info, in Serial form.
|
|
|
|
func (r *referrersResult) toSerial(res *serial.Result, fset *token.FileSet) {
|
|
referrers := &serial.Referrers{
|
|
Pos: fset.Position(r.query.Pos()).String(),
|
|
Desc: r.obj.String(),
|
|
}
|
|
if pos := r.obj.Pos(); pos != token.NoPos { // Package objects have no Pos()
|
|
referrers.ObjPos = fset.Position(pos).String()
|
|
}
|
|
for _, ref := range r.refs {
|
|
referrers.Refs = append(referrers.Refs, fset.Position(ref.NamePos).String())
|
|
}
|
|
res.Referrers = referrers
|
|
}
|