gopls/internal/cache: rename methods on Package

Rename methods on cache.Package to eliminate unnecessary "Get" prefixes.
Also rename pkg.go to package.go.

Change-Id: I42f2fa7a18a5973a53af93c63b48c7db19cba3b2
Reviewed-on: https://go-review.googlesource.com/c/tools/+/572475
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Alan Donovan <[email protected]>

Author: findleyr

gopls/internal/cache/pkg.go renamed to gopls/internal/cache/package.go

@@ -86,6 +86,7 @@ type loadScope interface {
 	aScope()
 }
 
+// TODO(rfindley): move to load.go
 type (
 	fileLoadScope    protocol.DocumentURI // load packages containing a file (including command-line-arguments)
 	packageLoadScope string               // load a specific package (the value is its PackageID)
@@ -124,23 +125,33 @@ func (pkg *syntaxPackage) File(uri protocol.DocumentURI) (*parsego.File, error)
 	return nil, fmt.Errorf("no parsed file for %s in %v", uri, pkg.id)
 }
 
-func (p *Package) GetSyntax() []*ast.File {
+// Syntax returns parsed compiled Go files contained in this package.
+func (p *Package) Syntax() []*ast.File {
 	var syntax []*ast.File
 	for _, pgf := range p.pkg.compiledGoFiles {
 		syntax = append(syntax, pgf.File)
 	}
 	return syntax
 }
 
+// FileSet returns the FileSet describing this package's positions.
+//
+// The returned FileSet is guaranteed to describe all Syntax, but may also
+// describe additional files.
 func (p *Package) FileSet() *token.FileSet {
 	return p.pkg.fset
 }
 
-func (p *Package) GetTypes() *types.Package {
+// Types returns the type checked go/types.Package.
+func (p *Package) Types() *types.Package {
 	return p.pkg.types
 }
 
-func (p *Package) GetTypesInfo() *types.Info {
+// TypesInfo returns the go/types.Info annotating the Syntax of this package
+// with type information.
+//
+// All fields in the resulting Info are populated.
+func (p *Package) TypesInfo() *types.Info {
 	return p.pkg.typesInfo
 }
 
@@ -152,10 +163,14 @@ func (p *Package) DependencyTypes(path PackagePath) *types.Package {
 	return p.pkg.importMap[path]
 }
 
-func (p *Package) GetParseErrors() []scanner.ErrorList {
+// ParseErrors returns a slice containing all non-empty parse errors produces
+// while parsing p.Syntax, or nil if the package contains no parse errors.
+func (p *Package) ParseErrors() []scanner.ErrorList {
 	return p.pkg.parseErrors
 }
 
-func (p *Package) GetTypeErrors() []types.Error {
+// TypeErrors returns the go/types.Errors produced during type checking this
+// package, if any.
+func (p *Package) TypeErrors() []types.Error {
 	return p.pkg.typeErrors
 }

gopls/internal/golang/change_signature.go

@@ -45,7 +45,7 @@ func RemoveUnusedParameter(ctx context.Context, fh file.Handle, rng protocol.Ran
 	if err != nil {
 		return nil, err
 	}
-	if perrors, terrors := pkg.GetParseErrors(), pkg.GetTypeErrors(); len(perrors) > 0 || len(terrors) > 0 {
+	if perrors, terrors := pkg.ParseErrors(), pkg.TypeErrors(); len(perrors) > 0 || len(terrors) > 0 {
 		var sample string
 		if len(perrors) > 0 {
 			sample = perrors[0].Error()
@@ -367,7 +367,7 @@ func rewriteCalls(ctx context.Context, rw signatureRewrite) (map[protocol.Docume
 	{
 		delegate := internalastutil.CloneNode(rw.newDecl) // clone before modifying
 		delegate.Name.Name = tag + delegate.Name.Name
-		if obj := rw.pkg.GetTypes().Scope().Lookup(delegate.Name.Name); obj != nil {
+		if obj := rw.pkg.Types().Scope().Lookup(delegate.Name.Name); obj != nil {
 			return nil, fmt.Errorf("synthetic name %q conflicts with an existing declaration", delegate.Name.Name)
 		}
 
@@ -467,9 +467,9 @@ func reTypeCheck(logf func(string, ...any), orig *cache.Package, fileMask map[pr
 		var importer func(importPath string) (*types.Package, error)
 		{
 			var (
-				importsByPath = make(map[string]*types.Package)   // cached imports
-				toSearch      = []*types.Package{orig.GetTypes()} // packages to search
-				searched      = make(map[string]bool)             // path -> (false, if present in toSearch; true, if already searched)
+				importsByPath = make(map[string]*types.Package) // cached imports
+				toSearch      = []*types.Package{orig.Types()}  // packages to search
+				searched      = make(map[string]bool)           // path -> (false, if present in toSearch; true, if already searched)
 			)
 			importer = func(path string) (*types.Package, error) {
 				if p, ok := importsByPath[path]; ok {

gopls/internal/golang/code_lens.go

@@ -135,7 +135,7 @@ func matchTestFunc(fn *ast.FuncDecl, pkg *cache.Package, nameRe *regexp.Regexp,
 	if !nameRe.MatchString(fn.Name.Name) {
 		return false
 	}
-	info := pkg.GetTypesInfo()
+	info := pkg.TypesInfo()
 	if info == nil {
 		return false
 	}

gopls/internal/golang/codeaction.go

@@ -335,7 +335,7 @@ func getRewriteCodeActions(ctx context.Context, pkg *cache.Package, snapshot *ca
 	//
 	// TODO: Consider removing the inspection after convenienceAnalyzers are removed.
 	inspect := inspector.New([]*ast.File{pgf.File})
-	for _, diag := range fillstruct.Diagnose(inspect, start, end, pkg.GetTypes(), pkg.GetTypesInfo()) {
+	for _, diag := range fillstruct.Diagnose(inspect, start, end, pkg.Types(), pkg.TypesInfo()) {
 		rng, err := pgf.Mapper.PosRange(pgf.Tok, diag.Pos, diag.End)
 		if err != nil {
 			return nil, err
@@ -354,7 +354,7 @@ func getRewriteCodeActions(ctx context.Context, pkg *cache.Package, snapshot *ca
 		}
 	}
 
-	for _, diag := range fillswitch.Diagnose(inspect, start, end, pkg.GetTypes(), pkg.GetTypesInfo()) {
+	for _, diag := range fillswitch.Diagnose(inspect, start, end, pkg.Types(), pkg.TypesInfo()) {
 		edits, err := suggestedFixToEdits(ctx, snapshot, pkg.FileSet(), &diag.SuggestedFixes[0])
 		if err != nil {
 			return nil, err
@@ -413,14 +413,14 @@ func canRemoveParameter(pkg *cache.Package, pgf *parsego.File, rng protocol.Rang
 		return true // trivially unused
 	}
 
-	obj := pkg.GetTypesInfo().Defs[info.Name]
+	obj := pkg.TypesInfo().Defs[info.Name]
 	if obj == nil {
 		return false // something went wrong
 	}
 
 	used := false
 	ast.Inspect(info.Decl.Body, func(node ast.Node) bool {
-		if n, ok := node.(*ast.Ident); ok && pkg.GetTypesInfo().Uses[n] == obj {
+		if n, ok := node.(*ast.Ident); ok && pkg.TypesInfo().Uses[n] == obj {
 			used = true
 		}
 		return !used // keep going until we find a use

gopls/internal/golang/completion/builtin.go

@@ -82,7 +82,7 @@ func (c *completer) builtinArgType(obj types.Object, call *ast.CallExpr, parentI
 		// For non-initial append() args, infer slice type from the first
 		// append() arg, or from parent context.
 		if len(call.Args) > 0 {
-			inf.objType = c.pkg.GetTypesInfo().TypeOf(call.Args[0])
+			inf.objType = c.pkg.TypesInfo().TypeOf(call.Args[0])
 		}
 		if inf.objType == nil {
 			inf.objType = parentInf.objType
@@ -98,13 +98,13 @@ func (c *completer) builtinArgType(obj types.Object, call *ast.CallExpr, parentI
 
 		// Penalize the first append() argument as a candidate. You
 		// don't normally append a slice to itself.
-		if sliceChain := objChain(c.pkg.GetTypesInfo(), call.Args[0]); len(sliceChain) > 0 {
+		if sliceChain := objChain(c.pkg.TypesInfo(), call.Args[0]); len(sliceChain) > 0 {
 			inf.penalized = append(inf.penalized, penalizedObj{objChain: sliceChain, penalty: 0.9})
 		}
 	case "delete":
 		if exprIdx > 0 && len(call.Args) > 0 {
 			// Try to fill in expected type of map key.
-			firstArgType := c.pkg.GetTypesInfo().TypeOf(call.Args[0])
+			firstArgType := c.pkg.TypesInfo().TypeOf(call.Args[0])
 			if firstArgType != nil {
 				if mt, ok := firstArgType.Underlying().(*types.Map); ok {
 					inf.objType = mt.Key()
@@ -114,9 +114,9 @@ func (c *completer) builtinArgType(obj types.Object, call *ast.CallExpr, parentI
 	case "copy":
 		var t1, t2 types.Type
 		if len(call.Args) > 0 {
-			t1 = c.pkg.GetTypesInfo().TypeOf(call.Args[0])
+			t1 = c.pkg.TypesInfo().TypeOf(call.Args[0])
 			if len(call.Args) > 1 {
-				t2 = c.pkg.GetTypesInfo().TypeOf(call.Args[1])
+				t2 = c.pkg.TypesInfo().TypeOf(call.Args[1])
 			}
 		}