gopls/internal/protocol: add DocumentURI.Base accessor

...and use it everywhere.

Change-Id: Ib2d59840a7dbbdfc48a62edbf7264ae3e9502378
Reviewed-on: https://go-review.googlesource.com/c/tools/+/678758
LUCI-TryBot-Result: Go LUCI <[email protected]>
Auto-Submit: Alan Donovan <[email protected]>
Reviewed-by: Robert Findley <[email protected]>

Author: adonovan

gopls/internal/cache/snapshot.go

@@ -1421,7 +1421,7 @@ https://github.com/golang/tools/blob/master/gopls/doc/workspace.md.`, modDir, fi
 					fix = `This file may be excluded due to its build tags; try adding "-tags=<build tag>" to your gopls "buildFlags" configuration
 See the documentation for more information on working with build tags:
 https://github.com/golang/tools/blob/master/gopls/doc/settings.md#buildflags.`
-				} else if strings.Contains(filepath.Base(fh.URI().Path()), "_") {
+				} else if strings.Contains(fh.URI().Base(), "_") {
 					fix = `This file may be excluded due to its GOOS/GOARCH, or other build constraints.`
 				} else {
 					fix = `This file is ignored by your gopls build.` // we don't know why

gopls/internal/cache/workspace.go

@@ -18,7 +18,7 @@ import (
 
 // isGoWork reports if uri is a go.work file.
 func isGoWork(uri protocol.DocumentURI) bool {
-	return filepath.Base(uri.Path()) == "go.work"
+	return uri.Base() == "go.work"
 }
 
 // goWorkModules returns the URIs of go.mod files named by the go.work file.
@@ -63,7 +63,7 @@ func localModFiles(relativeTo string, goWorkOrModPaths []string) map[protocol.Do
 
 // isGoMod reports if uri is a go.mod file.
 func isGoMod(uri protocol.DocumentURI) bool {
-	return filepath.Base(uri.Path()) == "go.mod"
+	return uri.Base() == "go.mod"
 }
 
 // isWorkspaceFile reports if uri matches a set of globs defined in workspaceFiles

gopls/internal/cmd/cmd.go

@@ -903,7 +903,7 @@ func (f *cmdFile) spanRange(s span) (protocol.Range, error) {
 	// case-sensitive directories. The authoritative answer
 	// requires querying the file system, and we don't want
 	// to do that.
-	if !strings.EqualFold(filepath.Base(string(f.mapper.URI)), filepath.Base(string(s.URI()))) {
+	if !strings.EqualFold(f.mapper.URI.Base(), s.URI().Base()) {
 		return protocol.Range{}, bugpkg.Errorf("mapper is for file %q instead of %q", f.mapper.URI, s.URI())
 	}
 	start, err := pointPosition(f.mapper, s.Start())

gopls/internal/golang/addtest.go

@@ -265,7 +265,7 @@ func AddTestForFunc(ctx context.Context, snapshot *cache.Snapshot, loc protocol.
 		return nil, err
 	}
 
-	testBase := strings.TrimSuffix(filepath.Base(loc.URI.Path()), ".go") + "_test.go"
+	testBase := strings.TrimSuffix(loc.URI.Base(), ".go") + "_test.go"
 	goTestFileURI := protocol.URIFromPath(filepath.Join(loc.URI.DirPath(), testBase))
 
 	testFH, err := snapshot.ReadFile(ctx, goTestFileURI)

gopls/internal/golang/call_hierarchy.go

@@ -11,7 +11,6 @@ import (
 	"go/ast"
 	"go/token"
 	"go/types"
-	"path/filepath"
 
 	"golang.org/x/tools/go/ast/astutil"
 	"golang.org/x/tools/go/types/typeutil"
@@ -59,7 +58,7 @@ func PrepareCallHierarchy(ctx context.Context, snapshot *cache.Snapshot, fh file
 		Name:           obj.Name(),
 		Kind:           protocol.Function,
 		Tags:           []protocol.SymbolTag{},
-		Detail:         fmt.Sprintf("%s • %s", obj.Pkg().Path(), filepath.Base(declLoc.URI.Path())),
+		Detail:         fmt.Sprintf("%s • %s", obj.Pkg().Path(), declLoc.URI.Base()),
 		URI:            declLoc.URI,
 		Range:          rng,
 		SelectionRange: rng,
@@ -182,7 +181,7 @@ func enclosingNodeCallItem(ctx context.Context, snapshot *cache.Snapshot, pkgPat
 		Name:           name,
 		Kind:           kind,
 		Tags:           []protocol.SymbolTag{},
-		Detail:         fmt.Sprintf("%s • %s", pkgPath, filepath.Base(fh.URI().Path())),
+		Detail:         fmt.Sprintf("%s • %s", pkgPath, fh.URI().Base()),
 		URI:            loc.URI,
 		Range:          rng,
 		SelectionRange: rng,
@@ -283,7 +282,7 @@ func OutgoingCalls(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle
 					Name:           obj.Name(),
 					Kind:           protocol.Function,
 					Tags:           []protocol.SymbolTag{},
-					Detail:         fmt.Sprintf("%s • %s", obj.Pkg().Path(), filepath.Base(loc.URI.Path())),
+					Detail:         fmt.Sprintf("%s • %s", obj.Pkg().Path(), loc.URI.Base()),
 					URI:            loc.URI,
 					Range:          loc.Range,
 					SelectionRange: loc.Range,

gopls/internal/golang/codeaction.go

@@ -11,7 +11,6 @@ import (
 	"go/ast"
 	"go/token"
 	"go/types"
-	"path/filepath"
 	"reflect"
 	"slices"
 	"strings"
@@ -1108,7 +1107,7 @@ func toggleCompilerOptDetails(ctx context.Context, req *codeActionsRequest) erro
 
 		title := fmt.Sprintf("%s compiler optimization details for %q",
 			cond(req.snapshot.WantCompilerOptDetails(dir), "Hide", "Show"),
-			filepath.Base(dir.Path()))
+			dir.Base())
 		cmd := command.NewGCDetailsCommand(title, req.fh.URI())
 		req.addCommandAction(cmd, false)
 	}

gopls/internal/mcp/context.go

@@ -13,7 +13,6 @@ import (
 	"fmt"
 	"go/ast"
 	"go/token"
-	"path/filepath"
 	"slices"
 	"strings"
 
@@ -58,7 +57,7 @@ func contextHandler(ctx context.Context, session *cache.Session, params *mcp.Cal
 	fmt.Fprintf(&result, "Current package %q (package %s) declares the following symbols:\n\n", pkg.Metadata().PkgPath, pkg.Metadata().Name)
 	// Write context of the current file.
 	{
-		fmt.Fprintf(&result, "%s (current file):\n", filepath.Base(pgf.URI.Path()))
+		fmt.Fprintf(&result, "%s (current file):\n", pgf.URI.Base())
 		result.WriteString("--->\n")
 		if err := writeFileSummary(ctx, snapshot, pgf.URI, &result, false); err != nil {
 			return nil, err
@@ -73,7 +72,7 @@ func contextHandler(ctx context.Context, session *cache.Session, params *mcp.Cal
 				continue
 			}
 
-			fmt.Fprintf(&result, "%s:\n", filepath.Base(file.URI.Path()))
+			fmt.Fprintf(&result, "%s:\n", file.URI.Base())
 			result.WriteString("--->\n")
 			if err := writeFileSummary(ctx, snapshot, file.URI, &result, false); err != nil {
 				return nil, err
@@ -86,7 +85,7 @@ func contextHandler(ctx context.Context, session *cache.Session, params *mcp.Cal
 	if len(pgf.File.Imports) > 0 {
 		// Write import decls of the current file.
 		{
-			fmt.Fprintf(&result, "Current file %q contains this import declaration:\n", filepath.Base(pgf.URI.Path()))
+			fmt.Fprintf(&result, "Current file %q contains this import declaration:\n", pgf.URI.Base())
 			result.WriteString("--->\n")
 			// Add all import decl to output including all floating comment by
 			// using GenDecl's start and end position.
@@ -127,7 +126,7 @@ func contextHandler(ctx context.Context, session *cache.Session, params *mcp.Cal
 
 				fmt.Fprintf(&result, "%q (package %s)\n", importPath, impMetadata.Name)
 				for _, f := range impMetadata.CompiledGoFiles {
-					fmt.Fprintf(&result, "%s:\n", filepath.Base(f.Path()))
+					fmt.Fprintf(&result, "%s:\n", f.Base())
 					result.WriteString("--->\n")
 					if err := writeFileSummary(ctx, snapshot, f, &result, true); err != nil {
 						return nil, err

gopls/internal/protocol/uri.go

@@ -91,6 +91,11 @@ func (uri DocumentURI) Path() string {
 	return filepath.FromSlash(filename)
 }
 
+// Base returns the base name of the file path of the given URI.
+func (uri DocumentURI) Base() string {
+	return filepath.Base(uri.Path())
+}
+
 // Dir returns the URI for the directory containing the receiver.
 func (uri DocumentURI) Dir() DocumentURI {
 	// This function could be more efficiently implemented by avoiding any call

gopls/internal/server/command.go

@@ -91,7 +91,7 @@ func (h *commandHandler) Modules(ctx context.Context, args command.ModulesArgs)
 			return false // "can't happen" (see prior Encloses check)
 		}
 
-		assert(filepath.Base(goMod.Path()) == "go.mod", fmt.Sprintf("invalid go.mod path: want go.mod, got %q", goMod.Path()))
+		assert(goMod.Base() == "go.mod", fmt.Sprintf("invalid go.mod path: want go.mod, got %q", goMod.Path()))
 
 		// Invariant: rel is a relative path without "../" segments and the last
 		// segment is "go.mod"

gopls/internal/server/text_synchronization.go

@@ -168,8 +168,7 @@ func (s *server) warnAboutModifyingGeneratedFiles(ctx context.Context, uri proto
 	isGenerated := golang.IsGenerated(ctx, snapshot, uri)
 	release()
 	if isGenerated {
-		msg := fmt.Sprintf("Warning: editing %s, a generated file.",
-			filepath.Base(uri.Path()))
+		msg := fmt.Sprintf("Warning: editing %s, a generated file.", uri.Base())
 		showMessage(ctx, s.client, protocol.Warning, msg)
 	}
 	return nil

gopls/internal/test/integration/misc/definition_test.go

@@ -637,7 +637,7 @@ var _ = foo(123) // call
 		env.OpenFile("a.go")
 
 		locString := func(loc protocol.Location) string {
-			return fmt.Sprintf("%s:%s", filepath.Base(loc.URI.Path()), loc.Range)
+			return fmt.Sprintf("%s:%s", loc.URI.Base(), loc.Range)
 		}
 
 		// Definition at the call"foo(123)" takes us to the Go declaration.

gopls/internal/test/integration/modfile/modfile_test.go

@@ -6,7 +6,6 @@ package modfile
 
 import (
 	"os"
-	"path/filepath"
 	"runtime"
 	"strings"
 	"testing"
@@ -870,7 +869,7 @@ func hello() {}
 		// Confirm that we still have metadata with only on-disk edits.
 		env.OpenFile("main.go")
 		loc := env.FirstDefinition(env.RegexpSearch("main.go", "hello"))
-		if filepath.Base(string(loc.URI)) != "hello.go" {
+		if loc.URI.Base() != "hello.go" {
 			t.Fatalf("expected definition in hello.go, got %s", loc.URI)
 		}
 		// Confirm that we no longer have metadata when the file is saved.