mirror of
https://github.com/golang/go
synced 2024-11-19 01:44:40 -07:00
aa94e735be
Add a symbolStyle configuration option, and use it to parameterize the following behavior when computing workspace symbols: + package (default): include package name in the workspace symbol. + full: fully qualify the symbol by import path + dynamic: use as the symbol the shortest suffix of the full path that contains the match. To implement this, expose package name in the source.Package interface. To be consistent with other handling in the cache package, define a new cache.packageName named string type, to avoid confusion with packageID or packagePath (if confusing those two identifiers was a problem, surely it is a potential problem for package name as well). Change-Id: Ic8ed6ba5473b0523b97e677878e5e6bddfff10a7 Reviewed-on: https://go-review.googlesource.com/c/tools/+/236842 Run-TryBot: Robert Findley <rfindley@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Paul Jolly <paul@myitcv.org.uk>
139 lines
3.2 KiB
Go
139 lines
3.2 KiB
Go
// Copyright 2019 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 cache
|
|
|
|
import (
|
|
"go/ast"
|
|
"go/types"
|
|
|
|
"golang.org/x/tools/go/packages"
|
|
"golang.org/x/tools/internal/lsp/source"
|
|
"golang.org/x/tools/internal/span"
|
|
errors "golang.org/x/xerrors"
|
|
)
|
|
|
|
// pkg contains the type information needed by the source package.
|
|
type pkg struct {
|
|
// ID and package path have their own types to avoid being used interchangeably.
|
|
id packageID
|
|
name packageName
|
|
pkgPath packagePath
|
|
mode source.ParseMode
|
|
forTest packagePath
|
|
goFiles []*parseGoHandle
|
|
compiledGoFiles []*parseGoHandle
|
|
errors []*source.Error
|
|
imports map[packagePath]*pkg
|
|
module *packages.Module
|
|
typeErrors []types.Error
|
|
types *types.Package
|
|
typesInfo *types.Info
|
|
typesSizes types.Sizes
|
|
}
|
|
|
|
// Declare explicit types for package paths, names, and IDs to ensure that we
|
|
// never use an ID where a path belongs, and vice versa. If we confused these,
|
|
// it would result in confusing errors because package IDs often look like
|
|
// package paths.
|
|
type (
|
|
packageID string
|
|
packagePath string
|
|
packageName string
|
|
)
|
|
|
|
// Declare explicit types for files and directories to distinguish between the two.
|
|
type fileURI span.URI
|
|
type directoryURI span.URI
|
|
type viewLoadScope span.URI
|
|
|
|
func (p *pkg) ID() string {
|
|
return string(p.id)
|
|
}
|
|
|
|
func (p *pkg) Name() string {
|
|
return string(p.name)
|
|
}
|
|
|
|
func (p *pkg) PkgPath() string {
|
|
return string(p.pkgPath)
|
|
}
|
|
|
|
func (p *pkg) CompiledGoFiles() []source.ParseGoHandle {
|
|
var files []source.ParseGoHandle
|
|
for _, f := range p.compiledGoFiles {
|
|
files = append(files, f)
|
|
}
|
|
return files
|
|
}
|
|
|
|
func (p *pkg) File(uri span.URI) (source.ParseGoHandle, error) {
|
|
for _, ph := range p.compiledGoFiles {
|
|
if ph.File().URI() == uri {
|
|
return ph, nil
|
|
}
|
|
}
|
|
for _, ph := range p.goFiles {
|
|
if ph.File().URI() == uri {
|
|
return ph, nil
|
|
}
|
|
}
|
|
return nil, errors.Errorf("no ParseGoHandle for %s", uri)
|
|
}
|
|
|
|
func (p *pkg) GetSyntax() []*ast.File {
|
|
var syntax []*ast.File
|
|
for _, ph := range p.compiledGoFiles {
|
|
file, _, _, _, err := ph.Cached()
|
|
if err == nil {
|
|
syntax = append(syntax, file)
|
|
}
|
|
}
|
|
return syntax
|
|
}
|
|
|
|
func (p *pkg) GetErrors() []*source.Error {
|
|
return p.errors
|
|
}
|
|
|
|
func (p *pkg) GetTypes() *types.Package {
|
|
return p.types
|
|
}
|
|
|
|
func (p *pkg) GetTypesInfo() *types.Info {
|
|
return p.typesInfo
|
|
}
|
|
|
|
func (p *pkg) GetTypesSizes() types.Sizes {
|
|
return p.typesSizes
|
|
}
|
|
|
|
func (p *pkg) IsIllTyped() bool {
|
|
return p.types == nil || p.typesInfo == nil || p.typesSizes == nil
|
|
}
|
|
|
|
func (p *pkg) ForTest() string {
|
|
return string(p.forTest)
|
|
}
|
|
|
|
func (p *pkg) GetImport(pkgPath string) (source.Package, error) {
|
|
if imp := p.imports[packagePath(pkgPath)]; imp != nil {
|
|
return imp, nil
|
|
}
|
|
// Don't return a nil pointer because that still satisfies the interface.
|
|
return nil, errors.Errorf("no imported package for %s", pkgPath)
|
|
}
|
|
|
|
func (p *pkg) Imports() []source.Package {
|
|
var result []source.Package
|
|
for _, imp := range p.imports {
|
|
result = append(result, imp)
|
|
}
|
|
return result
|
|
}
|
|
|
|
func (p *pkg) Module() *packages.Module {
|
|
return p.module
|
|
}
|