diff --git a/blog/blog.go b/blog/blog.go
index 947c60e95a2..901b53f440e 100644
--- a/blog/blog.go
+++ b/blog/blog.go
@@ -420,7 +420,7 @@ type rootData struct {
BasePath string
GodocURL string
AnalyticsHTML template.HTML
- Data interface{}
+ Data any
}
// ServeHTTP serves the front, index, and article pages
diff --git a/cmd/bundle/gotypesalias.go b/cmd/bundle/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/cmd/bundle/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/cmd/callgraph/gotypesalias.go b/cmd/callgraph/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/cmd/callgraph/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/cmd/callgraph/main.go b/cmd/callgraph/main.go
index 9e440bbafb9..e489de883d0 100644
--- a/cmd/callgraph/main.go
+++ b/cmd/callgraph/main.go
@@ -148,10 +148,7 @@ func init() {
// If $GOMAXPROCS isn't set, use the full capacity of the machine.
// For small machines, use at least 4 threads.
if os.Getenv("GOMAXPROCS") == "" {
- n := runtime.NumCPU()
- if n < 4 {
- n = 4
- }
+ n := max(runtime.NumCPU(), 4)
runtime.GOMAXPROCS(n)
}
}
diff --git a/cmd/callgraph/main_test.go b/cmd/callgraph/main_test.go
index ce634139e68..3b56cd7ffef 100644
--- a/cmd/callgraph/main_test.go
+++ b/cmd/callgraph/main_test.go
@@ -5,7 +5,6 @@
// No testdata on Android.
//go:build !android && go1.11
-// +build !android,go1.11
package main
diff --git a/cmd/deadcode/deadcode.go b/cmd/deadcode/deadcode.go
index f129102cc4c..e164dc22ba8 100644
--- a/cmd/deadcode/deadcode.go
+++ b/cmd/deadcode/deadcode.go
@@ -15,11 +15,13 @@ import (
"go/types"
"io"
"log"
+ "maps"
"os"
"path/filepath"
"regexp"
"runtime"
"runtime/pprof"
+ "slices"
"sort"
"strings"
"text/template"
@@ -175,7 +177,7 @@ func main() {
}
}
- if isGenerated(file) {
+ if ast.IsGenerated(file) {
generated[p.Fset.File(file.Pos()).Name()] = true
}
}
@@ -290,9 +292,7 @@ func main() {
// Build array of jsonPackage objects.
var packages []any
- pkgpaths := keys(byPkgPath)
- sort.Strings(pkgpaths)
- for _, pkgpath := range pkgpaths {
+ for _, pkgpath := range slices.Sorted(maps.Keys(byPkgPath)) {
if !filter.MatchString(pkgpath) {
continue
}
@@ -303,7 +303,7 @@ func main() {
// declaration order. This tends to keep related
// methods such as (T).Marshal and (*T).Unmarshal
// together better than sorting.
- fns := keys(m)
+ fns := slices.Collect(maps.Keys(m))
sort.Slice(fns, func(i, j int) bool {
xposn := prog.Fset.Position(fns[i].Pos())
yposn := prog.Fset.Position(fns[j].Pos())
@@ -368,7 +368,7 @@ func prettyName(fn *ssa.Function, qualified bool) string {
// anonymous?
if fn.Parent() != nil {
format(fn.Parent())
- i := index(fn.Parent().AnonFuncs, fn)
+ i := slices.Index(fn.Parent().AnonFuncs, fn)
fmt.Fprintf(&buf, "$%d", i+1)
return
}
@@ -414,45 +414,6 @@ func printObjects(format string, objects []any) {
}
}
-// TODO(adonovan): use go1.21's ast.IsGenerated.
-
-// isGenerated reports whether the file was generated by a program,
-// not handwritten, by detecting the special comment described
-// at https://go.dev/s/generatedcode.
-//
-// The syntax tree must have been parsed with the ParseComments flag.
-// Example:
-//
-// f, err := parser.ParseFile(fset, filename, src, parser.ParseComments|parser.PackageClauseOnly)
-// if err != nil { ... }
-// gen := ast.IsGenerated(f)
-func isGenerated(file *ast.File) bool {
- _, ok := generator(file)
- return ok
-}
-
-func generator(file *ast.File) (string, bool) {
- for _, group := range file.Comments {
- for _, comment := range group.List {
- if comment.Pos() > file.Package {
- break // after package declaration
- }
- // opt: check Contains first to avoid unnecessary array allocation in Split.
- const prefix = "// Code generated "
- if strings.Contains(comment.Text, prefix) {
- for _, line := range strings.Split(comment.Text, "\n") {
- if rest, ok := strings.CutPrefix(line, prefix); ok {
- if gen, ok := strings.CutSuffix(rest, " DO NOT EDIT."); ok {
- return gen, true
- }
- }
- }
- }
- }
- }
- return "", false
-}
-
// pathSearch returns the shortest path from one of the roots to one
// of the targets (along with the root itself), or zero if no path was found.
func pathSearch(roots []*ssa.Function, res *rta.Result, targets map[*ssa.Function]bool) (*callgraph.Node, []*callgraph.Edge) {
@@ -466,7 +427,7 @@ func pathSearch(roots []*ssa.Function, res *rta.Result, targets map[*ssa.Functio
// Sort roots into preferred order.
importsTesting := func(fn *ssa.Function) bool {
isTesting := func(p *types.Package) bool { return p.Path() == "testing" }
- return containsFunc(fn.Pkg.Pkg.Imports(), isTesting)
+ return slices.ContainsFunc(fn.Pkg.Pkg.Imports(), isTesting)
}
sort.Slice(roots, func(i, j int) bool {
x, y := roots[i], roots[j]
@@ -500,7 +461,7 @@ func pathSearch(roots []*ssa.Function, res *rta.Result, targets map[*ssa.Functio
for {
edge := seen[node]
if edge == nil {
- reverse(path)
+ slices.Reverse(path)
return path
}
path = append(path, edge)
@@ -604,43 +565,3 @@ type jsonPosition struct {
func (p jsonPosition) String() string {
return fmt.Sprintf("%s:%d:%d", p.File, p.Line, p.Col)
}
-
-// -- from the future --
-
-// TODO(adonovan): use go1.22's slices and maps packages.
-
-func containsFunc[S ~[]E, E any](s S, f func(E) bool) bool {
- return indexFunc(s, f) >= 0
-}
-
-func indexFunc[S ~[]E, E any](s S, f func(E) bool) int {
- for i := range s {
- if f(s[i]) {
- return i
- }
- }
- return -1
-}
-
-func index[S ~[]E, E comparable](s S, v E) int {
- for i := range s {
- if v == s[i] {
- return i
- }
- }
- return -1
-}
-
-func reverse[S ~[]E, E any](s S) {
- for i, j := 0, len(s)-1; i < j; i, j = i+1, j-1 {
- s[i], s[j] = s[j], s[i]
- }
-}
-
-func keys[M ~map[K]V, K comparable, V any](m M) []K {
- r := make([]K, 0, len(m))
- for k := range m {
- r = append(r, k)
- }
- return r
-}
diff --git a/cmd/deadcode/deadcode_test.go b/cmd/deadcode/deadcode_test.go
index 90c067331dc..a9b8327c7d7 100644
--- a/cmd/deadcode/deadcode_test.go
+++ b/cmd/deadcode/deadcode_test.go
@@ -34,7 +34,6 @@ func Test(t *testing.T) {
t.Fatal(err)
}
for _, filename := range matches {
- filename := filename
t.Run(filename, func(t *testing.T) {
t.Parallel()
diff --git a/cmd/deadcode/gotypesalias.go b/cmd/deadcode/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/cmd/deadcode/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/cmd/eg/gotypesalias.go b/cmd/eg/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/cmd/eg/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/cmd/file2fuzz/main.go b/cmd/file2fuzz/main.go
index 2a86c2ece88..f9d4708cd28 100644
--- a/cmd/file2fuzz/main.go
+++ b/cmd/file2fuzz/main.go
@@ -34,7 +34,7 @@ import (
var encVersion1 = "go test fuzz v1"
func encodeByteSlice(b []byte) []byte {
- return []byte(fmt.Sprintf("%s\n[]byte(%q)", encVersion1, b))
+ return fmt.Appendf(nil, "%s\n[]byte(%q)", encVersion1, b)
}
func usage() {
diff --git a/cmd/fiximports/main_test.go b/cmd/fiximports/main_test.go
index ebbd7520d2e..69f8726f135 100644
--- a/cmd/fiximports/main_test.go
+++ b/cmd/fiximports/main_test.go
@@ -5,7 +5,6 @@
// No testdata on Android.
//go:build !android
-// +build !android
package main
diff --git a/cmd/go-contrib-init/contrib.go b/cmd/go-contrib-init/contrib.go
index 9254b86388f..0ab93c90f73 100644
--- a/cmd/go-contrib-init/contrib.go
+++ b/cmd/go-contrib-init/contrib.go
@@ -160,44 +160,6 @@ GOPATH: %s
}
return
}
-
- gopath := firstGoPath()
- if gopath == "" {
- log.Fatal("Your GOPATH is not set, please set it")
- }
-
- rightdir := filepath.Join(gopath, "src", "golang.org", "x", *repo)
- if !strings.HasPrefix(wd, rightdir) {
- dirExists, err := exists(rightdir)
- if err != nil {
- log.Fatal(err)
- }
- if !dirExists {
- log.Fatalf("The repo you want to work on is currently not on your system.\n"+
- "Run %q to obtain this repo\n"+
- "then go to the directory %q\n",
- "go get -d golang.org/x/"+*repo, rightdir)
- }
- log.Fatalf("Your current directory is:%q\n"+
- "Working on golang/x/%v requires you be in %q\n",
- wd, *repo, rightdir)
- }
-}
-
-func firstGoPath() string {
- list := filepath.SplitList(build.Default.GOPATH)
- if len(list) < 1 {
- return ""
- }
- return list[0]
-}
-
-func exists(path string) (bool, error) {
- _, err := os.Stat(path)
- if os.IsNotExist(err) {
- return false, nil
- }
- return true, err
}
func inGoPath(wd string) bool {
diff --git a/cmd/godex/gotypesalias.go b/cmd/godex/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/cmd/godex/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/cmd/godex/isAlias18.go b/cmd/godex/isAlias18.go
index 431602b2243..f1f78731d4c 100644
--- a/cmd/godex/isAlias18.go
+++ b/cmd/godex/isAlias18.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build !go1.9
-// +build !go1.9
package main
diff --git a/cmd/godex/isAlias19.go b/cmd/godex/isAlias19.go
index e5889119fa1..db29555fd8c 100644
--- a/cmd/godex/isAlias19.go
+++ b/cmd/godex/isAlias19.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build go1.9
-// +build go1.9
package main
diff --git a/cmd/godex/writetype.go b/cmd/godex/writetype.go
index 866f718f05f..f59760a81c6 100644
--- a/cmd/godex/writetype.go
+++ b/cmd/godex/writetype.go
@@ -14,6 +14,7 @@ package main
import (
"go/types"
+ "slices"
)
func (p *printer) writeType(this *types.Package, typ types.Type) {
@@ -28,11 +29,9 @@ func (p *printer) writeTypeInternal(this *types.Package, typ types.Type, visited
// practice deeply nested composite types with unnamed component
// types are uncommon. This code is likely more efficient than
// using a map.
- for _, t := range visited {
- if t == typ {
- p.printf("○%T", typ) // cycle to typ
- return
- }
+ if slices.Contains(visited, typ) {
+ p.printf("○%T", typ) // cycle to typ
+ return
}
visited = append(visited, typ)
@@ -72,7 +71,7 @@ func (p *printer) writeTypeInternal(this *types.Package, typ types.Type, visited
p.print("struct {\n")
p.indent++
- for i := 0; i < n; i++ {
+ for i := range n {
f := t.Field(i)
if !f.Anonymous() {
p.printf("%s ", f.Name())
@@ -120,7 +119,7 @@ func (p *printer) writeTypeInternal(this *types.Package, typ types.Type, visited
if GcCompatibilityMode {
// print flattened interface
// (useful to compare against gc-generated interfaces)
- for i := 0; i < n; i++ {
+ for i := range n {
m := t.Method(i)
p.print(m.Name())
p.writeSignatureInternal(this, m.Type().(*types.Signature), visited)
diff --git a/cmd/godoc/godoc_test.go b/cmd/godoc/godoc_test.go
index 66b93f10630..7cd38574233 100644
--- a/cmd/godoc/godoc_test.go
+++ b/cmd/godoc/godoc_test.go
@@ -16,6 +16,7 @@ import (
"os/exec"
"regexp"
"runtime"
+ "slices"
"strings"
"sync"
"testing"
@@ -127,12 +128,7 @@ func waitForServer(t *testing.T, ctx context.Context, url, match string, reverse
// hasTag checks whether a given release tag is contained in the current version
// of the go binary.
func hasTag(t string) bool {
- for _, v := range build.Default.ReleaseTags {
- if t == v {
- return true
- }
- }
- return false
+ return slices.Contains(build.Default.ReleaseTags, t)
}
func TestURL(t *testing.T) {
diff --git a/cmd/godoc/gotypesalias.go b/cmd/godoc/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/cmd/godoc/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/cmd/godoc/main.go b/cmd/godoc/main.go
index a665be0769d..1bce091f269 100644
--- a/cmd/godoc/main.go
+++ b/cmd/godoc/main.go
@@ -114,7 +114,7 @@ func loggingHandler(h http.Handler) http.Handler {
func handleURLFlag() {
// Try up to 10 fetches, following redirects.
urlstr := *urlFlag
- for i := 0; i < 10; i++ {
+ for range 10 {
// Prepare request.
u, err := url.Parse(urlstr)
if err != nil {
diff --git a/cmd/goimports/goimports.go b/cmd/goimports/goimports.go
index dcb5023a2e7..11f56e0e865 100644
--- a/cmd/goimports/goimports.go
+++ b/cmd/goimports/goimports.go
@@ -361,8 +361,8 @@ func replaceTempFilename(diff []byte, filename string) ([]byte, error) {
}
// Always print filepath with slash separator.
f := filepath.ToSlash(filename)
- bs[0] = []byte(fmt.Sprintf("--- %s%s", f+".orig", t0))
- bs[1] = []byte(fmt.Sprintf("+++ %s%s", f, t1))
+ bs[0] = fmt.Appendf(nil, "--- %s%s", f+".orig", t0)
+ bs[1] = fmt.Appendf(nil, "+++ %s%s", f, t1)
return bytes.Join(bs, []byte{'\n'}), nil
}
diff --git a/cmd/goimports/goimports_gc.go b/cmd/goimports/goimports_gc.go
index 3326646d035..3a88482fe8d 100644
--- a/cmd/goimports/goimports_gc.go
+++ b/cmd/goimports/goimports_gc.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build gc
-// +build gc
package main
diff --git a/cmd/goimports/goimports_not_gc.go b/cmd/goimports/goimports_not_gc.go
index 344fe7576b0..21dc77920be 100644
--- a/cmd/goimports/goimports_not_gc.go
+++ b/cmd/goimports/goimports_not_gc.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build !gc
-// +build !gc
package main
diff --git a/cmd/goimports/gotypesalias.go b/cmd/goimports/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/cmd/goimports/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/cmd/gomvpkg/gotypesalias.go b/cmd/gomvpkg/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/cmd/gomvpkg/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/cmd/gotype/gotypesalias.go b/cmd/gotype/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/cmd/gotype/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/cmd/gotype/sizesFor18.go b/cmd/gotype/sizesFor18.go
index 39e3d9f047e..15d2355ca42 100644
--- a/cmd/gotype/sizesFor18.go
+++ b/cmd/gotype/sizesFor18.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build !go1.9
-// +build !go1.9
// This file contains a copy of the implementation of types.SizesFor
// since this function is not available in go/types before Go 1.9.
diff --git a/cmd/gotype/sizesFor19.go b/cmd/gotype/sizesFor19.go
index 34181c8d04d..c46bb777024 100644
--- a/cmd/gotype/sizesFor19.go
+++ b/cmd/gotype/sizesFor19.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build go1.9
-// +build go1.9
package main
diff --git a/cmd/goyacc/yacc.go b/cmd/goyacc/yacc.go
index 965a76f14dc..be084da3690 100644
--- a/cmd/goyacc/yacc.go
+++ b/cmd/goyacc/yacc.go
@@ -1478,7 +1478,7 @@ func symnam(i int) string {
// set elements 0 through n-1 to c
func aryfil(v []int, n, c int) {
- for i := 0; i < n; i++ {
+ for i := range n {
v[i] = c
}
}
@@ -1840,7 +1840,7 @@ func closure(i int) {
nexts:
// initially fill the sets
- for s := 0; s < n; s++ {
+ for s := range n {
prd := curres[s]
//
@@ -2609,7 +2609,7 @@ func callopt() {
if adb > 2 {
for p = 0; p <= maxa; p += 10 {
fmt.Fprintf(ftable, "%v ", p)
- for i = 0; i < 10; i++ {
+ for i = range 10 {
fmt.Fprintf(ftable, "%v ", amem[p+i])
}
ftable.WriteRune('\n')
@@ -2653,7 +2653,7 @@ func gin(i int) {
// now, find amem place for it
nextgp:
- for p := 0; p < ACTSIZE; p++ {
+ for p := range ACTSIZE {
if amem[p] != 0 {
continue
}
@@ -3117,7 +3117,7 @@ func aryeq(a []int, b []int) int {
if len(b) != n {
return 0
}
- for ll := 0; ll < n; ll++ {
+ for ll := range n {
if a[ll] != b[ll] {
return 0
}
diff --git a/cmd/html2article/conv.go b/cmd/html2article/conv.go
index 604bb1fd7cd..e2946431ce2 100644
--- a/cmd/html2article/conv.go
+++ b/cmd/html2article/conv.go
@@ -16,6 +16,7 @@ import (
"net/url"
"os"
"regexp"
+ "slices"
"strings"
"golang.org/x/net/html"
@@ -270,10 +271,8 @@ func hasClass(name string) selector {
return func(n *html.Node) bool {
for _, a := range n.Attr {
if a.Key == "class" {
- for _, c := range strings.Fields(a.Val) {
- if c == name {
- return true
- }
+ if slices.Contains(strings.Fields(a.Val), name) {
+ return true
}
}
}
diff --git a/cmd/present/main.go b/cmd/present/main.go
index 340025276f9..99ed838e926 100644
--- a/cmd/present/main.go
+++ b/cmd/present/main.go
@@ -73,8 +73,8 @@ func main() {
origin := &url.URL{Scheme: "http"}
if *originHost != "" {
- if strings.HasPrefix(*originHost, "https://") {
- *originHost = strings.TrimPrefix(*originHost, "https://")
+ if after, ok := strings.CutPrefix(*originHost, "https://"); ok {
+ *originHost = after
origin.Scheme = "https"
}
*originHost = strings.TrimPrefix(*originHost, "http://")
diff --git a/cmd/present2md/main.go b/cmd/present2md/main.go
index a11e57ecf8b..e23bb33daed 100644
--- a/cmd/present2md/main.go
+++ b/cmd/present2md/main.go
@@ -447,10 +447,10 @@ func parseInlineLink(s string) (link string, length int) {
// If the URL is http://foo.com, drop the http://
// In other words, render [[http://golang.org]] as:
// golang.org
- if strings.HasPrefix(rawURL, url.Scheme+"://") {
- simpleURL = strings.TrimPrefix(rawURL, url.Scheme+"://")
- } else if strings.HasPrefix(rawURL, url.Scheme+":") {
- simpleURL = strings.TrimPrefix(rawURL, url.Scheme+":")
+ if after, ok := strings.CutPrefix(rawURL, url.Scheme+"://"); ok {
+ simpleURL = after
+ } else if after, ok := strings.CutPrefix(rawURL, url.Scheme+":"); ok {
+ simpleURL = after
}
}
return renderLink(rawURL, simpleURL), end + 2
diff --git a/cmd/signature-fuzzer/internal/fuzz-generator/gen_test.go b/cmd/signature-fuzzer/internal/fuzz-generator/gen_test.go
index 4bd5bab7c38..f10a7e9a7df 100644
--- a/cmd/signature-fuzzer/internal/fuzz-generator/gen_test.go
+++ b/cmd/signature-fuzzer/internal/fuzz-generator/gen_test.go
@@ -35,7 +35,7 @@ func mkGenState() *genstate {
func TestBasic(t *testing.T) {
checkTunables(tunables)
s := mkGenState()
- for i := 0; i < 1000; i++ {
+ for i := range 1000 {
s.wr = NewWrapRand(int64(i), RandCtlChecks|RandCtlPanic)
fp := s.GenFunc(i, i)
var buf bytes.Buffer
@@ -58,7 +58,7 @@ func TestMoreComplicated(t *testing.T) {
checkTunables(tunables)
s := mkGenState()
- for i := 0; i < 10000; i++ {
+ for i := range 10000 {
s.wr = NewWrapRand(int64(i), RandCtlChecks|RandCtlPanic)
fp := s.GenFunc(i, i)
var buf bytes.Buffer
diff --git a/cmd/signature-fuzzer/internal/fuzz-generator/generator.go b/cmd/signature-fuzzer/internal/fuzz-generator/generator.go
index 6c8002f9f0c..261dd6c029b 100644
--- a/cmd/signature-fuzzer/internal/fuzz-generator/generator.go
+++ b/cmd/signature-fuzzer/internal/fuzz-generator/generator.go
@@ -48,6 +48,7 @@ import (
"os"
"os/exec"
"path/filepath"
+ "slices"
"strconv"
"strings"
)
@@ -561,12 +562,7 @@ func (s *genstate) popTunables() {
// See precludeSelectedTypes below for more info.
func (s *genstate) redistributeFraction(toIncorporate uint8, avoid []int) {
inavoid := func(j int) bool {
- for _, k := range avoid {
- if j == k {
- return true
- }
- }
- return false
+ return slices.Contains(avoid, j)
}
doredis := func() {
@@ -631,7 +627,7 @@ func (s *genstate) GenParm(f *funcdef, depth int, mkctl bool, pidx int) parm {
// Convert tf into a cumulative sum
tf := s.tunables.typeFractions
sum := uint8(0)
- for i := 0; i < len(tf); i++ {
+ for i := range len(tf) {
sum += tf[i]
tf[i] = sum
}
@@ -662,7 +658,7 @@ func (s *genstate) GenParm(f *funcdef, depth int, mkctl bool, pidx int) parm {
f.structdefs = append(f.structdefs, sp)
tnf := int64(s.tunables.nStructFields) / int64(depth+1)
nf := int(s.wr.Intn(tnf))
- for fi := 0; fi < nf; fi++ {
+ for range nf {
fp := s.GenParm(f, depth+1, false, pidx)
skComp := tunables.doSkipCompare &&
uint8(s.wr.Intn(100)) < s.tunables.skipCompareFraction
@@ -832,7 +828,7 @@ func (s *genstate) GenFunc(fidx int, pidx int) *funcdef {
needControl := f.recur
f.dodefc = uint8(s.wr.Intn(100))
pTaken := uint8(s.wr.Intn(100)) < s.tunables.takenFraction
- for pi := 0; pi < numParams; pi++ {
+ for range numParams {
newparm := s.GenParm(f, 0, needControl, pidx)
if !pTaken {
newparm.SetAddrTaken(notAddrTaken)
@@ -848,7 +844,7 @@ func (s *genstate) GenFunc(fidx int, pidx int) *funcdef {
}
rTaken := uint8(s.wr.Intn(100)) < s.tunables.takenFraction
- for ri := 0; ri < numReturns; ri++ {
+ for range numReturns {
r := s.GenReturn(f, 0, pidx)
if !rTaken {
r.SetAddrTaken(notAddrTaken)
@@ -903,7 +899,7 @@ func (s *genstate) emitCompareFunc(f *funcdef, b *bytes.Buffer, p parm) {
b.WriteString(" return ")
numel := p.NumElements()
ncmp := 0
- for i := 0; i < numel; i++ {
+ for i := range numel {
lelref, lelparm := p.GenElemRef(i, "left")
relref, _ := p.GenElemRef(i, "right")
if lelref == "" || lelref == "_" {
@@ -1501,7 +1497,7 @@ func (s *genstate) emitParamChecks(f *funcdef, b *bytes.Buffer, pidx int, value
} else {
numel := p.NumElements()
cel := checkableElements(p)
- for i := 0; i < numel; i++ {
+ for i := range numel {
verb(4, "emitting check-code for p%d el %d value=%d", pi, i, value)
elref, elparm := p.GenElemRef(i, s.genParamRef(p, pi))
valstr, value = s.GenValue(f, elparm, value, false)
@@ -1535,7 +1531,7 @@ func (s *genstate) emitParamChecks(f *funcdef, b *bytes.Buffer, pidx int, value
// receiver value check
if f.isMethod {
numel := f.receiver.NumElements()
- for i := 0; i < numel; i++ {
+ for i := range numel {
verb(4, "emitting check-code for rcvr el %d value=%d", i, value)
elref, elparm := f.receiver.GenElemRef(i, "rcvr")
valstr, value = s.GenValue(f, elparm, value, false)
@@ -1608,7 +1604,7 @@ func (s *genstate) emitDeferChecks(f *funcdef, b *bytes.Buffer, value int) int {
b.WriteString(" // check parm " + which + "\n")
numel := p.NumElements()
cel := checkableElements(p)
- for i := 0; i < numel; i++ {
+ for i := range numel {
elref, elparm := p.GenElemRef(i, s.genParamRef(p, pi))
if elref == "" || elref == "_" || cel == 0 {
verb(4, "empty skip p%d el %d", pi, i)
@@ -2058,7 +2054,7 @@ func (s *genstate) emitMain(outf *os.File, numit int, fcnmask map[int]int, pkmas
for k := 0; k < s.NumTestPackages; k++ {
cp := fmt.Sprintf("%s%s%d", s.Tag, CallerName, k)
fmt.Fprintf(outf, " go func(ch chan bool) {\n")
- for i := 0; i < numit; i++ {
+ for i := range numit {
if shouldEmitFP(i, k, fcnmask, pkmask) {
fmt.Fprintf(outf, " %s.%s%d(\"normal\")\n", cp, CallerName, i)
if s.tunables.doReflectCall {
diff --git a/cmd/signature-fuzzer/internal/fuzz-generator/wraprand.go b/cmd/signature-fuzzer/internal/fuzz-generator/wraprand.go
index bba178dc317..f83a5f22e27 100644
--- a/cmd/signature-fuzzer/internal/fuzz-generator/wraprand.go
+++ b/cmd/signature-fuzzer/internal/fuzz-generator/wraprand.go
@@ -6,7 +6,7 @@ package generator
import (
"fmt"
- "math/rand"
+ "math/rand/v2"
"os"
"runtime"
"strings"
@@ -20,8 +20,7 @@ const (
)
func NewWrapRand(seed int64, ctl int) *wraprand {
- rand.Seed(seed)
- return &wraprand{seed: seed, ctl: ctl}
+ return &wraprand{seed: seed, ctl: ctl, rand: rand.New(rand.NewPCG(0, uint64(seed)))}
}
type wraprand struct {
@@ -32,6 +31,7 @@ type wraprand struct {
tag string
calls []string
ctl int
+ rand *rand.Rand
}
func (w *wraprand) captureCall(tag string, val string) {
@@ -59,7 +59,7 @@ func (w *wraprand) captureCall(tag string, val string) {
func (w *wraprand) Intn(n int64) int64 {
w.intncalls++
- rv := rand.Int63n(n)
+ rv := w.rand.Int64N(n)
if w.ctl&RandCtlCapture != 0 {
w.captureCall("Intn", fmt.Sprintf("%d", rv))
}
@@ -68,7 +68,7 @@ func (w *wraprand) Intn(n int64) int64 {
func (w *wraprand) Float32() float32 {
w.f32calls++
- rv := rand.Float32()
+ rv := w.rand.Float32()
if w.ctl&RandCtlCapture != 0 {
w.captureCall("Float32", fmt.Sprintf("%f", rv))
}
@@ -77,7 +77,7 @@ func (w *wraprand) Float32() float32 {
func (w *wraprand) NormFloat64() float64 {
w.f64calls++
- rv := rand.NormFloat64()
+ rv := w.rand.NormFloat64()
if w.ctl&RandCtlCapture != 0 {
w.captureCall("NormFloat64", fmt.Sprintf("%f", rv))
}
@@ -85,7 +85,7 @@ func (w *wraprand) NormFloat64() float64 {
}
func (w *wraprand) emitCalls(fn string) {
- outf, err := os.OpenFile(fn, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0666)
+ outf, err := os.OpenFile(fn, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o666)
if err != nil {
panic(err)
}
diff --git a/cmd/splitdwarf/splitdwarf.go b/cmd/splitdwarf/splitdwarf.go
index 90ff10b6a05..24aa239226c 100644
--- a/cmd/splitdwarf/splitdwarf.go
+++ b/cmd/splitdwarf/splitdwarf.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build aix || darwin || dragonfly || freebsd || linux || netbsd || openbsd
-// +build aix darwin dragonfly freebsd linux netbsd openbsd
/*
Splitdwarf uncompresses and copies the DWARF segment of a Mach-O
diff --git a/cmd/ssadump/gotypesalias.go b/cmd/ssadump/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/cmd/ssadump/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/cmd/stress/stress.go b/cmd/stress/stress.go
index 6472064f933..e8b8641b387 100644
--- a/cmd/stress/stress.go
+++ b/cmd/stress/stress.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build unix || aix || darwin || dragonfly || freebsd || linux || netbsd || openbsd || solaris || windows
-// +build unix aix darwin dragonfly freebsd linux netbsd openbsd solaris windows
// The stress utility is intended for catching sporadic failures.
// It runs a given process in parallel in a loop and collects any failures.
diff --git a/cmd/stringer/golden_test.go b/cmd/stringer/golden_test.go
index 2a81c0855aa..e40b7c53c91 100644
--- a/cmd/stringer/golden_test.go
+++ b/cmd/stringer/golden_test.go
@@ -453,7 +453,6 @@ func TestGolden(t *testing.T) {
dir := t.TempDir()
for _, test := range golden {
- test := test
t.Run(test.name, func(t *testing.T) {
input := "package test\n" + test.input
file := test.name + ".go"
diff --git a/cmd/stringer/gotypesalias.go b/cmd/stringer/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/cmd/stringer/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/cmd/toolstash/main.go b/cmd/toolstash/main.go
index c533ed1e572..3a92c00bfff 100644
--- a/cmd/toolstash/main.go
+++ b/cmd/toolstash/main.go
@@ -225,7 +225,7 @@ func main() {
return
}
- tool = cmd[0]
+ tool = exeName(cmd[0])
if i := strings.LastIndexAny(tool, `/\`); i >= 0 {
tool = tool[i+1:]
}
@@ -530,7 +530,7 @@ func runCmd(cmd []string, keepLog bool, logName string) (output []byte, err erro
}()
}
- xcmd := exec.Command(cmd[0], cmd[1:]...)
+ xcmd := exec.Command(exeName(cmd[0]), cmd[1:]...)
if !keepLog {
return xcmd.CombinedOutput()
}
@@ -571,9 +571,10 @@ func save() {
if !shouldSave(name) {
continue
}
- src := filepath.Join(binDir, name)
+ bin := exeName(name)
+ src := filepath.Join(binDir, bin)
if _, err := os.Stat(src); err == nil {
- cp(src, filepath.Join(stashDir, name))
+ cp(src, filepath.Join(stashDir, bin))
}
}
@@ -641,3 +642,10 @@ func cp(src, dst string) {
log.Fatal(err)
}
}
+
+func exeName(name string) string {
+ if runtime.GOOS == "windows" {
+ return name + ".exe"
+ }
+ return name
+}
diff --git a/container/intsets/sparse.go b/container/intsets/sparse.go
index c56aacc28bb..b9b4c91ed21 100644
--- a/container/intsets/sparse.go
+++ b/container/intsets/sparse.go
@@ -267,7 +267,7 @@ func (s *Sparse) init() {
// loop. Fail fast before this occurs.
// We don't want to call panic here because it prevents the
// inlining of this function.
- _ = (interface{}(nil)).(to_copy_a_sparse_you_must_call_its_Copy_method)
+ _ = (any(nil)).(to_copy_a_sparse_you_must_call_its_Copy_method)
}
}
diff --git a/container/intsets/sparse_test.go b/container/intsets/sparse_test.go
index cd8ec6e0840..f218e09b6a3 100644
--- a/container/intsets/sparse_test.go
+++ b/container/intsets/sparse_test.go
@@ -236,7 +236,7 @@ func (set *pset) check(t *testing.T, msg string) {
func randomPset(prng *rand.Rand, maxSize int) *pset {
set := makePset()
size := int(prng.Int()) % maxSize
- for i := 0; i < size; i++ {
+ for range size {
// TODO(adonovan): benchmark how performance varies
// with this sparsity parameter.
n := int(prng.Int()) % 10000
@@ -252,7 +252,7 @@ func TestRandomMutations(t *testing.T) {
set := makePset()
prng := rand.New(rand.NewSource(0))
- for i := 0; i < 10000; i++ {
+ for i := range 10000 {
n := int(prng.Int())%2000 - 1000
if i%2 == 0 {
if debug {
@@ -278,9 +278,9 @@ func TestRandomMutations(t *testing.T) {
func TestLowerBound(t *testing.T) {
// Use random sets of sizes from 0 to about 4000.
prng := rand.New(rand.NewSource(0))
- for i := uint(0); i < 12; i++ {
+ for i := range uint(12) {
x := randomPset(prng, 1<= j && e < found {
@@ -302,7 +302,7 @@ func TestSetOperations(t *testing.T) {
// For each operator, we test variations such as
// Z.op(X, Y), Z.op(X, Z) and Z.op(Z, Y) to exercise
// the degenerate cases of each method implementation.
- for i := uint(0); i < 12; i++ {
+ for i := range uint(12) {
X := randomPset(prng, 1< default GODEBUG has gotypesalias=0
+go 1.23.0
require (
github.com/google/go-cmp v0.6.0
github.com/yuin/goldmark v1.4.13
- golang.org/x/mod v0.23.0
- golang.org/x/net v0.35.0
- golang.org/x/sync v0.11.0
+ golang.org/x/mod v0.24.0
+ golang.org/x/net v0.39.0
+ golang.org/x/sync v0.13.0
golang.org/x/telemetry v0.0.0-20240521205824-bda55230c457
)
-require golang.org/x/sys v0.30.0 // indirect
+require golang.org/x/sys v0.32.0 // indirect
diff --git a/go.sum b/go.sum
index 2d11b060c08..ff5857bd93a 100644
--- a/go.sum
+++ b/go.sum
@@ -2,13 +2,13 @@ github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/yuin/goldmark v1.4.13 h1:fVcFKWvrslecOb/tg+Cc05dkeYx540o0FuFt3nUVDoE=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
-golang.org/x/mod v0.23.0 h1:Zb7khfcRGKk+kqfxFaP5tZqCnDZMjC5VtUBs87Hr6QM=
-golang.org/x/mod v0.23.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
-golang.org/x/net v0.35.0 h1:T5GQRQb2y08kTAByq9L4/bz8cipCdA8FbRTXewonqY8=
-golang.org/x/net v0.35.0/go.mod h1:EglIi67kWsHKlRzzVMUD93VMSWGFOMSZgxFjparz1Qk=
-golang.org/x/sync v0.11.0 h1:GGz8+XQP4FvTTrjZPzNKTMFtSXH80RAzG+5ghFPgK9w=
-golang.org/x/sync v0.11.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
-golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc=
-golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU=
+golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww=
+golang.org/x/net v0.39.0 h1:ZCu7HMWDxpXpaiKdhzIfaltL9Lp31x/3fCP11bc6/fY=
+golang.org/x/net v0.39.0/go.mod h1:X7NRbYVEA+ewNkCNyJ513WmMdQ3BineSwVtN2zD/d+E=
+golang.org/x/sync v0.13.0 h1:AauUjRAJ9OSnvULf/ARrrVywoJDy0YS2AwQ98I37610=
+golang.org/x/sync v0.13.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
+golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
+golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
golang.org/x/telemetry v0.0.0-20240521205824-bda55230c457 h1:zf5N6UOrA487eEFacMePxjXAJctxKmyjKUsjA11Uzuk=
golang.org/x/telemetry v0.0.0-20240521205824-bda55230c457/go.mod h1:pRgIJT+bRLFKnoM1ldnzKoxTIn14Yxz928LQRYYgIN0=
diff --git a/go/analysis/analysis.go b/go/analysis/analysis.go
index 3a73084a53c..a7df4d1fe4e 100644
--- a/go/analysis/analysis.go
+++ b/go/analysis/analysis.go
@@ -45,7 +45,7 @@ type Analyzer struct {
// To pass analysis results between packages (and thus
// potentially between address spaces), use Facts, which are
// serializable.
- Run func(*Pass) (interface{}, error)
+ Run func(*Pass) (any, error)
// RunDespiteErrors allows the driver to invoke
// the Run method of this analyzer even on a
@@ -112,7 +112,7 @@ type Pass struct {
// The map keys are the elements of Analysis.Required,
// and the type of each corresponding value is the required
// analysis's ResultType.
- ResultOf map[*Analyzer]interface{}
+ ResultOf map[*Analyzer]any
// ReadFile returns the contents of the named file.
//
@@ -186,7 +186,7 @@ type ObjectFact struct {
// Reportf is a helper function that reports a Diagnostic using the
// specified position and formatted error message.
-func (pass *Pass) Reportf(pos token.Pos, format string, args ...interface{}) {
+func (pass *Pass) Reportf(pos token.Pos, format string, args ...any) {
msg := fmt.Sprintf(format, args...)
pass.Report(Diagnostic{Pos: pos, Message: msg})
}
@@ -201,7 +201,7 @@ type Range interface {
// ReportRangef is a helper function that reports a Diagnostic using the
// range provided. ast.Node values can be passed in as the range because
// they satisfy the Range interface.
-func (pass *Pass) ReportRangef(rng Range, format string, args ...interface{}) {
+func (pass *Pass) ReportRangef(rng Range, format string, args ...any) {
msg := fmt.Sprintf(format, args...)
pass.Report(Diagnostic{Pos: rng.Pos(), End: rng.End(), Message: msg})
}
diff --git a/go/analysis/analysistest/analysistest.go b/go/analysis/analysistest/analysistest.go
index 775fd20094d..20312345018 100644
--- a/go/analysis/analysistest/analysistest.go
+++ b/go/analysis/analysistest/analysistest.go
@@ -12,6 +12,7 @@ import (
"go/token"
"go/types"
"log"
+ "maps"
"os"
"path/filepath"
"regexp"
@@ -75,19 +76,27 @@ var TestData = func() string {
// Testing is an abstraction of a *testing.T.
type Testing interface {
- Errorf(format string, args ...interface{})
+ Errorf(format string, args ...any)
}
-// RunWithSuggestedFixes behaves like Run, but additionally verifies suggested fixes.
-// It uses golden files placed alongside the source code under analysis:
-// suggested fixes for code in example.go will be compared against example.go.golden.
+// RunWithSuggestedFixes behaves like Run, but additionally applies
+// suggested fixes and verifies their output.
//
-// Golden files can be formatted in one of two ways: as plain Go source code, or as txtar archives.
-// In the first case, all suggested fixes will be applied to the original source, which will then be compared against the golden file.
-// In the second case, suggested fixes will be grouped by their messages, and each set of fixes will be applied and tested separately.
-// Each section in the archive corresponds to a single message.
+// It uses golden files, placed alongside each source file, to express
+// the desired output: the expected transformation of file example.go
+// is specified in file example.go.golden.
//
-// A golden file using txtar may look like this:
+// Golden files may be of two forms: a plain Go source file, or a
+// txtar archive.
+//
+// A plain Go source file indicates the expected result of applying
+// all suggested fixes to the original file.
+//
+// A txtar archive specifies, in each section, the expected result of
+// applying all suggested fixes of a given message to the original
+// file; the name of the archive section is the fix's message. In this
+// way, the various alternative fixes offered by a single diagnostic
+// can be tested independently. Here's an example:
//
// -- turn into single negation --
// package pkg
@@ -109,41 +118,28 @@ type Testing interface {
//
// # Conflicts
//
-// A single analysis pass may offer two or more suggested fixes that
-// (1) conflict but are nonetheless logically composable, (e.g.
-// because both update the import declaration), or (2) are
-// fundamentally incompatible (e.g. alternative fixes to the same
-// statement).
+// Regardless of the form of the golden file, it is possible for
+// multiple fixes to conflict, either because they overlap, or are
+// close enough together that the particular diff algorithm cannot
+// separate them.
//
-// It is up to the driver to decide how to apply such fixes. A
-// sophisticated driver could attempt to resolve conflicts of the
-// first kind, but this test driver simply reports the fact of the
-// conflict with the expectation that the user will split their tests
-// into nonconflicting parts.
+// RunWithSuggestedFixes uses a simple three-way merge to accumulate
+// fixes, similar to a git merge. The merge algorithm may be able to
+// coalesce identical edits, for example duplicate imports of the same
+// package. (Bear in mind that this is an editorial decision. In
+// general, coalescing identical edits may not be correct: consider
+// two statements that increment the same counter.)
//
-// Conflicts of the second kind can be avoided by giving the
-// alternative fixes different names (SuggestedFix.Message) and
-// defining the .golden file as a multi-section txtar file with a
-// named section for each alternative fix, as shown above.
+// If there are conflicts, the test fails. In any case, the
+// non-conflicting edits will be compared against the expected output.
+// In this situation, we recommend that you increase the textual
+// separation between conflicting parts or, if that fails, split
+// your tests into smaller parts.
//
-// Analyzers that compute fixes from a textual diff of the
-// before/after file contents (instead of directly from syntax tree
-// positions) may produce fixes that, although logically
-// non-conflicting, nonetheless conflict due to the particulars of the
-// diff algorithm. In such cases it may suffice to introduce
-// sufficient separation of the statements in the test input so that
-// the computed diffs do not overlap. If that fails, break the test
-// into smaller parts.
-//
-// TODO(adonovan): the behavior of RunWithSuggestedFixes as documented
-// above is impractical for tests that report multiple diagnostics and
-// offer multiple alternative fixes for the same diagnostic, and it is
-// inconsistent with the interpretation of multiple diagnostics
-// described at Diagnostic.SuggestedFixes.
-// We need to rethink the analyzer testing API to better support such
-// cases. In the meantime, users of RunWithSuggestedFixes testing
-// analyzers that offer alternative fixes are advised to put each fix
-// in a separate .go file in the testdata.
+// If a diagnostic offers multiple fixes for the same problem, they
+// are almost certain to conflict, so in this case you should define
+// the expected output using a multi-section txtar file as described
+// above.
func RunWithSuggestedFixes(t Testing, dir string, a *analysis.Analyzer, patterns ...string) []*Result {
results := Run(t, dir, a, patterns...)
@@ -173,133 +169,165 @@ func RunWithSuggestedFixes(t Testing, dir string, a *analysis.Analyzer, patterns
for _, result := range results {
act := result.Action
- // file -> message -> edits
- // TODO(adonovan): this mapping assumes fix.Messages are unique across analyzers,
- // whereas they are only unique within a given Diagnostic.
- fileEdits := make(map[*token.File]map[string][]diff.Edit)
-
- // We may assume that fixes are validated upon creation in Pass.Report.
- // Group fixes by file and message.
+ // For each fix, split its edits by file and convert to diff form.
+ var (
+ // fixEdits: message -> fixes -> filename -> edits
+ //
+ // TODO(adonovan): this mapping assumes fix.Messages
+ // are unique across analyzers, whereas they are only
+ // unique within a given Diagnostic.
+ fixEdits = make(map[string][]map[string][]diff.Edit)
+ allFilenames = make(map[string]bool)
+ )
for _, diag := range act.Diagnostics {
+ // Fixes are validated upon creation in Pass.Report.
for _, fix := range diag.SuggestedFixes {
// Assert that lazy fixes have a Category (#65578, #65087).
if inTools && len(fix.TextEdits) == 0 && diag.Category == "" {
t.Errorf("missing Diagnostic.Category for SuggestedFix without TextEdits (gopls requires the category for the name of the fix command")
}
+ // Convert edits to diff form.
+ // Group fixes by message and file.
+ edits := make(map[string][]diff.Edit)
for _, edit := range fix.TextEdits {
file := act.Package.Fset.File(edit.Pos)
- if _, ok := fileEdits[file]; !ok {
- fileEdits[file] = make(map[string][]diff.Edit)
- }
- fileEdits[file][fix.Message] = append(fileEdits[file][fix.Message], diff.Edit{
+ allFilenames[file.Name()] = true
+ edits[file.Name()] = append(edits[file.Name()], diff.Edit{
Start: file.Offset(edit.Pos),
End: file.Offset(edit.End),
New: string(edit.NewText),
})
}
+ fixEdits[fix.Message] = append(fixEdits[fix.Message], edits)
+ }
+ }
+
+ merge := func(file, message string, x, y []diff.Edit) []diff.Edit {
+ z, ok := diff.Merge(x, y)
+ if !ok {
+ t.Errorf("in file %s, conflict applying fix %q", file, message)
+ return x // discard y
}
+ return z
}
- for file, fixes := range fileEdits {
- // Get the original file contents.
- // TODO(adonovan): plumb pass.ReadFile.
- orig, err := os.ReadFile(file.Name())
+ // Because the checking is driven by original
+ // filenames, there is no way to express that a fix
+ // (e.g. extract declaration) creates a new file.
+ for _, filename := range slices.Sorted(maps.Keys(allFilenames)) {
+ // Read the original file.
+ content, err := os.ReadFile(filename)
if err != nil {
- t.Errorf("error reading %s: %v", file.Name(), err)
+ t.Errorf("error reading %s: %v", filename, err)
continue
}
- // Get the golden file and read the contents.
- ar, err := txtar.ParseFile(file.Name() + ".golden")
+ // check checks that the accumulated edits applied
+ // to the original content yield the wanted content.
+ check := func(prefix string, accumulated []diff.Edit, want []byte) {
+ if err := applyDiffsAndCompare(filename, content, want, accumulated); err != nil {
+ t.Errorf("%s: %s", prefix, err)
+ }
+ }
+
+ // Read the golden file. It may have one of two forms:
+ // (1) A txtar archive with one section per fix title,
+ // including all fixes of just that title.
+ // (2) The expected output for file.Name after all (?) fixes are applied.
+ // This form requires that no diagnostic has multiple fixes.
+ ar, err := txtar.ParseFile(filename + ".golden")
if err != nil {
- t.Errorf("error reading %s.golden: %v", file.Name(), err)
+ t.Errorf("error reading %s.golden: %v", filename, err)
continue
}
-
if len(ar.Files) > 0 {
- // one virtual file per kind of suggested fix
-
- if len(ar.Comment) != 0 {
- // we allow either just the comment, or just virtual
- // files, not both. it is not clear how "both" should
- // behave.
- t.Errorf("%s.golden has leading comment; we don't know what to do with it", file.Name())
+ // Form #1: one archive section per kind of suggested fix.
+ if len(ar.Comment) > 0 {
+ // Disallow the combination of comment and archive sections.
+ t.Errorf("%s.golden has leading comment; we don't know what to do with it", filename)
continue
}
- // Sort map keys for determinism in tests.
- // TODO(jba): replace with slices.Sorted(maps.Keys(fixes)) when go.mod >= 1.23.
- var keys []string
- for k := range fixes {
- keys = append(keys, k)
- }
- slices.Sort(keys)
- for _, sf := range keys {
- edits := fixes[sf]
- found := false
- for _, vf := range ar.Files {
- if vf.Name == sf {
- found = true
- // the file may contain multiple trailing
- // newlines if the user places empty lines
- // between files in the archive. normalize
- // this to a single newline.
- golden := append(bytes.TrimRight(vf.Data, "\n"), '\n')
-
- if err := applyDiffsAndCompare(orig, golden, edits, file.Name()); err != nil {
- t.Errorf("%s", err)
- }
- break
- }
- }
- if !found {
- t.Errorf("no section for suggested fix %q in %s.golden", sf, file.Name())
+
+ // Each archive section is named for a fix.Message.
+ // Accumulate the parts of the fix that apply to the current file,
+ // using a simple three-way merge, discarding conflicts,
+ // then apply the merged edits and compare to the archive section.
+ for _, section := range ar.Files {
+ message, want := section.Name, section.Data
+ var accumulated []diff.Edit
+ for _, fix := range fixEdits[message] {
+ accumulated = merge(filename, message, accumulated, fix[filename])
}
- }
- } else {
- // all suggested fixes are represented by a single file
- // TODO(adonovan): fix: this makes no sense if len(fixes) > 1.
- // Sort map keys for determinism in tests.
- // TODO(jba): replace with slices.Sorted(maps.Keys(fixes)) when go.mod >= 1.23.
- var keys []string
- for k := range fixes {
- keys = append(keys, k)
- }
- slices.Sort(keys)
- var catchallEdits []diff.Edit
- for _, k := range keys {
- catchallEdits = append(catchallEdits, fixes[k]...)
+ check(fmt.Sprintf("all fixes of message %q", message), accumulated, want)
}
- if err := applyDiffsAndCompare(orig, ar.Comment, catchallEdits, file.Name()); err != nil {
- t.Errorf("%s", err)
+ } else {
+ // Form #2: all suggested fixes are represented by a single file.
+ want := ar.Comment
+ var accumulated []diff.Edit
+ for _, message := range slices.Sorted(maps.Keys(fixEdits)) {
+ for _, fix := range fixEdits[message] {
+ accumulated = merge(filename, message, accumulated, fix[filename])
+ }
}
+ check("all fixes", accumulated, want)
}
}
}
+
return results
}
-// applyDiffsAndCompare applies edits to src and compares the results against
-// golden after formatting both. fileName is use solely for error reporting.
-func applyDiffsAndCompare(src, golden []byte, edits []diff.Edit, fileName string) error {
- out, err := diff.ApplyBytes(src, edits)
+// applyDiffsAndCompare applies edits to original and compares the results against
+// want after formatting both. fileName is use solely for error reporting.
+func applyDiffsAndCompare(filename string, original, want []byte, edits []diff.Edit) error {
+ // Relativize filename, for tidier errors.
+ if cwd, err := os.Getwd(); err == nil {
+ if rel, err := filepath.Rel(cwd, filename); err == nil {
+ filename = rel
+ }
+ }
+
+ if len(edits) == 0 {
+ return fmt.Errorf("%s: no edits", filename)
+ }
+ fixedBytes, err := diff.ApplyBytes(original, edits)
if err != nil {
- return fmt.Errorf("%s: error applying fixes: %v (see possible explanations at RunWithSuggestedFixes)", fileName, err)
+ return fmt.Errorf("%s: error applying fixes: %v (see possible explanations at RunWithSuggestedFixes)", filename, err)
}
- wantRaw, err := format.Source(golden)
+ fixed, err := format.Source(fixedBytes)
if err != nil {
- return fmt.Errorf("%s.golden: error formatting golden file: %v\n%s", fileName, err, out)
+ return fmt.Errorf("%s: error formatting resulting source: %v\n%s", filename, err, fixedBytes)
}
- want := string(wantRaw)
- formatted, err := format.Source(out)
+ want, err = format.Source(want)
if err != nil {
- return fmt.Errorf("%s: error formatting resulting source: %v\n%s", fileName, err, out)
+ return fmt.Errorf("%s.golden: error formatting golden file: %v\n%s", filename, err, fixed)
}
- if got := string(formatted); got != want {
- unified := diff.Unified(fileName+".golden", "actual", want, got)
- return fmt.Errorf("suggested fixes failed for %s:\n%s", fileName, unified)
+
+ // Keep error reporting logic below consistent with
+ // TestScript in ../internal/checker/fix_test.go!
+
+ unified := func(xlabel, ylabel string, x, y []byte) string {
+ x = append(slices.Clip(bytes.TrimSpace(x)), '\n')
+ y = append(slices.Clip(bytes.TrimSpace(y)), '\n')
+ return diff.Unified(xlabel, ylabel, string(x), string(y))
+ }
+
+ if diff := unified(filename+" (fixed)", filename+" (want)", fixed, want); diff != "" {
+ return fmt.Errorf("unexpected %s content:\n"+
+ "-- original --\n%s\n"+
+ "-- fixed --\n%s\n"+
+ "-- want --\n%s\n"+
+ "-- diff original fixed --\n%s\n"+
+ "-- diff fixed want --\n%s",
+ filename,
+ original,
+ fixed,
+ want,
+ unified(filename+" (original)", filename+" (fixed)", original, fixed),
+ diff)
}
return nil
}
@@ -499,7 +527,7 @@ func check(t Testing, gopath string, act *checker.Action) {
// Any comment starting with "want" is treated
// as an expectation, even without following whitespace.
- if rest := strings.TrimPrefix(text, "want"); rest != text {
+ if rest, ok := strings.CutPrefix(text, "want"); ok {
lineDelta, expects, err := parseExpectations(rest)
if err != nil {
t.Errorf("%s:%d: in 'want' comment: %s", filename, linenum, err)
@@ -551,7 +579,7 @@ func check(t Testing, gopath string, act *checker.Action) {
// ignored. (This was previously a hack in the respective
// analyzers' tests.)
if act.Analyzer.Name == "buildtag" || act.Analyzer.Name == "directive" {
- files = append(files[:len(files):len(files)], act.Package.IgnoredFiles...)
+ files = slices.Concat(files, act.Package.IgnoredFiles)
}
for _, filename := range files {
diff --git a/go/analysis/analysistest/analysistest_test.go b/go/analysis/analysistest/analysistest_test.go
index eedbb5c2a90..88cd8f8f1d5 100644
--- a/go/analysis/analysistest/analysistest_test.go
+++ b/go/analysis/analysistest/analysistest_test.go
@@ -262,6 +262,6 @@ type T string
type errorfunc func(string)
-func (f errorfunc) Errorf(format string, args ...interface{}) {
+func (f errorfunc) Errorf(format string, args ...any) {
f(fmt.Sprintf(format, args...))
}
diff --git a/go/analysis/checker/checker.go b/go/analysis/checker/checker.go
index 502ec922179..94808733b9d 100644
--- a/go/analysis/checker/checker.go
+++ b/go/analysis/checker/checker.go
@@ -594,7 +594,7 @@ func (act *Action) exportPackageFact(fact analysis.Fact) {
func factType(fact analysis.Fact) reflect.Type {
t := reflect.TypeOf(fact)
- if t.Kind() != reflect.Ptr {
+ if t.Kind() != reflect.Pointer {
log.Fatalf("invalid Fact type: got %T, want pointer", fact)
}
return t
diff --git a/go/analysis/internal/analysisflags/flags.go b/go/analysis/internal/analysisflags/flags.go
index c2445575cff..6aefef25815 100644
--- a/go/analysis/internal/analysisflags/flags.go
+++ b/go/analysis/internal/analysisflags/flags.go
@@ -201,7 +201,7 @@ func addVersionFlag() {
type versionFlag struct{}
func (versionFlag) IsBoolFlag() bool { return true }
-func (versionFlag) Get() interface{} { return nil }
+func (versionFlag) Get() any { return nil }
func (versionFlag) String() string { return "" }
func (versionFlag) Set(s string) error {
if s != "full" {
@@ -252,7 +252,7 @@ const (
// triState implements flag.Value, flag.Getter, and flag.boolFlag.
// They work like boolean flags: we can say vet -printf as well as vet -printf=true
-func (ts *triState) Get() interface{} {
+func (ts *triState) Get() any {
return *ts == setTrue
}
@@ -340,7 +340,7 @@ func PrintPlain(out io.Writer, fset *token.FileSet, contextLines int, diag analy
// A JSONTree is a mapping from package ID to analysis name to result.
// Each result is either a jsonError or a list of JSONDiagnostic.
-type JSONTree map[string]map[string]interface{}
+type JSONTree map[string]map[string]any
// A TextEdit describes the replacement of a portion of a file.
// Start and End are zero-based half-open indices into the original byte
@@ -383,7 +383,7 @@ type JSONRelatedInformation struct {
// Add adds the result of analysis 'name' on package 'id'.
// The result is either a list of diagnostics or an error.
func (tree JSONTree) Add(fset *token.FileSet, id, name string, diags []analysis.Diagnostic, err error) {
- var v interface{}
+ var v any
if err != nil {
type jsonError struct {
Err string `json:"error"`
@@ -429,7 +429,7 @@ func (tree JSONTree) Add(fset *token.FileSet, id, name string, diags []analysis.
if v != nil {
m, ok := tree[id]
if !ok {
- m = make(map[string]interface{})
+ m = make(map[string]any)
tree[id] = m
}
m[name] = v
diff --git a/go/analysis/internal/checker/checker.go b/go/analysis/internal/checker/checker.go
index fb3c47b1625..bc57dc6e673 100644
--- a/go/analysis/internal/checker/checker.go
+++ b/go/analysis/internal/checker/checker.go
@@ -86,7 +86,36 @@ func RegisterFlags() {
// It provides most of the logic for the main functions of both the
// singlechecker and the multi-analysis commands.
// It returns the appropriate exit code.
-func Run(args []string, analyzers []*analysis.Analyzer) int {
+//
+// TODO(adonovan): tests should not call this function directly;
+// fiddling with global variables (flags) is error-prone and hostile
+// to parallelism. Instead, use unit tests of the actual units (e.g.
+// checker.Analyze) and integration tests (e.g. TestScript) of whole
+// executables.
+func Run(args []string, analyzers []*analysis.Analyzer) (exitcode int) {
+ // Instead of returning a code directly,
+ // call this function to monotonically increase the exit code.
+ // This allows us to keep going in the face of some errors
+ // without having to remember what code to return.
+ //
+ // TODO(adonovan): interpreting exit codes is like reading tea-leaves.
+ // Insted of wasting effort trying to encode a multidimensional result
+ // into 7 bits we should just emit structured JSON output, and
+ // an exit code of 0 or 1 for success or failure.
+ exitAtLeast := func(code int) {
+ exitcode = max(code, exitcode)
+ }
+
+ // When analysisflags is linked in (for {single,multi}checker),
+ // then the -v flag is registered for complex legacy reasons
+ // related to cmd/vet CLI.
+ // Treat it as an undocumented alias for -debug=v.
+ if v := flag.CommandLine.Lookup("v"); v != nil &&
+ v.Value.(flag.Getter).Get() == true &&
+ !strings.Contains(Debug, "v") {
+ Debug += "v"
+ }
+
if CPUProfile != "" {
f, err := os.Create(CPUProfile)
if err != nil {
@@ -142,17 +171,14 @@ func Run(args []string, analyzers []*analysis.Analyzer) int {
initial, err := load(args, allSyntax)
if err != nil {
log.Print(err)
- return 1
+ exitAtLeast(1)
+ return
}
- // TODO(adonovan): simplify exit code logic by using a single
- // exit code variable and applying "code = max(code, X)" each
- // time an error of code X occurs.
- pkgsExitCode := 0
// Print package and module errors regardless of RunDespiteErrors.
// Do not exit if there are errors, yet.
if n := packages.PrintErrors(initial); n > 0 {
- pkgsExitCode = 1
+ exitAtLeast(1)
}
var factLog io.Writer
@@ -172,7 +198,8 @@ func Run(args []string, analyzers []*analysis.Analyzer) int {
graph, err := checker.Analyze(analyzers, initial, opts)
if err != nil {
log.Print(err)
- return 1
+ exitAtLeast(1)
+ return
}
// Don't print the diagnostics,
@@ -181,22 +208,22 @@ func Run(args []string, analyzers []*analysis.Analyzer) int {
if err := applyFixes(graph.Roots, Diff); err != nil {
// Fail when applying fixes failed.
log.Print(err)
- return 1
+ exitAtLeast(1)
+ return
}
- // TODO(adonovan): don't proceed to print the text or JSON output
- // if we applied fixes; stop here.
- //
- // return pkgsExitCode
+ // Don't proceed to print text/JSON,
+ // and don't report an error
+ // just because there were diagnostics.
+ return
}
// Print the results. If !RunDespiteErrors and there
// are errors in the packages, this will have 0 exit
// code. Otherwise, we prefer to return exit code
// indicating diagnostics.
- if diagExitCode := printDiagnostics(graph); diagExitCode != 0 {
- return diagExitCode // there were diagnostics
- }
- return pkgsExitCode // package errors but no diagnostics
+ exitAtLeast(printDiagnostics(graph))
+
+ return
}
// printDiagnostics prints diagnostics in text or JSON form
@@ -215,15 +242,14 @@ func printDiagnostics(graph *checker.Graph) (exitcode int) {
// Compute the exit code.
var numErrors, rootDiags int
- // TODO(adonovan): use "for act := range graph.All() { ... }" in go1.23.
- graph.All()(func(act *checker.Action) bool {
+ for act := range graph.All() {
if act.Err != nil {
numErrors++
} else if act.IsRoot {
rootDiags += len(act.Diagnostics)
}
- return true
- })
+ }
+
if numErrors > 0 {
exitcode = 1 // analysis failed, at least partially
} else if rootDiags > 0 {
@@ -239,12 +265,10 @@ func printDiagnostics(graph *checker.Graph) (exitcode int) {
var list []*checker.Action
var total time.Duration
- // TODO(adonovan): use "for act := range graph.All() { ... }" in go1.23.
- graph.All()(func(act *checker.Action) bool {
+ for act := range graph.All() {
list = append(list, act)
total += act.Duration
- return true
- })
+ }
// Print actions accounting for 90% of the total.
sort.Slice(list, func(i, j int) bool {
@@ -541,6 +565,10 @@ fixloop:
}
}
+ if dbg('v') {
+ log.Printf("applied %d fixes, updated %d files", len(fixes), filesUpdated)
+ }
+
return nil
}
diff --git a/go/analysis/internal/checker/checker_test.go b/go/analysis/internal/checker/checker_test.go
index fcf5f66e03e..7d73aa3c6bb 100644
--- a/go/analysis/internal/checker/checker_test.go
+++ b/go/analysis/internal/checker/checker_test.go
@@ -49,8 +49,10 @@ func Foo() {
t.Fatal(err)
}
path := filepath.Join(testdata, "src/rename/test.go")
+
checker.Fix = true
checker.Run([]string{"file=" + path}, []*analysis.Analyzer{renameAnalyzer})
+ checker.Fix = false
contents, err := os.ReadFile(path)
if err != nil {
@@ -105,7 +107,7 @@ func NewT1() *T1 { return &T1{T} }
Name: "noop",
Doc: "noop",
Requires: []*analysis.Analyzer{inspect.Analyzer},
- Run: func(pass *analysis.Pass) (interface{}, error) {
+ Run: func(pass *analysis.Pass) (any, error) {
return nil, nil
},
RunDespiteErrors: true,
@@ -117,7 +119,7 @@ func NewT1() *T1 { return &T1{T} }
Name: "noopfact",
Doc: "noopfact",
Requires: []*analysis.Analyzer{inspect.Analyzer},
- Run: func(pass *analysis.Pass) (interface{}, error) {
+ Run: func(pass *analysis.Pass) (any, error) {
return nil, nil
},
RunDespiteErrors: true,
@@ -138,31 +140,33 @@ func NewT1() *T1 { return &T1{T} }
// package from source. For the rest, it asks 'go list' for export data,
// which fails because the compiler encounters the type error. Since the
// errors come from 'go list', the driver doesn't run the analyzer.
- {name: "despite-error", pattern: []string{rderrFile}, analyzers: []*analysis.Analyzer{noop}, code: 1},
+ {name: "despite-error", pattern: []string{rderrFile}, analyzers: []*analysis.Analyzer{noop}, code: exitCodeFailed},
// The noopfact analyzer does use facts, so the driver loads source for
// all dependencies, does type checking itself, recognizes the error as a
// type error, and runs the analyzer.
- {name: "despite-error-fact", pattern: []string{rderrFile}, analyzers: []*analysis.Analyzer{noopWithFact}, code: 1},
+ {name: "despite-error-fact", pattern: []string{rderrFile}, analyzers: []*analysis.Analyzer{noopWithFact}, code: exitCodeFailed},
// combination of parse/type errors and no errors
- {name: "despite-error-and-no-error", pattern: []string{rderrFile, "sort"}, analyzers: []*analysis.Analyzer{renameAnalyzer, noop}, code: 1},
+ {name: "despite-error-and-no-error", pattern: []string{rderrFile, "sort"}, analyzers: []*analysis.Analyzer{renameAnalyzer, noop}, code: exitCodeFailed},
// non-existing package error
- {name: "no-package", pattern: []string{"xyz"}, analyzers: []*analysis.Analyzer{renameAnalyzer}, code: 1},
- {name: "no-package-despite-error", pattern: []string{"abc"}, analyzers: []*analysis.Analyzer{noop}, code: 1},
- {name: "no-multi-package-despite-error", pattern: []string{"xyz", "abc"}, analyzers: []*analysis.Analyzer{noop}, code: 1},
+ {name: "no-package", pattern: []string{"xyz"}, analyzers: []*analysis.Analyzer{renameAnalyzer}, code: exitCodeFailed},
+ {name: "no-package-despite-error", pattern: []string{"abc"}, analyzers: []*analysis.Analyzer{noop}, code: exitCodeFailed},
+ {name: "no-multi-package-despite-error", pattern: []string{"xyz", "abc"}, analyzers: []*analysis.Analyzer{noop}, code: exitCodeFailed},
// combination of type/parsing and different errors
- {name: "different-errors", pattern: []string{rderrFile, "xyz"}, analyzers: []*analysis.Analyzer{renameAnalyzer, noop}, code: 1},
+ {name: "different-errors", pattern: []string{rderrFile, "xyz"}, analyzers: []*analysis.Analyzer{renameAnalyzer, noop}, code: exitCodeFailed},
// non existing dir error
- {name: "no-match-dir", pattern: []string{"file=non/existing/dir"}, analyzers: []*analysis.Analyzer{renameAnalyzer, noop}, code: 1},
+ {name: "no-match-dir", pattern: []string{"file=non/existing/dir"}, analyzers: []*analysis.Analyzer{renameAnalyzer, noop}, code: exitCodeFailed},
// no errors
- {name: "no-errors", pattern: []string{"sort"}, analyzers: []*analysis.Analyzer{renameAnalyzer, noop}, code: 0},
+ {name: "no-errors", pattern: []string{"sort"}, analyzers: []*analysis.Analyzer{renameAnalyzer, noop}, code: exitCodeSuccess},
// duplicate list error with no findings
- {name: "list-error", pattern: []string{cperrFile}, analyzers: []*analysis.Analyzer{noop}, code: 1},
+ {name: "list-error", pattern: []string{cperrFile}, analyzers: []*analysis.Analyzer{noop}, code: exitCodeFailed},
// duplicate list errors with findings (issue #67790)
- {name: "list-error-findings", pattern: []string{cperrFile}, analyzers: []*analysis.Analyzer{renameAnalyzer}, code: 3},
+ {name: "list-error-findings", pattern: []string{cperrFile}, analyzers: []*analysis.Analyzer{renameAnalyzer}, code: exitCodeDiagnostics},
} {
- if got := checker.Run(test.pattern, test.analyzers); got != test.code {
- t.Errorf("got incorrect exit code %d for test %s; want %d", got, test.name, test.code)
- }
+ t.Run(test.name, func(t *testing.T) {
+ if got := checker.Run(test.pattern, test.analyzers); got != test.code {
+ t.Errorf("got incorrect exit code %d for test %s; want %d", got, test.name, test.code)
+ }
+ })
}
}
@@ -181,7 +185,7 @@ func TestURL(t *testing.T) {
Name: "pkgname",
Doc: "trivial analyzer that reports package names",
URL: "https://pkg.go.dev/golang.org/x/tools/go/analysis/internal/checker",
- Run: func(p *analysis.Pass) (interface{}, error) {
+ Run: func(p *analysis.Pass) (any, error) {
for _, f := range p.Files {
p.ReportRangef(f.Name, "package name is %s", f.Name.Name)
}
diff --git a/go/analysis/internal/checker/fix_test.go b/go/analysis/internal/checker/fix_test.go
index 8fb7506ac70..00710cc0e1b 100644
--- a/go/analysis/internal/checker/fix_test.go
+++ b/go/analysis/internal/checker/fix_test.go
@@ -52,9 +52,9 @@ func TestMain(m *testing.M) {
}
const (
- exitCodeSuccess = 0 // success (no diagnostics)
+ exitCodeSuccess = 0 // success (no diagnostics, or successful -fix)
exitCodeFailed = 1 // analysis failed to run
- exitCodeDiagnostics = 3 // diagnostics were reported
+ exitCodeDiagnostics = 3 // diagnostics were reported (and no -fix)
)
// TestReportInvalidDiagnostic tests that a call to pass.Report with
@@ -93,7 +93,7 @@ func TestReportInvalidDiagnostic(t *testing.T) {
// TextEdit has invalid Pos.
{
"bad Pos",
- `analyzer "a" suggests invalid fix .*: missing file info for pos`,
+ `analyzer "a" suggests invalid fix .*: no token.File for TextEdit.Pos .0.`,
func(pos token.Pos) analysis.Diagnostic {
return analysis.Diagnostic{
Pos: pos,
@@ -110,7 +110,7 @@ func TestReportInvalidDiagnostic(t *testing.T) {
// TextEdit has invalid End.
{
"End < Pos",
- `analyzer "a" suggests invalid fix .*: pos .* > end`,
+ `analyzer "a" suggests invalid fix .*: TextEdit.Pos .* > TextEdit.End .*`,
func(pos token.Pos) analysis.Diagnostic {
return analysis.Diagnostic{
Pos: pos,
@@ -281,6 +281,9 @@ func TestScript(t *testing.T) {
t.Logf("%s: $ %s\nstdout:\n%s\nstderr:\n%s", prefix, clean(cmd), stdout, lastStderr)
}
+ // Keep error reporting logic below consistent with
+ // applyDiffsAndCompare in ../../analysistest/analysistest.go!
+
unified := func(xlabel, ylabel string, x, y []byte) string {
x = append(slices.Clip(bytes.TrimSpace(x)), '\n')
y = append(slices.Clip(bytes.TrimSpace(y)), '\n')
diff --git a/go/analysis/internal/checker/start_test.go b/go/analysis/internal/checker/start_test.go
index 618ccd09b93..60ed54464ae 100644
--- a/go/analysis/internal/checker/start_test.go
+++ b/go/analysis/internal/checker/start_test.go
@@ -40,6 +40,7 @@ package comment
path := filepath.Join(testdata, "src/comment/doc.go")
checker.Fix = true
checker.Run([]string{"file=" + path}, []*analysis.Analyzer{commentAnalyzer})
+ checker.Fix = false
contents, err := os.ReadFile(path)
if err != nil {
@@ -61,7 +62,7 @@ var commentAnalyzer = &analysis.Analyzer{
Run: commentRun,
}
-func commentRun(pass *analysis.Pass) (interface{}, error) {
+func commentRun(pass *analysis.Pass) (any, error) {
const (
from = "/* Package comment */"
to = "// Package comment"
diff --git a/go/analysis/internal/checker/testdata/diff.txt b/go/analysis/internal/checker/testdata/diff.txt
index 5a0c9c2a3b2..f11f01ad1e4 100644
--- a/go/analysis/internal/checker/testdata/diff.txt
+++ b/go/analysis/internal/checker/testdata/diff.txt
@@ -8,8 +8,7 @@
skip GOOS=windows
checker -rename -fix -diff example.com/p
-exit 3
-stderr renaming "bar" to "baz"
+exit 0
-- go.mod --
module example.com
diff --git a/go/analysis/internal/checker/testdata/fixes.txt b/go/analysis/internal/checker/testdata/fixes.txt
index 89f245f9ace..4d906ca3f54 100644
--- a/go/analysis/internal/checker/testdata/fixes.txt
+++ b/go/analysis/internal/checker/testdata/fixes.txt
@@ -2,9 +2,9 @@
# particular when processing duplicate fixes for overlapping packages
# in the same directory ("p", "p [p.test]", "p_test [p.test]").
-checker -rename -fix example.com/p
-exit 3
-stderr renaming "bar" to "baz"
+checker -rename -fix -v example.com/p
+stderr applied 8 fixes, updated 3 files
+exit 0
-- go.mod --
module example.com
diff --git a/go/analysis/internal/checker/testdata/importdup.txt b/go/analysis/internal/checker/testdata/importdup.txt
index e1783777858..4c144a61221 100644
--- a/go/analysis/internal/checker/testdata/importdup.txt
+++ b/go/analysis/internal/checker/testdata/importdup.txt
@@ -1,8 +1,9 @@
# Test that duplicate imports--and, more generally, duplicate
# identical insertions--are coalesced.
-checker -marker -fix example.com/a
-exit 3
+checker -marker -fix -v example.com/a
+stderr applied 2 fixes, updated 1 files
+exit 0
-- go.mod --
module example.com
diff --git a/go/analysis/internal/checker/testdata/importdup2.txt b/go/analysis/internal/checker/testdata/importdup2.txt
index 118fdc0184b..c2da0f33195 100644
--- a/go/analysis/internal/checker/testdata/importdup2.txt
+++ b/go/analysis/internal/checker/testdata/importdup2.txt
@@ -19,8 +19,9 @@
# In more complex examples, the result
# may be more subtly order-dependent.
-checker -marker -fix example.com/a example.com/b
-exit 3
+checker -marker -fix -v example.com/a example.com/b
+stderr applied 6 fixes, updated 2 files
+exit 0
-- go.mod --
module example.com
diff --git a/go/analysis/internal/checker/testdata/noend.txt b/go/analysis/internal/checker/testdata/noend.txt
index 2d6be074565..5ebc5e011ba 100644
--- a/go/analysis/internal/checker/testdata/noend.txt
+++ b/go/analysis/internal/checker/testdata/noend.txt
@@ -2,8 +2,7 @@
# interpreted as if equal to SuggestedFix.Pos (see issue #64199).
checker -noend -fix example.com/a
-exit 3
-stderr say hello
+exit 0
-- go.mod --
module example.com
diff --git a/go/analysis/internal/checker/testdata/overlap.txt b/go/analysis/internal/checker/testdata/overlap.txt
index f556ef308b9..581f2e18950 100644
--- a/go/analysis/internal/checker/testdata/overlap.txt
+++ b/go/analysis/internal/checker/testdata/overlap.txt
@@ -15,9 +15,12 @@
# (This is a pretty unlikely situation, but it corresponds
# to a historical test, TestOther, that used to check for
# a conflict, and it seemed wrong to delete it without explanation.)
+#
+# The fixes are silently and successfully applied.
-checker -rename -marker -fix example.com/a
-exit 3
+checker -rename -marker -fix -v example.com/a
+stderr applied 2 fixes, updated 1 file
+exit 0
-- go.mod --
module example.com
diff --git a/go/analysis/internal/internal.go b/go/analysis/internal/internal.go
index e7c8247fd33..327c4b50579 100644
--- a/go/analysis/internal/internal.go
+++ b/go/analysis/internal/internal.go
@@ -9,4 +9,4 @@ import "golang.org/x/tools/go/analysis"
// This function is set by the checker package to provide
// backdoor access to the private Pass field
// of the checker.Action type, for use by analysistest.
-var Pass func(interface{}) *analysis.Pass
+var Pass func(any) *analysis.Pass
diff --git a/go/analysis/internal/versiontest/version_test.go b/go/analysis/internal/versiontest/version_test.go
index 43c52f565f7..5bd6d3027dd 100644
--- a/go/analysis/internal/versiontest/version_test.go
+++ b/go/analysis/internal/versiontest/version_test.go
@@ -26,7 +26,7 @@ import (
var analyzer = &analysis.Analyzer{
Name: "versiontest",
Doc: "off",
- Run: func(pass *analysis.Pass) (interface{}, error) {
+ Run: func(pass *analysis.Pass) (any, error) {
pass.Reportf(pass.Files[0].Package, "goversion=%s", pass.Pkg.GoVersion())
return nil, nil
},
diff --git a/go/analysis/multichecker/multichecker_test.go b/go/analysis/multichecker/multichecker_test.go
index 07bf977369b..1491df153b9 100644
--- a/go/analysis/multichecker/multichecker_test.go
+++ b/go/analysis/multichecker/multichecker_test.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build go1.12
-// +build go1.12
package multichecker_test
@@ -24,7 +23,7 @@ func main() {
fail := &analysis.Analyzer{
Name: "fail",
Doc: "always fail on a package 'sort'",
- Run: func(pass *analysis.Pass) (interface{}, error) {
+ Run: func(pass *analysis.Pass) (any, error) {
if pass.Pkg.Path() == "sort" {
return nil, fmt.Errorf("failed")
}
diff --git a/go/analysis/passes/appends/appends.go b/go/analysis/passes/appends/appends.go
index 6976f0d9090..e554c3cc903 100644
--- a/go/analysis/passes/appends/appends.go
+++ b/go/analysis/passes/appends/appends.go
@@ -29,7 +29,7 @@ var Analyzer = &analysis.Analyzer{
Run: run,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
diff --git a/go/analysis/passes/asmdecl/asmdecl.go b/go/analysis/passes/asmdecl/asmdecl.go
index a47ecbae731..436b03cb290 100644
--- a/go/analysis/passes/asmdecl/asmdecl.go
+++ b/go/analysis/passes/asmdecl/asmdecl.go
@@ -150,7 +150,7 @@ var (
abiSuff = re(`^(.+)<(ABI.+)>$`)
)
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
// No work if no assembly files.
var sfiles []string
for _, fname := range pass.OtherFiles {
@@ -226,7 +226,7 @@ Files:
for lineno, line := range lines {
lineno++
- badf := func(format string, args ...interface{}) {
+ badf := func(format string, args ...any) {
pass.Reportf(analysisutil.LineStart(tf, lineno), "[%s] %s: %s", arch, fnName, fmt.Sprintf(format, args...))
}
@@ -646,7 +646,7 @@ func asmParseDecl(pass *analysis.Pass, decl *ast.FuncDecl) map[string]*asmFunc {
}
// asmCheckVar checks a single variable reference.
-func asmCheckVar(badf func(string, ...interface{}), fn *asmFunc, line, expr string, off int, v *asmVar, archDef *asmArch) {
+func asmCheckVar(badf func(string, ...any), fn *asmFunc, line, expr string, off int, v *asmVar, archDef *asmArch) {
m := asmOpcode.FindStringSubmatch(line)
if m == nil {
if !strings.HasPrefix(strings.TrimSpace(line), "//") {
diff --git a/go/analysis/passes/buildssa/buildssa.go b/go/analysis/passes/buildssa/buildssa.go
index f077ea28247..f49fea51762 100644
--- a/go/analysis/passes/buildssa/buildssa.go
+++ b/go/analysis/passes/buildssa/buildssa.go
@@ -32,7 +32,7 @@ type SSA struct {
SrcFuncs []*ssa.Function
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
// We must create a new Program for each Package because the
// analysis API provides no place to hang a Program shared by
// all Packages. Consequently, SSA Packages and Functions do not
diff --git a/go/analysis/passes/buildtag/buildtag.go b/go/analysis/passes/buildtag/buildtag.go
index e7434e8fed2..6c7a0df585d 100644
--- a/go/analysis/passes/buildtag/buildtag.go
+++ b/go/analysis/passes/buildtag/buildtag.go
@@ -26,7 +26,7 @@ var Analyzer = &analysis.Analyzer{
Run: runBuildTag,
}
-func runBuildTag(pass *analysis.Pass) (interface{}, error) {
+func runBuildTag(pass *analysis.Pass) (any, error) {
for _, f := range pass.Files {
checkGoFile(pass, f)
}
diff --git a/go/analysis/passes/cgocall/cgocall.go b/go/analysis/passes/cgocall/cgocall.go
index 4f3bb035d65..d9189b5b696 100644
--- a/go/analysis/passes/cgocall/cgocall.go
+++ b/go/analysis/passes/cgocall/cgocall.go
@@ -55,7 +55,7 @@ func run(pass *analysis.Pass) (any, error) {
return nil, nil
}
-func checkCgo(fset *token.FileSet, f *ast.File, info *types.Info, reportf func(token.Pos, string, ...interface{})) {
+func checkCgo(fset *token.FileSet, f *ast.File, info *types.Info, reportf func(token.Pos, string, ...any)) {
ast.Inspect(f, func(n ast.Node) bool {
call, ok := n.(*ast.CallExpr)
if !ok {
diff --git a/go/analysis/passes/composite/composite.go b/go/analysis/passes/composite/composite.go
index f56c3e622fb..25c98a97bbc 100644
--- a/go/analysis/passes/composite/composite.go
+++ b/go/analysis/passes/composite/composite.go
@@ -51,7 +51,7 @@ func init() {
// runUnkeyedLiteral checks if a composite literal is a struct literal with
// unkeyed fields.
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
@@ -115,7 +115,7 @@ func run(pass *analysis.Pass) (interface{}, error) {
missingKeys = append(missingKeys, analysis.TextEdit{
Pos: e.Pos(),
End: e.Pos(),
- NewText: []byte(fmt.Sprintf("%s: ", field.Name())),
+ NewText: fmt.Appendf(nil, "%s: ", field.Name()),
})
}
}
diff --git a/go/analysis/passes/copylock/copylock.go b/go/analysis/passes/copylock/copylock.go
index a9f02ac62e6..a4e455d9b30 100644
--- a/go/analysis/passes/copylock/copylock.go
+++ b/go/analysis/passes/copylock/copylock.go
@@ -36,7 +36,7 @@ var Analyzer = &analysis.Analyzer{
Run: run,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
var goversion string // effective file version ("" => unknown)
@@ -355,7 +355,7 @@ func lockPath(tpkg *types.Package, typ types.Type, seen map[types.Type]bool) typ
}
nfields := styp.NumFields()
- for i := 0; i < nfields; i++ {
+ for i := range nfields {
ftyp := styp.Field(i).Type()
subpath := lockPath(tpkg, ftyp, seen)
if subpath != nil {
@@ -378,7 +378,7 @@ var lockerType *types.Interface
// Construct a sync.Locker interface type.
func init() {
- nullary := types.NewSignature(nil, nil, nil, false) // func()
+ nullary := types.NewSignatureType(nil, nil, nil, nil, nil, false) // func()
methods := []*types.Func{
types.NewFunc(token.NoPos, nil, "Lock", nullary),
types.NewFunc(token.NoPos, nil, "Unlock", nullary),
diff --git a/go/analysis/passes/ctrlflow/ctrlflow.go b/go/analysis/passes/ctrlflow/ctrlflow.go
index d21adeee900..951aaed00fd 100644
--- a/go/analysis/passes/ctrlflow/ctrlflow.go
+++ b/go/analysis/passes/ctrlflow/ctrlflow.go
@@ -80,7 +80,7 @@ func (c *CFGs) FuncLit(lit *ast.FuncLit) *cfg.CFG {
return c.funcLits[lit].cfg
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
// Because CFG construction consumes and produces noReturn
diff --git a/go/analysis/passes/defers/cmd/defers/gotypesalias.go b/go/analysis/passes/defers/cmd/defers/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/analysis/passes/defers/cmd/defers/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/analysis/passes/directive/directive.go b/go/analysis/passes/directive/directive.go
index b205402388e..bebec891408 100644
--- a/go/analysis/passes/directive/directive.go
+++ b/go/analysis/passes/directive/directive.go
@@ -40,7 +40,7 @@ var Analyzer = &analysis.Analyzer{
Run: runDirective,
}
-func runDirective(pass *analysis.Pass) (interface{}, error) {
+func runDirective(pass *analysis.Pass) (any, error) {
for _, f := range pass.Files {
checkGoFile(pass, f)
}
diff --git a/go/analysis/passes/errorsas/errorsas_test.go b/go/analysis/passes/errorsas/errorsas_test.go
index 6689d8114a7..5414f9e8b6d 100644
--- a/go/analysis/passes/errorsas/errorsas_test.go
+++ b/go/analysis/passes/errorsas/errorsas_test.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build go1.13
-// +build go1.13
package errorsas_test
diff --git a/go/analysis/passes/fieldalignment/cmd/fieldalignment/gotypesalias.go b/go/analysis/passes/fieldalignment/cmd/fieldalignment/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/analysis/passes/fieldalignment/cmd/fieldalignment/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/analysis/passes/fieldalignment/fieldalignment.go b/go/analysis/passes/fieldalignment/fieldalignment.go
index 93fa39140e6..4987ec5afdd 100644
--- a/go/analysis/passes/fieldalignment/fieldalignment.go
+++ b/go/analysis/passes/fieldalignment/fieldalignment.go
@@ -65,7 +65,7 @@ var Analyzer = &analysis.Analyzer{
Run: run,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
(*ast.StructType)(nil),
@@ -168,7 +168,7 @@ func optimalOrder(str *types.Struct, sizes *gcSizes) (*types.Struct, []int) {
}
elems := make([]elem, nf)
- for i := 0; i < nf; i++ {
+ for i := range nf {
field := str.Field(i)
ft := field.Type()
elems[i] = elem{
@@ -312,7 +312,7 @@ func (s *gcSizes) Sizeof(T types.Type) int64 {
var o int64
max := int64(1)
- for i := 0; i < nf; i++ {
+ for i := range nf {
ft := t.Field(i).Type()
a, sz := s.Alignof(ft), s.Sizeof(ft)
if a > max {
@@ -366,7 +366,7 @@ func (s *gcSizes) ptrdata(T types.Type) int64 {
}
var o, p int64
- for i := 0; i < nf; i++ {
+ for i := range nf {
ft := t.Field(i).Type()
a, sz := s.Alignof(ft), s.Sizeof(ft)
fp := s.ptrdata(ft)
diff --git a/go/analysis/passes/findcall/cmd/findcall/gotypesalias.go b/go/analysis/passes/findcall/cmd/findcall/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/analysis/passes/findcall/cmd/findcall/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/analysis/passes/findcall/findcall.go b/go/analysis/passes/findcall/findcall.go
index 2671573d1fe..9db4de1c20f 100644
--- a/go/analysis/passes/findcall/findcall.go
+++ b/go/analysis/passes/findcall/findcall.go
@@ -38,7 +38,7 @@ func init() {
Analyzer.Flags.StringVar(&name, "name", name, "name of the function to find")
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
for _, f := range pass.Files {
ast.Inspect(f, func(n ast.Node) bool {
if call, ok := n.(*ast.CallExpr); ok {
diff --git a/go/analysis/passes/framepointer/framepointer.go b/go/analysis/passes/framepointer/framepointer.go
index 8012de99daa..ba94fd68ea4 100644
--- a/go/analysis/passes/framepointer/framepointer.go
+++ b/go/analysis/passes/framepointer/framepointer.go
@@ -113,7 +113,7 @@ var arm64Branch = map[string]bool{
"RET": true,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
arch, ok := arches[build.Default.GOARCH]
if !ok {
return nil, nil
diff --git a/go/analysis/passes/httpmux/cmd/httpmux/gotypesalias.go b/go/analysis/passes/httpmux/cmd/httpmux/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/analysis/passes/httpmux/cmd/httpmux/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/analysis/passes/httpmux/httpmux.go b/go/analysis/passes/httpmux/httpmux.go
index 58d3ed5daca..655b78fd1cb 100644
--- a/go/analysis/passes/httpmux/httpmux.go
+++ b/go/analysis/passes/httpmux/httpmux.go
@@ -9,6 +9,7 @@ import (
"go/constant"
"go/types"
"regexp"
+ "slices"
"strings"
"golang.org/x/mod/semver"
@@ -103,12 +104,7 @@ func isMethodNamed(f *types.Func, pkgPath string, names ...string) bool {
if f.Type().(*types.Signature).Recv() == nil {
return false // not a method
}
- for _, n := range names {
- if f.Name() == n {
- return true
- }
- }
- return false // not in names
+ return slices.Contains(names, f.Name())
}
// stringConstantExpr returns expression's string constant value.
diff --git a/go/analysis/passes/ifaceassert/cmd/ifaceassert/gotypesalias.go b/go/analysis/passes/ifaceassert/cmd/ifaceassert/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/analysis/passes/ifaceassert/cmd/ifaceassert/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/analysis/passes/ifaceassert/ifaceassert.go b/go/analysis/passes/ifaceassert/ifaceassert.go
index 5f07ed3ffde..4022dbe7c22 100644
--- a/go/analysis/passes/ifaceassert/ifaceassert.go
+++ b/go/analysis/passes/ifaceassert/ifaceassert.go
@@ -52,7 +52,7 @@ func assertableTo(free *typeparams.Free, v, t types.Type) *types.Func {
return nil
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
(*ast.TypeAssertExpr)(nil),
diff --git a/go/analysis/passes/inspect/inspect.go b/go/analysis/passes/inspect/inspect.go
index 3b121cb0ce7..ee1972f56df 100644
--- a/go/analysis/passes/inspect/inspect.go
+++ b/go/analysis/passes/inspect/inspect.go
@@ -44,6 +44,6 @@ var Analyzer = &analysis.Analyzer{
ResultType: reflect.TypeOf(new(inspector.Inspector)),
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
return inspector.New(pass.Files), nil
}
diff --git a/go/analysis/passes/loopclosure/loopclosure.go b/go/analysis/passes/loopclosure/loopclosure.go
index d3181242153..64df1b106a1 100644
--- a/go/analysis/passes/loopclosure/loopclosure.go
+++ b/go/analysis/passes/loopclosure/loopclosure.go
@@ -30,7 +30,7 @@ var Analyzer = &analysis.Analyzer{
Run: run,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
diff --git a/go/analysis/passes/lostcancel/cmd/lostcancel/gotypesalias.go b/go/analysis/passes/lostcancel/cmd/lostcancel/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/analysis/passes/lostcancel/cmd/lostcancel/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/analysis/passes/lostcancel/lostcancel.go b/go/analysis/passes/lostcancel/lostcancel.go
index f8a661aa5db..a7fee180925 100644
--- a/go/analysis/passes/lostcancel/lostcancel.go
+++ b/go/analysis/passes/lostcancel/lostcancel.go
@@ -47,7 +47,7 @@ var contextPackage = "context"
// containing the assignment, we assume that other uses exist.
//
// checkLostCancel analyzes a single named or literal function.
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
// Fast path: bypass check if file doesn't use context.WithCancel.
if !analysisinternal.Imports(pass.Pkg, contextPackage) {
return nil, nil
diff --git a/go/analysis/passes/nilfunc/nilfunc.go b/go/analysis/passes/nilfunc/nilfunc.go
index 778f7f1f8f9..fa1883b0c34 100644
--- a/go/analysis/passes/nilfunc/nilfunc.go
+++ b/go/analysis/passes/nilfunc/nilfunc.go
@@ -16,7 +16,7 @@ import (
"golang.org/x/tools/go/analysis/passes/inspect"
"golang.org/x/tools/go/analysis/passes/internal/analysisutil"
"golang.org/x/tools/go/ast/inspector"
- "golang.org/x/tools/internal/typeparams"
+ "golang.org/x/tools/internal/typesinternal"
)
//go:embed doc.go
@@ -30,7 +30,7 @@ var Analyzer = &analysis.Analyzer{
Run: run,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
@@ -55,24 +55,8 @@ func run(pass *analysis.Pass) (interface{}, error) {
return
}
- // Only want identifiers or selector expressions.
- var obj types.Object
- switch v := e2.(type) {
- case *ast.Ident:
- obj = pass.TypesInfo.Uses[v]
- case *ast.SelectorExpr:
- obj = pass.TypesInfo.Uses[v.Sel]
- case *ast.IndexExpr, *ast.IndexListExpr:
- // Check generic functions such as "f[T1,T2]".
- x, _, _, _ := typeparams.UnpackIndexExpr(v)
- if id, ok := x.(*ast.Ident); ok {
- obj = pass.TypesInfo.Uses[id]
- }
- default:
- return
- }
-
// Only want functions.
+ obj := pass.TypesInfo.Uses[typesinternal.UsedIdent(pass.TypesInfo, e2)]
if _, ok := obj.(*types.Func); !ok {
return
}
diff --git a/go/analysis/passes/nilness/cmd/nilness/gotypesalias.go b/go/analysis/passes/nilness/cmd/nilness/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/analysis/passes/nilness/cmd/nilness/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/analysis/passes/nilness/nilness.go b/go/analysis/passes/nilness/nilness.go
index faaf12a9385..af61ae6088d 100644
--- a/go/analysis/passes/nilness/nilness.go
+++ b/go/analysis/passes/nilness/nilness.go
@@ -28,7 +28,7 @@ var Analyzer = &analysis.Analyzer{
Requires: []*analysis.Analyzer{buildssa.Analyzer},
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
ssainput := pass.ResultOf[buildssa.Analyzer].(*buildssa.SSA)
for _, fn := range ssainput.SrcFuncs {
runFunc(pass, fn)
@@ -37,7 +37,7 @@ func run(pass *analysis.Pass) (interface{}, error) {
}
func runFunc(pass *analysis.Pass, fn *ssa.Function) {
- reportf := func(category string, pos token.Pos, format string, args ...interface{}) {
+ reportf := func(category string, pos token.Pos, format string, args ...any) {
// We ignore nil-checking ssa.Instructions
// that don't correspond to syntax.
if pos.IsValid() {
diff --git a/go/analysis/passes/pkgfact/pkgfact.go b/go/analysis/passes/pkgfact/pkgfact.go
index 077c8780815..31748795dac 100644
--- a/go/analysis/passes/pkgfact/pkgfact.go
+++ b/go/analysis/passes/pkgfact/pkgfact.go
@@ -53,7 +53,7 @@ type pairsFact []string
func (f *pairsFact) AFact() {}
func (f *pairsFact) String() string { return "pairs(" + strings.Join(*f, ", ") + ")" }
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
result := make(map[string]string)
// At each import, print the fact from the imported
diff --git a/go/analysis/passes/printf/printf.go b/go/analysis/passes/printf/printf.go
index 81600a283aa..a28ed365d1e 100644
--- a/go/analysis/passes/printf/printf.go
+++ b/go/analysis/passes/printf/printf.go
@@ -924,9 +924,14 @@ func checkPrint(pass *analysis.Pass, call *ast.CallExpr, name string) {
// The % in "abc 0.0%" couldn't be a formatting directive.
s = strings.TrimSuffix(s, "%")
if strings.Contains(s, "%") {
- m := printFormatRE.FindStringSubmatch(s)
- if m != nil {
- pass.ReportRangef(call, "%s call has possible Printf formatting directive %s", name, m[0])
+ for _, m := range printFormatRE.FindAllString(s, -1) {
+ // Allow %XX where XX are hex digits,
+ // as this is common in URLs.
+ if len(m) >= 3 && isHex(m[1]) && isHex(m[2]) {
+ continue
+ }
+ pass.ReportRangef(call, "%s call has possible Printf formatting directive %s", name, m)
+ break // report only the first one
}
}
}
@@ -992,3 +997,10 @@ func (ss stringSet) Set(flag string) error {
//
// Remove this after the 1.24 release.
var suppressNonconstants bool
+
+// isHex reports whether b is a hex digit.
+func isHex(b byte) bool {
+ return '0' <= b && b <= '9' ||
+ 'A' <= b && b <= 'F' ||
+ 'a' <= b && b <= 'f'
+}
diff --git a/go/analysis/passes/printf/testdata/src/a/a.go b/go/analysis/passes/printf/testdata/src/a/a.go
index 02ce425f8a3..da48f98f0a8 100644
--- a/go/analysis/passes/printf/testdata/src/a/a.go
+++ b/go/analysis/passes/printf/testdata/src/a/a.go
@@ -154,6 +154,8 @@ func PrintfTests() {
fmt.Println("%v", "hi") // want "fmt.Println call has possible Printf formatting directive %v"
fmt.Println("%T", "hi") // want "fmt.Println call has possible Printf formatting directive %T"
fmt.Println("%s"+" there", "hi") // want "fmt.Println call has possible Printf formatting directive %s"
+ fmt.Println("http://foo.com?q%2Fabc") // no diagnostic: %XX is excepted
+ fmt.Println("http://foo.com?q%2Fabc-%s") // want"fmt.Println call has possible Printf formatting directive %s"
fmt.Println("0.0%") // correct (trailing % couldn't be a formatting directive)
fmt.Printf("%s", "hi", 3) // want "fmt.Printf call needs 1 arg but has 2 args"
_ = fmt.Sprintf("%"+("s"), "hi", 3) // want "fmt.Sprintf call needs 1 arg but has 2 args"
diff --git a/go/analysis/passes/reflectvaluecompare/cmd/reflectvaluecompare/main.go b/go/analysis/passes/reflectvaluecompare/cmd/reflectvaluecompare/main.go
new file mode 100644
index 00000000000..f3f9e163913
--- /dev/null
+++ b/go/analysis/passes/reflectvaluecompare/cmd/reflectvaluecompare/main.go
@@ -0,0 +1,18 @@
+// Copyright 2025 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.
+
+// The reflectvaluecompare command applies the reflectvaluecompare
+// checker to the specified packages of Go source code.
+//
+// Run with:
+//
+// $ go run ./go/analysis/passes/reflectvaluecompare/cmd/reflectvaluecompare -- packages...
+package main
+
+import (
+ "golang.org/x/tools/go/analysis/passes/reflectvaluecompare"
+ "golang.org/x/tools/go/analysis/singlechecker"
+)
+
+func main() { singlechecker.Main(reflectvaluecompare.Analyzer) }
diff --git a/go/analysis/passes/reflectvaluecompare/reflectvaluecompare.go b/go/analysis/passes/reflectvaluecompare/reflectvaluecompare.go
index 72435b2fc7a..d0632dbdafe 100644
--- a/go/analysis/passes/reflectvaluecompare/reflectvaluecompare.go
+++ b/go/analysis/passes/reflectvaluecompare/reflectvaluecompare.go
@@ -28,7 +28,7 @@ var Analyzer = &analysis.Analyzer{
Run: run,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
diff --git a/go/analysis/passes/shadow/cmd/shadow/gotypesalias.go b/go/analysis/passes/shadow/cmd/shadow/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/analysis/passes/shadow/cmd/shadow/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/analysis/passes/shadow/shadow.go b/go/analysis/passes/shadow/shadow.go
index 30258c991f3..8f768bb76c5 100644
--- a/go/analysis/passes/shadow/shadow.go
+++ b/go/analysis/passes/shadow/shadow.go
@@ -36,7 +36,7 @@ func init() {
Analyzer.Flags.BoolVar(&strict, "strict", strict, "whether to be strict about shadowing; can be noisy")
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
spans := make(map[types.Object]span)
diff --git a/go/analysis/passes/shift/shift.go b/go/analysis/passes/shift/shift.go
index 46b5f6d68c6..57987b3d203 100644
--- a/go/analysis/passes/shift/shift.go
+++ b/go/analysis/passes/shift/shift.go
@@ -34,7 +34,7 @@ var Analyzer = &analysis.Analyzer{
Run: run,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
// Do a complete pass to compute dead nodes.
diff --git a/go/analysis/passes/stdmethods/stdmethods.go b/go/analysis/passes/stdmethods/stdmethods.go
index 28f51b1ec9a..a0bdf001abd 100644
--- a/go/analysis/passes/stdmethods/stdmethods.go
+++ b/go/analysis/passes/stdmethods/stdmethods.go
@@ -66,7 +66,7 @@ var canonicalMethods = map[string]struct{ args, results []string }{
"WriteTo": {[]string{"=io.Writer"}, []string{"int64", "error"}}, // io.WriterTo
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
diff --git a/go/analysis/passes/stdversion/main.go b/go/analysis/passes/stdversion/main.go
index 2156d41e4a9..bf1c3a0b31f 100644
--- a/go/analysis/passes/stdversion/main.go
+++ b/go/analysis/passes/stdversion/main.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build ignore
-// +build ignore
package main
diff --git a/go/analysis/passes/stringintconv/cmd/stringintconv/gotypesalias.go b/go/analysis/passes/stringintconv/cmd/stringintconv/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/analysis/passes/stringintconv/cmd/stringintconv/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/analysis/passes/stringintconv/string.go b/go/analysis/passes/stringintconv/string.go
index f56e6ecaa29..a23721cd26f 100644
--- a/go/analysis/passes/stringintconv/string.go
+++ b/go/analysis/passes/stringintconv/string.go
@@ -70,7 +70,7 @@ func typeName(t types.Type) string {
return ""
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
(*ast.File)(nil),
diff --git a/go/analysis/passes/structtag/structtag.go b/go/analysis/passes/structtag/structtag.go
index 4115ef76943..da4afd1b232 100644
--- a/go/analysis/passes/structtag/structtag.go
+++ b/go/analysis/passes/structtag/structtag.go
@@ -13,6 +13,7 @@ import (
"go/types"
"path/filepath"
"reflect"
+ "slices"
"strconv"
"strings"
@@ -34,7 +35,7 @@ var Analyzer = &analysis.Analyzer{
Run: run,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
@@ -167,11 +168,8 @@ func checkTagDuplicates(pass *analysis.Pass, tag, key string, nearest, field *ty
if i := strings.Index(val, ","); i >= 0 {
if key == "xml" {
// Use a separate namespace for XML attributes.
- for _, opt := range strings.Split(val[i:], ",") {
- if opt == "attr" {
- key += " attribute" // Key is part of the error message.
- break
- }
+ if slices.Contains(strings.Split(val[i:], ","), "attr") {
+ key += " attribute" // Key is part of the error message.
}
}
val = val[:i]
diff --git a/go/analysis/passes/testinggoroutine/testinggoroutine.go b/go/analysis/passes/testinggoroutine/testinggoroutine.go
index fef5a6014c4..f49ac4eb1a0 100644
--- a/go/analysis/passes/testinggoroutine/testinggoroutine.go
+++ b/go/analysis/passes/testinggoroutine/testinggoroutine.go
@@ -36,7 +36,7 @@ var Analyzer = &analysis.Analyzer{
Run: run,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
if !analysisinternal.Imports(pass.Pkg, "testing") {
diff --git a/go/analysis/passes/testinggoroutine/util.go b/go/analysis/passes/testinggoroutine/util.go
index 027c99e6b0f..88e77fb4fc4 100644
--- a/go/analysis/passes/testinggoroutine/util.go
+++ b/go/analysis/passes/testinggoroutine/util.go
@@ -7,6 +7,7 @@ package testinggoroutine
import (
"go/ast"
"go/types"
+ "slices"
"golang.org/x/tools/internal/typeparams"
)
@@ -48,12 +49,7 @@ func isMethodNamed(f *types.Func, pkgPath string, names ...string) bool {
if f.Type().(*types.Signature).Recv() == nil {
return false
}
- for _, n := range names {
- if f.Name() == n {
- return true
- }
- }
- return false
+ return slices.Contains(names, f.Name())
}
func funcIdent(fun ast.Expr) *ast.Ident {
diff --git a/go/analysis/passes/tests/tests.go b/go/analysis/passes/tests/tests.go
index 285b34218c3..9f59006ebb2 100644
--- a/go/analysis/passes/tests/tests.go
+++ b/go/analysis/passes/tests/tests.go
@@ -47,7 +47,7 @@ var acceptedFuzzTypes = []types.Type{
types.NewSlice(types.Universe.Lookup("byte").Type()),
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
for _, f := range pass.Files {
if !strings.HasSuffix(pass.Fset.File(f.FileStart).Name(), "_test.go") {
continue
diff --git a/go/analysis/passes/unmarshal/cmd/unmarshal/gotypesalias.go b/go/analysis/passes/unmarshal/cmd/unmarshal/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/analysis/passes/unmarshal/cmd/unmarshal/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/analysis/passes/unreachable/testdata/src/a/a.go b/go/analysis/passes/unreachable/testdata/src/a/a.go
index b283fd00b9a..136a07caa21 100644
--- a/go/analysis/passes/unreachable/testdata/src/a/a.go
+++ b/go/analysis/passes/unreachable/testdata/src/a/a.go
@@ -2118,11 +2118,6 @@ var _ = func() int {
println() // ok
}
-var _ = func() {
- // goto without label used to panic
- goto
-}
-
func _() int {
// Empty switch tag with non-bool case value used to panic.
switch {
diff --git a/go/analysis/passes/unreachable/testdata/src/a/a.go.golden b/go/analysis/passes/unreachable/testdata/src/a/a.go.golden
index 40494030423..79cb89d4181 100644
--- a/go/analysis/passes/unreachable/testdata/src/a/a.go.golden
+++ b/go/analysis/passes/unreachable/testdata/src/a/a.go.golden
@@ -2082,11 +2082,6 @@ var _ = func() int {
println() // ok
}
-var _ = func() {
- // goto without label used to panic
- goto
-}
-
func _() int {
// Empty switch tag with non-bool case value used to panic.
switch {
diff --git a/go/analysis/passes/unreachable/unreachable.go b/go/analysis/passes/unreachable/unreachable.go
index b810db7ee95..fcf5fbd9060 100644
--- a/go/analysis/passes/unreachable/unreachable.go
+++ b/go/analysis/passes/unreachable/unreachable.go
@@ -30,7 +30,7 @@ var Analyzer = &analysis.Analyzer{
Run: run,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
diff --git a/go/analysis/passes/unsafeptr/unsafeptr.go b/go/analysis/passes/unsafeptr/unsafeptr.go
index fb5b944faad..57c6da64ff3 100644
--- a/go/analysis/passes/unsafeptr/unsafeptr.go
+++ b/go/analysis/passes/unsafeptr/unsafeptr.go
@@ -30,7 +30,7 @@ var Analyzer = &analysis.Analyzer{
Run: run,
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
nodeFilter := []ast.Node{
diff --git a/go/analysis/passes/unusedresult/cmd/unusedresult/gotypesalias.go b/go/analysis/passes/unusedresult/cmd/unusedresult/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/analysis/passes/unusedresult/cmd/unusedresult/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/analysis/passes/unusedresult/unusedresult.go b/go/analysis/passes/unusedresult/unusedresult.go
index d7cc1e6ae2c..932f1347e56 100644
--- a/go/analysis/passes/unusedresult/unusedresult.go
+++ b/go/analysis/passes/unusedresult/unusedresult.go
@@ -85,7 +85,7 @@ func init() {
"comma-separated list of names of methods of type func() string whose results must be used")
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
// Split functions into (pkg, name) pairs to save allocation later.
@@ -130,9 +130,7 @@ func run(pass *analysis.Pass) (interface{}, error) {
}
// func() string
-var sigNoArgsStringResult = types.NewSignature(nil, nil,
- types.NewTuple(types.NewParam(token.NoPos, nil, "", types.Typ[types.String])),
- false)
+var sigNoArgsStringResult = types.NewSignatureType(nil, nil, nil, nil, types.NewTuple(types.NewParam(token.NoPos, nil, "", types.Typ[types.String])), false)
type stringSetFlag map[string]bool
diff --git a/go/analysis/passes/usesgenerics/usesgenerics.go b/go/analysis/passes/usesgenerics/usesgenerics.go
index 5c5df3a79a0..b7ff3ad6877 100644
--- a/go/analysis/passes/usesgenerics/usesgenerics.go
+++ b/go/analysis/passes/usesgenerics/usesgenerics.go
@@ -53,7 +53,7 @@ type featuresFact struct {
func (f *featuresFact) AFact() {}
func (f *featuresFact) String() string { return f.Features.String() }
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
direct := genericfeatures.ForPackage(inspect, pass.TypesInfo)
diff --git a/go/analysis/unitchecker/main.go b/go/analysis/unitchecker/main.go
index 4374e7bf945..246be909249 100644
--- a/go/analysis/unitchecker/main.go
+++ b/go/analysis/unitchecker/main.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build ignore
-// +build ignore
// This file provides an example command for static checkers
// conforming to the golang.org/x/tools/go/analysis API.
diff --git a/go/analysis/unitchecker/unitchecker.go b/go/analysis/unitchecker/unitchecker.go
index 82c3db6a39d..a1ee80388b6 100644
--- a/go/analysis/unitchecker/unitchecker.go
+++ b/go/analysis/unitchecker/unitchecker.go
@@ -287,7 +287,7 @@ func run(fset *token.FileSet, cfg *Config, analyzers []*analysis.Analyzer) ([]re
// Also build a map to hold working state and result.
type action struct {
once sync.Once
- result interface{}
+ result any
err error
usesFacts bool // (transitively uses)
diagnostics []analysis.Diagnostic
@@ -337,7 +337,7 @@ func run(fset *token.FileSet, cfg *Config, analyzers []*analysis.Analyzer) ([]re
// The inputs to this analysis are the
// results of its prerequisites.
- inputs := make(map[*analysis.Analyzer]interface{})
+ inputs := make(map[*analysis.Analyzer]any)
var failed []string
for _, req := range a.Requires {
reqact := exec(req)
diff --git a/go/analysis/unitchecker/unitchecker_test.go b/go/analysis/unitchecker/unitchecker_test.go
index 173d76348f7..6c3bba6793e 100644
--- a/go/analysis/unitchecker/unitchecker_test.go
+++ b/go/analysis/unitchecker/unitchecker_test.go
@@ -59,7 +59,7 @@ func testIntegration(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a
func _() {
diff --git a/go/analysis/validate.go b/go/analysis/validate.go
index 4f2c4045622..14539392116 100644
--- a/go/analysis/validate.go
+++ b/go/analysis/validate.go
@@ -63,7 +63,7 @@ func Validate(analyzers []*Analyzer) error {
return fmt.Errorf("fact type %s registered by two analyzers: %v, %v",
t, a, prev)
}
- if t.Kind() != reflect.Ptr {
+ if t.Kind() != reflect.Pointer {
return fmt.Errorf("%s: fact type %s is not a pointer", a, t)
}
factTypes[t] = a
diff --git a/go/analysis/validate_test.go b/go/analysis/validate_test.go
index 7f4ee2c05b9..b192ef0a3c0 100644
--- a/go/analysis/validate_test.go
+++ b/go/analysis/validate_test.go
@@ -11,7 +11,7 @@ import (
func TestValidate(t *testing.T) {
var (
- run = func(p *Pass) (interface{}, error) {
+ run = func(p *Pass) (any, error) {
return nil, nil
}
dependsOnSelf = &Analyzer{
@@ -130,7 +130,7 @@ func TestCycleInRequiresGraphErrorMessage(t *testing.T) {
func TestValidateEmptyDoc(t *testing.T) {
withoutDoc := &Analyzer{
Name: "withoutDoc",
- Run: func(p *Pass) (interface{}, error) {
+ Run: func(p *Pass) (any, error) {
return nil, nil
},
}
diff --git a/go/ast/astutil/imports.go b/go/ast/astutil/imports.go
index a6b5ed0a893..5e5601aa467 100644
--- a/go/ast/astutil/imports.go
+++ b/go/ast/astutil/imports.go
@@ -9,6 +9,7 @@ import (
"fmt"
"go/ast"
"go/token"
+ "slices"
"strconv"
"strings"
)
@@ -186,7 +187,7 @@ func AddNamedImport(fset *token.FileSet, f *ast.File, name, path string) (added
spec.(*ast.ImportSpec).Path.ValuePos = first.Pos()
first.Specs = append(first.Specs, spec)
}
- f.Decls = append(f.Decls[:i], f.Decls[i+1:]...)
+ f.Decls = slices.Delete(f.Decls, i, i+1)
i--
}
diff --git a/go/ast/astutil/rewrite.go b/go/ast/astutil/rewrite.go
index 58934f76633..5c8dbbb7a35 100644
--- a/go/ast/astutil/rewrite.go
+++ b/go/ast/astutil/rewrite.go
@@ -183,7 +183,7 @@ type application struct {
func (a *application) apply(parent ast.Node, name string, iter *iterator, n ast.Node) {
// convert typed nil into untyped nil
- if v := reflect.ValueOf(n); v.Kind() == reflect.Ptr && v.IsNil() {
+ if v := reflect.ValueOf(n); v.Kind() == reflect.Pointer && v.IsNil() {
n = nil
}
diff --git a/go/ast/astutil/rewrite_test.go b/go/ast/astutil/rewrite_test.go
index 57136a07cab..2e1c77034c8 100644
--- a/go/ast/astutil/rewrite_test.go
+++ b/go/ast/astutil/rewrite_test.go
@@ -244,7 +244,6 @@ func vardecl(name, typ string) *ast.GenDecl {
func TestRewrite(t *testing.T) {
t.Run("*", func(t *testing.T) {
for _, test := range rewriteTests {
- test := test
t.Run(test.name, func(t *testing.T) {
t.Parallel()
fset := token.NewFileSet()
diff --git a/go/ast/astutil/util.go b/go/ast/astutil/util.go
index ca71e3e1055..c820b208499 100644
--- a/go/ast/astutil/util.go
+++ b/go/ast/astutil/util.go
@@ -8,4 +8,6 @@ import "go/ast"
// Unparen returns e with any enclosing parentheses stripped.
// Deprecated: use [ast.Unparen].
+//
+//go:fix inline
func Unparen(e ast.Expr) ast.Expr { return ast.Unparen(e) }
diff --git a/go/ast/inspector/inspector.go b/go/ast/inspector/inspector.go
index 0d5050fe405..1da4a361f0b 100644
--- a/go/ast/inspector/inspector.go
+++ b/go/ast/inspector/inspector.go
@@ -10,6 +10,7 @@
// builds a list of push/pop events and their node type. Subsequent
// method calls that request a traversal scan this list, rather than walk
// the AST, and perform type filtering using efficient bit sets.
+// This representation is sometimes called a "balanced parenthesis tree."
//
// Experiments suggest the inspector's traversals are about 2.5x faster
// than ast.Inspect, but it may take around 5 traversals for this
@@ -50,6 +51,7 @@ type Inspector struct {
//go:linkname events
func events(in *Inspector) []event { return in.events }
+//go:linkname packEdgeKindAndIndex
func packEdgeKindAndIndex(ek edge.Kind, index int) int32 {
return int32(uint32(index+1)<<7 | uint32(ek))
}
diff --git a/go/buildutil/allpackages.go b/go/buildutil/allpackages.go
index dfb8cd6c7b0..32886a7175f 100644
--- a/go/buildutil/allpackages.go
+++ b/go/buildutil/allpackages.go
@@ -52,7 +52,6 @@ func ForEachPackage(ctxt *build.Context, found func(importPath string, err error
var wg sync.WaitGroup
for _, root := range ctxt.SrcDirs() {
- root := root
wg.Add(1)
go func() {
allPackages(ctxt, root, ch)
@@ -107,7 +106,6 @@ func allPackages(ctxt *build.Context, root string, ch chan<- item) {
ch <- item{pkg, err}
}
for _, fi := range files {
- fi := fi
if fi.IsDir() {
wg.Add(1)
go func() {
diff --git a/go/buildutil/allpackages_test.go b/go/buildutil/allpackages_test.go
index 6af86771104..2df5f27e223 100644
--- a/go/buildutil/allpackages_test.go
+++ b/go/buildutil/allpackages_test.go
@@ -5,7 +5,6 @@
// Incomplete source tree on Android.
//go:build !android
-// +build !android
package buildutil_test
diff --git a/go/buildutil/fakecontext.go b/go/buildutil/fakecontext.go
index 763d18809b4..1f75141d504 100644
--- a/go/buildutil/fakecontext.go
+++ b/go/buildutil/fakecontext.go
@@ -95,7 +95,7 @@ func (s byName) Less(i, j int) bool { return s[i].Name() < s[j].Name() }
type fakeFileInfo string
func (fi fakeFileInfo) Name() string { return string(fi) }
-func (fakeFileInfo) Sys() interface{} { return nil }
+func (fakeFileInfo) Sys() any { return nil }
func (fakeFileInfo) ModTime() time.Time { return time.Time{} }
func (fakeFileInfo) IsDir() bool { return false }
func (fakeFileInfo) Size() int64 { return 0 }
@@ -104,7 +104,7 @@ func (fakeFileInfo) Mode() os.FileMode { return 0644 }
type fakeDirInfo string
func (fd fakeDirInfo) Name() string { return string(fd) }
-func (fakeDirInfo) Sys() interface{} { return nil }
+func (fakeDirInfo) Sys() any { return nil }
func (fakeDirInfo) ModTime() time.Time { return time.Time{} }
func (fakeDirInfo) IsDir() bool { return true }
func (fakeDirInfo) Size() int64 { return 0 }
diff --git a/go/buildutil/tags.go b/go/buildutil/tags.go
index 32c8d1424d2..410c8e72d48 100644
--- a/go/buildutil/tags.go
+++ b/go/buildutil/tags.go
@@ -51,7 +51,7 @@ func (v *TagsFlag) Set(s string) error {
return nil
}
-func (v *TagsFlag) Get() interface{} { return *v }
+func (v *TagsFlag) Get() any { return *v }
func splitQuotedFields(s string) ([]string, error) {
// See $GOROOT/src/cmd/internal/quoted/quoted.go (Split)
diff --git a/go/callgraph/cha/cha_test.go b/go/callgraph/cha/cha_test.go
index 5ac64e17244..922541d6c56 100644
--- a/go/callgraph/cha/cha_test.go
+++ b/go/callgraph/cha/cha_test.go
@@ -5,7 +5,6 @@
// No testdata on Android.
//go:build !android
-// +build !android
package cha_test
@@ -41,7 +40,7 @@ var inputs = []string{
func expectation(f *ast.File) (string, token.Pos) {
for _, c := range f.Comments {
text := strings.TrimSpace(c.Text())
- if t := strings.TrimPrefix(text, "WANT:\n"); t != text {
+ if t, ok := strings.CutPrefix(text, "WANT:\n"); ok {
return t, c.Pos()
}
}
diff --git a/go/callgraph/rta/rta.go b/go/callgraph/rta/rta.go
index b489b0178c8..224c0b96ce0 100644
--- a/go/callgraph/rta/rta.go
+++ b/go/callgraph/rta/rta.go
@@ -371,7 +371,7 @@ func (r *rta) interfaces(C types.Type) []*types.Interface {
// Ascertain set of interfaces C implements
// and update the 'implements' relation.
- r.interfaceTypes.Iterate(func(I types.Type, v interface{}) {
+ r.interfaceTypes.Iterate(func(I types.Type, v any) {
iinfo := v.(*interfaceTypeInfo)
if I := types.Unalias(I).(*types.Interface); implements(cinfo, iinfo) {
iinfo.implementations = append(iinfo.implementations, C)
@@ -400,7 +400,7 @@ func (r *rta) implementations(I *types.Interface) []types.Type {
// Ascertain set of concrete types that implement I
// and update the 'implements' relation.
- r.concreteTypes.Iterate(func(C types.Type, v interface{}) {
+ r.concreteTypes.Iterate(func(C types.Type, v any) {
cinfo := v.(*concreteTypeInfo)
if implements(cinfo, iinfo) {
cinfo.implements = append(cinfo.implements, I)
diff --git a/go/callgraph/rta/rta_test.go b/go/callgraph/rta/rta_test.go
index 74e77b01291..8cfc73ee4db 100644
--- a/go/callgraph/rta/rta_test.go
+++ b/go/callgraph/rta/rta_test.go
@@ -5,7 +5,6 @@
// No testdata on Android.
//go:build !android
-// +build !android
package rta_test
@@ -106,7 +105,7 @@ func check(t *testing.T, f *ast.File, pkg *ssa.Package, res *rta.Result) {
expectation := func(f *ast.File) (string, int) {
for _, c := range f.Comments {
text := strings.TrimSpace(c.Text())
- if t := strings.TrimPrefix(text, "WANT:\n"); t != text {
+ if t, ok := strings.CutPrefix(text, "WANT:\n"); ok {
return t, tokFile.Line(c.Pos())
}
}
@@ -135,7 +134,7 @@ func check(t *testing.T, f *ast.File, pkg *ssa.Package, res *rta.Result) {
// A leading "!" negates the assertion.
sense := true
- if rest := strings.TrimPrefix(line, "!"); rest != line {
+ if rest, ok := strings.CutPrefix(line, "!"); ok {
sense = false
line = strings.TrimSpace(rest)
if line == "" {
@@ -221,7 +220,7 @@ func check(t *testing.T, f *ast.File, pkg *ssa.Package, res *rta.Result) {
// Check runtime types.
{
got := make(stringset)
- res.RuntimeTypes.Iterate(func(key types.Type, value interface{}) {
+ res.RuntimeTypes.Iterate(func(key types.Type, value any) {
if !value.(bool) { // accessible to reflection
typ := types.TypeString(types.Unalias(key), types.RelativeTo(pkg.Pkg))
got[typ] = true
diff --git a/go/callgraph/vta/graph.go b/go/callgraph/vta/graph.go
index c13b8a5e6cb..26225e7db37 100644
--- a/go/callgraph/vta/graph.go
+++ b/go/callgraph/vta/graph.go
@@ -8,6 +8,7 @@ import (
"fmt"
"go/token"
"go/types"
+ "iter"
"golang.org/x/tools/go/ssa"
"golang.org/x/tools/go/types/typeutil"
@@ -270,7 +271,7 @@ func (g *vtaGraph) numNodes() int {
return len(g.idx)
}
-func (g *vtaGraph) successors(x idx) func(yield func(y idx) bool) {
+func (g *vtaGraph) successors(x idx) iter.Seq[idx] {
return func(yield func(y idx) bool) {
for y := range g.m[x] {
if !yield(y) {
@@ -633,12 +634,12 @@ func (b *builder) call(c ssa.CallInstruction) {
return
}
- siteCallees(c, b.callees)(func(f *ssa.Function) bool {
+ for f := range siteCallees(c, b.callees) {
addArgumentFlows(b, c, f)
site, ok := c.(ssa.Value)
if !ok {
- return true // go or defer
+ continue // go or defer
}
results := f.Signature.Results()
@@ -653,8 +654,7 @@ func (b *builder) call(c ssa.CallInstruction) {
b.addInFlowEdge(resultVar{f: f, index: i}, local)
}
}
- return true
- })
+ }
}
func addArgumentFlows(b *builder, c ssa.CallInstruction, f *ssa.Function) {
diff --git a/go/callgraph/vta/graph_test.go b/go/callgraph/vta/graph_test.go
index 9e780c7e4e2..725749ea6ab 100644
--- a/go/callgraph/vta/graph_test.go
+++ b/go/callgraph/vta/graph_test.go
@@ -148,7 +148,9 @@ func TestVtaGraph(t *testing.T) {
{n4, 0},
} {
sl := 0
- g.successors(g.idx[test.n])(func(_ idx) bool { sl++; return true })
+ for range g.successors(g.idx[test.n]) {
+ sl++
+ }
if sl != test.l {
t.Errorf("want %d successors; got %d", test.l, sl)
}
@@ -163,10 +165,10 @@ func vtaGraphStr(g *vtaGraph) []string {
var vgs []string
for n := 0; n < g.numNodes(); n++ {
var succStr []string
- g.successors(idx(n))(func(s idx) bool {
+ for s := range g.successors(idx(n)) {
succStr = append(succStr, g.node[s].String())
- return true
- })
+ }
+
sort.Strings(succStr)
entry := fmt.Sprintf("%v -> %v", g.node[n].String(), strings.Join(succStr, ", "))
vgs = append(vgs, removeModulePrefix(entry))
diff --git a/go/callgraph/vta/helpers_test.go b/go/callgraph/vta/helpers_test.go
index 59a9277f759..be5e756dcd5 100644
--- a/go/callgraph/vta/helpers_test.go
+++ b/go/callgraph/vta/helpers_test.go
@@ -28,7 +28,7 @@ import (
func want(f *ast.File) []string {
for _, c := range f.Comments {
text := strings.TrimSpace(c.Text())
- if t := strings.TrimPrefix(text, "WANT:\n"); t != text {
+ if t, ok := strings.CutPrefix(text, "WANT:\n"); ok {
return strings.Split(t, "\n")
}
}
diff --git a/go/callgraph/vta/internal/trie/bits_test.go b/go/callgraph/vta/internal/trie/bits_test.go
index 07784cdffac..f6e510eccd0 100644
--- a/go/callgraph/vta/internal/trie/bits_test.go
+++ b/go/callgraph/vta/internal/trie/bits_test.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build go1.13
-// +build go1.13
package trie
diff --git a/go/callgraph/vta/internal/trie/builder.go b/go/callgraph/vta/internal/trie/builder.go
index c814c039f72..bdd39397ec6 100644
--- a/go/callgraph/vta/internal/trie/builder.go
+++ b/go/callgraph/vta/internal/trie/builder.go
@@ -14,13 +14,13 @@ package trie
//
// Collisions functions may be applied whenever a value is inserted
// or two maps are merged, or intersected.
-type Collision func(lhs interface{}, rhs interface{}) interface{}
+type Collision func(lhs any, rhs any) any
// TakeLhs always returns the left value in a collision.
-func TakeLhs(lhs, rhs interface{}) interface{} { return lhs }
+func TakeLhs(lhs, rhs any) any { return lhs }
// TakeRhs always returns the right hand side in a collision.
-func TakeRhs(lhs, rhs interface{}) interface{} { return rhs }
+func TakeRhs(lhs, rhs any) any { return rhs }
// Builder creates new Map. Each Builder has a unique Scope.
//
@@ -78,7 +78,7 @@ func (b *Builder) Empty() Map { return Map{b.Scope(), b.empty} }
// if _, ok := m[k]; ok { m[k] = c(m[k], v} else { m[k] = v}
//
// An insertion or update happened whenever Insert(m, ...) != m .
-func (b *Builder) InsertWith(c Collision, m Map, k uint64, v interface{}) Map {
+func (b *Builder) InsertWith(c Collision, m Map, k uint64, v any) Map {
m = b.Clone(m)
return Map{b.Scope(), b.insert(c, m.n, b.mkLeaf(key(k), v), false)}
}
@@ -92,7 +92,7 @@ func (b *Builder) InsertWith(c Collision, m Map, k uint64, v interface{}) Map {
// if _, ok := m[k]; ok { m[k] = val }
//
// This is equivalent to b.Merge(m, b.Create({k: v})).
-func (b *Builder) Insert(m Map, k uint64, v interface{}) Map {
+func (b *Builder) Insert(m Map, k uint64, v any) Map {
return b.InsertWith(TakeLhs, m, k, v)
}
@@ -100,7 +100,7 @@ func (b *Builder) Insert(m Map, k uint64, v interface{}) Map {
// updating a map[uint64]interface{} by:
//
// m[key] = val
-func (b *Builder) Update(m Map, key uint64, val interface{}) Map {
+func (b *Builder) Update(m Map, key uint64, val any) Map {
return b.InsertWith(TakeRhs, m, key, val)
}
@@ -185,14 +185,14 @@ func (b *Builder) MutEmpty() MutMap {
// Insert an element into the map using the collision function for the builder.
// Returns true if the element was inserted.
-func (mm *MutMap) Insert(k uint64, v interface{}) bool {
+func (mm *MutMap) Insert(k uint64, v any) bool {
old := mm.M
mm.M = mm.B.Insert(old, k, v)
return old != mm.M
}
// Updates an element in the map. Returns true if the map was updated.
-func (mm *MutMap) Update(k uint64, v interface{}) bool {
+func (mm *MutMap) Update(k uint64, v any) bool {
old := mm.M
mm.M = mm.B.Update(old, k, v)
return old != mm.M
@@ -221,7 +221,7 @@ func (mm *MutMap) Intersect(other Map) bool {
return old != mm.M
}
-func (b *Builder) Create(m map[uint64]interface{}) Map {
+func (b *Builder) Create(m map[uint64]any) Map {
var leaves []*leaf
for k, v := range m {
leaves = append(leaves, b.mkLeaf(key(k), v))
@@ -259,7 +259,7 @@ func (b *Builder) create(leaves []*leaf) node {
}
// mkLeaf returns the hash-consed representative of (k, v) in the current scope.
-func (b *Builder) mkLeaf(k key, v interface{}) *leaf {
+func (b *Builder) mkLeaf(k key, v any) *leaf {
rep, ok := b.leaves[leaf{k, v}]
if !ok {
rep = &leaf{k, v} // heap-allocated copy
diff --git a/go/callgraph/vta/internal/trie/op_test.go b/go/callgraph/vta/internal/trie/op_test.go
index ba0d5be71a9..535e7ac2775 100644
--- a/go/callgraph/vta/internal/trie/op_test.go
+++ b/go/callgraph/vta/internal/trie/op_test.go
@@ -12,6 +12,7 @@ import (
"time"
"golang.org/x/tools/go/callgraph/vta/internal/trie"
+ "maps"
)
// This file tests trie.Map by cross checking operations on a collection of
@@ -21,13 +22,13 @@ import (
// mapCollection is effectively a []map[uint64]interface{}.
// These support operations being applied to the i'th maps.
type mapCollection interface {
- Elements() []map[uint64]interface{}
+ Elements() []map[uint64]any
DeepEqual(l, r int) bool
- Lookup(id int, k uint64) (interface{}, bool)
+ Lookup(id int, k uint64) (any, bool)
- Insert(id int, k uint64, v interface{})
- Update(id int, k uint64, v interface{})
+ Insert(id int, k uint64, v any)
+ Update(id int, k uint64, v any)
Remove(id int, k uint64)
Intersect(l int, r int)
Merge(l int, r int)
@@ -86,19 +87,19 @@ type trieCollection struct {
tries []trie.MutMap
}
-func (c *trieCollection) Elements() []map[uint64]interface{} {
- var maps []map[uint64]interface{}
+func (c *trieCollection) Elements() []map[uint64]any {
+ var maps []map[uint64]any
for _, m := range c.tries {
maps = append(maps, trie.Elems(m.M))
}
return maps
}
-func (c *trieCollection) Eq(id int, m map[uint64]interface{}) bool {
+func (c *trieCollection) Eq(id int, m map[uint64]any) bool {
elems := trie.Elems(c.tries[id].M)
return !reflect.DeepEqual(elems, m)
}
-func (c *trieCollection) Lookup(id int, k uint64) (interface{}, bool) {
+func (c *trieCollection) Lookup(id int, k uint64) (any, bool) {
return c.tries[id].M.Lookup(k)
}
func (c *trieCollection) DeepEqual(l, r int) bool {
@@ -109,11 +110,11 @@ func (c *trieCollection) Add() {
c.tries = append(c.tries, c.b.MutEmpty())
}
-func (c *trieCollection) Insert(id int, k uint64, v interface{}) {
+func (c *trieCollection) Insert(id int, k uint64, v any) {
c.tries[id].Insert(k, v)
}
-func (c *trieCollection) Update(id int, k uint64, v interface{}) {
+func (c *trieCollection) Update(id int, k uint64, v any) {
c.tries[id].Update(k, v)
}
@@ -140,7 +141,7 @@ func (c *trieCollection) Assign(l, r int) {
c.tries[l] = c.tries[r]
}
-func average(x interface{}, y interface{}) interface{} {
+func average(x any, y any) any {
if x, ok := x.(float32); ok {
if y, ok := y.(float32); ok {
return (x + y) / 2.0
@@ -149,13 +150,13 @@ func average(x interface{}, y interface{}) interface{} {
return x
}
-type builtinCollection []map[uint64]interface{}
+type builtinCollection []map[uint64]any
-func (c builtinCollection) Elements() []map[uint64]interface{} {
+func (c builtinCollection) Elements() []map[uint64]any {
return c
}
-func (c builtinCollection) Lookup(id int, k uint64) (interface{}, bool) {
+func (c builtinCollection) Lookup(id int, k uint64) (any, bool) {
v, ok := c[id][k]
return v, ok
}
@@ -163,13 +164,13 @@ func (c builtinCollection) DeepEqual(l, r int) bool {
return reflect.DeepEqual(c[l], c[r])
}
-func (c builtinCollection) Insert(id int, k uint64, v interface{}) {
+func (c builtinCollection) Insert(id int, k uint64, v any) {
if _, ok := c[id][k]; !ok {
c[id][k] = v
}
}
-func (c builtinCollection) Update(id int, k uint64, v interface{}) {
+func (c builtinCollection) Update(id int, k uint64, v any) {
c[id][k] = v
}
@@ -178,7 +179,7 @@ func (c builtinCollection) Remove(id int, k uint64) {
}
func (c builtinCollection) Intersect(l int, r int) {
- result := map[uint64]interface{}{}
+ result := map[uint64]any{}
for k, v := range c[l] {
if _, ok := c[r][k]; ok {
result[k] = v
@@ -188,18 +189,14 @@ func (c builtinCollection) Intersect(l int, r int) {
}
func (c builtinCollection) Merge(l int, r int) {
- result := map[uint64]interface{}{}
- for k, v := range c[r] {
- result[k] = v
- }
- for k, v := range c[l] {
- result[k] = v
- }
+ result := map[uint64]any{}
+ maps.Copy(result, c[r])
+ maps.Copy(result, c[l])
c[l] = result
}
func (c builtinCollection) Average(l int, r int) {
- avg := map[uint64]interface{}{}
+ avg := map[uint64]any{}
for k, lv := range c[l] {
if rv, ok := c[r][k]; ok {
avg[k] = average(lv, rv)
@@ -216,15 +213,13 @@ func (c builtinCollection) Average(l int, r int) {
}
func (c builtinCollection) Assign(l, r int) {
- m := map[uint64]interface{}{}
- for k, v := range c[r] {
- m[k] = v
- }
+ m := map[uint64]any{}
+ maps.Copy(m, c[r])
c[l] = m
}
func (c builtinCollection) Clear(id int) {
- c[id] = map[uint64]interface{}{}
+ c[id] = map[uint64]any{}
}
func newTriesCollection(size int) *trieCollection {
@@ -232,7 +227,7 @@ func newTriesCollection(size int) *trieCollection {
b: trie.NewBuilder(),
tries: make([]trie.MutMap, size),
}
- for i := 0; i < size; i++ {
+ for i := range size {
tc.tries[i] = tc.b.MutEmpty()
}
return tc
@@ -240,8 +235,8 @@ func newTriesCollection(size int) *trieCollection {
func newMapsCollection(size int) *builtinCollection {
maps := make(builtinCollection, size)
- for i := 0; i < size; i++ {
- maps[i] = map[uint64]interface{}{}
+ for i := range size {
+ maps[i] = map[uint64]any{}
}
return &maps
}
@@ -255,9 +250,9 @@ type operation struct {
}
// Apply the operation to maps.
-func (op operation) Apply(maps mapCollection) interface{} {
+func (op operation) Apply(maps mapCollection) any {
type lookupresult struct {
- v interface{}
+ v any
ok bool
}
switch op.code {
@@ -290,7 +285,7 @@ func (op operation) Apply(maps mapCollection) interface{} {
func distribution(dist map[opCode]int) []opCode {
var codes []opCode
for op, n := range dist {
- for i := 0; i < n; i++ {
+ for range n {
codes = append(codes, op)
}
}
@@ -326,7 +321,7 @@ func randOperator(r *rand.Rand, opts options) operation {
func randOperators(r *rand.Rand, numops int, opts options) []operation {
ops := make([]operation, numops)
- for i := 0; i < numops; i++ {
+ for i := range numops {
ops[i] = randOperator(r, opts)
}
return ops
diff --git a/go/callgraph/vta/internal/trie/trie.go b/go/callgraph/vta/internal/trie/trie.go
index 511fde51565..a8480192556 100644
--- a/go/callgraph/vta/internal/trie/trie.go
+++ b/go/callgraph/vta/internal/trie/trie.go
@@ -55,7 +55,7 @@ func (m Map) Size() int {
}
return m.n.size()
}
-func (m Map) Lookup(k uint64) (interface{}, bool) {
+func (m Map) Lookup(k uint64) (any, bool) {
if m.n != nil {
if leaf := m.n.find(key(k)); leaf != nil {
return leaf.v, true
@@ -68,7 +68,7 @@ func (m Map) Lookup(k uint64) (interface{}, bool) {
// %s string conversion for .
func (m Map) String() string {
var kvs []string
- m.Range(func(u uint64, i interface{}) bool {
+ m.Range(func(u uint64, i any) bool {
kvs = append(kvs, fmt.Sprintf("%d: %s", u, i))
return true
})
@@ -78,7 +78,7 @@ func (m Map) String() string {
// Range over the leaf (key, value) pairs in the map in order and
// applies cb(key, value) to each. Stops early if cb returns false.
// Returns true if all elements were visited without stopping early.
-func (m Map) Range(cb func(uint64, interface{}) bool) bool {
+func (m Map) Range(cb func(uint64, any) bool) bool {
if m.n != nil {
return m.n.visit(cb)
}
@@ -100,9 +100,9 @@ func (m Map) DeepEqual(other Map) bool {
}
// Elems are the (k,v) elements in the Map as a map[uint64]interface{}
-func Elems(m Map) map[uint64]interface{} {
- dest := make(map[uint64]interface{}, m.Size())
- m.Range(func(k uint64, v interface{}) bool {
+func Elems(m Map) map[uint64]any {
+ dest := make(map[uint64]any, m.Size())
+ m.Range(func(k uint64, v any) bool {
dest[k] = v
return true
})
@@ -117,7 +117,7 @@ type node interface {
// visit the leaves (key, value) pairs in the map in order and
// applies cb(key, value) to each. Stops early if cb returns false.
// Returns true if all elements were visited without stopping early.
- visit(cb func(uint64, interface{}) bool) bool
+ visit(cb func(uint64, any) bool) bool
// Two nodes contain the same elements regardless of scope.
deepEqual(node) bool
@@ -139,7 +139,7 @@ type empty struct {
// leaf represents a single pair.
type leaf struct {
k key
- v interface{}
+ v any
}
// branch represents a tree node within the Patricia trie.
@@ -215,13 +215,13 @@ func (br *branch) deepEqual(m node) bool {
return false
}
-func (*empty) visit(cb func(uint64, interface{}) bool) bool {
+func (*empty) visit(cb func(uint64, any) bool) bool {
return true
}
-func (l *leaf) visit(cb func(uint64, interface{}) bool) bool {
+func (l *leaf) visit(cb func(uint64, any) bool) bool {
return cb(uint64(l.k), l.v)
}
-func (br *branch) visit(cb func(uint64, interface{}) bool) bool {
+func (br *branch) visit(cb func(uint64, any) bool) bool {
if !br.left.visit(cb) {
return false
}
diff --git a/go/callgraph/vta/internal/trie/trie_test.go b/go/callgraph/vta/internal/trie/trie_test.go
index c0651b0ef86..817cb5c5e28 100644
--- a/go/callgraph/vta/internal/trie/trie_test.go
+++ b/go/callgraph/vta/internal/trie/trie_test.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build go1.13
-// +build go1.13
package trie
@@ -35,8 +34,8 @@ func TestScope(t *testing.T) {
}
func TestCollision(t *testing.T) {
- var x interface{} = 1
- var y interface{} = 2
+ var x any = 1
+ var y any = 2
if v := TakeLhs(x, y); v != x {
t.Errorf("TakeLhs(%s, %s) got %s. want %s", x, y, v, x)
@@ -58,7 +57,7 @@ func TestDefault(t *testing.T) {
if v, ok := def.Lookup(123); !(v == nil && !ok) {
t.Errorf("Scope{}.Lookup() = (%s, %v) not (nil, false)", v, ok)
}
- if !def.Range(func(k uint64, v interface{}) bool {
+ if !def.Range(func(k uint64, v any) bool {
t.Errorf("Scope{}.Range() called it callback on %d:%s", k, v)
return true
}) {
@@ -115,7 +114,7 @@ func TestEmpty(t *testing.T) {
if l := e.n.find(123); l != nil {
t.Errorf("empty.find(123) got %v. want nil", l)
}
- e.Range(func(k uint64, v interface{}) bool {
+ e.Range(func(k uint64, v any) bool {
t.Errorf("empty.Range() called it callback on %d:%s", k, v)
return true
})
@@ -130,23 +129,23 @@ func TestCreate(t *testing.T) {
// The node orders are printed in lexicographic little-endian.
b := NewBuilder()
for _, c := range []struct {
- m map[uint64]interface{}
+ m map[uint64]any
want string
}{
{
- map[uint64]interface{}{},
+ map[uint64]any{},
"{}",
},
{
- map[uint64]interface{}{1: "a"},
+ map[uint64]any{1: "a"},
"{1: a}",
},
{
- map[uint64]interface{}{2: "b", 1: "a"},
+ map[uint64]any{2: "b", 1: "a"},
"{1: a, 2: b}",
},
{
- map[uint64]interface{}{1: "x", 4: "y", 5: "z"},
+ map[uint64]any{1: "x", 4: "y", 5: "z"},
"{1: x, 4: y, 5: z}",
},
} {
@@ -159,7 +158,7 @@ func TestCreate(t *testing.T) {
func TestElems(t *testing.T) {
b := NewBuilder()
- for _, orig := range []map[uint64]interface{}{
+ for _, orig := range []map[uint64]any{
{},
{1: "a"},
{1: "a", 2: "b"},
@@ -175,10 +174,10 @@ func TestElems(t *testing.T) {
func TestRange(t *testing.T) {
b := NewBuilder()
- m := b.Create(map[uint64]interface{}{1: "x", 3: "y", 5: "z", 6: "stop", 8: "a"})
+ m := b.Create(map[uint64]any{1: "x", 3: "y", 5: "z", 6: "stop", 8: "a"})
calls := 0
- cb := func(k uint64, v interface{}) bool {
+ cb := func(k uint64, v any) bool {
t.Logf("visiting (%d, %v)", k, v)
calls++
return k%2 != 0 // stop after the first even number.
@@ -196,7 +195,7 @@ func TestRange(t *testing.T) {
}
func TestDeepEqual(t *testing.T) {
- for _, m := range []map[uint64]interface{}{
+ for _, m := range []map[uint64]any{
{},
{1: "x"},
{1: "x", 2: "y"},
@@ -211,32 +210,32 @@ func TestDeepEqual(t *testing.T) {
func TestNotDeepEqual(t *testing.T) {
for _, c := range []struct {
- left map[uint64]interface{}
- right map[uint64]interface{}
+ left map[uint64]any
+ right map[uint64]any
}{
{
- map[uint64]interface{}{1: "x"},
- map[uint64]interface{}{},
+ map[uint64]any{1: "x"},
+ map[uint64]any{},
},
{
- map[uint64]interface{}{},
- map[uint64]interface{}{1: "y"},
+ map[uint64]any{},
+ map[uint64]any{1: "y"},
},
{
- map[uint64]interface{}{1: "x"},
- map[uint64]interface{}{1: "y"},
+ map[uint64]any{1: "x"},
+ map[uint64]any{1: "y"},
},
{
- map[uint64]interface{}{1: "x"},
- map[uint64]interface{}{1: "x", 2: "Y"},
+ map[uint64]any{1: "x"},
+ map[uint64]any{1: "x", 2: "Y"},
},
{
- map[uint64]interface{}{1: "x", 2: "Y"},
- map[uint64]interface{}{1: "x"},
+ map[uint64]any{1: "x", 2: "Y"},
+ map[uint64]any{1: "x"},
},
{
- map[uint64]interface{}{1: "x", 2: "y"},
- map[uint64]interface{}{1: "x", 2: "Y"},
+ map[uint64]any{1: "x", 2: "y"},
+ map[uint64]any{1: "x", 2: "Y"},
},
} {
l := NewBuilder().Create(c.left)
@@ -250,97 +249,97 @@ func TestNotDeepEqual(t *testing.T) {
func TestMerge(t *testing.T) {
b := NewBuilder()
for _, c := range []struct {
- left map[uint64]interface{}
- right map[uint64]interface{}
+ left map[uint64]any
+ right map[uint64]any
want string
}{
{
- map[uint64]interface{}{},
- map[uint64]interface{}{},
+ map[uint64]any{},
+ map[uint64]any{},
"{}",
},
{
- map[uint64]interface{}{},
- map[uint64]interface{}{1: "a"},
+ map[uint64]any{},
+ map[uint64]any{1: "a"},
"{1: a}",
},
{
- map[uint64]interface{}{1: "a"},
- map[uint64]interface{}{},
+ map[uint64]any{1: "a"},
+ map[uint64]any{},
"{1: a}",
},
{
- map[uint64]interface{}{1: "a", 2: "b"},
- map[uint64]interface{}{},
+ map[uint64]any{1: "a", 2: "b"},
+ map[uint64]any{},
"{1: a, 2: b}",
},
{
- map[uint64]interface{}{1: "x"},
- map[uint64]interface{}{1: "y"},
+ map[uint64]any{1: "x"},
+ map[uint64]any{1: "y"},
"{1: x}", // default collision is left
},
{
- map[uint64]interface{}{1: "x"},
- map[uint64]interface{}{2: "y"},
+ map[uint64]any{1: "x"},
+ map[uint64]any{2: "y"},
"{1: x, 2: y}",
},
{
- map[uint64]interface{}{4: "y", 5: "z"},
- map[uint64]interface{}{1: "x"},
+ map[uint64]any{4: "y", 5: "z"},
+ map[uint64]any{1: "x"},
"{1: x, 4: y, 5: z}",
},
{
- map[uint64]interface{}{1: "x", 5: "z"},
- map[uint64]interface{}{4: "y"},
+ map[uint64]any{1: "x", 5: "z"},
+ map[uint64]any{4: "y"},
"{1: x, 4: y, 5: z}",
},
{
- map[uint64]interface{}{1: "x", 4: "y"},
- map[uint64]interface{}{5: "z"},
+ map[uint64]any{1: "x", 4: "y"},
+ map[uint64]any{5: "z"},
"{1: x, 4: y, 5: z}",
},
{
- map[uint64]interface{}{1: "a", 4: "c"},
- map[uint64]interface{}{2: "b", 5: "d"},
+ map[uint64]any{1: "a", 4: "c"},
+ map[uint64]any{2: "b", 5: "d"},
"{1: a, 2: b, 4: c, 5: d}",
},
{
- map[uint64]interface{}{1: "a", 4: "c"},
- map[uint64]interface{}{2: "b", 5 + 8: "d"},
+ map[uint64]any{1: "a", 4: "c"},
+ map[uint64]any{2: "b", 5 + 8: "d"},
"{1: a, 2: b, 4: c, 13: d}",
},
{
- map[uint64]interface{}{2: "b", 5 + 8: "d"},
- map[uint64]interface{}{1: "a", 4: "c"},
+ map[uint64]any{2: "b", 5 + 8: "d"},
+ map[uint64]any{1: "a", 4: "c"},
"{1: a, 2: b, 4: c, 13: d}",
},
{
- map[uint64]interface{}{1: "a", 4: "c"},
- map[uint64]interface{}{2: "b", 5 + 8: "d"},
+ map[uint64]any{1: "a", 4: "c"},
+ map[uint64]any{2: "b", 5 + 8: "d"},
"{1: a, 2: b, 4: c, 13: d}",
},
{
- map[uint64]interface{}{2: "b", 5 + 8: "d"},
- map[uint64]interface{}{1: "a", 4: "c"},
+ map[uint64]any{2: "b", 5 + 8: "d"},
+ map[uint64]any{1: "a", 4: "c"},
"{1: a, 2: b, 4: c, 13: d}",
},
{
- map[uint64]interface{}{2: "b", 5 + 8: "d"},
- map[uint64]interface{}{2: "", 3: "a"},
+ map[uint64]any{2: "b", 5 + 8: "d"},
+ map[uint64]any{2: "", 3: "a"},
"{2: b, 3: a, 13: d}",
},
{
// crafted for `!prefixesOverlap(p, m, q, n)`
- left: map[uint64]interface{}{1: "a", 2 + 1: "b"},
- right: map[uint64]interface{}{4 + 1: "c", 4 + 2: "d"},
+ left: map[uint64]any{1: "a", 2 + 1: "b"},
+ right: map[uint64]any{4 + 1: "c", 4 + 2: "d"},
// p: 5, m: 2 q: 1, n: 2
want: "{1: a, 3: b, 5: c, 6: d}",
},
{
// crafted for `ord(m, n) && !zeroBit(q, m)`
- left: map[uint64]interface{}{8 + 2 + 1: "a", 16 + 4: "b"},
- right: map[uint64]interface{}{16 + 8 + 2 + 1: "c", 16 + 8 + 4 + 2 + 1: "d"},
+ left: map[uint64]any{8 + 2 + 1: "a", 16 + 4: "b"},
+ right: map[uint64]any{16 + 8 + 2 + 1: "c", 16 + 8 + 4 + 2 + 1: "d"},
// left: p: 15, m: 16
// right: q: 27, n: 4
want: "{11: a, 20: b, 27: c, 31: d}",
@@ -348,8 +347,8 @@ func TestMerge(t *testing.T) {
{
// crafted for `ord(n, m) && !zeroBit(p, n)`
// p: 6, m: 1 q: 5, n: 2
- left: map[uint64]interface{}{4 + 2: "b", 4 + 2 + 1: "c"},
- right: map[uint64]interface{}{4: "a", 4 + 2 + 1: "dropped"},
+ left: map[uint64]any{4 + 2: "b", 4 + 2 + 1: "c"},
+ right: map[uint64]any{4: "a", 4 + 2 + 1: "dropped"},
want: "{4: a, 6: b, 7: c}",
},
} {
@@ -365,65 +364,65 @@ func TestIntersect(t *testing.T) {
// Most of the test cases go after specific branches of intersect.
b := NewBuilder()
for _, c := range []struct {
- left map[uint64]interface{}
- right map[uint64]interface{}
+ left map[uint64]any
+ right map[uint64]any
want string
}{
{
- left: map[uint64]interface{}{10: "a", 39: "b"},
- right: map[uint64]interface{}{10: "A", 39: "B", 75: "C"},
+ left: map[uint64]any{10: "a", 39: "b"},
+ right: map[uint64]any{10: "A", 39: "B", 75: "C"},
want: "{10: a, 39: b}",
},
{
- left: map[uint64]interface{}{10: "a", 39: "b"},
- right: map[uint64]interface{}{},
+ left: map[uint64]any{10: "a", 39: "b"},
+ right: map[uint64]any{},
want: "{}",
},
{
- left: map[uint64]interface{}{},
- right: map[uint64]interface{}{10: "A", 39: "B", 75: "C"},
+ left: map[uint64]any{},
+ right: map[uint64]any{10: "A", 39: "B", 75: "C"},
want: "{}",
},
{ // m == n && p == q && left.(*empty) case
- left: map[uint64]interface{}{4: 1, 6: 3, 10: 8, 15: "on left"},
- right: map[uint64]interface{}{0: 8, 7: 6, 11: 0, 15: "on right"},
+ left: map[uint64]any{4: 1, 6: 3, 10: 8, 15: "on left"},
+ right: map[uint64]any{0: 8, 7: 6, 11: 0, 15: "on right"},
want: "{15: on left}",
},
{ // m == n && p == q && right.(*empty) case
- left: map[uint64]interface{}{0: "on left", 1: 2, 2: 3, 3: 1, 7: 3},
- right: map[uint64]interface{}{0: "on right", 5: 1, 6: 8},
+ left: map[uint64]any{0: "on left", 1: 2, 2: 3, 3: 1, 7: 3},
+ right: map[uint64]any{0: "on right", 5: 1, 6: 8},
want: "{0: on left}",
},
{ // m == n && p == q && both left and right are not empty
- left: map[uint64]interface{}{1: "a", 2: "b", 3: "c"},
- right: map[uint64]interface{}{0: "A", 1: "B", 2: "C"},
+ left: map[uint64]any{1: "a", 2: "b", 3: "c"},
+ right: map[uint64]any{0: "A", 1: "B", 2: "C"},
want: "{1: a, 2: b}",
},
{ // m == n && p == q && both left and right are not empty
- left: map[uint64]interface{}{1: "a", 2: "b", 3: "c"},
- right: map[uint64]interface{}{0: "A", 1: "B", 2: "C"},
+ left: map[uint64]any{1: "a", 2: "b", 3: "c"},
+ right: map[uint64]any{0: "A", 1: "B", 2: "C"},
want: "{1: a, 2: b}",
},
{ // !prefixesOverlap(p, m, q, n)
// p = 1, m = 2, q = 5, n = 2
- left: map[uint64]interface{}{0b001: 1, 0b011: 3},
- right: map[uint64]interface{}{0b100: 4, 0b111: 7},
+ left: map[uint64]any{0b001: 1, 0b011: 3},
+ right: map[uint64]any{0b100: 4, 0b111: 7},
want: "{}",
},
{ // ord(m, n) && zeroBit(q, m)
// p = 3, m = 4, q = 0, n = 1
- left: map[uint64]interface{}{0b010: 2, 0b101: 5},
- right: map[uint64]interface{}{0b000: 0, 0b001: 1},
+ left: map[uint64]any{0b010: 2, 0b101: 5},
+ right: map[uint64]any{0b000: 0, 0b001: 1},
want: "{}",
},
{ // ord(m, n) && !zeroBit(q, m)
// p = 29, m = 2, q = 30, n = 1
- left: map[uint64]interface{}{
+ left: map[uint64]any{
0b11101: "29",
0b11110: "30",
},
- right: map[uint64]interface{}{
+ right: map[uint64]any{
0b11110: "30 on right",
0b11111: "31",
},
@@ -431,14 +430,14 @@ func TestIntersect(t *testing.T) {
},
{ // ord(n, m) && zeroBit(p, n)
// p = 5, m = 2, q = 3, n = 4
- left: map[uint64]interface{}{0b000: 0, 0b001: 1},
- right: map[uint64]interface{}{0b010: 2, 0b101: 5},
+ left: map[uint64]any{0b000: 0, 0b001: 1},
+ right: map[uint64]any{0b010: 2, 0b101: 5},
want: "{}",
},
{ // default case
// p = 5, m = 2, q = 3, n = 4
- left: map[uint64]interface{}{0b100: 1, 0b110: 3},
- right: map[uint64]interface{}{0b000: 8, 0b111: 6},
+ left: map[uint64]any{0b100: 1, 0b110: 3},
+ right: map[uint64]any{0b000: 8, 0b111: 6},
want: "{}",
},
} {
@@ -452,10 +451,10 @@ func TestIntersect(t *testing.T) {
func TestIntersectWith(t *testing.T) {
b := NewBuilder()
- l := b.Create(map[uint64]interface{}{10: 2.0, 39: 32.0})
- r := b.Create(map[uint64]interface{}{10: 6.0, 39: 10.0, 75: 1.0})
+ l := b.Create(map[uint64]any{10: 2.0, 39: 32.0})
+ r := b.Create(map[uint64]any{10: 6.0, 39: 10.0, 75: 1.0})
- prodIfDifferent := func(x interface{}, y interface{}) interface{} {
+ prodIfDifferent := func(x any, y any) any {
if x, ok := x.(float64); ok {
if y, ok := y.(float64); ok {
if x == y {
@@ -479,24 +478,24 @@ func TestRemove(t *testing.T) {
// Most of the test cases go after specific branches of intersect.
b := NewBuilder()
for _, c := range []struct {
- m map[uint64]interface{}
+ m map[uint64]any
key uint64
want string
}{
- {map[uint64]interface{}{}, 10, "{}"},
- {map[uint64]interface{}{10: "a"}, 10, "{}"},
- {map[uint64]interface{}{39: "b"}, 10, "{39: b}"},
+ {map[uint64]any{}, 10, "{}"},
+ {map[uint64]any{10: "a"}, 10, "{}"},
+ {map[uint64]any{39: "b"}, 10, "{39: b}"},
// Branch cases:
// !matchPrefix(kp, br.prefix, br.branching)
- {map[uint64]interface{}{10: "a", 39: "b"}, 128, "{10: a, 39: b}"},
+ {map[uint64]any{10: "a", 39: "b"}, 128, "{10: a, 39: b}"},
// case: left == br.left && right == br.right
- {map[uint64]interface{}{10: "a", 39: "b"}, 16, "{10: a, 39: b}"},
+ {map[uint64]any{10: "a", 39: "b"}, 16, "{10: a, 39: b}"},
// left updated and is empty.
- {map[uint64]interface{}{10: "a", 39: "b"}, 10, "{39: b}"},
+ {map[uint64]any{10: "a", 39: "b"}, 10, "{39: b}"},
// right updated and is empty.
- {map[uint64]interface{}{10: "a", 39: "b"}, 39, "{10: a}"},
+ {map[uint64]any{10: "a", 39: "b"}, 39, "{10: a}"},
// final b.mkBranch(...) case.
- {map[uint64]interface{}{10: "a", 39: "b", 128: "c"}, 39, "{10: a, 128: c}"},
+ {map[uint64]any{10: "a", 39: "b", 128: "c"}, 39, "{10: a, 128: c}"},
} {
pre := b.Create(c.m)
post := b.Remove(pre, c.key)
@@ -508,8 +507,8 @@ func TestRemove(t *testing.T) {
func TestRescope(t *testing.T) {
b := NewBuilder()
- l := b.Create(map[uint64]interface{}{10: "a", 39: "b"})
- r := b.Create(map[uint64]interface{}{10: "A", 39: "B", 75: "C"})
+ l := b.Create(map[uint64]any{10: "a", 39: "b"})
+ r := b.Create(map[uint64]any{10: "A", 39: "B", 75: "C"})
b.Rescope()
@@ -527,8 +526,8 @@ func TestRescope(t *testing.T) {
func TestSharing(t *testing.T) {
b := NewBuilder()
- l := b.Create(map[uint64]interface{}{0: "a", 1: "b"})
- r := b.Create(map[uint64]interface{}{1: "B", 2: "C"})
+ l := b.Create(map[uint64]any{0: "a", 1: "b"})
+ r := b.Create(map[uint64]any{1: "B", 2: "C"})
rleftold := r.n.(*branch).left
diff --git a/go/callgraph/vta/propagation.go b/go/callgraph/vta/propagation.go
index f448cde1135..a71c5b0034a 100644
--- a/go/callgraph/vta/propagation.go
+++ b/go/callgraph/vta/propagation.go
@@ -6,6 +6,7 @@ package vta
import (
"go/types"
+ "iter"
"slices"
"golang.org/x/tools/go/callgraph/vta/internal/trie"
@@ -41,7 +42,7 @@ func scc(g *vtaGraph) (sccs [][]idx, idxToSccID []int) {
*ns = state{pre: nextPre, lowLink: nextPre, onStack: true}
stack = append(stack, n)
- g.successors(n)(func(s idx) bool {
+ for s := range g.successors(n) {
if ss := &states[s]; ss.pre == 0 {
// Analyze successor s that has not been visited yet.
doSCC(s)
@@ -51,8 +52,7 @@ func scc(g *vtaGraph) (sccs [][]idx, idxToSccID []int) {
// in the current SCC.
ns.lowLink = min(ns.lowLink, ss.pre)
}
- return true
- })
+ }
// if n is a root node, pop the stack and generate a new SCC.
if ns.lowLink == ns.pre {
@@ -113,14 +113,12 @@ type propType struct {
// the role of a map from nodes to a set of propTypes.
type propTypeMap map[node]*trie.MutMap
-// propTypes returns a go1.23 iterator for the propTypes associated with
+// propTypes returns an iterator for the propTypes associated with
// node `n` in map `ptm`.
-func (ptm propTypeMap) propTypes(n node) func(yield func(propType) bool) {
- // TODO: when x/tools uses go1.23, change callers to use range-over-func
- // (https://go.dev/issue/65237).
+func (ptm propTypeMap) propTypes(n node) iter.Seq[propType] {
return func(yield func(propType) bool) {
if types := ptm[n]; types != nil {
- types.M.Range(func(_ uint64, elem interface{}) bool {
+ types.M.Range(func(_ uint64, elem any) bool {
return yield(elem.(propType))
})
}
@@ -167,10 +165,9 @@ func propagate(graph *vtaGraph, canon *typeutil.Map) propTypeMap {
for i := len(sccs) - 1; i >= 0; i-- {
nextSccs := make(map[int]empty)
for _, n := range sccs[i] {
- graph.successors(n)(func(succ idx) bool {
+ for succ := range graph.successors(n) {
nextSccs[idxToSccID[succ]] = empty{}
- return true
- })
+ }
}
// Propagate types to all successor SCCs.
for nextScc := range nextSccs {
diff --git a/go/callgraph/vta/propagation_test.go b/go/callgraph/vta/propagation_test.go
index 492258f81e3..2b36cf39bb7 100644
--- a/go/callgraph/vta/propagation_test.go
+++ b/go/callgraph/vta/propagation_test.go
@@ -98,10 +98,9 @@ func nodeToTypeString(pMap propTypeMap) map[string]string {
nodeToTypeStr := make(map[string]string)
for node := range pMap {
var propStrings []string
- pMap.propTypes(node)(func(prop propType) bool {
+ for prop := range pMap.propTypes(node) {
propStrings = append(propStrings, propTypeString(prop))
- return true
- })
+ }
sort.Strings(propStrings)
nodeToTypeStr[node.String()] = strings.Join(propStrings, ";")
}
@@ -124,17 +123,14 @@ func sccEqual(sccs1 []string, sccs2 []string) bool {
//
// for every edge x -> y in g, nodeToScc[x] > nodeToScc[y]
func isRevTopSorted(g *vtaGraph, idxToScc []int) bool {
- result := true
- for n := 0; n < len(idxToScc); n++ {
- g.successors(idx(n))(func(s idx) bool {
+ for n := range idxToScc {
+ for s := range g.successors(idx(n)) {
if idxToScc[n] < idxToScc[s] {
- result = false
return false
}
- return true
- })
+ }
}
- return result
+ return true
}
func sccMapsConsistent(sccs [][]idx, idxToSccID []int) bool {
@@ -203,7 +199,7 @@ func testSuite() map[string]*vtaGraph {
a := newNamedType("A")
b := newNamedType("B")
c := newNamedType("C")
- sig := types.NewSignature(nil, types.NewTuple(), types.NewTuple(), false)
+ sig := types.NewSignatureType(nil, nil, nil, types.NewTuple(), types.NewTuple(), false)
f1 := &ssa.Function{Signature: sig}
setName(f1, "F1")
diff --git a/go/callgraph/vta/utils.go b/go/callgraph/vta/utils.go
index bbd8400ec9b..3a708f220a7 100644
--- a/go/callgraph/vta/utils.go
+++ b/go/callgraph/vta/utils.go
@@ -6,6 +6,7 @@ package vta
import (
"go/types"
+ "iter"
"golang.org/x/tools/go/ssa"
"golang.org/x/tools/internal/typeparams"
@@ -147,10 +148,8 @@ func sliceArrayElem(t types.Type) types.Type {
}
}
-// siteCallees returns a go1.23 iterator for the callees for call site `c`.
-func siteCallees(c ssa.CallInstruction, callees calleesFunc) func(yield func(*ssa.Function) bool) {
- // TODO: when x/tools uses go1.23, change callers to use range-over-func
- // (https://go.dev/issue/65237).
+// siteCallees returns an iterator for the callees for call site `c`.
+func siteCallees(c ssa.CallInstruction, callees calleesFunc) iter.Seq[*ssa.Function] {
return func(yield func(*ssa.Function) bool) {
for _, callee := range callees(c) {
if !yield(callee) {
diff --git a/go/callgraph/vta/vta.go b/go/callgraph/vta/vta.go
index 56fce13725f..ed12001fdb2 100644
--- a/go/callgraph/vta/vta.go
+++ b/go/callgraph/vta/vta.go
@@ -126,12 +126,11 @@ func (c *constructor) resolves(call ssa.CallInstruction) []*ssa.Function {
// Cover the case of dynamic higher-order and interface calls.
var res []*ssa.Function
resolved := resolve(call, c.types, c.cache)
- siteCallees(call, c.callees)(func(f *ssa.Function) bool {
+ for f := range siteCallees(call, c.callees) {
if _, ok := resolved[f]; ok {
res = append(res, f)
}
- return true
- })
+ }
return res
}
@@ -140,12 +139,11 @@ func (c *constructor) resolves(call ssa.CallInstruction) []*ssa.Function {
func resolve(c ssa.CallInstruction, types propTypeMap, cache methodCache) map[*ssa.Function]empty {
fns := make(map[*ssa.Function]empty)
n := local{val: c.Common().Value}
- types.propTypes(n)(func(p propType) bool {
+ for p := range types.propTypes(n) {
for _, f := range propFunc(p, c, cache) {
fns[f] = empty{}
}
- return true
- })
+ }
return fns
}
diff --git a/go/callgraph/vta/vta_test.go b/go/callgraph/vta/vta_test.go
index ea7d584d2d9..42610abb139 100644
--- a/go/callgraph/vta/vta_test.go
+++ b/go/callgraph/vta/vta_test.go
@@ -118,7 +118,7 @@ func TestVTAProgVsFuncSet(t *testing.T) {
// available, which can happen when using analysis package. A successful
// test simply does not panic.
func TestVTAPanicMissingDefinitions(t *testing.T) {
- run := func(pass *analysis.Pass) (interface{}, error) {
+ run := func(pass *analysis.Pass) (any, error) {
s := pass.ResultOf[buildssa.Analyzer].(*buildssa.SSA)
CallGraph(ssautil.AllFunctions(s.Pkg.Prog), cha.CallGraph(s.Pkg.Prog))
return nil, nil
diff --git a/go/expect/expect.go b/go/expect/expect.go
index be0e1dd23e6..1c002d91b60 100644
--- a/go/expect/expect.go
+++ b/go/expect/expect.go
@@ -66,9 +66,9 @@ import (
// It knows the position of the start of the comment, and the name and
// arguments that make up the note.
type Note struct {
- Pos token.Pos // The position at which the note identifier appears
- Name string // the name associated with the note
- Args []interface{} // the arguments for the note
+ Pos token.Pos // The position at which the note identifier appears
+ Name string // the name associated with the note
+ Args []any // the arguments for the note
}
// ReadFile is the type of a function that can provide file contents for a
@@ -85,7 +85,7 @@ type ReadFile func(filename string) ([]byte, error)
// MatchBefore returns the range of the line that matched the pattern, and
// invalid positions if there was no match, or an error if the line could not be
// found.
-func MatchBefore(fset *token.FileSet, readFile ReadFile, end token.Pos, pattern interface{}) (token.Pos, token.Pos, error) {
+func MatchBefore(fset *token.FileSet, readFile ReadFile, end token.Pos, pattern any) (token.Pos, token.Pos, error) {
f := fset.File(end)
content, err := readFile(f.Name())
if err != nil {
diff --git a/go/expect/expect_test.go b/go/expect/expect_test.go
index cc585418d1b..d1ce96b868e 100644
--- a/go/expect/expect_test.go
+++ b/go/expect/expect_test.go
@@ -18,7 +18,7 @@ func TestMarker(t *testing.T) {
filename string
expectNotes int
expectMarkers map[string]string
- expectChecks map[string][]interface{}
+ expectChecks map[string][]any
}{
{
filename: "testdata/test.go",
@@ -36,7 +36,7 @@ func TestMarker(t *testing.T) {
"NonIdentifier": "+",
"StringMarker": "\"hello\"",
},
- expectChecks: map[string][]interface{}{
+ expectChecks: map[string][]any{
"αSimpleMarker": nil,
"StringAndInt": {"Number %d", int64(12)},
"Bool": {true},
@@ -140,7 +140,7 @@ func TestMarker(t *testing.T) {
}
}
-func checkMarker(t *testing.T, fset *token.FileSet, readFile expect.ReadFile, markers map[string]token.Pos, pos token.Pos, name string, pattern interface{}) {
+func checkMarker(t *testing.T, fset *token.FileSet, readFile expect.ReadFile, markers map[string]token.Pos, pos token.Pos, name string, pattern any) {
start, end, err := expect.MatchBefore(fset, readFile, pos, pattern)
if err != nil {
t.Errorf("%v: MatchBefore failed: %v", fset.Position(pos), err)
diff --git a/go/expect/extract.go b/go/expect/extract.go
index 902b1e806e4..9cc5c8171fd 100644
--- a/go/expect/extract.go
+++ b/go/expect/extract.go
@@ -32,7 +32,7 @@ type Identifier string
// See the package documentation for details about the syntax of those
// notes.
func Parse(fset *token.FileSet, filename string, content []byte) ([]*Note, error) {
- var src interface{}
+ var src any
if content != nil {
src = content
}
@@ -220,7 +220,7 @@ func (t *tokens) Pos() token.Pos {
return t.base + token.Pos(t.scanner.Position.Offset)
}
-func (t *tokens) Errorf(msg string, args ...interface{}) {
+func (t *tokens) Errorf(msg string, args ...any) {
if t.err != nil {
return
}
@@ -280,9 +280,9 @@ func parseNote(t *tokens) *Note {
}
}
-func parseArgumentList(t *tokens) []interface{} {
- args := []interface{}{} // @name() is represented by a non-nil empty slice.
- t.Consume() // '('
+func parseArgumentList(t *tokens) []any {
+ args := []any{} // @name() is represented by a non-nil empty slice.
+ t.Consume() // '('
t.Skip('\n')
for t.Token() != ')' {
args = append(args, parseArgument(t))
@@ -300,7 +300,7 @@ func parseArgumentList(t *tokens) []interface{} {
return args
}
-func parseArgument(t *tokens) interface{} {
+func parseArgument(t *tokens) any {
switch t.Token() {
case scanner.Ident:
v := t.Consume()
diff --git a/go/gcexportdata/example_test.go b/go/gcexportdata/example_test.go
index 9574f30d32b..d6d69a8aa54 100644
--- a/go/gcexportdata/example_test.go
+++ b/go/gcexportdata/example_test.go
@@ -3,11 +3,6 @@
// license that can be found in the LICENSE file.
//go:build go1.7 && gc && !android && !ios && (unix || aix || darwin || dragonfly || freebsd || linux || netbsd || openbsd || solaris || plan9 || windows)
-// +build go1.7
-// +build gc
-// +build !android
-// +build !ios
-// +build unix aix darwin dragonfly freebsd linux netbsd openbsd solaris plan9 windows
package gcexportdata_test
@@ -20,6 +15,7 @@ import (
"log"
"os"
"path/filepath"
+ "slices"
"strings"
"golang.org/x/tools/go/gcexportdata"
@@ -56,13 +52,7 @@ func ExampleRead() {
// We can see all the names in Names.
members := pkg.Scope().Names()
- foundPrintln := false
- for _, member := range members {
- if member == "Println" {
- foundPrintln = true
- break
- }
- }
+ foundPrintln := slices.Contains(members, "Println")
fmt.Print("Package members: ")
if foundPrintln {
fmt.Println("Println found")
diff --git a/go/gcexportdata/gcexportdata.go b/go/gcexportdata/gcexportdata.go
index 65fe2628e90..7b90bc92353 100644
--- a/go/gcexportdata/gcexportdata.go
+++ b/go/gcexportdata/gcexportdata.go
@@ -193,10 +193,7 @@ func Read(in io.Reader, fset *token.FileSet, imports map[string]*types.Package,
return pkg, err
default:
- l := len(data)
- if l > 10 {
- l = 10
- }
+ l := min(len(data), 10)
return nil, fmt.Errorf("unexpected export data with prefix %q for path %s", string(data[:l]), path)
}
}
diff --git a/go/gcexportdata/main.go b/go/gcexportdata/main.go
index e9df4e9a9a5..0b267e33867 100644
--- a/go/gcexportdata/main.go
+++ b/go/gcexportdata/main.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build ignore
-// +build ignore
// The gcexportdata command is a diagnostic tool that displays the
// contents of gc export data files.
diff --git a/go/internal/cgo/cgo.go b/go/internal/cgo/cgo.go
index 697974bb9b2..735efeb531d 100644
--- a/go/internal/cgo/cgo.go
+++ b/go/internal/cgo/cgo.go
@@ -203,7 +203,7 @@ func envList(key, def string) []string {
// stringList's arguments should be a sequence of string or []string values.
// stringList flattens them into a single []string.
-func stringList(args ...interface{}) []string {
+func stringList(args ...any) []string {
var x []string
for _, arg := range args {
switch arg := arg.(type) {
diff --git a/go/internal/gccgoimporter/newInterface10.go b/go/internal/gccgoimporter/newInterface10.go
index 1b449ef9886..f49c9b067dd 100644
--- a/go/internal/gccgoimporter/newInterface10.go
+++ b/go/internal/gccgoimporter/newInterface10.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build !go1.11
-// +build !go1.11
package gccgoimporter
diff --git a/go/internal/gccgoimporter/newInterface11.go b/go/internal/gccgoimporter/newInterface11.go
index 631546ec66f..c7d5edb4858 100644
--- a/go/internal/gccgoimporter/newInterface11.go
+++ b/go/internal/gccgoimporter/newInterface11.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build go1.11
-// +build go1.11
package gccgoimporter
diff --git a/go/internal/gccgoimporter/parser.go b/go/internal/gccgoimporter/parser.go
index f315ec41004..7b0702892c4 100644
--- a/go/internal/gccgoimporter/parser.go
+++ b/go/internal/gccgoimporter/parser.go
@@ -86,7 +86,7 @@ func (e importError) Error() string {
return fmt.Sprintf("import error %s (byte offset = %d): %s", e.pos, e.pos.Offset, e.err)
}
-func (p *parser) error(err interface{}) {
+func (p *parser) error(err any) {
if s, ok := err.(string); ok {
err = errors.New(s)
}
@@ -94,7 +94,7 @@ func (p *parser) error(err interface{}) {
panic(importError{p.scanner.Pos(), err.(error)})
}
-func (p *parser) errorf(format string, args ...interface{}) {
+func (p *parser) errorf(format string, args ...any) {
p.error(fmt.Errorf(format, args...))
}
@@ -492,7 +492,7 @@ func (p *parser) reserve(n int) {
// used to resolve named types, or it can be a *types.Pointer,
// used to resolve pointers to named types in case they are referenced
// by embedded fields.
-func (p *parser) update(t types.Type, nlist []interface{}) {
+func (p *parser) update(t types.Type, nlist []any) {
if t == reserved {
p.errorf("internal error: update(%v) invoked on reserved", nlist)
}
@@ -529,7 +529,7 @@ func (p *parser) update(t types.Type, nlist []interface{}) {
// NamedType = TypeName [ "=" ] Type { Method } .
// TypeName = ExportedName .
// Method = "func" "(" Param ")" Name ParamList ResultList [InlineBody] ";" .
-func (p *parser) parseNamedType(nlist []interface{}) types.Type {
+func (p *parser) parseNamedType(nlist []any) types.Type {
pkg, name := p.parseExportedName()
scope := pkg.Scope()
obj := scope.Lookup(name)
@@ -619,7 +619,7 @@ func (p *parser) parseNamedType(nlist []interface{}) types.Type {
p.skipInlineBody()
p.expectEOL()
- sig := types.NewSignature(receiver, params, results, isVariadic)
+ sig := types.NewSignatureType(receiver, nil, nil, params, results, isVariadic)
nt.AddMethod(types.NewFunc(token.NoPos, pkg, name, sig))
}
}
@@ -648,7 +648,7 @@ func (p *parser) parseInt() int {
// parseArrayOrSliceType parses an ArrayOrSliceType:
//
// ArrayOrSliceType = "[" [ int ] "]" Type .
-func (p *parser) parseArrayOrSliceType(pkg *types.Package, nlist []interface{}) types.Type {
+func (p *parser) parseArrayOrSliceType(pkg *types.Package, nlist []any) types.Type {
p.expect('[')
if p.tok == ']' {
p.next()
@@ -673,7 +673,7 @@ func (p *parser) parseArrayOrSliceType(pkg *types.Package, nlist []interface{})
// parseMapType parses a MapType:
//
// MapType = "map" "[" Type "]" Type .
-func (p *parser) parseMapType(pkg *types.Package, nlist []interface{}) types.Type {
+func (p *parser) parseMapType(pkg *types.Package, nlist []any) types.Type {
p.expectKeyword("map")
t := new(types.Map)
@@ -691,7 +691,7 @@ func (p *parser) parseMapType(pkg *types.Package, nlist []interface{}) types.Typ
// parseChanType parses a ChanType:
//
// ChanType = "chan" ["<-" | "-<"] Type .
-func (p *parser) parseChanType(pkg *types.Package, nlist []interface{}) types.Type {
+func (p *parser) parseChanType(pkg *types.Package, nlist []any) types.Type {
p.expectKeyword("chan")
t := new(types.Chan)
@@ -720,7 +720,7 @@ func (p *parser) parseChanType(pkg *types.Package, nlist []interface{}) types.Ty
// parseStructType parses a StructType:
//
// StructType = "struct" "{" { Field } "}" .
-func (p *parser) parseStructType(pkg *types.Package, nlist []interface{}) types.Type {
+func (p *parser) parseStructType(pkg *types.Package, nlist []any) types.Type {
p.expectKeyword("struct")
t := new(types.Struct)
@@ -793,14 +793,14 @@ func (p *parser) parseResultList(pkg *types.Package) *types.Tuple {
// parseFunctionType parses a FunctionType:
//
// FunctionType = ParamList ResultList .
-func (p *parser) parseFunctionType(pkg *types.Package, nlist []interface{}) *types.Signature {
+func (p *parser) parseFunctionType(pkg *types.Package, nlist []any) *types.Signature {
t := new(types.Signature)
p.update(t, nlist)
params, isVariadic := p.parseParamList(pkg)
results := p.parseResultList(pkg)
- *t = *types.NewSignature(nil, params, results, isVariadic)
+ *t = *types.NewSignatureType(nil, nil, nil, params, results, isVariadic)
return t
}
@@ -837,7 +837,7 @@ func (p *parser) parseFunc(pkg *types.Package) *types.Func {
// parseInterfaceType parses an InterfaceType:
//
// InterfaceType = "interface" "{" { ("?" Type | Func) ";" } "}" .
-func (p *parser) parseInterfaceType(pkg *types.Package, nlist []interface{}) types.Type {
+func (p *parser) parseInterfaceType(pkg *types.Package, nlist []any) types.Type {
p.expectKeyword("interface")
t := new(types.Interface)
@@ -868,7 +868,7 @@ func (p *parser) parseInterfaceType(pkg *types.Package, nlist []interface{}) typ
// parsePointerType parses a PointerType:
//
// PointerType = "*" ("any" | Type) .
-func (p *parser) parsePointerType(pkg *types.Package, nlist []interface{}) types.Type {
+func (p *parser) parsePointerType(pkg *types.Package, nlist []any) types.Type {
p.expect('*')
if p.tok == scanner.Ident {
p.expectKeyword("any")
@@ -888,7 +888,7 @@ func (p *parser) parsePointerType(pkg *types.Package, nlist []interface{}) types
// parseTypeSpec parses a TypeSpec:
//
// TypeSpec = NamedType | MapType | ChanType | StructType | InterfaceType | PointerType | ArrayOrSliceType | FunctionType .
-func (p *parser) parseTypeSpec(pkg *types.Package, nlist []interface{}) types.Type {
+func (p *parser) parseTypeSpec(pkg *types.Package, nlist []any) types.Type {
switch p.tok {
case scanner.String:
return p.parseNamedType(nlist)
@@ -980,14 +980,14 @@ func lookupBuiltinType(typ int) types.Type {
// Type = "<" "type" ( "-" int | int [ TypeSpec ] ) ">" .
//
// parseType updates the type map to t for all type numbers n.
-func (p *parser) parseType(pkg *types.Package, n ...interface{}) types.Type {
+func (p *parser) parseType(pkg *types.Package, n ...any) types.Type {
p.expect('<')
t, _ := p.parseTypeAfterAngle(pkg, n...)
return t
}
// (*parser).Type after reading the "<".
-func (p *parser) parseTypeAfterAngle(pkg *types.Package, n ...interface{}) (t types.Type, n1 int) {
+func (p *parser) parseTypeAfterAngle(pkg *types.Package, n ...any) (t types.Type, n1 int) {
p.expectKeyword("type")
n1 = 0
@@ -1030,7 +1030,7 @@ func (p *parser) parseTypeAfterAngle(pkg *types.Package, n ...interface{}) (t ty
// parseTypeExtended is identical to parseType, but if the type in
// question is a saved type, returns the index as well as the type
// pointer (index returned is zero if we parsed a builtin).
-func (p *parser) parseTypeExtended(pkg *types.Package, n ...interface{}) (t types.Type, n1 int) {
+func (p *parser) parseTypeExtended(pkg *types.Package, n ...any) (t types.Type, n1 int) {
p.expect('<')
t, n1 = p.parseTypeAfterAngle(pkg, n...)
return
@@ -1119,7 +1119,7 @@ func (p *parser) parseTypes(pkg *types.Package) {
}
// parseSavedType parses one saved type definition.
-func (p *parser) parseSavedType(pkg *types.Package, i int, nlist []interface{}) {
+func (p *parser) parseSavedType(pkg *types.Package, i int, nlist []any) {
defer func(s *scanner.Scanner, tok rune, lit string) {
p.scanner = s
p.tok = tok
diff --git a/go/loader/loader.go b/go/loader/loader.go
index 2d4865f664f..d06f95ad76c 100644
--- a/go/loader/loader.go
+++ b/go/loader/loader.go
@@ -215,7 +215,7 @@ func (conf *Config) fset() *token.FileSet {
// src specifies the parser input as a string, []byte, or io.Reader, and
// filename is its apparent name. If src is nil, the contents of
// filename are read from the file system.
-func (conf *Config) ParseFile(filename string, src interface{}) (*ast.File, error) {
+func (conf *Config) ParseFile(filename string, src any) (*ast.File, error) {
// TODO(adonovan): use conf.build() etc like parseFiles does.
return parser.ParseFile(conf.fset(), filename, src, conf.ParserMode)
}
diff --git a/go/loader/loader_test.go b/go/loader/loader_test.go
index 2276b49ad6f..eb9feb221f0 100644
--- a/go/loader/loader_test.go
+++ b/go/loader/loader_test.go
@@ -5,7 +5,6 @@
// No testdata on Android.
//go:build !android
-// +build !android
package loader_test
diff --git a/go/packages/external.go b/go/packages/external.go
index 91bd62e83b1..f37bc651009 100644
--- a/go/packages/external.go
+++ b/go/packages/external.go
@@ -90,7 +90,7 @@ func findExternalDriver(cfg *Config) driver {
const toolPrefix = "GOPACKAGESDRIVER="
tool := ""
for _, env := range cfg.Env {
- if val := strings.TrimPrefix(env, toolPrefix); val != env {
+ if val, ok := strings.CutPrefix(env, toolPrefix); ok {
tool = val
}
}
diff --git a/go/packages/gopackages/gotypesalias.go b/go/packages/gopackages/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/packages/gopackages/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/packages/gopackages/main.go b/go/packages/gopackages/main.go
index 3841ac3410b..7ec0bdc7bdd 100644
--- a/go/packages/gopackages/main.go
+++ b/go/packages/gopackages/main.go
@@ -248,7 +248,7 @@ func (app *application) print(lpkg *packages.Package) {
// e.g. --flag=one --flag=two would produce []string{"one", "two"}.
type stringListValue []string
-func (ss *stringListValue) Get() interface{} { return []string(*ss) }
+func (ss *stringListValue) Get() any { return []string(*ss) }
func (ss *stringListValue) String() string { return fmt.Sprintf("%q", *ss) }
diff --git a/go/packages/internal/nodecount/gotypesalias.go b/go/packages/internal/nodecount/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/packages/internal/nodecount/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/packages/overlay_test.go b/go/packages/overlay_test.go
index 9edd0d646ed..4a7cc68f4c7 100644
--- a/go/packages/overlay_test.go
+++ b/go/packages/overlay_test.go
@@ -10,6 +10,7 @@ import (
"os"
"path/filepath"
"reflect"
+ "slices"
"sort"
"testing"
@@ -32,7 +33,7 @@ func testOverlayChangesPackageName(t *testing.T, exporter packagestest.Exporter)
log.SetFlags(log.Lshortfile)
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a.go": "package foo\nfunc f(){}\n",
},
Overlay: map[string][]byte{
@@ -62,7 +63,7 @@ func testOverlayChangesBothPackageNames(t *testing.T, exporter packagestest.Expo
log.SetFlags(log.Lshortfile)
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a.go": "package foo\nfunc g(){}\n",
"a_test.go": "package foo\nfunc f(){}\n",
},
@@ -93,7 +94,7 @@ func testOverlayChangesBothPackageNames(t *testing.T, exporter packagestest.Expo
if len(initial) != 3 {
t.Fatalf("expected 3 packages, got %v", len(initial))
}
- for i := 0; i < 3; i++ {
+ for i := range 3 {
if ok := checkPkg(t, initial[i], want[i].id, want[i].name, want[i].count); !ok {
t.Errorf("%d: got {%s %s %d}, expected %v", i, initial[i].ID,
initial[i].Name, len(initial[i].Syntax), want[i])
@@ -110,7 +111,7 @@ func TestOverlayChangesTestPackageName(t *testing.T) {
func testOverlayChangesTestPackageName(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a_test.go": "package foo\nfunc f(){}\n",
},
Overlay: map[string][]byte{
@@ -139,7 +140,7 @@ func testOverlayChangesTestPackageName(t *testing.T, exporter packagestest.Expor
if len(initial) != 3 {
t.Fatalf("expected 3 packages, got %v", len(initial))
}
- for i := 0; i < 3; i++ {
+ for i := range 3 {
if ok := checkPkg(t, initial[i], want[i].id, want[i].name, want[i].count); !ok {
t.Errorf("got {%s %s %d}, expected %v", initial[i].ID,
initial[i].Name, len(initial[i].Syntax), want[i])
@@ -194,7 +195,7 @@ func TestHello(t *testing.T) {
// First, get the source of truth by loading the package, all on disk.
onDisk := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": aFile,
"a/a_test.go": aTestVariant,
"a/a_x_test.go": aXTest,
@@ -213,7 +214,7 @@ func TestHello(t *testing.T) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": aFile,
"a/a_test.go": aTestVariant,
"a/a_x_test.go": ``, // empty x test on disk
@@ -248,7 +249,7 @@ func TestOverlay(t *testing.T) { testAllOrModulesParallel(t, testOverlay) }
func testOverlay(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import "golang.org/fake/b"; const A = "a" + b.B`,
"b/b.go": `package b; import "golang.org/fake/c"; const B = "b" + c.C`,
"c/c.go": `package c; const C = "c"`,
@@ -316,7 +317,7 @@ func TestOverlayDeps(t *testing.T) { testAllOrModulesParallel(t, testOverlayDeps
func testOverlayDeps(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"c/c.go": `package c; const C = "c"`,
"c/c_test.go": `package c; import "testing"; func TestC(t *testing.T) {}`,
},
@@ -366,7 +367,7 @@ func testNewPackagesInOverlay(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{
{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import "golang.org/fake/b"; const A = "a" + b.B`,
"b/b.go": `package b; import "golang.org/fake/c"; const B = "b" + c.C`,
"c/c.go": `package c; const C = "c"`,
@@ -375,7 +376,7 @@ func testNewPackagesInOverlay(t *testing.T, exporter packagestest.Exporter) {
},
{
Name: "example.com/extramodule",
- Files: map[string]interface{}{
+ Files: map[string]any{
"pkg/x.go": "package pkg\n",
},
},
@@ -471,7 +472,7 @@ func testOverlayNewPackageAndTest(t *testing.T, exporter packagestest.Exporter)
exported := packagestest.Export(t, exporter, []packagestest.Module{
{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"foo.txt": "placeholder",
},
},
@@ -623,7 +624,7 @@ func TestOverlayGOPATHVendoring(t *testing.T) {
exported := packagestest.Export(t, packagestest.GOPATH, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"vendor/vendor.com/foo/foo.go": `package foo; const X = "hi"`,
"user/user.go": `package user`,
},
@@ -652,7 +653,7 @@ func TestContainsOverlay(t *testing.T) { testAllOrModulesParallel(t, testContain
func testContainsOverlay(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import "golang.org/fake/b"`,
"b/b.go": `package b; import "golang.org/fake/c"`,
"c/c.go": `package c`,
@@ -681,7 +682,7 @@ func TestContainsOverlayXTest(t *testing.T) { testAllOrModulesParallel(t, testCo
func testContainsOverlayXTest(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import "golang.org/fake/b"`,
"b/b.go": `package b; import "golang.org/fake/c"`,
"c/c.go": `package c`,
@@ -717,7 +718,7 @@ func testInvalidFilesBeforeOverlay(t *testing.T, exporter packagestest.Exporter)
exported := packagestest.Export(t, exporter, []packagestest.Module{
{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"d/d.go": ``,
"main.go": ``,
},
@@ -754,7 +755,7 @@ func testInvalidFilesBeforeOverlayContains(t *testing.T, exporter packagestest.E
exported := packagestest.Export(t, exporter, []packagestest.Module{
{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"d/d.go": `package d; import "net/http"; const Get = http.MethodGet; const Hello = "hello";`,
"d/util.go": ``,
"d/d_test.go": ``,
@@ -824,11 +825,8 @@ func testInvalidFilesBeforeOverlayContains(t *testing.T, exporter packagestest.E
t.Fatalf("expected package ID %q, got %q", tt.wantID, pkg.ID)
}
var containsFile bool
- for _, goFile := range pkg.CompiledGoFiles {
- if f == goFile {
- containsFile = true
- break
- }
+ if slices.Contains(pkg.CompiledGoFiles, f) {
+ containsFile = true
}
if !containsFile {
t.Fatalf("expected %s in CompiledGoFiles, got %v", f, pkg.CompiledGoFiles)
@@ -861,7 +859,7 @@ func testInvalidXTestInGOPATH(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{
{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"x/x.go": `package x`,
"x/x_test.go": ``,
},
@@ -892,7 +890,7 @@ func testAddImportInOverlay(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{
{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a
import (
@@ -961,7 +959,7 @@ func testLoadDifferentPatterns(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{
{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"foo.txt": "placeholder",
"b/b.go": `package b
import "golang.org/fake/a"
@@ -1054,7 +1052,7 @@ func TestOverlaysInReplace(t *testing.T) {
if err := os.Mkdir(dirB, 0775); err != nil {
t.Fatal(err)
}
- if err := os.WriteFile(filepath.Join(dirB, "go.mod"), []byte(fmt.Sprintf("module %s.com", dirB)), 0775); err != nil {
+ if err := os.WriteFile(filepath.Join(dirB, "go.mod"), fmt.Appendf(nil, "module %s.com", dirB), 0775); err != nil {
t.Fatal(err)
}
if err := os.MkdirAll(filepath.Join(dirB, "inner"), 0775); err != nil {
diff --git a/go/packages/packages.go b/go/packages/packages.go
index c3a59b8ebf4..6665a04c173 100644
--- a/go/packages/packages.go
+++ b/go/packages/packages.go
@@ -141,6 +141,8 @@ const (
LoadAllSyntax = LoadSyntax | NeedDeps
// Deprecated: NeedExportsFile is a historical misspelling of NeedExportFile.
+ //
+ //go:fix inline
NeedExportsFile = NeedExportFile
)
@@ -161,7 +163,7 @@ type Config struct {
// If the user provides a logger, debug logging is enabled.
// If the GOPACKAGESDEBUG environment variable is set to true,
// but the logger is nil, default to log.Printf.
- Logf func(format string, args ...interface{})
+ Logf func(format string, args ...any)
// Dir is the directory in which to run the build system's query tool
// that provides information about the packages.
@@ -564,13 +566,13 @@ type ModuleError struct {
}
func init() {
- packagesinternal.GetDepsErrors = func(p interface{}) []*packagesinternal.PackageError {
+ packagesinternal.GetDepsErrors = func(p any) []*packagesinternal.PackageError {
return p.(*Package).depsErrors
}
- packagesinternal.SetModFile = func(config interface{}, value string) {
+ packagesinternal.SetModFile = func(config any, value string) {
config.(*Config).modFile = value
}
- packagesinternal.SetModFlag = func(config interface{}, value string) {
+ packagesinternal.SetModFlag = func(config any, value string) {
config.(*Config).modFlag = value
}
packagesinternal.TypecheckCgo = int(typecheckCgo)
@@ -739,7 +741,7 @@ func newLoader(cfg *Config) *loader {
if debug {
ld.Config.Logf = log.Printf
} else {
- ld.Config.Logf = func(format string, args ...interface{}) {}
+ ld.Config.Logf = func(format string, args ...any) {}
}
}
if ld.Config.Mode == 0 {
diff --git a/go/packages/packages_test.go b/go/packages/packages_test.go
index 06fa488d1ed..ae3cbb6bb2b 100644
--- a/go/packages/packages_test.go
+++ b/go/packages/packages_test.go
@@ -20,6 +20,7 @@ import (
"path/filepath"
"reflect"
"runtime"
+ "slices"
"sort"
"strings"
"testing"
@@ -129,7 +130,7 @@ func TestLoadImportsGraph(t *testing.T) { testAllOrModulesParallel(t, testLoadIm
func testLoadImportsGraph(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; const A = 1`,
"b/b.go": `package b; import ("golang.org/fake/a"; _ "container/list"); var B = a.A`,
"c/c.go": `package c; import (_ "golang.org/fake/b"; _ "unsafe")`,
@@ -305,7 +306,7 @@ func TestLoadImportsTestVariants(t *testing.T) {
func testLoadImportsTestVariants(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import _ "golang.org/fake/b"`,
"b/b.go": `package b`,
"b/b_test.go": `package b`,
@@ -346,11 +347,11 @@ func TestLoadAbsolutePath(t *testing.T) {
exported := packagestest.Export(t, packagestest.GOPATH, []packagestest.Module{{
Name: "golang.org/gopatha",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a`,
}}, {
Name: "golang.org/gopathb",
- Files: map[string]interface{}{
+ Files: map[string]any{
"b/b.go": `package b`,
}}})
defer exported.Cleanup()
@@ -381,13 +382,13 @@ func TestLoadArgumentListIsNotTooLong(t *testing.T) {
argMax := 1_000_000
exported := packagestest.Export(t, packagestest.GOPATH, []packagestest.Module{{
Name: "golang.org/mod",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": `package main"`,
}}})
defer exported.Cleanup()
numOfPatterns := argMax/16 + 1 // the pattern below is approx. 16 chars
patterns := make([]string, numOfPatterns)
- for i := 0; i < numOfPatterns; i++ {
+ for i := range numOfPatterns {
patterns[i] = fmt.Sprintf("golang.org/mod/p%d", i)
} // patterns have more than argMax number of chars combined with whitespaces b/w patterns
@@ -402,7 +403,7 @@ func TestVendorImports(t *testing.T) {
exported := packagestest.Export(t, packagestest.GOPATH, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import _ "b"; import _ "golang.org/fake/c";`,
"a/vendor/b/b.go": `package b; import _ "golang.org/fake/c"`,
"c/c.go": `package c; import _ "b"`,
@@ -463,7 +464,7 @@ func TestConfigDir(t *testing.T) { testAllOrModulesParallel(t, testConfigDir) }
func testConfigDir(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; const Name = "a" `,
"a/b/b.go": `package b; const Name = "a/b"`,
"b/b.go": `package b; const Name = "b"`,
@@ -522,7 +523,7 @@ func testConfigFlags(t *testing.T, exporter packagestest.Exporter) {
// Test satisfying +build line tags, with -tags flag.
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
// package a
"a/a.go": `package a; import _ "golang.org/fake/a/b"`,
"a/b.go": `// +build tag
@@ -587,7 +588,7 @@ func testLoadTypes(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import "golang.org/fake/b"; import "golang.org/fake/c"; const A = "a" + b.B + c.C`,
"b/b.go": `package b; const B = "b"`,
"c/c.go": `package c; const C = "c" + 1`,
@@ -640,7 +641,7 @@ func TestLoadTypesBits(t *testing.T) { testAllOrModulesParallel(t, testLoadTypes
func testLoadTypesBits(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import "golang.org/fake/b"; const A = "a" + b.B`,
"b/b.go": `package b; import "golang.org/fake/c"; const B = "b" + c.C`,
"c/c.go": `package c; import "golang.org/fake/d"; const C = "c" + d.D`,
@@ -716,7 +717,7 @@ func TestLoadSyntaxOK(t *testing.T) { testAllOrModulesParallel(t, testLoadSyntax
func testLoadSyntaxOK(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import "golang.org/fake/b"; const A = "a" + b.B`,
"b/b.go": `package b; import "golang.org/fake/c"; const B = "b" + c.C`,
"c/c.go": `package c; import "golang.org/fake/d"; const C = "c" + d.D`,
@@ -807,7 +808,7 @@ func testLoadDiamondTypes(t *testing.T, exporter packagestest.Exporter) {
// We make a diamond dependency and check the type d.D is the same through both paths
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import ("golang.org/fake/b"; "golang.org/fake/c"); var _ = b.B == c.C`,
"b/b.go": `package b; import "golang.org/fake/d"; var B d.D`,
"c/c.go": `package c; import "golang.org/fake/d"; var C d.D`,
@@ -850,7 +851,7 @@ func testLoadSyntaxError(t *testing.T, exporter packagestest.Exporter) {
// should be IllTyped.
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import "golang.org/fake/b"; const A = "a" + b.B`,
"b/b.go": `package b; import "golang.org/fake/c"; const B = "b" + c.C`,
"c/c.go": `package c; import "golang.org/fake/d"; const C = "c" + d.D`,
@@ -922,7 +923,7 @@ func TestParseFileModifyAST(t *testing.T) { testAllOrModulesParallel(t, testPars
func testParseFileModifyAST(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; const A = "a" `,
}}})
defer exported.Cleanup()
@@ -1010,7 +1011,7 @@ func testLoadAllSyntaxImportErrors(t *testing.T, exporter packagestest.Exporter)
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"unicycle/unicycle.go": `package unicycle; import _ "unicycle"`,
"bicycle1/bicycle1.go": `package bicycle1; import _ "bicycle2"`,
"bicycle2/bicycle2.go": `package bicycle2; import _ "bicycle1"`,
@@ -1090,7 +1091,7 @@ func TestAbsoluteFilenames(t *testing.T) { testAllOrModulesParallel(t, testAbsol
func testAbsoluteFilenames(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; const A = 1`,
"b/b.go": `package b; import ("golang.org/fake/a"; _ "errors"); var B = a.A`,
"b/vendor/a/a.go": `package a; const A = 1`,
@@ -1180,7 +1181,7 @@ func TestContains(t *testing.T) { testAllOrModulesParallel(t, testContains) }
func testContains(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import "golang.org/fake/b"`,
"b/b.go": `package b; import "golang.org/fake/c"`,
"c/c.go": `package c`,
@@ -1219,7 +1220,7 @@ func testSizes(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import "unsafe"; const WordSize = 8*unsafe.Sizeof(int(0))`,
}}})
defer exported.Cleanup()
@@ -1257,7 +1258,7 @@ func TestNeedTypeSizesWithBadGOARCH(t *testing.T) {
testAllOrModulesParallel(t, func(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "testdata",
- Files: map[string]interface{}{"a/a.go": `package a`}}})
+ Files: map[string]any{"a/a.go": `package a`}}})
defer exported.Cleanup()
exported.Config.Mode = packages.NeedTypesSizes // or {,Info,Sizes}
@@ -1280,7 +1281,7 @@ func TestContainsFallbackSticks(t *testing.T) {
func testContainsFallbackSticks(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import "golang.org/fake/b"`,
"b/b.go": `package b; import "golang.org/fake/c"`,
"c/c.go": `package c`,
@@ -1313,7 +1314,7 @@ func TestNoPatterns(t *testing.T) { testAllOrModulesParallel(t, testNoPatterns)
func testNoPatterns(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a;`,
"a/b/b.go": `package b;`,
}}})
@@ -1336,7 +1337,7 @@ func testJSON(t *testing.T, exporter packagestest.Exporter) {
// TODO: add in some errors
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; const A = 1`,
"b/b.go": `package b; import "golang.org/fake/a"; var B = a.A`,
"c/c.go": `package c; import "golang.org/fake/b" ; var C = b.B`,
@@ -1503,7 +1504,7 @@ func TestPatternPassthrough(t *testing.T) { testAllOrModulesParallel(t, testPatt
func testPatternPassthrough(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a;`,
}}})
defer exported.Cleanup()
@@ -1563,7 +1564,7 @@ EOF
}
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"bin/gopackagesdriver": driverScript,
"golist/golist.go": "package golist",
}}})
@@ -1610,7 +1611,7 @@ EOF
defer os.Setenv(pathKey, oldPath)
// Clone exported.Config
config := exported.Config
- config.Env = append([]string{}, exported.Config.Env...)
+ config.Env = slices.Clone(exported.Config.Env)
config.Env = append(config.Env, "GOPACKAGESDRIVER="+test.driver)
pkgs, err := packages.Load(exported.Config, "golist")
if err != nil {
@@ -1639,7 +1640,7 @@ func TestBasicXTest(t *testing.T) { testAllOrModulesParallel(t, testBasicXTest)
func testBasicXTest(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a;`,
"a/a_test.go": `package a_test;`,
}}})
@@ -1657,7 +1658,7 @@ func TestErrorMissingFile(t *testing.T) { testAllOrModulesParallel(t, testErrorM
func testErrorMissingFile(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a_test.go": `package a;`,
}}})
defer exported.Cleanup()
@@ -1685,11 +1686,11 @@ func TestReturnErrorWhenUsingNonGoFiles(t *testing.T) {
func testReturnErrorWhenUsingNonGoFiles(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/gopatha",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a`,
}}, {
Name: "golang.org/gopathb",
- Files: map[string]interface{}{
+ Files: map[string]any{
"b/b.c": `package b`,
}}})
defer exported.Cleanup()
@@ -1713,7 +1714,7 @@ func TestReturnErrorWhenUsingGoFilesInMultipleDirectories(t *testing.T) {
func testReturnErrorWhenUsingGoFilesInMultipleDirectories(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/gopatha",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a`,
"b/b.go": `package b`,
}}})
@@ -1745,7 +1746,7 @@ func TestReturnErrorForUnexpectedDirectoryLayout(t *testing.T) {
func testReturnErrorForUnexpectedDirectoryLayout(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/gopatha",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/testdata/a.go": `package a; import _ "b"`,
"a/vendor/b/b.go": `package b; import _ "fmt"`,
}}})
@@ -1774,7 +1775,7 @@ func TestMissingDependency(t *testing.T) { testAllOrModulesParallel(t, testMissi
func testMissingDependency(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import _ "this/package/doesnt/exist"`,
}}})
defer exported.Cleanup()
@@ -1796,7 +1797,7 @@ func TestAdHocContains(t *testing.T) { testAllOrModulesParallel(t, testAdHocCont
func testAdHocContains(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a;`,
}}})
defer exported.Cleanup()
@@ -1839,7 +1840,7 @@ func testCgoNoCcompiler(t *testing.T, exporter packagestest.Exporter) {
testenv.NeedsTool(t, "cgo")
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a
import "net/http"
const A = http.MethodGet
@@ -1873,7 +1874,7 @@ func testCgoMissingFile(t *testing.T, exporter packagestest.Exporter) {
testenv.NeedsTool(t, "cgo")
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a
// #include "foo.h"
@@ -1962,7 +1963,7 @@ func testCgoNoSyntax(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"c/c.go": `package c; import "C"`,
},
}})
@@ -1978,7 +1979,6 @@ func testCgoNoSyntax(t *testing.T, exporter packagestest.Exporter) {
packages.NeedName | packages.NeedImports,
}
for _, mode := range modes {
- mode := mode
t.Run(fmt.Sprint(mode), func(t *testing.T) {
exported.Config.Mode = mode
pkgs, err := packages.Load(exported.Config, "golang.org/fake/c")
@@ -2005,7 +2005,7 @@ func testCgoBadPkgConfig(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"c/c.go": `package c
// #cgo pkg-config: --cflags -- foo
@@ -2074,7 +2074,7 @@ func TestIssue32814(t *testing.T) { testAllOrModulesParallel(t, testIssue32814)
func testIssue32814(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{}}})
+ Files: map[string]any{}}})
defer exported.Cleanup()
exported.Config.Mode = packages.NeedName | packages.NeedTypes | packages.NeedSyntax | packages.NeedTypesInfo | packages.NeedTypesSizes
@@ -2103,7 +2103,7 @@ func TestLoadTypesInfoWithoutNeedDeps(t *testing.T) {
func testLoadTypesInfoWithoutNeedDeps(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import _ "golang.org/fake/b"`,
"b/b.go": `package b`,
}}})
@@ -2130,7 +2130,7 @@ func TestLoadWithNeedDeps(t *testing.T) {
func testLoadWithNeedDeps(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import _ "golang.org/fake/b"`,
"b/b.go": `package b; import _ "golang.org/fake/c"`,
"c/c.go": `package c`,
@@ -2174,7 +2174,7 @@ func TestImpliedLoadMode(t *testing.T) {
func testImpliedLoadMode(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import _ "golang.org/fake/b"`,
"b/b.go": `package b`,
}}})
@@ -2243,7 +2243,7 @@ func TestMultiplePackageVersionsIssue36188(t *testing.T) {
func testMultiplePackageVersionsIssue36188(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import _ "golang.org/fake/b"`,
"b/b.go": `package main`,
}}})
@@ -2363,7 +2363,7 @@ func TestCycleImportStack(t *testing.T) {
func testCycleImportStack(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; import _ "golang.org/fake/b"`,
"b/b.go": `package b; import _ "golang.org/fake/a"`,
}}})
@@ -2393,7 +2393,7 @@ func TestForTestField(t *testing.T) {
func testForTestField(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a; func hello() {};`,
"a/a_test.go": `package a; import "testing"; func TestA1(t *testing.T) {};`,
"a/x_test.go": `package a_test; import "testing"; func TestA2(t *testing.T) {};`,
@@ -2499,7 +2499,7 @@ func testIssue37098(t *testing.T, exporter packagestest.Exporter) {
// file.
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
// The "package" statement must be included for SWIG sources to
// be generated.
"a/a.go": "package a",
@@ -2550,7 +2550,7 @@ func TestIssue56632(t *testing.T) {
exported := packagestest.Export(t, packagestest.GOPATH, []packagestest.Module{{
Name: "golang.org/issue56632",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a`,
"a/a_cgo.go": `package a
@@ -2593,7 +2593,7 @@ func testInvalidFilesInXTest(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{
{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"d/d.go": `package d; import "net/http"; const d = http.MethodGet; func Get() string { return d; }`,
"d/d2.go": ``, // invalid file
"d/d_test.go": `package d_test; import "testing"; import "golang.org/fake/d"; func TestD(t *testing.T) { d.Get(); }`,
@@ -2628,7 +2628,7 @@ func testTypecheckCgo(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{
{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"cgo/cgo.go": cgo,
},
},
@@ -2662,7 +2662,7 @@ func testIssue48226(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{
{
Name: "golang.org/fake/syntax",
- Files: map[string]interface{}{
+ Files: map[string]any{
"syntax.go": `package test`,
},
},
@@ -2697,7 +2697,7 @@ func TestModule(t *testing.T) {
func testModule(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{"a/a.go": `package a`}}})
+ Files: map[string]any{"a/a.go": `package a`}}})
exported.Config.Mode = packages.NeedModule
rootDir := filepath.Dir(filepath.Dir(exported.File("golang.org/fake", "a/a.go")))
@@ -2746,7 +2746,7 @@ func testExternal_NotHandled(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a`,
"empty_driver/main.go": `package main
@@ -2787,7 +2787,7 @@ func main() {
t.Fatal(err)
}
- exported.Config.Env = append(append([]string{}, baseEnv...), "GOPACKAGESDRIVER="+emptyDriverPath)
+ exported.Config.Env = append(slices.Clone(baseEnv), "GOPACKAGESDRIVER="+emptyDriverPath)
initial, err := packages.Load(exported.Config, "golang.org/fake/a")
if err != nil {
t.Fatal(err)
@@ -2807,7 +2807,7 @@ func main() {
t.Fatal(err)
}
- exported.Config.Env = append(append([]string{}, baseEnv...), "GOPACKAGESDRIVER="+notHandledDriverPath)
+ exported.Config.Env = append(slices.Clone(baseEnv), "GOPACKAGESDRIVER="+notHandledDriverPath)
initial, err = packages.Load(exported.Config, "golang.org/fake/a")
if err != nil {
t.Fatal(err)
@@ -2825,7 +2825,7 @@ func TestInvalidPackageName(t *testing.T) {
func testInvalidPackageName(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": `package default
func main() {
@@ -3206,7 +3206,7 @@ func TestLoadTypesInfoWithoutSyntaxOrTypes(t *testing.T) {
func testLoadTypesInfoWithoutSyntaxOrTypes(t *testing.T, exporter packagestest.Exporter) {
exported := packagestest.Export(t, exporter, []packagestest.Module{{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a/a.go": `package a;
func foo() int {
diff --git a/go/packages/packagestest/expect.go b/go/packages/packagestest/expect.go
index dc41894a6ed..4be34191e62 100644
--- a/go/packages/packagestest/expect.go
+++ b/go/packages/packagestest/expect.go
@@ -72,7 +72,7 @@ const (
//
// It is safe to call this repeatedly with different method sets, but it is
// not safe to call it concurrently.
-func (e *Exported) Expect(methods map[string]interface{}) error {
+func (e *Exported) Expect(methods map[string]any) error {
if err := e.getNotes(); err != nil {
return err
}
@@ -98,7 +98,7 @@ func (e *Exported) Expect(methods map[string]interface{}) error {
n = &expect.Note{
Pos: n.Pos,
Name: markMethod,
- Args: []interface{}{n.Name, n.Name},
+ Args: []any{n.Name, n.Name},
}
}
mi, ok := ms[n.Name]
@@ -222,7 +222,7 @@ func (e *Exported) getMarkers() error {
}
// set markers early so that we don't call getMarkers again from Expect
e.markers = make(map[string]Range)
- return e.Expect(map[string]interface{}{
+ return e.Expect(map[string]any{
markMethod: e.Mark,
})
}
@@ -243,7 +243,7 @@ var (
// It takes the args remaining, and returns the args it did not consume.
// This allows a converter to consume 0 args for well known types, or multiple
// args for compound types.
-type converter func(*expect.Note, []interface{}) (reflect.Value, []interface{}, error)
+type converter func(*expect.Note, []any) (reflect.Value, []any, error)
// method is used to track information about Invoke methods that is expensive to
// calculate so that we can work it out once rather than per marker.
@@ -259,19 +259,19 @@ type method struct {
func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
switch {
case pt == noteType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
return reflect.ValueOf(n), args, nil
}, nil
case pt == fsetType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
return reflect.ValueOf(e.ExpectFileSet), args, nil
}, nil
case pt == exportedType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
return reflect.ValueOf(e), args, nil
}, nil
case pt == posType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
r, remains, err := e.rangeConverter(n, args)
if err != nil {
return reflect.Value{}, nil, err
@@ -279,7 +279,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
return reflect.ValueOf(r.Start), remains, nil
}, nil
case pt == positionType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
r, remains, err := e.rangeConverter(n, args)
if err != nil {
return reflect.Value{}, nil, err
@@ -287,7 +287,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
return reflect.ValueOf(e.ExpectFileSet.Position(r.Start)), remains, nil
}, nil
case pt == rangeType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
r, remains, err := e.rangeConverter(n, args)
if err != nil {
return reflect.Value{}, nil, err
@@ -295,7 +295,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
return reflect.ValueOf(r), remains, nil
}, nil
case pt == identifierType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -310,7 +310,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}, nil
case pt == regexType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -323,7 +323,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}, nil
case pt.Kind() == reflect.String:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -339,7 +339,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}
}, nil
case pt.Kind() == reflect.Int64:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -353,7 +353,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}
}, nil
case pt.Kind() == reflect.Bool:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -366,7 +366,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
return reflect.ValueOf(b), args, nil
}, nil
case pt.Kind() == reflect.Slice:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
converter, err := e.buildConverter(pt.Elem())
if err != nil {
return reflect.Value{}, nil, err
@@ -384,7 +384,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}, nil
default:
if pt.Kind() == reflect.Interface && pt.NumMethod() == 0 {
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -395,7 +395,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}
}
-func (e *Exported) rangeConverter(n *expect.Note, args []interface{}) (Range, []interface{}, error) {
+func (e *Exported) rangeConverter(n *expect.Note, args []any) (Range, []any, error) {
tokFile := e.ExpectFileSet.File(n.Pos)
if len(args) < 1 {
return Range{}, nil, fmt.Errorf("missing argument")
diff --git a/go/packages/packagestest/expect_test.go b/go/packages/packagestest/expect_test.go
index 46d96d61fb9..70ff6656012 100644
--- a/go/packages/packagestest/expect_test.go
+++ b/go/packages/packagestest/expect_test.go
@@ -19,7 +19,7 @@ func TestExpect(t *testing.T) {
}})
defer exported.Cleanup()
checkCount := 0
- if err := exported.Expect(map[string]interface{}{
+ if err := exported.Expect(map[string]any{
"check": func(src, target token.Position) {
checkCount++
},
diff --git a/go/packages/packagestest/export.go b/go/packages/packagestest/export.go
index 47e6d11b94b..86da99ecdf3 100644
--- a/go/packages/packagestest/export.go
+++ b/go/packages/packagestest/export.go
@@ -101,7 +101,7 @@ type Module struct {
// The keys are the file fragment that follows the module name, the value can
// be a string or byte slice, in which case it is the contents of the
// file, otherwise it must be a Writer function.
- Files map[string]interface{}
+ Files map[string]any
// Overlay is the set of source file overlays for the module.
// The keys are the file fragment as in the Files configuration.
@@ -159,7 +159,6 @@ var All = []Exporter{GOPATH, Modules}
func TestAll(t *testing.T, f func(*testing.T, Exporter)) {
t.Helper()
for _, e := range All {
- e := e // in case f calls t.Parallel
t.Run(e.Name(), func(t *testing.T) {
t.Helper()
f(t, e)
@@ -173,7 +172,6 @@ func TestAll(t *testing.T, f func(*testing.T, Exporter)) {
func BenchmarkAll(b *testing.B, f func(*testing.B, Exporter)) {
b.Helper()
for _, e := range All {
- e := e // in case f calls t.Parallel
b.Run(e.Name(), func(b *testing.B) {
b.Helper()
f(b, e)
@@ -483,7 +481,7 @@ func GroupFilesByModules(root string) ([]Module, error) {
primarymod := &Module{
Name: root,
- Files: make(map[string]interface{}),
+ Files: make(map[string]any),
Overlay: make(map[string][]byte),
}
mods := map[string]*Module{
@@ -573,7 +571,7 @@ func GroupFilesByModules(root string) ([]Module, error) {
}
mods[path] = &Module{
Name: filepath.ToSlash(module),
- Files: make(map[string]interface{}),
+ Files: make(map[string]any),
Overlay: make(map[string][]byte),
}
currentModule = path
@@ -591,8 +589,8 @@ func GroupFilesByModules(root string) ([]Module, error) {
// This is to enable the common case in tests where you have a full copy of the
// package in your testdata.
// This will panic if there is any kind of error trying to walk the file tree.
-func MustCopyFileTree(root string) map[string]interface{} {
- result := map[string]interface{}{}
+func MustCopyFileTree(root string) map[string]any {
+ result := map[string]any{}
if err := filepath.Walk(filepath.FromSlash(root), func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
diff --git a/go/packages/packagestest/export_test.go b/go/packages/packagestest/export_test.go
index eb13f560916..e3e4658efb6 100644
--- a/go/packages/packagestest/export_test.go
+++ b/go/packages/packagestest/export_test.go
@@ -16,7 +16,7 @@ import (
var testdata = []packagestest.Module{{
Name: "golang.org/fake1",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a.go": packagestest.Symlink("testdata/a.go"), // broken symlink
"b.go": "invalid file contents",
},
@@ -26,22 +26,22 @@ var testdata = []packagestest.Module{{
},
}, {
Name: "golang.org/fake2",
- Files: map[string]interface{}{
+ Files: map[string]any{
"other/a.go": "package fake2",
},
}, {
Name: "golang.org/fake2/v2",
- Files: map[string]interface{}{
+ Files: map[string]any{
"other/a.go": "package fake2",
},
}, {
Name: "golang.org/fake3@v1.0.0",
- Files: map[string]interface{}{
+ Files: map[string]any{
"other/a.go": "package fake3",
},
}, {
Name: "golang.org/fake3@v1.1.0",
- Files: map[string]interface{}{
+ Files: map[string]any{
"other/a.go": "package fake3",
},
}}
@@ -97,13 +97,13 @@ func TestGroupFilesByModules(t *testing.T) {
want: []packagestest.Module{
{
Name: "testdata/groups/one",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": true,
},
},
{
Name: "example.com/extra",
- Files: map[string]interface{}{
+ Files: map[string]any{
"help.go": true,
},
},
@@ -114,7 +114,7 @@ func TestGroupFilesByModules(t *testing.T) {
want: []packagestest.Module{
{
Name: "testdata/groups/two",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": true,
"expect/yo.go": true,
"expect/yo_test.go": true,
@@ -122,33 +122,33 @@ func TestGroupFilesByModules(t *testing.T) {
},
{
Name: "example.com/extra",
- Files: map[string]interface{}{
+ Files: map[string]any{
"yo.go": true,
"geez/help.go": true,
},
},
{
Name: "example.com/extra/v2",
- Files: map[string]interface{}{
+ Files: map[string]any{
"me.go": true,
"geez/help.go": true,
},
},
{
Name: "example.com/tempmod",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": true,
},
},
{
Name: "example.com/what@v1.0.0",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": true,
},
},
{
Name: "example.com/what@v1.1.0",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": true,
},
},
diff --git a/go/ssa/builder.go b/go/ssa/builder.go
index 4cd71260b61..84ccbc0927a 100644
--- a/go/ssa/builder.go
+++ b/go/ssa/builder.go
@@ -82,6 +82,8 @@ import (
"runtime"
"sync"
+ "slices"
+
"golang.org/x/tools/internal/typeparams"
"golang.org/x/tools/internal/versions"
)
@@ -559,7 +561,7 @@ func (sb *storebuf) emit(fn *Function) {
// literal that may reference parts of the LHS.
func (b *builder) assign(fn *Function, loc lvalue, e ast.Expr, isZero bool, sb *storebuf) {
// Can we initialize it in place?
- if e, ok := unparen(e).(*ast.CompositeLit); ok {
+ if e, ok := ast.Unparen(e).(*ast.CompositeLit); ok {
// A CompositeLit never evaluates to a pointer,
// so if the type of the location is a pointer,
// an &-operation is implied.
@@ -614,7 +616,7 @@ func (b *builder) assign(fn *Function, loc lvalue, e ast.Expr, isZero bool, sb *
// expr lowers a single-result expression e to SSA form, emitting code
// to fn and returning the Value defined by the expression.
func (b *builder) expr(fn *Function, e ast.Expr) Value {
- e = unparen(e)
+ e = ast.Unparen(e)
tv := fn.info.Types[e]
@@ -704,7 +706,7 @@ func (b *builder) expr0(fn *Function, e ast.Expr, tv types.TypeAndValue) Value {
return y
}
// Call to "intrinsic" built-ins, e.g. new, make, panic.
- if id, ok := unparen(e.Fun).(*ast.Ident); ok {
+ if id, ok := ast.Unparen(e.Fun).(*ast.Ident); ok {
if obj, ok := fn.info.Uses[id].(*types.Builtin); ok {
if v := b.builtin(fn, obj, e.Args, fn.typ(tv.Type), e.Lparen); v != nil {
return v
@@ -721,7 +723,7 @@ func (b *builder) expr0(fn *Function, e ast.Expr, tv types.TypeAndValue) Value {
switch e.Op {
case token.AND: // &X --- potentially escaping.
addr := b.addr(fn, e.X, true)
- if _, ok := unparen(e.X).(*ast.StarExpr); ok {
+ if _, ok := ast.Unparen(e.X).(*ast.StarExpr); ok {
// &*p must panic if p is nil (http://golang.org/s/go12nil).
// For simplicity, we'll just (suboptimally) rely
// on the side effects of a load.
@@ -1002,7 +1004,7 @@ func (b *builder) setCallFunc(fn *Function, e *ast.CallExpr, c *CallCommon) {
c.pos = e.Lparen
// Is this a method call?
- if selector, ok := unparen(e.Fun).(*ast.SelectorExpr); ok {
+ if selector, ok := ast.Unparen(e.Fun).(*ast.SelectorExpr); ok {
sel := fn.selection(selector)
if sel != nil && sel.kind == types.MethodVal {
obj := sel.obj.(*types.Func)
@@ -1372,7 +1374,7 @@ func (b *builder) compLit(fn *Function, addr Value, e *ast.CompositeLit, isZero
// An &-operation may be implied:
// map[*struct{}]bool{&struct{}{}: true}
wantAddr := false
- if _, ok := unparen(e.Key).(*ast.CompositeLit); ok {
+ if _, ok := ast.Unparen(e.Key).(*ast.CompositeLit); ok {
wantAddr = isPointerCore(t.Key())
}
@@ -1547,9 +1549,9 @@ func (b *builder) typeSwitchStmt(fn *Function, s *ast.TypeSwitchStmt, label *lbl
var x Value
switch ass := s.Assign.(type) {
case *ast.ExprStmt: // x.(type)
- x = b.expr(fn, unparen(ass.X).(*ast.TypeAssertExpr).X)
+ x = b.expr(fn, ast.Unparen(ass.X).(*ast.TypeAssertExpr).X)
case *ast.AssignStmt: // y := x.(type)
- x = b.expr(fn, unparen(ass.Rhs[0]).(*ast.TypeAssertExpr).X)
+ x = b.expr(fn, ast.Unparen(ass.Rhs[0]).(*ast.TypeAssertExpr).X)
}
done := fn.newBasicBlock("typeswitch.done")
@@ -1667,7 +1669,7 @@ func (b *builder) selectStmt(fn *Function, s *ast.SelectStmt, label *lblock) {
}
case *ast.AssignStmt: // x := <-ch
- recv := unparen(comm.Rhs[0]).(*ast.UnaryExpr)
+ recv := ast.Unparen(comm.Rhs[0]).(*ast.UnaryExpr)
st = &SelectState{
Dir: types.RecvOnly,
Chan: b.expr(fn, recv.X),
@@ -1678,7 +1680,7 @@ func (b *builder) selectStmt(fn *Function, s *ast.SelectStmt, label *lblock) {
}
case *ast.ExprStmt: // <-ch
- recv := unparen(comm.X).(*ast.UnaryExpr)
+ recv := ast.Unparen(comm.X).(*ast.UnaryExpr)
st = &SelectState{
Dir: types.RecvOnly,
Chan: b.expr(fn, recv.X),
@@ -2021,8 +2023,8 @@ func (b *builder) forStmtGo122(fn *Function, s *ast.ForStmt, label *lblock) {
// Remove instructions for phi, load, and store.
// lift() will remove the unused i_next *Alloc.
isDead := func(i Instruction) bool { return dead[i] }
- loop.Instrs = removeInstrsIf(loop.Instrs, isDead)
- post.Instrs = removeInstrsIf(post.Instrs, isDead)
+ loop.Instrs = slices.DeleteFunc(loop.Instrs, isDead)
+ post.Instrs = slices.DeleteFunc(post.Instrs, isDead)
}
}
diff --git a/go/ssa/builder_test.go b/go/ssa/builder_test.go
index 2589cc82bb6..a48723bd271 100644
--- a/go/ssa/builder_test.go
+++ b/go/ssa/builder_test.go
@@ -613,7 +613,6 @@ var indirect = R[int].M
"(p.S[int]).M[int]",
},
} {
- entry := entry
t.Run(entry.name, func(t *testing.T) {
v := p.Var(entry.name)
if v == nil {
@@ -1011,7 +1010,6 @@ func TestGo117Builtins(t *testing.T) {
}
for _, tc := range tests {
- tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
fset := token.NewFileSet()
@@ -1466,7 +1464,6 @@ func TestBuildPackageGo120(t *testing.T) {
}
for _, tc := range tests {
- tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
fset := token.NewFileSet()
diff --git a/go/ssa/const_test.go b/go/ssa/const_test.go
index 6738f07b2ef..6097bd93757 100644
--- a/go/ssa/const_test.go
+++ b/go/ssa/const_test.go
@@ -39,9 +39,9 @@ func TestConstString(t *testing.T) {
}
for _, test := range []struct {
- expr string // type expression
- constant interface{} // constant value
- want string // expected String() value
+ expr string // type expression
+ constant any // constant value
+ want string // expected String() value
}{
{"int", int64(0), "0:int"},
{"int64", int64(0), "0:int64"},
diff --git a/go/ssa/dom.go b/go/ssa/dom.go
index f490986140c..78f651c8ee9 100644
--- a/go/ssa/dom.go
+++ b/go/ssa/dom.go
@@ -22,6 +22,7 @@ import (
"fmt"
"math/big"
"os"
+ "slices"
"sort"
)
@@ -43,7 +44,7 @@ func (b *BasicBlock) Dominates(c *BasicBlock) bool {
// DomPreorder returns a new slice containing the blocks of f
// in a preorder traversal of the dominator tree.
func (f *Function) DomPreorder() []*BasicBlock {
- slice := append([]*BasicBlock(nil), f.Blocks...)
+ slice := slices.Clone(f.Blocks)
sort.Slice(slice, func(i, j int) bool {
return slice[i].dom.pre < slice[j].dom.pre
})
@@ -54,7 +55,7 @@ func (f *Function) DomPreorder() []*BasicBlock {
// in a postorder traversal of the dominator tree.
// (This is not the same as a postdominance order.)
func (f *Function) DomPostorder() []*BasicBlock {
- slice := append([]*BasicBlock(nil), f.Blocks...)
+ slice := slices.Clone(f.Blocks)
sort.Slice(slice, func(i, j int) bool {
return slice[i].dom.post < slice[j].dom.post
})
@@ -277,8 +278,8 @@ func sanityCheckDomTree(f *Function) {
// Check the entire relation. O(n^2).
// The Recover block (if any) must be treated specially so we skip it.
ok := true
- for i := 0; i < n; i++ {
- for j := 0; j < n; j++ {
+ for i := range n {
+ for j := range n {
b, c := f.Blocks[i], f.Blocks[j]
if c == f.Recover {
continue
diff --git a/go/ssa/emit.go b/go/ssa/emit.go
index a3d41ad95a4..e53ebf5a7fd 100644
--- a/go/ssa/emit.go
+++ b/go/ssa/emit.go
@@ -81,7 +81,7 @@ func emitDebugRef(f *Function, e ast.Expr, v Value, isAddr bool) {
panic("nil")
}
var obj types.Object
- e = unparen(e)
+ e = ast.Unparen(e)
if id, ok := e.(*ast.Ident); ok {
if isBlankIdent(id) {
return
@@ -496,7 +496,7 @@ func emitTailCall(f *Function, call *Call) {
case 1:
ret.Results = []Value{tuple}
default:
- for i := 0; i < nr; i++ {
+ for i := range nr {
v := emitExtract(f, tuple, i)
// TODO(adonovan): in principle, this is required:
// v = emitConv(f, o.Type, f.Signature.Results[i].Type)
diff --git a/go/ssa/example_test.go b/go/ssa/example_test.go
index e0fba0be681..03775414df2 100644
--- a/go/ssa/example_test.go
+++ b/go/ssa/example_test.go
@@ -3,9 +3,6 @@
// license that can be found in the LICENSE file.
//go:build !android && !ios && (unix || aix || darwin || dragonfly || freebsd || linux || netbsd || openbsd || solaris || plan9 || windows)
-// +build !android
-// +build !ios
-// +build unix aix darwin dragonfly freebsd linux netbsd openbsd solaris plan9 windows
package ssa_test
diff --git a/go/ssa/func.go b/go/ssa/func.go
index 010c128a9ec..2d52309b623 100644
--- a/go/ssa/func.go
+++ b/go/ssa/func.go
@@ -13,6 +13,7 @@ import (
"go/token"
"go/types"
"io"
+ "iter"
"os"
"strings"
@@ -187,8 +188,7 @@ func targetedBlock(f *Function, tok token.Token) *BasicBlock {
}
// instrs returns an iterator that returns each reachable instruction of the SSA function.
-// TODO: return an iter.Seq once x/tools is on 1.23
-func (f *Function) instrs() func(yield func(i Instruction) bool) {
+func (f *Function) instrs() iter.Seq[Instruction] {
return func(yield func(i Instruction) bool) {
for _, block := range f.Blocks {
for _, instr := range block.Instrs {
@@ -817,7 +817,7 @@ func blockExit(fn *Function, block *BasicBlock, pos token.Pos) *exit {
return e
}
-// blockExit creates a new exit to a yield fn that returns the source function.
+// returnExit creates a new exit to a yield fn that returns the source function.
func returnExit(fn *Function, pos token.Pos) *exit {
e := &exit{
id: unique(fn),
diff --git a/go/ssa/instantiate.go b/go/ssa/instantiate.go
index 2512f32976c..20a0986e6d3 100644
--- a/go/ssa/instantiate.go
+++ b/go/ssa/instantiate.go
@@ -7,6 +7,7 @@ package ssa
import (
"fmt"
"go/types"
+ "slices"
"sync"
)
@@ -122,10 +123,5 @@ func (prog *Program) isParameterized(ts ...types.Type) bool {
// handle the most common but shallow cases such as T, pkg.T,
// *T without consulting the cache under the lock.
- for _, t := range ts {
- if prog.hasParams.Has(t) {
- return true
- }
- }
- return false
+ return slices.ContainsFunc(ts, prog.hasParams.Has)
}
diff --git a/go/ssa/interp/external.go b/go/ssa/interp/external.go
index 2a3a7e5b79e..2fb683c07fe 100644
--- a/go/ssa/interp/external.go
+++ b/go/ssa/interp/external.go
@@ -9,6 +9,7 @@ package interp
import (
"bytes"
+ "maps"
"math"
"os"
"runtime"
@@ -30,7 +31,7 @@ var externals = make(map[string]externalFn)
func init() {
// That little dot ۰ is an Arabic zero numeral (U+06F0), categories [Nd].
- for k, v := range map[string]externalFn{
+ maps.Copy(externals, map[string]externalFn{
"(reflect.Value).Bool": ext۰reflect۰Value۰Bool,
"(reflect.Value).CanAddr": ext۰reflect۰Value۰CanAddr,
"(reflect.Value).CanInterface": ext۰reflect۰Value۰CanInterface,
@@ -111,9 +112,7 @@ func init() {
"strings.ToLower": ext۰strings۰ToLower,
"time.Sleep": ext۰time۰Sleep,
"unicode/utf8.DecodeRuneInString": ext۰unicode۰utf8۰DecodeRuneInString,
- } {
- externals[k] = v
- }
+ })
}
func ext۰bytes۰Equal(fr *frame, args []value) value {
diff --git a/go/ssa/interp/interp.go b/go/ssa/interp/interp.go
index f80db0676c7..7bd06120f6c 100644
--- a/go/ssa/interp/interp.go
+++ b/go/ssa/interp/interp.go
@@ -109,7 +109,7 @@ type frame struct {
defers *deferred
result value
panicking bool
- panic interface{}
+ panic any
phitemps []value // temporaries for parallel phi assignment
}
diff --git a/go/ssa/interp/map.go b/go/ssa/interp/map.go
index f5d5f230b73..e96e44df2b9 100644
--- a/go/ssa/interp/map.go
+++ b/go/ssa/interp/map.go
@@ -17,7 +17,7 @@ import (
type hashable interface {
hash(t types.Type) int
- eq(t types.Type, x interface{}) bool
+ eq(t types.Type, x any) bool
}
type entry struct {
diff --git a/go/ssa/interp/reflect.go b/go/ssa/interp/reflect.go
index 8259e56d860..22f8cde89c0 100644
--- a/go/ssa/interp/reflect.go
+++ b/go/ssa/interp/reflect.go
@@ -231,7 +231,7 @@ func reflectKind(t types.Type) reflect.Kind {
case *types.Map:
return reflect.Map
case *types.Pointer:
- return reflect.Ptr
+ return reflect.Pointer
case *types.Slice:
return reflect.Slice
case *types.Struct:
@@ -510,7 +510,7 @@ func newMethod(pkg *ssa.Package, recvType types.Type, name string) *ssa.Function
// that is needed is the "pointerness" of Recv.Type, and for
// now, we'll set it to always be false since we're only
// concerned with rtype. Encapsulate this better.
- sig := types.NewSignature(types.NewParam(token.NoPos, nil, "recv", recvType), nil, nil, false)
+ sig := types.NewSignatureType(types.NewParam(token.NoPos, nil, "recv", recvType), nil, nil, nil, nil, false)
fn := pkg.Prog.NewFunction(name, sig, "fake reflect method")
fn.Pkg = pkg
return fn
diff --git a/go/ssa/interp/value.go b/go/ssa/interp/value.go
index bd681cb6152..4d65aa6c83e 100644
--- a/go/ssa/interp/value.go
+++ b/go/ssa/interp/value.go
@@ -48,7 +48,7 @@ import (
"golang.org/x/tools/go/types/typeutil"
)
-type value interface{}
+type value any
type tuple []value
@@ -123,7 +123,7 @@ func usesBuiltinMap(t types.Type) bool {
panic(fmt.Sprintf("invalid map key type: %T", t))
}
-func (x array) eq(t types.Type, _y interface{}) bool {
+func (x array) eq(t types.Type, _y any) bool {
y := _y.(array)
tElt := t.Underlying().(*types.Array).Elem()
for i, xi := range x {
@@ -143,7 +143,7 @@ func (x array) hash(t types.Type) int {
return h
}
-func (x structure) eq(t types.Type, _y interface{}) bool {
+func (x structure) eq(t types.Type, _y any) bool {
y := _y.(structure)
tStruct := t.Underlying().(*types.Struct)
for i, n := 0, tStruct.NumFields(); i < n; i++ {
@@ -175,7 +175,7 @@ func sameType(x, y types.Type) bool {
return y != nil && types.Identical(x, y)
}
-func (x iface) eq(t types.Type, _y interface{}) bool {
+func (x iface) eq(t types.Type, _y any) bool {
y := _y.(iface)
return sameType(x.t, y.t) && (x.t == nil || equals(x.t, x.v, y.v))
}
@@ -188,7 +188,7 @@ func (x rtype) hash(_ types.Type) int {
return hashType(x.t)
}
-func (x rtype) eq(_ types.Type, y interface{}) bool {
+func (x rtype) eq(_ types.Type, y any) bool {
return types.Identical(x.t, y.(rtype).t)
}
diff --git a/go/ssa/lift.go b/go/ssa/lift.go
index aada3dc3227..d7c1bf5063e 100644
--- a/go/ssa/lift.go
+++ b/go/ssa/lift.go
@@ -43,6 +43,7 @@ import (
"go/token"
"math/big"
"os"
+ "slices"
"golang.org/x/tools/internal/typeparams"
)
@@ -105,23 +106,7 @@ func buildDomFrontier(fn *Function) domFrontier {
}
func removeInstr(refs []Instruction, instr Instruction) []Instruction {
- return removeInstrsIf(refs, func(i Instruction) bool { return i == instr })
-}
-
-func removeInstrsIf(refs []Instruction, p func(Instruction) bool) []Instruction {
- // TODO(taking): replace with go1.22 slices.DeleteFunc.
- i := 0
- for _, ref := range refs {
- if p(ref) {
- continue
- }
- refs[i] = ref
- i++
- }
- for j := i; j != len(refs); j++ {
- refs[j] = nil // aid GC
- }
- return refs[:i]
+ return slices.DeleteFunc(refs, func(i Instruction) bool { return i == instr })
}
// lift replaces local and new Allocs accessed only with
@@ -389,7 +374,7 @@ func (s *blockSet) add(b *BasicBlock) bool {
// returns its index, or returns -1 if empty.
func (s *blockSet) take() int {
l := s.BitLen()
- for i := 0; i < l; i++ {
+ for i := range l {
if s.Bit(i) == 1 {
s.SetBit(&s.Int, i, 0)
return i
@@ -418,10 +403,8 @@ func liftAlloc(df domFrontier, alloc *Alloc, newPhis newPhiMap, fresh *int) bool
// Don't lift result values in functions that defer
// calls that may recover from panic.
if fn := alloc.Parent(); fn.Recover != nil {
- for _, nr := range fn.results {
- if nr == alloc {
- return false
- }
+ if slices.Contains(fn.results, alloc) {
+ return false
}
}
diff --git a/go/ssa/mode.go b/go/ssa/mode.go
index 8381639a585..61c91452ce2 100644
--- a/go/ssa/mode.go
+++ b/go/ssa/mode.go
@@ -108,4 +108,4 @@ func (m *BuilderMode) Set(s string) error {
}
// Get returns m.
-func (m BuilderMode) Get() interface{} { return m }
+func (m BuilderMode) Get() any { return m }
diff --git a/go/ssa/print.go b/go/ssa/print.go
index 432c4b05b6d..8b92d08463a 100644
--- a/go/ssa/print.go
+++ b/go/ssa/print.go
@@ -387,7 +387,7 @@ func (s *MapUpdate) String() string {
func (s *DebugRef) String() string {
p := s.Parent().Prog.Fset.Position(s.Pos())
- var descr interface{}
+ var descr any
if s.object != nil {
descr = s.object // e.g. "var x int"
} else {
diff --git a/go/ssa/sanity.go b/go/ssa/sanity.go
index e35e4d79357..b11680a1e1d 100644
--- a/go/ssa/sanity.go
+++ b/go/ssa/sanity.go
@@ -14,6 +14,7 @@ import (
"go/types"
"io"
"os"
+ "slices"
"strings"
)
@@ -48,7 +49,7 @@ func mustSanityCheck(fn *Function, reporter io.Writer) {
}
}
-func (s *sanity) diagnostic(prefix, format string, args ...interface{}) {
+func (s *sanity) diagnostic(prefix, format string, args ...any) {
fmt.Fprintf(s.reporter, "%s: function %s", prefix, s.fn)
if s.block != nil {
fmt.Fprintf(s.reporter, ", block %s", s.block)
@@ -58,12 +59,12 @@ func (s *sanity) diagnostic(prefix, format string, args ...interface{}) {
io.WriteString(s.reporter, "\n")
}
-func (s *sanity) errorf(format string, args ...interface{}) {
+func (s *sanity) errorf(format string, args ...any) {
s.insane = true
s.diagnostic("Error", format, args...)
}
-func (s *sanity) warnf(format string, args ...interface{}) {
+func (s *sanity) warnf(format string, args ...any) {
s.diagnostic("Warning", format, args...)
}
@@ -119,13 +120,7 @@ func (s *sanity) checkInstr(idx int, instr Instruction) {
case *Alloc:
if !instr.Heap {
- found := false
- for _, l := range s.fn.Locals {
- if l == instr {
- found = true
- break
- }
- }
+ found := slices.Contains(s.fn.Locals, instr)
if !found {
s.errorf("local alloc %s = %s does not appear in Function.Locals", instr.Name(), instr)
}
@@ -282,13 +277,7 @@ func (s *sanity) checkBlock(b *BasicBlock, index int) {
// Check predecessor and successor relations are dual,
// and that all blocks in CFG belong to same function.
for _, a := range b.Preds {
- found := false
- for _, bb := range a.Succs {
- if bb == b {
- found = true
- break
- }
- }
+ found := slices.Contains(a.Succs, b)
if !found {
s.errorf("expected successor edge in predecessor %s; found only: %s", a, a.Succs)
}
@@ -297,13 +286,7 @@ func (s *sanity) checkBlock(b *BasicBlock, index int) {
}
}
for _, c := range b.Succs {
- found := false
- for _, bb := range c.Preds {
- if bb == b {
- found = true
- break
- }
- }
+ found := slices.Contains(c.Preds, b)
if !found {
s.errorf("expected predecessor edge in successor %s; found only: %s", c, c.Preds)
}
@@ -529,12 +512,10 @@ func (s *sanity) checkFunction(fn *Function) bool {
// Build the set of valid referrers.
s.instrs = make(map[Instruction]unit)
- // TODO: switch to range-over-func when x/tools updates to 1.23.
// instrs are the instructions that are present in the function.
- fn.instrs()(func(instr Instruction) bool {
+ for instr := range fn.instrs() {
s.instrs[instr] = unit{}
- return true
- })
+ }
// Check all Locals allocations appear in the function instruction.
for i, l := range fn.Locals {
diff --git a/go/ssa/source.go b/go/ssa/source.go
index 055a6b1ef5f..d0cc1f4861a 100644
--- a/go/ssa/source.go
+++ b/go/ssa/source.go
@@ -153,7 +153,7 @@ func findNamedFunc(pkg *Package, pos token.Pos) *Function {
// the ssa.Value.)
func (f *Function) ValueForExpr(e ast.Expr) (value Value, isAddr bool) {
if f.debugInfo() { // (opt)
- e = unparen(e)
+ e = ast.Unparen(e)
for _, b := range f.Blocks {
for _, instr := range b.Instrs {
if ref, ok := instr.(*DebugRef); ok {
diff --git a/go/ssa/ssautil/load_test.go b/go/ssa/ssautil/load_test.go
index 10375a3227f..cf157fe4401 100644
--- a/go/ssa/ssautil/load_test.go
+++ b/go/ssa/ssautil/load_test.go
@@ -154,7 +154,7 @@ func TestIssue53604(t *testing.T) {
e := packagestest.Export(t, packagestest.Modules, []packagestest.Module{
{
Name: "golang.org/fake",
- Files: map[string]interface{}{
+ Files: map[string]any{
"x/x.go": `package x; import "golang.org/fake/y"; var V = y.F()`,
"y/y.go": `package y; import "golang.org/fake/z"; var F = func () *int { return &z.Z } `,
"z/z.go": `package z; var Z int`,
diff --git a/go/ssa/ssautil/switch_test.go b/go/ssa/ssautil/switch_test.go
index 081b09010ee..6ff5c9b92c3 100644
--- a/go/ssa/ssautil/switch_test.go
+++ b/go/ssa/ssautil/switch_test.go
@@ -5,7 +5,6 @@
// No testdata on Android.
//go:build !android
-// +build !android
package ssautil_test
diff --git a/go/ssa/stdlib_test.go b/go/ssa/stdlib_test.go
index 9b78cfbf839..08df50b9eeb 100644
--- a/go/ssa/stdlib_test.go
+++ b/go/ssa/stdlib_test.go
@@ -5,7 +5,6 @@
// Incomplete source tree on Android.
//go:build !android
-// +build !android
package ssa_test
diff --git a/go/ssa/subst.go b/go/ssa/subst.go
index bbe5796d703..b4ea16854ea 100644
--- a/go/ssa/subst.go
+++ b/go/ssa/subst.go
@@ -266,7 +266,7 @@ func (subst *subster) interface_(iface *types.Interface) *types.Interface {
var methods []*types.Func
initMethods := func(n int) { // copy first n explicit methods
methods = make([]*types.Func, iface.NumExplicitMethods())
- for i := 0; i < n; i++ {
+ for i := range n {
f := iface.ExplicitMethod(i)
norecv := changeRecv(f.Type().(*types.Signature), nil)
methods[i] = types.NewFunc(f.Pos(), f.Pkg(), f.Name(), norecv)
@@ -290,7 +290,7 @@ func (subst *subster) interface_(iface *types.Interface) *types.Interface {
var embeds []types.Type
initEmbeds := func(n int) { // copy first n embedded types
embeds = make([]types.Type, iface.NumEmbeddeds())
- for i := 0; i < n; i++ {
+ for i := range n {
embeds[i] = iface.EmbeddedType(i)
}
}
diff --git a/go/ssa/util.go b/go/ssa/util.go
index 4a056cbe0bd..e53b31ff3bb 100644
--- a/go/ssa/util.go
+++ b/go/ssa/util.go
@@ -35,8 +35,6 @@ func assert(p bool, msg string) {
//// AST utilities
-func unparen(e ast.Expr) ast.Expr { return ast.Unparen(e) }
-
// isBlankIdent returns true iff e is an Ident with name "_".
// They have no associated types.Object, and thus no type.
func isBlankIdent(e ast.Expr) bool {
@@ -168,7 +166,7 @@ func declaredWithin(obj types.Object, fn *types.Func) bool {
// returns a closure that prints the corresponding "end" message.
// Call using 'defer logStack(...)()' to show builder stack on panic.
// Don't forget trailing parens!
-func logStack(format string, args ...interface{}) func() {
+func logStack(format string, args ...any) func() {
msg := fmt.Sprintf(format, args...)
io.WriteString(os.Stderr, msg)
io.WriteString(os.Stderr, "\n")
@@ -195,7 +193,7 @@ func makeLen(T types.Type) *Builtin {
lenParams := types.NewTuple(anonVar(T))
return &Builtin{
name: "len",
- sig: types.NewSignature(nil, lenParams, lenResults, false),
+ sig: types.NewSignatureType(nil, nil, nil, lenParams, lenResults, false),
}
}
@@ -387,7 +385,7 @@ func (m *typeListMap) hash(ts []types.Type) uint32 {
// Some smallish prime far away from typeutil.Hash.
n := len(ts)
h := uint32(13619) + 2*uint32(n)
- for i := 0; i < n; i++ {
+ for i := range n {
h += 3 * m.hasher.Hash(ts[i])
}
return h
diff --git a/go/ssa/wrappers.go b/go/ssa/wrappers.go
index d09b4f250ee..aeb160eff23 100644
--- a/go/ssa/wrappers.go
+++ b/go/ssa/wrappers.go
@@ -106,9 +106,7 @@ func (b *builder) buildWrapper(fn *Function) {
var c Call
c.Call.Value = &Builtin{
name: "ssa:wrapnilchk",
- sig: types.NewSignature(nil,
- types.NewTuple(anonVar(fn.method.recv), anonVar(tString), anonVar(tString)),
- types.NewTuple(anonVar(fn.method.recv)), false),
+ sig: types.NewSignatureType(nil, nil, nil, types.NewTuple(anonVar(fn.method.recv), anonVar(tString), anonVar(tString)), types.NewTuple(anonVar(fn.method.recv)), false),
}
c.Call.Args = []Value{
v,
@@ -262,7 +260,7 @@ func createThunk(prog *Program, sel *selection) *Function {
}
func changeRecv(s *types.Signature, recv *types.Var) *types.Signature {
- return types.NewSignature(recv, s.Params(), s.Results(), s.Variadic())
+ return types.NewSignatureType(recv, nil, nil, s.Params(), s.Results(), s.Variadic())
}
// A local version of *types.Selection.
diff --git a/go/types/internal/play/gotypesalias.go b/go/types/internal/play/gotypesalias.go
deleted file mode 100644
index 288c10c2d0a..00000000000
--- a/go/types/internal/play/gotypesalias.go
+++ /dev/null
@@ -1,12 +0,0 @@
-// Copyright 2024 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.
-
-//go:build go1.23
-
-//go:debug gotypesalias=1
-
-package main
-
-// Materialize aliases whenever the go toolchain version is after 1.23 (#69772).
-// Remove this file after go.mod >= 1.23 (which implies gotypesalias=1).
diff --git a/go/types/internal/play/play.go b/go/types/internal/play/play.go
index eb9e5794b94..4212a6b82cf 100644
--- a/go/types/internal/play/play.go
+++ b/go/types/internal/play/play.go
@@ -2,6 +2,8 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
+//go:build go1.23
+
// The play program is a playground for go/types: a simple web-based
// text editor into which the user can enter a Go program, select a
// region, and see type information about it.
@@ -28,14 +30,15 @@ import (
"strings"
"golang.org/x/tools/go/ast/astutil"
+ "golang.org/x/tools/go/ast/inspector"
"golang.org/x/tools/go/packages"
"golang.org/x/tools/go/types/typeutil"
+ "golang.org/x/tools/internal/astutil/cursor"
"golang.org/x/tools/internal/typeparams"
)
// TODO(adonovan):
// - show line numbers next to textarea.
-// - show a (tree) breakdown of the representation of the expression's type.
// - mention this in the go/types tutorial.
// - display versions of go/types and go command.
@@ -160,6 +163,15 @@ func handleSelectJSON(w http.ResponseWriter, req *http.Request) {
innermostExpr = e
}
}
+ // Show the cursor stack too.
+ // It's usually the same, but may differ in edge
+ // cases (e.g. around FuncType.Func).
+ inspect := inspector.New([]*ast.File{file})
+ if cur, ok := cursor.Root(inspect).FindPos(startPos, endPos); ok {
+ fmt.Fprintf(out, "Cursor.FindPos().Stack() = %v\n", cur.Stack(nil))
+ } else {
+ fmt.Fprintf(out, "Cursor.FindPos() failed\n")
+ }
fmt.Fprintf(out, "\n")
// Expression type information
@@ -297,6 +309,10 @@ func formatObj(out *strings.Builder, fset *token.FileSet, ref string, obj types.
}
fmt.Fprintf(out, "\n\n")
+ fmt.Fprintf(out, "Type:\n")
+ describeType(out, obj.Type())
+ fmt.Fprintf(out, "\n")
+
// method set
if methods := typeutil.IntuitiveMethodSet(obj.Type(), nil); len(methods) > 0 {
fmt.Fprintf(out, "Methods:\n")
@@ -318,6 +334,65 @@ func formatObj(out *strings.Builder, fset *token.FileSet, ref string, obj types.
}
}
+// describeType formats t to out in a way that makes it clear what methods to call on t to
+// get at its parts.
+// describeType assumes t was constructed by the type checker, so it doesn't check
+// for recursion. The type checker replaces recursive alias types, which are illegal,
+// with a BasicType that says as much. Other types that it constructs are recursive
+// only via a name, and this function does not traverse names.
+func describeType(out *strings.Builder, t types.Type) {
+ depth := -1
+
+ var ft func(string, types.Type)
+ ft = func(prefix string, t types.Type) {
+ depth++
+ defer func() { depth-- }()
+
+ for range depth {
+ fmt.Fprint(out, ". ")
+ }
+
+ fmt.Fprintf(out, "%s%T:", prefix, t)
+ switch t := t.(type) {
+ case *types.Basic:
+ fmt.Fprintf(out, " Name: %q\n", t.Name())
+ case *types.Pointer:
+ fmt.Fprintln(out)
+ ft("Elem: ", t.Elem())
+ case *types.Slice:
+ fmt.Fprintln(out)
+ ft("Elem: ", t.Elem())
+ case *types.Array:
+ fmt.Fprintf(out, " Len: %d\n", t.Len())
+ ft("Elem: ", t.Elem())
+ case *types.Map:
+ fmt.Fprintln(out)
+ ft("Key: ", t.Key())
+ ft("Elem: ", t.Elem())
+ case *types.Chan:
+ fmt.Fprintf(out, " Dir: %s\n", chanDirs[t.Dir()])
+ ft("Elem: ", t.Elem())
+ case *types.Alias:
+ fmt.Fprintf(out, " Name: %q\n", t.Obj().Name())
+ ft("Rhs: ", t.Rhs())
+ default:
+ // For types we may have missed or which have too much to bother with,
+ // print their string representation.
+ // TODO(jba): print more about struct types (their fields) and interface and named
+ // types (their methods).
+ fmt.Fprintf(out, " %s\n", t)
+ }
+ }
+
+ ft("", t)
+}
+
+var chanDirs = []string{
+ "SendRecv",
+ "SendOnly",
+ "RecvOnly",
+}
+
func handleRoot(w http.ResponseWriter, req *http.Request) { io.WriteString(w, mainHTML) }
func handleJS(w http.ResponseWriter, req *http.Request) { io.WriteString(w, mainJS) }
func handleCSS(w http.ResponseWriter, req *http.Request) { io.WriteString(w, mainCSS) }
@@ -366,12 +441,3 @@ textarea { width: 6in; }
body { color: gray; }
div#out { font-family: monospace; font-size: 80%; }
`
-
-// TODO(adonovan): use go1.21 built-in.
-func min(x, y int) int {
- if x < y {
- return x
- } else {
- return y
- }
-}
diff --git a/go/types/objectpath/objectpath_test.go b/go/types/objectpath/objectpath_test.go
index 0805c9d919a..642d6da4926 100644
--- a/go/types/objectpath/objectpath_test.go
+++ b/go/types/objectpath/objectpath_test.go
@@ -308,7 +308,7 @@ func (unreachable) F() {} // not reachable in export data
if err != nil {
t.Fatal(err)
}
- conf := types.Config{Importer: importer.For("source", nil)}
+ conf := types.Config{Importer: importer.ForCompiler(token.NewFileSet(), "source", nil)}
info := &types.Info{
Defs: make(map[*ast.Ident]types.Object),
}
diff --git a/go/types/typeutil/callee.go b/go/types/typeutil/callee.go
index 754380351e8..53b71339305 100644
--- a/go/types/typeutil/callee.go
+++ b/go/types/typeutil/callee.go
@@ -7,45 +7,23 @@ package typeutil
import (
"go/ast"
"go/types"
-
- "golang.org/x/tools/internal/typeparams"
+ _ "unsafe" // for linkname
)
// Callee returns the named target of a function call, if any:
// a function, method, builtin, or variable.
//
// Functions and methods may potentially have type parameters.
+//
+// Note: for calls of instantiated functions and methods, Callee returns
+// the corresponding generic function or method on the generic type.
func Callee(info *types.Info, call *ast.CallExpr) types.Object {
- fun := ast.Unparen(call.Fun)
-
- // Look through type instantiation if necessary.
- isInstance := false
- switch fun.(type) {
- case *ast.IndexExpr, *ast.IndexListExpr:
- // When extracting the callee from an *IndexExpr, we need to check that
- // it is a *types.Func and not a *types.Var.
- // Example: Don't match a slice m within the expression `m[0]()`.
- isInstance = true
- fun, _, _, _ = typeparams.UnpackIndexExpr(fun)
- }
-
- var obj types.Object
- switch fun := fun.(type) {
- case *ast.Ident:
- obj = info.Uses[fun] // type, var, builtin, or declared func
- case *ast.SelectorExpr:
- if sel, ok := info.Selections[fun]; ok {
- obj = sel.Obj() // method or field
- } else {
- obj = info.Uses[fun.Sel] // qualified identifier?
- }
+ obj := info.Uses[usedIdent(info, call.Fun)]
+ if obj == nil {
+ return nil
}
if _, ok := obj.(*types.TypeName); ok {
- return nil // T(x) is a conversion, not a call
- }
- // A Func is required to match instantiations.
- if _, ok := obj.(*types.Func); isInstance && !ok {
- return nil // Was not a Func.
+ return nil
}
return obj
}
@@ -56,13 +34,52 @@ func Callee(info *types.Info, call *ast.CallExpr) types.Object {
// Note: for calls of instantiated functions and methods, StaticCallee returns
// the corresponding generic function or method on the generic type.
func StaticCallee(info *types.Info, call *ast.CallExpr) *types.Func {
- if f, ok := Callee(info, call).(*types.Func); ok && !interfaceMethod(f) {
- return f
+ obj := info.Uses[usedIdent(info, call.Fun)]
+ fn, _ := obj.(*types.Func)
+ if fn == nil || interfaceMethod(fn) {
+ return nil
+ }
+ return fn
+}
+
+// usedIdent is the implementation of [internal/typesinternal.UsedIdent].
+// It returns the identifier associated with e.
+// See typesinternal.UsedIdent for a fuller description.
+// This function should live in typesinternal, but cannot because it would
+// create an import cycle.
+//
+//go:linkname usedIdent
+func usedIdent(info *types.Info, e ast.Expr) *ast.Ident {
+ if info.Types == nil || info.Uses == nil {
+ panic("one of info.Types or info.Uses is nil; both must be populated")
+ }
+ // Look through type instantiation if necessary.
+ switch d := ast.Unparen(e).(type) {
+ case *ast.IndexExpr:
+ if info.Types[d.Index].IsType() {
+ e = d.X
+ }
+ case *ast.IndexListExpr:
+ e = d.X
+ }
+
+ switch e := ast.Unparen(e).(type) {
+ // info.Uses always has the object we want, even for selector expressions.
+ // We don't need info.Selections.
+ // See go/types/recording.go:recordSelection.
+ case *ast.Ident:
+ return e
+ case *ast.SelectorExpr:
+ return e.Sel
}
return nil
}
+// interfaceMethod reports whether its argument is a method of an interface.
+// This function should live in typesinternal, but cannot because it would create an import cycle.
+//
+//go:linkname interfaceMethod
func interfaceMethod(f *types.Func) bool {
- recv := f.Type().(*types.Signature).Recv()
+ recv := f.Signature().Recv()
return recv != nil && types.IsInterface(recv.Type())
}
diff --git a/go/types/typeutil/callee_test.go b/go/types/typeutil/callee_test.go
index 1d48bc743a9..3f96533ffff 100644
--- a/go/types/typeutil/callee_test.go
+++ b/go/types/typeutil/callee_test.go
@@ -122,6 +122,7 @@ func testStaticCallee(t *testing.T, contents []string) {
cfg := &types.Config{Importer: closure(packages)}
info := &types.Info{
Instances: make(map[*ast.Ident]types.Instance),
+ Types: make(map[ast.Expr]types.TypeAndValue),
Uses: make(map[*ast.Ident]types.Object),
Selections: make(map[*ast.SelectorExpr]*types.Selection),
FileVersions: make(map[*ast.File]string),
diff --git a/go/types/typeutil/map.go b/go/types/typeutil/map.go
index 43261147c05..b6d542c64ee 100644
--- a/go/types/typeutil/map.go
+++ b/go/types/typeutil/map.go
@@ -389,8 +389,13 @@ func (hasher) hashTypeName(tname *types.TypeName) uint32 {
// path, and whether or not it is a package-level typename. It
// is rare for a package to define multiple local types with
// the same name.)
- hash := uintptr(unsafe.Pointer(tname))
- return uint32(hash ^ (hash >> 32))
+ ptr := uintptr(unsafe.Pointer(tname))
+ if unsafe.Sizeof(ptr) == 8 {
+ hash := uint64(ptr)
+ return uint32(hash ^ (hash >> 32))
+ } else {
+ return uint32(ptr)
+ }
}
// shallowHash computes a hash of t without looking at any of its
diff --git a/godoc/godoc17_test.go b/godoc/godoc17_test.go
index 82e23e64775..c8bf2d96d42 100644
--- a/godoc/godoc17_test.go
+++ b/godoc/godoc17_test.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build go1.7
-// +build go1.7
package godoc
diff --git a/godoc/index.go b/godoc/index.go
index 05a1a9441ee..853337715c1 100644
--- a/godoc/index.go
+++ b/godoc/index.go
@@ -65,6 +65,7 @@ import (
"golang.org/x/tools/godoc/util"
"golang.org/x/tools/godoc/vfs"
+ "maps"
)
// ----------------------------------------------------------------------------
@@ -862,9 +863,7 @@ func (x *Indexer) indexGoFile(dirname string, filename string, file *token.File,
dest = make(map[string]SpotKind)
x.exports[pkgPath] = dest
}
- for k, v := range x.curPkgExports {
- dest[k] = v
- }
+ maps.Copy(dest, x.curPkgExports)
}
}
@@ -1069,7 +1068,7 @@ func (c *Corpus) NewIndex() *Index {
// convert alist into a map of alternative spellings
alts := make(map[string]*AltWords)
- for i := 0; i < len(alist); i++ {
+ for i := range alist {
a := alist[i].(*AltWords)
alts[a.Canon] = a
}
diff --git a/godoc/snippet.go b/godoc/snippet.go
index 1750478606e..43c1899a093 100644
--- a/godoc/snippet.go
+++ b/godoc/snippet.go
@@ -14,6 +14,7 @@ import (
"fmt"
"go/ast"
"go/token"
+ "slices"
)
type Snippet struct {
@@ -41,10 +42,8 @@ func findSpec(list []ast.Spec, id *ast.Ident) ast.Spec {
return s
}
case *ast.ValueSpec:
- for _, n := range s.Names {
- if n == id {
- return s
- }
+ if slices.Contains(s.Names, id) {
+ return s
}
case *ast.TypeSpec:
if s.Name == id {
diff --git a/godoc/static/gen_test.go b/godoc/static/gen_test.go
index 1f1c62e0e9c..7b7668a558c 100644
--- a/godoc/static/gen_test.go
+++ b/godoc/static/gen_test.go
@@ -39,7 +39,7 @@ to see the differences.`)
// TestAppendQuote ensures that AppendQuote produces a valid literal.
func TestAppendQuote(t *testing.T) {
var in, out bytes.Buffer
- for r := rune(0); r < unicode.MaxRune; r++ {
+ for r := range unicode.MaxRune {
in.WriteRune(r)
}
appendQuote(&out, in.Bytes())
diff --git a/godoc/static/makestatic.go b/godoc/static/makestatic.go
index a8a652f8ed5..5a7337290ff 100644
--- a/godoc/static/makestatic.go
+++ b/godoc/static/makestatic.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build ignore
-// +build ignore
// Command makestatic writes the generated file buffer to "static.go".
// It is intended to be invoked via "go generate" (directive in "gen.go").
diff --git a/godoc/versions_test.go b/godoc/versions_test.go
index a021616ba11..7b822f69b51 100644
--- a/godoc/versions_test.go
+++ b/godoc/versions_test.go
@@ -6,6 +6,7 @@ package godoc
import (
"go/build"
+ "slices"
"testing"
"golang.org/x/tools/internal/testenv"
@@ -102,12 +103,7 @@ func TestParseVersionRow(t *testing.T) {
// hasTag checks whether a given release tag is contained in the current version
// of the go binary.
func hasTag(t string) bool {
- for _, v := range build.Default.ReleaseTags {
- if t == v {
- return true
- }
- }
- return false
+ return slices.Contains(build.Default.ReleaseTags, t)
}
func TestAPIVersion(t *testing.T) {
diff --git a/godoc/vfs/fs.go b/godoc/vfs/fs.go
index f12d653fef2..2bec5886052 100644
--- a/godoc/vfs/fs.go
+++ b/godoc/vfs/fs.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build go1.16
-// +build go1.16
package vfs
diff --git a/godoc/vfs/os.go b/godoc/vfs/os.go
index 35d050946e6..fe21a58662e 100644
--- a/godoc/vfs/os.go
+++ b/godoc/vfs/os.go
@@ -12,6 +12,7 @@ import (
pathpkg "path"
"path/filepath"
"runtime"
+ "slices"
)
// We expose a new variable because otherwise we need to copy the findGOROOT logic again
@@ -45,10 +46,8 @@ type osFS struct {
func isGoPath(path string) bool {
for _, bp := range filepath.SplitList(build.Default.GOPATH) {
- for _, gp := range filepath.SplitList(path) {
- if bp == gp {
- return true
- }
+ if slices.Contains(filepath.SplitList(path), bp) {
+ return true
}
}
return false
diff --git a/godoc/vfs/zipfs/zipfs_test.go b/godoc/vfs/zipfs/zipfs_test.go
index b6f2431b0b5..3e5a8034a5b 100644
--- a/godoc/vfs/zipfs/zipfs_test.go
+++ b/godoc/vfs/zipfs/zipfs_test.go
@@ -59,7 +59,7 @@ func TestMain(t *testing.M) {
os.Exit(t.Run())
}
-// setups state each of the tests uses
+// setup state each of the tests uses
func setup() error {
// create zipfs
b := new(bytes.Buffer)
@@ -172,7 +172,7 @@ func TestZipFSOpenSeek(t *testing.T) {
defer f.Close()
// test Seek() multiple times
- for i := 0; i < 3; i++ {
+ for range 3 {
all, err := io.ReadAll(f)
if err != nil {
t.Error(err)
diff --git a/gopls/doc/analyzers.md b/gopls/doc/analyzers.md
index 68465f9809d..4b2bff1a63a 100644
--- a/gopls/doc/analyzers.md
+++ b/gopls/doc/analyzers.md
@@ -298,7 +298,7 @@ The gofix analyzer inlines functions and constants that are marked for inlining.
Default: on.
-Package documentation: [gofix](https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/gofix)
+Package documentation: [gofix](https://pkg.go.dev/golang.org/x/tools/internal/gofix)
## `hostport`: check format of addresses passed to net.Dial
@@ -476,29 +476,89 @@ Package documentation: [lostcancel](https://pkg.go.dev/golang.org/x/tools/go/ana
This analyzer reports opportunities for simplifying and clarifying
-existing code by using more modern features of Go, such as:
-
- - replacing an if/else conditional assignment by a call to the
- built-in min or max functions added in go1.21;
- - replacing sort.Slice(x, func(i, j int) bool) { return s[i] < s[j] }
- by a call to slices.Sort(s), added in go1.21;
- - replacing interface{} by the 'any' type added in go1.18;
- - replacing append([]T(nil), s...) by slices.Clone(s) or
- slices.Concat(s), added in go1.21;
- - replacing a loop around an m[k]=v map update by a call
- to one of the Collect, Copy, Clone, or Insert functions
- from the maps package, added in go1.21;
- - replacing []byte(fmt.Sprintf...) by fmt.Appendf(nil, ...),
- added in go1.19;
- - replacing uses of context.WithCancel in tests with t.Context, added in
- go1.24;
- - replacing omitempty by omitzero on structs, added in go1.24;
- - replacing append(s[:i], s[i+1]...) by slices.Delete(s, i, i+1),
- added in go1.21
- - replacing a 3-clause for i := 0; i < n; i++ {} loop by
- for i := range n {}, added in go1.22;
- - replacing Split in "for range strings.Split(...)" by go1.24's
- more efficient SplitSeq;
+existing code by using more modern features of Go and its standard
+library.
+
+Each diagnostic provides a fix. Our intent is that these fixes may
+be safely applied en masse without changing the behavior of your
+program. In some cases the suggested fixes are imperfect and may
+lead to (for example) unused imports or unused local variables,
+causing build breakage. However, these problems are generally
+trivial to fix. We regard any modernizer whose fix changes program
+behavior to have a serious bug and will endeavor to fix it.
+
+To apply all modernization fixes en masse, you can use the
+following command:
+
+ $ go run golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@latest -fix -test ./...
+
+If the tool warns of conflicting fixes, you may need to run it more
+than once until it has applied all fixes cleanly. This command is
+not an officially supported interface and may change in the future.
+
+Changes produced by this tool should be reviewed as usual before
+being merged. In some cases, a loop may be replaced by a simple
+function call, causing comments within the loop to be discarded.
+Human judgment may be required to avoid losing comments of value.
+
+Each diagnostic reported by modernize has a specific category. (The
+categories are listed below.) Diagnostics in some categories, such
+as "efaceany" (which replaces "interface{}" with "any" where it is
+safe to do so) are particularly numerous. It may ease the burden of
+code review to apply fixes in two passes, the first change
+consisting only of fixes of category "efaceany", the second
+consisting of all others. This can be achieved using the -category flag:
+
+ $ modernize -category=efaceany -fix -test ./...
+ $ modernize -category=-efaceany -fix -test ./...
+
+Categories of modernize diagnostic:
+
+ - forvar: remove x := x variable declarations made unnecessary by the new semantics of loops in go1.22.
+
+ - slicescontains: replace 'for i, elem := range s { if elem == needle { ...; break }'
+ by a call to slices.Contains, added in go1.21.
+
+ - minmax: replace an if/else conditional assignment by a call to
+ the built-in min or max functions added in go1.21.
+
+ - sortslice: replace sort.Slice(x, func(i, j int) bool) { return s[i] < s[j] }
+ by a call to slices.Sort(s), added in go1.21.
+
+ - efaceany: replace interface{} by the 'any' type added in go1.18.
+
+ - slicesclone: replace append([]T(nil), s...) by slices.Clone(s) or
+ slices.Concat(s), added in go1.21.
+
+ - mapsloop: replace a loop around an m[k]=v map update by a call
+ to one of the Collect, Copy, Clone, or Insert functions from
+ the maps package, added in go1.21.
+
+ - fmtappendf: replace []byte(fmt.Sprintf...) by fmt.Appendf(nil, ...),
+ added in go1.19.
+
+ - testingcontext: replace uses of context.WithCancel in tests
+ with t.Context, added in go1.24.
+
+ - omitzero: replace omitempty by omitzero on structs, added in go1.24.
+
+ - bloop: replace "for i := range b.N" or "for range b.N" in a
+ benchmark with "for b.Loop()", and remove any preceding calls
+ to b.StopTimer, b.StartTimer, and b.ResetTimer.
+
+ - slicesdelete: replace append(s[:i], s[i+1]...) by
+ slices.Delete(s, i, i+1), added in go1.21.
+
+ - rangeint: replace a 3-clause "for i := 0; i < n; i++" loop by
+ "for i := range n", added in go1.22.
+
+ - stringsseq: replace Split in "for range strings.Split(...)" by go1.24's
+ more efficient SplitSeq, or Fields with FieldSeq.
+
+ - stringscutprefix: replace some uses of HasPrefix followed by TrimPrefix with CutPrefix,
+ added to the strings package in go1.20.
+
+ - waitgroup: replace old complex usages of sync.WaitGroup by less complex WaitGroup.Go method in go1.25.
Default: on.
@@ -962,12 +1022,29 @@ A method is considered unused if it is unexported, not referenced
that of any method of an interface type declared within the same
package.
-The tool may report a false positive for a declaration of an
-unexported function that is referenced from another package using
-the go:linkname mechanism, if the declaration's doc comment does
-not also have a go:linkname comment. (Such code is in any case
-strongly discouraged: linkname annotations, if they must be used at
-all, should be used on both the declaration and the alias.)
+The tool may report false positives in some situations, for
+example:
+
+ - For a declaration of an unexported function that is referenced
+ from another package using the go:linkname mechanism, if the
+ declaration's doc comment does not also have a go:linkname
+ comment.
+
+ (Such code is in any case strongly discouraged: linkname
+ annotations, if they must be used at all, should be used on both
+ the declaration and the alias.)
+
+ - For compiler intrinsics in the "runtime" package that, though
+ never referenced, are known to the compiler and are called
+ indirectly by compiled object code.
+
+ - For functions called only from assembly.
+
+ - For functions called only from files whose build tags are not
+ selected in the current build configuration.
+
+See https://github.com/golang/go/issues/71686 for discussion of
+these limitations.
The unusedfunc algorithm is not as precise as the
golang.org/x/tools/cmd/deadcode tool, but it has the advantage that
diff --git a/gopls/doc/assets/go.mod b/gopls/doc/assets/go.mod
index 73f49695726..9b417f19ed8 100644
--- a/gopls/doc/assets/go.mod
+++ b/gopls/doc/assets/go.mod
@@ -4,4 +4,4 @@
module golang.org/x/tools/gopls/doc/assets
-go 1.19
+go 1.23.0
diff --git a/gopls/doc/codelenses.md b/gopls/doc/codelenses.md
index d8aa8e1f479..fa7c6c68859 100644
--- a/gopls/doc/codelenses.md
+++ b/gopls/doc/codelenses.md
@@ -75,6 +75,8 @@ File type: Go
## `run_govulncheck`: Run govulncheck (legacy)
+**This setting is experimental and may be deleted.**
+
This codelens source annotates the `module` directive in a go.mod file
with a command to run Govulncheck asynchronously.
@@ -134,6 +136,8 @@ File type: go.mod
## `vulncheck`: Run govulncheck
+**This setting is experimental and may be deleted.**
+
This codelens source annotates the `module` directive in a go.mod file
with a command to run govulncheck synchronously.
diff --git a/gopls/doc/features/diagnostics.md b/gopls/doc/features/diagnostics.md
index ceec607c123..6be7a43493a 100644
--- a/gopls/doc/features/diagnostics.md
+++ b/gopls/doc/features/diagnostics.md
@@ -51,7 +51,7 @@ build`. Gopls doesn't actually run the compiler; that would be too
There is an optional third source of diagnostics:
-
+
- **Compiler optimization details** are diagnostics that report
details relevant to optimization decisions made by the Go
diff --git a/gopls/doc/features/navigation.md b/gopls/doc/features/navigation.md
index f46f2935683..f3454f7188c 100644
--- a/gopls/doc/features/navigation.md
+++ b/gopls/doc/features/navigation.md
@@ -85,7 +85,10 @@ Client support:
The LSP
[`textDocument/implementation`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_implementation)
-request queries the "implements" relation between interfaces and concrete types:
+request queries the relation between abstract and concrete types and
+their methods.
+
+Interfaces and concrete types are matched using method sets:
- When invoked on a reference to an **interface type**, it returns the
location of the declaration of each type that implements
@@ -111,6 +114,17 @@ types with methods due to embedding) may be missing from the results.
but that is not consistent with the "scalable" gopls design.
-->
+Functions, `func` types, and dynamic function calls are matched using signatures:
+
+- When invoked on the `func` token of a **function definition**,
+ it returns the locations of the matching signature types
+ and dynamic call expressions.
+- When invoked on the `func` token of a **signature type**,
+ it returns the locations of the matching concrete function definitions.
+- When invoked on the `(` token of a **dynamic function call**,
+ it returns the locations of the matching concrete function
+ definitions.
+
If either the target type or the candidate type are generic, the
results will include the candidate type if there is any instantiation
of the two types that would allow one to implement the other.
@@ -120,6 +134,12 @@ types, without regard to consistency of substitutions across the
method set or even within a single method.
This may lead to occasional spurious matches.)
+Since a type may be both a function type and a named type with methods
+(for example, `http.HandlerFunc`), it may participate in both kinds of
+implementation queries (by method-sets and function signatures).
+Queries using method-sets should be invoked on the type or method name,
+and queries using signatures should be invoked on a `func` or `(` token.
+
Client support:
- **VS Code**: Use [Go to Implementations](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-implementation) (`⌘F12`).
- **Emacs + eglot**: Use `M-x eglot-find-implementation`.
diff --git a/gopls/doc/features/transformation.md b/gopls/doc/features/transformation.md
index caf13221cfa..a72ff676832 100644
--- a/gopls/doc/features/transformation.md
+++ b/gopls/doc/features/transformation.md
@@ -814,3 +814,12 @@ which HTML documents are composed:
+
+
+
+### `refactor.rewrite.eliminateDotImport`: Eliminate dot import
+
+When the cursor is on a dot import gopls can offer the "Eliminate dot import"
+code action, which removes the dot from the import and qualifies uses of the
+package throughout the file. This code action is offered only if
+each use of the package can be qualified without collisions with existing names.
diff --git a/gopls/doc/release/v0.18.0.md b/gopls/doc/release/v0.18.0.md
index 8d641a2104f..9aa0f9c9d07 100644
--- a/gopls/doc/release/v0.18.0.md
+++ b/gopls/doc/release/v0.18.0.md
@@ -37,16 +37,22 @@ details to be reported as diagnostics. For example, it indicates which
variables escape to the heap, and which array accesses require bounds
checks.
+TODO: add links to the complete manual for each item.
+
## New `modernize` analyzer
Gopls now reports when code could be simplified or clarified by
using more modern features of Go, and provides a quick fix to apply
the change.
-Examples:
+For example, a conditional assignment using an if/else statement may
+be replaced by a call to the `min` or `max` built-in functions added
+in Go 1.18.
-- replacement of conditional assignment using an if/else statement by
- a call to the `min` or `max` built-in functions added in Go 1.18;
+Use this command to apply modernization fixes en masse:
+```
+$ go run golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@latest -test ./...
+```
## New `unusedfunc` analyzer
@@ -97,6 +103,12 @@ const Ptr = Pointer
```
gopls will suggest replacing `Ptr` in your code with `Pointer`.
+Use this command to apply such fixes en masse:
+
+```
+$ go run golang.org/x/tools/gopls/internal/analysis/gofix/cmd/gofix@latest -test -fix ./...
+```
+
## "Implementations" supports generics
At long last, the "Go to Implementations" feature now fully supports
diff --git a/gopls/doc/release/v0.19.0.md b/gopls/doc/release/v0.19.0.md
new file mode 100644
index 00000000000..f6208417ebc
--- /dev/null
+++ b/gopls/doc/release/v0.19.0.md
@@ -0,0 +1,48 @@
+# Configuration Changes
+
+- The `gopls check` subcommant now accepts a `-severity` flag to set a minimum
+ severity for the diagnostics it reports. By default, the minimum severity
+ is "warning", so `gopls check` may report fewer diagnostics than before. Set
+ `-severity=hint` to reproduce the previous behavior.
+
+# New features
+
+## "Implementations" supports signature types
+
+The Implementations query reports the correspondence between abstract
+and concrete types and their methods based on their method sets.
+Now, it also reports the correspondence between function types,
+dynamic function calls, and function definitions, based on their signatures.
+
+To use it, invoke an Implementations query on the `func` token of the
+definition of a named function, named method, or function literal.
+Gopls reports the set of function signature types that abstract this
+function, and the set of dynamic calls through values of such types.
+
+Conversely, an Implementations query on the `func` token of a
+signature type, or on the `(` paren of a dynamic function call,
+reports the set of concrete functions that the signature abstracts
+or that the call dispatches to.
+
+Since a type may be both a function type and a named type with methods
+(for example, `http.HandlerFunc`), it may participate in both kinds of
+Implements queries (method-sets and function signatures).
+Queries using method-sets should be invoked on the type or method name,
+and queries using signatures should be invoked on a `func` or `(` token.
+
+Only the local (same-package) algorithm is currently supported.
+TODO: implement global.
+
+
+## "Eliminate dot import" code action
+
+This code action, available on a dotted import, will offer to replace
+the import with a regular one and qualify each use of the package
+with its name.
+
+### Auto-complete package clause for new Go files
+
+Gopls now automatically adds the appropriate `package` clause to newly created Go files,
+so that you can immediately get started writing the interesting part.
+
+It requires client support for `workspace/didCreateFiles`
\ No newline at end of file
diff --git a/gopls/doc/settings.md b/gopls/doc/settings.md
index d989b2d19b9..1f4f5746524 100644
--- a/gopls/doc/settings.md
+++ b/gopls/doc/settings.md
@@ -355,6 +355,30 @@ These analyses are documented on
Default: `false`.
+
+### `annotations map[enum]bool`
+
+annotations specifies the various kinds of compiler
+optimization details that should be reported as diagnostics
+when enabled for a package by the "Toggle compiler
+optimization details" (`gopls.gc_details`) command.
+
+(Some users care only about one kind of annotation in their
+profiling efforts. More importantly, in large packages, the
+number of annotations can sometimes overwhelm the user
+interface and exceed the per-file diagnostic limit.)
+
+TODO(adonovan): rename this field to CompilerOptDetail.
+
+Each enum must be one of:
+
+* `"bounds"` controls bounds checking diagnostics.
+* `"escape"` controls diagnostics about escape choices.
+* `"inline"` controls diagnostics about inlining choices.
+* `"nil"` controls nil checks.
+
+Default: `{"bounds":true,"escape":true,"inline":true,"nil":true}`.
+
### `vulncheck enum`
@@ -428,6 +452,9 @@ Must be one of:
* `"FullDocumentation"`
* `"NoDocumentation"`
* `"SingleLine"`
+* `"Structured"` is a misguided experimental setting that returns a JSON
+hover format. This setting should not be used, as it will be removed in a
+future release of gopls.
* `"SynopsisDocumentation"`
Default: `"FullDocumentation"`.
diff --git a/gopls/doc/vim.md b/gopls/doc/vim.md
index e71482115ea..444a7d6ff31 100644
--- a/gopls/doc/vim.md
+++ b/gopls/doc/vim.md
@@ -230,5 +230,5 @@ require('lspconfig').gopls.setup({
[govim-install]: https://github.com/myitcv/govim/blob/master/README.md#govim---go-development-plugin-for-vim8
[nvim-docs]: https://neovim.io/doc/user/lsp.html
[nvim-install]: https://github.com/neovim/neovim/wiki/Installing-Neovim
-[nvim-lspconfig]: https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#gopls
+[nvim-lspconfig]: https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md#gopls
[nvim-lspconfig-imports]: https://github.com/neovim/nvim-lspconfig/issues/115
diff --git a/gopls/go.mod b/gopls/go.mod
index 83620720ae6..c09e2daf7bd 100644
--- a/gopls/go.mod
+++ b/gopls/go.mod
@@ -1,29 +1,27 @@
module golang.org/x/tools/gopls
-// go 1.23.1 fixes some bugs in go/types Alias support (golang/go#68894, golang/go#68905).
-// go 1.23.4 fixes a miscompilation of range-over-func (golang/go#70035).
-go 1.23.4
+go 1.24.2
require (
github.com/google/go-cmp v0.6.0
github.com/jba/templatecheck v0.7.1
- golang.org/x/mod v0.23.0
- golang.org/x/sync v0.11.0
- golang.org/x/sys v0.30.0
- golang.org/x/telemetry v0.0.0-20241220003058-cc96b6e0d3d9
- golang.org/x/text v0.22.0
- golang.org/x/tools v0.28.0
- golang.org/x/vuln v1.1.3
+ golang.org/x/mod v0.24.0
+ golang.org/x/sync v0.13.0
+ golang.org/x/sys v0.32.0
+ golang.org/x/telemetry v0.0.0-20250220152412-165e2f84edbc
+ golang.org/x/text v0.24.0
+ golang.org/x/tools v0.30.0
+ golang.org/x/vuln v1.1.4
gopkg.in/yaml.v3 v3.0.1
- honnef.co/go/tools v0.5.1
+ honnef.co/go/tools v0.6.0
mvdan.cc/gofumpt v0.7.0
- mvdan.cc/xurls/v2 v2.5.0
+ mvdan.cc/xurls/v2 v2.6.0
)
require (
github.com/BurntSushi/toml v1.4.1-0.20240526193622-a339e1f7089c // indirect
github.com/google/safehtml v0.1.0 // indirect
- golang.org/x/exp/typeparams v0.0.0-20241210194714-1829a127f884 // indirect
+ golang.org/x/exp/typeparams v0.0.0-20250218142911-aa4b98e5adaa // indirect
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
)
diff --git a/gopls/go.sum b/gopls/go.sum
index b2b3d925a78..f5a9bbde4ca 100644
--- a/gopls/go.sum
+++ b/gopls/go.sum
@@ -12,50 +12,50 @@ github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
-github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8=
-github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4=
+github.com/rogpeppe/go-internal v1.13.2-0.20241226121412-a5dc8ff20d0a h1:w3tdWGKbLGBPtR/8/oO74W6hmz0qE5q0z9aqSAewaaM=
+github.com/rogpeppe/go-internal v1.13.2-0.20241226121412-a5dc8ff20d0a/go.mod h1:S8kfXMp+yh77OxPD4fdM6YUknrZpQxLhvxzS4gDHENY=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
-golang.org/x/crypto v0.33.0/go.mod h1:bVdXmD7IV/4GdElGPozy6U7lWdRXA4qyRVGJV57uQ5M=
-golang.org/x/exp/typeparams v0.0.0-20241210194714-1829a127f884 h1:1xaZTydL5Gsg78QharTwKfA9FY9CZ1VQj6D/AZEvHR0=
-golang.org/x/exp/typeparams v0.0.0-20241210194714-1829a127f884/go.mod h1:AbB0pIl9nAr9wVwH+Z2ZpaocVmF5I4GyWCDIsVjR0bk=
+golang.org/x/crypto v0.37.0/go.mod h1:vg+k43peMZ0pUMhYmVAWysMK35e6ioLh3wB8ZCAfbVc=
+golang.org/x/exp/typeparams v0.0.0-20250218142911-aa4b98e5adaa h1:Br3+0EZZohShrmVVc85znGpxw7Ca8hsUJlrdT/JQGw8=
+golang.org/x/exp/typeparams v0.0.0-20250218142911-aa4b98e5adaa/go.mod h1:LKZHyeOpPuZcMgxeHjJp4p5yvxrCX1xDvH10zYHhjjQ=
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
-golang.org/x/mod v0.23.0 h1:Zb7khfcRGKk+kqfxFaP5tZqCnDZMjC5VtUBs87Hr6QM=
-golang.org/x/mod v0.23.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
+golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU=
+golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww=
golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
-golang.org/x/net v0.35.0/go.mod h1:EglIi67kWsHKlRzzVMUD93VMSWGFOMSZgxFjparz1Qk=
+golang.org/x/net v0.39.0/go.mod h1:X7NRbYVEA+ewNkCNyJ513WmMdQ3BineSwVtN2zD/d+E=
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
-golang.org/x/sync v0.11.0 h1:GGz8+XQP4FvTTrjZPzNKTMFtSXH80RAzG+5ghFPgK9w=
-golang.org/x/sync v0.11.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/sync v0.13.0 h1:AauUjRAJ9OSnvULf/ARrrVywoJDy0YS2AwQ98I37610=
+golang.org/x/sync v0.13.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc=
-golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
+golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
golang.org/x/telemetry v0.0.0-20240521205824-bda55230c457/go.mod h1:pRgIJT+bRLFKnoM1ldnzKoxTIn14Yxz928LQRYYgIN0=
-golang.org/x/telemetry v0.0.0-20241220003058-cc96b6e0d3d9 h1:L2k9GUV2TpQKVRGMjN94qfUMgUwOFimSQ6gipyJIjKw=
-golang.org/x/telemetry v0.0.0-20241220003058-cc96b6e0d3d9/go.mod h1:8h4Hgq+jcTvCDv2+i7NrfWwpYHcESleo2nGHxLbFLJ4=
+golang.org/x/telemetry v0.0.0-20250220152412-165e2f84edbc h1:HS+G1Mhh2dxM8ObutfYKdjfD7zpkyeP/UxeRnJpIZtQ=
+golang.org/x/telemetry v0.0.0-20250220152412-165e2f84edbc/go.mod h1:bDzXkYUaHzz51CtDy5kh/jR4lgPxsdbqC37kp/dzhCc=
golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
-golang.org/x/term v0.29.0/go.mod h1:6bl4lRlvVuDgSf3179VpIxBF0o10JUpXWOnI7nErv7s=
+golang.org/x/term v0.31.0/go.mod h1:R4BeIy7D95HzImkxGkTW1UQTtP54tio2RyHz7PwK0aw=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
-golang.org/x/text v0.22.0 h1:bofq7m3/HAFvbF51jz3Q9wLg3jkvSPuiZu/pD1XwgtM=
-golang.org/x/text v0.22.0/go.mod h1:YRoo4H8PVmsu+E3Ou7cqLVH8oXWIHVoX0jqUWALQhfY=
-golang.org/x/vuln v1.1.3 h1:NPGnvPOTgnjBc9HTaUx+nj+EaUYxl5SJOWqaDYGaFYw=
-golang.org/x/vuln v1.1.3/go.mod h1:7Le6Fadm5FOqE9C926BCD0g12NWyhg7cxV4BwcPFuNY=
+golang.org/x/text v0.24.0 h1:dd5Bzh4yt5KYA8f9CJHCP4FB4D51c2c6JvN37xJJkJ0=
+golang.org/x/text v0.24.0/go.mod h1:L8rBsPeo2pSS+xqN0d5u2ikmjtmoJbDBT1b7nHvFCdU=
+golang.org/x/vuln v1.1.4 h1:Ju8QsuyhX3Hk8ma3CesTbO8vfJD9EvUBgHvkxHBzj0I=
+golang.org/x/vuln v1.1.4/go.mod h1:F+45wmU18ym/ca5PLTPLsSzr2KppzswxPP603ldA67s=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-honnef.co/go/tools v0.5.1 h1:4bH5o3b5ZULQ4UrBmP+63W9r7qIkqJClEA9ko5YKx+I=
-honnef.co/go/tools v0.5.1/go.mod h1:e9irvo83WDG9/irijV44wr3tbhcFeRnfpVlRqVwpzMs=
+honnef.co/go/tools v0.6.0 h1:TAODvD3knlq75WCp2nyGJtT4LeRV/o7NN9nYPeVJXf8=
+honnef.co/go/tools v0.6.0/go.mod h1:3puzxxljPCe8RGJX7BIy1plGbxEOZni5mR2aXe3/uk4=
mvdan.cc/gofumpt v0.7.0 h1:bg91ttqXmi9y2xawvkuMXyvAA/1ZGJqYAEGjXuP0JXU=
mvdan.cc/gofumpt v0.7.0/go.mod h1:txVFJy/Sc/mvaycET54pV8SW8gWxTlUuGHVEcncmNUo=
-mvdan.cc/xurls/v2 v2.5.0 h1:lyBNOm8Wo71UknhUs4QTFUNNMyxy2JEIaKKo0RWOh+8=
-mvdan.cc/xurls/v2 v2.5.0/go.mod h1:yQgaGQ1rFtJUzkmKiHYSSfuQxqfYmd//X6PxvholpeE=
+mvdan.cc/xurls/v2 v2.6.0 h1:3NTZpeTxYVWNSokW3MKeyVkz/j7uYXYiMtXRUfmjbgI=
+mvdan.cc/xurls/v2 v2.6.0/go.mod h1:bCvEZ1XvdA6wDnxY7jPPjEmigDtvtvPXAD/Exa9IMSk=
diff --git a/gopls/internal/analysis/deprecated/deprecated.go b/gopls/internal/analysis/deprecated/deprecated.go
index c6df00b4f50..400041ba088 100644
--- a/gopls/internal/analysis/deprecated/deprecated.go
+++ b/gopls/internal/analysis/deprecated/deprecated.go
@@ -36,7 +36,7 @@ var Analyzer = &analysis.Analyzer{
}
// checkDeprecated is a simplified copy of staticcheck.CheckDeprecated.
-func checkDeprecated(pass *analysis.Pass) (interface{}, error) {
+func checkDeprecated(pass *analysis.Pass) (any, error) {
inspector := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
deprs, err := collectDeprecatedNames(pass, inspector)
diff --git a/gopls/internal/analysis/embeddirective/embeddirective.go b/gopls/internal/analysis/embeddirective/embeddirective.go
index e623587cc68..7590cba9ad8 100644
--- a/gopls/internal/analysis/embeddirective/embeddirective.go
+++ b/gopls/internal/analysis/embeddirective/embeddirective.go
@@ -28,7 +28,7 @@ var Analyzer = &analysis.Analyzer{
const FixCategory = "addembedimport" // recognized by gopls ApplyFix
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
for _, f := range pass.Files {
comments := embedDirectiveComments(f)
if len(comments) == 0 {
diff --git a/gopls/internal/analysis/fillreturns/fillreturns.go b/gopls/internal/analysis/fillreturns/fillreturns.go
index 8a602dc2eef..a90105f6f56 100644
--- a/gopls/internal/analysis/fillreturns/fillreturns.go
+++ b/gopls/internal/analysis/fillreturns/fillreturns.go
@@ -15,9 +15,12 @@ import (
"strings"
"golang.org/x/tools/go/analysis"
- "golang.org/x/tools/go/ast/astutil"
+ "golang.org/x/tools/go/analysis/passes/inspect"
+ "golang.org/x/tools/go/ast/inspector"
"golang.org/x/tools/gopls/internal/fuzzy"
+ "golang.org/x/tools/gopls/internal/util/moreiters"
"golang.org/x/tools/internal/analysisinternal"
+ "golang.org/x/tools/internal/astutil/cursor"
"golang.org/x/tools/internal/typesinternal"
)
@@ -27,105 +30,38 @@ var doc string
var Analyzer = &analysis.Analyzer{
Name: "fillreturns",
Doc: analysisinternal.MustExtractDoc(doc, "fillreturns"),
+ Requires: []*analysis.Analyzer{inspect.Analyzer},
Run: run,
RunDespiteErrors: true,
URL: "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/fillreturns",
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
+ inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
info := pass.TypesInfo
- if info == nil {
- return nil, fmt.Errorf("nil TypeInfo")
- }
outer:
for _, typeErr := range pass.TypeErrors {
- // Filter out the errors that are not relevant to this analyzer.
- if !FixesError(typeErr) {
- continue
- }
- var file *ast.File
- for _, f := range pass.Files {
- if f.FileStart <= typeErr.Pos && typeErr.Pos <= f.FileEnd {
- file = f
- break
- }
- }
- if file == nil {
- continue
- }
-
- // Get the end position of the error.
- // (This heuristic assumes that the buffer is formatted,
- // at least up to the end position of the error.)
- var buf bytes.Buffer
- if err := format.Node(&buf, pass.Fset, file); err != nil {
- continue
- }
- typeErrEndPos := analysisinternal.TypeErrorEndPos(pass.Fset, buf.Bytes(), typeErr.Pos)
-
- // TODO(rfindley): much of the error handling code below returns, when it
- // should probably continue.
-
- // Get the path for the relevant range.
- path, _ := astutil.PathEnclosingInterval(file, typeErr.Pos, typeErrEndPos)
- if len(path) == 0 {
- return nil, nil
- }
-
- // Find the enclosing return statement.
- var ret *ast.ReturnStmt
- var retIdx int
- for i, n := range path {
- if r, ok := n.(*ast.ReturnStmt); ok {
- ret = r
- retIdx = i
- break
- }
- }
- if ret == nil {
- return nil, nil
- }
-
- // Get the function type that encloses the ReturnStmt.
- var enclosingFunc *ast.FuncType
- for _, n := range path[retIdx+1:] {
- switch node := n.(type) {
- case *ast.FuncLit:
- enclosingFunc = node.Type
- case *ast.FuncDecl:
- enclosingFunc = node.Type
- }
- if enclosingFunc != nil {
- break
- }
+ if !fixesError(typeErr) {
+ continue // irrelevant type error
}
- if enclosingFunc == nil || enclosingFunc.Results == nil {
- continue
+ _, start, end, ok := typesinternal.ErrorCodeStartEnd(typeErr)
+ if !ok {
+ continue // no position information
}
-
- // Skip any generic enclosing functions, since type parameters don't
- // have 0 values.
- // TODO(rfindley): We should be able to handle this if the return
- // values are all concrete types.
- if tparams := enclosingFunc.TypeParams; tparams != nil && tparams.NumFields() > 0 {
- return nil, nil
+ curErr, ok := cursor.Root(inspect).FindPos(start, end)
+ if !ok {
+ continue // can't find node
}
- // Find the function declaration that encloses the ReturnStmt.
- var outer *ast.FuncDecl
- for _, p := range path {
- if p, ok := p.(*ast.FuncDecl); ok {
- outer = p
- break
- }
- }
- if outer == nil {
- return nil, nil
+ // Find cursor for enclosing return statement (which may be curErr itself).
+ curRet, ok := moreiters.First(curErr.Enclosing((*ast.ReturnStmt)(nil)))
+ if !ok {
+ continue // no enclosing return
}
+ ret := curRet.Node().(*ast.ReturnStmt)
- // Skip any return statements that contain function calls with multiple
- // return values.
+ // Skip if any return argument is a tuple-valued function call.
for _, expr := range ret.Results {
e, ok := expr.(*ast.CallExpr)
if !ok {
@@ -136,24 +72,47 @@ outer:
}
}
+ // Get type of innermost enclosing function.
+ var funcType *ast.FuncType
+ curFunc, _ := enclosingFunc(curRet) // can't fail
+ switch fn := curFunc.Node().(type) {
+ case *ast.FuncLit:
+ funcType = fn.Type
+ case *ast.FuncDecl:
+ funcType = fn.Type
+
+ // Skip generic functions since type parameters don't have zero values.
+ // TODO(rfindley): We should be able to handle this if the return
+ // values are all concrete types.
+ if funcType.TypeParams.NumFields() > 0 {
+ continue
+ }
+ }
+ if funcType.Results == nil {
+ continue
+ }
+
// Duplicate the return values to track which values have been matched.
remaining := make([]ast.Expr, len(ret.Results))
copy(remaining, ret.Results)
- fixed := make([]ast.Expr, len(enclosingFunc.Results.List))
+ fixed := make([]ast.Expr, len(funcType.Results.List))
// For each value in the return function declaration, find the leftmost element
// in the return statement that has the desired type. If no such element exists,
// fill in the missing value with the appropriate "zero" value.
// Beware that type information may be incomplete.
var retTyps []types.Type
- for _, ret := range enclosingFunc.Results.List {
+ for _, ret := range funcType.Results.List {
retTyp := info.TypeOf(ret.Type)
if retTyp == nil {
return nil, nil
}
retTyps = append(retTyps, retTyp)
}
+
+ curFile, _ := moreiters.First(curRet.Enclosing((*ast.File)(nil)))
+ file := curFile.Node().(*ast.File)
matches := analysisinternal.MatchingIdents(retTyps, file, ret.Pos(), info, pass.Pkg)
qual := typesinternal.FileQualifier(file, pass.Pkg)
for i, retTyp := range retTyps {
@@ -215,8 +174,8 @@ outer:
}
pass.Report(analysis.Diagnostic{
- Pos: typeErr.Pos,
- End: typeErrEndPos,
+ Pos: start,
+ End: end,
Message: typeErr.Msg,
SuggestedFixes: []analysis.SuggestedFix{{
Message: "Fill in return values",
@@ -255,7 +214,7 @@ var wrongReturnNumRegexes = []*regexp.Regexp{
regexp.MustCompile(`not enough return values`),
}
-func FixesError(err types.Error) bool {
+func fixesError(err types.Error) bool {
msg := strings.TrimSpace(err.Msg)
for _, rx := range wrongReturnNumRegexes {
if rx.MatchString(msg) {
@@ -264,3 +223,9 @@ func FixesError(err types.Error) bool {
}
return false
}
+
+// enclosingFunc returns the cursor for the innermost Func{Decl,Lit}
+// that encloses c, if any.
+func enclosingFunc(c cursor.Cursor) (cursor.Cursor, bool) {
+ return moreiters.First(c.Enclosing((*ast.FuncDecl)(nil), (*ast.FuncLit)(nil)))
+}
diff --git a/gopls/internal/analysis/fillstruct/fillstruct.go b/gopls/internal/analysis/fillstruct/fillstruct.go
index a8a861f0651..62f7d77f58e 100644
--- a/gopls/internal/analysis/fillstruct/fillstruct.go
+++ b/gopls/internal/analysis/fillstruct/fillstruct.go
@@ -25,6 +25,8 @@ import (
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/ast/astutil"
+ "golang.org/x/tools/gopls/internal/cache"
+ "golang.org/x/tools/gopls/internal/cache/parsego"
"golang.org/x/tools/gopls/internal/fuzzy"
"golang.org/x/tools/gopls/internal/util/safetoken"
"golang.org/x/tools/internal/analysisinternal"
@@ -129,15 +131,15 @@ const FixCategory = "fillstruct" // recognized by gopls ApplyFix
// SuggestedFix computes the suggested fix for the kinds of
// diagnostics produced by the Analyzer above.
-func SuggestedFix(fset *token.FileSet, start, end token.Pos, content []byte, file *ast.File, pkg *types.Package, info *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
- if info == nil {
- return nil, nil, fmt.Errorf("nil types.Info")
- }
-
- pos := start // don't use the end
-
- // TODO(rstambler): Using ast.Inspect would probably be more efficient than
- // calling PathEnclosingInterval. Switch this approach.
+func SuggestedFix(cpkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
+ var (
+ fset = cpkg.FileSet()
+ pkg = cpkg.Types()
+ info = cpkg.TypesInfo()
+ pos = start // don't use end
+ )
+ // TODO(adonovan): simplify, using Cursor.
+ file := pgf.Cursor.Node().(*ast.File)
path, _ := astutil.PathEnclosingInterval(file, pos, pos)
if len(path) == 0 {
return nil, nil, fmt.Errorf("no enclosing ast.Node")
@@ -234,7 +236,7 @@ func SuggestedFix(fset *token.FileSet, start, end token.Pos, content []byte, fil
}
// Find the line on which the composite literal is declared.
- split := bytes.Split(content, []byte("\n"))
+ split := bytes.Split(pgf.Src, []byte("\n"))
lineNumber := safetoken.StartPosition(fset, expr.Lbrace).Line
firstLine := split[lineNumber-1] // lines are 1-indexed
diff --git a/gopls/internal/analysis/gofix/directive.go b/gopls/internal/analysis/gofix/directive.go
deleted file mode 100644
index 796feb5189e..00000000000
--- a/gopls/internal/analysis/gofix/directive.go
+++ /dev/null
@@ -1,95 +0,0 @@
-// Copyright 2024 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 gofix
-
-import (
- "go/ast"
- "go/token"
- "strings"
-)
-
-// -- plundered from the future (CL 605517, issue #68021) --
-
-// TODO(adonovan): replace with ast.Directive after go1.24 (#68021).
-// Beware of our local mods to handle analysistest
-// "want" comments on the same line.
-
-// A directive is a comment line with special meaning to the Go
-// toolchain or another tool. It has the form:
-//
-// //tool:name args
-//
-// The "tool:" portion is missing for the three directives named
-// line, extern, and export.
-//
-// See https://go.dev/doc/comment#Syntax for details of Go comment
-// syntax and https://pkg.go.dev/cmd/compile#hdr-Compiler_Directives
-// for details of directives used by the Go compiler.
-type directive struct {
- Pos token.Pos // of preceding "//"
- Tool string
- Name string
- Args string // may contain internal spaces
-}
-
-// directives returns the directives within the comment.
-func directives(g *ast.CommentGroup) (res []*directive) {
- if g != nil {
- // Avoid (*ast.CommentGroup).Text() as it swallows directives.
- for _, c := range g.List {
- if len(c.Text) > 2 &&
- c.Text[1] == '/' &&
- c.Text[2] != ' ' &&
- isDirective(c.Text[2:]) {
-
- tool, nameargs, ok := strings.Cut(c.Text[2:], ":")
- if !ok {
- // Must be one of {line,extern,export}.
- tool, nameargs = "", tool
- }
- name, args, _ := strings.Cut(nameargs, " ") // tab??
- // Permit an additional line comment after the args, chiefly to support
- // [golang.org/x/tools/go/analysis/analysistest].
- args, _, _ = strings.Cut(args, "//")
- res = append(res, &directive{
- Pos: c.Slash,
- Tool: tool,
- Name: name,
- Args: strings.TrimSpace(args),
- })
- }
- }
- }
- return
-}
-
-// isDirective reports whether c is a comment directive.
-// This code is also in go/printer.
-func isDirective(c string) bool {
- // "//line " is a line directive.
- // "//extern " is for gccgo.
- // "//export " is for cgo.
- // (The // has been removed.)
- if strings.HasPrefix(c, "line ") || strings.HasPrefix(c, "extern ") || strings.HasPrefix(c, "export ") {
- return true
- }
-
- // "//[a-z0-9]+:[a-z0-9]"
- // (The // has been removed.)
- colon := strings.Index(c, ":")
- if colon <= 0 || colon+1 >= len(c) {
- return false
- }
- for i := 0; i <= colon+1; i++ {
- if i == colon {
- continue
- }
- b := c[i]
- if !('a' <= b && b <= 'z' || '0' <= b && b <= '9') {
- return false
- }
- }
- return true
-}
diff --git a/gopls/internal/analysis/gofix/gofix.go b/gopls/internal/analysis/gofix/gofix.go
deleted file mode 100644
index 101924366d6..00000000000
--- a/gopls/internal/analysis/gofix/gofix.go
+++ /dev/null
@@ -1,341 +0,0 @@
-// Copyright 2023 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 gofix
-
-import (
- "fmt"
- "go/ast"
- "go/token"
- "go/types"
-
- _ "embed"
-
- "golang.org/x/tools/go/analysis"
- "golang.org/x/tools/go/analysis/passes/inspect"
- "golang.org/x/tools/go/ast/inspector"
- "golang.org/x/tools/go/types/typeutil"
- "golang.org/x/tools/gopls/internal/util/moreiters"
- "golang.org/x/tools/internal/analysisinternal"
- "golang.org/x/tools/internal/astutil/cursor"
- "golang.org/x/tools/internal/astutil/edge"
- "golang.org/x/tools/internal/diff"
- "golang.org/x/tools/internal/refactor/inline"
- "golang.org/x/tools/internal/typesinternal"
-)
-
-//go:embed doc.go
-var doc string
-
-var Analyzer = &analysis.Analyzer{
- Name: "gofix",
- Doc: analysisinternal.MustExtractDoc(doc, "gofix"),
- URL: "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/gofix",
- Run: run,
- FactTypes: []analysis.Fact{new(goFixInlineFuncFact), new(goFixInlineConstFact)},
- Requires: []*analysis.Analyzer{inspect.Analyzer},
-}
-
-func run(pass *analysis.Pass) (any, error) {
- // Memoize repeated calls for same file.
- fileContent := make(map[string][]byte)
- readFile := func(node ast.Node) ([]byte, error) {
- filename := pass.Fset.File(node.Pos()).Name()
- content, ok := fileContent[filename]
- if !ok {
- var err error
- content, err = pass.ReadFile(filename)
- if err != nil {
- return nil, err
- }
- fileContent[filename] = content
- }
- return content, nil
- }
-
- // Return the unique ast.File for a cursor.
- currentFile := func(c cursor.Cursor) *ast.File {
- cf, _ := moreiters.First(c.Ancestors((*ast.File)(nil)))
- return cf.Node().(*ast.File)
- }
-
- // Pass 1: find functions and constants annotated with an appropriate "//go:fix"
- // comment (the syntax proposed by #32816),
- // and export a fact for each one.
- inlinableFuncs := make(map[*types.Func]*inline.Callee) // memoization of fact import (nil => no fact)
- inlinableConsts := make(map[*types.Const]*goFixInlineConstFact)
-
- inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
- nodeFilter := []ast.Node{(*ast.FuncDecl)(nil), (*ast.GenDecl)(nil)}
- inspect.Preorder(nodeFilter, func(n ast.Node) {
- switch decl := n.(type) {
- case *ast.FuncDecl:
- if !hasFixInline(decl.Doc) {
- return
- }
- content, err := readFile(decl)
- if err != nil {
- pass.Reportf(decl.Doc.Pos(), "invalid inlining candidate: cannot read source file: %v", err)
- return
- }
- callee, err := inline.AnalyzeCallee(discard, pass.Fset, pass.Pkg, pass.TypesInfo, decl, content)
- if err != nil {
- pass.Reportf(decl.Doc.Pos(), "invalid inlining candidate: %v", err)
- return
- }
- fn := pass.TypesInfo.Defs[decl.Name].(*types.Func)
- pass.ExportObjectFact(fn, &goFixInlineFuncFact{callee})
- inlinableFuncs[fn] = callee
-
- case *ast.GenDecl:
- if decl.Tok != token.CONST {
- return
- }
- declInline := hasFixInline(decl.Doc)
- // Accept inline directives on the entire decl as well as individual specs.
- for _, spec := range decl.Specs {
- spec := spec.(*ast.ValueSpec) // guaranteed by Tok == CONST
- specInline := hasFixInline(spec.Doc)
- if declInline || specInline {
- for i, name := range spec.Names {
- if i >= len(spec.Values) {
- // Possible following an iota.
- break
- }
- val := spec.Values[i]
- var rhsID *ast.Ident
- switch e := val.(type) {
- case *ast.Ident:
- // Constants defined with the predeclared iota cannot be inlined.
- if pass.TypesInfo.Uses[e] == builtinIota {
- pass.Reportf(val.Pos(), "invalid //go:fix inline directive: const value is iota")
- continue
- }
- rhsID = e
- case *ast.SelectorExpr:
- rhsID = e.Sel
- default:
- pass.Reportf(val.Pos(), "invalid //go:fix inline directive: const value is not the name of another constant")
- continue
- }
- lhs := pass.TypesInfo.Defs[name].(*types.Const)
- rhs := pass.TypesInfo.Uses[rhsID].(*types.Const) // must be so in a well-typed program
- con := &goFixInlineConstFact{
- RHSName: rhs.Name(),
- RHSPkgName: rhs.Pkg().Name(),
- RHSPkgPath: rhs.Pkg().Path(),
- }
- if rhs.Pkg() == pass.Pkg {
- con.rhsObj = rhs
- }
- inlinableConsts[lhs] = con
- // Create a fact only if the LHS is exported and defined at top level.
- // We create a fact even if the RHS is non-exported,
- // so we can warn uses in other packages.
- if lhs.Exported() && typesinternal.IsPackageLevel(lhs) {
- pass.ExportObjectFact(lhs, con)
- }
- }
- }
- }
- }
- })
-
- // Pass 2. Inline each static call to an inlinable function
- // and each reference to an inlinable constant.
- //
- // TODO(adonovan): handle multiple diffs that each add the same import.
- for cur := range cursor.Root(inspect).Preorder((*ast.CallExpr)(nil), (*ast.Ident)(nil)) {
- n := cur.Node()
- switch n := n.(type) {
- case *ast.CallExpr:
- call := n
- if fn := typeutil.StaticCallee(pass.TypesInfo, call); fn != nil {
- // Inlinable?
- callee, ok := inlinableFuncs[fn]
- if !ok {
- var fact goFixInlineFuncFact
- if pass.ImportObjectFact(fn, &fact) {
- callee = fact.Callee
- inlinableFuncs[fn] = callee
- }
- }
- if callee == nil {
- continue // nope
- }
-
- // Inline the call.
- content, err := readFile(call)
- if err != nil {
- pass.Reportf(call.Lparen, "invalid inlining candidate: cannot read source file: %v", err)
- continue
- }
- curFile := currentFile(cur)
- caller := &inline.Caller{
- Fset: pass.Fset,
- Types: pass.Pkg,
- Info: pass.TypesInfo,
- File: curFile,
- Call: call,
- Content: content,
- }
- res, err := inline.Inline(caller, callee, &inline.Options{Logf: discard})
- if err != nil {
- pass.Reportf(call.Lparen, "%v", err)
- continue
- }
- if res.Literalized {
- // Users are not fond of inlinings that literalize
- // f(x) to func() { ... }(), so avoid them.
- //
- // (Unfortunately the inliner is very timid,
- // and often literalizes when it cannot prove that
- // reducing the call is safe; the user of this tool
- // has no indication of what the problem is.)
- continue
- }
- got := res.Content
-
- // Suggest the "fix".
- var textEdits []analysis.TextEdit
- for _, edit := range diff.Bytes(content, got) {
- textEdits = append(textEdits, analysis.TextEdit{
- Pos: curFile.FileStart + token.Pos(edit.Start),
- End: curFile.FileStart + token.Pos(edit.End),
- NewText: []byte(edit.New),
- })
- }
- pass.Report(analysis.Diagnostic{
- Pos: call.Pos(),
- End: call.End(),
- Message: fmt.Sprintf("Call of %v should be inlined", callee),
- SuggestedFixes: []analysis.SuggestedFix{{
- Message: fmt.Sprintf("Inline call of %v", callee),
- TextEdits: textEdits,
- }},
- })
- }
-
- case *ast.Ident:
- // If the identifier is a use of an inlinable constant, suggest inlining it.
- if con, ok := pass.TypesInfo.Uses[n].(*types.Const); ok {
- fcon, ok := inlinableConsts[con]
- if !ok {
- var fact goFixInlineConstFact
- if pass.ImportObjectFact(con, &fact) {
- fcon = &fact
- inlinableConsts[con] = fcon
- }
- }
- if fcon == nil {
- continue // nope
- }
-
- // If n is qualified by a package identifier, we'll need the full selector expression.
- var sel *ast.SelectorExpr
- if e, _ := cur.Edge(); e == edge.SelectorExpr_Sel {
- sel = cur.Parent().Node().(*ast.SelectorExpr)
- }
- curFile := currentFile(cur)
-
- // We have an identifier A here (n), possibly qualified by a package identifier (sel.X),
- // and an inlinable "const A = B" elsewhere (fcon).
- // Consider replacing A with B.
-
- // Check that the expression we are inlining (B) means the same thing
- // (refers to the same object) in n's scope as it does in A's scope.
- // If the RHS is not in the current package, AddImport will handle
- // shadowing, so we only need to worry about when both expressions
- // are in the current package.
- if pass.Pkg.Path() == fcon.RHSPkgPath {
- // fcon.rhsObj is the object referred to by B in the definition of A.
- scope := pass.TypesInfo.Scopes[curFile].Innermost(n.Pos()) // n's scope
- _, obj := scope.LookupParent(fcon.RHSName, n.Pos()) // what "B" means in n's scope
- if obj == nil {
- // Should be impossible: if code at n can refer to the LHS,
- // it can refer to the RHS.
- panic(fmt.Sprintf("no object for inlinable const %s RHS %s", n.Name, fcon.RHSName))
- }
- if obj != fcon.rhsObj {
- // "B" means something different here than at the inlinable const's scope.
- continue
- }
- }
- var (
- importPrefix string
- edits []analysis.TextEdit
- )
- if fcon.RHSPkgPath != pass.Pkg.Path() {
- _, importPrefix, edits = analysisinternal.AddImport(
- pass.TypesInfo, curFile, fcon.RHSPkgName, fcon.RHSPkgPath, fcon.RHSName, n.Pos())
- }
- var (
- pos = n.Pos()
- end = n.End()
- name = n.Name
- )
- // Replace the entire SelectorExpr if there is one.
- if sel != nil {
- pos = sel.Pos()
- end = sel.End()
- name = sel.X.(*ast.Ident).Name + "." + n.Name
- }
- edits = append(edits, analysis.TextEdit{
- Pos: pos,
- End: end,
- NewText: []byte(importPrefix + fcon.RHSName),
- })
- pass.Report(analysis.Diagnostic{
- Pos: pos,
- End: end,
- Message: fmt.Sprintf("Constant %s should be inlined", name),
- SuggestedFixes: []analysis.SuggestedFix{{
- Message: fmt.Sprintf("Inline constant %s", name),
- TextEdits: edits,
- }},
- })
- }
- }
- }
-
- return nil, nil
-}
-
-// hasFixInline reports the presence of a "//go:fix inline" directive
-// in the comments.
-func hasFixInline(cg *ast.CommentGroup) bool {
- for _, d := range directives(cg) {
- if d.Tool == "go" && d.Name == "fix" && d.Args == "inline" {
- return true
- }
- }
- return false
-}
-
-// A goFixInlineFuncFact is exported for each function marked "//go:fix inline".
-// It holds information about the callee to support inlining.
-type goFixInlineFuncFact struct{ Callee *inline.Callee }
-
-func (f *goFixInlineFuncFact) String() string { return "goFixInline " + f.Callee.String() }
-func (*goFixInlineFuncFact) AFact() {}
-
-// A goFixInlineConstFact is exported for each constant marked "//go:fix inline".
-// It holds information about an inlinable constant. Gob-serializable.
-type goFixInlineConstFact struct {
- // Information about "const LHSName = RHSName".
- RHSName string
- RHSPkgPath string
- RHSPkgName string
- rhsObj types.Object // for current package
-}
-
-func (c *goFixInlineConstFact) String() string {
- return fmt.Sprintf("goFixInline const %q.%s", c.RHSPkgPath, c.RHSName)
-}
-
-func (*goFixInlineConstFact) AFact() {}
-
-func discard(string, ...any) {}
-
-var builtinIota = types.Universe.Lookup("iota")
diff --git a/gopls/internal/analysis/gofix/gofix_test.go b/gopls/internal/analysis/gofix/gofix_test.go
deleted file mode 100644
index 32bd87b6cd2..00000000000
--- a/gopls/internal/analysis/gofix/gofix_test.go
+++ /dev/null
@@ -1,16 +0,0 @@
-// Copyright 2018 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 gofix_test
-
-import (
- "testing"
-
- "golang.org/x/tools/go/analysis/analysistest"
- "golang.org/x/tools/gopls/internal/analysis/gofix"
-)
-
-func TestAnalyzer(t *testing.T) {
- analysistest.RunWithSuggestedFixes(t, analysistest.TestData(), gofix.Analyzer, "a", "b")
-}
diff --git a/gopls/internal/analysis/gofix/testdata/src/a/a.go b/gopls/internal/analysis/gofix/testdata/src/a/a.go
deleted file mode 100644
index ae486746e5b..00000000000
--- a/gopls/internal/analysis/gofix/testdata/src/a/a.go
+++ /dev/null
@@ -1,98 +0,0 @@
-package a
-
-// Functions.
-
-func f() {
- One() // want `Call of a.One should be inlined`
-
- new(T).Two() // want `Call of \(a.T\).Two should be inlined`
-}
-
-type T struct{}
-
-//go:fix inline
-func One() int { return one } // want One:`goFixInline a.One`
-
-const one = 1
-
-//go:fix inline
-func (T) Two() int { return 2 } // want Two:`goFixInline \(a.T\).Two`
-
-// Constants.
-
-const Uno = 1
-
-//go:fix inline
-const In1 = Uno // want In1: `goFixInline const "a".Uno`
-
-const (
- no1 = one
-
- //go:fix inline
- In2 = one // want In2: `goFixInline const "a".one`
-)
-
-//go:fix inline
-const (
- in3 = one
- in4 = one
- bad1 = 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
-)
-
-//go:fix inline
-const in5,
- in6,
- bad2 = one, one,
- one + 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
-
-// Make sure we don't crash on iota consts, but still process the whole decl.
-//
-//go:fix inline
-const (
- a = iota // want `invalid //go:fix inline directive: const value is iota`
- b
- in7 = one
-)
-
-func _() {
- x := In1 // want `Constant In1 should be inlined`
- x = In2 // want `Constant In2 should be inlined`
- x = in3 // want `Constant in3 should be inlined`
- x = in4 // want `Constant in4 should be inlined`
- x = in5 // want `Constant in5 should be inlined`
- x = in6 // want `Constant in6 should be inlined`
- x = in7 // want `Constant in7 should be inlined`
- x = no1
- _ = x
-
- in1 := 1 // don't inline lvalues
- _ = in1
-}
-
-const (
- x = 1
- //go:fix inline
- in8 = x
-)
-
-func shadow() {
- var x int // shadows x at package scope
-
- //go:fix inline
- const a = iota // want `invalid //go:fix inline directive: const value is iota`
-
- const iota = 2
- // Below this point, iota is an ordinary constant.
-
- //go:fix inline
- const b = iota
-
- x = a // a is defined with the predeclared iota, so it cannot be inlined
- x = b // want `Constant b should be inlined`
-
- // Don't offer to inline in8, because the result, "x", would mean something different
- // in this scope than it does in the scope where in8 is defined.
- x = in8
-
- _ = x
-}
diff --git a/gopls/internal/analysis/gofix/testdata/src/a/a.go.golden b/gopls/internal/analysis/gofix/testdata/src/a/a.go.golden
deleted file mode 100644
index 7d75a598fb7..00000000000
--- a/gopls/internal/analysis/gofix/testdata/src/a/a.go.golden
+++ /dev/null
@@ -1,98 +0,0 @@
-package a
-
-// Functions.
-
-func f() {
- _ = one // want `Call of a.One should be inlined`
-
- _ = 2 // want `Call of \(a.T\).Two should be inlined`
-}
-
-type T struct{}
-
-//go:fix inline
-func One() int { return one } // want One:`goFixInline a.One`
-
-const one = 1
-
-//go:fix inline
-func (T) Two() int { return 2 } // want Two:`goFixInline \(a.T\).Two`
-
-// Constants.
-
-const Uno = 1
-
-//go:fix inline
-const In1 = Uno // want In1: `goFixInline const "a".Uno`
-
-const (
- no1 = one
-
- //go:fix inline
- In2 = one // want In2: `goFixInline const "a".one`
-)
-
-//go:fix inline
-const (
- in3 = one
- in4 = one
- bad1 = 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
-)
-
-//go:fix inline
-const in5,
- in6,
- bad2 = one, one,
- one + 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
-
-// Make sure we don't crash on iota consts, but still process the whole decl.
-//
-//go:fix inline
-const (
- a = iota // want `invalid //go:fix inline directive: const value is iota`
- b
- in7 = one
-)
-
-func _() {
- x := Uno // want `Constant In1 should be inlined`
- x = one // want `Constant In2 should be inlined`
- x = one // want `Constant in3 should be inlined`
- x = one // want `Constant in4 should be inlined`
- x = one // want `Constant in5 should be inlined`
- x = one // want `Constant in6 should be inlined`
- x = one // want `Constant in7 should be inlined`
- x = no1
- _ = x
-
- in1 := 1 // don't inline lvalues
- _ = in1
-}
-
-const (
- x = 1
- //go:fix inline
- in8 = x
-)
-
-func shadow() {
- var x int // shadows x at package scope
-
- //go:fix inline
- const a = iota // want `invalid //go:fix inline directive: const value is iota`
-
- const iota = 2
- // Below this point, iota is an ordinary constant.
-
- //go:fix inline
- const b = iota
-
- x = a // a is defined with the predeclared iota, so it cannot be inlined
- x = iota // want `Constant b should be inlined`
-
- // Don't offer to inline in8, because the result, "x", would mean something different
- // in this scope than it does in the scope where in8 is defined.
- x = in8
-
- _ = x
-}
diff --git a/gopls/internal/analysis/hostport/hostport.go b/gopls/internal/analysis/hostport/hostport.go
index a7030ae116f..d95e475d1bf 100644
--- a/gopls/internal/analysis/hostport/hostport.go
+++ b/gopls/internal/analysis/hostport/hostport.go
@@ -14,11 +14,10 @@ import (
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/inspect"
- "golang.org/x/tools/go/ast/inspector"
"golang.org/x/tools/go/types/typeutil"
"golang.org/x/tools/gopls/internal/util/safetoken"
- "golang.org/x/tools/internal/analysisinternal"
- "golang.org/x/tools/internal/astutil/cursor"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
)
const Doc = `check format of addresses passed to net.Dial
@@ -44,20 +43,20 @@ var Analyzer = &analysis.Analyzer{
Name: "hostport",
Doc: Doc,
URL: "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/hostport",
- Requires: []*analysis.Analyzer{inspect.Analyzer},
+ Requires: []*analysis.Analyzer{inspect.Analyzer, typeindexanalyzer.Analyzer},
Run: run,
}
func run(pass *analysis.Pass) (any, error) {
- // Fast path: if the package doesn't import net and fmt, skip
- // the traversal.
- if !analysisinternal.Imports(pass.Pkg, "net") ||
- !analysisinternal.Imports(pass.Pkg, "fmt") {
- return nil, nil
+ var (
+ index = pass.ResultOf[typeindexanalyzer.Analyzer].(*typeindex.Index)
+ info = pass.TypesInfo
+ fmtSprintf = index.Object("fmt", "Sprintf")
+ )
+ if !index.Used(fmtSprintf) {
+ return nil, nil // fast path: package doesn't use fmt.Sprintf
}
- info := pass.TypesInfo
-
// checkAddr reports a diagnostic (and returns true) if e
// is a call of the form fmt.Sprintf("%d:%d", ...).
// The diagnostic includes a fix.
@@ -65,96 +64,94 @@ func run(pass *analysis.Pass) (any, error) {
// dialCall is non-nil if the Dial call is non-local
// but within the same file.
checkAddr := func(e ast.Expr, dialCall *ast.CallExpr) {
- if call, ok := e.(*ast.CallExpr); ok {
- obj := typeutil.Callee(info, call)
- if analysisinternal.IsFunctionNamed(obj, "fmt", "Sprintf") {
- // Examine format string.
- formatArg := call.Args[0]
- if tv := info.Types[formatArg]; tv.Value != nil {
- numericPort := false
- format := constant.StringVal(tv.Value)
- switch format {
- case "%s:%d":
- // Have: fmt.Sprintf("%s:%d", host, port)
- numericPort = true
-
- case "%s:%s":
- // Have: fmt.Sprintf("%s:%s", host, portStr)
- // Keep port string as is.
-
- default:
- return
- }
+ if call, ok := e.(*ast.CallExpr); ok && typeutil.Callee(info, call) == fmtSprintf {
+ // Examine format string.
+ formatArg := call.Args[0]
+ if tv := info.Types[formatArg]; tv.Value != nil {
+ numericPort := false
+ format := constant.StringVal(tv.Value)
+ switch format {
+ case "%s:%d":
+ // Have: fmt.Sprintf("%s:%d", host, port)
+ numericPort = true
+
+ case "%s:%s":
+ // Have: fmt.Sprintf("%s:%s", host, portStr)
+ // Keep port string as is.
+
+ default:
+ return
+ }
- // Use granular edits to preserve original formatting.
- edits := []analysis.TextEdit{
- {
- // Replace fmt.Sprintf with net.JoinHostPort.
- Pos: call.Fun.Pos(),
- End: call.Fun.End(),
- NewText: []byte("net.JoinHostPort"),
- },
- {
- // Delete format string.
- Pos: formatArg.Pos(),
- End: call.Args[1].Pos(),
- },
- }
+ // Use granular edits to preserve original formatting.
+ edits := []analysis.TextEdit{
+ {
+ // Replace fmt.Sprintf with net.JoinHostPort.
+ Pos: call.Fun.Pos(),
+ End: call.Fun.End(),
+ NewText: []byte("net.JoinHostPort"),
+ },
+ {
+ // Delete format string.
+ Pos: formatArg.Pos(),
+ End: call.Args[1].Pos(),
+ },
+ }
- // Turn numeric port into a string.
- if numericPort {
- // port => fmt.Sprintf("%d", port)
- // 123 => "123"
- port := call.Args[2]
- newPort := fmt.Sprintf(`fmt.Sprintf("%%d", %s)`, port)
- if port := info.Types[port].Value; port != nil {
- if i, ok := constant.Int64Val(port); ok {
- newPort = fmt.Sprintf(`"%d"`, i) // numeric constant
- }
+ // Turn numeric port into a string.
+ if numericPort {
+ // port => fmt.Sprintf("%d", port)
+ // 123 => "123"
+ port := call.Args[2]
+ newPort := fmt.Sprintf(`fmt.Sprintf("%%d", %s)`, port)
+ if port := info.Types[port].Value; port != nil {
+ if i, ok := constant.Int64Val(port); ok {
+ newPort = fmt.Sprintf(`"%d"`, i) // numeric constant
}
-
- edits = append(edits, analysis.TextEdit{
- Pos: port.Pos(),
- End: port.End(),
- NewText: []byte(newPort),
- })
- }
-
- // Refer to Dial call, if not adjacent.
- suffix := ""
- if dialCall != nil {
- suffix = fmt.Sprintf(" (passed to net.Dial at L%d)",
- safetoken.StartPosition(pass.Fset, dialCall.Pos()).Line)
}
- pass.Report(analysis.Diagnostic{
- // Highlight the format string.
- Pos: formatArg.Pos(),
- End: formatArg.End(),
- Message: fmt.Sprintf("address format %q does not work with IPv6%s", format, suffix),
- SuggestedFixes: []analysis.SuggestedFix{{
- Message: "Replace fmt.Sprintf with net.JoinHostPort",
- TextEdits: edits,
- }},
+ edits = append(edits, analysis.TextEdit{
+ Pos: port.Pos(),
+ End: port.End(),
+ NewText: []byte(newPort),
})
}
+
+ // Refer to Dial call, if not adjacent.
+ suffix := ""
+ if dialCall != nil {
+ suffix = fmt.Sprintf(" (passed to net.Dial at L%d)",
+ safetoken.StartPosition(pass.Fset, dialCall.Pos()).Line)
+ }
+
+ pass.Report(analysis.Diagnostic{
+ // Highlight the format string.
+ Pos: formatArg.Pos(),
+ End: formatArg.End(),
+ Message: fmt.Sprintf("address format %q does not work with IPv6%s", format, suffix),
+ SuggestedFixes: []analysis.SuggestedFix{{
+ Message: "Replace fmt.Sprintf with net.JoinHostPort",
+ TextEdits: edits,
+ }},
+ })
}
}
}
// Check address argument of each call to net.Dial et al.
- inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
- for curCall := range cursor.Root(inspect).Preorder((*ast.CallExpr)(nil)) {
- call := curCall.Node().(*ast.CallExpr)
-
- obj := typeutil.Callee(info, call)
- if analysisinternal.IsFunctionNamed(obj, "net", "Dial", "DialTimeout") ||
- analysisinternal.IsMethodNamed(obj, "net", "Dialer", "Dial") {
-
+ for _, callee := range []types.Object{
+ index.Object("net", "Dial"),
+ index.Object("net", "DialTimeout"),
+ index.Selection("net", "Dialer", "Dial"),
+ } {
+ for curCall := range index.Calls(callee) {
+ call := curCall.Node().(*ast.CallExpr)
switch address := call.Args[1].(type) {
case *ast.CallExpr:
- // net.Dial("tcp", fmt.Sprintf("%s:%d", ...))
- checkAddr(address, nil)
+ if len(call.Args) == 2 { // avoid spread-call edge case
+ // net.Dial("tcp", fmt.Sprintf("%s:%d", ...))
+ checkAddr(address, nil)
+ }
case *ast.Ident:
// addr := fmt.Sprintf("%s:%d", ...)
@@ -162,25 +159,23 @@ func run(pass *analysis.Pass) (any, error) {
// net.Dial("tcp", addr)
// Search for decl of addrVar within common ancestor of addrVar and Dial call.
+ // TODO(adonovan): abstract "find RHS of statement that assigns var v".
+ // TODO(adonovan): reject if there are other assignments to var v.
if addrVar, ok := info.Uses[address].(*types.Var); ok {
- pos := addrVar.Pos()
- for curAncestor := range curCall.Ancestors() {
- if curIdent, ok := curAncestor.FindPos(pos, pos); ok {
- // curIdent is the declaring ast.Ident of addr.
- switch parent := curIdent.Parent().Node().(type) {
- case *ast.AssignStmt:
- if len(parent.Rhs) == 1 {
- // Have: addr := fmt.Sprintf("%s:%d", ...)
- checkAddr(parent.Rhs[0], call)
- }
-
- case *ast.ValueSpec:
- if len(parent.Values) == 1 {
- // Have: var addr = fmt.Sprintf("%s:%d", ...)
- checkAddr(parent.Values[0], call)
- }
+ if curId, ok := index.Def(addrVar); ok {
+ // curIdent is the declaring ast.Ident of addr.
+ switch parent := curId.Parent().Node().(type) {
+ case *ast.AssignStmt:
+ if len(parent.Rhs) == 1 {
+ // Have: addr := fmt.Sprintf("%s:%d", ...)
+ checkAddr(parent.Rhs[0], call)
+ }
+
+ case *ast.ValueSpec:
+ if len(parent.Values) == 1 {
+ // Have: var addr = fmt.Sprintf("%s:%d", ...)
+ checkAddr(parent.Values[0], call)
}
- break
}
}
}
diff --git a/gopls/internal/analysis/maprange/cmd/maprange/main.go b/gopls/internal/analysis/maprange/cmd/maprange/main.go
new file mode 100644
index 00000000000..ec1fd5ca93c
--- /dev/null
+++ b/gopls/internal/analysis/maprange/cmd/maprange/main.go
@@ -0,0 +1,14 @@
+// Copyright 2025 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.
+
+// The maprange command applies the golang.org/x/tools/gopls/internal/analysis/maprange
+// analysis to the specified packages of Go source code.
+package main
+
+import (
+ "golang.org/x/tools/go/analysis/singlechecker"
+ "golang.org/x/tools/gopls/internal/analysis/maprange"
+)
+
+func main() { singlechecker.Main(maprange.Analyzer) }
diff --git a/gopls/internal/analysis/maprange/doc.go b/gopls/internal/analysis/maprange/doc.go
new file mode 100644
index 00000000000..46f465059a9
--- /dev/null
+++ b/gopls/internal/analysis/maprange/doc.go
@@ -0,0 +1,37 @@
+// Copyright 2025 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 maprange defines an Analyzer that checks for redundant use
+// of the functions maps.Keys and maps.Values in "for" statements with
+// "range" clauses.
+//
+// # Analyzer maprange
+//
+// maprange: checks for unnecessary calls to maps.Keys and maps.Values in range statements
+//
+// Consider a loop written like this:
+//
+// for val := range maps.Values(m) {
+// fmt.Println(val)
+// }
+//
+// This should instead be written without the call to maps.Values:
+//
+// for _, val := range m {
+// fmt.Println(val)
+// }
+//
+// golang.org/x/exp/maps returns slices for Keys/Values instead of iterators,
+// but unnecessary calls should similarly be removed:
+//
+// for _, key := range maps.Keys(m) {
+// fmt.Println(key)
+// }
+//
+// should be rewritten as:
+//
+// for key := range m {
+// fmt.Println(key)
+// }
+package maprange
diff --git a/gopls/internal/analysis/maprange/maprange.go b/gopls/internal/analysis/maprange/maprange.go
new file mode 100644
index 00000000000..eed04b14e72
--- /dev/null
+++ b/gopls/internal/analysis/maprange/maprange.go
@@ -0,0 +1,159 @@
+// Copyright 2025 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 maprange
+
+import (
+ _ "embed"
+ "fmt"
+ "go/ast"
+ "go/types"
+
+ "golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/gopls/internal/util/moreiters"
+ "golang.org/x/tools/internal/analysisinternal"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
+ "golang.org/x/tools/internal/astutil/cursor"
+ "golang.org/x/tools/internal/astutil/edge"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
+ "golang.org/x/tools/internal/versions"
+)
+
+//go:embed doc.go
+var doc string
+
+var Analyzer = &analysis.Analyzer{
+ Name: "maprange",
+ Doc: analysisinternal.MustExtractDoc(doc, "maprange"),
+ URL: "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/maprange",
+ Requires: []*analysis.Analyzer{typeindexanalyzer.Analyzer},
+ Run: run,
+}
+
+// This is a variable because the package name is different in Google's code base.
+var xmaps = "golang.org/x/exp/maps"
+
+func run(pass *analysis.Pass) (any, error) {
+ switch pass.Pkg.Path() {
+ case "maps", xmaps:
+ // These packages know how to use their own APIs.
+ return nil, nil
+ }
+ var (
+ index = pass.ResultOf[typeindexanalyzer.Analyzer].(*typeindex.Index)
+ mapsKeys = index.Object("maps", "Keys")
+ mapsValues = index.Object("maps", "Values")
+ xmapsKeys = index.Object(xmaps, "Keys")
+ xmapsValues = index.Object(xmaps, "Values")
+ )
+ for _, callee := range []types.Object{mapsKeys, mapsValues, xmapsKeys, xmapsValues} {
+ for curCall := range index.Calls(callee) {
+ if ek, _ := curCall.ParentEdge(); ek != edge.RangeStmt_X {
+ continue
+ }
+ analyzeRangeStmt(pass, callee, curCall)
+ }
+ }
+ return nil, nil
+}
+
+// analyzeRangeStmt analyzes range statements iterating over calls to maps.Keys
+// or maps.Values (from the standard library "maps" or "golang.org/x/exp/maps").
+//
+// It reports a diagnostic with a suggested fix to simplify the loop by removing
+// the unnecessary function call and adjusting range variables, if possible.
+// For certain patterns involving x/exp/maps.Keys before Go 1.22, it reports
+// a diagnostic about potential incorrect usage without a suggested fix.
+// No diagnostic is reported if the range statement doesn't require changes.
+func analyzeRangeStmt(pass *analysis.Pass, callee types.Object, curCall cursor.Cursor) {
+ var (
+ call = curCall.Node().(*ast.CallExpr)
+ rangeStmt = curCall.Parent().Node().(*ast.RangeStmt)
+ pkg = callee.Pkg().Path()
+ fn = callee.Name()
+ )
+ var edits []analysis.TextEdit
+
+ // Check if the call to maps.Keys or maps.Values can be removed/replaced.
+ // Example:
+ // for range maps.Keys(m)
+ // ^^^^^^^^^ removeCall
+ // for i, _ := range maps.Keys(m)
+ // ^^^^^^^^^ replace with `len`
+ //
+ // If we have: for i, k := range maps.Keys(m) (only possible using x/exp/maps)
+ // or: for i, v = range maps.Values(m)
+ // do not remove the call.
+ removeCall := !isSet(rangeStmt.Key) || !isSet(rangeStmt.Value)
+ replace := ""
+ if pkg == xmaps && isSet(rangeStmt.Key) && rangeStmt.Value == nil {
+ // If we have: for i := range maps.Keys(m) (using x/exp/maps),
+ // Replace with: for i := range len(m)
+ replace = "len"
+ canRangeOverInt := fileUses(pass.TypesInfo, curCall, "go1.22")
+ if !canRangeOverInt {
+ pass.Report(analysis.Diagnostic{
+ Pos: call.Pos(),
+ End: call.End(),
+ Message: fmt.Sprintf("likely incorrect use of %s.%s (returns a slice)", pkg, fn),
+ })
+ return
+ }
+ }
+ if removeCall {
+ edits = append(edits, analysis.TextEdit{
+ Pos: call.Fun.Pos(),
+ End: call.Fun.End(),
+ NewText: []byte(replace)})
+ }
+ // Check if the key of the range statement should be removed.
+ // Example:
+ // for _, k := range maps.Keys(m)
+ // ^^^ removeKey ^^^^^^^^^ removeCall
+ removeKey := pkg == xmaps && fn == "Keys" && !isSet(rangeStmt.Key) && isSet(rangeStmt.Value)
+ if removeKey {
+ edits = append(edits, analysis.TextEdit{
+ Pos: rangeStmt.Key.Pos(),
+ End: rangeStmt.Value.Pos(),
+ })
+ }
+ // Check if a key should be inserted to the range statement.
+ // Example:
+ // for _, v := range maps.Values(m)
+ // ^^^ addKey ^^^^^^^^^^^ removeCall
+ addKey := pkg == "maps" && fn == "Values" && isSet(rangeStmt.Key)
+ if addKey {
+ edits = append(edits, analysis.TextEdit{
+ Pos: rangeStmt.Key.Pos(),
+ End: rangeStmt.Key.Pos(),
+ NewText: []byte("_, "),
+ })
+ }
+
+ if len(edits) > 0 {
+ pass.Report(analysis.Diagnostic{
+ Pos: call.Pos(),
+ End: call.End(),
+ Message: fmt.Sprintf("unnecessary and inefficient call of %s.%s", pkg, fn),
+ SuggestedFixes: []analysis.SuggestedFix{{
+ Message: fmt.Sprintf("Remove unnecessary call to %s.%s", pkg, fn),
+ TextEdits: edits,
+ }},
+ })
+ }
+}
+
+// isSet reports whether an ast.Expr is a non-nil expression that is not the blank identifier.
+func isSet(expr ast.Expr) bool {
+ ident, ok := expr.(*ast.Ident)
+ return expr != nil && (!ok || ident.Name != "_")
+}
+
+// fileUses reports whether the file containing the specified cursor
+// uses at least the specified version of Go (e.g. "go1.24").
+func fileUses(info *types.Info, c cursor.Cursor, version string) bool {
+ c, _ = moreiters.First(c.Enclosing((*ast.File)(nil)))
+ file := c.Node().(*ast.File)
+ return !versions.Before(info.FileVersions[file], version)
+}
diff --git a/gopls/internal/analysis/maprange/maprange_test.go b/gopls/internal/analysis/maprange/maprange_test.go
new file mode 100644
index 00000000000..1759dc1db99
--- /dev/null
+++ b/gopls/internal/analysis/maprange/maprange_test.go
@@ -0,0 +1,23 @@
+// Copyright 2025 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 maprange_test
+
+import (
+ "golang.org/x/tools/go/analysis/analysistest"
+ "golang.org/x/tools/gopls/internal/analysis/maprange"
+ "golang.org/x/tools/internal/testfiles"
+ "path/filepath"
+ "testing"
+)
+
+func TestBasic(t *testing.T) {
+ dir := testfiles.ExtractTxtarFileToTmp(t, filepath.Join(analysistest.TestData(), "basic.txtar"))
+ analysistest.RunWithSuggestedFixes(t, dir, maprange.Analyzer, "maprange")
+}
+
+func TestOld(t *testing.T) {
+ dir := testfiles.ExtractTxtarFileToTmp(t, filepath.Join(analysistest.TestData(), "old.txtar"))
+ analysistest.RunWithSuggestedFixes(t, dir, maprange.Analyzer, "maprange")
+}
diff --git a/gopls/internal/analysis/maprange/testdata/basic.txtar b/gopls/internal/analysis/maprange/testdata/basic.txtar
new file mode 100644
index 00000000000..1950e958218
--- /dev/null
+++ b/gopls/internal/analysis/maprange/testdata/basic.txtar
@@ -0,0 +1,209 @@
+Test of fixing redundant calls to maps.Keys and maps.Values
+(both stdlib "maps" and "golang.org/x/exp/maps") for Go 1.24.
+
+-- go.mod --
+module maprange
+
+require golang.org/x/exp v0.0.0
+
+replace golang.org/x/exp => ./exp
+
+go 1.24
+
+-- basic.go --
+package basic
+
+import "maps"
+
+func _() {
+ m := make(map[int]int)
+
+ for range maps.Keys(m) { // want `unnecessary and inefficient call of maps.Keys`
+ }
+
+ for range maps.Values(m) { // want `unnecessary and inefficient call of maps.Values`
+ }
+
+ var x struct {
+ Map map[int]int
+ }
+ x.Map = make(map[int]int)
+ for x.Map[1] = range maps.Keys(m) { // want `unnecessary and inefficient call of maps.Keys`
+ }
+
+ for x.Map[2] = range maps.Values(m) { // want `unnecessary and inefficient call of maps.Values`
+ }
+
+ for k := range maps.Keys(m) { // want `unnecessary and inefficient call of maps.Keys`
+ _ = k
+ }
+
+ for v := range maps.Values(m) { // want `unnecessary and inefficient call of maps.Values`
+ _ = v
+ }
+
+ for range maps.Keys(x.Map) { // want `unnecessary and inefficient call of maps.Keys`
+ }
+
+ for /* comment */ k := range /* comment */ maps.Keys(/* comment */ m) { // want `unnecessary and inefficient call of maps.Keys`
+ _ = k
+ }
+}
+
+-- basic.go.golden --
+package basic
+
+import "maps"
+
+func _() {
+ m := make(map[int]int)
+
+ for range m { // want `unnecessary and inefficient call of maps.Keys`
+ }
+
+ for range m { // want `unnecessary and inefficient call of maps.Values`
+ }
+
+ var x struct {
+ Map map[int]int
+ }
+ x.Map = make(map[int]int)
+ for x.Map[1] = range m { // want `unnecessary and inefficient call of maps.Keys`
+ }
+
+ for _, x.Map[2] = range m { // want `unnecessary and inefficient call of maps.Values`
+ }
+
+ for k := range m { // want `unnecessary and inefficient call of maps.Keys`
+ _ = k
+ }
+
+ for _, v := range m { // want `unnecessary and inefficient call of maps.Values`
+ _ = v
+ }
+
+ for range x.Map { // want `unnecessary and inefficient call of maps.Keys`
+ }
+
+ for /* comment */ k := range /* comment */ /* comment */ m { // want `unnecessary and inefficient call of maps.Keys`
+ _ = k
+ }
+}
+
+-- xmaps.go --
+package basic
+
+import "golang.org/x/exp/maps"
+
+func _() {
+ m := make(map[int]int)
+
+ for range maps.Keys(m) { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Keys`
+ }
+
+ for range maps.Values(m) { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Values`
+ }
+
+ for i := range maps.Values(m) { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Values`
+ _ = i
+ }
+
+ var x struct {
+ Map map[int]int
+ }
+ x.Map = make(map[int]int)
+ for _, x.Map[1] = range maps.Keys(m) { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Keys`
+ }
+
+ for _, x.Map[2] = range maps.Values(m) { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Values`
+ }
+
+ for _, k := range maps.Keys(m) { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Keys`
+ _ = k
+ }
+
+ for _, v := range maps.Values(m) { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Values`
+ _ = v
+ }
+
+ for range maps.Keys(x.Map) { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Keys`
+ }
+
+ for i, k := range maps.Keys(m) { // ok: this can't be straightforwardly rewritten
+ _, _ = i, k
+ }
+
+ for _, _ = range maps.Values(m) { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Values`
+ }
+}
+
+-- xmaps.go.golden --
+package basic
+
+import "golang.org/x/exp/maps"
+
+func _() {
+ m := make(map[int]int)
+
+ for range m { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Keys`
+ }
+
+ for range m { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Values`
+ }
+
+ for i := range len(m) { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Values`
+ _ = i
+ }
+
+ var x struct {
+ Map map[int]int
+ }
+ x.Map = make(map[int]int)
+ for x.Map[1] = range m { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Keys`
+ }
+
+ for _, x.Map[2] = range m { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Values`
+ }
+
+ for k := range m { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Keys`
+ _ = k
+ }
+
+ for _, v := range m { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Values`
+ _ = v
+ }
+
+ for range x.Map { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Keys`
+ }
+
+ for i, k := range maps.Keys(m) { // ok: this can't be straightforwardly rewritten
+ _, _ = i, k
+ }
+
+ for _, _ = range m { // want `unnecessary and inefficient call of golang.org/x/exp/maps.Values`
+ }
+}
+
+-- exp/go.mod --
+module golang.org/x/exp
+
+go 1.24
+
+-- exp/maps/maps.go --
+package maps
+
+func Keys[M ~map[K]V, K comparable, V any](m M) []K {
+ r := make([]K, 0, len(m))
+ for k := range m {
+ r = append(r, k)
+ }
+ return r
+}
+
+func Values[M ~map[K]V, K comparable, V any](m M) []V {
+ r := make([]V, 0, len(m))
+ for _, v := range m {
+ r = append(r, v)
+ }
+ return r
+}
\ No newline at end of file
diff --git a/gopls/internal/analysis/maprange/testdata/old.txtar b/gopls/internal/analysis/maprange/testdata/old.txtar
new file mode 100644
index 00000000000..d27ff8c2a22
--- /dev/null
+++ b/gopls/internal/analysis/maprange/testdata/old.txtar
@@ -0,0 +1,62 @@
+Test of fixing redundant calls to maps.Keys and maps.Values
+(both stdlib "maps" and "golang.org/x/exp/maps") for Go 1.21,
+before range over int made suggesting a fix for a rare case easier.
+
+-- go.mod --
+module maprange
+
+require golang.org/x/exp v0.0.0
+
+replace golang.org/x/exp => ./exp
+
+go 1.21
+
+-- old.go --
+package old
+
+import "golang.org/x/exp/maps"
+
+func _() {
+ m := make(map[int]int)
+
+ for i := range maps.Keys(m) { // want `likely incorrect use of golang.org/x/exp/maps.Keys \(returns a slice\)`
+ _ = i
+ }
+}
+
+-- old.go.golden --
+package old
+
+import "golang.org/x/exp/maps"
+
+func _() {
+ m := make(map[int]int)
+
+ for i := range maps.Keys(m) { // want `likely incorrect use of golang.org/x/exp/maps.Keys \(returns a slice\)`
+ _ = i
+ }
+}
+
+-- exp/go.mod --
+module golang.org/x/exp
+
+go 1.21
+
+-- exp/maps/maps.go --
+package maps
+
+func Keys[M ~map[K]V, K comparable, V any](m M) []K {
+ r := make([]K, 0, len(m))
+ for k := range m {
+ r = append(r, k)
+ }
+ return r
+}
+
+func Values[M ~map[K]V, K comparable, V any](m M) []V {
+ r := make([]V, 0, len(m))
+ for _, v := range m {
+ r = append(r, v)
+ }
+ return r
+}
\ No newline at end of file
diff --git a/gopls/internal/analysis/modernize/bloop.go b/gopls/internal/analysis/modernize/bloop.go
index f851a6688e1..5bfb0b7d8e8 100644
--- a/gopls/internal/analysis/modernize/bloop.go
+++ b/gopls/internal/analysis/modernize/bloop.go
@@ -14,8 +14,11 @@ import (
"golang.org/x/tools/go/analysis/passes/inspect"
"golang.org/x/tools/go/ast/inspector"
"golang.org/x/tools/go/types/typeutil"
+ "golang.org/x/tools/gopls/internal/util/moreiters"
"golang.org/x/tools/internal/analysisinternal"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
"golang.org/x/tools/internal/astutil/cursor"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
)
// bloop updates benchmarks that use "for range b.N", replacing it
@@ -31,7 +34,11 @@ func bloop(pass *analysis.Pass) {
return
}
- info := pass.TypesInfo
+ var (
+ inspect = pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+ index = pass.ResultOf[typeindexanalyzer.Analyzer].(*typeindex.Index)
+ info = pass.TypesInfo
+ )
// edits computes the text edits for a matched for/range loop
// at the specified cursor. b is the *testing.B value, and
@@ -76,7 +83,6 @@ func bloop(pass *analysis.Pass) {
}
// Find all for/range statements.
- inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
loops := []ast.Node{
(*ast.ForStmt)(nil),
(*ast.RangeStmt)(nil),
@@ -101,11 +107,11 @@ func bloop(pass *analysis.Pass) {
if assign, ok := n.Init.(*ast.AssignStmt); ok &&
assign.Tok == token.DEFINE &&
len(assign.Rhs) == 1 &&
- isZeroLiteral(assign.Rhs[0]) &&
+ isZeroIntLiteral(info, assign.Rhs[0]) &&
is[*ast.IncDecStmt](n.Post) &&
n.Post.(*ast.IncDecStmt).Tok == token.INC &&
equalSyntax(n.Post.(*ast.IncDecStmt).X, assign.Lhs[0]) &&
- !uses(info, body, info.Defs[assign.Lhs[0].(*ast.Ident)]) {
+ !uses(index, body, info.Defs[assign.Lhs[0].(*ast.Ident)]) {
delStart, delEnd = n.Init.Pos(), n.Post.End()
}
@@ -152,9 +158,9 @@ func bloop(pass *analysis.Pass) {
}
// uses reports whether the subtree cur contains a use of obj.
-func uses(info *types.Info, cur cursor.Cursor, obj types.Object) bool {
- for curId := range cur.Preorder((*ast.Ident)(nil)) {
- if info.Uses[curId.Node().(*ast.Ident)] == obj {
+func uses(index *typeindex.Index, cur cursor.Cursor, obj types.Object) bool {
+ for use := range index.Uses(obj) {
+ if cur.Contains(use) {
return true
}
}
@@ -164,8 +170,5 @@ func uses(info *types.Info, cur cursor.Cursor, obj types.Object) bool {
// enclosingFunc returns the cursor for the innermost Func{Decl,Lit}
// that encloses c, if any.
func enclosingFunc(c cursor.Cursor) (cursor.Cursor, bool) {
- for curAncestor := range c.Ancestors((*ast.FuncDecl)(nil), (*ast.FuncLit)(nil)) {
- return curAncestor, true
- }
- return cursor.Cursor{}, false
+ return moreiters.First(c.Enclosing((*ast.FuncDecl)(nil), (*ast.FuncLit)(nil)))
}
diff --git a/gopls/internal/analysis/modernize/doc.go b/gopls/internal/analysis/modernize/doc.go
index 15aeab64d8d..aa052540832 100644
--- a/gopls/internal/analysis/modernize/doc.go
+++ b/gopls/internal/analysis/modernize/doc.go
@@ -9,27 +9,87 @@
// modernize: simplify code by using modern constructs
//
// This analyzer reports opportunities for simplifying and clarifying
-// existing code by using more modern features of Go, such as:
-//
-// - replacing an if/else conditional assignment by a call to the
-// built-in min or max functions added in go1.21;
-// - replacing sort.Slice(x, func(i, j int) bool) { return s[i] < s[j] }
-// by a call to slices.Sort(s), added in go1.21;
-// - replacing interface{} by the 'any' type added in go1.18;
-// - replacing append([]T(nil), s...) by slices.Clone(s) or
-// slices.Concat(s), added in go1.21;
-// - replacing a loop around an m[k]=v map update by a call
-// to one of the Collect, Copy, Clone, or Insert functions
-// from the maps package, added in go1.21;
-// - replacing []byte(fmt.Sprintf...) by fmt.Appendf(nil, ...),
-// added in go1.19;
-// - replacing uses of context.WithCancel in tests with t.Context, added in
-// go1.24;
-// - replacing omitempty by omitzero on structs, added in go1.24;
-// - replacing append(s[:i], s[i+1]...) by slices.Delete(s, i, i+1),
-// added in go1.21
-// - replacing a 3-clause for i := 0; i < n; i++ {} loop by
-// for i := range n {}, added in go1.22;
-// - replacing Split in "for range strings.Split(...)" by go1.24's
-// more efficient SplitSeq;
+// existing code by using more modern features of Go and its standard
+// library.
+//
+// Each diagnostic provides a fix. Our intent is that these fixes may
+// be safely applied en masse without changing the behavior of your
+// program. In some cases the suggested fixes are imperfect and may
+// lead to (for example) unused imports or unused local variables,
+// causing build breakage. However, these problems are generally
+// trivial to fix. We regard any modernizer whose fix changes program
+// behavior to have a serious bug and will endeavor to fix it.
+//
+// To apply all modernization fixes en masse, you can use the
+// following command:
+//
+// $ go run golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@latest -fix -test ./...
+//
+// If the tool warns of conflicting fixes, you may need to run it more
+// than once until it has applied all fixes cleanly. This command is
+// not an officially supported interface and may change in the future.
+//
+// Changes produced by this tool should be reviewed as usual before
+// being merged. In some cases, a loop may be replaced by a simple
+// function call, causing comments within the loop to be discarded.
+// Human judgment may be required to avoid losing comments of value.
+//
+// Each diagnostic reported by modernize has a specific category. (The
+// categories are listed below.) Diagnostics in some categories, such
+// as "efaceany" (which replaces "interface{}" with "any" where it is
+// safe to do so) are particularly numerous. It may ease the burden of
+// code review to apply fixes in two passes, the first change
+// consisting only of fixes of category "efaceany", the second
+// consisting of all others. This can be achieved using the -category flag:
+//
+// $ modernize -category=efaceany -fix -test ./...
+// $ modernize -category=-efaceany -fix -test ./...
+//
+// Categories of modernize diagnostic:
+//
+// - forvar: remove x := x variable declarations made unnecessary by the new semantics of loops in go1.22.
+//
+// - slicescontains: replace 'for i, elem := range s { if elem == needle { ...; break }'
+// by a call to slices.Contains, added in go1.21.
+//
+// - minmax: replace an if/else conditional assignment by a call to
+// the built-in min or max functions added in go1.21.
+//
+// - sortslice: replace sort.Slice(x, func(i, j int) bool) { return s[i] < s[j] }
+// by a call to slices.Sort(s), added in go1.21.
+//
+// - efaceany: replace interface{} by the 'any' type added in go1.18.
+//
+// - slicesclone: replace append([]T(nil), s...) by slices.Clone(s) or
+// slices.Concat(s), added in go1.21.
+//
+// - mapsloop: replace a loop around an m[k]=v map update by a call
+// to one of the Collect, Copy, Clone, or Insert functions from
+// the maps package, added in go1.21.
+//
+// - fmtappendf: replace []byte(fmt.Sprintf...) by fmt.Appendf(nil, ...),
+// added in go1.19.
+//
+// - testingcontext: replace uses of context.WithCancel in tests
+// with t.Context, added in go1.24.
+//
+// - omitzero: replace omitempty by omitzero on structs, added in go1.24.
+//
+// - bloop: replace "for i := range b.N" or "for range b.N" in a
+// benchmark with "for b.Loop()", and remove any preceding calls
+// to b.StopTimer, b.StartTimer, and b.ResetTimer.
+//
+// - slicesdelete: replace append(s[:i], s[i+1]...) by
+// slices.Delete(s, i, i+1), added in go1.21.
+//
+// - rangeint: replace a 3-clause "for i := 0; i < n; i++" loop by
+// "for i := range n", added in go1.22.
+//
+// - stringsseq: replace Split in "for range strings.Split(...)" by go1.24's
+// more efficient SplitSeq, or Fields with FieldSeq.
+//
+// - stringscutprefix: replace some uses of HasPrefix followed by TrimPrefix with CutPrefix,
+// added to the strings package in go1.20.
+//
+// - waitgroup: replace old complex usages of sync.WaitGroup by less complex WaitGroup.Go method in go1.25.
package modernize
diff --git a/gopls/internal/analysis/modernize/fmtappendf.go b/gopls/internal/analysis/modernize/fmtappendf.go
index 8575827aa3e..6b01d38050e 100644
--- a/gopls/internal/analysis/modernize/fmtappendf.go
+++ b/gopls/internal/analysis/modernize/fmtappendf.go
@@ -5,33 +5,35 @@
package modernize
import (
+ "fmt"
"go/ast"
"go/types"
"strings"
"golang.org/x/tools/go/analysis"
- "golang.org/x/tools/go/analysis/passes/inspect"
- "golang.org/x/tools/go/ast/inspector"
- "golang.org/x/tools/go/types/typeutil"
- "golang.org/x/tools/internal/analysisinternal"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
+ "golang.org/x/tools/internal/astutil/edge"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
)
// The fmtappend function replaces []byte(fmt.Sprintf(...)) by
-// fmt.Appendf(nil, ...).
+// fmt.Appendf(nil, ...), and similarly for Sprint, Sprintln.
func fmtappendf(pass *analysis.Pass) {
- inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
- info := pass.TypesInfo
- for curFile := range filesUsing(inspect, info, "go1.19") {
- for curCallExpr := range curFile.Preorder((*ast.CallExpr)(nil)) {
- conv := curCallExpr.Node().(*ast.CallExpr)
- tv := info.Types[conv.Fun]
- if tv.IsType() && types.Identical(tv.Type, byteSliceType) {
- call, ok := conv.Args[0].(*ast.CallExpr)
- if ok {
- obj := typeutil.Callee(info, call)
- if !analysisinternal.IsFunctionNamed(obj, "fmt", "Sprintf", "Sprintln", "Sprint") {
- continue
- }
+ index := pass.ResultOf[typeindexanalyzer.Analyzer].(*typeindex.Index)
+ for _, fn := range []types.Object{
+ index.Object("fmt", "Sprintf"),
+ index.Object("fmt", "Sprintln"),
+ index.Object("fmt", "Sprint"),
+ } {
+ for curCall := range index.Calls(fn) {
+ call := curCall.Node().(*ast.CallExpr)
+ if ek, idx := curCall.ParentEdge(); ek == edge.CallExpr_Args && idx == 0 {
+ // Is parent a T(fmt.SprintX(...)) conversion?
+ conv := curCall.Parent().Node().(*ast.CallExpr)
+ tv := pass.TypesInfo.Types[conv.Fun]
+ if tv.IsType() && types.Identical(tv.Type, byteSliceType) &&
+ fileUses(pass.TypesInfo, enclosingFile(curCall), "go1.19") {
+ // Have: []byte(fmt.SprintX(...))
// Find "Sprint" identifier.
var id *ast.Ident
@@ -42,13 +44,14 @@ func fmtappendf(pass *analysis.Pass) {
id = e // "Sprint" after `import . "fmt"`
}
+ old, new := fn.Name(), strings.Replace(fn.Name(), "Sprint", "Append", 1)
pass.Report(analysis.Diagnostic{
Pos: conv.Pos(),
End: conv.End(),
Category: "fmtappendf",
- Message: "Replace []byte(fmt.Sprintf...) with fmt.Appendf",
+ Message: fmt.Sprintf("Replace []byte(fmt.%s...) with fmt.%s", old, new),
SuggestedFixes: []analysis.SuggestedFix{{
- Message: "Replace []byte(fmt.Sprintf...) with fmt.Appendf",
+ Message: fmt.Sprintf("Replace []byte(fmt.%s...) with fmt.%s", old, new),
TextEdits: []analysis.TextEdit{
{
// delete "[]byte("
@@ -63,7 +66,7 @@ func fmtappendf(pass *analysis.Pass) {
{
Pos: id.Pos(),
End: id.End(),
- NewText: []byte(strings.Replace(obj.Name(), "Sprint", "Append", 1)),
+ NewText: []byte(new),
},
{
Pos: call.Lparen + 1,
diff --git a/gopls/internal/analysis/modernize/forvar.go b/gopls/internal/analysis/modernize/forvar.go
new file mode 100644
index 00000000000..6f88ab77ed9
--- /dev/null
+++ b/gopls/internal/analysis/modernize/forvar.go
@@ -0,0 +1,95 @@
+// Copyright 2025 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 modernize
+
+import (
+ "go/ast"
+ "go/token"
+
+ "golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/go/analysis/passes/inspect"
+ "golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/gopls/internal/util/bug"
+ "golang.org/x/tools/internal/analysisinternal"
+)
+
+// forvar offers to fix unnecessary copying of a for variable
+//
+// for _, x := range foo {
+// x := x // offer to remove this superfluous assignment
+// }
+//
+// Prerequisites:
+// First statement in a range loop has to be :=
+// where the two idents are the same,
+// and the ident is defined (:=) as a variable in the for statement.
+// (Note that this 'fix' does not work for three clause loops
+// because the Go specification says "The variable used by each subsequent iteration
+// is declared implicitly before executing the post statement and initialized to the
+// value of the previous iteration's variable at that moment.")
+func forvar(pass *analysis.Pass) {
+ info := pass.TypesInfo
+
+ inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+ for curFile := range filesUsing(inspect, info, "go1.22") {
+ for curLoop := range curFile.Preorder((*ast.RangeStmt)(nil)) {
+ // in a range loop. Is the first statement var := var?
+ // if so, is var one of the range vars, and is it defined
+ // in the for statement?
+ // If so, decide how much to delete.
+ loop := curLoop.Node().(*ast.RangeStmt)
+ if loop.Tok != token.DEFINE {
+ continue
+ }
+ v, stmt := loopVarRedecl(loop.Body)
+ if v == nil {
+ continue // index is not redeclared
+ }
+ if (loop.Key == nil || !equalSyntax(loop.Key, v)) &&
+ (loop.Value == nil || !equalSyntax(loop.Value, v)) {
+ continue
+ }
+ astFile := curFile.Node().(*ast.File)
+ edits := analysisinternal.DeleteStmt(pass.Fset, astFile, stmt, bug.Reportf)
+ if len(edits) == 0 {
+ bug.Reportf("forvar failed to delete statement")
+ continue
+ }
+ remove := edits[0]
+ diag := analysis.Diagnostic{
+ Pos: remove.Pos,
+ End: remove.End,
+ Category: "forvar",
+ Message: "copying variable is unneeded",
+ SuggestedFixes: []analysis.SuggestedFix{{
+ Message: "Remove unneeded redeclaration",
+ TextEdits: []analysis.TextEdit{remove},
+ }},
+ }
+ pass.Report(diag)
+ }
+ }
+}
+
+// if the first statement is var := var, return var and the stmt
+func loopVarRedecl(body *ast.BlockStmt) (*ast.Ident, *ast.AssignStmt) {
+ if len(body.List) < 1 {
+ return nil, nil
+ }
+ stmt, ok := body.List[0].(*ast.AssignStmt)
+ if !ok || !isSimpleAssign(stmt) || stmt.Tok != token.DEFINE {
+ return nil, nil
+ }
+ if _, ok := stmt.Lhs[0].(*ast.Ident); !ok {
+ return nil, nil
+ }
+ if _, ok := stmt.Rhs[0].(*ast.Ident); !ok {
+ return nil, nil
+ }
+ if stmt.Lhs[0].(*ast.Ident).Name == stmt.Rhs[0].(*ast.Ident).Name {
+ return stmt.Lhs[0].(*ast.Ident), stmt
+ }
+ return nil, nil
+}
diff --git a/gopls/internal/analysis/modernize/maps.go b/gopls/internal/analysis/modernize/maps.go
index c93899621ef..1a5e2c3eeee 100644
--- a/gopls/internal/analysis/modernize/maps.go
+++ b/gopls/internal/analysis/modernize/maps.go
@@ -32,7 +32,7 @@ import (
//
// maps.Copy(m, x) (x is map)
// maps.Insert(m, x) (x is iter.Seq2)
-// m = maps.Clone(x) (x is map, m is a new map)
+// m = maps.Clone(x) (x is a non-nil map, m is a new map)
// m = maps.Collect(x) (x is iter.Seq2, m is a new map)
//
// A map is newly created if the preceding statement has one of these
@@ -41,7 +41,9 @@ import (
// m = make(M)
// m = M{}
func mapsloop(pass *analysis.Pass) {
- if pass.Pkg.Path() == "maps " {
+ // Skip the analyzer in packages where its
+ // fixes would create an import cycle.
+ if within(pass, "maps", "bytes", "runtime") {
return
}
@@ -77,6 +79,8 @@ func mapsloop(pass *analysis.Pass) {
// Is the preceding statement of the form
// m = make(M) or M{}
// and can we replace its RHS with slices.{Clone,Collect}?
+ //
+ // Beware: if x may be nil, we cannot use Clone as it preserves nilness.
var mrhs ast.Expr // make(M) or M{}, or nil
if curPrev, ok := curRange.PrevSibling(); ok {
if assign, ok := curPrev.Node().(*ast.AssignStmt); ok &&
@@ -87,9 +91,9 @@ func mapsloop(pass *analysis.Pass) {
// Have: m = rhs; for k, v := range x { m[k] = v }
var newMap bool
rhs := assign.Rhs[0]
- switch rhs := rhs.(type) {
+ switch rhs := ast.Unparen(rhs).(type) {
case *ast.CallExpr:
- if id, ok := rhs.Fun.(*ast.Ident); ok &&
+ if id, ok := ast.Unparen(rhs.Fun).(*ast.Ident); ok &&
info.Uses[id] == builtinMake {
// Have: m = make(...)
newMap = true
@@ -122,6 +126,16 @@ func mapsloop(pass *analysis.Pass) {
mrhs = rhs
}
}
+
+ // Temporarily disable the transformation to the
+ // (nil-preserving) maps.Clone until we can prove
+ // that x is non-nil. This is rarely possible,
+ // and may require control flow analysis
+ // (e.g. a dominating "if len(x)" check).
+ // See #71844.
+ if xmap {
+ mrhs = nil
+ }
}
}
}
@@ -142,16 +156,35 @@ func mapsloop(pass *analysis.Pass) {
start, end token.Pos
)
if mrhs != nil {
- // Replace RHS of preceding m=... assignment (and loop) with expression.
- start, end = mrhs.Pos(), rng.End()
- newText = fmt.Appendf(nil, "%s%s(%s)",
+ // Replace assignment and loop with expression.
+ //
+ // m = make(...)
+ // for k, v := range x { /* comments */ m[k] = v }
+ //
+ // ->
+ //
+ // /* comments */
+ // m = maps.Copy(x)
+ curPrev, _ := curRange.PrevSibling()
+ start, end = curPrev.Node().Pos(), rng.End()
+ newText = fmt.Appendf(nil, "%s%s = %s%s(%s)",
+ allComments(file, start, end),
+ analysisinternal.Format(pass.Fset, m),
prefix,
funcName,
analysisinternal.Format(pass.Fset, x))
} else {
// Replace loop with call statement.
+ //
+ // for k, v := range x { /* comments */ m[k] = v }
+ //
+ // ->
+ //
+ // /* comments */
+ // maps.Copy(m, x)
start, end = rng.Pos(), rng.End()
- newText = fmt.Appendf(nil, "%s%s(%s, %s)",
+ newText = fmt.Appendf(nil, "%s%s%s(%s, %s)",
+ allComments(file, start, end),
prefix,
funcName,
analysisinternal.Format(pass.Fset, m),
diff --git a/gopls/internal/analysis/modernize/minmax.go b/gopls/internal/analysis/modernize/minmax.go
index 26b12341cad..0e43ee11c3d 100644
--- a/gopls/internal/analysis/modernize/minmax.go
+++ b/gopls/internal/analysis/modernize/minmax.go
@@ -9,12 +9,14 @@ import (
"go/ast"
"go/token"
"go/types"
+ "strings"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/inspect"
"golang.org/x/tools/go/ast/inspector"
"golang.org/x/tools/internal/analysisinternal"
"golang.org/x/tools/internal/astutil/cursor"
+ "golang.org/x/tools/internal/typeparams"
)
// The minmax pass replaces if/else statements with calls to min or max.
@@ -24,6 +26,10 @@ import (
// 1. if a < b { x = a } else { x = b } => x = min(a, b)
// 2. x = a; if a < b { x = b } => x = max(a, b)
//
+// Pattern 1 requires that a is not NaN, and pattern 2 requires that b
+// is not Nan. Since this is hard to prove, we reject floating-point
+// numbers.
+//
// Variants:
// - all four ordered comparisons
// - "x := a" or "x = a" or "var x = a" in pattern 2
@@ -32,7 +38,7 @@ func minmax(pass *analysis.Pass) {
// check is called for all statements of this form:
// if a < b { lhs = rhs }
- check := func(curIfStmt cursor.Cursor, compare *ast.BinaryExpr) {
+ check := func(file *ast.File, curIfStmt cursor.Cursor, compare *ast.BinaryExpr) {
var (
ifStmt = curIfStmt.Node().(*ast.IfStmt)
tassign = ifStmt.Body.List[0].(*ast.AssignStmt)
@@ -57,7 +63,7 @@ func minmax(pass *analysis.Pass) {
if equalSyntax(lhs, lhs2) {
if equalSyntax(rhs, a) && equalSyntax(rhs2, b) {
sign = +sign
- } else if equalSyntax(rhs2, a) || equalSyntax(rhs, b) {
+ } else if equalSyntax(rhs2, a) && equalSyntax(rhs, b) {
sign = -sign
} else {
return
@@ -85,7 +91,8 @@ func minmax(pass *analysis.Pass) {
// Replace IfStmt with lhs = min(a, b).
Pos: ifStmt.Pos(),
End: ifStmt.End(),
- NewText: fmt.Appendf(nil, "%s = %s(%s, %s)",
+ NewText: fmt.Appendf(nil, "%s%s = %s(%s, %s)",
+ allComments(file, ifStmt.Pos(), ifStmt.End()),
analysisinternal.Format(pass.Fset, lhs),
sym,
analysisinternal.Format(pass.Fset, a),
@@ -95,7 +102,7 @@ func minmax(pass *analysis.Pass) {
})
}
- } else if prev, ok := curIfStmt.PrevSibling(); ok && isSimpleAssign(prev.Node()) {
+ } else if prev, ok := curIfStmt.PrevSibling(); ok && isSimpleAssign(prev.Node()) && ifStmt.Else == nil {
fassign := prev.Node().(*ast.AssignStmt)
// Have: lhs0 = rhs0; if a < b { lhs = rhs }
@@ -144,10 +151,13 @@ func minmax(pass *analysis.Pass) {
SuggestedFixes: []analysis.SuggestedFix{{
Message: fmt.Sprintf("Replace if/else with %s", sym),
TextEdits: []analysis.TextEdit{{
- // Replace rhs0 and IfStmt with min(a, b)
- Pos: rhs0.Pos(),
+ Pos: fassign.Pos(),
End: ifStmt.End(),
- NewText: fmt.Appendf(nil, "%s(%s, %s)",
+ // Replace "x := a; if ... {}" with "x = min(...)", preserving comments.
+ NewText: fmt.Appendf(nil, "%s %s %s %s(%s, %s)",
+ allComments(file, fassign.Pos(), ifStmt.End()),
+ analysisinternal.Format(pass.Fset, lhs),
+ fassign.Tok.String(),
sym,
analysisinternal.Format(pass.Fset, a),
analysisinternal.Format(pass.Fset, b)),
@@ -159,23 +169,35 @@ func minmax(pass *analysis.Pass) {
}
// Find all "if a < b { lhs = rhs }" statements.
+ info := pass.TypesInfo
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
- for curFile := range filesUsing(inspect, pass.TypesInfo, "go1.21") {
+ for curFile := range filesUsing(inspect, info, "go1.21") {
+ astFile := curFile.Node().(*ast.File)
for curIfStmt := range curFile.Preorder((*ast.IfStmt)(nil)) {
ifStmt := curIfStmt.Node().(*ast.IfStmt)
-
if compare, ok := ifStmt.Cond.(*ast.BinaryExpr); ok &&
ifStmt.Init == nil &&
isInequality(compare.Op) != 0 &&
isAssignBlock(ifStmt.Body) {
-
- // Have: if a < b { lhs = rhs }
- check(curIfStmt, compare)
+ // a blank var has no type.
+ if tLHS := info.TypeOf(ifStmt.Body.List[0].(*ast.AssignStmt).Lhs[0]); tLHS != nil && !maybeNaN(tLHS) {
+ // Have: if a < b { lhs = rhs }
+ check(astFile, curIfStmt, compare)
+ }
}
}
}
}
+// allComments collects all the comments from start to end.
+func allComments(file *ast.File, start, end token.Pos) string {
+ var buf strings.Builder
+ for co := range analysisinternal.Comments(file, start, end) {
+ _, _ = fmt.Fprintf(&buf, "%s\n", co.Text)
+ }
+ return buf.String()
+}
+
// isInequality reports non-zero if tok is one of < <= => >:
// +1 for > and -1 for <.
func isInequality(tok token.Token) int {
@@ -206,6 +228,21 @@ func isSimpleAssign(n ast.Node) bool {
len(assign.Rhs) == 1
}
+// maybeNaN reports whether t is (or may be) a floating-point type.
+func maybeNaN(t types.Type) bool {
+ // For now, we rely on core types.
+ // TODO(adonovan): In the post-core-types future,
+ // follow the approach of types.Checker.applyTypeFunc.
+ t = typeparams.CoreType(t)
+ if t == nil {
+ return true // fail safe
+ }
+ if basic, ok := t.(*types.Basic); ok && basic.Info()&types.IsFloat != 0 {
+ return true
+ }
+ return false
+}
+
// -- utils --
func is[T any](x any) bool {
diff --git a/gopls/internal/analysis/modernize/modernize.go b/gopls/internal/analysis/modernize/modernize.go
index 0f7b58eed37..b7e943a0c51 100644
--- a/gopls/internal/analysis/modernize/modernize.go
+++ b/gopls/internal/analysis/modernize/modernize.go
@@ -7,19 +7,24 @@ package modernize
import (
_ "embed"
"go/ast"
+ "go/constant"
"go/format"
"go/token"
"go/types"
"iter"
"regexp"
+ "slices"
"strings"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/inspect"
"golang.org/x/tools/go/ast/inspector"
"golang.org/x/tools/gopls/internal/util/astutil"
+ "golang.org/x/tools/gopls/internal/util/moreiters"
"golang.org/x/tools/internal/analysisinternal"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
"golang.org/x/tools/internal/astutil/cursor"
+ "golang.org/x/tools/internal/stdlib"
"golang.org/x/tools/internal/versions"
)
@@ -29,11 +34,20 @@ var doc string
var Analyzer = &analysis.Analyzer{
Name: "modernize",
Doc: analysisinternal.MustExtractDoc(doc, "modernize"),
- Requires: []*analysis.Analyzer{inspect.Analyzer},
+ Requires: []*analysis.Analyzer{inspect.Analyzer, typeindexanalyzer.Analyzer},
Run: run,
URL: "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/modernize",
}
+// Stopgap until general solution in CL 655555 lands. A change to the
+// cmd/vet CLI requires a proposal whereas a change to an analyzer's
+// flag set does not.
+var category string
+
+func init() {
+ Analyzer.Flags.StringVar(&category, "category", "", "comma-separated list of categories to apply; with a leading '-', a list of categories to ignore")
+}
+
func run(pass *analysis.Pass) (any, error) {
// Decorate pass.Report to suppress diagnostics in generated files.
//
@@ -53,6 +67,10 @@ func run(pass *analysis.Pass) (any, error) {
if diag.Category == "" {
panic("Diagnostic.Category is unset")
}
+ // TODO(adonovan): stopgap until CL 655555 lands.
+ if !enabledCategory(category, diag.Category) {
+ return
+ }
if _, ok := generated[pass.Fset.File(diag.Pos)]; ok {
return // skip checking if it's generated code
}
@@ -64,24 +82,20 @@ func run(pass *analysis.Pass) (any, error) {
bloop(pass)
efaceany(pass)
fmtappendf(pass)
+ forvar(pass)
mapsloop(pass)
minmax(pass)
omitzero(pass)
rangeint(pass)
slicescontains(pass)
slicesdelete(pass)
- splitseq(pass)
+ stringscutprefix(pass)
+ stringsseq(pass)
sortslice(pass)
testingContext(pass)
+ waitgroup(pass)
- // TODO(adonovan):
- // - more modernizers here; see #70815.
- // - opt: interleave these micro-passes within a single inspection.
- // - solve the "duplicate import" problem (#68765) when a number of
- // fixes in the same file are applied in parallel and all add
- // the same import. The tests exhibit the problem.
- // - should all diagnostics be of the form "x can be modernized by y"
- // or is that a foolish consistency?
+ // TODO(adonovan): opt: interleave these micro-passes within a single inspection.
return nil, nil
}
@@ -106,14 +120,22 @@ func formatExprs(fset *token.FileSet, exprs []ast.Expr) string {
return buf.String()
}
-// isZeroLiteral reports whether e is the literal 0.
-func isZeroLiteral(e ast.Expr) bool {
- lit, ok := e.(*ast.BasicLit)
- return ok && lit.Kind == token.INT && lit.Value == "0"
+// isZeroIntLiteral reports whether e is an integer whose value is 0.
+func isZeroIntLiteral(info *types.Info, e ast.Expr) bool {
+ return isIntLiteral(info, e, 0)
+}
+
+// isIntLiteral reports whether e is an integer with given value.
+func isIntLiteral(info *types.Info, e ast.Expr, n int64) bool {
+ return info.Types[e].Value == constant.MakeInt64(n)
}
// filesUsing returns a cursor for each *ast.File in the inspector
// that uses at least the specified version of Go (e.g. "go1.24").
+//
+// TODO(adonovan): opt: eliminate this function, instead following the
+// approach of [fmtappendf], which uses typeindex and [fileUses].
+// See "Tip" at [fileUses] for motivation.
func filesUsing(inspect *inspector.Inspector, info *types.Info, version string) iter.Seq[cursor.Cursor] {
return func(yield func(cursor.Cursor) bool) {
for curFile := range cursor.Root(inspect).Children() {
@@ -125,6 +147,45 @@ func filesUsing(inspect *inspector.Inspector, info *types.Info, version string)
}
}
+// fileUses reports whether the specified file uses at least the
+// specified version of Go (e.g. "go1.24").
+//
+// Tip: we recommend using this check "late", just before calling
+// pass.Report, rather than "early" (when entering each ast.File, or
+// each candidate node of interest, during the traversal), because the
+// operation is not free, yet is not a highly selective filter: the
+// fraction of files that pass most version checks is high and
+// increases over time.
+func fileUses(info *types.Info, file *ast.File, version string) bool {
+ return !versions.Before(info.FileVersions[file], version)
+}
+
+// enclosingFile returns the syntax tree for the file enclosing c.
+func enclosingFile(c cursor.Cursor) *ast.File {
+ c, _ = moreiters.First(c.Enclosing((*ast.File)(nil)))
+ return c.Node().(*ast.File)
+}
+
+// within reports whether the current pass is analyzing one of the
+// specified standard packages or their dependencies.
+func within(pass *analysis.Pass, pkgs ...string) bool {
+ path := pass.Pkg.Path()
+ return standard(path) &&
+ moreiters.Contains(stdlib.Dependencies(pkgs...), path)
+}
+
+// standard reports whether the specified package path belongs to a
+// package in the standard library (including internal dependencies).
+func standard(path string) bool {
+ // A standard package has no dot in its first segment.
+ // (It may yet have a dot, e.g. "vendor/golang.org/x/foo".)
+ slash := strings.IndexByte(path, '/')
+ if slash < 0 {
+ slash = len(path)
+ }
+ return !strings.Contains(path[:slash], ".") && path != "testdata"
+}
+
var (
builtinAny = types.Universe.Lookup("any")
builtinAppend = types.Universe.Lookup("append")
@@ -137,3 +198,60 @@ var (
byteSliceType = types.NewSlice(types.Typ[types.Byte])
omitemptyRegex = regexp.MustCompile(`(?:^json| json):"[^"]*(,omitempty)(?:"|,[^"]*")\s?`)
)
+
+// enabledCategory reports whether a given category is enabled by the specified
+// filter. filter is a comma-separated list of categories, optionally prefixed
+// with `-` to disable all provided categories. All categories are enabled with
+// an empty filter.
+//
+// (Will be superseded by https://go.dev/cl/655555.)
+func enabledCategory(filter, category string) bool {
+ if filter == "" {
+ return true
+ }
+ // negation must be specified at the start
+ filter, exclude := strings.CutPrefix(filter, "-")
+ filters := strings.Split(filter, ",")
+ if slices.Contains(filters, category) {
+ return !exclude
+ }
+ return exclude
+}
+
+// noEffects reports whether the expression has no side effects, i.e., it
+// does not modify the memory state. This function is conservative: it may
+// return false even when the expression has no effect.
+func noEffects(info *types.Info, expr ast.Expr) bool {
+ noEffects := true
+ ast.Inspect(expr, func(n ast.Node) bool {
+ switch v := n.(type) {
+ case nil, *ast.Ident, *ast.BasicLit, *ast.BinaryExpr, *ast.ParenExpr,
+ *ast.SelectorExpr, *ast.IndexExpr, *ast.SliceExpr, *ast.TypeAssertExpr,
+ *ast.StarExpr, *ast.CompositeLit, *ast.ArrayType, *ast.StructType,
+ *ast.MapType, *ast.InterfaceType, *ast.KeyValueExpr:
+ // No effect
+ case *ast.UnaryExpr:
+ // Channel send <-ch has effects
+ if v.Op == token.ARROW {
+ noEffects = false
+ }
+ case *ast.CallExpr:
+ // Type conversion has no effects
+ if !info.Types[v].IsType() {
+ // TODO(adonovan): Add a case for built-in functions without side
+ // effects (by using callsPureBuiltin from tools/internal/refactor/inline)
+
+ noEffects = false
+ }
+ case *ast.FuncLit:
+ // A FuncLit has no effects, but do not descend into it.
+ return false
+ default:
+ // All other expressions have effects
+ noEffects = false
+ }
+
+ return noEffects
+ })
+ return noEffects
+}
diff --git a/gopls/internal/analysis/modernize/modernize_test.go b/gopls/internal/analysis/modernize/modernize_test.go
index 6662914b28d..e823e983995 100644
--- a/gopls/internal/analysis/modernize/modernize_test.go
+++ b/gopls/internal/analysis/modernize/modernize_test.go
@@ -17,14 +17,19 @@ func Test(t *testing.T) {
"bloop",
"efaceany",
"fmtappendf",
+ "forvar",
"mapsloop",
"minmax",
"omitzero",
"rangeint",
"slicescontains",
"slicesdelete",
+ "stringscutprefix",
+ "stringscutprefix/bytescutprefix",
"splitseq",
+ "fieldsseq",
"sortslice",
"testingcontext",
+ "waitgroup",
)
}
diff --git a/gopls/internal/analysis/modernize/rangeint.go b/gopls/internal/analysis/modernize/rangeint.go
index c36203cef06..1d3f4b5db0c 100644
--- a/gopls/internal/analysis/modernize/rangeint.go
+++ b/gopls/internal/analysis/modernize/rangeint.go
@@ -8,13 +8,18 @@ import (
"fmt"
"go/ast"
"go/token"
+ "go/types"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/inspect"
"golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/go/types/typeutil"
"golang.org/x/tools/internal/analysisinternal"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
"golang.org/x/tools/internal/astutil/cursor"
"golang.org/x/tools/internal/astutil/edge"
+ "golang.org/x/tools/internal/typesinternal"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
)
// rangeint offers a fix to replace a 3-clause 'for' loop:
@@ -36,13 +41,23 @@ import (
// - The limit must not be b.N, to avoid redundancy with bloop's fixes.
//
// Caveats:
-// - The fix will cause the limit expression to be evaluated exactly
-// once, instead of once per iteration. The limit may be a function call
-// (e.g. seq.Len()). The fix may change the cardinality of side effects.
+//
+// The fix causes the limit expression to be evaluated exactly once,
+// instead of once per iteration. So, to avoid changing the
+// cardinality of side effects, the limit expression must not involve
+// function calls (e.g. seq.Len()) or channel receives. Moreover, the
+// value of the limit expression must be loop invariant, which in
+// practice means it must take one of the following forms:
+//
+// - a local variable that is assigned only once and not address-taken;
+// - a constant; or
+// - len(s), where s has the above properties.
func rangeint(pass *analysis.Pass) {
info := pass.TypesInfo
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+ typeindex := pass.ResultOf[typeindexanalyzer.Analyzer].(*typeindex.Index)
+
for curFile := range filesUsing(inspect, info, "go1.22") {
nextLoop:
for curLoop := range curFile.Preorder((*ast.ForStmt)(nil)) {
@@ -50,7 +65,7 @@ func rangeint(pass *analysis.Pass) {
if init, ok := loop.Init.(*ast.AssignStmt); ok &&
isSimpleAssign(init) &&
is[*ast.Ident](init.Lhs[0]) &&
- isZeroLiteral(init.Rhs[0]) {
+ isZeroIntLiteral(info, init.Rhs[0]) {
// Have: for i = 0; ... (or i := 0)
index := init.Lhs[0].(*ast.Ident)
@@ -58,13 +73,41 @@ func rangeint(pass *analysis.Pass) {
compare.Op == token.LSS &&
equalSyntax(compare.X, init.Lhs[0]) {
// Have: for i = 0; i < limit; ... {}
+
limit := compare.Y
- // Skip loops up to b.N in benchmarks; see [bloop].
- if sel, ok := limit.(*ast.SelectorExpr); ok &&
- sel.Sel.Name == "N" &&
- analysisinternal.IsPointerToNamed(info.TypeOf(sel.X), "testing", "B") {
- continue // skip b.N
+ // If limit is "len(slice)", simplify it to "slice".
+ //
+ // (Don't replace "for i := 0; i < len(map); i++"
+ // with "for range m" because it's too hard to prove
+ // that len(m) is loop-invariant).
+ if call, ok := limit.(*ast.CallExpr); ok &&
+ typeutil.Callee(info, call) == builtinLen &&
+ is[*types.Slice](info.TypeOf(call.Args[0]).Underlying()) {
+ limit = call.Args[0]
+ }
+
+ // Check the form of limit: must be a constant,
+ // or a local var that is not assigned or address-taken.
+ limitOK := false
+ if info.Types[limit].Value != nil {
+ limitOK = true // constant
+ } else if id, ok := limit.(*ast.Ident); ok {
+ if v, ok := info.Uses[id].(*types.Var); ok &&
+ !(v.Exported() && typesinternal.IsPackageLevel(v)) {
+ // limit is a local or unexported global var.
+ // (An exported global may have uses we can't see.)
+ for cur := range typeindex.Uses(v) {
+ if isScalarLvalue(info, cur) {
+ // Limit var is assigned or address-taken.
+ continue nextLoop
+ }
+ }
+ limitOK = true
+ }
+ }
+ if !limitOK {
+ continue nextLoop
}
if inc, ok := loop.Post.(*ast.IncDecStmt); ok &&
@@ -73,7 +116,7 @@ func rangeint(pass *analysis.Pass) {
// Have: for i = 0; i < limit; i++ {}
// Find references to i within the loop body.
- v := info.Defs[index]
+ v := info.ObjectOf(index)
used := false
for curId := range curLoop.Child(loop.Body).Preorder((*ast.Ident)(nil)) {
id := curId.Node().(*ast.Ident)
@@ -83,7 +126,7 @@ func rangeint(pass *analysis.Pass) {
// Reject if any is an l-value (assigned or address-taken):
// a "for range int" loop does not respect assignments to
// the loop variable.
- if isScalarLvalue(curId) {
+ if isScalarLvalue(info, curId) {
continue nextLoop
}
}
@@ -98,6 +141,59 @@ func rangeint(pass *analysis.Pass) {
})
}
+ // If i is used after the loop,
+ // don't offer a fix, as a range loop
+ // leaves i with a different final value (limit-1).
+ if init.Tok == token.ASSIGN {
+ for curId := range curLoop.Parent().Preorder((*ast.Ident)(nil)) {
+ id := curId.Node().(*ast.Ident)
+ if id.Pos() > loop.End() && info.Uses[id] == v {
+ continue nextLoop
+ }
+ }
+ }
+
+ // If limit is len(slice),
+ // simplify "range len(slice)" to "range slice".
+ if call, ok := limit.(*ast.CallExpr); ok &&
+ typeutil.Callee(info, call) == builtinLen &&
+ is[*types.Slice](info.TypeOf(call.Args[0]).Underlying()) {
+ limit = call.Args[0]
+ }
+
+ // If the limit is a untyped constant of non-integer type,
+ // such as "const limit = 1e3", its effective type may
+ // differ between the two forms.
+ // In a for loop, it must be comparable with int i,
+ // for i := 0; i < limit; i++
+ // but in a range loop it would become a float,
+ // for i := range limit {}
+ // which is a type error. We need to convert it to int
+ // in this case.
+ //
+ // Unfortunately go/types discards the untyped type
+ // (but see Untyped in golang/go#70638) so we must
+ // re-type check the expression to detect this case.
+ var beforeLimit, afterLimit string
+ if v := info.Types[limit].Value; v != nil {
+ tVar := info.TypeOf(init.Rhs[0])
+
+ // TODO(adonovan): use a types.Qualifier that respects the existing
+ // imports of this file that are visible (not shadowed) at the current position,
+ // and adds new imports as needed, similar to analysisinternal.AddImport.
+ // (Unfortunately types.Qualifier doesn't provide the name of the package
+ // member to be qualified, a qualifier cannot perform the necessary shadowing
+ // check for dot-imported names.)
+ beforeLimit, afterLimit = fmt.Sprintf("%s(", types.TypeString(tVar, types.RelativeTo(pass.Pkg))), ")"
+ info2 := &types.Info{Types: make(map[ast.Expr]types.TypeAndValue)}
+ if types.CheckExpr(pass.Fset, pass.Pkg, limit.Pos(), limit, info2) == nil {
+ tLimit := types.Default(info2.TypeOf(limit))
+ if types.AssignableTo(tLimit, tVar) {
+ beforeLimit, afterLimit = "", ""
+ }
+ }
+ }
+
pass.Report(analysis.Diagnostic{
Pos: init.Pos(),
End: inc.End(),
@@ -111,15 +207,30 @@ func rangeint(pass *analysis.Pass) {
// ----- ---
// -------
// for i := range limit {}
+
+ // Delete init.
{
Pos: init.Rhs[0].Pos(),
End: limit.Pos(),
NewText: []byte("range "),
},
+ // Add "int(" before limit, if needed.
+ {
+ Pos: limit.Pos(),
+ End: limit.Pos(),
+ NewText: []byte(beforeLimit),
+ },
+ // Delete inc.
{
Pos: limit.End(),
End: inc.End(),
},
+ // Add ")" after limit, if needed.
+ {
+ Pos: limit.End(),
+ End: limit.End(),
+ NewText: []byte(afterLimit),
+ },
}...),
}},
})
@@ -135,7 +246,7 @@ func rangeint(pass *analysis.Pass) {
//
// This function is valid only for scalars (x = ...),
// not for aggregates (x.a[i] = ...)
-func isScalarLvalue(curId cursor.Cursor) bool {
+func isScalarLvalue(info *types.Info, curId cursor.Cursor) bool {
// Unfortunately we can't simply use info.Types[e].Assignable()
// as it is always true for a variable even when that variable is
// used only as an r-value. So we must inspect enclosing syntax.
@@ -143,15 +254,22 @@ func isScalarLvalue(curId cursor.Cursor) bool {
cur := curId
// Strip enclosing parens.
- ek, _ := cur.Edge()
+ ek, _ := cur.ParentEdge()
for ek == edge.ParenExpr_X {
cur = cur.Parent()
- ek, _ = cur.Edge()
+ ek, _ = cur.ParentEdge()
}
switch ek {
case edge.AssignStmt_Lhs:
- return true // i = j
+ assign := cur.Parent().Node().(*ast.AssignStmt)
+ if assign.Tok != token.DEFINE {
+ return true // i = j or i += j
+ }
+ id := curId.Node().(*ast.Ident)
+ if v, ok := info.Defs[id]; ok && v.Pos() != id.Pos() {
+ return true // reassignment of i (i, j := 1, 2)
+ }
case edge.IncDecStmt_X:
return true // i++, i--
case edge.UnaryExpr_X:
diff --git a/gopls/internal/analysis/modernize/slices.go b/gopls/internal/analysis/modernize/slices.go
index bdab9dea649..18e02d51ebf 100644
--- a/gopls/internal/analysis/modernize/slices.go
+++ b/gopls/internal/analysis/modernize/slices.go
@@ -12,6 +12,7 @@ import (
"go/ast"
"go/types"
"slices"
+ "strconv"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/inspect"
@@ -27,6 +28,10 @@ import (
// with a call to go1.21's slices.Concat(base, a, b, c), or simpler
// replacements such as slices.Clone(a) in degenerate cases.
//
+// We offer bytes.Clone in preference to slices.Clone where
+// appropriate, if the package already imports "bytes";
+// their behaviors are identical.
+//
// The base expression must denote a clipped slice (see [isClipped]
// for definition), otherwise the replacement might eliminate intended
// side effects to the base slice's array.
@@ -41,7 +46,9 @@ import (
// The fix does not always preserve nilness the of base slice when the
// addends (a, b, c) are all empty.
func appendclipped(pass *analysis.Pass) {
- if pass.Pkg.Path() == "slices" {
+ // Skip the analyzer in packages where its
+ // fixes would create an import cycle.
+ if within(pass, "slices", "bytes", "runtime") {
return
}
@@ -94,15 +101,32 @@ func appendclipped(pass *analysis.Pass) {
}
}
- // append(zerocap, s...) -> slices.Clone(s)
- _, prefix, importEdits := analysisinternal.AddImport(info, file, "slices", "slices", "Clone", call.Pos())
+ // If the slice type is []byte, and the file imports
+ // "bytes" but not "slices", prefer the (behaviorally
+ // identical) bytes.Clone for local consistency.
+ // https://go.dev/issue/70815#issuecomment-2671572984
+ fileImports := func(path string) bool {
+ return slices.ContainsFunc(file.Imports, func(spec *ast.ImportSpec) bool {
+ value, _ := strconv.Unquote(spec.Path.Value)
+ return value == path
+ })
+ }
+ clonepkg := cond(
+ types.Identical(info.TypeOf(call), byteSliceType) &&
+ !fileImports("slices") && fileImports("bytes"),
+ "bytes",
+ "slices")
+
+ // append(zerocap, s...) -> slices.Clone(s) or bytes.Clone(s)
+ _, prefix, importEdits := analysisinternal.AddImport(info, file, clonepkg, clonepkg, "Clone", call.Pos())
+ message := fmt.Sprintf("Replace append with %s.Clone", clonepkg)
pass.Report(analysis.Diagnostic{
Pos: call.Pos(),
End: call.End(),
Category: "slicesclone",
- Message: "Replace append with slices.Clone",
+ Message: message,
SuggestedFixes: []analysis.SuggestedFix{{
- Message: "Replace append with slices.Clone",
+ Message: message,
TextEdits: append(importEdits, []analysis.TextEdit{{
Pos: call.Pos(),
End: call.End(),
@@ -186,13 +210,16 @@ func appendclipped(pass *analysis.Pass) {
// x[:len(x):len(x)] (nonempty) res=x
// x[:k:k] (nonempty)
// slices.Clip(x) (nonempty) res=x
+//
+// TODO(adonovan): Add a check that the expression x has no side effects in
+// case x[:len(x):len(x)] -> x. Now the program behavior may change.
func clippedSlice(info *types.Info, e ast.Expr) (res ast.Expr, empty bool) {
switch e := e.(type) {
case *ast.SliceExpr:
// x[:0:0], x[:len(x):len(x)], x[:k:k]
if e.Slice3 && e.High != nil && e.Max != nil && equalSyntax(e.High, e.Max) { // x[:k:k]
res = e
- empty = isZeroLiteral(e.High) // x[:0:0]
+ empty = isZeroIntLiteral(info, e.High) // x[:0:0]
if call, ok := e.High.(*ast.CallExpr); ok &&
typeutil.Callee(info, call) == builtinLen &&
equalSyntax(call.Args[0], e.X) {
diff --git a/gopls/internal/analysis/modernize/slicescontains.go b/gopls/internal/analysis/modernize/slicescontains.go
index 09642448bb5..e99474df6ab 100644
--- a/gopls/internal/analysis/modernize/slicescontains.go
+++ b/gopls/internal/analysis/modernize/slicescontains.go
@@ -15,8 +15,10 @@ import (
"golang.org/x/tools/go/ast/inspector"
"golang.org/x/tools/go/types/typeutil"
"golang.org/x/tools/internal/analysisinternal"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
"golang.org/x/tools/internal/astutil/cursor"
"golang.org/x/tools/internal/typeparams"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
)
// The slicescontains pass identifies loops that can be replaced by a
@@ -46,13 +48,21 @@ import (
// It may change cardinality of effects of the "needle" expression.
// (Mostly this appears to be a desirable optimization, avoiding
// redundantly repeated evaluation.)
+//
+// TODO(adonovan): Add a check that needle/predicate expression from
+// if-statement has no effects. Now the program behavior may change.
func slicescontains(pass *analysis.Pass) {
- // Don't modify the slices package itself.
- if pass.Pkg.Path() == "slices" {
+ // Skip the analyzer in packages where its
+ // fixes would create an import cycle.
+ if within(pass, "slices", "runtime") {
return
}
- info := pass.TypesInfo
+ var (
+ inspect = pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+ index = pass.ResultOf[typeindexanalyzer.Analyzer].(*typeindex.Index)
+ info = pass.TypesInfo
+ )
// check is called for each RangeStmt of this form:
// for i, elem := range s { if cond { ... } }
@@ -140,8 +150,8 @@ func slicescontains(pass *analysis.Pass) {
if !ok {
panic(fmt.Sprintf("FindNode(%T) failed", n))
}
- return uses(info, cur, info.Defs[rng.Key.(*ast.Ident)]) ||
- rng.Value != nil && uses(info, cur, info.Defs[rng.Value.(*ast.Ident)])
+ return uses(index, cur, info.Defs[rng.Key.(*ast.Ident)]) ||
+ rng.Value != nil && uses(index, cur, info.Defs[rng.Value.(*ast.Ident)])
}
if usesRangeVar(body) {
// Body uses range var "i" or "elem".
@@ -345,7 +355,6 @@ func slicescontains(pass *analysis.Pass) {
}
}
- inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
for curFile := range filesUsing(inspect, info, "go1.21") {
file := curFile.Node().(*ast.File)
diff --git a/gopls/internal/analysis/modernize/slicesdelete.go b/gopls/internal/analysis/modernize/slicesdelete.go
index 24b2182ca6a..493009c35be 100644
--- a/gopls/internal/analysis/modernize/slicesdelete.go
+++ b/gopls/internal/analysis/modernize/slicesdelete.go
@@ -21,6 +21,12 @@ import (
// Other variations that will also have suggested replacements include:
// append(s[:i-1], s[i:]...) and append(s[:i+k1], s[i+k2:]) where k2 > k1.
func slicesdelete(pass *analysis.Pass) {
+ // Skip the analyzer in packages where its
+ // fixes would create an import cycle.
+ if within(pass, "slices", "runtime") {
+ return
+ }
+
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
info := pass.TypesInfo
report := func(file *ast.File, call *ast.CallExpr, slice1, slice2 *ast.SliceExpr) {
@@ -88,7 +94,7 @@ func slicesdelete(pass *analysis.Pass) {
slice2, ok2 := call.Args[1].(*ast.SliceExpr)
if ok1 && slice1.Low == nil && !slice1.Slice3 &&
ok2 && slice2.High == nil && !slice2.Slice3 &&
- equalSyntax(slice1.X, slice2.X) &&
+ equalSyntax(slice1.X, slice2.X) && noEffects(info, slice1.X) &&
increasingSliceIndices(info, slice1.High, slice2.Low) {
// Have append(s[:a], s[b:]...) where we can verify a < b.
report(file, call, slice1, slice2)
diff --git a/gopls/internal/analysis/modernize/sortslice.go b/gopls/internal/analysis/modernize/sortslice.go
index 7f695d76495..bbd04e9293d 100644
--- a/gopls/internal/analysis/modernize/sortslice.go
+++ b/gopls/internal/analysis/modernize/sortslice.go
@@ -5,16 +5,14 @@
package modernize
import (
- "fmt"
"go/ast"
"go/token"
"go/types"
"golang.org/x/tools/go/analysis"
- "golang.org/x/tools/go/analysis/passes/inspect"
- "golang.org/x/tools/go/ast/inspector"
- "golang.org/x/tools/go/types/typeutil"
"golang.org/x/tools/internal/analysisinternal"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
)
// The sortslice pass replaces sort.Slice(slice, less) with
@@ -37,18 +35,19 @@ import (
// - sort.Sort(x) where x has a named slice type whose Less method is the natural order.
// -> sort.Slice(x)
func sortslice(pass *analysis.Pass) {
- if !analysisinternal.Imports(pass.Pkg, "sort") {
+ // Skip the analyzer in packages where its
+ // fixes would create an import cycle.
+ if within(pass, "slices", "sort", "runtime") {
return
}
- info := pass.TypesInfo
-
- check := func(file *ast.File, call *ast.CallExpr) {
- // call to sort.Slice?
- obj := typeutil.Callee(info, call)
- if !analysisinternal.IsFunctionNamed(obj, "sort", "Slice") {
- return
- }
+ var (
+ info = pass.TypesInfo
+ index = pass.ResultOf[typeindexanalyzer.Analyzer].(*typeindex.Index)
+ sortSlice = index.Object("sort", "Slice")
+ )
+ for curCall := range index.Calls(sortSlice) {
+ call := curCall.Node().(*ast.CallExpr)
if lit, ok := call.Args[1].(*ast.FuncLit); ok && len(lit.Body.List) == 1 {
sig := info.Types[lit.Type].Type.(*types.Signature)
@@ -57,57 +56,50 @@ func sortslice(pass *analysis.Pass) {
i := sig.Params().At(0)
j := sig.Params().At(1)
- ret := lit.Body.List[0].(*ast.ReturnStmt)
- if compare, ok := ret.Results[0].(*ast.BinaryExpr); ok && compare.Op == token.LSS {
- // isIndex reports whether e is s[v].
- isIndex := func(e ast.Expr, v *types.Var) bool {
- index, ok := e.(*ast.IndexExpr)
- return ok &&
- equalSyntax(index.X, s) &&
- is[*ast.Ident](index.Index) &&
- info.Uses[index.Index.(*ast.Ident)] == v
- }
- if isIndex(compare.X, i) && isIndex(compare.Y, j) {
- // Have: sort.Slice(s, func(i, j int) bool { return s[i] < s[j] })
+ if ret, ok := lit.Body.List[0].(*ast.ReturnStmt); ok {
+ if compare, ok := ret.Results[0].(*ast.BinaryExpr); ok && compare.Op == token.LSS {
+ // isIndex reports whether e is s[v].
+ isIndex := func(e ast.Expr, v *types.Var) bool {
+ index, ok := e.(*ast.IndexExpr)
+ return ok &&
+ equalSyntax(index.X, s) &&
+ is[*ast.Ident](index.Index) &&
+ info.Uses[index.Index.(*ast.Ident)] == v
+ }
+ file := enclosingFile(curCall)
+ if isIndex(compare.X, i) && isIndex(compare.Y, j) &&
+ fileUses(info, file, "go1.21") {
+ // Have: sort.Slice(s, func(i, j int) bool { return s[i] < s[j] })
- _, prefix, importEdits := analysisinternal.AddImport(
- info, file, "slices", "slices", "Sort", call.Pos())
+ _, prefix, importEdits := analysisinternal.AddImport(
+ info, file, "slices", "slices", "Sort", call.Pos())
- pass.Report(analysis.Diagnostic{
- // Highlight "sort.Slice".
- Pos: call.Fun.Pos(),
- End: call.Fun.End(),
- Category: "sortslice",
- Message: fmt.Sprintf("sort.Slice can be modernized using slices.Sort"),
- SuggestedFixes: []analysis.SuggestedFix{{
- Message: fmt.Sprintf("Replace sort.Slice call by slices.Sort"),
- TextEdits: append(importEdits, []analysis.TextEdit{
- {
- // Replace sort.Slice with slices.Sort.
- Pos: call.Fun.Pos(),
- End: call.Fun.End(),
- NewText: []byte(prefix + "Sort"),
- },
- {
- // Eliminate FuncLit.
- Pos: call.Args[0].End(),
- End: call.Rparen,
- },
- }...),
- }},
- })
+ pass.Report(analysis.Diagnostic{
+ // Highlight "sort.Slice".
+ Pos: call.Fun.Pos(),
+ End: call.Fun.End(),
+ Category: "sortslice",
+ Message: "sort.Slice can be modernized using slices.Sort",
+ SuggestedFixes: []analysis.SuggestedFix{{
+ Message: "Replace sort.Slice call by slices.Sort",
+ TextEdits: append(importEdits, []analysis.TextEdit{
+ {
+ // Replace sort.Slice with slices.Sort.
+ Pos: call.Fun.Pos(),
+ End: call.Fun.End(),
+ NewText: []byte(prefix + "Sort"),
+ },
+ {
+ // Eliminate FuncLit.
+ Pos: call.Args[0].End(),
+ End: call.Rparen,
+ },
+ }...),
+ }},
+ })
+ }
}
}
}
}
-
- inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
- for curFile := range filesUsing(inspect, info, "go1.21") {
- file := curFile.Node().(*ast.File)
-
- for curCall := range curFile.Preorder((*ast.CallExpr)(nil)) {
- call := curCall.Node().(*ast.CallExpr)
- check(file, call)
- }
- }
}
diff --git a/gopls/internal/analysis/modernize/stringscutprefix.go b/gopls/internal/analysis/modernize/stringscutprefix.go
new file mode 100644
index 00000000000..cd053539910
--- /dev/null
+++ b/gopls/internal/analysis/modernize/stringscutprefix.go
@@ -0,0 +1,205 @@
+// Copyright 2025 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 modernize
+
+import (
+ "fmt"
+ "go/ast"
+ "go/token"
+
+ "golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/go/analysis/passes/inspect"
+ "golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/go/types/typeutil"
+ "golang.org/x/tools/internal/analysisinternal"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
+)
+
+// stringscutprefix offers a fix to replace an if statement which
+// calls to the 2 patterns below with strings.CutPrefix.
+//
+// Patterns:
+//
+// 1. if strings.HasPrefix(s, pre) { use(strings.TrimPrefix(s, pre) }
+// =>
+// if after, ok := strings.CutPrefix(s, pre); ok { use(after) }
+//
+// 2. if after := strings.TrimPrefix(s, pre); after != s { use(after) }
+// =>
+// if after, ok := strings.CutPrefix(s, pre); ok { use(after) }
+//
+// The use must occur within the first statement of the block, and the offered fix
+// only replaces the first occurrence of strings.TrimPrefix.
+//
+// Variants:
+// - bytes.HasPrefix usage as pattern 1.
+func stringscutprefix(pass *analysis.Pass) {
+ var (
+ inspect = pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+ index = pass.ResultOf[typeindexanalyzer.Analyzer].(*typeindex.Index)
+ info = pass.TypesInfo
+
+ stringsTrimPrefix = index.Object("strings", "TrimPrefix")
+ bytesTrimPrefix = index.Object("bytes", "TrimPrefix")
+ )
+ if !index.Used(stringsTrimPrefix, bytesTrimPrefix) {
+ return
+ }
+
+ const (
+ category = "stringscutprefix"
+ fixedMessage = "Replace HasPrefix/TrimPrefix with CutPrefix"
+ )
+
+ for curFile := range filesUsing(inspect, pass.TypesInfo, "go1.20") {
+ for curIfStmt := range curFile.Preorder((*ast.IfStmt)(nil)) {
+ ifStmt := curIfStmt.Node().(*ast.IfStmt)
+
+ // pattern1
+ if call, ok := ifStmt.Cond.(*ast.CallExpr); ok && len(ifStmt.Body.List) > 0 {
+ obj := typeutil.Callee(info, call)
+ if !analysisinternal.IsFunctionNamed(obj, "strings", "HasPrefix") &&
+ !analysisinternal.IsFunctionNamed(obj, "bytes", "HasPrefix") {
+ continue
+ }
+
+ // Replace the first occurrence of strings.TrimPrefix(s, pre) in the first statement only,
+ // but not later statements in case s or pre are modified by intervening logic.
+ firstStmt := curIfStmt.Child(ifStmt.Body).Child(ifStmt.Body.List[0])
+ for curCall := range firstStmt.Preorder((*ast.CallExpr)(nil)) {
+ call1 := curCall.Node().(*ast.CallExpr)
+ obj1 := typeutil.Callee(info, call1)
+ // bytesTrimPrefix or stringsTrimPrefix might be nil if the file doesn't import it,
+ // so we need to ensure the obj1 is not nil otherwise the call1 is not TrimPrefix and cause a panic.
+ if obj1 == nil ||
+ obj1 != stringsTrimPrefix && obj1 != bytesTrimPrefix {
+ continue
+ }
+ // Have: if strings.HasPrefix(s0, pre0) { ...strings.TrimPrefix(s, pre)... }
+ var (
+ s0 = call.Args[0]
+ pre0 = call.Args[1]
+ s = call1.Args[0]
+ pre = call1.Args[1]
+ )
+
+ // check whether the obj1 uses the exact the same argument with strings.HasPrefix
+ // shadow variables won't be valid because we only access the first statement.
+ if equalSyntax(s0, s) && equalSyntax(pre0, pre) {
+ after := analysisinternal.FreshName(info.Scopes[ifStmt], ifStmt.Pos(), "after")
+ _, prefix, importEdits := analysisinternal.AddImport(
+ info,
+ curFile.Node().(*ast.File),
+ obj1.Pkg().Name(),
+ obj1.Pkg().Path(),
+ "CutPrefix",
+ call.Pos(),
+ )
+ okVarName := analysisinternal.FreshName(info.Scopes[ifStmt], ifStmt.Pos(), "ok")
+ pass.Report(analysis.Diagnostic{
+ // highlight at HasPrefix call.
+ Pos: call.Pos(),
+ End: call.End(),
+ Category: category,
+ Message: "HasPrefix + TrimPrefix can be simplified to CutPrefix",
+ SuggestedFixes: []analysis.SuggestedFix{{
+ Message: fixedMessage,
+ // if strings.HasPrefix(s, pre) { use(strings.TrimPrefix(s, pre)) }
+ // ------------ ----------------- ----- --------------------------
+ // if after, ok := strings.CutPrefix(s, pre); ok { use(after) }
+ TextEdits: append(importEdits, []analysis.TextEdit{
+ {
+ Pos: call.Fun.Pos(),
+ End: call.Fun.Pos(),
+ NewText: []byte(fmt.Sprintf("%s, %s :=", after, okVarName)),
+ },
+ {
+ Pos: call.Fun.Pos(),
+ End: call.Fun.End(),
+ NewText: fmt.Appendf(nil, "%sCutPrefix", prefix),
+ },
+ {
+ Pos: call.End(),
+ End: call.End(),
+ NewText: []byte(fmt.Sprintf("; %s ", okVarName)),
+ },
+ {
+ Pos: call1.Pos(),
+ End: call1.End(),
+ NewText: []byte(after),
+ },
+ }...),
+ }}},
+ )
+ break
+ }
+ }
+ }
+
+ // pattern2
+ if bin, ok := ifStmt.Cond.(*ast.BinaryExpr); ok &&
+ bin.Op == token.NEQ &&
+ ifStmt.Init != nil &&
+ isSimpleAssign(ifStmt.Init) {
+ assign := ifStmt.Init.(*ast.AssignStmt)
+ if call, ok := assign.Rhs[0].(*ast.CallExpr); ok && assign.Tok == token.DEFINE {
+ lhs := assign.Lhs[0]
+ obj := typeutil.Callee(info, call)
+ if obj == stringsTrimPrefix &&
+ (equalSyntax(lhs, bin.X) && equalSyntax(call.Args[0], bin.Y) ||
+ (equalSyntax(lhs, bin.Y) && equalSyntax(call.Args[0], bin.X))) {
+ okVarName := analysisinternal.FreshName(info.Scopes[ifStmt], ifStmt.Pos(), "ok")
+ // Have one of:
+ // if rest := TrimPrefix(s, prefix); rest != s {
+ // if rest := TrimPrefix(s, prefix); s != rest {
+
+ // We use AddImport not to add an import (since it exists already)
+ // but to compute the correct prefix in the dot-import case.
+ _, prefix, importEdits := analysisinternal.AddImport(
+ info,
+ curFile.Node().(*ast.File),
+ obj.Pkg().Name(),
+ obj.Pkg().Path(),
+ "CutPrefix",
+ call.Pos(),
+ )
+
+ pass.Report(analysis.Diagnostic{
+ // highlight from the init and the condition end.
+ Pos: ifStmt.Init.Pos(),
+ End: ifStmt.Cond.End(),
+ Category: category,
+ Message: "TrimPrefix can be simplified to CutPrefix",
+ SuggestedFixes: []analysis.SuggestedFix{{
+ Message: fixedMessage,
+ // if x := strings.TrimPrefix(s, pre); x != s ...
+ // ---- ---------- ------
+ // if x, ok := strings.CutPrefix (s, pre); ok ...
+ TextEdits: append(importEdits, []analysis.TextEdit{
+ {
+ Pos: assign.Lhs[0].End(),
+ End: assign.Lhs[0].End(),
+ NewText: fmt.Appendf(nil, ", %s", okVarName),
+ },
+ {
+ Pos: call.Fun.Pos(),
+ End: call.Fun.End(),
+ NewText: fmt.Appendf(nil, "%sCutPrefix", prefix),
+ },
+ {
+ Pos: ifStmt.Cond.Pos(),
+ End: ifStmt.Cond.End(),
+ NewText: []byte(okVarName),
+ },
+ }...),
+ }},
+ })
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/gopls/internal/analysis/modernize/splitseq.go b/gopls/internal/analysis/modernize/stringsseq.go
similarity index 63%
rename from gopls/internal/analysis/modernize/splitseq.go
rename to gopls/internal/analysis/modernize/stringsseq.go
index 1f3da859e9b..d32f8be754f 100644
--- a/gopls/internal/analysis/modernize/splitseq.go
+++ b/gopls/internal/analysis/modernize/stringsseq.go
@@ -5,6 +5,7 @@
package modernize
import (
+ "fmt"
"go/ast"
"go/token"
"go/types"
@@ -13,12 +14,14 @@ import (
"golang.org/x/tools/go/analysis/passes/inspect"
"golang.org/x/tools/go/ast/inspector"
"golang.org/x/tools/go/types/typeutil"
- "golang.org/x/tools/internal/analysisinternal"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
"golang.org/x/tools/internal/astutil/edge"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
)
-// splitseq offers a fix to replace a call to strings.Split with
-// SplitSeq when it is the operand of a range loop, either directly:
+// stringsseq offers a fix to replace a call to strings.Split with
+// SplitSeq or strings.Fields with FieldsSeq
+// when it is the operand of a range loop, either directly:
//
// for _, line := range strings.Split() {...}
//
@@ -29,13 +32,22 @@ import (
//
// Variants:
// - bytes.SplitSeq
-func splitseq(pass *analysis.Pass) {
- if !analysisinternal.Imports(pass.Pkg, "strings") &&
- !analysisinternal.Imports(pass.Pkg, "bytes") {
+// - bytes.FieldsSeq
+func stringsseq(pass *analysis.Pass) {
+ var (
+ inspect = pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+ index = pass.ResultOf[typeindexanalyzer.Analyzer].(*typeindex.Index)
+ info = pass.TypesInfo
+
+ stringsSplit = index.Object("strings", "Split")
+ stringsFields = index.Object("strings", "Fields")
+ bytesSplit = index.Object("bytes", "Split")
+ bytesFields = index.Object("bytes", "Fields")
+ )
+ if !index.Used(stringsSplit, stringsFields, bytesSplit, bytesFields) {
return
}
- info := pass.TypesInfo
- inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+
for curFile := range filesUsing(inspect, info, "go1.24") {
for curRange := range curFile.Preorder((*ast.RangeStmt)(nil)) {
rng := curRange.Node().(*ast.RangeStmt)
@@ -52,14 +64,14 @@ func splitseq(pass *analysis.Pass) {
if !ok {
if id, ok := rng.X.(*ast.Ident); ok {
if v, ok := info.Uses[id].(*types.Var); ok {
- if ek, idx := curRange.Edge(); ek == edge.BlockStmt_List && idx > 0 {
+ if ek, idx := curRange.ParentEdge(); ek == edge.BlockStmt_List && idx > 0 {
curPrev, _ := curRange.PrevSibling()
if assign, ok := curPrev.Node().(*ast.AssignStmt); ok &&
assign.Tok == token.DEFINE &&
len(assign.Lhs) == 1 &&
len(assign.Rhs) == 1 &&
info.Defs[assign.Lhs[0].(*ast.Ident)] == v &&
- soleUse(info, v) == id {
+ soleUseIs(index, v, id) {
// Have:
// lines := ...
// for _, line := range lines {...}
@@ -88,21 +100,26 @@ func splitseq(pass *analysis.Pass) {
})
}
- if sel, ok := call.Fun.(*ast.SelectorExpr); ok &&
- (analysisinternal.IsFunctionNamed(typeutil.Callee(info, call), "strings", "Split") ||
- analysisinternal.IsFunctionNamed(typeutil.Callee(info, call), "bytes", "Split")) {
+ sel, ok := call.Fun.(*ast.SelectorExpr)
+ if !ok {
+ continue
+ }
+
+ switch obj := typeutil.Callee(info, call); obj {
+ case stringsSplit, stringsFields, bytesSplit, bytesFields:
+ oldFnName := obj.Name()
+ seqFnName := fmt.Sprintf("%sSeq", oldFnName)
pass.Report(analysis.Diagnostic{
Pos: sel.Pos(),
End: sel.End(),
- Category: "splitseq",
- Message: "Ranging over SplitSeq is more efficient",
+ Category: "stringsseq",
+ Message: fmt.Sprintf("Ranging over %s is more efficient", seqFnName),
SuggestedFixes: []analysis.SuggestedFix{{
- Message: "Replace Split with SplitSeq",
+ Message: fmt.Sprintf("Replace %s with %s", oldFnName, seqFnName),
TextEdits: append(edits, analysis.TextEdit{
- // Split -> SplitSeq
Pos: sel.Sel.Pos(),
End: sel.Sel.End(),
- NewText: []byte("SplitSeq")}),
+ NewText: []byte(seqFnName)}),
}},
})
}
diff --git a/gopls/internal/analysis/modernize/testdata/src/appendclipped/bytesclone.go b/gopls/internal/analysis/modernize/testdata/src/appendclipped/bytesclone.go
new file mode 100644
index 00000000000..6425211b924
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/appendclipped/bytesclone.go
@@ -0,0 +1,11 @@
+package appendclipped
+
+import (
+ "bytes"
+)
+
+var _ bytes.Buffer
+
+func _(b []byte) {
+ print(append([]byte{}, b...)) // want "Replace append with bytes.Clone"
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/appendclipped/bytesclone.go.golden b/gopls/internal/analysis/modernize/testdata/src/appendclipped/bytesclone.go.golden
new file mode 100644
index 00000000000..f49be6156b2
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/appendclipped/bytesclone.go.golden
@@ -0,0 +1,11 @@
+package appendclipped
+
+import (
+ "bytes"
+)
+
+var _ bytes.Buffer
+
+func _(b []byte) {
+ print(bytes.Clone(b)) // want "Replace append with bytes.Clone"
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/fieldsseq/fieldsseq.go b/gopls/internal/analysis/modernize/testdata/src/fieldsseq/fieldsseq.go
new file mode 100644
index 00000000000..b86df1a8a94
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/fieldsseq/fieldsseq.go
@@ -0,0 +1,42 @@
+//go:build go1.24
+
+package fieldsseq
+
+import (
+ "bytes"
+ "strings"
+)
+
+func _() {
+ for _, line := range strings.Fields("") { // want "Ranging over FieldsSeq is more efficient"
+ println(line)
+ }
+ for i, line := range strings.Fields("") { // nope: uses index var
+ println(i, line)
+ }
+ for i, _ := range strings.Fields("") { // nope: uses index var
+ println(i)
+ }
+ for i := range strings.Fields("") { // nope: uses index var
+ println(i)
+ }
+ for _ = range strings.Fields("") { // want "Ranging over FieldsSeq is more efficient"
+ }
+ for range strings.Fields("") { // want "Ranging over FieldsSeq is more efficient"
+ }
+ for range bytes.Fields(nil) { // want "Ranging over FieldsSeq is more efficient"
+ }
+ {
+ lines := strings.Fields("") // want "Ranging over FieldsSeq is more efficient"
+ for _, line := range lines {
+ println(line)
+ }
+ }
+ {
+ lines := strings.Fields("") // nope: lines is used not just by range
+ for _, line := range lines {
+ println(line)
+ }
+ println(lines)
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/fieldsseq/fieldsseq.go.golden b/gopls/internal/analysis/modernize/testdata/src/fieldsseq/fieldsseq.go.golden
new file mode 100644
index 00000000000..9fa1bfd1b62
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/fieldsseq/fieldsseq.go.golden
@@ -0,0 +1,42 @@
+//go:build go1.24
+
+package fieldsseq
+
+import (
+ "bytes"
+ "strings"
+)
+
+func _() {
+ for line := range strings.FieldsSeq("") { // want "Ranging over FieldsSeq is more efficient"
+ println(line)
+ }
+ for i, line := range strings.Fields( "") { // nope: uses index var
+ println(i, line)
+ }
+ for i, _ := range strings.Fields( "") { // nope: uses index var
+ println(i)
+ }
+ for i := range strings.Fields( "") { // nope: uses index var
+ println(i)
+ }
+ for range strings.FieldsSeq("") { // want "Ranging over FieldsSeq is more efficient"
+ }
+ for range strings.FieldsSeq("") { // want "Ranging over FieldsSeq is more efficient"
+ }
+ for range bytes.FieldsSeq(nil) { // want "Ranging over FieldsSeq is more efficient"
+ }
+ {
+ lines := strings.FieldsSeq("") // want "Ranging over FieldsSeq is more efficient"
+ for line := range lines {
+ println(line)
+ }
+ }
+ {
+ lines := strings.Fields( "") // nope: lines is used not just by range
+ for _, line := range lines {
+ println(line)
+ }
+ println(lines)
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/fieldsseq/fieldsseq_go123.go b/gopls/internal/analysis/modernize/testdata/src/fieldsseq/fieldsseq_go123.go
new file mode 100644
index 00000000000..c2bd314db75
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/fieldsseq/fieldsseq_go123.go
@@ -0,0 +1 @@
+package fieldsseq
diff --git a/gopls/internal/analysis/modernize/testdata/src/fmtappendf/fmtappendf.go b/gopls/internal/analysis/modernize/testdata/src/fmtappendf/fmtappendf.go
index a39a03ee786..a435b6a6461 100644
--- a/gopls/internal/analysis/modernize/testdata/src/fmtappendf/fmtappendf.go
+++ b/gopls/internal/analysis/modernize/testdata/src/fmtappendf/fmtappendf.go
@@ -29,8 +29,8 @@ func typealias() {
}
func otherprints() {
- sprint := []byte(fmt.Sprint("bye %d", 1)) // want "Replace .*Sprintf.* with fmt.Appendf"
+ sprint := []byte(fmt.Sprint("bye %d", 1)) // want "Replace .*Sprint.* with fmt.Append"
print(sprint)
- sprintln := []byte(fmt.Sprintln("bye %d", 1)) // want "Replace .*Sprintf.* with fmt.Appendf"
+ sprintln := []byte(fmt.Sprintln("bye %d", 1)) // want "Replace .*Sprintln.* with fmt.Appendln"
print(sprintln)
}
diff --git a/gopls/internal/analysis/modernize/testdata/src/fmtappendf/fmtappendf.go.golden b/gopls/internal/analysis/modernize/testdata/src/fmtappendf/fmtappendf.go.golden
index 7c8aa7b9a5e..4fd2b136b82 100644
--- a/gopls/internal/analysis/modernize/testdata/src/fmtappendf/fmtappendf.go.golden
+++ b/gopls/internal/analysis/modernize/testdata/src/fmtappendf/fmtappendf.go.golden
@@ -29,8 +29,8 @@ func typealias() {
}
func otherprints() {
- sprint := fmt.Append(nil, "bye %d", 1) // want "Replace .*Sprintf.* with fmt.Appendf"
+ sprint := fmt.Append(nil, "bye %d", 1) // want "Replace .*Sprint.* with fmt.Append"
print(sprint)
- sprintln := fmt.Appendln(nil, "bye %d", 1) // want "Replace .*Sprintf.* with fmt.Appendf"
+ sprintln := fmt.Appendln(nil, "bye %d", 1) // want "Replace .*Sprintln.* with fmt.Appendln"
print(sprintln)
}
\ No newline at end of file
diff --git a/gopls/internal/analysis/modernize/testdata/src/forvar/forvar.go b/gopls/internal/analysis/modernize/testdata/src/forvar/forvar.go
new file mode 100644
index 00000000000..dd5ecd75e29
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/forvar/forvar.go
@@ -0,0 +1,62 @@
+package forvar
+
+func _(m map[int]int, s []int) {
+ // changed
+ for i := range s {
+ i := i // want "copying variable is unneeded"
+ go f(i)
+ }
+ for _, v := range s {
+ v := v // want "copying variable is unneeded"
+ go f(v)
+ }
+ for k, v := range m {
+ k := k // want "copying variable is unneeded"
+ v := v // nope: report only the first redeclaration
+ go f(k)
+ go f(v)
+ }
+ for _, v := range m {
+ v := v // want "copying variable is unneeded"
+ go f(v)
+ }
+ for i := range s {
+ /* hi */ i := i // want "copying variable is unneeded"
+ go f(i)
+ }
+ // nope
+ var i, k, v int
+
+ for i = range s { // nope, scope change
+ i := i
+ go f(i)
+ }
+ for _, v = range s { // nope, scope change
+ v := v
+ go f(v)
+ }
+ for k = range m { // nope, scope change
+ k := k
+ go f(k)
+ }
+ for k, v = range m { // nope, scope change
+ k := k
+ v := v
+ go f(k)
+ go f(v)
+ }
+ for _, v = range m { // nope, scope change
+ v := v
+ go f(v)
+ }
+ for _, v = range m { // nope, not x := x
+ v := i
+ go f(v)
+ }
+ for i := range s {
+ i := (i)
+ go f(i)
+ }
+}
+
+func f(n int) {}
diff --git a/gopls/internal/analysis/modernize/testdata/src/forvar/forvar.go.golden b/gopls/internal/analysis/modernize/testdata/src/forvar/forvar.go.golden
new file mode 100644
index 00000000000..35f71404c35
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/forvar/forvar.go.golden
@@ -0,0 +1,62 @@
+package forvar
+
+func _(m map[int]int, s []int) {
+ // changed
+ for i := range s {
+ // want "copying variable is unneeded"
+ go f(i)
+ }
+ for _, v := range s {
+ // want "copying variable is unneeded"
+ go f(v)
+ }
+ for k, v := range m {
+ // want "copying variable is unneeded"
+ v := v // nope: report only the first redeclaration
+ go f(k)
+ go f(v)
+ }
+ for _, v := range m {
+ // want "copying variable is unneeded"
+ go f(v)
+ }
+ for i := range s {
+ /* hi */ // want "copying variable is unneeded"
+ go f(i)
+ }
+ // nope
+ var i, k, v int
+
+ for i = range s { // nope, scope change
+ i := i
+ go f(i)
+ }
+ for _, v = range s { // nope, scope change
+ v := v
+ go f(v)
+ }
+ for k = range m { // nope, scope change
+ k := k
+ go f(k)
+ }
+ for k, v = range m { // nope, scope change
+ k := k
+ v := v
+ go f(k)
+ go f(v)
+ }
+ for _, v = range m { // nope, scope change
+ v := v
+ go f(v)
+ }
+ for _, v = range m { // nope, not x := x
+ v := i
+ go f(v)
+ }
+ for i := range s {
+ i := (i)
+ go f(i)
+ }
+}
+
+func f(n int) {}
diff --git a/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop.go b/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop.go
index 769b4c84f60..7d0f7d17e91 100644
--- a/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop.go
+++ b/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop.go
@@ -16,6 +16,7 @@ type M map[int]string
func useCopy(dst, src map[int]string) {
// Replace loop by maps.Copy.
for key, value := range src {
+ // A
dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Copy"
}
}
@@ -23,15 +24,45 @@ func useCopy(dst, src map[int]string) {
func useCopyGeneric[K comparable, V any, M ~map[K]V](dst, src M) {
// Replace loop by maps.Copy.
for key, value := range src {
+ // A
dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Copy"
}
}
-func useClone(src map[int]string) {
- // Replace make(...) by maps.Clone.
+func useCopyNotClone(src map[int]string) {
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
+ // Replace make(...) by maps.Copy.
dst := make(map[int]string, len(src))
+ // A
+ for key, value := range src {
+ // B
+ dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Copy"
+ // C
+ }
+
+ // A
+ dst = map[int]string{}
+ // B
for key, value := range src {
- dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Clone"
+ // C
+ dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Copy"
+ }
+ println(dst)
+}
+
+func useCopyParen(src map[int]string) {
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
+ // Replace (make)(...) by maps.Clone.
+ dst := (make)(map[int]string, len(src))
+ for key, value := range src {
+ dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Copy"
+ }
+
+ dst = (map[int]string{})
+ for key, value := range src {
+ dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Copy"
}
println(dst)
}
@@ -55,32 +86,38 @@ func useCopy_typesDiffer2(src map[int]string) {
}
func useClone_typesDiffer3(src map[int]string) {
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
// Replace loop and make(...) as maps.Clone(src) returns map[int]string
// which is assignable to M.
var dst M
dst = make(M, len(src))
for key, value := range src {
- dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Clone"
+ dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Copy"
}
println(dst)
}
func useClone_typesDiffer4(src map[int]string) {
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
// Replace loop and make(...) as maps.Clone(src) returns map[int]string
// which is assignable to M.
var dst M
dst = make(M, len(src))
for key, value := range src {
- dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Clone"
+ dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Copy"
}
println(dst)
}
func useClone_generic[Map ~map[K]V, K comparable, V any](src Map) {
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
// Replace loop and make(...) by maps.Clone
dst := make(Map, len(src))
for key, value := range src {
- dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Clone"
+ dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Copy"
}
println(dst)
}
@@ -97,8 +134,10 @@ func useInsert_assignableToSeq2(dst map[int]string, src func(yield func(int, str
func useCollect(src iter.Seq2[int, string]) {
// Replace loop and make(...) by maps.Collect.
var dst map[int]string
- dst = make(map[int]string)
+ dst = make(map[int]string) // A
+ // B
for key, value := range src {
+ // C
dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Collect"
}
}
@@ -108,7 +147,9 @@ func useInsert_typesDifferAssign(src iter.Seq2[int, string]) {
// that is assignable to M.
var dst M
dst = make(M)
+ // A
for key, value := range src {
+ // B
dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Collect"
}
}
diff --git a/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop.go.golden b/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop.go.golden
index b9aa39021e8..9136105b908 100644
--- a/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop.go.golden
+++ b/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop.go.golden
@@ -15,23 +15,56 @@ type M map[int]string
func useCopy(dst, src map[int]string) {
// Replace loop by maps.Copy.
+ // A
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
maps.Copy(dst, src)
}
func useCopyGeneric[K comparable, V any, M ~map[K]V](dst, src M) {
// Replace loop by maps.Copy.
+ // A
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
maps.Copy(dst, src)
}
-func useClone(src map[int]string) {
- // Replace make(...) by maps.Clone.
- dst := maps.Clone(src)
+func useCopyNotClone(src map[int]string) {
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
+ // Replace make(...) by maps.Copy.
+ dst := make(map[int]string, len(src))
+ // A
+ // B
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
+ // C
+ maps.Copy(dst, src)
+
+ // A
+ dst = map[int]string{}
+ // B
+ // C
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
+ maps.Copy(dst, src)
+ println(dst)
+}
+
+func useCopyParen(src map[int]string) {
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
+ // Replace (make)(...) by maps.Clone.
+ dst := (make)(map[int]string, len(src))
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
+ maps.Copy(dst, src)
+
+ dst = (map[int]string{})
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
+ maps.Copy(dst, src)
println(dst)
}
func useCopy_typesDiffer(src M) {
// Replace loop but not make(...) as maps.Copy(src) would return wrong type M.
dst := make(map[int]string, len(src))
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
maps.Copy(dst, src)
println(dst)
}
@@ -39,29 +72,42 @@ func useCopy_typesDiffer(src M) {
func useCopy_typesDiffer2(src map[int]string) {
// Replace loop but not make(...) as maps.Copy(src) would return wrong type map[int]string.
dst := make(M, len(src))
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
maps.Copy(dst, src)
println(dst)
}
func useClone_typesDiffer3(src map[int]string) {
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
// Replace loop and make(...) as maps.Clone(src) returns map[int]string
// which is assignable to M.
var dst M
- dst = maps.Clone(src)
+ dst = make(M, len(src))
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
+ maps.Copy(dst, src)
println(dst)
}
func useClone_typesDiffer4(src map[int]string) {
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
// Replace loop and make(...) as maps.Clone(src) returns map[int]string
// which is assignable to M.
var dst M
- dst = maps.Clone(src)
+ dst = make(M, len(src))
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
+ maps.Copy(dst, src)
println(dst)
}
func useClone_generic[Map ~map[K]V, K comparable, V any](src Map) {
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
// Replace loop and make(...) by maps.Clone
- dst := maps.Clone(src)
+ dst := make(Map, len(src))
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
+ maps.Copy(dst, src)
println(dst)
}
@@ -69,12 +115,17 @@ func useClone_generic[Map ~map[K]V, K comparable, V any](src Map) {
func useInsert_assignableToSeq2(dst map[int]string, src func(yield func(int, string) bool)) {
// Replace loop by maps.Insert because src is assignable to iter.Seq2.
+ // want "Replace m\\[k\\]=v loop with maps.Insert"
maps.Insert(dst, src)
}
func useCollect(src iter.Seq2[int, string]) {
// Replace loop and make(...) by maps.Collect.
var dst map[int]string
+ // A
+ // B
+ // C
+ // want "Replace m\\[k\\]=v loop with maps.Collect"
dst = maps.Collect(src)
}
@@ -82,6 +133,9 @@ func useInsert_typesDifferAssign(src iter.Seq2[int, string]) {
// Replace loop and make(...): maps.Collect returns an unnamed map type
// that is assignable to M.
var dst M
+ // A
+ // B
+ // want "Replace m\\[k\\]=v loop with maps.Collect"
dst = maps.Collect(src)
}
@@ -89,6 +143,7 @@ func useInsert_typesDifferDeclare(src iter.Seq2[int, string]) {
// Replace loop but not make(...) as maps.Collect would return an
// unnamed map type that would change the type of dst.
dst := make(M)
+ // want "Replace m\\[k\\]=v loop with maps.Insert"
maps.Insert(dst, src)
}
diff --git a/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop_dot.go b/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop_dot.go
index c33d43e23ad..ae28f11afda 100644
--- a/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop_dot.go
+++ b/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop_dot.go
@@ -14,10 +14,12 @@ func useCopyDot(dst, src map[int]string) {
}
func useCloneDot(src map[int]string) {
- // Replace make(...) by maps.Clone.
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
+ // Replace make(...) by maps.Copy.
dst := make(map[int]string, len(src))
for key, value := range src {
- dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Clone"
+ dst[key] = value // want "Replace m\\[k\\]=v loop with maps.Copy"
}
println(dst)
}
diff --git a/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop_dot.go.golden b/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop_dot.go.golden
index d6a30537645..6347d56360a 100644
--- a/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop_dot.go.golden
+++ b/gopls/internal/analysis/modernize/testdata/src/mapsloop/mapsloop_dot.go.golden
@@ -8,12 +8,16 @@ var _ = Clone[M] // force "maps" import so that each diagnostic doesn't add one
func useCopyDot(dst, src map[int]string) {
// Replace loop by maps.Copy.
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
Copy(dst, src)
}
func useCloneDot(src map[int]string) {
- // Replace make(...) by maps.Clone.
- dst := Clone(src)
+ // Clone is tempting but wrong when src may be nil; see #71844.
+
+ // Replace make(...) by maps.Copy.
+ dst := make(map[int]string, len(src))
+ // want "Replace m\\[k\\]=v loop with maps.Copy"
+ Copy(dst, src)
println(dst)
}
-
diff --git a/gopls/internal/analysis/modernize/testdata/src/minmax/minmax.go b/gopls/internal/analysis/modernize/testdata/src/minmax/minmax.go
index c73bd30139b..cdc767450d2 100644
--- a/gopls/internal/analysis/modernize/testdata/src/minmax/minmax.go
+++ b/gopls/internal/analysis/modernize/testdata/src/minmax/minmax.go
@@ -1,9 +1,12 @@
package minmax
func ifmin(a, b int) {
- x := a
+ x := a // A
+ // B
if a < b { // want "if statement can be modernized using max"
- x = b
+ // C
+ x = b // D
+ // E
}
print(x)
}
@@ -33,20 +36,30 @@ func ifmaxvariant(a, b int) {
}
func ifelsemin(a, b int) {
- var x int
+ var x int // A
+ // B
if a <= b { // want "if/else statement can be modernized using min"
- x = a
+ // C
+ x = a // D
+ // E
} else {
- x = b
+ // F
+ x = b // G
+ // H
}
print(x)
}
func ifelsemax(a, b int) {
- var x int
+ // A
+ var x int // B
+ // C
if a >= b { // want "if/else statement can be modernized using max"
- x = a
+ // D
+ x = a // E
+ // F
} else {
+ // G
x = b
}
print(x)
@@ -92,3 +105,54 @@ func nopeAssignHasIncrementOperator() {
}
print(y)
}
+
+// Regression test for https://github.com/golang/go/issues/71721.
+func nopeNotAMinimum(x, y int) int {
+ // A value of -1 or 0 will use a default value (30).
+ if x <= 0 {
+ y = 30
+ } else {
+ y = x
+ }
+ return y
+}
+
+// Regression test for https://github.com/golang/go/issues/71847#issuecomment-2673491596
+func nopeHasElseBlock(x int) int {
+ y := x
+ // Before, this was erroneously reduced to y = max(x, 0)
+ if y < 0 {
+ y = 0
+ } else {
+ y += 2
+ }
+ return y
+}
+
+func fix72727(a, b int) {
+ o := a - 42
+ // some important comment. DO NOT REMOVE.
+ if o < b { // want "if statement can be modernized using max"
+ o = b
+ }
+}
+
+type myfloat float64
+
+// The built-in min/max differ in their treatement of NaN,
+// so reject floating-point numbers (#72829).
+func nopeFloat(a, b myfloat) (res myfloat) {
+ if a < b {
+ res = a
+ } else {
+ res = b
+ }
+ return
+}
+
+// Regression test for golang/go#72928.
+func underscoreAssign(a, b int) {
+ if a > b {
+ _ = a
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/minmax/minmax.go.golden b/gopls/internal/analysis/modernize/testdata/src/minmax/minmax.go.golden
index 11eac2c1418..b7be86bf416 100644
--- a/gopls/internal/analysis/modernize/testdata/src/minmax/minmax.go.golden
+++ b/gopls/internal/analysis/modernize/testdata/src/minmax/minmax.go.golden
@@ -1,33 +1,57 @@
package minmax
func ifmin(a, b int) {
+ // A
+ // B
+ // want "if statement can be modernized using max"
+ // C
+ // D
+ // E
x := max(a, b)
print(x)
}
func ifmax(a, b int) {
+ // want "if statement can be modernized using min"
x := min(a, b)
print(x)
}
func ifminvariant(a, b int) {
+ // want "if statement can be modernized using min"
x := min(a, b)
print(x)
}
func ifmaxvariant(a, b int) {
+ // want "if statement can be modernized using min"
x := min(a, b)
print(x)
}
func ifelsemin(a, b int) {
- var x int
+ var x int // A
+ // B
+ // want "if/else statement can be modernized using min"
+ // C
+ // D
+ // E
+ // F
+ // G
+ // H
x = min(a, b)
print(x)
}
func ifelsemax(a, b int) {
- var x int
+ // A
+ var x int // B
+ // C
+ // want "if/else statement can be modernized using max"
+ // D
+ // E
+ // F
+ // G
x = max(a, b)
print(x)
}
@@ -55,6 +79,7 @@ func nopeIfStmtHasInitStmt() {
// Regression test for a bug: fix was "y := max(x, y)".
func oops() {
x := 1
+ // want "if statement can be modernized using max"
y := max(x, 2)
print(y)
}
@@ -69,3 +94,52 @@ func nopeAssignHasIncrementOperator() {
}
print(y)
}
+
+// Regression test for https://github.com/golang/go/issues/71721.
+func nopeNotAMinimum(x, y int) int {
+ // A value of -1 or 0 will use a default value (30).
+ if x <= 0 {
+ y = 30
+ } else {
+ y = x
+ }
+ return y
+}
+
+// Regression test for https://github.com/golang/go/issues/71847#issuecomment-2673491596
+func nopeHasElseBlock(x int) int {
+ y := x
+ // Before, this was erroneously reduced to y = max(x, 0)
+ if y < 0 {
+ y = 0
+ } else {
+ y += 2
+ }
+ return y
+}
+
+func fix72727(a, b int) {
+ // some important comment. DO NOT REMOVE.
+ // want "if statement can be modernized using max"
+ o := max(a-42, b)
+}
+
+type myfloat float64
+
+// The built-in min/max differ in their treatement of NaN,
+// so reject floating-point numbers (#72829).
+func nopeFloat(a, b myfloat) (res myfloat) {
+ if a < b {
+ res = a
+ } else {
+ res = b
+ }
+ return
+}
+
+// Regression test for golang/go#72928.
+func underscoreAssign(a, b int) {
+ if a > b {
+ _ = a
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/rangeint/rangeint.go b/gopls/internal/analysis/modernize/testdata/src/rangeint/rangeint.go
index e17dccac9d0..74f3488546c 100644
--- a/gopls/internal/analysis/modernize/testdata/src/rangeint/rangeint.go
+++ b/gopls/internal/analysis/modernize/testdata/src/rangeint/rangeint.go
@@ -1,16 +1,74 @@
package rangeint
-func _(i int, s struct{ i int }) {
+import (
+ "os"
+ os1 "os"
+)
+
+func _(i int, s struct{ i int }, slice []int) {
for i := 0; i < 10; i++ { // want "for loop can be modernized using range over int"
println(i)
}
- for i = 0; i < f(); i++ { // want "for loop can be modernized using range over int"
+ for j := int(0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := int8(0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := int16(0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := int32(0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := int64(0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := uint8(0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := uint16(0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := uint32(0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := uint64(0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := int8(0.); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := int8(.0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := os.FileMode(0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+
+ {
+ var i int
+ for i = 0; i < 10; i++ { // want "for loop can be modernized using range over int"
+ }
+ // NB: no uses of i after loop.
}
for i := 0; i < 10; i++ { // want "for loop can be modernized using range over int"
// i unused within loop
}
+ for i := 0; i < len(slice); i++ { // want "for loop can be modernized using range over int"
+ println(slice[i])
+ }
+ for i := 0; i < len(""); i++ { // want "for loop can be modernized using range over int"
+ // NB: not simplified to range ""
+ }
// nope
+ for j := .0; j < 10; j++ { // nope: j is a float type
+ println(j)
+ }
+ for j := float64(0); j < 10; j++ { // nope: j is a float type
+ println(j)
+ }
for i := 0; i < 10; { // nope: missing increment
}
for i := 0; i < 10; i-- { // nope: negative increment
@@ -32,6 +90,144 @@ func _(i int, s struct{ i int }) {
for i := 0; i < 10; i++ { // nope: assigns i
i = 8
}
+
+ // The limit expression must be loop invariant;
+ // see https://github.com/golang/go/issues/72917
+ for i := 0; i < f(); i++ { // nope
+ }
+ {
+ var s struct{ limit int }
+ for i := 0; i < s.limit; i++ { // nope: limit is not a const or local var
+ }
+ }
+ {
+ const k = 10
+ for i := 0; i < k; i++ { // want "for loop can be modernized using range over int"
+ }
+ }
+ {
+ var limit = 10
+ for i := 0; i < limit; i++ { // want "for loop can be modernized using range over int"
+ }
+ }
+ {
+ var limit = 10
+ for i := 0; i < limit; i++ { // nope: limit is address-taken
+ }
+ print(&limit)
+ }
+ {
+ limit := 10
+ limit++
+ for i := 0; i < limit; i++ { // nope: limit is assigned other than by its declaration
+ }
+ }
+ for i := 0; i < Global; i++ { // nope: limit is an exported global var; may be updated elsewhere
+ }
+ for i := 0; i < len(table); i++ { // want "for loop can be modernized using range over int"
+ }
+ {
+ s := []string{}
+ for i := 0; i < len(s); i++ { // nope: limit is not loop-invariant
+ s = s[1:]
+ }
+ }
+ for i := 0; i < len(slice); i++ { // nope: i is incremented within loop
+ i += 1
+ }
}
+var Global int
+
+var table = []string{"hello", "world"}
+
func f() int { return 0 }
+
+// Repro for part of #71847: ("for range n is invalid if the loop body contains i++"):
+func _(s string) {
+ var i int // (this is necessary)
+ for i = 0; i < len(s); i++ { // nope: loop body increments i
+ if true {
+ i++ // nope
+ }
+ }
+}
+
+// Repro for #71952: for and range loops have different final values
+// on i (n and n-1, respectively) so we can't offer the fix if i is
+// used after the loop.
+func nopePostconditionDiffers() {
+ i := 0
+ for i = 0; i < 5; i++ {
+ println(i)
+ }
+ println(i) // must print 5, not 4
+}
+
+// Non-integer untyped constants need to be explicitly converted to int.
+func issue71847d() {
+ const limit = 1e3 // float
+ for i := 0; i < limit; i++ { // want "for loop can be modernized using range over int"
+ }
+ for i := int(0); i < limit; i++ { // want "for loop can be modernized using range over int"
+ }
+ for i := uint(0); i < limit; i++ { // want "for loop can be modernized using range over int"
+ }
+
+ const limit2 = 1 + 0i // complex
+ for i := 0; i < limit2; i++ { // want "for loop can be modernized using range over int"
+ }
+}
+
+func issue72726() {
+ var n, kd int
+ for i := 0; i < n; i++ { // want "for loop can be modernized using range over int"
+ // nope: j will be invisible once it's refactored to 'for j := range min(n-j, kd+1)'
+ for j := 0; j < min(n-j, kd+1); j++ { // nope
+ _, _ = i, j
+ }
+ }
+
+ for i := 0; i < i; i++ { // nope
+ }
+
+ var i int
+ for i = 0; i < i/2; i++ { // nope
+ }
+
+ var arr []int
+ for i = 0; i < arr[i]; i++ { // nope
+ }
+}
+
+func todo() {
+ for j := os1.FileMode(0); j < 10; j++ { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+}
+
+type T uint
+type TAlias = uint
+
+func Fn(a int) T {
+ return T(a)
+}
+
+func issue73037() {
+ var q T
+ for a := T(0); a < q; a++ { // want "for loop can be modernized using range over int"
+ println(a)
+ }
+ for a := Fn(0); a < q; a++ {
+ println(a)
+ }
+ var qa TAlias
+ for a := TAlias(0); a < qa; a++ { // want "for loop can be modernized using range over int"
+ println(a)
+ }
+ for a := T(0); a < 10; a++ { // want "for loop can be modernized using range over int"
+ for b := T(0); b < 10; b++ { // want "for loop can be modernized using range over int"
+ println(a, b)
+ }
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/rangeint/rangeint.go.golden b/gopls/internal/analysis/modernize/testdata/src/rangeint/rangeint.go.golden
index 5a76229c858..cdd2f118997 100644
--- a/gopls/internal/analysis/modernize/testdata/src/rangeint/rangeint.go.golden
+++ b/gopls/internal/analysis/modernize/testdata/src/rangeint/rangeint.go.golden
@@ -1,16 +1,74 @@
package rangeint
-func _(i int, s struct{ i int }) {
+import (
+ "os"
+ os1 "os"
+)
+
+func _(i int, s struct{ i int }, slice []int) {
for i := range 10 { // want "for loop can be modernized using range over int"
println(i)
}
- for i = range f() { // want "for loop can be modernized using range over int"
+ for j := range 10 { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := range int8(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := range int16(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := range int32(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := range int64(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := range uint8(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := range uint16(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := range uint32(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := range uint64(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := range int8(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := range int8(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+ for j := range os.FileMode(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+
+ {
+ var i int
+ for i = range 10 { // want "for loop can be modernized using range over int"
+ }
+ // NB: no uses of i after loop.
}
for range 10 { // want "for loop can be modernized using range over int"
// i unused within loop
}
+ for i := range slice { // want "for loop can be modernized using range over int"
+ println(slice[i])
+ }
+ for range len("") { // want "for loop can be modernized using range over int"
+ // NB: not simplified to range ""
+ }
// nope
+ for j := .0; j < 10; j++ { // nope: j is a float type
+ println(j)
+ }
+ for j := float64(0); j < 10; j++ { // nope: j is a float type
+ println(j)
+ }
for i := 0; i < 10; { // nope: missing increment
}
for i := 0; i < 10; i-- { // nope: negative increment
@@ -32,6 +90,144 @@ func _(i int, s struct{ i int }) {
for i := 0; i < 10; i++ { // nope: assigns i
i = 8
}
+
+ // The limit expression must be loop invariant;
+ // see https://github.com/golang/go/issues/72917
+ for i := 0; i < f(); i++ { // nope
+ }
+ {
+ var s struct{ limit int }
+ for i := 0; i < s.limit; i++ { // nope: limit is not a const or local var
+ }
+ }
+ {
+ const k = 10
+ for range k { // want "for loop can be modernized using range over int"
+ }
+ }
+ {
+ var limit = 10
+ for range limit { // want "for loop can be modernized using range over int"
+ }
+ }
+ {
+ var limit = 10
+ for i := 0; i < limit; i++ { // nope: limit is address-taken
+ }
+ print(&limit)
+ }
+ {
+ limit := 10
+ limit++
+ for i := 0; i < limit; i++ { // nope: limit is assigned other than by its declaration
+ }
+ }
+ for i := 0; i < Global; i++ { // nope: limit is an exported global var; may be updated elsewhere
+ }
+ for range table { // want "for loop can be modernized using range over int"
+ }
+ {
+ s := []string{}
+ for i := 0; i < len(s); i++ { // nope: limit is not loop-invariant
+ s = s[1:]
+ }
+ }
+ for i := 0; i < len(slice); i++ { // nope: i is incremented within loop
+ i += 1
+ }
}
+var Global int
+
+var table = []string{"hello", "world"}
+
func f() int { return 0 }
+
+// Repro for part of #71847: ("for range n is invalid if the loop body contains i++"):
+func _(s string) {
+ var i int // (this is necessary)
+ for i = 0; i < len(s); i++ { // nope: loop body increments i
+ if true {
+ i++ // nope
+ }
+ }
+}
+
+// Repro for #71952: for and range loops have different final values
+// on i (n and n-1, respectively) so we can't offer the fix if i is
+// used after the loop.
+func nopePostconditionDiffers() {
+ i := 0
+ for i = 0; i < 5; i++ {
+ println(i)
+ }
+ println(i) // must print 5, not 4
+}
+
+// Non-integer untyped constants need to be explicitly converted to int.
+func issue71847d() {
+ const limit = 1e3 // float
+ for range int(limit) { // want "for loop can be modernized using range over int"
+ }
+ for range int(limit) { // want "for loop can be modernized using range over int"
+ }
+ for range uint(limit) { // want "for loop can be modernized using range over int"
+ }
+
+ const limit2 = 1 + 0i // complex
+ for range int(limit2) { // want "for loop can be modernized using range over int"
+ }
+}
+
+func issue72726() {
+ var n, kd int
+ for i := range n { // want "for loop can be modernized using range over int"
+ // nope: j will be invisible once it's refactored to 'for j := range min(n-j, kd+1)'
+ for j := 0; j < min(n-j, kd+1); j++ { // nope
+ _, _ = i, j
+ }
+ }
+
+ for i := 0; i < i; i++ { // nope
+ }
+
+ var i int
+ for i = 0; i < i/2; i++ { // nope
+ }
+
+ var arr []int
+ for i = 0; i < arr[i]; i++ { // nope
+ }
+}
+
+func todo() {
+ for j := range os.FileMode(10) { // want "for loop can be modernized using range over int"
+ println(j)
+ }
+}
+
+type T uint
+type TAlias = uint
+
+func Fn(a int) T {
+ return T(a)
+}
+
+func issue73037() {
+ var q T
+ for a := range q { // want "for loop can be modernized using range over int"
+ println(a)
+ }
+ for a := Fn(0); a < q; a++ {
+ println(a)
+ }
+ var qa TAlias
+ for a := range qa { // want "for loop can be modernized using range over int"
+ println(a)
+ }
+ for a := range T(10) { // want "for loop can be modernized using range over int"
+ for b := range T(10) { // want "for loop can be modernized using range over int"
+ println(a, b)
+ }
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/slicesdelete/slicesdelete.go b/gopls/internal/analysis/modernize/testdata/src/slicesdelete/slicesdelete.go
index a710d06f2fe..0ee608d8f9f 100644
--- a/gopls/internal/analysis/modernize/testdata/src/slicesdelete/slicesdelete.go
+++ b/gopls/internal/analysis/modernize/testdata/src/slicesdelete/slicesdelete.go
@@ -2,6 +2,10 @@ package slicesdelete
var g struct{ f []int }
+func h() []int { return []int{} }
+
+var ch chan []int
+
func slicesdelete(test, other []byte, i int) {
const k = 1
_ = append(test[:i], test[i+1:]...) // want "Replace append with slices.Delete"
@@ -26,6 +30,10 @@ func slicesdelete(test, other []byte, i int) {
_ = append(g.f[:i], g.f[i+k:]...) // want "Replace append with slices.Delete"
+ _ = append(h()[:i], h()[i+1:]...) // potentially has side effects
+
+ _ = append((<-ch)[:i], (<-ch)[i+1:]...) // has side effects
+
_ = append(test[:3], test[i+1:]...) // cannot verify a < b
_ = append(test[:i-4], test[i-1:]...) // want "Replace append with slices.Delete"
diff --git a/gopls/internal/analysis/modernize/testdata/src/slicesdelete/slicesdelete.go.golden b/gopls/internal/analysis/modernize/testdata/src/slicesdelete/slicesdelete.go.golden
index 9b2ba9a0b80..a15eb07dee9 100644
--- a/gopls/internal/analysis/modernize/testdata/src/slicesdelete/slicesdelete.go.golden
+++ b/gopls/internal/analysis/modernize/testdata/src/slicesdelete/slicesdelete.go.golden
@@ -2,51 +2,45 @@ package slicesdelete
import "slices"
-import "slices"
-
-import "slices"
-
-import "slices"
-
-import "slices"
+var g struct{ f []int }
-import "slices"
+func h() []int { return []int{} }
-import "slices"
+var ch chan []int
-import "slices"
+func slicesdelete(test, other []byte, i int) {
+ const k = 1
+ _ = slices.Delete(test, i, i+1) // want "Replace append with slices.Delete"
-var g struct{ f []int }
+ _ = slices.Delete(test, i+1, i+2) // want "Replace append with slices.Delete"
-func slicesdelete(test, other []byte, i int) {
- const k = 1
- _ = slices.Delete(test, i, i+1) // want "Replace append with slices.Delete"
+ _ = append(test[:i+1], test[i+1:]...) // not deleting any slice elements
- _ = slices.Delete(test, i+1, i+2) // want "Replace append with slices.Delete"
+ _ = append(test[:i], test[i-1:]...) // not deleting any slice elements
- _ = append(test[:i+1], test[i+1:]...) // not deleting any slice elements
+ _ = slices.Delete(test, i-1, i) // want "Replace append with slices.Delete"
- _ = append(test[:i], test[i-1:]...) // not deleting any slice elements
+ _ = slices.Delete(test, i-2, i+1) // want "Replace append with slices.Delete"
- _ = slices.Delete(test, i-1, i) // want "Replace append with slices.Delete"
+ _ = append(test[:i-2], other[i+1:]...) // different slices "test" and "other"
- _ = slices.Delete(test, i-2, i+1) // want "Replace append with slices.Delete"
+ _ = append(test[:i-2], other[i+1+k:]...) // cannot verify a < b
- _ = append(test[:i-2], other[i+1:]...) // different slices "test" and "other"
+ _ = append(test[:i-2], test[11:]...) // cannot verify a < b
- _ = append(test[:i-2], other[i+1+k:]...) // cannot verify a < b
+ _ = slices.Delete(test, 1, 3) // want "Replace append with slices.Delete"
- _ = append(test[:i-2], test[11:]...) // cannot verify a < b
+ _ = slices.Delete(g.f, i, i+k) // want "Replace append with slices.Delete"
- _ = slices.Delete(test, 1, 3) // want "Replace append with slices.Delete"
+ _ = append(h()[:i], h()[i+1:]...) // potentially has side effects
- _ = slices.Delete(g.f, i, i+k) // want "Replace append with slices.Delete"
+ _ = append((<-ch)[:i], (<-ch)[i+1:]...) // has side effects
- _ = append(test[:3], test[i+1:]...) // cannot verify a < b
+ _ = append(test[:3], test[i+1:]...) // cannot verify a < b
- _ = slices.Delete(test, i-4, i-1) // want "Replace append with slices.Delete"
+ _ = slices.Delete(test, i-4, i-1) // want "Replace append with slices.Delete"
- _ = slices.Delete(test, 1+2, 3+4) // want "Replace append with slices.Delete"
+ _ = slices.Delete(test, 1+2, 3+4) // want "Replace append with slices.Delete"
- _ = append(test[:1+2], test[i-1:]...) // cannot verify a < b
-}
\ No newline at end of file
+ _ = append(test[:1+2], test[i-1:]...) // cannot verify a < b
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/sortslice/sortslice.go b/gopls/internal/analysis/modernize/testdata/src/sortslice/sortslice.go
index 53d15746839..19242065b24 100644
--- a/gopls/internal/analysis/modernize/testdata/src/sortslice/sortslice.go
+++ b/gopls/internal/analysis/modernize/testdata/src/sortslice/sortslice.go
@@ -20,6 +20,16 @@ func _(s []int) {
sort.Slice(s, func(i, j int) bool { return s[j] < s[i] }) // nope: wrong index var
}
-func _(s2 []struct{ x int }) {
+func _(sense bool, s2 []struct{ x int }) {
sort.Slice(s2, func(i, j int) bool { return s2[i].x < s2[j].x }) // nope: not a simple index operation
+
+ // Regression test for a crash: the sole statement of a
+ // comparison func body is not necessarily a return!
+ sort.Slice(s2, func(i, j int) bool {
+ if sense {
+ return s2[i].x < s2[j].x
+ } else {
+ return s2[i].x > s2[j].x
+ }
+ })
}
diff --git a/gopls/internal/analysis/modernize/testdata/src/sortslice/sortslice.go.golden b/gopls/internal/analysis/modernize/testdata/src/sortslice/sortslice.go.golden
index d97636fd311..19149b4480a 100644
--- a/gopls/internal/analysis/modernize/testdata/src/sortslice/sortslice.go.golden
+++ b/gopls/internal/analysis/modernize/testdata/src/sortslice/sortslice.go.golden
@@ -2,8 +2,6 @@ package sortslice
import "slices"
-import "slices"
-
import "sort"
type myint int
@@ -24,6 +22,16 @@ func _(s []int) {
sort.Slice(s, func(i, j int) bool { return s[j] < s[i] }) // nope: wrong index var
}
-func _(s2 []struct{ x int }) {
+func _(sense bool, s2 []struct{ x int }) {
sort.Slice(s2, func(i, j int) bool { return s2[i].x < s2[j].x }) // nope: not a simple index operation
+
+ // Regression test for a crash: the sole statement of a
+ // comparison func body is not necessarily a return!
+ sort.Slice(s2, func(i, j int) bool {
+ if sense {
+ return s2[i].x < s2[j].x
+ } else {
+ return s2[i].x > s2[j].x
+ }
+ })
}
diff --git a/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix.go b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix.go
new file mode 100644
index 00000000000..7c5363e6c8d
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix.go
@@ -0,0 +1,16 @@
+package bytescutprefix
+
+import (
+ "bytes"
+)
+
+func _() {
+ if bytes.HasPrefix(bss, bspre) { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := bytes.TrimPrefix(bss, bspre)
+ _ = a
+ }
+ if bytes.HasPrefix([]byte(""), []byte("")) { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := bytes.TrimPrefix([]byte(""), []byte(""))
+ _ = a
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix.go.golden b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix.go.golden
new file mode 100644
index 00000000000..8d41a8bf343
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix.go.golden
@@ -0,0 +1,16 @@
+package bytescutprefix
+
+import (
+ "bytes"
+)
+
+func _() {
+ if after, ok := bytes.CutPrefix(bss, bspre); ok { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := after
+ _ = a
+ }
+ if after, ok := bytes.CutPrefix([]byte(""), []byte("")); ok { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := after
+ _ = a
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix_dot.go b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix_dot.go
new file mode 100644
index 00000000000..bfde6b7a461
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix_dot.go
@@ -0,0 +1,15 @@
+package bytescutprefix
+
+import (
+ . "bytes"
+)
+
+var bss, bspre []byte
+
+// test supported cases of pattern 1
+func _() {
+ if HasPrefix(bss, bspre) { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := TrimPrefix(bss, bspre)
+ _ = a
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix_dot.go.golden b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix_dot.go.golden
new file mode 100644
index 00000000000..8eb562e7940
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/bytescutprefix/bytescutprefix_dot.go.golden
@@ -0,0 +1,15 @@
+package bytescutprefix
+
+import (
+ . "bytes"
+)
+
+var bss, bspre []byte
+
+// test supported cases of pattern 1
+func _() {
+ if after, ok := CutPrefix(bss, bspre); ok { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := after
+ _ = a
+ }
+}
\ No newline at end of file
diff --git a/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix.go b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix.go
new file mode 100644
index 00000000000..7679bdb6e67
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix.go
@@ -0,0 +1,124 @@
+package stringscutprefix
+
+import (
+ "strings"
+)
+
+var (
+ s, pre string
+)
+
+// test supported cases of pattern 1
+func _() {
+ if strings.HasPrefix(s, pre) { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := strings.TrimPrefix(s, pre)
+ _ = a
+ }
+ if strings.HasPrefix("", "") { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := strings.TrimPrefix("", "")
+ _ = a
+ }
+ if strings.HasPrefix(s, "") { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ println([]byte(strings.TrimPrefix(s, "")))
+ }
+ if strings.HasPrefix(s, "") { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a, b := "", strings.TrimPrefix(s, "")
+ _, _ = a, b
+ }
+ if strings.HasPrefix(s, "") { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a, b := strings.TrimPrefix(s, ""), strings.TrimPrefix(s, "") // only replace the first occurrence
+ s = "123"
+ b = strings.TrimPrefix(s, "") // only replace the first occurrence
+ _, _ = a, b
+ }
+
+ var a, b string
+ if strings.HasPrefix(s, "") { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a, b = "", strings.TrimPrefix(s, "")
+ _, _ = a, b
+ }
+}
+
+// test cases that are not supported by pattern1
+func _() {
+ ok := strings.HasPrefix("", "")
+ if ok { // noop, currently it doesn't track the result usage of HasPrefix
+ a := strings.TrimPrefix("", "")
+ _ = a
+ }
+ if strings.HasPrefix(s, pre) {
+ a := strings.TrimPrefix("", "") // noop, as the argument isn't the same
+ _ = a
+ }
+ if strings.HasPrefix(s, pre) {
+ var result string
+ result = strings.TrimPrefix("", "") // noop, as we believe define is more popular.
+ _ = result
+ }
+ if strings.HasPrefix("", "") {
+ a := strings.TrimPrefix(s, pre) // noop, as the argument isn't the same
+ _ = a
+ }
+}
+
+var value0 string
+
+// test supported cases of pattern2
+func _() {
+ if after := strings.TrimPrefix(s, pre); after != s { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+ if after := strings.TrimPrefix(s, pre); s != after { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+ if after := strings.TrimPrefix(s, pre); s != after { // want "TrimPrefix can be simplified to CutPrefix"
+ println(strings.TrimPrefix(s, pre)) // noop here
+ }
+ if after := strings.TrimPrefix(s, ""); s != after { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+ var ok bool // define an ok variable to test the fix won't shadow it for its if stmt body
+ _ = ok
+ if after := strings.TrimPrefix(s, pre); after != s { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+ var predefined string
+ if predefined = strings.TrimPrefix(s, pre); s != predefined { // noop
+ println(predefined)
+ }
+ if predefined = strings.TrimPrefix(s, pre); s != predefined { // noop
+ println(&predefined)
+ }
+ var value string
+ if value = strings.TrimPrefix(s, pre); s != value { // noop
+ println(value)
+ }
+ lhsMap := make(map[string]string)
+ if lhsMap[""] = strings.TrimPrefix(s, pre); s != lhsMap[""] { // noop
+ println(lhsMap[""])
+ }
+ arr := make([]string, 0)
+ if arr[0] = strings.TrimPrefix(s, pre); s != arr[0] { // noop
+ println(arr[0])
+ }
+ type example struct {
+ field string
+ }
+ var e example
+ if e.field = strings.TrimPrefix(s, pre); s != e.field { // noop
+ println(e.field)
+ }
+}
+
+// test cases that not supported by pattern2
+func _() {
+ if after := strings.TrimPrefix(s, pre); s != pre { // noop
+ println(after)
+ }
+ if after := strings.TrimPrefix(s, pre); after != pre { // noop
+ println(after)
+ }
+ if strings.TrimPrefix(s, pre) != s {
+ println(strings.TrimPrefix(s, pre))
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix.go.golden b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix.go.golden
new file mode 100644
index 00000000000..a6c52b08802
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix.go.golden
@@ -0,0 +1,124 @@
+package stringscutprefix
+
+import (
+ "strings"
+)
+
+var (
+ s, pre string
+)
+
+// test supported cases of pattern 1
+func _() {
+ if after, ok := strings.CutPrefix(s, pre); ok { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := after
+ _ = a
+ }
+ if after, ok := strings.CutPrefix("", ""); ok { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := after
+ _ = a
+ }
+ if after, ok := strings.CutPrefix(s, ""); ok { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ println([]byte(after))
+ }
+ if after, ok := strings.CutPrefix(s, ""); ok { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a, b := "", after
+ _, _ = a, b
+ }
+ if after, ok := strings.CutPrefix(s, ""); ok { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a, b := after, strings.TrimPrefix(s, "") // only replace the first occurrence
+ s = "123"
+ b = strings.TrimPrefix(s, "") // only replace the first occurrence
+ _, _ = a, b
+ }
+
+ var a, b string
+ if after, ok := strings.CutPrefix(s, ""); ok { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a, b = "", after
+ _, _ = a, b
+ }
+}
+
+// test cases that are not supported by pattern1
+func _() {
+ ok := strings.HasPrefix("", "")
+ if ok { // noop, currently it doesn't track the result usage of HasPrefix
+ a := strings.TrimPrefix("", "")
+ _ = a
+ }
+ if strings.HasPrefix(s, pre) {
+ a := strings.TrimPrefix("", "") // noop, as the argument isn't the same
+ _ = a
+ }
+ if strings.HasPrefix(s, pre) {
+ var result string
+ result = strings.TrimPrefix("", "") // noop, as we believe define is more popular.
+ _ = result
+ }
+ if strings.HasPrefix("", "") {
+ a := strings.TrimPrefix(s, pre) // noop, as the argument isn't the same
+ _ = a
+ }
+}
+
+var value0 string
+
+// test supported cases of pattern2
+func _() {
+ if after, ok := strings.CutPrefix(s, pre); ok { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+ if after, ok := strings.CutPrefix(s, pre); ok { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+ if after, ok := strings.CutPrefix(s, pre); ok { // want "TrimPrefix can be simplified to CutPrefix"
+ println(strings.TrimPrefix(s, pre)) // noop here
+ }
+ if after, ok := strings.CutPrefix(s, ""); ok { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+ var ok bool // define an ok variable to test the fix won't shadow it for its if stmt body
+ _ = ok
+ if after, ok0 := strings.CutPrefix(s, pre); ok0 { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+ var predefined string
+ if predefined = strings.TrimPrefix(s, pre); s != predefined { // noop
+ println(predefined)
+ }
+ if predefined = strings.TrimPrefix(s, pre); s != predefined { // noop
+ println(&predefined)
+ }
+ var value string
+ if value = strings.TrimPrefix(s, pre); s != value { // noop
+ println(value)
+ }
+ lhsMap := make(map[string]string)
+ if lhsMap[""] = strings.TrimPrefix(s, pre); s != lhsMap[""] { // noop
+ println(lhsMap[""])
+ }
+ arr := make([]string, 0)
+ if arr[0] = strings.TrimPrefix(s, pre); s != arr[0] { // noop
+ println(arr[0])
+ }
+ type example struct {
+ field string
+ }
+ var e example
+ if e.field = strings.TrimPrefix(s, pre); s != e.field { // noop
+ println(e.field)
+ }
+}
+
+// test cases that not supported by pattern2
+func _() {
+ if after := strings.TrimPrefix(s, pre); s != pre { // noop
+ println(after)
+ }
+ if after := strings.TrimPrefix(s, pre); after != pre { // noop
+ println(after)
+ }
+ if strings.TrimPrefix(s, pre) != s {
+ println(strings.TrimPrefix(s, pre))
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix_dot.go b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix_dot.go
new file mode 100644
index 00000000000..75ce5bbe39b
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix_dot.go
@@ -0,0 +1,23 @@
+package stringscutprefix
+
+import (
+ . "strings"
+)
+
+// test supported cases of pattern 1
+func _() {
+ if HasPrefix(s, pre) { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := TrimPrefix(s, pre)
+ _ = a
+ }
+}
+
+// test supported cases of pattern2
+func _() {
+ if after := TrimPrefix(s, pre); after != s { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+ if after := TrimPrefix(s, pre); s != after { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix_dot.go.golden b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix_dot.go.golden
new file mode 100644
index 00000000000..50e3b6ff0ca
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/stringscutprefix/stringscutprefix_dot.go.golden
@@ -0,0 +1,23 @@
+package stringscutprefix
+
+import (
+ . "strings"
+)
+
+// test supported cases of pattern 1
+func _() {
+ if after, ok := CutPrefix(s, pre); ok { // want "HasPrefix \\+ TrimPrefix can be simplified to CutPrefix"
+ a := after
+ _ = a
+ }
+}
+
+// test supported cases of pattern2
+func _() {
+ if after, ok := CutPrefix(s, pre); ok { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+ if after, ok := CutPrefix(s, pre); ok { // want "TrimPrefix can be simplified to CutPrefix"
+ println(after)
+ }
+}
\ No newline at end of file
diff --git a/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup.go b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup.go
new file mode 100644
index 00000000000..8269235bda7
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup.go
@@ -0,0 +1,152 @@
+package waitgroup
+
+import (
+ "fmt"
+ "sync"
+)
+
+// supported case for pattern 1.
+func _() {
+ var wg sync.WaitGroup
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ defer wg.Done()
+ fmt.Println()
+ }()
+
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ defer wg.Done()
+ }()
+
+ for range 10 {
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ defer wg.Done()
+ fmt.Println()
+ }()
+ }
+}
+
+// supported case for pattern 2.
+func _() {
+ var wg sync.WaitGroup
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ fmt.Println()
+ wg.Done()
+ }()
+
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ wg.Done()
+ }()
+
+ for range 10 {
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ fmt.Println()
+ wg.Done()
+ }()
+ }
+}
+
+// this function puts some wrong usages but waitgroup modernizer will still offer fixes.
+func _() {
+ var wg sync.WaitGroup
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ defer wg.Done()
+ defer wg.Done()
+ fmt.Println()
+ }()
+
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ defer wg.Done()
+ fmt.Println()
+ wg.Done()
+ }()
+
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ fmt.Println()
+ wg.Done()
+ wg.Done()
+ }()
+}
+
+// this function puts the unsupported cases of pattern 1.
+func _() {
+ var wg sync.WaitGroup
+ wg.Add(1)
+ go func() {}()
+
+ wg.Add(1)
+ go func(i int) {
+ defer wg.Done()
+ fmt.Println(i)
+ }(1)
+
+ wg.Add(1)
+ go func() {
+ fmt.Println()
+ defer wg.Done()
+ }()
+
+ wg.Add(1)
+ go func() { // noop: no wg.Done call inside function body.
+ fmt.Println()
+ }()
+
+ go func() { // noop: no Add call before this go stmt.
+ defer wg.Done()
+ fmt.Println()
+ }()
+
+ wg.Add(2) // noop: only support Add(1).
+ go func() {
+ defer wg.Done()
+ }()
+
+ var wg1 sync.WaitGroup
+ wg1.Add(1) // noop: Add and Done should be the same object.
+ go func() {
+ defer wg.Done()
+ fmt.Println()
+ }()
+
+ wg.Add(1) // noop: Add and Done should be the same object.
+ go func() {
+ defer wg1.Done()
+ fmt.Println()
+ }()
+}
+
+// this function puts the unsupported cases of pattern 2.
+func _() {
+ var wg sync.WaitGroup
+ wg.Add(1)
+ go func() {
+ wg.Done()
+ fmt.Println()
+ }()
+
+ go func() { // noop: no Add call before this go stmt.
+ fmt.Println()
+ wg.Done()
+ }()
+
+ var wg1 sync.WaitGroup
+ wg1.Add(1) // noop: Add and Done should be the same object.
+ go func() {
+ fmt.Println()
+ wg.Done()
+ }()
+
+ wg.Add(1) // noop: Add and Done should be the same object.
+ go func() {
+ fmt.Println()
+ wg1.Done()
+ }()
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup.go.golden b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup.go.golden
new file mode 100644
index 00000000000..dd98429da0d
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup.go.golden
@@ -0,0 +1,143 @@
+package waitgroup
+
+import (
+ "fmt"
+ "sync"
+)
+
+// supported case for pattern 1.
+func _() {
+ var wg sync.WaitGroup
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ fmt.Println()
+ })
+
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ })
+
+ for range 10 {
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ fmt.Println()
+ })
+ }
+}
+
+// supported case for pattern 2.
+func _() {
+ var wg sync.WaitGroup
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ fmt.Println()
+ })
+
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ })
+
+ for range 10 {
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ fmt.Println()
+ })
+ }
+}
+
+// this function puts some wrong usages but waitgroup modernizer will still offer fixes.
+func _() {
+ var wg sync.WaitGroup
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ defer wg.Done()
+ fmt.Println()
+ })
+
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ fmt.Println()
+ wg.Done()
+ })
+
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ fmt.Println()
+ wg.Done()
+ })
+}
+
+// this function puts the unsupported cases of pattern 1.
+func _() {
+ var wg sync.WaitGroup
+ wg.Add(1)
+ go func() {}()
+
+ wg.Add(1)
+ go func(i int) {
+ defer wg.Done()
+ fmt.Println(i)
+ }(1)
+
+ wg.Add(1)
+ go func() {
+ fmt.Println()
+ defer wg.Done()
+ }()
+
+ wg.Add(1)
+ go func() { // noop: no wg.Done call inside function body.
+ fmt.Println()
+ }()
+
+ go func() { // noop: no Add call before this go stmt.
+ defer wg.Done()
+ fmt.Println()
+ }()
+
+ wg.Add(2) // noop: only support Add(1).
+ go func() {
+ defer wg.Done()
+ }()
+
+ var wg1 sync.WaitGroup
+ wg1.Add(1) // noop: Add and Done should be the same object.
+ go func() {
+ defer wg.Done()
+ fmt.Println()
+ }()
+
+ wg.Add(1) // noop: Add and Done should be the same object.
+ go func() {
+ defer wg1.Done()
+ fmt.Println()
+ }()
+}
+
+// this function puts the unsupported cases of pattern 2.
+func _() {
+ var wg sync.WaitGroup
+ wg.Add(1)
+ go func() {
+ wg.Done()
+ fmt.Println()
+ }()
+
+ go func() { // noop: no Add call before this go stmt.
+ fmt.Println()
+ wg.Done()
+ }()
+
+ var wg1 sync.WaitGroup
+ wg1.Add(1) // noop: Add and Done should be the same object.
+ go func() {
+ fmt.Println()
+ wg.Done()
+ }()
+
+ wg.Add(1) // noop: Add and Done should be the same object.
+ go func() {
+ fmt.Println()
+ wg1.Done()
+ }()
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_alias.go b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_alias.go
new file mode 100644
index 00000000000..087edba27be
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_alias.go
@@ -0,0 +1,21 @@
+package waitgroup
+
+import (
+ "fmt"
+ sync1 "sync"
+)
+
+func _() {
+ var wg sync1.WaitGroup
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ defer wg.Done()
+ fmt.Println()
+ }()
+
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ fmt.Println()
+ wg.Done()
+ }()
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_alias.go.golden b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_alias.go.golden
new file mode 100644
index 00000000000..377973bc689
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_alias.go.golden
@@ -0,0 +1,19 @@
+package waitgroup
+
+import (
+ "fmt"
+ sync1 "sync"
+)
+
+func _() {
+ var wg sync1.WaitGroup
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ fmt.Println()
+ })
+
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ fmt.Println()
+ })
+}
\ No newline at end of file
diff --git a/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_dot.go b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_dot.go
new file mode 100644
index 00000000000..b4d1e150dbc
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_dot.go
@@ -0,0 +1,22 @@
+package waitgroup
+
+import (
+ "fmt"
+ . "sync"
+)
+
+// supported case for pattern 1.
+func _() {
+ var wg WaitGroup
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ defer wg.Done()
+ fmt.Println()
+ }()
+
+ wg.Add(1) // want "Goroutine creation can be simplified using WaitGroup.Go"
+ go func() {
+ fmt.Println()
+ wg.Done()
+ }()
+}
diff --git a/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_dot.go.golden b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_dot.go.golden
new file mode 100644
index 00000000000..37584be72f8
--- /dev/null
+++ b/gopls/internal/analysis/modernize/testdata/src/waitgroup/waitgroup_dot.go.golden
@@ -0,0 +1,20 @@
+package waitgroup
+
+import (
+ "fmt"
+ . "sync"
+)
+
+// supported case for pattern 1.
+func _() {
+ var wg WaitGroup
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ fmt.Println()
+ })
+
+ // want "Goroutine creation can be simplified using WaitGroup.Go"
+ wg.Go(func() {
+ fmt.Println()
+ })
+}
\ No newline at end of file
diff --git a/gopls/internal/analysis/modernize/testingcontext.go b/gopls/internal/analysis/modernize/testingcontext.go
index 9bdc11ccfca..de52f756ab8 100644
--- a/gopls/internal/analysis/modernize/testingcontext.go
+++ b/gopls/internal/analysis/modernize/testingcontext.go
@@ -14,12 +14,11 @@ import (
"unicode/utf8"
"golang.org/x/tools/go/analysis"
- "golang.org/x/tools/go/analysis/passes/inspect"
- "golang.org/x/tools/go/ast/inspector"
"golang.org/x/tools/go/types/typeutil"
"golang.org/x/tools/internal/analysisinternal"
- "golang.org/x/tools/internal/astutil/cursor"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
"golang.org/x/tools/internal/astutil/edge"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
)
// The testingContext pass replaces calls to context.WithCancel from within
@@ -41,38 +40,32 @@ import (
// - the call is within a test or subtest function
// - the relevant testing.{T,B,F} is named and not shadowed at the call
func testingContext(pass *analysis.Pass) {
- if !analysisinternal.Imports(pass.Pkg, "testing") {
- return
- }
+ var (
+ index = pass.ResultOf[typeindexanalyzer.Analyzer].(*typeindex.Index)
+ info = pass.TypesInfo
- info := pass.TypesInfo
+ contextWithCancel = index.Object("context", "WithCancel")
+ )
- // checkCall finds eligible calls to context.WithCancel to replace.
- checkCall := func(cur cursor.Cursor) {
+calls:
+ for cur := range index.Calls(contextWithCancel) {
call := cur.Node().(*ast.CallExpr)
- obj := typeutil.Callee(info, call)
- if !analysisinternal.IsFunctionNamed(obj, "context", "WithCancel") {
- return
- }
-
- // Have: context.WithCancel(arg)
+ // Have: context.WithCancel(...)
arg, ok := call.Args[0].(*ast.CallExpr)
if !ok {
- return
+ continue
}
- if obj := typeutil.Callee(info, arg); !analysisinternal.IsFunctionNamed(obj, "context", "Background", "TODO") {
- return
+ if !analysisinternal.IsFunctionNamed(typeutil.Callee(info, arg), "context", "Background", "TODO") {
+ continue
}
-
// Have: context.WithCancel(context.{Background,TODO}())
parent := cur.Parent()
assign, ok := parent.Node().(*ast.AssignStmt)
if !ok || assign.Tok != token.DEFINE {
- return
+ continue
}
-
// Have: a, b := context.WithCancel(context.{Background,TODO}())
// Check that both a and b are declared, not redeclarations.
@@ -80,27 +73,27 @@ func testingContext(pass *analysis.Pass) {
for _, expr := range assign.Lhs {
id, ok := expr.(*ast.Ident)
if !ok {
- return
+ continue calls
}
obj, ok := info.Defs[id]
if !ok {
- return
+ continue calls
}
lhs = append(lhs, obj)
}
next, ok := parent.NextSibling()
if !ok {
- return
+ continue
}
defr, ok := next.Node().(*ast.DeferStmt)
if !ok {
- return
+ continue
}
- if soleUse(info, lhs[1]) != defr.Call.Fun {
- return
+ deferId, ok := defr.Call.Fun.(*ast.Ident)
+ if !ok || !soleUseIs(index, lhs[1], deferId) {
+ continue // b is used elsewhere
}
-
// Have:
// a, b := context.WithCancel(context.{Background,TODO}())
// defer b()
@@ -110,7 +103,7 @@ func testingContext(pass *analysis.Pass) {
if curFunc, ok := enclosingFunc(cur); ok {
switch n := curFunc.Node().(type) {
case *ast.FuncLit:
- if e, idx := curFunc.Edge(); e == edge.CallExpr_Args && idx == 1 {
+ if ek, idx := curFunc.ParentEdge(); ek == edge.CallExpr_Args && idx == 1 {
// Have: call(..., func(...) { ...context.WithCancel(...)... })
obj := typeutil.Callee(info, curFunc.Parent().Node().(*ast.CallExpr))
if (analysisinternal.IsMethodNamed(obj, "testing", "T", "Run") ||
@@ -126,8 +119,7 @@ func testingContext(pass *analysis.Pass) {
testObj = isTestFn(info, n)
}
}
-
- if testObj != nil {
+ if testObj != nil && fileUses(info, enclosingFile(cur), "go1.24") {
// Have a test function. Check that we can resolve the relevant
// testing.{T,B,F} at the current position.
if _, obj := lhs[0].Parent().LookupParent(testObj.Name(), lhs[0].Pos()); obj == testObj {
@@ -148,29 +140,19 @@ func testingContext(pass *analysis.Pass) {
}
}
}
-
- inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
- for curFile := range filesUsing(inspect, info, "go1.24") {
- for cur := range curFile.Preorder((*ast.CallExpr)(nil)) {
- checkCall(cur)
- }
- }
}
-// soleUse returns the ident that refers to obj, if there is exactly one.
-//
-// TODO(rfindley): consider factoring to share with gopls/internal/refactor/inline.
-func soleUse(info *types.Info, obj types.Object) (sole *ast.Ident) {
- // This is not efficient, but it is called infrequently.
- for id, obj2 := range info.Uses {
- if obj2 == obj {
- if sole != nil {
- return nil // not unique
- }
- sole = id
+// soleUseIs reports whether id is the sole Ident that uses obj.
+// (It returns false if there were no uses of obj.)
+func soleUseIs(index *typeindex.Index, obj types.Object, id *ast.Ident) bool {
+ empty := true
+ for use := range index.Uses(obj) {
+ empty = false
+ if use.Node() != id {
+ return false
}
}
- return sole
+ return !empty
}
// isTestFn checks whether fn is a test function (TestX, BenchmarkX, FuzzX),
diff --git a/gopls/internal/analysis/modernize/waitgroup.go b/gopls/internal/analysis/modernize/waitgroup.go
new file mode 100644
index 00000000000..080bd4d362a
--- /dev/null
+++ b/gopls/internal/analysis/modernize/waitgroup.go
@@ -0,0 +1,144 @@
+// Copyright 2025 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 modernize
+
+import (
+ "fmt"
+ "go/ast"
+ "slices"
+
+ "golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/go/types/typeutil"
+ "golang.org/x/tools/internal/analysisinternal"
+ typeindexanalyzer "golang.org/x/tools/internal/analysisinternal/typeindex"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
+)
+
+// The waitgroup pass replaces old more complex code with
+// go1.25 added API WaitGroup.Go.
+//
+// Patterns:
+//
+// 1. wg.Add(1); go func() { defer wg.Done(); ... }()
+// =>
+// wg.Go(go func() { ... })
+//
+// 2. wg.Add(1); go func() { ...; wg.Done() }()
+// =>
+// wg.Go(go func() { ... })
+//
+// The wg.Done must occur within the first statement of the block in a
+// defer format or last statement of the block, and the offered fix
+// only removes the first/last wg.Done call. It doesn't fix existing
+// wrong usage of sync.WaitGroup.
+//
+// The use of WaitGroup.Go in pattern 1 implicitly introduces a
+// 'defer', which may change the behavior in the case of panic from
+// the "..." logic. In this instance, the change is safe: before and
+// after the transformation, an unhandled panic inevitably results in
+// a fatal crash. The fact that the transformed code calls wg.Done()
+// before the crash doesn't materially change anything. (If Done had
+// other effects, or blocked, or if WaitGroup.Go propagated panics
+// from child to parent goroutine, the argument would be different.)
+func waitgroup(pass *analysis.Pass) {
+ var (
+ index = pass.ResultOf[typeindexanalyzer.Analyzer].(*typeindex.Index)
+ info = pass.TypesInfo
+ syncWaitGroupAdd = index.Selection("sync", "WaitGroup", "Add")
+ syncWaitGroupDone = index.Selection("sync", "WaitGroup", "Done")
+ )
+ if !index.Used(syncWaitGroupDone) {
+ return
+ }
+
+ for curAddCall := range index.Calls(syncWaitGroupAdd) {
+ // Extract receiver from wg.Add call.
+ addCall := curAddCall.Node().(*ast.CallExpr)
+ if !isIntLiteral(info, addCall.Args[0], 1) {
+ continue // not a call to wg.Add(1)
+ }
+ // Inv: the Args[0] check ensures addCall is not of
+ // the form sync.WaitGroup.Add(&wg, 1).
+ addCallRecv := ast.Unparen(addCall.Fun).(*ast.SelectorExpr).X
+
+ // Following statement must be go func() { ... } ().
+ addStmt, ok := curAddCall.Parent().Node().(*ast.ExprStmt)
+ if !ok {
+ continue // unnecessary parens?
+ }
+ curNext, ok := curAddCall.Parent().NextSibling()
+ if !ok {
+ continue // no successor
+ }
+ goStmt, ok := curNext.Node().(*ast.GoStmt)
+ if !ok {
+ continue // not a go stmt
+ }
+ lit, ok := goStmt.Call.Fun.(*ast.FuncLit)
+ if !ok || len(goStmt.Call.Args) != 0 {
+ continue // go argument is not func(){...}()
+ }
+ list := lit.Body.List
+ if len(list) == 0 {
+ continue
+ }
+
+ // Body must start with "defer wg.Done()" or end with "wg.Done()".
+ var doneStmt ast.Stmt
+ if deferStmt, ok := list[0].(*ast.DeferStmt); ok &&
+ typeutil.Callee(info, deferStmt.Call) == syncWaitGroupDone &&
+ equalSyntax(ast.Unparen(deferStmt.Call.Fun).(*ast.SelectorExpr).X, addCallRecv) {
+ doneStmt = deferStmt // "defer wg.Done()"
+
+ } else if lastStmt, ok := list[len(list)-1].(*ast.ExprStmt); ok {
+ if doneCall, ok := lastStmt.X.(*ast.CallExpr); ok &&
+ typeutil.Callee(info, doneCall) == syncWaitGroupDone &&
+ equalSyntax(ast.Unparen(doneCall.Fun).(*ast.SelectorExpr).X, addCallRecv) {
+ doneStmt = lastStmt // "wg.Done()"
+ }
+ }
+ if doneStmt == nil {
+ continue
+ }
+
+ file := enclosingFile(curAddCall)
+ if !fileUses(info, file, "go1.25") {
+ continue
+ }
+
+ pass.Report(analysis.Diagnostic{
+ Pos: addCall.Pos(),
+ End: goStmt.End(),
+ Category: "waitgroup",
+ Message: "Goroutine creation can be simplified using WaitGroup.Go",
+ SuggestedFixes: []analysis.SuggestedFix{{
+ Message: "Simplify by using WaitGroup.Go",
+ TextEdits: slices.Concat(
+ // delete "wg.Add(1)"
+ analysisinternal.DeleteStmt(pass.Fset, file, addStmt, nil),
+ // delete "wg.Done()" or "defer wg.Done()"
+ analysisinternal.DeleteStmt(pass.Fset, file, doneStmt, nil),
+ []analysis.TextEdit{
+ // go func()
+ // ------
+ // wg.Go(func()
+ {
+ Pos: goStmt.Pos(),
+ End: goStmt.Call.Pos(),
+ NewText: fmt.Appendf(nil, "%s.Go(", addCallRecv),
+ },
+ // ... }()
+ // -
+ // ... } )
+ {
+ Pos: goStmt.Call.Lparen,
+ End: goStmt.Call.Rparen,
+ },
+ },
+ ),
+ }},
+ })
+ }
+}
diff --git a/gopls/internal/analysis/nonewvars/nonewvars.go b/gopls/internal/analysis/nonewvars/nonewvars.go
index 9e5d79df02c..eeae7211c97 100644
--- a/gopls/internal/analysis/nonewvars/nonewvars.go
+++ b/gopls/internal/analysis/nonewvars/nonewvars.go
@@ -7,16 +7,17 @@
package nonewvars
import (
- "bytes"
_ "embed"
"go/ast"
- "go/format"
"go/token"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/inspect"
"golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/gopls/internal/util/moreiters"
"golang.org/x/tools/internal/analysisinternal"
+ "golang.org/x/tools/internal/astutil/cursor"
+ "golang.org/x/tools/internal/typesinternal"
)
//go:embed doc.go
@@ -31,59 +32,44 @@ var Analyzer = &analysis.Analyzer{
URL: "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/nonewvars",
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
- if len(pass.TypeErrors) == 0 {
- return nil, nil
- }
- nodeFilter := []ast.Node{(*ast.AssignStmt)(nil)}
- inspect.Preorder(nodeFilter, func(n ast.Node) {
- assignStmt, _ := n.(*ast.AssignStmt)
- // We only care about ":=".
- if assignStmt.Tok != token.DEFINE {
- return
+ for _, typeErr := range pass.TypeErrors {
+ if typeErr.Msg != "no new variables on left side of :=" {
+ continue // irrelevant error
+ }
+ _, start, end, ok := typesinternal.ErrorCodeStartEnd(typeErr)
+ if !ok {
+ continue // can't get position info
+ }
+ curErr, ok := cursor.Root(inspect).FindPos(start, end)
+ if !ok {
+ continue // can't find errant node
}
- var file *ast.File
- for _, f := range pass.Files {
- if f.FileStart <= assignStmt.Pos() && assignStmt.Pos() < f.FileEnd {
- file = f
- break
- }
+ // Find enclosing assignment (which may be curErr itself).
+ curAssign, ok := moreiters.First(curErr.Enclosing((*ast.AssignStmt)(nil)))
+ if !ok {
+ continue // no enclosing assignment
}
- if file == nil {
- return
+ assign := curAssign.Node().(*ast.AssignStmt)
+ if assign.Tok != token.DEFINE {
+ continue // not a := statement
}
- for _, err := range pass.TypeErrors {
- if !FixesError(err.Msg) {
- continue
- }
- if assignStmt.Pos() > err.Pos || err.Pos >= assignStmt.End() {
- continue
- }
- var buf bytes.Buffer
- if err := format.Node(&buf, pass.Fset, file); err != nil {
- continue
- }
- pass.Report(analysis.Diagnostic{
- Pos: err.Pos,
- End: analysisinternal.TypeErrorEndPos(pass.Fset, buf.Bytes(), err.Pos),
- Message: err.Msg,
- SuggestedFixes: []analysis.SuggestedFix{{
- Message: "Change ':=' to '='",
- TextEdits: []analysis.TextEdit{{
- Pos: err.Pos,
- End: err.Pos + 1,
- }},
+ pass.Report(analysis.Diagnostic{
+ Pos: assign.TokPos,
+ End: assign.TokPos + token.Pos(len(":=")),
+ Message: typeErr.Msg,
+ SuggestedFixes: []analysis.SuggestedFix{{
+ Message: "Change ':=' to '='",
+ TextEdits: []analysis.TextEdit{{
+ Pos: assign.TokPos,
+ End: assign.TokPos + token.Pos(len(":")),
}},
- })
- }
- })
+ }},
+ })
+ }
return nil, nil
}
-
-func FixesError(msg string) bool {
- return msg == "no new variables on left side of :="
-}
diff --git a/gopls/internal/analysis/noresultvalues/noresultvalues.go b/gopls/internal/analysis/noresultvalues/noresultvalues.go
index 118beb4568b..848f6532ce0 100644
--- a/gopls/internal/analysis/noresultvalues/noresultvalues.go
+++ b/gopls/internal/analysis/noresultvalues/noresultvalues.go
@@ -5,9 +5,8 @@
package noresultvalues
import (
- "bytes"
"go/ast"
- "go/format"
+ "go/token"
"strings"
_ "embed"
@@ -15,7 +14,10 @@ import (
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/inspect"
"golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/gopls/internal/util/moreiters"
"golang.org/x/tools/internal/analysisinternal"
+ "golang.org/x/tools/internal/astutil/cursor"
+ "golang.org/x/tools/internal/typesinternal"
)
//go:embed doc.go
@@ -30,57 +32,42 @@ var Analyzer = &analysis.Analyzer{
URL: "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/noresultvalues",
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
- if len(pass.TypeErrors) == 0 {
- return nil, nil
- }
-
- nodeFilter := []ast.Node{(*ast.ReturnStmt)(nil)}
- inspect.Preorder(nodeFilter, func(n ast.Node) {
- retStmt, _ := n.(*ast.ReturnStmt)
- var file *ast.File
- for _, f := range pass.Files {
- if f.FileStart <= retStmt.Pos() && retStmt.Pos() < f.FileEnd {
- file = f
- break
- }
+ for _, typErr := range pass.TypeErrors {
+ if !fixesError(typErr.Msg) {
+ continue // irrelevant error
}
- if file == nil {
- return
+ _, start, end, ok := typesinternal.ErrorCodeStartEnd(typErr)
+ if !ok {
+ continue // can't get position info
}
-
- for _, err := range pass.TypeErrors {
- if !FixesError(err.Msg) {
- continue
- }
- if retStmt.Pos() >= err.Pos || err.Pos >= retStmt.End() {
- continue
- }
- var buf bytes.Buffer
- if err := format.Node(&buf, pass.Fset, file); err != nil {
- continue
- }
+ curErr, ok := cursor.Root(inspect).FindPos(start, end)
+ if !ok {
+ continue // can't find errant node
+ }
+ // Find first enclosing return statement, if any.
+ if curRet, ok := moreiters.First(curErr.Enclosing((*ast.ReturnStmt)(nil))); ok {
+ ret := curRet.Node()
pass.Report(analysis.Diagnostic{
- Pos: err.Pos,
- End: analysisinternal.TypeErrorEndPos(pass.Fset, buf.Bytes(), err.Pos),
- Message: err.Msg,
+ Pos: start,
+ End: end,
+ Message: typErr.Msg,
SuggestedFixes: []analysis.SuggestedFix{{
Message: "Delete return values",
TextEdits: []analysis.TextEdit{{
- Pos: retStmt.Pos(),
- End: retStmt.End(),
- NewText: []byte("return"),
+ Pos: ret.Pos() + token.Pos(len("return")),
+ End: ret.End(),
}},
}},
})
}
- })
+ }
return nil, nil
}
-func FixesError(msg string) bool {
+func fixesError(msg string) bool {
return msg == "no result values expected" ||
strings.HasPrefix(msg, "too many return values") && strings.Contains(msg, "want ()")
}
diff --git a/gopls/internal/analysis/simplifycompositelit/simplifycompositelit.go b/gopls/internal/analysis/simplifycompositelit/simplifycompositelit.go
index 15176cef1c8..b38ccf4d5ed 100644
--- a/gopls/internal/analysis/simplifycompositelit/simplifycompositelit.go
+++ b/gopls/internal/analysis/simplifycompositelit/simplifycompositelit.go
@@ -33,7 +33,7 @@ var Analyzer = &analysis.Analyzer{
URL: "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/simplifycompositelit",
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
// Gather information whether file is generated or not
generated := make(map[*token.File]bool)
for _, file := range pass.Files {
diff --git a/gopls/internal/analysis/simplifyrange/simplifyrange.go b/gopls/internal/analysis/simplifyrange/simplifyrange.go
index 6d079059eb1..594ebd1f55a 100644
--- a/gopls/internal/analysis/simplifyrange/simplifyrange.go
+++ b/gopls/internal/analysis/simplifyrange/simplifyrange.go
@@ -5,10 +5,8 @@
package simplifyrange
import (
- "bytes"
_ "embed"
"go/ast"
- "go/printer"
"go/token"
"golang.org/x/tools/go/analysis"
@@ -28,7 +26,7 @@ var Analyzer = &analysis.Analyzer{
URL: "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/simplifyrange",
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
// Gather information whether file is generated or not
generated := make(map[*token.File]bool)
for _, file := range pass.Files {
@@ -42,73 +40,48 @@ func run(pass *analysis.Pass) (interface{}, error) {
(*ast.RangeStmt)(nil),
}
inspect.Preorder(nodeFilter, func(n ast.Node) {
- if _, ok := generated[pass.Fset.File(n.Pos())]; ok {
- return // skip checking if it's generated code
- }
+ rng := n.(*ast.RangeStmt)
- var copy *ast.RangeStmt // shallow-copy the AST before modifying
- {
- x := *n.(*ast.RangeStmt)
- copy = &x
- }
- end := newlineIndex(pass.Fset, copy)
+ kblank := isBlank(rng.Key)
+ vblank := isBlank(rng.Value)
+ var start, end token.Pos
+ switch {
+ case kblank && (rng.Value == nil || vblank):
+ // for _ = range x {}
+ // for _, _ = range x {}
+ // ^^^^^^^
+ start, end = rng.Key.Pos(), rng.Range
- // Range statements of the form: for i, _ := range x {}
- var old ast.Expr
- if isBlank(copy.Value) {
- old = copy.Value
- copy.Value = nil
- }
- // Range statements of the form: for _ := range x {}
- if isBlank(copy.Key) && copy.Value == nil {
- old = copy.Key
- copy.Key = nil
+ case vblank:
+ // for k, _ := range x {}
+ // ^^^
+ start, end = rng.Key.End(), rng.Value.End()
+
+ default:
+ return
}
- // Return early if neither if condition is met.
- if old == nil {
+
+ if generated[pass.Fset.File(n.Pos())] {
return
}
+
pass.Report(analysis.Diagnostic{
- Pos: old.Pos(),
- End: old.End(),
- Message: "simplify range expression",
- SuggestedFixes: suggestedFixes(pass.Fset, copy, end),
+ Pos: start,
+ End: end,
+ Message: "simplify range expression",
+ SuggestedFixes: []analysis.SuggestedFix{{
+ Message: "Remove empty value",
+ TextEdits: []analysis.TextEdit{{
+ Pos: start,
+ End: end,
+ }},
+ }},
})
})
return nil, nil
}
-func suggestedFixes(fset *token.FileSet, rng *ast.RangeStmt, end token.Pos) []analysis.SuggestedFix {
- var b bytes.Buffer
- printer.Fprint(&b, fset, rng)
- stmt := b.Bytes()
- index := bytes.Index(stmt, []byte("\n"))
- // If there is a new line character, then don't replace the body.
- if index != -1 {
- stmt = stmt[:index]
- }
- return []analysis.SuggestedFix{{
- Message: "Remove empty value",
- TextEdits: []analysis.TextEdit{{
- Pos: rng.Pos(),
- End: end,
- NewText: stmt[:index],
- }},
- }}
-}
-
-func newlineIndex(fset *token.FileSet, rng *ast.RangeStmt) token.Pos {
- var b bytes.Buffer
- printer.Fprint(&b, fset, rng)
- contents := b.Bytes()
- index := bytes.Index(contents, []byte("\n"))
- if index == -1 {
- return rng.End()
- }
- return rng.Pos() + token.Pos(index)
-}
-
-func isBlank(x ast.Expr) bool {
- ident, ok := x.(*ast.Ident)
- return ok && ident.Name == "_"
+func isBlank(e ast.Expr) bool {
+ id, ok := e.(*ast.Ident)
+ return ok && id.Name == "_"
}
diff --git a/gopls/internal/analysis/simplifyrange/simplifyrange_test.go b/gopls/internal/analysis/simplifyrange/simplifyrange_test.go
index 50a600e03bf..089f65df870 100644
--- a/gopls/internal/analysis/simplifyrange/simplifyrange_test.go
+++ b/gopls/internal/analysis/simplifyrange/simplifyrange_test.go
@@ -5,8 +5,6 @@
package simplifyrange_test
import (
- "go/build"
- "slices"
"testing"
"golang.org/x/tools/go/analysis/analysistest"
@@ -14,9 +12,8 @@ import (
)
func Test(t *testing.T) {
- testdata := analysistest.TestData()
- analysistest.RunWithSuggestedFixes(t, testdata, simplifyrange.Analyzer, "a", "generatedcode")
- if slices.Contains(build.Default.ReleaseTags, "go1.23") { // uses iter.Seq
- analysistest.RunWithSuggestedFixes(t, testdata, simplifyrange.Analyzer, "rangeoverfunc")
- }
+ analysistest.RunWithSuggestedFixes(t, analysistest.TestData(), simplifyrange.Analyzer,
+ "a",
+ "generatedcode",
+ "rangeoverfunc")
}
diff --git a/gopls/internal/analysis/simplifyrange/testdata/src/a/a.go b/gopls/internal/analysis/simplifyrange/testdata/src/a/a.go
index 49face1e968..1d7b1bd58f2 100644
--- a/gopls/internal/analysis/simplifyrange/testdata/src/a/a.go
+++ b/gopls/internal/analysis/simplifyrange/testdata/src/a/a.go
@@ -13,4 +13,11 @@ func m() {
}
for _ = range maps { // want "simplify range expression"
}
+ for _, _ = range maps { // want "simplify range expression"
+ }
+ for _, v := range maps { // nope
+ println(v)
+ }
+ for range maps { // nope
+ }
}
diff --git a/gopls/internal/analysis/simplifyrange/testdata/src/a/a.go.golden b/gopls/internal/analysis/simplifyrange/testdata/src/a/a.go.golden
index ec8490ab337..25139bd93f2 100644
--- a/gopls/internal/analysis/simplifyrange/testdata/src/a/a.go.golden
+++ b/gopls/internal/analysis/simplifyrange/testdata/src/a/a.go.golden
@@ -13,4 +13,11 @@ func m() {
}
for range maps { // want "simplify range expression"
}
+ for range maps { // want "simplify range expression"
+ }
+ for _, v := range maps { // nope
+ println(v)
+ }
+ for range maps { // nope
+ }
}
diff --git a/gopls/internal/analysis/simplifyslice/simplifyslice.go b/gopls/internal/analysis/simplifyslice/simplifyslice.go
index 6755187afe5..28cc266d713 100644
--- a/gopls/internal/analysis/simplifyslice/simplifyslice.go
+++ b/gopls/internal/analysis/simplifyslice/simplifyslice.go
@@ -37,7 +37,7 @@ var Analyzer = &analysis.Analyzer{
// An example where it does not:
// x, y := b[:n], b[n:]
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
// Gather information whether file is generated or not
generated := make(map[*token.File]bool)
for _, file := range pass.Files {
diff --git a/gopls/internal/analysis/unusedfunc/doc.go b/gopls/internal/analysis/unusedfunc/doc.go
index 5946ed897bb..9e2fc8145c8 100644
--- a/gopls/internal/analysis/unusedfunc/doc.go
+++ b/gopls/internal/analysis/unusedfunc/doc.go
@@ -20,12 +20,29 @@
// that of any method of an interface type declared within the same
// package.
//
-// The tool may report a false positive for a declaration of an
-// unexported function that is referenced from another package using
-// the go:linkname mechanism, if the declaration's doc comment does
-// not also have a go:linkname comment. (Such code is in any case
-// strongly discouraged: linkname annotations, if they must be used at
-// all, should be used on both the declaration and the alias.)
+// The tool may report false positives in some situations, for
+// example:
+//
+// - For a declaration of an unexported function that is referenced
+// from another package using the go:linkname mechanism, if the
+// declaration's doc comment does not also have a go:linkname
+// comment.
+//
+// (Such code is in any case strongly discouraged: linkname
+// annotations, if they must be used at all, should be used on both
+// the declaration and the alias.)
+//
+// - For compiler intrinsics in the "runtime" package that, though
+// never referenced, are known to the compiler and are called
+// indirectly by compiled object code.
+//
+// - For functions called only from assembly.
+//
+// - For functions called only from files whose build tags are not
+// selected in the current build configuration.
+//
+// See https://github.com/golang/go/issues/71686 for discussion of
+// these limitations.
//
// The unusedfunc algorithm is not as precise as the
// golang.org/x/tools/cmd/deadcode tool, but it has the advantage that
diff --git a/gopls/internal/analysis/unusedparams/unusedparams.go b/gopls/internal/analysis/unusedparams/unusedparams.go
index 2986dfd6e41..12076c5f273 100644
--- a/gopls/internal/analysis/unusedparams/unusedparams.go
+++ b/gopls/internal/analysis/unusedparams/unusedparams.go
@@ -80,24 +80,9 @@ func run(pass *analysis.Pass) (any, error) {
inspect.Preorder(filter, func(n ast.Node) {
switch n := n.(type) {
case *ast.CallExpr:
- // Strip off any generic instantiation.
- fun := n.Fun
- switch fun_ := fun.(type) {
- case *ast.IndexExpr:
- fun = fun_.X // f[T]() (funcs[i]() is rejected below)
- case *ast.IndexListExpr:
- fun = fun_.X // f[K, V]()
- }
-
+ id := typesinternal.UsedIdent(pass.TypesInfo, n.Fun)
// Find object:
// record non-exported function, method, or func-typed var.
- var id *ast.Ident
- switch fun := fun.(type) {
- case *ast.Ident:
- id = fun
- case *ast.SelectorExpr:
- id = fun.Sel
- }
if id != nil && !id.IsExported() {
switch pass.TypesInfo.Uses[id].(type) {
case *types.Func, *types.Var:
@@ -202,7 +187,7 @@ func run(pass *analysis.Pass) (any, error) {
case *ast.AssignStmt:
// f = func() {...}
// f := func() {...}
- if e, idx := c.Edge(); e == edge.AssignStmt_Rhs {
+ if ek, idx := c.ParentEdge(); ek == edge.AssignStmt_Rhs {
// Inv: n == AssignStmt.Rhs[idx]
if id, ok := parent.Lhs[idx].(*ast.Ident); ok {
fn = pass.TypesInfo.ObjectOf(id)
diff --git a/gopls/internal/analysis/unusedvariable/unusedvariable.go b/gopls/internal/analysis/unusedvariable/unusedvariable.go
index 15bcd43d873..3ea1dbe6953 100644
--- a/gopls/internal/analysis/unusedvariable/unusedvariable.go
+++ b/gopls/internal/analysis/unusedvariable/unusedvariable.go
@@ -13,10 +13,12 @@ import (
"go/token"
"go/types"
"regexp"
+ "slices"
"strings"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/ast/astutil"
+ "golang.org/x/tools/gopls/internal/util/bug"
"golang.org/x/tools/gopls/internal/util/safetoken"
)
@@ -45,7 +47,7 @@ func run(pass *analysis.Pass) (any, error) {
if len(match) > 0 {
varName := match[1]
// Beginning in Go 1.23, go/types began quoting vars as `v'.
- varName = strings.Trim(varName, "'`'")
+ varName = strings.Trim(varName, "`'")
err := runForError(pass, typeErr, varName)
if err != nil {
@@ -165,16 +167,13 @@ func removeVariableFromSpec(pass *analysis.Pass, path []ast.Node, stmt *ast.Valu
// Find parent DeclStmt and delete it
for _, node := range path {
if declStmt, ok := node.(*ast.DeclStmt); ok {
- edits := deleteStmtFromBlock(pass.Fset, path, declStmt)
- if len(edits) == 0 {
- return nil // can this happen?
- }
- return []analysis.SuggestedFix{
- {
+ if edits := deleteStmtFromBlock(pass.Fset, path, declStmt); len(edits) > 0 {
+ return []analysis.SuggestedFix{{
Message: suggestedFixMessage(ident.Name),
TextEdits: edits,
- },
+ }}
}
+ return nil
}
}
}
@@ -222,16 +221,13 @@ func removeVariableFromAssignment(fset *token.FileSet, path []ast.Node, stmt *as
}
// RHS does not have any side effects, delete the whole statement
- edits := deleteStmtFromBlock(fset, path, stmt)
- if len(edits) == 0 {
- return nil // can this happen?
- }
- return []analysis.SuggestedFix{
- {
+ if edits := deleteStmtFromBlock(fset, path, stmt); len(edits) > 0 {
+ return []analysis.SuggestedFix{{
Message: suggestedFixMessage(ident.Name),
TextEdits: edits,
- },
+ }}
}
+ return nil
}
// Otherwise replace ident with `_`
@@ -253,34 +249,48 @@ func suggestedFixMessage(name string) string {
return fmt.Sprintf("Remove variable %s", name)
}
+// deleteStmtFromBlock returns the edits to remove stmt if its parent is a BlockStmt.
+// (stmt is not necessarily the leaf, path[0].)
+//
+// It returns nil if the parent is not a block, as in these examples:
+//
+// switch STMT; {}
+// switch { default: STMT }
+// select { default: STMT }
+//
+// TODO(adonovan): handle these cases too.
func deleteStmtFromBlock(fset *token.FileSet, path []ast.Node, stmt ast.Stmt) []analysis.TextEdit {
- // Find innermost enclosing BlockStmt.
- var block *ast.BlockStmt
- for i := range path {
- if blockStmt, ok := path[i].(*ast.BlockStmt); ok {
- block = blockStmt
- break
- }
+ // TODO(adonovan): simplify using Cursor API.
+ i := slices.Index(path, ast.Node(stmt)) // must be present
+ block, ok := path[i+1].(*ast.BlockStmt)
+ if !ok {
+ return nil // parent is not a BlockStmt
}
- nodeIndex := -1
- for i, blockStmt := range block.List {
- if blockStmt == stmt {
- nodeIndex = i
- break
- }
+ nodeIndex := slices.Index(block.List, stmt)
+ if nodeIndex == -1 {
+ bug.Reportf("%s: Stmt not found in BlockStmt.List", safetoken.StartPosition(fset, stmt.Pos())) // refine #71812
+ return nil
}
- // The statement we need to delete was not found in BlockStmt
- if nodeIndex == -1 {
+ if !stmt.Pos().IsValid() {
+ bug.Reportf("%s: invalid Stmt.Pos", safetoken.StartPosition(fset, stmt.Pos())) // refine #71812
return nil
}
// Delete until the end of the block unless there is another statement after
// the one we are trying to delete
end := block.Rbrace
+ if !end.IsValid() {
+ bug.Reportf("%s: BlockStmt has no Rbrace", safetoken.StartPosition(fset, block.Pos())) // refine #71812
+ return nil
+ }
if nodeIndex < len(block.List)-1 {
end = block.List[nodeIndex+1].Pos()
+ if end < stmt.Pos() {
+ bug.Reportf("%s: BlockStmt.List[last].Pos > BlockStmt.Rbrace", safetoken.StartPosition(fset, block.Pos())) // refine #71812
+ return nil
+ }
}
// Account for comments within the block containing the statement
@@ -298,7 +308,7 @@ outer:
// If a comment exists within the current block, after the unused variable statement,
// and before the next statement, we shouldn't delete it.
if coLine > stmtEndLine {
- end = co.Pos()
+ end = co.Pos() // preserves invariant stmt.Pos <= end (#71812)
break outer
}
if co.Pos() > end {
@@ -308,12 +318,11 @@ outer:
}
}
- return []analysis.TextEdit{
- {
- Pos: stmt.Pos(),
- End: end,
- },
- }
+ // Delete statement and optional following comment.
+ return []analysis.TextEdit{{
+ Pos: stmt.Pos(),
+ End: end,
+ }}
}
// exprMayHaveSideEffects reports whether the expression may have side effects
diff --git a/gopls/internal/analysis/yield/yield.go b/gopls/internal/analysis/yield/yield.go
index ccd30045f97..354cf372186 100644
--- a/gopls/internal/analysis/yield/yield.go
+++ b/gopls/internal/analysis/yield/yield.go
@@ -44,7 +44,7 @@ var Analyzer = &analysis.Analyzer{
URL: "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/yield",
}
-func run(pass *analysis.Pass) (interface{}, error) {
+func run(pass *analysis.Pass) (any, error) {
inspector := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
// Find all calls to yield of the right type.
diff --git a/gopls/internal/cache/analysis.go b/gopls/internal/cache/analysis.go
index d570c0a46ae..cf5518cf79f 100644
--- a/gopls/internal/cache/analysis.go
+++ b/gopls/internal/cache/analysis.go
@@ -637,7 +637,7 @@ func (an *analysisNode) runCached(ctx context.Context, key file.Hash) (*analyzeS
return summary, nil
}
-// analysisCacheKey returns a cache key that is a cryptographic digest
+// cacheKey returns a cache key that is a cryptographic digest
// of the all the values that might affect type checking and analysis:
// the analyzer names, package metadata, names and contents of
// compiled Go files, and vdeps (successor) information
@@ -822,8 +822,7 @@ func typesLookup(pkg *types.Package) func(string) *types.Package {
)
// search scans children the next package in pending, looking for pkgPath.
- var search func(pkgPath string) (*types.Package, int)
- search = func(pkgPath string) (sought *types.Package, numPending int) {
+ search := func(pkgPath string) (sought *types.Package, numPending int) {
mu.Lock()
defer mu.Unlock()
@@ -886,7 +885,7 @@ type action struct {
vdeps map[PackageID]*analysisNode // vertical dependencies
// results of action.exec():
- result interface{} // result of Run function, of type a.ResultType
+ result any // result of Run function, of type a.ResultType
summary *actionSummary
err error
}
@@ -965,7 +964,7 @@ func (act *action) exec(ctx context.Context) (any, *actionSummary, error) {
}
// Gather analysis Result values from horizontal dependencies.
- inputs := make(map[*analysis.Analyzer]interface{})
+ inputs := make(map[*analysis.Analyzer]any)
for _, dep := range act.hdeps {
inputs[dep.a] = dep.result
}
@@ -1179,7 +1178,7 @@ func (act *action) exec(ctx context.Context) (any, *actionSummary, error) {
// Recover from panics (only) within the analyzer logic.
// (Use an anonymous function to limit the recover scope.)
- var result interface{}
+ var result any
func() {
start := time.Now()
defer func() {
diff --git a/gopls/internal/cache/check.go b/gopls/internal/cache/check.go
index d094c535d7a..909003288bc 100644
--- a/gopls/internal/cache/check.go
+++ b/gopls/internal/cache/check.go
@@ -44,11 +44,6 @@ import (
"golang.org/x/tools/internal/versions"
)
-// Various optimizations that should not affect correctness.
-const (
- preserveImportGraph = true // hold on to the import graph for open packages
-)
-
type unit = struct{}
// A typeCheckBatch holds data for a logical type-checking operation, which may
@@ -97,21 +92,6 @@ func (b *typeCheckBatch) getHandle(id PackageID) *packageHandle {
return b._handles[id]
}
-// A futurePackage is a future result of type checking or importing a package,
-// to be cached in a map.
-//
-// The goroutine that creates the futurePackage is responsible for evaluating
-// its value, and closing the done channel.
-type futurePackage struct {
- done chan unit
- v pkgOrErr
-}
-
-type pkgOrErr struct {
- pkg *types.Package
- err error
-}
-
// TypeCheck parses and type-checks the specified packages,
// and returns them in the same order as the ids.
// The resulting packages' types may belong to different importers,
@@ -657,7 +637,10 @@ func (b *typeCheckBatch) checkPackageForImport(ctx context.Context, ph *packageH
go func() {
exportData, err := gcimporter.IExportShallow(b.fset, pkg, bug.Reportf)
if err != nil {
- bug.Reportf("exporting package %v: %v", ph.mp.ID, err)
+ // Internal error; the stack will have been reported via
+ // bug.Reportf within IExportShallow, so there's not much
+ // to do here (issue #71067).
+ event.Error(ctx, "IExportShallow failed", err, label.Package.Of(string(ph.mp.ID)))
return
}
if err := filecache.Set(exportDataKind, ph.key, exportData); err != nil {
@@ -701,8 +684,7 @@ func importLookup(mp *metadata.Package, source metadata.Source) func(PackagePath
// search scans children the next package in pending, looking for pkgPath.
// Invariant: whenever search is called, pkgPath is not yet mapped.
- var search func(pkgPath PackagePath) (PackageID, bool)
- search = func(pkgPath PackagePath) (id PackageID, found bool) {
+ search := func(pkgPath PackagePath) (id PackageID, found bool) {
pkg := pending[0]
pending = pending[1:]
for depPath, depID := range pkg.DepsByPkgPath {
@@ -2001,7 +1983,7 @@ func typeErrorsToDiagnostics(pkg *syntaxPackage, inputs *typeCheckInputs, errs [
batch := func(related []types.Error) {
var diags []*Diagnostic
for i, e := range related {
- code, start, end, ok := typesinternal.ReadGo116ErrorData(e)
+ code, start, end, ok := typesinternal.ErrorCodeStartEnd(e)
if !ok || !start.IsValid() || !end.IsValid() {
start, end = e.Pos, e.Pos
code = 0
@@ -2026,15 +2008,14 @@ func typeErrorsToDiagnostics(pkg *syntaxPackage, inputs *typeCheckInputs, errs [
posn := safetoken.StartPosition(e.Fset, start)
if !posn.IsValid() {
// All valid positions produced by the type checker should described by
- // its fileset.
+ // its fileset, yet since type checker errors are associated with
+ // positions in the AST, and AST nodes can overflow the file
+ // (golang/go#48300), we can't rely on this.
//
- // Note: in golang/go#64488, we observed an error that was positioned
- // over fixed syntax, which overflowed its file. So it's definitely
- // possible that we get here (it's hard to reason about fixing up the
- // AST). Nevertheless, it's a bug.
- if pkg.hasFixedFiles() {
- bug.Reportf("internal error: type checker error %q outside its Fset (fixed files)", e)
- } else {
+ // We should fix the parser, but in the meantime type errors are not
+ // significant if there are parse errors, so we can safely ignore this
+ // case.
+ if len(pkg.parseErrors) == 0 {
bug.Reportf("internal error: type checker error %q outside its Fset", e)
}
continue
@@ -2075,6 +2056,9 @@ func typeErrorsToDiagnostics(pkg *syntaxPackage, inputs *typeCheckInputs, errs [
if end == start {
// Expand the end position to a more meaningful span.
+ //
+ // TODO(adonovan): It is the type checker's responsibility
+ // to ensure that (start, end) are meaningful; see #71803.
end = analysisinternal.TypeErrorEndPos(e.Fset, pgf.Src, start)
// debugging golang/go#65960
diff --git a/gopls/internal/cache/filterer.go b/gopls/internal/cache/filterer.go
index 0ec18369bdf..13dbd8a1b04 100644
--- a/gopls/internal/cache/filterer.go
+++ b/gopls/internal/cache/filterer.go
@@ -11,45 +11,55 @@ import (
"strings"
)
-type Filterer struct {
- // Whether a filter is excluded depends on the operator (first char of the raw filter).
- // Slices filters and excluded then should have the same length.
- filters []*regexp.Regexp
- excluded []bool
-}
-
-// NewFilterer computes regular expression form of all raw filters
-func NewFilterer(rawFilters []string) *Filterer {
- var f Filterer
- for _, filter := range rawFilters {
+// PathIncludeFunc creates a function that determines if a given file path
+// should be included based on a set of inclusion/exclusion rules.
+//
+// The `rules` parameter is a slice of strings, where each string represents a
+// filtering rule. Each rule consists of an operator (`+` for inclusion, `-`
+// for exclusion) followed by a path pattern. See more detail of rules syntax
+// at [settings.BuildOptions.DirectoryFilters].
+//
+// Rules are evaluated in order, and the last matching rule determines
+// whether a path is included or excluded.
+//
+// Examples:
+// - []{"-foo"}: Exclude "foo" at the current depth.
+// - []{"-**foo"}: Exclude "foo" at any depth.
+// - []{"+bar"}: Include "bar" at the current depth.
+// - []{"-foo", "+foo/**/bar"}: Exclude all "foo" at current depth except
+// directory "bar" under "foo" at any depth.
+func PathIncludeFunc(rules []string) func(string) bool {
+ var matchers []*regexp.Regexp
+ var included []bool
+ for _, filter := range rules {
filter = path.Clean(filepath.ToSlash(filter))
// TODO(dungtuanle): fix: validate [+-] prefix.
op, prefix := filter[0], filter[1:]
- // convertFilterToRegexp adds "/" at the end of prefix to handle cases where a filter is a prefix of another filter.
+ // convertFilterToRegexp adds "/" at the end of prefix to handle cases
+ // where a filter is a prefix of another filter.
// For example, it prevents [+foobar, -foo] from excluding "foobar".
- f.filters = append(f.filters, convertFilterToRegexp(filepath.ToSlash(prefix)))
- f.excluded = append(f.excluded, op == '-')
+ matchers = append(matchers, convertFilterToRegexp(filepath.ToSlash(prefix)))
+ included = append(included, op == '+')
}
- return &f
-}
-
-// Disallow return true if the path is excluded from the filterer's filters.
-func (f *Filterer) Disallow(path string) bool {
- // Ensure trailing but not leading slash.
- path = strings.TrimPrefix(path, "/")
- if !strings.HasSuffix(path, "/") {
- path += "/"
- }
+ return func(path string) bool {
+ // Ensure leading and trailing slashes.
+ if !strings.HasPrefix(path, "/") {
+ path = "/" + path
+ }
+ if !strings.HasSuffix(path, "/") {
+ path += "/"
+ }
- // TODO(adonovan): opt: iterate in reverse and break at first match.
- excluded := false
- for i, filter := range f.filters {
- if filter.MatchString(path) {
- excluded = f.excluded[i] // last match wins
+ // TODO(adonovan): opt: iterate in reverse and break at first match.
+ include := true
+ for i, filter := range matchers {
+ if filter.MatchString(path) {
+ include = included[i] // last match wins
+ }
}
+ return include
}
- return excluded
}
// convertFilterToRegexp replaces glob-like operator substrings in a string file path to their equivalent regex forms.
@@ -60,7 +70,7 @@ func convertFilterToRegexp(filter string) *regexp.Regexp {
return regexp.MustCompile(".*")
}
var ret strings.Builder
- ret.WriteString("^")
+ ret.WriteString("^/")
segs := strings.Split(filter, "/")
for _, seg := range segs {
// Inv: seg != "" since path is clean.
@@ -77,7 +87,7 @@ func convertFilterToRegexp(filter string) *regexp.Regexp {
// BenchmarkWorkspaceSymbols time by ~20% (even though
// filter CPU time increased by only by ~2.5%) when the
// default filter was changed to "**/node_modules".
- pattern = strings.TrimPrefix(pattern, "^.*")
+ pattern = strings.TrimPrefix(pattern, "^/.*")
return regexp.MustCompile(pattern)
}
diff --git a/gopls/internal/cache/fs_memoized.go b/gopls/internal/cache/fs_memoized.go
index 9f156e3e153..a179b0ce7f5 100644
--- a/gopls/internal/cache/fs_memoized.go
+++ b/gopls/internal/cache/fs_memoized.go
@@ -41,6 +41,8 @@ type diskFile struct {
err error
}
+func (h *diskFile) String() string { return h.uri.Path() }
+
func (h *diskFile) URI() protocol.DocumentURI { return h.uri }
func (h *diskFile) Identity() file.Identity {
diff --git a/gopls/internal/cache/fs_overlay.go b/gopls/internal/cache/fs_overlay.go
index 265598bb967..b18d6d3f154 100644
--- a/gopls/internal/cache/fs_overlay.go
+++ b/gopls/internal/cache/fs_overlay.go
@@ -64,6 +64,8 @@ type overlay struct {
saved bool
}
+func (o *overlay) String() string { return o.uri.Path() }
+
func (o *overlay) URI() protocol.DocumentURI { return o.uri }
func (o *overlay) Identity() file.Identity {
diff --git a/gopls/internal/cache/load.go b/gopls/internal/cache/load.go
index 140cbc45490..e15e0cef0b6 100644
--- a/gopls/internal/cache/load.go
+++ b/gopls/internal/cache/load.go
@@ -365,7 +365,7 @@ func (s *Snapshot) config(ctx context.Context, allowNetwork AllowNetwork) *packa
packages.NeedForTest,
Fset: nil, // we do our own parsing
Overlay: s.buildOverlays(),
- Logf: func(format string, args ...interface{}) {
+ Logf: func(format string, args ...any) {
if s.view.folder.Options.VerboseOutput {
event.Log(ctx, fmt.Sprintf(format, args...))
}
diff --git a/gopls/internal/cache/metadata/graph.go b/gopls/internal/cache/metadata/graph.go
index 4b846df53be..716b767e37b 100644
--- a/gopls/internal/cache/metadata/graph.go
+++ b/gopls/internal/cache/metadata/graph.go
@@ -5,7 +5,9 @@
package metadata
import (
+ "iter"
"sort"
+ "strings"
"golang.org/x/tools/go/packages"
"golang.org/x/tools/gopls/internal/protocol"
@@ -99,6 +101,11 @@ func newGraph(pkgs map[PackageID]*Package) *Graph {
for _, uri := range mp.GoFiles {
uris[uri] = struct{}{}
}
+ for _, uri := range mp.OtherFiles {
+ if strings.HasSuffix(string(uri), ".s") { // assembly
+ uris[uri] = struct{}{}
+ }
+ }
for uri := range uris {
uriIDs[uri] = append(uriIDs[uri], id)
}
@@ -160,6 +167,35 @@ func (g *Graph) ReverseReflexiveTransitiveClosure(ids ...PackageID) map[PackageI
return seen
}
+// ForwardReflexiveTransitiveClosure returns an iterator over the
+// specified nodes and all their forward dependencies, in an arbitrary
+// topological (dependencies-first) order. The order may vary.
+func (g *Graph) ForwardReflexiveTransitiveClosure(ids ...PackageID) iter.Seq[*Package] {
+ return func(yield func(*Package) bool) {
+ seen := make(map[PackageID]bool)
+ var visit func(PackageID) bool
+ visit = func(id PackageID) bool {
+ if !seen[id] {
+ seen[id] = true
+ if mp := g.Packages[id]; mp != nil {
+ for _, depID := range mp.DepsByPkgPath {
+ if !visit(depID) {
+ return false
+ }
+ }
+ if !yield(mp) {
+ return false
+ }
+ }
+ }
+ return true
+ }
+ for _, id := range ids {
+ visit(id)
+ }
+ }
+}
+
// breakImportCycles breaks import cycles in the metadata by deleting
// Deps* edges. It modifies only metadata present in the 'updates'
// subset. This function has an internal test.
diff --git a/gopls/internal/cache/methodsets/methodsets.go b/gopls/internal/cache/methodsets/methodsets.go
index 3026819ee81..2387050f2d9 100644
--- a/gopls/internal/cache/methodsets/methodsets.go
+++ b/gopls/internal/cache/methodsets/methodsets.go
@@ -52,6 +52,7 @@ import (
"golang.org/x/tools/go/types/objectpath"
"golang.org/x/tools/gopls/internal/util/bug"
+ "golang.org/x/tools/gopls/internal/util/fingerprint"
"golang.org/x/tools/gopls/internal/util/frob"
"golang.org/x/tools/gopls/internal/util/safetoken"
"golang.org/x/tools/internal/typesinternal"
@@ -195,7 +196,7 @@ func implements(x, y *gobMethodSet) bool {
// so a string match is sufficient.
match = mx.Sum&my.Sum == my.Sum && mx.Fingerprint == my.Fingerprint
} else {
- match = unify(mx.parse(), my.parse())
+ match = fingerprint.Matches(mx.parse(), my.parse())
}
return !match
}
@@ -326,7 +327,7 @@ func methodSetInfo(t types.Type, setIndexInfo func(*gobMethod, *types.Func)) *go
for i := 0; i < mset.Len(); i++ {
m := mset.At(i).Obj().(*types.Func)
id := m.Id()
- fp, isTricky := fingerprint(m.Signature())
+ fp, isTricky := fingerprint.Encode(m.Signature())
if isTricky {
tricky = true
}
@@ -389,7 +390,7 @@ type gobMethod struct {
ObjectPath int // object path of method relative to PkgPath
// internal fields (not serialized)
- tree atomic.Pointer[sexpr] // fingerprint tree, parsed on demand
+ tree atomic.Pointer[fingerprint.Tree] // fingerprint tree, parsed on demand
}
// A gobPosition records the file, offset, and length of an identifier.
@@ -400,10 +401,10 @@ type gobPosition struct {
// parse returns the method's parsed fingerprint tree.
// It may return a new instance or a cached one.
-func (m *gobMethod) parse() sexpr {
+func (m *gobMethod) parse() fingerprint.Tree {
ptr := m.tree.Load()
if ptr == nil {
- tree := parseFingerprint(m.Fingerprint)
+ tree := fingerprint.Parse(m.Fingerprint)
ptr = &tree
m.tree.Store(ptr) // may race; that's ok
}
diff --git a/gopls/internal/cache/mod.go b/gopls/internal/cache/mod.go
index f16cfbfe1af..f6dd22754cc 100644
--- a/gopls/internal/cache/mod.go
+++ b/gopls/internal/cache/mod.go
@@ -45,14 +45,14 @@ func (s *Snapshot) ParseMod(ctx context.Context, fh file.Handle) (*ParsedModule,
// cache miss?
if !hit {
- promise, release := s.store.Promise(parseModKey(fh.Identity()), func(ctx context.Context, _ interface{}) interface{} {
+ promise, release := s.store.Promise(parseModKey(fh.Identity()), func(ctx context.Context, _ any) any {
parsed, err := parseModImpl(ctx, fh)
return parseModResult{parsed, err}
})
entry = promise
s.mu.Lock()
- s.parseModHandles.Set(uri, entry, func(_, _ interface{}) { release() })
+ s.parseModHandles.Set(uri, entry, func(_, _ any) { release() })
s.mu.Unlock()
}
@@ -131,14 +131,14 @@ func (s *Snapshot) ParseWork(ctx context.Context, fh file.Handle) (*ParsedWorkFi
// cache miss?
if !hit {
- handle, release := s.store.Promise(parseWorkKey(fh.Identity()), func(ctx context.Context, _ interface{}) interface{} {
+ handle, release := s.store.Promise(parseWorkKey(fh.Identity()), func(ctx context.Context, _ any) any {
parsed, err := parseWorkImpl(ctx, fh)
return parseWorkResult{parsed, err}
})
entry = handle
s.mu.Lock()
- s.parseWorkHandles.Set(uri, entry, func(_, _ interface{}) { release() })
+ s.parseWorkHandles.Set(uri, entry, func(_, _ any) { release() })
s.mu.Unlock()
}
@@ -212,7 +212,7 @@ func (s *Snapshot) ModWhy(ctx context.Context, fh file.Handle) (map[string]strin
// cache miss?
if !hit {
- handle := memoize.NewPromise("modWhy", func(ctx context.Context, arg interface{}) interface{} {
+ handle := memoize.NewPromise("modWhy", func(ctx context.Context, arg any) any {
why, err := modWhyImpl(ctx, arg.(*Snapshot), fh)
return modWhyResult{why, err}
})
diff --git a/gopls/internal/cache/mod_tidy.go b/gopls/internal/cache/mod_tidy.go
index 4d473d39b12..6d9a3e56b81 100644
--- a/gopls/internal/cache/mod_tidy.go
+++ b/gopls/internal/cache/mod_tidy.go
@@ -76,7 +76,7 @@ func (s *Snapshot) ModTidy(ctx context.Context, pm *ParsedModule) (*TidiedModule
return nil, err
}
- handle := memoize.NewPromise("modTidy", func(ctx context.Context, arg interface{}) interface{} {
+ handle := memoize.NewPromise("modTidy", func(ctx context.Context, arg any) any {
tidied, err := modTidyImpl(ctx, arg.(*Snapshot), pm)
return modTidyResult{tidied, err}
})
diff --git a/gopls/internal/cache/mod_vuln.go b/gopls/internal/cache/mod_vuln.go
index a92f5b5abe1..a48b18e4ba4 100644
--- a/gopls/internal/cache/mod_vuln.go
+++ b/gopls/internal/cache/mod_vuln.go
@@ -40,7 +40,7 @@ func (s *Snapshot) ModVuln(ctx context.Context, modURI protocol.DocumentURI) (*v
// Cache miss?
if !hit {
- handle := memoize.NewPromise("modVuln", func(ctx context.Context, arg interface{}) interface{} {
+ handle := memoize.NewPromise("modVuln", func(ctx context.Context, arg any) any {
result, err := modVulnImpl(ctx, arg.(*Snapshot))
return modVuln{result, err}
})
diff --git a/gopls/internal/cache/parse_cache.go b/gopls/internal/cache/parse_cache.go
index 8586f655d28..015510b881d 100644
--- a/gopls/internal/cache/parse_cache.go
+++ b/gopls/internal/cache/parse_cache.go
@@ -195,7 +195,7 @@ func (c *parseCache) startParse(mode parser.Mode, purgeFuncBodies bool, fhs ...f
}
uri := fh.URI()
- promise := memoize.NewPromise("parseCache.parse", func(ctx context.Context, _ interface{}) interface{} {
+ promise := memoize.NewPromise("parseCache.parse", func(ctx context.Context, _ any) any {
// Allocate 2*len(content)+parsePadding to allow for re-parsing once
// inside of parseGoSrc without exceeding the allocated space.
base, nextBase := c.allocateSpace(2*len(content) + parsePadding)
@@ -404,13 +404,13 @@ func (q queue) Swap(i, j int) {
q[j].lruIndex = j
}
-func (q *queue) Push(x interface{}) {
+func (q *queue) Push(x any) {
e := x.(*parseCacheEntry)
e.lruIndex = len(*q)
*q = append(*q, e)
}
-func (q *queue) Pop() interface{} {
+func (q *queue) Pop() any {
last := len(*q) - 1
e := (*q)[last]
(*q)[last] = nil // aid GC
diff --git a/gopls/internal/cache/parse_cache_test.go b/gopls/internal/cache/parse_cache_test.go
index 7aefac77c38..fe0548aa20d 100644
--- a/gopls/internal/cache/parse_cache_test.go
+++ b/gopls/internal/cache/parse_cache_test.go
@@ -218,6 +218,10 @@ type fakeFileHandle struct {
hash file.Hash
}
+func (h fakeFileHandle) String() string {
+ return h.uri.Path()
+}
+
func (h fakeFileHandle) URI() protocol.DocumentURI {
return h.uri
}
diff --git a/gopls/internal/cache/parsego/file.go b/gopls/internal/cache/parsego/file.go
index 41fd1937ec1..2be4ed4b2ca 100644
--- a/gopls/internal/cache/parsego/file.go
+++ b/gopls/internal/cache/parsego/file.go
@@ -14,6 +14,7 @@ import (
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/gopls/internal/util/bug"
"golang.org/x/tools/gopls/internal/util/safetoken"
+ "golang.org/x/tools/internal/astutil/cursor"
)
// A File contains the results of parsing a Go file.
@@ -32,6 +33,8 @@ type File struct {
// actual content of the file if we have fixed the AST.
Src []byte
+ Cursor cursor.Cursor // cursor of *ast.File, sans sibling files
+
// fixedSrc and fixedAST report on "fixing" that occurred during parsing of
// this file.
//
@@ -71,6 +74,11 @@ func (pgf *File) PositionPos(p protocol.Position) (token.Pos, error) {
return safetoken.Pos(pgf.Tok, offset)
}
+// PosPosition returns a protocol Position for the token.Pos in this file.
+func (pgf *File) PosPosition(pos token.Pos) (protocol.Position, error) {
+ return pgf.Mapper.PosPosition(pgf.Tok, pos)
+}
+
// PosRange returns a protocol Range for the token.Pos interval in this file.
func (pgf *File) PosRange(start, end token.Pos) (protocol.Range, error) {
return pgf.Mapper.PosRange(pgf.Tok, start, end)
diff --git a/gopls/internal/cache/parsego/parse.go b/gopls/internal/cache/parsego/parse.go
index df167314b04..4b37816caff 100644
--- a/gopls/internal/cache/parsego/parse.go
+++ b/gopls/internal/cache/parsego/parse.go
@@ -23,11 +23,12 @@ import (
"reflect"
"slices"
+ "golang.org/x/tools/go/ast/inspector"
"golang.org/x/tools/gopls/internal/label"
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/gopls/internal/util/astutil"
- "golang.org/x/tools/gopls/internal/util/bug"
"golang.org/x/tools/gopls/internal/util/safetoken"
+ "golang.org/x/tools/internal/astutil/cursor"
"golang.org/x/tools/internal/diff"
"golang.org/x/tools/internal/event"
)
@@ -63,39 +64,8 @@ func Parse(ctx context.Context, fset *token.FileSet, uri protocol.DocumentURI, s
}
// Inv: file != nil.
- // Workaround for #70162 (missing File{Start,End} when
- // parsing empty file) with go1.23.
- //
- // When parsing an empty file, or one without a valid
- // package declaration, the go1.23 parser bails out before
- // setting FileStart and End.
- //
- // This leaves us no way to find the original
- // token.File that ParseFile created, so as a
- // workaround, we recreate the token.File, and
- // populate the FileStart and FileEnd fields.
- //
- // See also #53202.
tokenFile := func(file *ast.File) *token.File {
- tok := fset.File(file.FileStart)
- if tok == nil {
- // Invalid File.FileStart (also File.{Package,Name.Pos}).
- if file.Package.IsValid() {
- bug.Report("ast.File has valid Package but no FileStart")
- }
- if file.Name.Pos().IsValid() {
- bug.Report("ast.File has valid Name.Pos but no FileStart")
- }
- tok = fset.AddFile(uri.Path(), -1, len(src))
- tok.SetLinesForContent(src)
- // If the File contained any valid token.Pos values,
- // they would all be invalid wrt the new token.File,
- // but we have established that it lacks FileStart,
- // Package, and Name.Pos.
- file.FileStart = token.Pos(tok.Base())
- file.FileEnd = token.Pos(tok.Base() + tok.Size())
- }
- return tok
+ return fset.File(file.FileStart)
}
tok := tokenFile(file)
@@ -153,6 +123,11 @@ func Parse(ctx context.Context, fset *token.FileSet, uri protocol.DocumentURI, s
}
assert(file != nil, "nil *ast.File")
+ // Provide a cursor for fast and convenient navigation.
+ inspect := inspector.New([]*ast.File{file})
+ curFile, _ := cursor.Root(inspect).FirstChild()
+ _ = curFile.Node().(*ast.File)
+
return &File{
URI: uri,
Mode: mode,
@@ -161,6 +136,7 @@ func Parse(ctx context.Context, fset *token.FileSet, uri protocol.DocumentURI, s
fixedAST: fixedAST,
File: file,
Tok: tok,
+ Cursor: curFile,
Mapper: protocol.NewMapper(uri, src),
ParseErr: parseErr,
}, fixes
@@ -552,11 +528,12 @@ func fixInitStmt(bad *ast.BadExpr, parent ast.Node, tok *token.File, src []byte)
}
// Try to extract a statement from the BadExpr.
- start, end, err := safetoken.Offsets(tok, bad.Pos(), bad.End()-1)
+ start, end, err := safetoken.Offsets(tok, bad.Pos(), bad.End())
if err != nil {
return false
}
- stmtBytes := src[start : end+1]
+ assert(end <= len(src), "offset overflow") // golang/go#72026
+ stmtBytes := src[start:end]
stmt, err := parseStmt(tok, bad.Pos(), stmtBytes)
if err != nil {
return false
diff --git a/gopls/internal/cache/port.go b/gopls/internal/cache/port.go
index 40005bcf6d4..8caaa801b68 100644
--- a/gopls/internal/cache/port.go
+++ b/gopls/internal/cache/port.go
@@ -7,6 +7,7 @@ package cache
import (
"bytes"
"go/build"
+ "go/build/constraint"
"go/parser"
"go/token"
"io"
@@ -173,12 +174,16 @@ func (p port) matches(path string, content []byte) bool {
// without trimming content.
func trimContentForPortMatch(content []byte) []byte {
buildComment := buildComment(content)
- return []byte(buildComment + "\npackage p") // package name does not matter
+ // The package name does not matter, but +build lines
+ // require a blank line before the package declaration.
+ return []byte(buildComment + "\n\npackage p")
}
// buildComment returns the first matching //go:build comment in the given
// content, or "" if none exists.
func buildComment(content []byte) string {
+ var lines []string
+
f, err := parser.ParseFile(token.NewFileSet(), "", content, parser.PackageClauseOnly|parser.ParseComments)
if err != nil {
return ""
@@ -186,24 +191,15 @@ func buildComment(content []byte) string {
for _, cg := range f.Comments {
for _, c := range cg.List {
- if isGoBuildComment(c.Text) {
+ if constraint.IsGoBuild(c.Text) {
+ // A file must have only one //go:build line.
return c.Text
}
+ if constraint.IsPlusBuild(c.Text) {
+ // A file may have several // +build lines.
+ lines = append(lines, c.Text)
+ }
}
}
- return ""
-}
-
-// Adapted from go/build/build.go.
-//
-// TODO(rfindley): use constraint.IsGoBuild once we are on 1.19+.
-func isGoBuildComment(line string) bool {
- const goBuildComment = "//go:build"
- if !strings.HasPrefix(line, goBuildComment) {
- return false
- }
- // Report whether //go:build is followed by a word boundary.
- line = strings.TrimSpace(line)
- rest := line[len(goBuildComment):]
- return len(rest) == 0 || len(strings.TrimSpace(rest)) < len(rest)
+ return strings.Join(lines, "\n")
}
diff --git a/gopls/internal/cache/session.go b/gopls/internal/cache/session.go
index a7fb618f679..c46fc78b975 100644
--- a/gopls/internal/cache/session.go
+++ b/gopls/internal/cache/session.go
@@ -169,14 +169,14 @@ func (s *Session) createView(ctx context.Context, def *viewDefinition) (*View, *
// Compute a prefix match, respecting segment boundaries, by ensuring
// the pattern (dir) has a trailing slash.
dirPrefix := strings.TrimSuffix(string(def.folder.Dir), "/") + "/"
- filterer := NewFilterer(def.folder.Options.DirectoryFilters)
+ pathIncluded := PathIncludeFunc(def.folder.Options.DirectoryFilters)
skipPath = func(dir string) bool {
uri := strings.TrimSuffix(string(protocol.URIFromPath(dir)), "/")
// Note that the logic below doesn't handle the case where uri ==
// v.folder.Dir, because there is no point in excluding the entire
// workspace folder!
if rel := strings.TrimPrefix(uri, dirPrefix); rel != uri {
- return filterer.Disallow(rel)
+ return !pathIncluded(rel)
}
return false
}
@@ -238,7 +238,12 @@ func (s *Session) createView(ctx context.Context, def *viewDefinition) (*View, *
viewDefinition: def,
importsState: newImportsState(backgroundCtx, s.cache.modCache, pe),
}
- if def.folder.Options.ImportsSource != settings.ImportsSourceOff {
+
+ // Keep this in sync with golang.computeImportEdits.
+ //
+ // TODO(rfindley): encapsulate the imports state logic so that the handling
+ // for Options.ImportsSource is in a single location.
+ if def.folder.Options.ImportsSource == settings.ImportsSourceGopls {
v.modcacheState = newModcacheState(def.folder.Env.GOMODCACHE)
}
@@ -1079,6 +1084,7 @@ type brokenFile struct {
err error
}
+func (b brokenFile) String() string { return b.uri.Path() }
func (b brokenFile) URI() protocol.DocumentURI { return b.uri }
func (b brokenFile) Identity() file.Identity { return file.Identity{URI: b.uri} }
func (b brokenFile) SameContentsOnDisk() bool { return false }
diff --git a/gopls/internal/cache/session_test.go b/gopls/internal/cache/session_test.go
index 5f9a59a4945..1b7472af605 100644
--- a/gopls/internal/cache/session_test.go
+++ b/gopls/internal/cache/session_test.go
@@ -337,7 +337,8 @@ replace (
for _, f := range test.folders {
opts := settings.DefaultOptions()
if f.options != nil {
- for _, err := range opts.Set(f.options(dir)) {
+ _, errs := opts.Set(f.options(dir))
+ for _, err := range errs {
t.Fatal(err)
}
}
diff --git a/gopls/internal/cache/snapshot.go b/gopls/internal/cache/snapshot.go
index c341ac6e85a..754389c7008 100644
--- a/gopls/internal/cache/snapshot.go
+++ b/gopls/internal/cache/snapshot.go
@@ -323,6 +323,8 @@ func fileKind(fh file.Handle) file.Kind {
return file.Sum
case ".work":
return file.Work
+ case ".s":
+ return file.Asm
}
return file.UnknownKind
}
@@ -645,6 +647,21 @@ func (s *Snapshot) Tests(ctx context.Context, ids ...PackageID) ([]*testfuncs.In
return indexes, s.forEachPackage(ctx, ids, pre, post)
}
+// NarrowestMetadataForFile returns metadata for the narrowest package
+// (the one with the fewest files) that encloses the specified file.
+// The result may be a test variant, but never an intermediate test variant.
+func (snapshot *Snapshot) NarrowestMetadataForFile(ctx context.Context, uri protocol.DocumentURI) (*metadata.Package, error) {
+ mps, err := snapshot.MetadataForFile(ctx, uri)
+ if err != nil {
+ return nil, err
+ }
+ metadata.RemoveIntermediateTestVariants(&mps)
+ if len(mps) == 0 {
+ return nil, fmt.Errorf("no package metadata for file %s", uri)
+ }
+ return mps[0], nil
+}
+
// MetadataForFile returns a new slice containing metadata for each
// package containing the Go file identified by uri, ordered by the
// number of CompiledGoFiles (i.e. "narrowest" to "widest" package),
@@ -652,6 +669,10 @@ func (s *Snapshot) Tests(ctx context.Context, ids ...PackageID) ([]*testfuncs.In
// The result may include tests and intermediate test variants of
// importable packages.
// It returns an error if the context was cancelled.
+//
+// TODO(adonovan): in nearly all cases the caller must use
+// [metadata.RemoveIntermediateTestVariants]. Make this a parameter to
+// force the caller to consider it (and reduce code).
func (s *Snapshot) MetadataForFile(ctx context.Context, uri protocol.DocumentURI) ([]*metadata.Package, error) {
if s.view.typ == AdHocView {
// As described in golang/go#57209, in ad-hoc workspaces (where we load ./
@@ -1301,7 +1322,7 @@ searchOverlays:
// where the file is inside a workspace module, but perhaps no packages
// were loaded for that module.
_, loadedMod := loadedModFiles[goMod]
- _, workspaceMod := s.view.viewDefinition.workspaceModFiles[goMod]
+ _, workspaceMod := s.view.workspaceModFiles[goMod]
// If we have a relevant go.mod file, check whether the file is orphaned
// due to its go.mod file being inactive. We could also offer a
// prescriptive diagnostic in the case that there is no go.mod file, but
diff --git a/gopls/internal/cache/source.go b/gopls/internal/cache/source.go
index 3e21c641651..7946b9746ab 100644
--- a/gopls/internal/cache/source.go
+++ b/gopls/internal/cache/source.go
@@ -61,9 +61,7 @@ func (s *goplsSource) ResolveReferences(ctx context.Context, filename string, mi
// collect the ones that are still
needed := maps.Clone(missing)
for _, a := range fromWS {
- if _, ok := needed[a.Package.Name]; ok {
- delete(needed, a.Package.Name)
- }
+ delete(needed, a.Package.Name)
}
// when debug (below) is gone, change this to: if len(needed) == 0 {return fromWS, nil}
var fromCache []*result
@@ -184,10 +182,13 @@ type found struct {
func (s *goplsSource) resolveWorkspaceReferences(filename string, missing imports.References) ([]*imports.Result, error) {
uri := protocol.URIFromPath(filename)
mypkgs, err := s.S.MetadataForFile(s.ctx, uri)
- if len(mypkgs) != 1 {
- // what does this mean? can it happen?
+ if err != nil {
+ return nil, err
+ }
+ if len(mypkgs) == 0 {
+ return nil, nil
}
- mypkg := mypkgs[0]
+ mypkg := mypkgs[0] // narrowest package
// search the metadata graph for package ids correstponding to missing
g := s.S.MetadataGraph()
var ids []metadata.PackageID
@@ -211,7 +212,7 @@ func (s *goplsSource) resolveWorkspaceReferences(filename string, missing import
// keep track of used syms and found results by package name
// TODO: avoid import cycles (is current package in forward closure)
founds := make(map[string][]found)
- for i := 0; i < len(ids); i++ {
+ for i := range len(ids) {
nm := string(pkgs[i].Name)
if satisfies(syms[i], missing[nm]) {
got := &imports.Result{
diff --git a/gopls/internal/cache/testfuncs/tests.go b/gopls/internal/cache/testfuncs/tests.go
index 1182795b37b..e0e3ce1beca 100644
--- a/gopls/internal/cache/testfuncs/tests.go
+++ b/gopls/internal/cache/testfuncs/tests.go
@@ -57,6 +57,7 @@ func NewIndex(files []*parsego.File, info *types.Info) *Index {
b := &indexBuilder{
fileIndex: make(map[protocol.DocumentURI]int),
subNames: make(map[string]int),
+ visited: make(map[*types.Func]bool),
}
return b.build(files, info)
}
@@ -101,6 +102,7 @@ func (b *indexBuilder) build(files []*parsego.File, info *types.Info) *Index {
}
b.Files[i].Tests = append(b.Files[i].Tests, t)
+ b.visited[obj] = true
// Check for subtests
if isTest {
@@ -168,27 +170,48 @@ func (b *indexBuilder) findSubtests(parent gobTest, typ *ast.FuncType, body *ast
t.Location.Range, _ = file.NodeRange(call)
tests = append(tests, t)
- if typ, body := findFunc(files, info, body, call.Args[1]); typ != nil {
+ fn, typ, body := findFunc(files, info, body, call.Args[1])
+ if typ == nil {
+ continue
+ }
+
+ // Function literals don't have an associated object
+ if fn == nil {
tests = append(tests, b.findSubtests(t, typ, body, file, files, info)...)
+ continue
+ }
+
+ // Never recurse if the second argument is a top-level test function
+ if isTest, _ := isTestOrExample(fn); isTest {
+ continue
+ }
+
+ // Don't recurse into functions that have already been visited
+ if b.visited[fn] {
+ continue
}
+
+ b.visited[fn] = true
+ tests = append(tests, b.findSubtests(t, typ, body, file, files, info)...)
}
return tests
}
// findFunc finds the type and body of the given expr, which may be a function
-// literal or reference to a declared function.
-//
-// If no function is found, findFunc returns (nil, nil).
-func findFunc(files []*parsego.File, info *types.Info, body *ast.BlockStmt, expr ast.Expr) (*ast.FuncType, *ast.BlockStmt) {
+// literal or reference to a declared function. If the expression is a declared
+// function, findFunc returns its [types.Func]. If the expression is a function
+// literal, findFunc returns nil for the first return value. If no function is
+// found, findFunc returns (nil, nil, nil).
+func findFunc(files []*parsego.File, info *types.Info, body *ast.BlockStmt, expr ast.Expr) (*types.Func, *ast.FuncType, *ast.BlockStmt) {
var obj types.Object
switch arg := expr.(type) {
case *ast.FuncLit:
- return arg.Type, arg.Body
+ return nil, arg.Type, arg.Body
case *ast.Ident:
obj = info.ObjectOf(arg)
if obj == nil {
- return nil, nil
+ return nil, nil, nil
}
case *ast.SelectorExpr:
@@ -198,12 +221,12 @@ func findFunc(files []*parsego.File, info *types.Info, body *ast.BlockStmt, expr
// complex. However, those cases should be rare.
sel, ok := info.Selections[arg]
if !ok {
- return nil, nil
+ return nil, nil, nil
}
obj = sel.Obj()
default:
- return nil, nil
+ return nil, nil, nil
}
if v, ok := obj.(*types.Var); ok {
@@ -211,7 +234,7 @@ func findFunc(files []*parsego.File, info *types.Info, body *ast.BlockStmt, expr
// the file), but that doesn't account for assignment. If the variable
// is assigned multiple times, we could easily get the wrong one.
_, _ = v, body
- return nil, nil
+ return nil, nil, nil
}
for _, file := range files {
@@ -228,11 +251,11 @@ func findFunc(files []*parsego.File, info *types.Info, body *ast.BlockStmt, expr
}
if info.ObjectOf(decl.Name) == obj {
- return decl.Type, decl.Body
+ return obj.(*types.Func), decl.Type, decl.Body
}
}
}
- return nil, nil
+ return nil, nil, nil
}
// isTestOrExample reports whether the given func is a testing func or an
@@ -308,6 +331,7 @@ type indexBuilder struct {
gobPackage
fileIndex map[protocol.DocumentURI]int
subNames map[string]int
+ visited map[*types.Func]bool
}
// -- serial format of index --
diff --git a/gopls/internal/cache/view.go b/gopls/internal/cache/view.go
index 26f0de86125..6bb0ae8edeb 100644
--- a/gopls/internal/cache/view.go
+++ b/gopls/internal/cache/view.go
@@ -20,7 +20,6 @@ import (
"os/exec"
"path"
"path/filepath"
- "regexp"
"slices"
"sort"
"strings"
@@ -109,7 +108,10 @@ type View struct {
// importsState is for the old imports code
importsState *importsState
- // maintain the current module cache index
+ // modcacheState is the replacement for importsState, to be used for
+ // goimports operations when the imports source is "gopls".
+ //
+ // It may be nil, if the imports source is not "gopls".
modcacheState *modcacheState
// pkgIndex is an index of package IDs, for efficient storage of typerefs.
@@ -475,11 +477,11 @@ func (v *View) filterFunc() func(protocol.DocumentURI) bool {
modcacheFilter := "-" + strings.TrimPrefix(filepath.ToSlash(pref), "/")
filters = append(filters, modcacheFilter)
}
- filterer := NewFilterer(filters)
+ pathIncluded := PathIncludeFunc(filters)
v._filterFunc = func(uri protocol.DocumentURI) bool {
// Only filter relative to the configured root directory.
if pathutil.InDir(folderDir, uri.Path()) {
- return relPathExcludedByFilter(strings.TrimPrefix(uri.Path(), folderDir), filterer)
+ return relPathExcludedByFilter(strings.TrimPrefix(uri.Path(), folderDir), pathIncluded)
}
return false
}
@@ -492,7 +494,9 @@ func (v *View) shutdown() {
// Cancel the initial workspace load if it is still running.
v.cancelInitialWorkspaceLoad()
v.importsState.stopTimer()
- v.modcacheState.stopTimer()
+ if v.modcacheState != nil {
+ v.modcacheState.stopTimer()
+ }
v.snapshotMu.Lock()
if v.snapshot != nil {
@@ -1248,8 +1252,6 @@ func globsMatchPath(globs, target string) bool {
return false
}
-var modFlagRegexp = regexp.MustCompile(`-mod[ =](\w+)`)
-
// TODO(rfindley): clean up the redundancy of allFilesExcluded,
// pathExcludedByFilterFunc, pathExcludedByFilter, view.filterFunc...
func allFilesExcluded(files []string, filterFunc func(protocol.DocumentURI) bool) bool {
@@ -1262,7 +1264,7 @@ func allFilesExcluded(files []string, filterFunc func(protocol.DocumentURI) bool
return true
}
-func relPathExcludedByFilter(path string, filterer *Filterer) bool {
+func relPathExcludedByFilter(path string, pathIncluded func(string) bool) bool {
path = strings.TrimPrefix(filepath.ToSlash(path), "/")
- return filterer.Disallow(path)
+ return !pathIncluded(path)
}
diff --git a/gopls/internal/cache/view_test.go b/gopls/internal/cache/view_test.go
index 992a3d61828..46000191e42 100644
--- a/gopls/internal/cache/view_test.go
+++ b/gopls/internal/cache/view_test.go
@@ -90,14 +90,14 @@ func TestFilters(t *testing.T) {
}
for _, tt := range tests {
- filterer := NewFilterer(tt.filters)
+ pathIncluded := PathIncludeFunc(tt.filters)
for _, inc := range tt.included {
- if relPathExcludedByFilter(inc, filterer) {
+ if relPathExcludedByFilter(inc, pathIncluded) {
t.Errorf("filters %q excluded %v, wanted included", tt.filters, inc)
}
}
for _, exc := range tt.excluded {
- if !relPathExcludedByFilter(exc, filterer) {
+ if !relPathExcludedByFilter(exc, pathIncluded) {
t.Errorf("filters %q included %v, wanted excluded", tt.filters, exc)
}
}
diff --git a/gopls/internal/cache/xrefs/xrefs.go b/gopls/internal/cache/xrefs/xrefs.go
index 2115322bfdc..d9b7051737a 100644
--- a/gopls/internal/cache/xrefs/xrefs.go
+++ b/gopls/internal/cache/xrefs/xrefs.go
@@ -44,8 +44,8 @@ func Index(files []*parsego.File, pkg *types.Package, info *types.Info) []byte {
objectpathFor := new(objectpath.Encoder).For
for fileIndex, pgf := range files {
- ast.Inspect(pgf.File, func(n ast.Node) bool {
- switch n := n.(type) {
+ for cur := range pgf.Cursor.Preorder((*ast.Ident)(nil), (*ast.ImportSpec)(nil)) {
+ switch n := cur.Node().(type) {
case *ast.Ident:
// Report a reference for each identifier that
// uses a symbol exported from another package.
@@ -68,7 +68,7 @@ func Index(files []*parsego.File, pkg *types.Package, info *types.Info) []byte {
if err != nil {
// Capitalized but not exported
// (e.g. local const/var/type).
- return true
+ continue
}
gobObj = &gobObject{Path: path}
objects[obj] = gobObj
@@ -91,7 +91,7 @@ func Index(files []*parsego.File, pkg *types.Package, info *types.Info) []byte {
// string to the imported package.
pkgname := info.PkgNameOf(n)
if pkgname == nil {
- return true // missing import
+ continue // missing import
}
objects := getObjects(pkgname.Imported())
gobObj, ok := objects[nil]
@@ -109,8 +109,7 @@ func Index(files []*parsego.File, pkg *types.Package, info *types.Info) []byte {
bug.Reportf("out of bounds import spec %+v", n.Path)
}
}
- return true
- })
+ }
}
// Flatten the maps into slices, and sort for determinism.
diff --git a/gopls/internal/cmd/check.go b/gopls/internal/cmd/check.go
index d256fa9de2a..8c0362b148a 100644
--- a/gopls/internal/cmd/check.go
+++ b/gopls/internal/cmd/check.go
@@ -16,7 +16,8 @@ import (
// check implements the check verb for gopls.
type check struct {
- app *Application
+ app *Application
+ Severity string `flag:"severity" help:"minimum diagnostic severity (hint, info, warning, or error)"`
}
func (c *check) Name() string { return "check" }
@@ -35,6 +36,20 @@ Example: show the diagnostic results of this file:
// Run performs the check on the files specified by args and prints the
// results to stdout.
func (c *check) Run(ctx context.Context, args ...string) error {
+ severityCutoff := protocol.SeverityWarning
+ switch c.Severity {
+ case "hint":
+ severityCutoff = protocol.SeverityHint
+ case "info":
+ severityCutoff = protocol.SeverityInformation
+ case "warning":
+ // default
+ case "error":
+ severityCutoff = protocol.SeverityError
+ default:
+ return fmt.Errorf("unrecognized -severity value %q", c.Severity)
+ }
+
if len(args) == 0 {
return nil
}
@@ -95,6 +110,9 @@ func (c *check) Run(ctx context.Context, args ...string) error {
file.diagnosticsMu.Unlock()
for _, diag := range diags {
+ if diag.Severity > severityCutoff { // lower severity value => greater severity, counterintuitively
+ continue
+ }
if err := print(file.uri, diag.Range, diag.Message); err != nil {
return err
}
diff --git a/gopls/internal/cmd/cmd.go b/gopls/internal/cmd/cmd.go
index a647b3198df..fed96388fb4 100644
--- a/gopls/internal/cmd/cmd.go
+++ b/gopls/internal/cmd/cmd.go
@@ -63,9 +63,6 @@ type Application struct {
// VeryVerbose enables a higher level of verbosity in logging output.
VeryVerbose bool `flag:"vv,veryverbose" help:"very verbose output"`
- // Control ocagent export of telemetry
- OCAgent string `flag:"ocagent" help:"the address of the ocagent (e.g. http://localhost:55678), or off"`
-
// PrepareOptions is called to update the options when a new view is built.
// It is primarily to allow the behavior of gopls to be modified by hooks.
PrepareOptions func(*settings.Options)
@@ -98,8 +95,6 @@ func (app *Application) verbose() bool {
// New returns a new Application ready to run.
func New() *Application {
app := &Application{
- OCAgent: "off", //TODO: Remove this line to default the exporter to on
-
Serve: Serve{
RemoteListenTimeout: 1 * time.Minute,
},
@@ -238,7 +233,7 @@ func (app *Application) Run(ctx context.Context, args ...string) error {
// executable, and immediately runs a gc.
filecache.Start()
- ctx = debug.WithInstance(ctx, app.OCAgent)
+ ctx = debug.WithInstance(ctx)
if len(args) == 0 {
s := flag.NewFlagSet(app.Name(), flag.ExitOnError)
return tool.Run(ctx, s, &app.Serve, args)
@@ -284,7 +279,7 @@ func (app *Application) internalCommands() []tool.Application {
func (app *Application) featureCommands() []tool.Application {
return []tool.Application{
&callHierarchy{app: app},
- &check{app: app},
+ &check{app: app, Severity: "warning"},
&codeaction{app: app},
&codelens{app: app},
&definition{app: app},
@@ -310,11 +305,6 @@ func (app *Application) featureCommands() []tool.Application {
}
}
-var (
- internalMu sync.Mutex
- internalConnections = make(map[string]*connection)
-)
-
// connect creates and initializes a new in-process gopls session.
func (app *Application) connect(ctx context.Context) (*connection, error) {
client := newClient(app)
@@ -353,7 +343,8 @@ func (c *connection) initialize(ctx context.Context, options func(*settings.Opti
// Make sure to respect configured options when sending initialize request.
opts := settings.DefaultOptions(options)
- // If you add an additional option here, you must update the map key in connect.
+ // If you add an additional option here,
+ // you must update the map key of settings.DefaultOptions called in (*Application).connect.
params.Capabilities.TextDocument.Hover = &protocol.HoverClientCapabilities{
ContentFormat: []protocol.MarkupKind{opts.PreferredContentFormat},
}
@@ -361,7 +352,7 @@ func (c *connection) initialize(ctx context.Context, options func(*settings.Opti
params.Capabilities.TextDocument.SemanticTokens = protocol.SemanticTokensClientCapabilities{}
params.Capabilities.TextDocument.SemanticTokens.Formats = []protocol.TokenFormat{"relative"}
params.Capabilities.TextDocument.SemanticTokens.Requests.Range = &protocol.Or_ClientSemanticTokensRequestOptions_range{Value: true}
- //params.Capabilities.TextDocument.SemanticTokens.Requests.Range.Value = true
+ // params.Capabilities.TextDocument.SemanticTokens.Requests.Range.Value = true
params.Capabilities.TextDocument.SemanticTokens.Requests.Full = &protocol.Or_ClientSemanticTokensRequestOptions_full{Value: true}
params.Capabilities.TextDocument.SemanticTokens.TokenTypes = moreslices.ConvertStrings[string](semtok.TokenTypes)
params.Capabilities.TextDocument.SemanticTokens.TokenModifiers = moreslices.ConvertStrings[string](semtok.TokenModifiers)
@@ -373,14 +364,17 @@ func (c *connection) initialize(ctx context.Context, options func(*settings.Opti
},
}
params.Capabilities.Window.WorkDoneProgress = true
+ params.Capabilities.Workspace.FileOperations = &protocol.FileOperationClientCapabilities{
+ DidCreate: true,
+ }
- params.InitializationOptions = map[string]interface{}{
+ params.InitializationOptions = map[string]any{
"symbolMatcher": string(opts.SymbolMatcher),
}
- if c.initializeResult, err = c.Server.Initialize(ctx, params); err != nil {
+ if c.initializeResult, err = c.Initialize(ctx, params); err != nil {
return err
}
- if err := c.Server.Initialized(ctx, &protocol.InitializedParams{}); err != nil {
+ if err := c.Initialized(ctx, &protocol.InitializedParams{}); err != nil {
return err
}
return nil
@@ -473,7 +467,7 @@ func (c *cmdClient) LogMessage(ctx context.Context, p *protocol.LogMessageParams
return nil
}
-func (c *cmdClient) Event(ctx context.Context, t *interface{}) error { return nil }
+func (c *cmdClient) Event(ctx context.Context, t *any) error { return nil }
func (c *cmdClient) RegisterCapability(ctx context.Context, p *protocol.RegistrationParams) error {
return nil
@@ -487,13 +481,13 @@ func (c *cmdClient) WorkspaceFolders(ctx context.Context) ([]protocol.WorkspaceF
return nil, nil
}
-func (c *cmdClient) Configuration(ctx context.Context, p *protocol.ParamConfiguration) ([]interface{}, error) {
- results := make([]interface{}, len(p.Items))
+func (c *cmdClient) Configuration(ctx context.Context, p *protocol.ParamConfiguration) ([]any, error) {
+ results := make([]any, len(p.Items))
for i, item := range p.Items {
if item.Section != "gopls" {
continue
}
- m := map[string]interface{}{
+ m := map[string]any{
"analyses": map[string]any{
"fillreturns": true,
"nonewvars": true,
@@ -663,7 +657,7 @@ func (c *cmdClient) PublishDiagnostics(ctx context.Context, p *protocol.PublishD
// TODO(golang/go#60122): replace the gopls.diagnose_files
// command with support for textDocument/diagnostic,
// so that we don't need to do this de-duplication.
- type key [6]interface{}
+ type key [6]any
seen := make(map[key]bool)
out := file.diagnostics[:0]
for _, d := range file.diagnostics {
@@ -778,10 +772,25 @@ func (c *connection) openFile(ctx context.Context, uri protocol.DocumentURI) (*c
return nil, file.err
}
+ // Choose language ID from file extension.
+ var langID protocol.LanguageKind // "" eventually maps to file.UnknownKind
+ switch filepath.Ext(uri.Path()) {
+ case ".go":
+ langID = "go"
+ case ".mod":
+ langID = "go.mod"
+ case ".sum":
+ langID = "go.sum"
+ case ".work":
+ langID = "go.work"
+ case ".s":
+ langID = "go.s"
+ }
+
p := &protocol.DidOpenTextDocumentParams{
TextDocument: protocol.TextDocumentItem{
URI: uri,
- LanguageID: "go",
+ LanguageID: langID,
Version: 1,
Text: string(file.mapper.Content),
},
@@ -812,10 +821,10 @@ func (c *connection) diagnoseFiles(ctx context.Context, files []protocol.Documen
}
func (c *connection) terminate(ctx context.Context) {
- //TODO: do we need to handle errors on these calls?
+ // TODO: do we need to handle errors on these calls?
c.Shutdown(ctx)
- //TODO: right now calling exit terminates the process, we should rethink that
- //server.Exit(ctx)
+ // TODO: right now calling exit terminates the process, we should rethink that
+ // server.Exit(ctx)
}
// Implement io.Closer.
diff --git a/gopls/internal/cmd/definition.go b/gopls/internal/cmd/definition.go
index d9cd98554e3..71e8b1511bd 100644
--- a/gopls/internal/cmd/definition.go
+++ b/gopls/internal/cmd/definition.go
@@ -96,7 +96,7 @@ func (d *definition) Run(ctx context.Context, args ...string) error {
}
if len(locs) == 0 {
- return fmt.Errorf("%v: not an identifier", from)
+ return fmt.Errorf("%v: no definition location (not an identifier?)", from)
}
file, err = conn.openFile(ctx, locs[0].URI)
if err != nil {
diff --git a/gopls/internal/cmd/integration_test.go b/gopls/internal/cmd/integration_test.go
index 42812a870a4..6e4b450635b 100644
--- a/gopls/internal/cmd/integration_test.go
+++ b/gopls/internal/cmd/integration_test.go
@@ -108,6 +108,12 @@ var C int
-- c/c2.go --
package c
var C int
+-- d/d.go --
+package d
+
+import "io/ioutil"
+
+var _ = ioutil.ReadFile
`)
// no files
@@ -141,6 +147,22 @@ var C int
res.checkStdout(`c2.go:2:5-6: C redeclared in this block`)
res.checkStdout(`c.go:2:5-6: - other declaration of C`)
}
+
+ // No deprecated (hint) diagnostic without -severity.
+ {
+ res := gopls(t, tree, "check", "./d/d.go")
+ res.checkExit(true)
+ if len(res.stdout) > 0 {
+ t.Errorf("check ./d/d.go returned unexpected output:\n%s", res.stdout)
+ }
+ }
+
+ // Deprecated (hint) diagnostics with -severity=hint
+ {
+ res := gopls(t, tree, "check", "-severity=hint", "./d/d.go")
+ res.checkExit(true)
+ res.checkStdout(`ioutil.ReadFile is deprecated`)
+ }
}
// TestCallHierarchy tests the 'call_hierarchy' subcommand (call_hierarchy.go).
@@ -486,6 +508,14 @@ func f() {
func TestImplementations(t *testing.T) {
t.Parallel()
+ // types.CheckExpr, now used in the rangeint modernizer, had a
+ // data race (#71817) that was fixed in go1.25 and backported
+ // to go1.24 but not to go1.23. Although in principle it could
+ // affect a lot of tests, it (weirdly) only seems to show up
+ // in this one (#72082). Rather than backport again, we
+ // suppress this test.
+ testenv.NeedsGo1Point(t, 24)
+
tree := writeTree(t, `
-- a.go --
package a
@@ -930,7 +960,7 @@ package foo
res3 := goplsWithEnv(t, tree, []string{"GOPACKAGESDRIVER=off"}, "stats", "-anon")
res3.checkExit(true)
- var statsAsMap3 map[string]interface{}
+ var statsAsMap3 map[string]any
if err := json.Unmarshal([]byte(res3.stdout), &statsAsMap3); err != nil {
t.Fatalf("failed to unmarshal JSON output of stats command: %v", err)
}
@@ -980,9 +1010,9 @@ type C struct{}
res := gopls(t, tree, "codeaction", "-title=Browse.*doc", "a/a.go")
res.checkExit(true)
got := res.stdout
- want := `command "Browse gopls feature documentation" [gopls.doc.features]` +
+ want := `command "Browse documentation for package a" [source.doc]` +
"\n" +
- `command "Browse documentation for package a" [source.doc]` +
+ `command "Browse gopls feature documentation" [gopls.doc.features]` +
"\n"
if got != want {
t.Errorf("codeaction: got <<%s>>, want <<%s>>\nstderr:\n%s", got, want, res.stderr)
@@ -1212,7 +1242,7 @@ func (res *result) checkOutput(pattern, name, content string) {
}
// toJSON decodes res.stdout as JSON into to *ptr and reports its success.
-func (res *result) toJSON(ptr interface{}) bool {
+func (res *result) toJSON(ptr any) bool {
if err := json.Unmarshal([]byte(res.stdout), ptr); err != nil {
res.t.Errorf("invalid JSON %v", err)
return false
diff --git a/gopls/internal/cmd/stats.go b/gopls/internal/cmd/stats.go
index cc19a94fb84..1ba43ccee83 100644
--- a/gopls/internal/cmd/stats.go
+++ b/gopls/internal/cmd/stats.go
@@ -164,7 +164,7 @@ func (s *stats) Run(ctx context.Context, args ...string) error {
}
// Filter JSON output to fields that are consistent with s.Anon.
- okFields := make(map[string]interface{})
+ okFields := make(map[string]any)
{
v := reflect.ValueOf(stats)
t := v.Type()
diff --git a/gopls/internal/cmd/symbols.go b/gopls/internal/cmd/symbols.go
index 663a08f4be1..15c593b0e74 100644
--- a/gopls/internal/cmd/symbols.go
+++ b/gopls/internal/cmd/symbols.go
@@ -53,7 +53,7 @@ func (r *symbols) Run(ctx context.Context, args ...string) error {
return err
}
for _, s := range symbols {
- if m, ok := s.(map[string]interface{}); ok {
+ if m, ok := s.(map[string]any); ok {
s, err = mapToSymbol(m)
if err != nil {
return err
@@ -69,7 +69,7 @@ func (r *symbols) Run(ctx context.Context, args ...string) error {
return nil
}
-func mapToSymbol(m map[string]interface{}) (interface{}, error) {
+func mapToSymbol(m map[string]any) (any, error) {
b, err := json.Marshal(m)
if err != nil {
return nil, err
diff --git a/gopls/internal/cmd/usage/check.hlp b/gopls/internal/cmd/usage/check.hlp
index eda1a25a191..c387c2cf5d9 100644
--- a/gopls/internal/cmd/usage/check.hlp
+++ b/gopls/internal/cmd/usage/check.hlp
@@ -6,3 +6,5 @@ Usage:
Example: show the diagnostic results of this file:
$ gopls check internal/cmd/check.go
+ -severity=string
+ minimum diagnostic severity (hint, info, warning, or error) (default "warning")
diff --git a/gopls/internal/cmd/usage/usage-v.hlp b/gopls/internal/cmd/usage/usage-v.hlp
index 64f99a3387e..044d4251e89 100644
--- a/gopls/internal/cmd/usage/usage-v.hlp
+++ b/gopls/internal/cmd/usage/usage-v.hlp
@@ -61,8 +61,6 @@ flags:
filename to log to. if value is "auto", then logging to a default output file is enabled
-mode=string
no effect
- -ocagent=string
- the address of the ocagent (e.g. http://localhost:55678), or off (default "off")
-port=int
port on which to run gopls for debugging purposes
-profile.alloc=string
diff --git a/gopls/internal/cmd/usage/usage.hlp b/gopls/internal/cmd/usage/usage.hlp
index c801a467626..b918b24a411 100644
--- a/gopls/internal/cmd/usage/usage.hlp
+++ b/gopls/internal/cmd/usage/usage.hlp
@@ -58,8 +58,6 @@ flags:
filename to log to. if value is "auto", then logging to a default output file is enabled
-mode=string
no effect
- -ocagent=string
- the address of the ocagent (e.g. http://localhost:55678), or off (default "off")
-port=int
port on which to run gopls for debugging purposes
-profile.alloc=string
diff --git a/gopls/internal/debug/log/log.go b/gopls/internal/debug/log/log.go
index d015f9bfdd3..9e7efa7bf17 100644
--- a/gopls/internal/debug/log/log.go
+++ b/gopls/internal/debug/log/log.go
@@ -33,7 +33,7 @@ func (l Level) Log(ctx context.Context, msg string) {
}
// Logf formats and exports a log event labeled with level l.
-func (l Level) Logf(ctx context.Context, format string, args ...interface{}) {
+func (l Level) Logf(ctx context.Context, format string, args ...any) {
l.Log(ctx, fmt.Sprintf(format, args...))
}
diff --git a/gopls/internal/debug/rpc.go b/gopls/internal/debug/rpc.go
index 8a696f848d0..5b8e1dbbbd0 100644
--- a/gopls/internal/debug/rpc.go
+++ b/gopls/internal/debug/rpc.go
@@ -209,7 +209,7 @@ func getStatusCode(span *export.Span) string {
return ""
}
-func (r *Rpcs) getData(req *http.Request) interface{} {
+func (r *Rpcs) getData(req *http.Request) any {
return r
}
diff --git a/gopls/internal/debug/serve.go b/gopls/internal/debug/serve.go
index 058254b755b..7cfe2b3d23e 100644
--- a/gopls/internal/debug/serve.go
+++ b/gopls/internal/debug/serve.go
@@ -33,7 +33,6 @@ import (
"golang.org/x/tools/internal/event/core"
"golang.org/x/tools/internal/event/export"
"golang.org/x/tools/internal/event/export/metric"
- "golang.org/x/tools/internal/event/export/ocagent"
"golang.org/x/tools/internal/event/export/prometheus"
"golang.org/x/tools/internal/event/keys"
"golang.org/x/tools/internal/event/label"
@@ -51,13 +50,11 @@ type Instance struct {
Logfile string
StartTime time.Time
ServerAddress string
- OCAgentConfig string
LogWriter io.Writer
exporter event.Exporter
- ocagent *ocagent.Exporter
prometheus *prometheus.Exporter
rpcs *Rpcs
traces *traces
@@ -280,23 +277,23 @@ func cmdline(w http.ResponseWriter, r *http.Request) {
pprof.Cmdline(fake, r)
}
-func (i *Instance) getCache(r *http.Request) interface{} {
+func (i *Instance) getCache(r *http.Request) any {
return i.State.Cache(path.Base(r.URL.Path))
}
-func (i *Instance) getAnalysis(r *http.Request) interface{} {
+func (i *Instance) getAnalysis(r *http.Request) any {
return i.State.Analysis()
}
-func (i *Instance) getSession(r *http.Request) interface{} {
+func (i *Instance) getSession(r *http.Request) any {
return i.State.Session(path.Base(r.URL.Path))
}
-func (i *Instance) getClient(r *http.Request) interface{} {
+func (i *Instance) getClient(r *http.Request) any {
return i.State.Client(path.Base(r.URL.Path))
}
-func (i *Instance) getServer(r *http.Request) interface{} {
+func (i *Instance) getServer(r *http.Request) any {
i.State.mu.Lock()
defer i.State.mu.Unlock()
id := path.Base(r.URL.Path)
@@ -308,7 +305,7 @@ func (i *Instance) getServer(r *http.Request) interface{} {
return nil
}
-func (i *Instance) getFile(r *http.Request) interface{} {
+func (i *Instance) getFile(r *http.Request) any {
identifier := path.Base(r.URL.Path)
sid := path.Base(path.Dir(r.URL.Path))
s := i.State.Session(sid)
@@ -324,7 +321,7 @@ func (i *Instance) getFile(r *http.Request) interface{} {
return nil
}
-func (i *Instance) getInfo(r *http.Request) interface{} {
+func (i *Instance) getInfo(r *http.Request) any {
buf := &bytes.Buffer{}
i.PrintServerInfo(r.Context(), buf)
return template.HTML(buf.String())
@@ -340,7 +337,7 @@ func (i *Instance) AddService(s protocol.Server, session *cache.Session) {
stdlog.Printf("unable to find a Client to add the protocol.Server to")
}
-func getMemory(_ *http.Request) interface{} {
+func getMemory(_ *http.Request) any {
var m runtime.MemStats
runtime.ReadMemStats(&m)
return m
@@ -363,16 +360,11 @@ func GetInstance(ctx context.Context) *Instance {
// WithInstance creates debug instance ready for use using the supplied
// configuration and stores it in the returned context.
-func WithInstance(ctx context.Context, agent string) context.Context {
+func WithInstance(ctx context.Context) context.Context {
i := &Instance{
- StartTime: time.Now(),
- OCAgentConfig: agent,
+ StartTime: time.Now(),
}
i.LogWriter = os.Stderr
- ocConfig := ocagent.Discover()
- //TODO: we should not need to adjust the discovered configuration
- ocConfig.Address = i.OCAgentConfig
- i.ocagent = ocagent.Connect(ocConfig)
i.prometheus = prometheus.New()
i.rpcs = &Rpcs{}
i.traces = &traces{}
@@ -439,7 +431,7 @@ func (i *Instance) Serve(ctx context.Context, addr string) (string, error) {
event.Log(ctx, "Debug serving", label1.Port.Of(port))
go func() {
mux := http.NewServeMux()
- mux.HandleFunc("/", render(MainTmpl, func(*http.Request) interface{} { return i }))
+ mux.HandleFunc("/", render(MainTmpl, func(*http.Request) any { return i }))
mux.HandleFunc("/debug/", render(DebugTmpl, nil))
mux.HandleFunc("/debug/pprof/", pprof.Index)
mux.HandleFunc("/debug/pprof/cmdline", cmdline)
@@ -541,9 +533,6 @@ func messageType(l log.Level) protocol.MessageType {
func makeInstanceExporter(i *Instance) event.Exporter {
exporter := func(ctx context.Context, ev core.Event, lm label.Map) context.Context {
- if i.ocagent != nil {
- ctx = i.ocagent.ProcessEvent(ctx, ev, lm)
- }
if i.prometheus != nil {
ctx = i.prometheus.ProcessEvent(ctx, ev, lm)
}
@@ -594,11 +583,11 @@ func makeInstanceExporter(i *Instance) event.Exporter {
return exporter
}
-type dataFunc func(*http.Request) interface{}
+type dataFunc func(*http.Request) any
func render(tmpl *template.Template, fun dataFunc) func(http.ResponseWriter, *http.Request) {
return func(w http.ResponseWriter, r *http.Request) {
- var data interface{}
+ var data any
if fun != nil {
data = fun(r)
}
diff --git a/gopls/internal/debug/template_test.go b/gopls/internal/debug/template_test.go
index d4d9071c140..52c60244776 100644
--- a/gopls/internal/debug/template_test.go
+++ b/gopls/internal/debug/template_test.go
@@ -29,7 +29,7 @@ import (
var templates = map[string]struct {
tmpl *template.Template
- data interface{} // a value of the needed type
+ data any // a value of the needed type
}{
"MainTmpl": {debug.MainTmpl, &debug.Instance{}},
"DebugTmpl": {debug.DebugTmpl, nil},
diff --git a/gopls/internal/debug/trace.go b/gopls/internal/debug/trace.go
index 9314a04d241..e6ff9697b67 100644
--- a/gopls/internal/debug/trace.go
+++ b/gopls/internal/debug/trace.go
@@ -277,7 +277,7 @@ func (t *traces) addRecentLocked(span *traceSpan, start bool) {
}
// getData returns the TraceResults rendered by TraceTmpl for the /trace[/name] endpoint.
-func (t *traces) getData(req *http.Request) interface{} {
+func (t *traces) getData(req *http.Request) any {
// TODO(adonovan): the HTTP request doesn't acquire the mutex
// for t or for each span! Audit and fix.
diff --git a/gopls/internal/doc/api.go b/gopls/internal/doc/api.go
index 258f90d49ae..52101dda8c9 100644
--- a/gopls/internal/doc/api.go
+++ b/gopls/internal/doc/api.go
@@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
-//go:generate go run ../../doc/generate
+//go:generate go run ./generate
// The doc package provides JSON metadata that documents gopls' public
// interfaces.
@@ -47,11 +47,13 @@ type EnumKey struct {
Name string // in JSON syntax (quoted)
Doc string
Default string
+ Status string // = "" | "advanced" | "experimental" | "deprecated"
}
type EnumValue struct {
- Value string // in JSON syntax (quoted)
- Doc string // doc comment; always starts with `Value`
+ Value string // in JSON syntax (quoted)
+ Doc string // doc comment; always starts with `Value`
+ Status string // = "" | "advanced" | "experimental" | "deprecated"
}
type Lens struct {
@@ -60,6 +62,7 @@ type Lens struct {
Title string
Doc string
Default bool
+ Status string // = "" | "advanced" | "experimental" | "deprecated"
}
type Analyzer struct {
@@ -73,4 +76,5 @@ type Hint struct {
Name string
Doc string
Default bool
+ Status string // = "" | "advanced" | "experimental" | "deprecated"
}
diff --git a/gopls/internal/doc/api.json b/gopls/internal/doc/api.json
index 8f101079a9c..0852870ba41 100644
--- a/gopls/internal/doc/api.json
+++ b/gopls/internal/doc/api.json
@@ -124,19 +124,28 @@
"EnumValues": [
{
"Value": "\"FullDocumentation\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
},
{
"Value": "\"NoDocumentation\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
},
{
"Value": "\"SingleLine\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
+ },
+ {
+ "Value": "\"Structured\"",
+ "Doc": "`\"Structured\"` is a misguided experimental setting that returns a JSON\nhover format. This setting should not be used, as it will be removed in a\nfuture release of gopls.\n",
+ "Status": ""
},
{
"Value": "\"SynopsisDocumentation\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
}
],
"Default": "\"FullDocumentation\"",
@@ -169,15 +178,18 @@
"EnumValues": [
{
"Value": "false",
- "Doc": "false: do not show links"
+ "Doc": "false: do not show links",
+ "Status": ""
},
{
"Value": "true",
- "Doc": "true: show links to the `linkTarget` domain"
+ "Doc": "true: show links to the `linkTarget` domain",
+ "Status": ""
},
{
"Value": "\"gopls\"",
- "Doc": "`\"gopls\"`: show links to gopls' internal documentation viewer"
+ "Doc": "`\"gopls\"`: show links to gopls' internal documentation viewer",
+ "Status": ""
}
],
"Default": "true",
@@ -224,15 +236,18 @@
"EnumValues": [
{
"Value": "\"CaseInsensitive\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
},
{
"Value": "\"CaseSensitive\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
},
{
"Value": "\"Fuzzy\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
}
],
"Default": "\"Fuzzy\"",
@@ -279,15 +294,18 @@
"EnumValues": [
{
"Value": "\"Both\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
},
{
"Value": "\"Definition\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
},
{
"Value": "\"Link\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
}
],
"Default": "\"Both\"",
@@ -306,19 +324,23 @@
"EnumValues": [
{
"Value": "\"CaseInsensitive\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
},
{
"Value": "\"CaseSensitive\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
},
{
"Value": "\"FastFuzzy\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
},
{
"Value": "\"Fuzzy\"",
- "Doc": ""
+ "Doc": "",
+ "Status": ""
}
],
"Default": "\"FastFuzzy\"",
@@ -337,15 +359,18 @@
"EnumValues": [
{
"Value": "\"Dynamic\"",
- "Doc": "`\"Dynamic\"` uses whichever qualifier results in the highest scoring\nmatch for the given symbol query. Here a \"qualifier\" is any \"/\" or \".\"\ndelimited suffix of the fully qualified symbol. i.e. \"to/pkg.Foo.Field\" or\njust \"Foo.Field\".\n"
+ "Doc": "`\"Dynamic\"` uses whichever qualifier results in the highest scoring\nmatch for the given symbol query. Here a \"qualifier\" is any \"/\" or \".\"\ndelimited suffix of the fully qualified symbol. i.e. \"to/pkg.Foo.Field\" or\njust \"Foo.Field\".\n",
+ "Status": ""
},
{
"Value": "\"Full\"",
- "Doc": "`\"Full\"` is fully qualified symbols, i.e.\n\"path/to/pkg.Foo.Field\".\n"
+ "Doc": "`\"Full\"` is fully qualified symbols, i.e.\n\"path/to/pkg.Foo.Field\".\n",
+ "Status": ""
},
{
"Value": "\"Package\"",
- "Doc": "`\"Package\"` is package qualified symbols i.e.\n\"pkg.Foo.Field\".\n"
+ "Doc": "`\"Package\"` is package qualified symbols i.e.\n\"pkg.Foo.Field\".\n",
+ "Status": ""
}
],
"Default": "\"Dynamic\"",
@@ -364,11 +389,13 @@
"EnumValues": [
{
"Value": "\"all\"",
- "Doc": "`\"all\"` matches symbols in any loaded package, including\ndependencies.\n"
+ "Doc": "`\"all\"` matches symbols in any loaded package, including\ndependencies.\n",
+ "Status": ""
},
{
"Value": "\"workspace\"",
- "Doc": "`\"workspace\"` matches symbols in workspace packages only.\n"
+ "Doc": "`\"workspace\"` matches symbols in workspace packages only.\n",
+ "Status": ""
}
],
"Default": "\"all\"",
@@ -386,282 +413,338 @@
{
"Name": "\"appends\"",
"Doc": "check for missing values after append\n\nThis checker reports calls to append that pass\nno values to be appended to the slice.\n\n\ts := []string{\"a\", \"b\", \"c\"}\n\t_ = append(s)\n\nSuch calls are always no-ops and often indicate an\nunderlying mistake.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"asmdecl\"",
"Doc": "report mismatches between assembly files and Go declarations",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"assign\"",
"Doc": "check for useless assignments\n\nThis checker reports assignments of the form x = x or a[i] = a[i].\nThese are almost always useless, and even when they aren't they are\nusually a mistake.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"atomic\"",
"Doc": "check for common mistakes using the sync/atomic package\n\nThe atomic checker looks for assignment statements of the form:\n\n\tx = atomic.AddUint64(\u0026x, 1)\n\nwhich are not atomic.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"atomicalign\"",
"Doc": "check for non-64-bits-aligned arguments to sync/atomic functions",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"bools\"",
"Doc": "check for common mistakes involving boolean operators",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"buildtag\"",
"Doc": "check //go:build and // +build directives",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"cgocall\"",
"Doc": "detect some violations of the cgo pointer passing rules\n\nCheck for invalid cgo pointer passing.\nThis looks for code that uses cgo to call C code passing values\nwhose types are almost always invalid according to the cgo pointer\nsharing rules.\nSpecifically, it warns about attempts to pass a Go chan, map, func,\nor slice to C, either directly, or via a pointer, array, or struct.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"composites\"",
"Doc": "check for unkeyed composite literals\n\nThis analyzer reports a diagnostic for composite literals of struct\ntypes imported from another package that do not use the field-keyed\nsyntax. Such literals are fragile because the addition of a new field\n(even if unexported) to the struct will cause compilation to fail.\n\nAs an example,\n\n\terr = \u0026net.DNSConfigError{err}\n\nshould be replaced by:\n\n\terr = \u0026net.DNSConfigError{Err: err}\n",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"copylocks\"",
"Doc": "check for locks erroneously passed by value\n\nInadvertently copying a value containing a lock, such as sync.Mutex or\nsync.WaitGroup, may cause both copies to malfunction. Generally such\nvalues should be referred to through a pointer.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"deepequalerrors\"",
"Doc": "check for calls of reflect.DeepEqual on error values\n\nThe deepequalerrors checker looks for calls of the form:\n\n reflect.DeepEqual(err1, err2)\n\nwhere err1 and err2 are errors. Using reflect.DeepEqual to compare\nerrors is discouraged.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"defers\"",
"Doc": "report common mistakes in defer statements\n\nThe defers analyzer reports a diagnostic when a defer statement would\nresult in a non-deferred call to time.Since, as experience has shown\nthat this is nearly always a mistake.\n\nFor example:\n\n\tstart := time.Now()\n\t...\n\tdefer recordLatency(time.Since(start)) // error: call to time.Since is not deferred\n\nThe correct code is:\n\n\tdefer func() { recordLatency(time.Since(start)) }()",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"deprecated\"",
"Doc": "check for use of deprecated identifiers\n\nThe deprecated analyzer looks for deprecated symbols and package\nimports.\n\nSee https://go.dev/wiki/Deprecated to learn about Go's convention\nfor documenting and signaling deprecated identifiers.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"directive\"",
"Doc": "check Go toolchain directives such as //go:debug\n\nThis analyzer checks for problems with known Go toolchain directives\nin all Go source files in a package directory, even those excluded by\n//go:build constraints, and all non-Go source files too.\n\nFor //go:debug (see https://go.dev/doc/godebug), the analyzer checks\nthat the directives are placed only in Go source files, only above the\npackage comment, and only in package main or *_test.go files.\n\nSupport for other known directives may be added in the future.\n\nThis analyzer does not check //go:build, which is handled by the\nbuildtag analyzer.\n",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"embed\"",
"Doc": "check //go:embed directive usage\n\nThis analyzer checks that the embed package is imported if //go:embed\ndirectives are present, providing a suggested fix to add the import if\nit is missing.\n\nThis analyzer also checks that //go:embed directives precede the\ndeclaration of a single variable.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"errorsas\"",
"Doc": "report passing non-pointer or non-error values to errors.As\n\nThe errorsas analysis reports calls to errors.As where the type\nof the second argument is not a pointer to a type implementing error.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"fillreturns\"",
"Doc": "suggest fixes for errors due to an incorrect number of return values\n\nThis checker provides suggested fixes for type errors of the\ntype \"wrong number of return values (want %d, got %d)\". For example:\n\n\tfunc m() (int, string, *bool, error) {\n\t\treturn\n\t}\n\nwill turn into\n\n\tfunc m() (int, string, *bool, error) {\n\t\treturn 0, \"\", nil, nil\n\t}\n\nThis functionality is similar to https://github.com/sqs/goreturns.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"framepointer\"",
"Doc": "report assembly that clobbers the frame pointer before saving it",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"gofix\"",
"Doc": "apply fixes based on go:fix comment directives\n\nThe gofix analyzer inlines functions and constants that are marked for inlining.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"hostport\"",
"Doc": "check format of addresses passed to net.Dial\n\nThis analyzer flags code that produce network address strings using\nfmt.Sprintf, as in this example:\n\n addr := fmt.Sprintf(\"%s:%d\", host, 12345) // \"will not work with IPv6\"\n ...\n conn, err := net.Dial(\"tcp\", addr) // \"when passed to dial here\"\n\nThe analyzer suggests a fix to use the correct approach, a call to\nnet.JoinHostPort:\n\n addr := net.JoinHostPort(host, \"12345\")\n ...\n conn, err := net.Dial(\"tcp\", addr)\n\nA similar diagnostic and fix are produced for a format string of \"%s:%s\".\n",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"httpresponse\"",
"Doc": "check for mistakes using HTTP responses\n\nA common mistake when using the net/http package is to defer a function\ncall to close the http.Response Body before checking the error that\ndetermines whether the response is valid:\n\n\tresp, err := http.Head(url)\n\tdefer resp.Body.Close()\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\t// (defer statement belongs here)\n\nThis checker helps uncover latent nil dereference bugs by reporting a\ndiagnostic for such mistakes.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"ifaceassert\"",
"Doc": "detect impossible interface-to-interface type assertions\n\nThis checker flags type assertions v.(T) and corresponding type-switch cases\nin which the static type V of v is an interface that cannot possibly implement\nthe target interface T. This occurs when V and T contain methods with the same\nname but different signatures. Example:\n\n\tvar v interface {\n\t\tRead()\n\t}\n\t_ = v.(io.Reader)\n\nThe Read method in v has a different signature than the Read method in\nio.Reader, so this assertion cannot succeed.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"infertypeargs\"",
"Doc": "check for unnecessary type arguments in call expressions\n\nExplicit type arguments may be omitted from call expressions if they can be\ninferred from function arguments, or from other type arguments:\n\n\tfunc f[T any](T) {}\n\t\n\tfunc _() {\n\t\tf[string](\"foo\") // string could be inferred\n\t}\n",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"loopclosure\"",
"Doc": "check references to loop variables from within nested functions\n\nThis analyzer reports places where a function literal references the\niteration variable of an enclosing loop, and the loop calls the function\nin such a way (e.g. with go or defer) that it may outlive the loop\niteration and possibly observe the wrong value of the variable.\n\nNote: An iteration variable can only outlive a loop iteration in Go versions \u003c=1.21.\nIn Go 1.22 and later, the loop variable lifetimes changed to create a new\niteration variable per loop iteration. (See go.dev/issue/60078.)\n\nIn this example, all the deferred functions run after the loop has\ncompleted, so all observe the final value of v [\u003cgo1.22].\n\n\tfor _, v := range list {\n\t defer func() {\n\t use(v) // incorrect\n\t }()\n\t}\n\nOne fix is to create a new variable for each iteration of the loop:\n\n\tfor _, v := range list {\n\t v := v // new var per iteration\n\t defer func() {\n\t use(v) // ok\n\t }()\n\t}\n\nAfter Go version 1.22, the previous two for loops are equivalent\nand both are correct.\n\nThe next example uses a go statement and has a similar problem [\u003cgo1.22].\nIn addition, it has a data race because the loop updates v\nconcurrent with the goroutines accessing it.\n\n\tfor _, v := range elem {\n\t go func() {\n\t use(v) // incorrect, and a data race\n\t }()\n\t}\n\nA fix is the same as before. The checker also reports problems\nin goroutines started by golang.org/x/sync/errgroup.Group.\nA hard-to-spot variant of this form is common in parallel tests:\n\n\tfunc Test(t *testing.T) {\n\t for _, test := range tests {\n\t t.Run(test.name, func(t *testing.T) {\n\t t.Parallel()\n\t use(test) // incorrect, and a data race\n\t })\n\t }\n\t}\n\nThe t.Parallel() call causes the rest of the function to execute\nconcurrent with the loop [\u003cgo1.22].\n\nThe analyzer reports references only in the last statement,\nas it is not deep enough to understand the effects of subsequent\nstatements that might render the reference benign.\n(\"Last statement\" is defined recursively in compound\nstatements such as if, switch, and select.)\n\nSee: https://golang.org/doc/go_faq.html#closures_and_goroutines",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"lostcancel\"",
"Doc": "check cancel func returned by context.WithCancel is called\n\nThe cancellation function returned by context.WithCancel, WithTimeout,\nWithDeadline and variants such as WithCancelCause must be called,\nor the new context will remain live until its parent context is cancelled.\n(The background context is never cancelled.)",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"modernize\"",
- "Doc": "simplify code by using modern constructs\n\nThis analyzer reports opportunities for simplifying and clarifying\nexisting code by using more modern features of Go, such as:\n\n - replacing an if/else conditional assignment by a call to the\n built-in min or max functions added in go1.21;\n - replacing sort.Slice(x, func(i, j int) bool) { return s[i] \u003c s[j] }\n by a call to slices.Sort(s), added in go1.21;\n - replacing interface{} by the 'any' type added in go1.18;\n - replacing append([]T(nil), s...) by slices.Clone(s) or\n slices.Concat(s), added in go1.21;\n - replacing a loop around an m[k]=v map update by a call\n to one of the Collect, Copy, Clone, or Insert functions\n from the maps package, added in go1.21;\n - replacing []byte(fmt.Sprintf...) by fmt.Appendf(nil, ...),\n added in go1.19;\n - replacing uses of context.WithCancel in tests with t.Context, added in\n go1.24;\n - replacing omitempty by omitzero on structs, added in go1.24;\n - replacing append(s[:i], s[i+1]...) by slices.Delete(s, i, i+1),\n added in go1.21\n - replacing a 3-clause for i := 0; i \u003c n; i++ {} loop by\n for i := range n {}, added in go1.22;\n - replacing Split in \"for range strings.Split(...)\" by go1.24's\n more efficient SplitSeq;",
- "Default": "true"
+ "Doc": "simplify code by using modern constructs\n\nThis analyzer reports opportunities for simplifying and clarifying\nexisting code by using more modern features of Go and its standard\nlibrary.\n\nEach diagnostic provides a fix. Our intent is that these fixes may\nbe safely applied en masse without changing the behavior of your\nprogram. In some cases the suggested fixes are imperfect and may\nlead to (for example) unused imports or unused local variables,\ncausing build breakage. However, these problems are generally\ntrivial to fix. We regard any modernizer whose fix changes program\nbehavior to have a serious bug and will endeavor to fix it.\n\nTo apply all modernization fixes en masse, you can use the\nfollowing command:\n\n\t$ go run golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@latest -fix -test ./...\n\nIf the tool warns of conflicting fixes, you may need to run it more\nthan once until it has applied all fixes cleanly. This command is\nnot an officially supported interface and may change in the future.\n\nChanges produced by this tool should be reviewed as usual before\nbeing merged. In some cases, a loop may be replaced by a simple\nfunction call, causing comments within the loop to be discarded.\nHuman judgment may be required to avoid losing comments of value.\n\nEach diagnostic reported by modernize has a specific category. (The\ncategories are listed below.) Diagnostics in some categories, such\nas \"efaceany\" (which replaces \"interface{}\" with \"any\" where it is\nsafe to do so) are particularly numerous. It may ease the burden of\ncode review to apply fixes in two passes, the first change\nconsisting only of fixes of category \"efaceany\", the second\nconsisting of all others. This can be achieved using the -category flag:\n\n\t$ modernize -category=efaceany -fix -test ./...\n\t$ modernize -category=-efaceany -fix -test ./...\n\nCategories of modernize diagnostic:\n\n - forvar: remove x := x variable declarations made unnecessary by the new semantics of loops in go1.22.\n\n - slicescontains: replace 'for i, elem := range s { if elem == needle { ...; break }'\n by a call to slices.Contains, added in go1.21.\n\n - minmax: replace an if/else conditional assignment by a call to\n the built-in min or max functions added in go1.21.\n\n - sortslice: replace sort.Slice(x, func(i, j int) bool) { return s[i] \u003c s[j] }\n by a call to slices.Sort(s), added in go1.21.\n\n - efaceany: replace interface{} by the 'any' type added in go1.18.\n\n - slicesclone: replace append([]T(nil), s...) by slices.Clone(s) or\n slices.Concat(s), added in go1.21.\n\n - mapsloop: replace a loop around an m[k]=v map update by a call\n to one of the Collect, Copy, Clone, or Insert functions from\n the maps package, added in go1.21.\n\n - fmtappendf: replace []byte(fmt.Sprintf...) by fmt.Appendf(nil, ...),\n added in go1.19.\n\n - testingcontext: replace uses of context.WithCancel in tests\n with t.Context, added in go1.24.\n\n - omitzero: replace omitempty by omitzero on structs, added in go1.24.\n\n - bloop: replace \"for i := range b.N\" or \"for range b.N\" in a\n benchmark with \"for b.Loop()\", and remove any preceding calls\n to b.StopTimer, b.StartTimer, and b.ResetTimer.\n\n - slicesdelete: replace append(s[:i], s[i+1]...) by\n slices.Delete(s, i, i+1), added in go1.21.\n\n - rangeint: replace a 3-clause \"for i := 0; i \u003c n; i++\" loop by\n \"for i := range n\", added in go1.22.\n\n - stringsseq: replace Split in \"for range strings.Split(...)\" by go1.24's\n more efficient SplitSeq, or Fields with FieldSeq.\n\n - stringscutprefix: replace some uses of HasPrefix followed by TrimPrefix with CutPrefix,\n added to the strings package in go1.20.\n\n - waitgroup: replace old complex usages of sync.WaitGroup by less complex WaitGroup.Go method in go1.25.",
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"nilfunc\"",
"Doc": "check for useless comparisons between functions and nil\n\nA useless comparison is one like f == nil as opposed to f() == nil.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"nilness\"",
"Doc": "check for redundant or impossible nil comparisons\n\nThe nilness checker inspects the control-flow graph of each function in\na package and reports nil pointer dereferences, degenerate nil\npointers, and panics with nil values. A degenerate comparison is of the form\nx==nil or x!=nil where x is statically known to be nil or non-nil. These are\noften a mistake, especially in control flow related to errors. Panics with nil\nvalues are checked because they are not detectable by\n\n\tif r := recover(); r != nil {\n\nThis check reports conditions such as:\n\n\tif f == nil { // impossible condition (f is a function)\n\t}\n\nand:\n\n\tp := \u0026v\n\t...\n\tif p != nil { // tautological condition\n\t}\n\nand:\n\n\tif p == nil {\n\t\tprint(*p) // nil dereference\n\t}\n\nand:\n\n\tif p == nil {\n\t\tpanic(p)\n\t}\n\nSometimes the control flow may be quite complex, making bugs hard\nto spot. In the example below, the err.Error expression is\nguaranteed to panic because, after the first return, err must be\nnil. The intervening loop is just a distraction.\n\n\t...\n\terr := g.Wait()\n\tif err != nil {\n\t\treturn err\n\t}\n\tpartialSuccess := false\n\tfor _, err := range errs {\n\t\tif err == nil {\n\t\t\tpartialSuccess = true\n\t\t\tbreak\n\t\t}\n\t}\n\tif partialSuccess {\n\t\treportStatus(StatusMessage{\n\t\t\tCode: code.ERROR,\n\t\t\tDetail: err.Error(), // \"nil dereference in dynamic method call\"\n\t\t})\n\t\treturn nil\n\t}\n\n...",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"nonewvars\"",
"Doc": "suggested fixes for \"no new vars on left side of :=\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"no new vars on left side of :=\". For example:\n\n\tz := 1\n\tz := 2\n\nwill turn into\n\n\tz := 1\n\tz = 2",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"noresultvalues\"",
"Doc": "suggested fixes for unexpected return values\n\nThis checker provides suggested fixes for type errors of the\ntype \"no result values expected\" or \"too many return values\".\nFor example:\n\n\tfunc z() { return nil }\n\nwill turn into\n\n\tfunc z() { return }",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"printf\"",
"Doc": "check consistency of Printf format strings and arguments\n\nThe check applies to calls of the formatting functions such as\n[fmt.Printf] and [fmt.Sprintf], as well as any detected wrappers of\nthose functions such as [log.Printf]. It reports a variety of\nmistakes such as syntax errors in the format string and mismatches\n(of number and type) between the verbs and their arguments.\n\nSee the documentation of the fmt package for the complete set of\nformat operators and their operand types.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"shadow\"",
"Doc": "check for possible unintended shadowing of variables\n\nThis analyzer check for shadowed variables.\nA shadowed variable is a variable declared in an inner scope\nwith the same name and type as a variable in an outer scope,\nand where the outer variable is mentioned after the inner one\nis declared.\n\n(This definition can be refined; the module generates too many\nfalse positives and is not yet enabled by default.)\n\nFor example:\n\n\tfunc BadRead(f *os.File, buf []byte) error {\n\t\tvar err error\n\t\tfor {\n\t\t\tn, err := f.Read(buf) // shadows the function variable 'err'\n\t\t\tif err != nil {\n\t\t\t\tbreak // causes return of wrong value\n\t\t\t}\n\t\t\tfoo(buf)\n\t\t}\n\t\treturn err\n\t}",
- "Default": "false"
+ "Default": "false",
+ "Status": ""
},
{
"Name": "\"shift\"",
"Doc": "check for shifts that equal or exceed the width of the integer",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"sigchanyzer\"",
"Doc": "check for unbuffered channel of os.Signal\n\nThis checker reports call expression of the form\n\n\tsignal.Notify(c \u003c-chan os.Signal, sig ...os.Signal),\n\nwhere c is an unbuffered channel, which can be at risk of missing the signal.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"simplifycompositelit\"",
"Doc": "check for composite literal simplifications\n\nAn array, slice, or map composite literal of the form:\n\n\t[]T{T{}, T{}}\n\nwill be simplified to:\n\n\t[]T{{}, {}}\n\nThis is one of the simplifications that \"gofmt -s\" applies.\n\nThis analyzer ignores generated code.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"simplifyrange\"",
"Doc": "check for range statement simplifications\n\nA range of the form:\n\n\tfor x, _ = range v {...}\n\nwill be simplified to:\n\n\tfor x = range v {...}\n\nA range of the form:\n\n\tfor _ = range v {...}\n\nwill be simplified to:\n\n\tfor range v {...}\n\nThis is one of the simplifications that \"gofmt -s\" applies.\n\nThis analyzer ignores generated code.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"simplifyslice\"",
"Doc": "check for slice simplifications\n\nA slice expression of the form:\n\n\ts[a:len(s)]\n\nwill be simplified to:\n\n\ts[a:]\n\nThis is one of the simplifications that \"gofmt -s\" applies.\n\nThis analyzer ignores generated code.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"slog\"",
"Doc": "check for invalid structured logging calls\n\nThe slog checker looks for calls to functions from the log/slog\npackage that take alternating key-value pairs. It reports calls\nwhere an argument in a key position is neither a string nor a\nslog.Attr, and where a final key is missing its value.\nFor example,it would report\n\n\tslog.Warn(\"message\", 11, \"k\") // slog.Warn arg \"11\" should be a string or a slog.Attr\n\nand\n\n\tslog.Info(\"message\", \"k1\", v1, \"k2\") // call to slog.Info missing a final value",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"sortslice\"",
"Doc": "check the argument type of sort.Slice\n\nsort.Slice requires an argument of a slice type. Check that\nthe interface{} value passed to sort.Slice is actually a slice.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"stdmethods\"",
"Doc": "check signature of methods of well-known interfaces\n\nSometimes a type may be intended to satisfy an interface but may fail to\ndo so because of a mistake in its method signature.\nFor example, the result of this WriteTo method should be (int64, error),\nnot error, to satisfy io.WriterTo:\n\n\ttype myWriterTo struct{...}\n\tfunc (myWriterTo) WriteTo(w io.Writer) error { ... }\n\nThis check ensures that each method whose name matches one of several\nwell-known interface methods from the standard library has the correct\nsignature for that interface.\n\nChecked method names include:\n\n\tFormat GobEncode GobDecode MarshalJSON MarshalXML\n\tPeek ReadByte ReadFrom ReadRune Scan Seek\n\tUnmarshalJSON UnreadByte UnreadRune WriteByte\n\tWriteTo",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"stdversion\"",
"Doc": "report uses of too-new standard library symbols\n\nThe stdversion analyzer reports references to symbols in the standard\nlibrary that were introduced by a Go release higher than the one in\nforce in the referring file. (Recall that the file's Go version is\ndefined by the 'go' directive its module's go.mod file, or by a\n\"//go:build go1.X\" build tag at the top of the file.)\n\nThe analyzer does not report a diagnostic for a reference to a \"too\nnew\" field or method of a type that is itself \"too new\", as this may\nhave false positives, for example if fields or methods are accessed\nthrough a type alias that is guarded by a Go version constraint.\n",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"stringintconv\"",
"Doc": "check for string(int) conversions\n\nThis checker flags conversions of the form string(x) where x is an integer\n(but not byte or rune) type. Such conversions are discouraged because they\nreturn the UTF-8 representation of the Unicode code point x, and not a decimal\nstring representation of x as one might expect. Furthermore, if x denotes an\ninvalid code point, the conversion cannot be statically rejected.\n\nFor conversions that intend on using the code point, consider replacing them\nwith string(rune(x)). Otherwise, strconv.Itoa and its equivalents return the\nstring representation of the value in the desired base.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"structtag\"",
"Doc": "check that struct field tags conform to reflect.StructTag.Get\n\nAlso report certain struct tags (json, xml) used with unexported fields.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"testinggoroutine\"",
"Doc": "report calls to (*testing.T).Fatal from goroutines started by a test\n\nFunctions that abruptly terminate a test, such as the Fatal, Fatalf, FailNow, and\nSkip{,f,Now} methods of *testing.T, must be called from the test goroutine itself.\nThis checker detects calls to these functions that occur within a goroutine\nstarted by the test. For example:\n\n\tfunc TestFoo(t *testing.T) {\n\t go func() {\n\t t.Fatal(\"oops\") // error: (*T).Fatal called from non-test goroutine\n\t }()\n\t}",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"tests\"",
"Doc": "check for common mistaken usages of tests and examples\n\nThe tests checker walks Test, Benchmark, Fuzzing and Example functions checking\nmalformed names, wrong signatures and examples documenting non-existent\nidentifiers.\n\nPlease see the documentation for package testing in golang.org/pkg/testing\nfor the conventions that are enforced for Tests, Benchmarks, and Examples.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"timeformat\"",
"Doc": "check for calls of (time.Time).Format or time.Parse with 2006-02-01\n\nThe timeformat checker looks for time formats with the 2006-02-01 (yyyy-dd-mm)\nformat. Internationally, \"yyyy-dd-mm\" does not occur in common calendar date\nstandards, and so it is more likely that 2006-01-02 (yyyy-mm-dd) was intended.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"unmarshal\"",
"Doc": "report passing non-pointer or non-interface values to unmarshal\n\nThe unmarshal analysis reports calls to functions such as json.Unmarshal\nin which the argument type is not a pointer or an interface.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"unreachable\"",
"Doc": "check for unreachable code\n\nThe unreachable analyzer finds statements that execution can never reach\nbecause they are preceded by a return statement, a call to panic, an\ninfinite loop, or similar constructs.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"unsafeptr\"",
"Doc": "check for invalid conversions of uintptr to unsafe.Pointer\n\nThe unsafeptr analyzer reports likely incorrect uses of unsafe.Pointer\nto convert integers to pointers. A conversion from uintptr to\nunsafe.Pointer is invalid if it implies that there is a uintptr-typed\nword in memory that holds a pointer value, because that word will be\ninvisible to stack copying and to the garbage collector.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"unusedfunc\"",
- "Doc": "check for unused functions and methods\n\nThe unusedfunc analyzer reports functions and methods that are\nnever referenced outside of their own declaration.\n\nA function is considered unused if it is unexported and not\nreferenced (except within its own declaration).\n\nA method is considered unused if it is unexported, not referenced\n(except within its own declaration), and its name does not match\nthat of any method of an interface type declared within the same\npackage.\n\nThe tool may report a false positive for a declaration of an\nunexported function that is referenced from another package using\nthe go:linkname mechanism, if the declaration's doc comment does\nnot also have a go:linkname comment. (Such code is in any case\nstrongly discouraged: linkname annotations, if they must be used at\nall, should be used on both the declaration and the alias.)\n\nThe unusedfunc algorithm is not as precise as the\ngolang.org/x/tools/cmd/deadcode tool, but it has the advantage that\nit runs within the modular analysis framework, enabling near\nreal-time feedback within gopls.",
- "Default": "true"
+ "Doc": "check for unused functions and methods\n\nThe unusedfunc analyzer reports functions and methods that are\nnever referenced outside of their own declaration.\n\nA function is considered unused if it is unexported and not\nreferenced (except within its own declaration).\n\nA method is considered unused if it is unexported, not referenced\n(except within its own declaration), and its name does not match\nthat of any method of an interface type declared within the same\npackage.\n\nThe tool may report false positives in some situations, for\nexample:\n\n - For a declaration of an unexported function that is referenced\n from another package using the go:linkname mechanism, if the\n declaration's doc comment does not also have a go:linkname\n comment.\n\n (Such code is in any case strongly discouraged: linkname\n annotations, if they must be used at all, should be used on both\n the declaration and the alias.)\n\n - For compiler intrinsics in the \"runtime\" package that, though\n never referenced, are known to the compiler and are called\n indirectly by compiled object code.\n\n - For functions called only from assembly.\n\n - For functions called only from files whose build tags are not\n selected in the current build configuration.\n\nSee https://github.com/golang/go/issues/71686 for discussion of\nthese limitations.\n\nThe unusedfunc algorithm is not as precise as the\ngolang.org/x/tools/cmd/deadcode tool, but it has the advantage that\nit runs within the modular analysis framework, enabling near\nreal-time feedback within gopls.",
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"unusedparams\"",
"Doc": "check for unused parameters of functions\n\nThe unusedparams analyzer checks functions to see if there are\nany parameters that are not being used.\n\nTo ensure soundness, it ignores:\n - \"address-taken\" functions, that is, functions that are used as\n a value rather than being called directly; their signatures may\n be required to conform to a func type.\n - exported functions or methods, since they may be address-taken\n in another package.\n - unexported methods whose name matches an interface method\n declared in the same package, since the method's signature\n may be required to conform to the interface type.\n - functions with empty bodies, or containing just a call to panic.\n - parameters that are unnamed, or named \"_\", the blank identifier.\n\nThe analyzer suggests a fix of replacing the parameter name by \"_\",\nbut in such cases a deeper fix can be obtained by invoking the\n\"Refactor: remove unused parameter\" code action, which will\neliminate the parameter entirely, along with all corresponding\narguments at call sites, while taking care to preserve any side\neffects in the argument expressions; see\nhttps://github.com/golang/tools/releases/tag/gopls%2Fv0.14.\n\nThis analyzer ignores generated code.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"unusedresult\"",
"Doc": "check for unused results of calls to some functions\n\nSome functions like fmt.Errorf return a result and have no side\neffects, so it is always a mistake to discard the result. Other\nfunctions may return an error that must not be ignored, or a cleanup\noperation that must be called. This analyzer reports calls to\nfunctions like these when the result of the call is ignored.\n\nThe set of functions may be controlled using flags.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"unusedvariable\"",
"Doc": "check for unused variables and suggest fixes",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"unusedwrite\"",
"Doc": "checks for unused writes\n\nThe analyzer reports instances of writes to struct fields and\narrays that are never read. Specifically, when a struct object\nor an array is copied, its elements are copied implicitly by\nthe compiler, and any element write to this copy does nothing\nwith the original object.\n\nFor example:\n\n\ttype T struct { x int }\n\n\tfunc f(input []T) {\n\t\tfor i, v := range input { // v is a copy\n\t\t\tv.x = i // unused write to field x\n\t\t}\n\t}\n\nAnother example is about non-pointer receiver:\n\n\ttype T struct { x int }\n\n\tfunc (t T) f() { // t is a copy\n\t\tt.x = i // unused write to field x\n\t}",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"waitgroup\"",
"Doc": "check for misuses of sync.WaitGroup\n\nThis analyzer detects mistaken calls to the (*sync.WaitGroup).Add\nmethod from inside a new goroutine, causing Add to race with Wait:\n\n\t// WRONG\n\tvar wg sync.WaitGroup\n\tgo func() {\n\t wg.Add(1) // \"WaitGroup.Add called from inside new goroutine\"\n\t defer wg.Done()\n\t ...\n\t}()\n\twg.Wait() // (may return prematurely before new goroutine starts)\n\nThe correct code calls Add before starting the goroutine:\n\n\t// RIGHT\n\tvar wg sync.WaitGroup\n\twg.Add(1)\n\tgo func() {\n\t\tdefer wg.Done()\n\t\t...\n\t}()\n\twg.Wait()",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"yield\"",
"Doc": "report calls to yield where the result is ignored\n\nAfter a yield function returns false, the caller should not call\nthe yield function again; generally the iterator should return\npromptly.\n\nThis example fails to check the result of the call to yield,\ncausing this analyzer to report a diagnostic:\n\n\tyield(1) // yield may be called again (on L2) after returning false\n\tyield(2)\n\nThe corrected code is either this:\n\n\tif yield(1) { yield(2) }\n\nor simply:\n\n\t_ = yield(1) \u0026\u0026 yield(2)\n\nIt is not always a mistake to ignore the result of yield.\nFor example, this is a valid single-element iterator:\n\n\tyield(1) // ok to ignore result\n\treturn\n\nIt is only a mistake when the yield call that returned false may be\nfollowed by another call.",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
}
]
},
@@ -685,6 +768,45 @@
"Hierarchy": "ui.diagnostic",
"DeprecationMessage": ""
},
+ {
+ "Name": "annotations",
+ "Type": "map[enum]bool",
+ "Doc": "annotations specifies the various kinds of compiler\noptimization details that should be reported as diagnostics\nwhen enabled for a package by the \"Toggle compiler\noptimization details\" (`gopls.gc_details`) command.\n\n(Some users care only about one kind of annotation in their\nprofiling efforts. More importantly, in large packages, the\nnumber of annotations can sometimes overwhelm the user\ninterface and exceed the per-file diagnostic limit.)\n\nTODO(adonovan): rename this field to CompilerOptDetail.\n",
+ "EnumKeys": {
+ "ValueType": "bool",
+ "Keys": [
+ {
+ "Name": "\"bounds\"",
+ "Doc": "`\"bounds\"` controls bounds checking diagnostics.\n",
+ "Default": "true",
+ "Status": ""
+ },
+ {
+ "Name": "\"escape\"",
+ "Doc": "`\"escape\"` controls diagnostics about escape choices.\n",
+ "Default": "true",
+ "Status": ""
+ },
+ {
+ "Name": "\"inline\"",
+ "Doc": "`\"inline\"` controls diagnostics about inlining choices.\n",
+ "Default": "true",
+ "Status": ""
+ },
+ {
+ "Name": "\"nil\"",
+ "Doc": "`\"nil\"` controls nil checks.\n",
+ "Default": "true",
+ "Status": ""
+ }
+ ]
+ },
+ "EnumValues": null,
+ "Default": "{\"bounds\":true,\"escape\":true,\"inline\":true,\"nil\":true}",
+ "Status": "",
+ "Hierarchy": "ui.diagnostic",
+ "DeprecationMessage": ""
+ },
{
"Name": "vulncheck",
"Type": "enum",
@@ -696,11 +818,13 @@
"EnumValues": [
{
"Value": "\"Imports\"",
- "Doc": "`\"Imports\"`: In Imports mode, `gopls` will report vulnerabilities that affect packages\ndirectly and indirectly used by the analyzed main module.\n"
+ "Doc": "`\"Imports\"`: In Imports mode, `gopls` will report vulnerabilities that affect packages\ndirectly and indirectly used by the analyzed main module.\n",
+ "Status": ""
},
{
"Value": "\"Off\"",
- "Doc": "`\"Off\"`: Disable vulnerability analysis.\n"
+ "Doc": "`\"Off\"`: Disable vulnerability analysis.\n",
+ "Status": ""
}
],
"Default": "\"Off\"",
@@ -733,11 +857,13 @@
"EnumValues": [
{
"Value": "\"Edit\"",
- "Doc": "`\"Edit\"`: Trigger diagnostics on file edit and save. (default)\n"
+ "Doc": "`\"Edit\"`: Trigger diagnostics on file edit and save. (default)\n",
+ "Status": ""
},
{
"Value": "\"Save\"",
- "Doc": "`\"Save\"`: Trigger diagnostics only on file save. Events like initial workspace load\nor configuration change will still trigger diagnostics.\n"
+ "Doc": "`\"Save\"`: Trigger diagnostics only on file save. Events like initial workspace load\nor configuration change will still trigger diagnostics.\n",
+ "Status": ""
}
],
"Default": "\"Edit\"",
@@ -769,37 +895,44 @@
{
"Name": "\"assignVariableTypes\"",
"Doc": "`\"assignVariableTypes\"` controls inlay hints for variable types in assign statements:\n```go\n\ti/* int*/, j/* int*/ := 0, len(r)-1\n```\n",
- "Default": "false"
+ "Default": "false",
+ "Status": ""
},
{
"Name": "\"compositeLiteralFields\"",
"Doc": "`\"compositeLiteralFields\"` inlay hints for composite literal field names:\n```go\n\t{/*in: */\"Hello, world\", /*want: */\"dlrow ,olleH\"}\n```\n",
- "Default": "false"
+ "Default": "false",
+ "Status": ""
},
{
"Name": "\"compositeLiteralTypes\"",
"Doc": "`\"compositeLiteralTypes\"` controls inlay hints for composite literal types:\n```go\n\tfor _, c := range []struct {\n\t\tin, want string\n\t}{\n\t\t/*struct{ in string; want string }*/{\"Hello, world\", \"dlrow ,olleH\"},\n\t}\n```\n",
- "Default": "false"
+ "Default": "false",
+ "Status": ""
},
{
"Name": "\"constantValues\"",
"Doc": "`\"constantValues\"` controls inlay hints for constant values:\n```go\n\tconst (\n\t\tKindNone Kind = iota/* = 0*/\n\t\tKindPrint/* = 1*/\n\t\tKindPrintf/* = 2*/\n\t\tKindErrorf/* = 3*/\n\t)\n```\n",
- "Default": "false"
+ "Default": "false",
+ "Status": ""
},
{
"Name": "\"functionTypeParameters\"",
"Doc": "`\"functionTypeParameters\"` inlay hints for implicit type parameters on generic functions:\n```go\n\tmyFoo/*[int, string]*/(1, \"hello\")\n```\n",
- "Default": "false"
+ "Default": "false",
+ "Status": ""
},
{
"Name": "\"parameterNames\"",
"Doc": "`\"parameterNames\"` controls inlay hints for parameter names:\n```go\n\tparseInt(/* str: */ \"123\", /* radix: */ 8)\n```\n",
- "Default": "false"
+ "Default": "false",
+ "Status": ""
},
{
"Name": "\"rangeVariableTypes\"",
"Doc": "`\"rangeVariableTypes\"` controls inlay hints for variable types in range statements:\n```go\n\tfor k/* int*/, v/* string*/ := range []string{} {\n\t\tfmt.Println(k, v)\n\t}\n```\n",
- "Default": "false"
+ "Default": "false",
+ "Status": ""
}
]
},
@@ -819,42 +952,50 @@
{
"Name": "\"generate\"",
"Doc": "`\"generate\"`: Run `go generate`\n\nThis codelens source annotates any `//go:generate` comments\nwith commands to run `go generate` in this directory, on\nall directories recursively beneath this one.\n\nSee [Generating code](https://go.dev/blog/generate) for\nmore details.\n",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"regenerate_cgo\"",
"Doc": "`\"regenerate_cgo\"`: Re-generate cgo declarations\n\nThis codelens source annotates an `import \"C\"` declaration\nwith a command to re-run the [cgo\ncommand](https://pkg.go.dev/cmd/cgo) to regenerate the\ncorresponding Go declarations.\n\nUse this after editing the C code in comments attached to\nthe import, or in C header files included by it.\n",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"run_govulncheck\"",
"Doc": "`\"run_govulncheck\"`: Run govulncheck (legacy)\n\nThis codelens source annotates the `module` directive in a go.mod file\nwith a command to run Govulncheck asynchronously.\n\n[Govulncheck](https://go.dev/blog/vuln) is a static analysis tool that\ncomputes the set of functions reachable within your application, including\ndependencies; queries a database of known security vulnerabilities; and\nreports any potential problems it finds.\n",
- "Default": "false"
+ "Default": "false",
+ "Status": "experimental"
},
{
"Name": "\"test\"",
"Doc": "`\"test\"`: Run tests and benchmarks\n\nThis codelens source annotates each `Test` and `Benchmark`\nfunction in a `*_test.go` file with a command to run it.\n\nThis source is off by default because VS Code has\na client-side custom UI for testing, and because progress\nnotifications are not a great UX for streamed test output.\nSee:\n- golang/go#67400 for a discussion of this feature.\n- https://github.com/joaotavora/eglot/discussions/1402\n for an alternative approach.\n",
- "Default": "false"
+ "Default": "false",
+ "Status": ""
},
{
"Name": "\"tidy\"",
"Doc": "`\"tidy\"`: Tidy go.mod file\n\nThis codelens source annotates the `module` directive in a\ngo.mod file with a command to run [`go mod\ntidy`](https://go.dev/ref/mod#go-mod-tidy), which ensures\nthat the go.mod file matches the source code in the module.\n",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"upgrade_dependency\"",
"Doc": "`\"upgrade_dependency\"`: Update dependencies\n\nThis codelens source annotates the `module` directive in a\ngo.mod file with commands to:\n\n- check for available upgrades,\n- upgrade direct dependencies, and\n- upgrade all dependencies transitively.\n",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"vendor\"",
"Doc": "`\"vendor\"`: Update vendor directory\n\nThis codelens source annotates the `module` directive in a\ngo.mod file with a command to run [`go mod\nvendor`](https://go.dev/ref/mod#go-mod-vendor), which\ncreates or updates the directory named `vendor` in the\nmodule root so that it contains an up-to-date copy of all\nnecessary package dependencies.\n",
- "Default": "true"
+ "Default": "true",
+ "Status": ""
},
{
"Name": "\"vulncheck\"",
"Doc": "`\"vulncheck\"`: Run govulncheck\n\nThis codelens source annotates the `module` directive in a go.mod file\nwith a command to run govulncheck synchronously.\n\n[Govulncheck](https://go.dev/blog/vuln) is a static analysis tool that\ncomputes the set of functions reachable within your application, including\ndependencies; queries a database of known security vulnerabilities; and\nreports any potential problems it finds.\n",
- "Default": "false"
+ "Default": "false",
+ "Status": "experimental"
}
]
},
@@ -984,56 +1125,64 @@
"Lens": "generate",
"Title": "Run `go generate`",
"Doc": "\nThis codelens source annotates any `//go:generate` comments\nwith commands to run `go generate` in this directory, on\nall directories recursively beneath this one.\n\nSee [Generating code](https://go.dev/blog/generate) for\nmore details.\n",
- "Default": true
+ "Default": true,
+ "Status": ""
},
{
"FileType": "Go",
"Lens": "regenerate_cgo",
"Title": "Re-generate cgo declarations",
"Doc": "\nThis codelens source annotates an `import \"C\"` declaration\nwith a command to re-run the [cgo\ncommand](https://pkg.go.dev/cmd/cgo) to regenerate the\ncorresponding Go declarations.\n\nUse this after editing the C code in comments attached to\nthe import, or in C header files included by it.\n",
- "Default": true
+ "Default": true,
+ "Status": ""
},
{
"FileType": "Go",
"Lens": "test",
"Title": "Run tests and benchmarks",
"Doc": "\nThis codelens source annotates each `Test` and `Benchmark`\nfunction in a `*_test.go` file with a command to run it.\n\nThis source is off by default because VS Code has\na client-side custom UI for testing, and because progress\nnotifications are not a great UX for streamed test output.\nSee:\n- golang/go#67400 for a discussion of this feature.\n- https://github.com/joaotavora/eglot/discussions/1402\n for an alternative approach.\n",
- "Default": false
+ "Default": false,
+ "Status": ""
},
{
"FileType": "go.mod",
"Lens": "run_govulncheck",
"Title": "Run govulncheck (legacy)",
"Doc": "\nThis codelens source annotates the `module` directive in a go.mod file\nwith a command to run Govulncheck asynchronously.\n\n[Govulncheck](https://go.dev/blog/vuln) is a static analysis tool that\ncomputes the set of functions reachable within your application, including\ndependencies; queries a database of known security vulnerabilities; and\nreports any potential problems it finds.\n",
- "Default": false
+ "Default": false,
+ "Status": "experimental"
},
{
"FileType": "go.mod",
"Lens": "tidy",
"Title": "Tidy go.mod file",
"Doc": "\nThis codelens source annotates the `module` directive in a\ngo.mod file with a command to run [`go mod\ntidy`](https://go.dev/ref/mod#go-mod-tidy), which ensures\nthat the go.mod file matches the source code in the module.\n",
- "Default": true
+ "Default": true,
+ "Status": ""
},
{
"FileType": "go.mod",
"Lens": "upgrade_dependency",
"Title": "Update dependencies",
"Doc": "\nThis codelens source annotates the `module` directive in a\ngo.mod file with commands to:\n\n- check for available upgrades,\n- upgrade direct dependencies, and\n- upgrade all dependencies transitively.\n",
- "Default": true
+ "Default": true,
+ "Status": ""
},
{
"FileType": "go.mod",
"Lens": "vendor",
"Title": "Update vendor directory",
"Doc": "\nThis codelens source annotates the `module` directive in a\ngo.mod file with a command to run [`go mod\nvendor`](https://go.dev/ref/mod#go-mod-vendor), which\ncreates or updates the directory named `vendor` in the\nmodule root so that it contains an up-to-date copy of all\nnecessary package dependencies.\n",
- "Default": true
+ "Default": true,
+ "Status": ""
},
{
"FileType": "go.mod",
"Lens": "vulncheck",
"Title": "Run govulncheck",
"Doc": "\nThis codelens source annotates the `module` directive in a go.mod file\nwith a command to run govulncheck synchronously.\n\n[Govulncheck](https://go.dev/blog/vuln) is a static analysis tool that\ncomputes the set of functions reachable within your application, including\ndependencies; queries a database of known security vulnerabilities; and\nreports any potential problems it finds.\n",
- "Default": false
+ "Default": false,
+ "Status": "experimental"
}
],
"Analyzers": [
@@ -1148,7 +1297,7 @@
{
"Name": "gofix",
"Doc": "apply fixes based on go:fix comment directives\n\nThe gofix analyzer inlines functions and constants that are marked for inlining.",
- "URL": "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/gofix",
+ "URL": "https://pkg.go.dev/golang.org/x/tools/internal/gofix",
"Default": true
},
{
@@ -1189,7 +1338,7 @@
},
{
"Name": "modernize",
- "Doc": "simplify code by using modern constructs\n\nThis analyzer reports opportunities for simplifying and clarifying\nexisting code by using more modern features of Go, such as:\n\n - replacing an if/else conditional assignment by a call to the\n built-in min or max functions added in go1.21;\n - replacing sort.Slice(x, func(i, j int) bool) { return s[i] \u003c s[j] }\n by a call to slices.Sort(s), added in go1.21;\n - replacing interface{} by the 'any' type added in go1.18;\n - replacing append([]T(nil), s...) by slices.Clone(s) or\n slices.Concat(s), added in go1.21;\n - replacing a loop around an m[k]=v map update by a call\n to one of the Collect, Copy, Clone, or Insert functions\n from the maps package, added in go1.21;\n - replacing []byte(fmt.Sprintf...) by fmt.Appendf(nil, ...),\n added in go1.19;\n - replacing uses of context.WithCancel in tests with t.Context, added in\n go1.24;\n - replacing omitempty by omitzero on structs, added in go1.24;\n - replacing append(s[:i], s[i+1]...) by slices.Delete(s, i, i+1),\n added in go1.21\n - replacing a 3-clause for i := 0; i \u003c n; i++ {} loop by\n for i := range n {}, added in go1.22;\n - replacing Split in \"for range strings.Split(...)\" by go1.24's\n more efficient SplitSeq;",
+ "Doc": "simplify code by using modern constructs\n\nThis analyzer reports opportunities for simplifying and clarifying\nexisting code by using more modern features of Go and its standard\nlibrary.\n\nEach diagnostic provides a fix. Our intent is that these fixes may\nbe safely applied en masse without changing the behavior of your\nprogram. In some cases the suggested fixes are imperfect and may\nlead to (for example) unused imports or unused local variables,\ncausing build breakage. However, these problems are generally\ntrivial to fix. We regard any modernizer whose fix changes program\nbehavior to have a serious bug and will endeavor to fix it.\n\nTo apply all modernization fixes en masse, you can use the\nfollowing command:\n\n\t$ go run golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@latest -fix -test ./...\n\nIf the tool warns of conflicting fixes, you may need to run it more\nthan once until it has applied all fixes cleanly. This command is\nnot an officially supported interface and may change in the future.\n\nChanges produced by this tool should be reviewed as usual before\nbeing merged. In some cases, a loop may be replaced by a simple\nfunction call, causing comments within the loop to be discarded.\nHuman judgment may be required to avoid losing comments of value.\n\nEach diagnostic reported by modernize has a specific category. (The\ncategories are listed below.) Diagnostics in some categories, such\nas \"efaceany\" (which replaces \"interface{}\" with \"any\" where it is\nsafe to do so) are particularly numerous. It may ease the burden of\ncode review to apply fixes in two passes, the first change\nconsisting only of fixes of category \"efaceany\", the second\nconsisting of all others. This can be achieved using the -category flag:\n\n\t$ modernize -category=efaceany -fix -test ./...\n\t$ modernize -category=-efaceany -fix -test ./...\n\nCategories of modernize diagnostic:\n\n - forvar: remove x := x variable declarations made unnecessary by the new semantics of loops in go1.22.\n\n - slicescontains: replace 'for i, elem := range s { if elem == needle { ...; break }'\n by a call to slices.Contains, added in go1.21.\n\n - minmax: replace an if/else conditional assignment by a call to\n the built-in min or max functions added in go1.21.\n\n - sortslice: replace sort.Slice(x, func(i, j int) bool) { return s[i] \u003c s[j] }\n by a call to slices.Sort(s), added in go1.21.\n\n - efaceany: replace interface{} by the 'any' type added in go1.18.\n\n - slicesclone: replace append([]T(nil), s...) by slices.Clone(s) or\n slices.Concat(s), added in go1.21.\n\n - mapsloop: replace a loop around an m[k]=v map update by a call\n to one of the Collect, Copy, Clone, or Insert functions from\n the maps package, added in go1.21.\n\n - fmtappendf: replace []byte(fmt.Sprintf...) by fmt.Appendf(nil, ...),\n added in go1.19.\n\n - testingcontext: replace uses of context.WithCancel in tests\n with t.Context, added in go1.24.\n\n - omitzero: replace omitempty by omitzero on structs, added in go1.24.\n\n - bloop: replace \"for i := range b.N\" or \"for range b.N\" in a\n benchmark with \"for b.Loop()\", and remove any preceding calls\n to b.StopTimer, b.StartTimer, and b.ResetTimer.\n\n - slicesdelete: replace append(s[:i], s[i+1]...) by\n slices.Delete(s, i, i+1), added in go1.21.\n\n - rangeint: replace a 3-clause \"for i := 0; i \u003c n; i++\" loop by\n \"for i := range n\", added in go1.22.\n\n - stringsseq: replace Split in \"for range strings.Split(...)\" by go1.24's\n more efficient SplitSeq, or Fields with FieldSeq.\n\n - stringscutprefix: replace some uses of HasPrefix followed by TrimPrefix with CutPrefix,\n added to the strings package in go1.20.\n\n - waitgroup: replace old complex usages of sync.WaitGroup by less complex WaitGroup.Go method in go1.25.",
"URL": "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/modernize",
"Default": true
},
@@ -1333,7 +1482,7 @@
},
{
"Name": "unusedfunc",
- "Doc": "check for unused functions and methods\n\nThe unusedfunc analyzer reports functions and methods that are\nnever referenced outside of their own declaration.\n\nA function is considered unused if it is unexported and not\nreferenced (except within its own declaration).\n\nA method is considered unused if it is unexported, not referenced\n(except within its own declaration), and its name does not match\nthat of any method of an interface type declared within the same\npackage.\n\nThe tool may report a false positive for a declaration of an\nunexported function that is referenced from another package using\nthe go:linkname mechanism, if the declaration's doc comment does\nnot also have a go:linkname comment. (Such code is in any case\nstrongly discouraged: linkname annotations, if they must be used at\nall, should be used on both the declaration and the alias.)\n\nThe unusedfunc algorithm is not as precise as the\ngolang.org/x/tools/cmd/deadcode tool, but it has the advantage that\nit runs within the modular analysis framework, enabling near\nreal-time feedback within gopls.",
+ "Doc": "check for unused functions and methods\n\nThe unusedfunc analyzer reports functions and methods that are\nnever referenced outside of their own declaration.\n\nA function is considered unused if it is unexported and not\nreferenced (except within its own declaration).\n\nA method is considered unused if it is unexported, not referenced\n(except within its own declaration), and its name does not match\nthat of any method of an interface type declared within the same\npackage.\n\nThe tool may report false positives in some situations, for\nexample:\n\n - For a declaration of an unexported function that is referenced\n from another package using the go:linkname mechanism, if the\n declaration's doc comment does not also have a go:linkname\n comment.\n\n (Such code is in any case strongly discouraged: linkname\n annotations, if they must be used at all, should be used on both\n the declaration and the alias.)\n\n - For compiler intrinsics in the \"runtime\" package that, though\n never referenced, are known to the compiler and are called\n indirectly by compiled object code.\n\n - For functions called only from assembly.\n\n - For functions called only from files whose build tags are not\n selected in the current build configuration.\n\nSee https://github.com/golang/go/issues/71686 for discussion of\nthese limitations.\n\nThe unusedfunc algorithm is not as precise as the\ngolang.org/x/tools/cmd/deadcode tool, but it has the advantage that\nit runs within the modular analysis framework, enabling near\nreal-time feedback within gopls.",
"URL": "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/unusedfunc",
"Default": true
},
@@ -1378,37 +1527,44 @@
{
"Name": "assignVariableTypes",
"Doc": "`\"assignVariableTypes\"` controls inlay hints for variable types in assign statements:\n```go\n\ti/* int*/, j/* int*/ := 0, len(r)-1\n```\n",
- "Default": false
+ "Default": false,
+ "Status": ""
},
{
"Name": "compositeLiteralFields",
"Doc": "`\"compositeLiteralFields\"` inlay hints for composite literal field names:\n```go\n\t{/*in: */\"Hello, world\", /*want: */\"dlrow ,olleH\"}\n```\n",
- "Default": false
+ "Default": false,
+ "Status": ""
},
{
"Name": "compositeLiteralTypes",
"Doc": "`\"compositeLiteralTypes\"` controls inlay hints for composite literal types:\n```go\n\tfor _, c := range []struct {\n\t\tin, want string\n\t}{\n\t\t/*struct{ in string; want string }*/{\"Hello, world\", \"dlrow ,olleH\"},\n\t}\n```\n",
- "Default": false
+ "Default": false,
+ "Status": ""
},
{
"Name": "constantValues",
"Doc": "`\"constantValues\"` controls inlay hints for constant values:\n```go\n\tconst (\n\t\tKindNone Kind = iota/* = 0*/\n\t\tKindPrint/* = 1*/\n\t\tKindPrintf/* = 2*/\n\t\tKindErrorf/* = 3*/\n\t)\n```\n",
- "Default": false
+ "Default": false,
+ "Status": ""
},
{
"Name": "functionTypeParameters",
"Doc": "`\"functionTypeParameters\"` inlay hints for implicit type parameters on generic functions:\n```go\n\tmyFoo/*[int, string]*/(1, \"hello\")\n```\n",
- "Default": false
+ "Default": false,
+ "Status": ""
},
{
"Name": "parameterNames",
"Doc": "`\"parameterNames\"` controls inlay hints for parameter names:\n```go\n\tparseInt(/* str: */ \"123\", /* radix: */ 8)\n```\n",
- "Default": false
+ "Default": false,
+ "Status": ""
},
{
"Name": "rangeVariableTypes",
"Doc": "`\"rangeVariableTypes\"` controls inlay hints for variable types in range statements:\n```go\n\tfor k/* int*/, v/* string*/ := range []string{} {\n\t\tfmt.Println(k, v)\n\t}\n```\n",
- "Default": false
+ "Default": false,
+ "Status": ""
}
]
}
\ No newline at end of file
diff --git a/gopls/doc/generate/generate.go b/gopls/internal/doc/generate/generate.go
similarity index 95%
rename from gopls/doc/generate/generate.go
rename to gopls/internal/doc/generate/generate.go
index b0d3e8c49f6..762fceeb4b9 100644
--- a/gopls/doc/generate/generate.go
+++ b/gopls/internal/doc/generate/generate.go
@@ -11,9 +11,7 @@
//
// Run it with this command:
//
-// $ cd gopls/internal/doc && go generate
-//
-// TODO(adonovan): move this package to gopls/internal/doc/generate.
+// $ cd gopls/internal/doc/generate && go generate
package main
import (
@@ -319,9 +317,17 @@ func loadEnums(pkg *packages.Package) (map[types.Type][]doc.EnumValue, error) {
spec := path[1].(*ast.ValueSpec)
value := cnst.Val().ExactString()
docstring := valueDoc(cnst.Name(), value, spec.Doc.Text())
+ var status string
+ for _, d := range internalastutil.Directives(spec.Doc) {
+ if d.Tool == "gopls" && d.Name == "status" {
+ status = d.Args
+ break
+ }
+ }
v := doc.EnumValue{
- Value: value,
- Doc: docstring,
+ Value: value,
+ Doc: docstring,
+ Status: status,
}
enums[obj.Type()] = append(enums[obj.Type()], v)
}
@@ -356,6 +362,7 @@ func collectEnumKeys(m *types.Map, reflectField reflect.Value, enumValues []doc.
keys = append(keys, doc.EnumKey{
Name: v.Value,
Doc: v.Doc,
+ Status: v.Status,
Default: def,
})
}
@@ -438,6 +445,7 @@ func loadLenses(settingsPkg *packages.Package, defaults map[settings.CodeLensSou
// Find the CodeLensSource enums among the files of the protocol package.
// Map each enum value to its doc comment.
enumDoc := make(map[string]string)
+ enumStatus := make(map[string]string)
for _, f := range settingsPkg.Syntax {
for _, decl := range f.Decls {
if decl, ok := decl.(*ast.GenDecl); ok && decl.Tok == token.CONST {
@@ -457,6 +465,12 @@ func loadLenses(settingsPkg *packages.Package, defaults map[settings.CodeLensSou
return nil, fmt.Errorf("%s: %s lacks doc comment", posn, spec.Names[0].Name)
}
enumDoc[value] = spec.Doc.Text()
+ for _, d := range internalastutil.Directives(spec.Doc) {
+ if d.Tool == "gopls" && d.Name == "status" {
+ enumStatus[value] = d.Args
+ break
+ }
+ }
}
}
}
@@ -481,6 +495,7 @@ func loadLenses(settingsPkg *packages.Package, defaults map[settings.CodeLensSou
Title: title,
Doc: docText,
Default: defaults[source],
+ Status: enumStatus[string(source)],
})
}
return nil
@@ -520,8 +535,9 @@ func loadHints(settingsPkg *packages.Package) ([]*doc.Hint, error) {
for _, enumVal := range enums[inlayHint] {
name, _ := strconv.Unquote(enumVal.Value)
hints = append(hints, &doc.Hint{
- Name: name,
- Doc: enumVal.Doc,
+ Name: name,
+ Doc: enumVal.Doc,
+ Status: enumVal.Status,
})
}
return hints, nil
@@ -602,17 +618,7 @@ func rewriteSettings(prevContent []byte, api *doc.API) ([]byte, error) {
fmt.Fprintf(&buf, "### `%s %s`\n\n", opt.Name, opt.Type)
// status
- switch opt.Status {
- case "":
- case "advanced":
- fmt.Fprint(&buf, "**This is an advanced setting and should not be configured by most `gopls` users.**\n\n")
- case "debug":
- fmt.Fprint(&buf, "**This setting is for debugging purposes only.**\n\n")
- case "experimental":
- fmt.Fprint(&buf, "**This setting is experimental and may be deleted.**\n\n")
- default:
- fmt.Fprintf(&buf, "**Status: %s.**\n\n", opt.Status)
- }
+ writeStatus(&buf, opt.Status)
// doc comment
buf.WriteString(opt.Doc)
@@ -653,6 +659,22 @@ func rewriteSettings(prevContent []byte, api *doc.API) ([]byte, error) {
return content, nil
}
+// writeStatus emits a Markdown paragraph to buf about the status of a feature,
+// if nonempty.
+func writeStatus(buf *bytes.Buffer, status string) {
+ switch status {
+ case "":
+ case "advanced":
+ fmt.Fprint(buf, "**This is an advanced setting and should not be configured by most `gopls` users.**\n\n")
+ case "debug":
+ fmt.Fprint(buf, "**This setting is for debugging purposes only.**\n\n")
+ case "experimental":
+ fmt.Fprint(buf, "**This setting is experimental and may be deleted.**\n\n")
+ default:
+ fmt.Fprintf(buf, "**Status: %s.**\n\n", status)
+ }
+}
+
var parBreakRE = regexp.MustCompile("\n{2,}")
func shouldShowEnumKeysInSettings(name string) bool {
@@ -724,6 +746,7 @@ func rewriteCodeLenses(prevContent []byte, api *doc.API) ([]byte, error) {
var buf bytes.Buffer
for _, lens := range api.Lenses {
fmt.Fprintf(&buf, "## `%s`: %s\n\n", lens.Lens, lens.Title)
+ writeStatus(&buf, lens.Status)
fmt.Fprintf(&buf, "%s\n\n", lens.Doc)
fmt.Fprintf(&buf, "Default: %v\n\n", onOff(lens.Default))
fmt.Fprintf(&buf, "File type: %s\n\n", lens.FileType)
diff --git a/gopls/doc/generate/generate_test.go b/gopls/internal/doc/generate/generate_test.go
similarity index 100%
rename from gopls/doc/generate/generate_test.go
rename to gopls/internal/doc/generate/generate_test.go
diff --git a/gopls/internal/file/file.go b/gopls/internal/file/file.go
index 5f8be06cf60..b817306aa07 100644
--- a/gopls/internal/file/file.go
+++ b/gopls/internal/file/file.go
@@ -49,6 +49,8 @@ type Handle interface {
// Content returns the contents of a file.
// If the file is not available, returns a nil slice and an error.
Content() ([]byte, error)
+ // String returns the file's path.
+ String() string
}
// A Source maps URIs to Handles.
diff --git a/gopls/internal/file/kind.go b/gopls/internal/file/kind.go
index 087a57f32d0..6a0ed009ed5 100644
--- a/gopls/internal/file/kind.go
+++ b/gopls/internal/file/kind.go
@@ -28,6 +28,8 @@ const (
Tmpl
// Work is a go.work file.
Work
+ // Asm is a Go assembly (.s) file.
+ Asm
)
func (k Kind) String() string {
@@ -42,13 +44,15 @@ func (k Kind) String() string {
return "tmpl"
case Work:
return "go.work"
+ case Asm:
+ return "Go assembly"
default:
return fmt.Sprintf("internal error: unknown file kind %d", k)
}
}
// KindForLang returns the gopls file [Kind] associated with the given LSP
-// LanguageKind string from protocol.TextDocumentItem.LanguageID,
+// LanguageKind string from the LanguageID field of [protocol.TextDocumentItem],
// or UnknownKind if the language is not one recognized by gopls.
func KindForLang(langID protocol.LanguageKind) Kind {
switch langID {
@@ -62,6 +66,8 @@ func KindForLang(langID protocol.LanguageKind) Kind {
return Tmpl
case "go.work":
return Work
+ case "go.s":
+ return Asm
default:
return UnknownKind
}
diff --git a/gopls/internal/fuzzy/input.go b/gopls/internal/fuzzy/input.go
index c1038163f1a..fd8575f6382 100644
--- a/gopls/internal/fuzzy/input.go
+++ b/gopls/internal/fuzzy/input.go
@@ -36,7 +36,7 @@ func RuneRoles(candidate []byte, reuse []RuneRole) []RuneRole {
}
prev, prev2 := rtNone, rtNone
- for i := 0; i < len(candidate); i++ {
+ for i := range candidate {
r := rune(candidate[i])
role := RNone
@@ -122,7 +122,7 @@ func LastSegment(input string, roles []RuneRole) string {
func fromChunks(chunks []string, buffer []byte) []byte {
ii := 0
for _, chunk := range chunks {
- for i := 0; i < len(chunk); i++ {
+ for i := range len(chunk) {
if ii >= cap(buffer) {
break
}
@@ -143,7 +143,7 @@ func toLower(input []byte, reuse []byte) []byte {
output = make([]byte, len(input))
}
- for i := 0; i < len(input); i++ {
+ for i := range input {
r := rune(input[i])
if input[i] <= unicode.MaxASCII {
if 'A' <= r && r <= 'Z' {
diff --git a/gopls/internal/fuzzy/input_test.go b/gopls/internal/fuzzy/input_test.go
index ffe147241b6..dd751b8f0c2 100644
--- a/gopls/internal/fuzzy/input_test.go
+++ b/gopls/internal/fuzzy/input_test.go
@@ -127,7 +127,7 @@ func BenchmarkRoles(b *testing.B) {
str := "AbstractSWTFactory"
out := make([]fuzzy.RuneRole, len(str))
- for i := 0; i < b.N; i++ {
+ for b.Loop() {
fuzzy.RuneRoles([]byte(str), out)
}
b.SetBytes(int64(len(str)))
diff --git a/gopls/internal/fuzzy/matcher.go b/gopls/internal/fuzzy/matcher.go
index 29d1b36501e..eff86efac34 100644
--- a/gopls/internal/fuzzy/matcher.go
+++ b/gopls/internal/fuzzy/matcher.go
@@ -134,10 +134,7 @@ func (m *Matcher) ScoreChunks(chunks []string) float32 {
if sc < 0 {
sc = 0
}
- normalizedScore := float32(sc) * m.scoreScale
- if normalizedScore > 1 {
- normalizedScore = 1
- }
+ normalizedScore := min(float32(sc)*m.scoreScale, 1)
return normalizedScore
}
@@ -177,7 +174,7 @@ func (m *Matcher) MatchedRanges() []int {
i--
}
// Reverse slice.
- for i := 0; i < len(ret)/2; i++ {
+ for i := range len(ret) / 2 {
ret[i], ret[len(ret)-1-i] = ret[len(ret)-1-i], ret[i]
}
return ret
@@ -211,7 +208,7 @@ func (m *Matcher) computeScore(candidate []byte, candidateLower []byte) int {
m.scores[0][0][0] = score(0, 0) // Start with 0.
segmentsLeft, lastSegStart := 1, 0
- for i := 0; i < candLen; i++ {
+ for i := range candLen {
if m.roles[i] == RSep {
segmentsLeft++
lastSegStart = i + 1
@@ -304,7 +301,7 @@ func (m *Matcher) computeScore(candidate []byte, candidateLower []byte) int {
// Third dimension encodes whether there is a gap between the previous match and the current
// one.
- for k := 0; k < 2; k++ {
+ for k := range 2 {
sc := m.scores[i-1][j-1][k].val() + charScore
isConsecutive := k == 1 || i-1 == 0 || i-1 == lastSegStart
@@ -342,7 +339,7 @@ func (m *Matcher) ScoreTable(candidate string) string {
var line1, line2, separator bytes.Buffer
line1.WriteString("\t")
line2.WriteString("\t")
- for j := 0; j < len(m.pattern); j++ {
+ for j := range len(m.pattern) {
line1.WriteString(fmt.Sprintf("%c\t\t", m.pattern[j]))
separator.WriteString("----------------")
}
diff --git a/gopls/internal/fuzzy/matcher_test.go b/gopls/internal/fuzzy/matcher_test.go
index 056da25d675..f743be0c5ef 100644
--- a/gopls/internal/fuzzy/matcher_test.go
+++ b/gopls/internal/fuzzy/matcher_test.go
@@ -293,8 +293,7 @@ func BenchmarkMatcher(b *testing.B) {
matcher := fuzzy.NewMatcher(pattern)
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
+ for b.Loop() {
for _, c := range candidates {
matcher.Score(c)
}
diff --git a/gopls/internal/fuzzy/self_test.go b/gopls/internal/fuzzy/self_test.go
index 1c64f1953df..7cdb4fdef96 100644
--- a/gopls/internal/fuzzy/self_test.go
+++ b/gopls/internal/fuzzy/self_test.go
@@ -14,7 +14,7 @@ func BenchmarkSelf_Matcher(b *testing.B) {
idents := collectIdentifiers(b)
patterns := generatePatterns()
- for i := 0; i < b.N; i++ {
+ for b.Loop() {
for _, pattern := range patterns {
sm := NewMatcher(pattern)
for _, ident := range idents {
@@ -28,7 +28,7 @@ func BenchmarkSelf_SymbolMatcher(b *testing.B) {
idents := collectIdentifiers(b)
patterns := generatePatterns()
- for i := 0; i < b.N; i++ {
+ for b.Loop() {
for _, pattern := range patterns {
sm := NewSymbolMatcher(pattern)
for _, ident := range idents {
diff --git a/gopls/internal/goasm/definition.go b/gopls/internal/goasm/definition.go
new file mode 100644
index 00000000000..903916d265d
--- /dev/null
+++ b/gopls/internal/goasm/definition.go
@@ -0,0 +1,136 @@
+// Copyright 2025 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 goasm provides language-server features for files in Go
+// assembly language (https://go.dev/doc/asm).
+package goasm
+
+import (
+ "context"
+ "fmt"
+ "go/token"
+
+ "golang.org/x/tools/gopls/internal/cache"
+ "golang.org/x/tools/gopls/internal/cache/metadata"
+ "golang.org/x/tools/gopls/internal/file"
+ "golang.org/x/tools/gopls/internal/protocol"
+ "golang.org/x/tools/gopls/internal/util/asm"
+ "golang.org/x/tools/gopls/internal/util/morestrings"
+ "golang.org/x/tools/internal/event"
+)
+
+// Definition handles the textDocument/definition request for Go assembly files.
+func Definition(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, position protocol.Position) ([]protocol.Location, error) {
+ ctx, done := event.Start(ctx, "goasm.Definition")
+ defer done()
+
+ mp, err := snapshot.NarrowestMetadataForFile(ctx, fh.URI())
+ if err != nil {
+ return nil, err
+ }
+
+ // Read the file.
+ content, err := fh.Content()
+ if err != nil {
+ return nil, err
+ }
+ mapper := protocol.NewMapper(fh.URI(), content)
+ offset, err := mapper.PositionOffset(position)
+ if err != nil {
+ return nil, err
+ }
+
+ // Parse the assembly.
+ //
+ // TODO(adonovan): make this just another
+ // attribute of the type-checked cache.Package.
+ file := asm.Parse(content)
+
+ // Figure out the selected symbol.
+ // For now, just find the identifier around the cursor.
+ var found *asm.Ident
+ for _, id := range file.Idents {
+ if id.Offset <= offset && offset <= id.End() {
+ found = &id
+ break
+ }
+ }
+ if found == nil {
+ return nil, fmt.Errorf("not an identifier")
+ }
+
+ // Resolve a symbol with a "." prefix to the current package.
+ sym := found.Name
+ if sym != "" && sym[0] == '.' {
+ sym = string(mp.PkgPath) + sym
+ }
+
+ // package-qualified symbol?
+ if pkgpath, name, ok := morestrings.CutLast(sym, "."); ok {
+ // Find declaring package among dependencies.
+ //
+ // TODO(adonovan): assembly may legally reference
+ // non-dependencies. For example, sync/atomic calls
+ // internal/runtime/atomic. Perhaps we should search
+ // the entire metadata graph, but that's path-dependent.
+ var declaring *metadata.Package
+ for pkg := range snapshot.MetadataGraph().ForwardReflexiveTransitiveClosure(mp.ID) {
+ if pkg.PkgPath == metadata.PackagePath(pkgpath) {
+ declaring = pkg
+ break
+ }
+ }
+ if declaring == nil {
+ return nil, fmt.Errorf("package %q is not a dependency", pkgpath)
+ }
+
+ pkgs, err := snapshot.TypeCheck(ctx, declaring.ID)
+ if err != nil {
+ return nil, err
+ }
+ pkg := pkgs[0]
+ def := pkg.Types().Scope().Lookup(name)
+ if def == nil {
+ return nil, fmt.Errorf("no symbol %q in package %q", name, pkgpath)
+ }
+ loc, err := mapPosition(ctx, pkg.FileSet(), snapshot, def.Pos(), def.Pos())
+ if err == nil {
+ return []protocol.Location{loc}, nil
+ }
+
+ } else {
+ // local symbols (funcs, vars, labels)
+ for _, id := range file.Idents {
+ if id.Name == found.Name &&
+ (id.Kind == asm.Text || id.Kind == asm.Global || id.Kind == asm.Label) {
+
+ loc, err := mapper.OffsetLocation(id.Offset, id.End())
+ if err != nil {
+ return nil, err
+ }
+ return []protocol.Location{loc}, nil
+ }
+ }
+ }
+
+ return nil, nil
+}
+
+// TODO(rfindley): avoid the duplicate column mapping here, by associating a
+// column mapper with each file handle.
+// TODO(adonovan): plundered from ../golang; factor.
+func mapPosition(ctx context.Context, fset *token.FileSet, s file.Source, start, end token.Pos) (protocol.Location, error) {
+ file := fset.File(start)
+ uri := protocol.URIFromPath(file.Name())
+ fh, err := s.ReadFile(ctx, uri)
+ if err != nil {
+ return protocol.Location{}, err
+ }
+ content, err := fh.Content()
+ if err != nil {
+ return protocol.Location{}, err
+ }
+ m := protocol.NewMapper(fh.URI(), content)
+ return m.PosLocation(file, start, end)
+}
diff --git a/gopls/internal/golang/addtest.go b/gopls/internal/golang/addtest.go
index 4a43a82ffee..e952874e109 100644
--- a/gopls/internal/golang/addtest.go
+++ b/gopls/internal/golang/addtest.go
@@ -319,7 +319,7 @@ func AddTestForFunc(ctx context.Context, snapshot *cache.Snapshot, loc protocol.
// package decl based on the originating file.
// Search for something that looks like a copyright header, to replicate
// in the new file.
- if c := copyrightComment(pgf.File); c != nil {
+ if c := CopyrightComment(pgf.File); c != nil {
start, end, err := pgf.NodeOffsets(c)
if err != nil {
return nil, err
diff --git a/gopls/internal/golang/assembly.go b/gopls/internal/golang/assembly.go
index 3b778a54697..12244a58c59 100644
--- a/gopls/internal/golang/assembly.go
+++ b/gopls/internal/golang/assembly.go
@@ -10,12 +10,17 @@ package golang
// - ./codeaction.go - computes the symbol and offers the CodeAction command.
// - ../server/command.go - handles the command by opening a web page.
// - ../server/server.go - handles the HTTP request and calls this function.
+//
+// For language-server behavior in Go assembly language files,
+// see [golang.org/x/tools/gopls/internal/goasm].
import (
"bytes"
"context"
"fmt"
"html"
+ "io"
+ "net/http"
"regexp"
"strconv"
"strings"
@@ -26,39 +31,35 @@ import (
// AssemblyHTML returns an HTML document containing an assembly listing of the selected function.
//
-// TODO(adonovan):
-// - display a "Compiling..." message as a cold build can be slow.
-// - cross-link jumps and block labels, like github.com/aclements/objbrowse.
-func AssemblyHTML(ctx context.Context, snapshot *cache.Snapshot, pkg *cache.Package, symbol string, web Web) ([]byte, error) {
- // Compile the package with -S, and capture its stderr stream.
+// TODO(adonovan): cross-link jumps and block labels, like github.com/aclements/objbrowse.
+//
+// See gopls/internal/test/integration/misc/webserver_test.go for tests.
+func AssemblyHTML(ctx context.Context, snapshot *cache.Snapshot, w http.ResponseWriter, pkg *cache.Package, symbol string, web Web) {
+ // Prepare to compile the package with -S, and capture its stderr stream.
inv, cleanupInvocation, err := snapshot.GoCommandInvocation(cache.NoNetwork, pkg.Metadata().CompiledGoFiles[0].DirPath(), "build", []string{"-gcflags=-S", "."})
if err != nil {
- return nil, err // e.g. failed to write overlays (rare)
+ // e.g. failed to write overlays (rare)
+ http.Error(w, err.Error(), http.StatusInternalServerError)
+ return
}
defer cleanupInvocation()
- _, stderr, err, _ := snapshot.View().GoCommandRunner().RunRaw(ctx, *inv)
- if err != nil {
- return nil, err // e.g. won't compile
- }
- content := stderr.String()
escape := html.EscapeString
- // Produce the report.
+ // Emit the start of the report.
title := fmt.Sprintf("%s assembly for %s",
escape(snapshot.View().GOARCH()),
escape(symbol))
- var buf bytes.Buffer
- buf.WriteString(`
+ io.WriteString(w, `
- ` + escape(title) + `
+ `+escape(title)+`
-
@@ -69,11 +70,38 @@ func AssemblyHTML(ctx context.Context, snapshot *cache.Snapshot, pkg *cache.Pack
Click on a source line marker L1234 to navigate your editor there.
(VS Code users: please upvote #208093)
-
- Reload the page to recompile.
-
+
Compiling...
`)
+ if flusher, ok := w.(http.Flusher); ok {
+ flusher.Flush()
+ }
+
+ // At this point errors must be reported by writing HTML.
+ // To do this, set "status" return early.
+
+ var buf bytes.Buffer
+ status := "Reload the page to recompile."
+ defer func() {
+ // Update the "Compiling..." message.
+ fmt.Fprintf(&buf, `
+
+
+`, status)
+ w.Write(buf.Bytes())
+ }()
+
+ // Compile the package.
+ _, stderr, err, _ := snapshot.View().GoCommandRunner().RunRaw(ctx, *inv)
+ if err != nil {
+ status = fmt.Sprintf("compilation failed: %v", err)
+ return
+ }
+
+ // Write the rest of the report.
+ content := stderr.String()
// insnRx matches an assembly instruction line.
// Submatch groups are: (offset-hex-dec, file-line-column, instruction).
@@ -88,7 +116,7 @@ func AssemblyHTML(ctx context.Context, snapshot *cache.Snapshot, pkg *cache.Pack
//
// Allow matches of symbol, symbol.func1, symbol.deferwrap, etc.
on := false
- for _, line := range strings.Split(content, "\n") {
+ for line := range strings.SplitSeq(content, "\n") {
// start of function symbol?
if strings.Contains(line, " STEXT ") {
on = strings.HasPrefix(line, symbol) &&
@@ -116,5 +144,4 @@ func AssemblyHTML(ctx context.Context, snapshot *cache.Snapshot, pkg *cache.Pack
}
buf.WriteByte('\n')
}
- return buf.Bytes(), nil
}
diff --git a/gopls/internal/golang/codeaction.go b/gopls/internal/golang/codeaction.go
index 34ac7426019..7949493a896 100644
--- a/gopls/internal/golang/codeaction.go
+++ b/gopls/internal/golang/codeaction.go
@@ -14,7 +14,6 @@ import (
"path/filepath"
"reflect"
"slices"
- "sort"
"strings"
"golang.org/x/tools/go/ast/astutil"
@@ -112,10 +111,7 @@ func CodeActions(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle,
}
}
- sort.Slice(actions, func(i, j int) bool {
- return actions[i].Kind < actions[j].Kind
- })
-
+ // Return code actions in the order their providers are listed.
return actions, nil
}
@@ -233,6 +229,8 @@ type codeActionProducer struct {
needPkg bool // fn needs type information (req.pkg)
}
+// Code Actions are returned in the order their producers are listed below.
+// Depending on the client, this may influence the order they appear in the UI.
var codeActionProducers = [...]codeActionProducer{
{kind: protocol.QuickFix, fn: quickFix, needPkg: true},
{kind: protocol.SourceOrganizeImports, fn: sourceOrganizeImports},
@@ -240,9 +238,8 @@ var codeActionProducers = [...]codeActionProducer{
{kind: settings.GoAssembly, fn: goAssembly, needPkg: true},
{kind: settings.GoDoc, fn: goDoc, needPkg: true},
{kind: settings.GoFreeSymbols, fn: goFreeSymbols},
- {kind: settings.GoTest, fn: goTest},
+ {kind: settings.GoTest, fn: goTest, needPkg: true},
{kind: settings.GoToggleCompilerOptDetails, fn: toggleCompilerOptDetails},
- {kind: settings.GoplsDocFeatures, fn: goplsDocFeatures},
{kind: settings.RefactorExtractFunction, fn: refactorExtractFunction},
{kind: settings.RefactorExtractMethod, fn: refactorExtractMethod},
{kind: settings.RefactorExtractToNewFile, fn: refactorExtractToNewFile},
@@ -260,6 +257,8 @@ var codeActionProducers = [...]codeActionProducer{
{kind: settings.RefactorRewriteMoveParamLeft, fn: refactorRewriteMoveParamLeft, needPkg: true},
{kind: settings.RefactorRewriteMoveParamRight, fn: refactorRewriteMoveParamRight, needPkg: true},
{kind: settings.RefactorRewriteSplitLines, fn: refactorRewriteSplitLines, needPkg: true},
+ {kind: settings.RefactorRewriteEliminateDotImport, fn: refactorRewriteEliminateDotImport, needPkg: true},
+ {kind: settings.GoplsDocFeatures, fn: goplsDocFeatures}, // offer this one last (#72742)
// Note: don't forget to update the allow-list in Server.CodeAction
// when adding new query operations like GoTest and GoDoc that
@@ -309,7 +308,7 @@ func quickFix(ctx context.Context, req *codeActionsRequest) error {
for _, typeError := range req.pkg.TypeErrors() {
// Does type error overlap with CodeAction range?
start, end := typeError.Pos, typeError.Pos
- if _, _, endPos, ok := typesinternal.ReadGo116ErrorData(typeError); ok {
+ if _, _, endPos, ok := typesinternal.ErrorCodeStartEnd(typeError); ok {
end = endPos
}
typeErrorRange, err := req.pgf.PosRange(start, end)
@@ -325,8 +324,7 @@ func quickFix(ctx context.Context, req *codeActionsRequest) error {
case strings.Contains(msg, "missing method"),
strings.HasPrefix(msg, "cannot convert"),
strings.Contains(msg, "not implement"):
- path, _ := astutil.PathEnclosingInterval(req.pgf.File, start, end)
- si := stubmethods.GetIfaceStubInfo(req.pkg.FileSet(), info, path, start)
+ si := stubmethods.GetIfaceStubInfo(req.pkg.FileSet(), info, req.pgf, start, end)
if si != nil {
qual := typesinternal.FileQualifier(req.pgf.File, si.Concrete.Obj().Pkg())
iface := types.TypeString(si.Interface.Type(), qual)
@@ -338,8 +336,7 @@ func quickFix(ctx context.Context, req *codeActionsRequest) error {
// Offer a "Declare missing method T.f" code action.
// See [stubMissingCalledFunctionFixer] for command implementation.
case strings.Contains(msg, "has no field or method"):
- path, _ := astutil.PathEnclosingInterval(req.pgf.File, start, end)
- si := stubmethods.GetCallStubInfo(req.pkg.FileSet(), info, path, start)
+ si := stubmethods.GetCallStubInfo(req.pkg.FileSet(), info, req.pgf, start, end)
if si != nil {
msg := fmt.Sprintf("Declare missing method %s.%s", si.Receiver.Obj().Name(), si.MethodName)
req.addApplyFixAction(msg, fixMissingCalledFunction, req.loc)
@@ -462,7 +459,7 @@ func goDoc(ctx context.Context, req *codeActionsRequest) error {
// refactorExtractFunction produces "Extract function" code actions.
// See [extractFunction] for command implementation.
func refactorExtractFunction(ctx context.Context, req *codeActionsRequest) error {
- if _, ok, _, _ := canExtractFunction(req.pgf.Tok, req.start, req.end, req.pgf.Src, req.pgf.File); ok {
+ if _, ok, _, _ := canExtractFunction(req.pgf.Tok, req.start, req.end, req.pgf.Src, req.pgf.Cursor); ok {
req.addApplyFixAction("Extract function", fixExtractFunction, req.loc)
}
return nil
@@ -471,7 +468,7 @@ func refactorExtractFunction(ctx context.Context, req *codeActionsRequest) error
// refactorExtractMethod produces "Extract method" code actions.
// See [extractMethod] for command implementation.
func refactorExtractMethod(ctx context.Context, req *codeActionsRequest) error {
- if _, ok, methodOK, _ := canExtractFunction(req.pgf.Tok, req.start, req.end, req.pgf.Src, req.pgf.File); ok && methodOK {
+ if _, ok, methodOK, _ := canExtractFunction(req.pgf.Tok, req.start, req.end, req.pgf.Src, req.pgf.Cursor); ok && methodOK {
req.addApplyFixAction("Extract method", fixExtractMethod, req.loc)
}
return nil
@@ -481,7 +478,7 @@ func refactorExtractMethod(ctx context.Context, req *codeActionsRequest) error {
// See [extractVariable] for command implementation.
func refactorExtractVariable(ctx context.Context, req *codeActionsRequest) error {
info := req.pkg.TypesInfo()
- if exprs, err := canExtractVariable(info, req.pgf.File, req.start, req.end, false); err == nil {
+ if exprs, err := canExtractVariable(info, req.pgf.Cursor, req.start, req.end, false); err == nil {
// Offer one of refactor.extract.{constant,variable}
// based on the constness of the expression; this is a
// limitation of the codeActionProducers mechanism.
@@ -507,7 +504,7 @@ func refactorExtractVariableAll(ctx context.Context, req *codeActionsRequest) er
info := req.pkg.TypesInfo()
// Don't suggest if only one expr is found,
// otherwise it will duplicate with [refactorExtractVariable]
- if exprs, err := canExtractVariable(info, req.pgf.File, req.start, req.end, true); err == nil && len(exprs) > 1 {
+ if exprs, err := canExtractVariable(info, req.pgf.Cursor, req.start, req.end, true); err == nil && len(exprs) > 1 {
start, end, err := req.pgf.NodeOffsets(exprs[0])
if err != nil {
return err
@@ -664,7 +661,7 @@ func refactorRewriteChangeQuote(ctx context.Context, req *codeActionsRequest) er
// refactorRewriteInvertIf produces "Invert 'if' condition" code actions.
// See [invertIfCondition] for command implementation.
func refactorRewriteInvertIf(ctx context.Context, req *codeActionsRequest) error {
- if _, ok, _ := canInvertIfCondition(req.pgf.File, req.start, req.end); ok {
+ if _, ok, _ := canInvertIfCondition(req.pgf.Cursor, req.start, req.end); ok {
req.addApplyFixAction("Invert 'if' condition", fixInvertIfCondition, req.loc)
}
return nil
@@ -674,17 +671,116 @@ func refactorRewriteInvertIf(ctx context.Context, req *codeActionsRequest) error
// See [splitLines] for command implementation.
func refactorRewriteSplitLines(ctx context.Context, req *codeActionsRequest) error {
// TODO(adonovan): opt: don't set needPkg just for FileSet.
- if msg, ok, _ := canSplitLines(req.pgf.File, req.pkg.FileSet(), req.start, req.end); ok {
+ if msg, ok, _ := canSplitLines(req.pgf.Cursor, req.pkg.FileSet(), req.start, req.end); ok {
req.addApplyFixAction(msg, fixSplitLines, req.loc)
}
return nil
}
+func refactorRewriteEliminateDotImport(ctx context.Context, req *codeActionsRequest) error {
+ // Figure out if the request is placed over a dot import.
+ var importSpec *ast.ImportSpec
+ for _, imp := range req.pgf.File.Imports {
+ if posRangeContains(imp.Pos(), imp.End(), req.start, req.end) {
+ importSpec = imp
+ break
+ }
+ }
+ if importSpec == nil {
+ return nil
+ }
+ if importSpec.Name == nil || importSpec.Name.Name != "." {
+ return nil
+ }
+
+ // dotImported package path and its imported name after removing the dot.
+ imported := req.pkg.TypesInfo().PkgNameOf(importSpec).Imported()
+ newName := imported.Name()
+
+ rng, err := req.pgf.PosRange(importSpec.Name.Pos(), importSpec.Path.Pos())
+ if err != nil {
+ return err
+ }
+ // Delete the '.' part of the import.
+ edits := []protocol.TextEdit{{
+ Range: rng,
+ }}
+
+ fileScope, ok := req.pkg.TypesInfo().Scopes[req.pgf.File]
+ if !ok {
+ return nil
+ }
+
+ // Go through each use of the dot imported package, checking its scope for
+ // shadowing and calculating an edit to qualify the identifier.
+ var stack []ast.Node
+ ast.Inspect(req.pgf.File, func(n ast.Node) bool {
+ if n == nil {
+ stack = stack[:len(stack)-1] // pop
+ return false
+ }
+ stack = append(stack, n) // push
+
+ ident, ok := n.(*ast.Ident)
+ if !ok {
+ return true
+ }
+ // Only keep identifiers that use a symbol from the
+ // dot imported package.
+ use := req.pkg.TypesInfo().Uses[ident]
+ if use == nil || use.Pkg() == nil {
+ return true
+ }
+ if use.Pkg() != imported {
+ return true
+ }
+
+ // Only qualify unqualified identifiers (due to dot imports).
+ // All other references to a symbol imported from another package
+ // are nested within a select expression (pkg.Foo, v.Method, v.Field).
+ if is[*ast.SelectorExpr](stack[len(stack)-2]) {
+ return true
+ }
+
+ // Make sure that the package name will not be shadowed by something else in scope.
+ // If it is then we cannot offer this particular code action.
+ //
+ // TODO: If the object found in scope is the package imported without a
+ // dot, or some builtin not used in the file, the code action could be
+ // allowed to go through.
+ sc := fileScope.Innermost(ident.Pos())
+ if sc == nil {
+ return true
+ }
+ _, obj := sc.LookupParent(newName, ident.Pos())
+ if obj != nil {
+ return true
+ }
+
+ rng, err := req.pgf.PosRange(ident.Pos(), ident.Pos()) // sic, zero-width range before ident
+ if err != nil {
+ return true
+ }
+ edits = append(edits, protocol.TextEdit{
+ Range: rng,
+ NewText: newName + ".",
+ })
+
+ return true
+ })
+
+ req.addEditAction("Eliminate dot import", nil, protocol.DocumentChangeEdit(
+ req.fh,
+ edits,
+ ))
+ return nil
+}
+
// refactorRewriteJoinLines produces "Join ITEMS into one line" code actions.
// See [joinLines] for command implementation.
func refactorRewriteJoinLines(ctx context.Context, req *codeActionsRequest) error {
// TODO(adonovan): opt: don't set needPkg just for FileSet.
- if msg, ok, _ := canJoinLines(req.pgf.File, req.pkg.FileSet(), req.start, req.end); ok {
+ if msg, ok, _ := canJoinLines(req.pgf.Cursor, req.pkg.FileSet(), req.start, req.end); ok {
req.addApplyFixAction(msg, fixJoinLines, req.loc)
}
return nil
@@ -847,44 +943,66 @@ func goAssembly(ctx context.Context, req *codeActionsRequest) error {
// directly to (say) a lambda of interest.
// Perhaps we could scroll to STEXT for the innermost
// enclosing nested function?
- path, _ := astutil.PathEnclosingInterval(req.pgf.File, req.start, req.end)
- if len(path) >= 2 { // [... FuncDecl File]
- if decl, ok := path[len(path)-2].(*ast.FuncDecl); ok {
- if fn, ok := req.pkg.TypesInfo().Defs[decl.Name].(*types.Func); ok {
- sig := fn.Signature()
-
- // Compute the linker symbol of the enclosing function.
- var sym strings.Builder
- if fn.Pkg().Name() == "main" {
- sym.WriteString("main")
- } else {
- sym.WriteString(fn.Pkg().Path())
- }
- sym.WriteString(".")
- if sig.Recv() != nil {
- if isPtr, named := typesinternal.ReceiverNamed(sig.Recv()); named != nil {
- if isPtr {
- fmt.Fprintf(&sym, "(*%s)", named.Obj().Name())
- } else {
- sym.WriteString(named.Obj().Name())
+
+ // Compute the linker symbol of the enclosing function or var initializer.
+ var sym strings.Builder
+ if pkg := req.pkg.Types(); pkg.Name() == "main" {
+ sym.WriteString("main")
+ } else {
+ sym.WriteString(pkg.Path())
+ }
+ sym.WriteString(".")
+
+ curSel, _ := req.pgf.Cursor.FindPos(req.start, req.end)
+ for cur := range curSel.Enclosing((*ast.FuncDecl)(nil), (*ast.ValueSpec)(nil)) {
+ var name string // in command title
+ switch node := cur.Node().(type) {
+ case *ast.FuncDecl:
+ // package-level func or method
+ if fn, ok := req.pkg.TypesInfo().Defs[node.Name].(*types.Func); ok &&
+ fn.Name() != "_" { // blank functions are not compiled
+
+ // Source-level init functions are compiled (along with
+ // package-level var initializers) in into a single pkg.init
+ // function, so this falls out of the logic below.
+
+ if sig := fn.Signature(); sig.TypeParams() == nil && sig.RecvTypeParams() == nil { // generic => no assembly
+ if sig.Recv() != nil {
+ if isPtr, named := typesinternal.ReceiverNamed(sig.Recv()); named != nil {
+ if isPtr {
+ fmt.Fprintf(&sym, "(*%s)", named.Obj().Name())
+ } else {
+ sym.WriteString(named.Obj().Name())
+ }
+ sym.WriteByte('.')
}
- sym.WriteByte('.')
}
+ sym.WriteString(fn.Name())
+
+ name = node.Name.Name // success
}
- sym.WriteString(fn.Name())
-
- if fn.Name() != "_" && // blank functions are not compiled
- (fn.Name() != "init" || sig.Recv() != nil) && // init functions aren't linker functions
- sig.TypeParams() == nil && sig.RecvTypeParams() == nil { // generic => no assembly
- cmd := command.NewAssemblyCommand(
- fmt.Sprintf("Browse %s assembly for %s", view.GOARCH(), decl.Name),
- view.ID(),
- string(req.pkg.Metadata().ID),
- sym.String())
- req.addCommandAction(cmd, false)
+ }
+
+ case *ast.ValueSpec:
+ // package-level var initializer?
+ if len(node.Names) > 0 && len(node.Values) > 0 {
+ v := req.pkg.TypesInfo().Defs[node.Names[0]]
+ if v != nil && typesinternal.IsPackageLevel(v) {
+ sym.WriteString("init")
+ name = "package initializer" // success
}
}
}
+
+ if name != "" {
+ cmd := command.NewAssemblyCommand(
+ fmt.Sprintf("Browse %s assembly for %s", view.GOARCH(), name),
+ view.ID(),
+ string(req.pkg.Metadata().ID),
+ sym.String())
+ req.addCommandAction(cmd, false)
+ break
+ }
}
return nil
}
diff --git a/gopls/internal/golang/compileropt.go b/gopls/internal/golang/compileropt.go
index f9f046463f6..bcce82c123f 100644
--- a/gopls/internal/golang/compileropt.go
+++ b/gopls/internal/golang/compileropt.go
@@ -16,6 +16,7 @@ import (
"golang.org/x/tools/gopls/internal/cache"
"golang.org/x/tools/gopls/internal/protocol"
+ "golang.org/x/tools/gopls/internal/settings"
"golang.org/x/tools/internal/event"
)
@@ -65,7 +66,7 @@ func CompilerOptDetails(ctx context.Context, snapshot *cache.Snapshot, pkgDir pr
reports := make(map[protocol.DocumentURI][]*cache.Diagnostic)
var parseError error
for _, fn := range files {
- uri, diagnostics, err := parseDetailsFile(fn)
+ uri, diagnostics, err := parseDetailsFile(fn, snapshot.Options())
if err != nil {
// expect errors for all the files, save 1
parseError = err
@@ -87,7 +88,7 @@ func CompilerOptDetails(ctx context.Context, snapshot *cache.Snapshot, pkgDir pr
}
// parseDetailsFile parses the file written by the Go compiler which contains a JSON-encoded protocol.Diagnostic.
-func parseDetailsFile(filename string) (protocol.DocumentURI, []*cache.Diagnostic, error) {
+func parseDetailsFile(filename string, options *settings.Options) (protocol.DocumentURI, []*cache.Diagnostic, error) {
buf, err := os.ReadFile(filename)
if err != nil {
return "", nil, err
@@ -118,30 +119,14 @@ func parseDetailsFile(filename string) (protocol.DocumentURI, []*cache.Diagnosti
if err := dec.Decode(d); err != nil {
return "", nil, err
}
- if d.Source != "go compiler" {
- continue
- }
d.Tags = []protocol.DiagnosticTag{} // must be an actual slice
msg := d.Code.(string)
if msg != "" {
- // Typical message prefixes gathered by grepping the source of
- // cmd/compile for literal arguments in calls to logopt.LogOpt.
- // (It is not a well defined set.)
- //
- // - canInlineFunction
- // - cannotInlineCall
- // - cannotInlineFunction
- // - copy
- // - escape
- // - escapes
- // - isInBounds
- // - isSliceInBounds
- // - iteration-variable-to-{heap,stack}
- // - leak
- // - loop-modified-{range,for}
- // - nilcheck
msg = fmt.Sprintf("%s(%s)", msg, d.Message)
}
+ if !showDiagnostic(msg, d.Source, options) {
+ continue
+ }
// zeroIndexedRange subtracts 1 from the line and
// range, because the compiler output neglects to
@@ -186,6 +171,51 @@ func parseDetailsFile(filename string) (protocol.DocumentURI, []*cache.Diagnosti
return uri, diagnostics, nil
}
+// showDiagnostic reports whether a given diagnostic should be shown to the end
+// user, given the current options.
+func showDiagnostic(msg, source string, o *settings.Options) bool {
+ if source != "go compiler" {
+ return false
+ }
+ if o.Annotations == nil {
+ return true
+ }
+
+ // The strings below were gathered by grepping the source of
+ // cmd/compile for literal arguments in calls to logopt.LogOpt.
+ // (It is not a well defined set.)
+ //
+ // - canInlineFunction
+ // - cannotInlineCall
+ // - cannotInlineFunction
+ // - escape
+ // - escapes
+ // - isInBounds
+ // - isSliceInBounds
+ // - leak
+ // - nilcheck
+ //
+ // Additional ones not handled by logic below:
+ // - copy
+ // - iteration-variable-to-{heap,stack}
+ // - loop-modified-{range,for}
+
+ switch {
+ case strings.HasPrefix(msg, "canInline") ||
+ strings.HasPrefix(msg, "cannotInline") ||
+ strings.HasPrefix(msg, "inlineCall"):
+ return o.Annotations[settings.Inline]
+ case strings.HasPrefix(msg, "escape") || msg == "leak":
+ return o.Annotations[settings.Escape]
+ case strings.HasPrefix(msg, "nilcheck"):
+ return o.Annotations[settings.Nil]
+ case strings.HasPrefix(msg, "isInBounds") ||
+ strings.HasPrefix(msg, "isSliceInBounds"):
+ return o.Annotations[settings.Bounds]
+ }
+ return false
+}
+
func findJSONFiles(dir string) ([]string, error) {
ans := []string{}
f := func(path string, fi os.FileInfo, _ error) error {
diff --git a/gopls/internal/golang/completion/completion.go b/gopls/internal/golang/completion/completion.go
index 4c340055233..a3270f97909 100644
--- a/gopls/internal/golang/completion/completion.go
+++ b/gopls/internal/golang/completion/completion.go
@@ -164,14 +164,14 @@ func (i *CompletionItem) addConversion(c *completer, conv conversionEdits) error
// Scoring constants are used for weighting the relevance of different candidates.
const (
+ // lowScore indicates an irrelevant or not useful completion item.
+ lowScore float64 = 0.01
+
// stdScore is the base score for all completion items.
stdScore float64 = 1.0
// highScore indicates a very relevant completion item.
highScore float64 = 10.0
-
- // lowScore indicates an irrelevant or not useful completion item.
- lowScore float64 = 0.01
)
// matcher matches a candidate's label against the user input. The
@@ -668,7 +668,7 @@ func Completion(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, p
err = c.collectCompletions(ctx)
if err != nil {
- return nil, nil, err
+ return nil, nil, fmt.Errorf("failed to collect completions: %v", err)
}
// Deep search collected candidates and their members for more candidates.
@@ -688,7 +688,7 @@ func Completion(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, p
for _, callback := range c.completionCallbacks {
if deadline == nil || time.Now().Before(*deadline) {
if err := c.snapshot.RunProcessEnvFunc(ctx, callback); err != nil {
- return nil, nil, err
+ return nil, nil, fmt.Errorf("failed to run goimports callback: %v", err)
}
}
}
@@ -702,7 +702,7 @@ func Completion(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, p
// depend on other candidates having already been collected.
c.addStatementCandidates()
- c.sortItems()
+ sortItems(c.items)
return c.items, c.getSurrounding(), nil
}
@@ -830,16 +830,16 @@ func (c *completer) scanToken(contents []byte) (token.Pos, token.Token, string)
}
}
-func (c *completer) sortItems() {
- sort.SliceStable(c.items, func(i, j int) bool {
+func sortItems(items []CompletionItem) {
+ sort.SliceStable(items, func(i, j int) bool {
// Sort by score first.
- if c.items[i].Score != c.items[j].Score {
- return c.items[i].Score > c.items[j].Score
+ if items[i].Score != items[j].Score {
+ return items[i].Score > items[j].Score
}
// Then sort by label so order stays consistent. This also has the
// effect of preferring shorter candidates.
- return c.items[i].Label < c.items[j].Label
+ return items[i].Label < items[j].Label
})
}
@@ -989,7 +989,10 @@ func (c *completer) populateImportCompletions(searchImport *ast.ImportSpec) erro
}
c.completionCallbacks = append(c.completionCallbacks, func(ctx context.Context, opts *imports.Options) error {
- return imports.GetImportPaths(ctx, searchImports, prefix, c.filename, c.pkg.Types().Name(), opts.Env)
+ if err := imports.GetImportPaths(ctx, searchImports, prefix, c.filename, c.pkg.Types().Name(), opts.Env); err != nil {
+ return fmt.Errorf("getting import paths: %v", err)
+ }
+ return nil
})
return nil
}
@@ -1174,7 +1177,10 @@ func isValidIdentifierChar(char byte) bool {
// adds struct fields, interface methods, function declaration fields to completion
func (c *completer) addFieldItems(fields *ast.FieldList) {
- if fields == nil {
+ // TODO: in golang/go#72828, we get here with a nil surrounding.
+ // This indicates a logic bug elsewhere: we should only be interrogating the
+ // surrounding if it is set.
+ if fields == nil || c.surrounding == nil {
return
}
@@ -1529,7 +1535,10 @@ func (c *completer) selector(ctx context.Context, sel *ast.SelectorExpr) error {
c.completionCallbacks = append(c.completionCallbacks, func(ctx context.Context, opts *imports.Options) error {
defer cancel()
- return imports.GetPackageExports(ctx, add, id.Name, c.filename, c.pkg.Types().Name(), opts.Env)
+ if err := imports.GetPackageExports(ctx, add, id.Name, c.filename, c.pkg.Types().Name(), opts.Env); err != nil {
+ return fmt.Errorf("getting package exports: %v", err)
+ }
+ return nil
})
return nil
}
@@ -1916,7 +1925,10 @@ func (c *completer) unimportedPackages(ctx context.Context, seen map[string]stru
}
c.completionCallbacks = append(c.completionCallbacks, func(ctx context.Context, opts *imports.Options) error {
- return imports.GetAllCandidates(ctx, add, prefix, c.filename, c.pkg.Types().Name(), opts.Env)
+ if err := imports.GetAllCandidates(ctx, add, prefix, c.filename, c.pkg.Types().Name(), opts.Env); err != nil {
+ return fmt.Errorf("getting completion candidates: %v", err)
+ }
+ return nil
})
return nil
@@ -1989,6 +2001,8 @@ func (c *completer) structLiteralFieldName(ctx context.Context) error {
// enclosingCompositeLiteral returns information about the composite literal enclosing the
// position.
+// It returns nil on failure; for example, if there is no type information for a
+// node on path.
func enclosingCompositeLiteral(path []ast.Node, pos token.Pos, info *types.Info) *compLitInfo {
for _, n := range path {
switch n := n.(type) {
@@ -2553,7 +2567,7 @@ func inferExpectedResultTypes(c *completer, callNodeIdx int) []types.Type {
switch node := c.path[callNodeIdx+1].(type) {
case *ast.KeyValueExpr:
enclosingCompositeLiteral := enclosingCompositeLiteral(c.path[callNodeIdx:], callNode.Pos(), c.pkg.TypesInfo())
- if !wantStructFieldCompletions(enclosingCompositeLiteral) {
+ if enclosingCompositeLiteral != nil && !wantStructFieldCompletions(enclosingCompositeLiteral) {
expectedResults = append(expectedResults, expectedCompositeLiteralType(enclosingCompositeLiteral, callNode.Pos()))
}
case *ast.AssignStmt:
diff --git a/gopls/internal/golang/completion/newfile.go b/gopls/internal/golang/completion/newfile.go
new file mode 100644
index 00000000000..d9869a2f050
--- /dev/null
+++ b/gopls/internal/golang/completion/newfile.go
@@ -0,0 +1,65 @@
+// Copyright 2025 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 completion
+
+import (
+ "bytes"
+ "context"
+ "fmt"
+
+ "golang.org/x/tools/gopls/internal/cache"
+ "golang.org/x/tools/gopls/internal/cache/parsego"
+ "golang.org/x/tools/gopls/internal/file"
+ "golang.org/x/tools/gopls/internal/golang"
+ "golang.org/x/tools/gopls/internal/protocol"
+)
+
+// NewFile returns a document change to complete an empty go file.
+func NewFile(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle) (*protocol.DocumentChange, error) {
+ if bs, err := fh.Content(); err != nil || len(bs) != 0 {
+ return nil, err
+ }
+ meta, err := golang.NarrowestMetadataForFile(ctx, snapshot, fh.URI())
+ if err != nil {
+ return nil, err
+ }
+ var buf bytes.Buffer
+ // Copy the copyright header from the first existing file that has one.
+ for _, fileURI := range meta.GoFiles {
+ if fileURI == fh.URI() {
+ continue
+ }
+ fh, err := snapshot.ReadFile(ctx, fileURI)
+ if err != nil {
+ continue
+ }
+ pgf, err := snapshot.ParseGo(ctx, fh, parsego.Header)
+ if err != nil {
+ continue
+ }
+ if group := golang.CopyrightComment(pgf.File); group != nil {
+ start, end, err := pgf.NodeOffsets(group)
+ if err != nil {
+ continue
+ }
+ buf.Write(pgf.Src[start:end])
+ buf.WriteString("\n\n")
+ break
+ }
+ }
+
+ pkgName, err := bestPackage(ctx, snapshot, fh.URI())
+ if err != nil {
+ return nil, err
+ }
+
+ fmt.Fprintf(&buf, "package %s\n", pkgName)
+ change := protocol.DocumentChangeEdit(fh, []protocol.TextEdit{{
+ Range: protocol.Range{}, // insert at start of file
+ NewText: buf.String(),
+ }})
+
+ return &change, nil
+}
diff --git a/gopls/internal/golang/completion/package.go b/gopls/internal/golang/completion/package.go
index 5fd6c04144d..d1698ee6580 100644
--- a/gopls/internal/golang/completion/package.go
+++ b/gopls/internal/golang/completion/package.go
@@ -15,6 +15,7 @@ import (
"go/token"
"go/types"
"path/filepath"
+ "sort"
"strings"
"unicode"
@@ -27,6 +28,24 @@ import (
"golang.org/x/tools/gopls/internal/util/safetoken"
)
+// bestPackage offers the best package name for a package declaration when
+// one is not present in the given file.
+func bestPackage(ctx context.Context, snapshot *cache.Snapshot, uri protocol.DocumentURI) (string, error) {
+ suggestions, err := packageSuggestions(ctx, snapshot, uri, "")
+ if err != nil {
+ return "", err
+ }
+ // sort with the same way of sortItems.
+ sort.SliceStable(suggestions, func(i, j int) bool {
+ if suggestions[i].score != suggestions[j].score {
+ return suggestions[i].score > suggestions[j].score
+ }
+ return suggestions[i].name < suggestions[j].name
+ })
+
+ return suggestions[0].name, nil
+}
+
// packageClauseCompletions offers completions for a package declaration when
// one is not present in the given file.
func packageClauseCompletions(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, position protocol.Position) ([]CompletionItem, *Selection, error) {
@@ -62,7 +81,7 @@ func packageClauseCompletions(ctx context.Context, snapshot *cache.Snapshot, fh
Score: pkg.score,
})
}
-
+ sortItems(items)
return items, surrounding, nil
}
@@ -197,11 +216,20 @@ func packageSuggestions(ctx context.Context, snapshot *cache.Snapshot, fileURI p
}
matcher := fuzzy.NewMatcher(prefix)
+ var currentPackageName string
+ if variants, err := snapshot.MetadataForFile(ctx, fileURI); err == nil &&
+ len(variants) != 0 {
+ currentPackageName = string(variants[0].Name)
+ }
// Always try to suggest a main package
defer func() {
+ mainScore := lowScore
+ if currentPackageName == "main" {
+ mainScore = highScore
+ }
if score := float64(matcher.Score("main")); score > 0 {
- packages = append(packages, toCandidate("main", score*lowScore))
+ packages = append(packages, toCandidate("main", score*mainScore))
}
}()
@@ -254,15 +282,20 @@ func packageSuggestions(ctx context.Context, snapshot *cache.Snapshot, fileURI p
seenPkgs[testPkgName] = struct{}{}
}
- // Add current directory name as a low relevance suggestion.
if _, ok := seenPkgs[pkgName]; !ok {
+ // Add current directory name as a low relevance suggestion.
+ dirNameScore := lowScore
+ // if current package name is empty, the dir name is the best choice.
+ if currentPackageName == "" {
+ dirNameScore = highScore
+ }
if score := float64(matcher.Score(string(pkgName))); score > 0 {
- packages = append(packages, toCandidate(string(pkgName), score*lowScore))
+ packages = append(packages, toCandidate(string(pkgName), score*dirNameScore))
}
testPkgName := pkgName + "_test"
if score := float64(matcher.Score(string(testPkgName))); score > 0 {
- packages = append(packages, toCandidate(string(testPkgName), score*lowScore))
+ packages = append(packages, toCandidate(string(testPkgName), score*dirNameScore))
}
}
diff --git a/gopls/internal/golang/completion/util.go b/gopls/internal/golang/completion/util.go
index 7a4729413ae..306078296c1 100644
--- a/gopls/internal/golang/completion/util.go
+++ b/gopls/internal/golang/completion/util.go
@@ -171,7 +171,7 @@ func deslice(T types.Type) types.Type {
return nil
}
-// isSelector returns the enclosing *ast.SelectorExpr when pos is in the
+// enclosingSelector returns the enclosing *ast.SelectorExpr when pos is in the
// selector.
func enclosingSelector(path []ast.Node, pos token.Pos) *ast.SelectorExpr {
if len(path) == 0 {
diff --git a/gopls/internal/golang/extract.go b/gopls/internal/golang/extract.go
index 2ce89795a06..f73e772e676 100644
--- a/gopls/internal/golang/extract.go
+++ b/gopls/internal/golang/extract.go
@@ -20,21 +20,24 @@ import (
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/ast/astutil"
+ "golang.org/x/tools/gopls/internal/cache"
+ "golang.org/x/tools/gopls/internal/cache/parsego"
goplsastutil "golang.org/x/tools/gopls/internal/util/astutil"
"golang.org/x/tools/gopls/internal/util/bug"
"golang.org/x/tools/gopls/internal/util/safetoken"
"golang.org/x/tools/internal/analysisinternal"
+ "golang.org/x/tools/internal/astutil/cursor"
"golang.org/x/tools/internal/typesinternal"
)
// extractVariable implements the refactor.extract.{variable,constant} CodeAction command.
-func extractVariable(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, _ *types.Package, info *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
- return extractExprs(fset, start, end, src, file, info, false)
+func extractVariable(pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
+ return extractExprs(pkg, pgf, start, end, false)
}
// extractVariableAll implements the refactor.extract.{variable,constant}-all CodeAction command.
-func extractVariableAll(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, _ *types.Package, info *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
- return extractExprs(fset, start, end, src, file, info, true)
+func extractVariableAll(pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
+ return extractExprs(pkg, pgf, start, end, true)
}
// extractExprs replaces occurrence(s) of a specified expression within the same function
@@ -43,9 +46,15 @@ func extractVariableAll(fset *token.FileSet, start, end token.Pos, src []byte, f
//
// The new variable/constant is declared as close as possible to the first found expression
// within the deepest common scope accessible to all candidate occurrences.
-func extractExprs(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, info *types.Info, all bool) (*token.FileSet, *analysis.SuggestedFix, error) {
+func extractExprs(pkg *cache.Package, pgf *parsego.File, start, end token.Pos, all bool) (*token.FileSet, *analysis.SuggestedFix, error) {
+ var (
+ fset = pkg.FileSet()
+ info = pkg.TypesInfo()
+ file = pgf.File
+ )
+ // TODO(adonovan): simplify, using Cursor.
tokFile := fset.File(file.FileStart)
- exprs, err := canExtractVariable(info, file, start, end, all)
+ exprs, err := canExtractVariable(info, pgf.Cursor, start, end, all)
if err != nil {
return nil, nil, fmt.Errorf("cannot extract: %v", err)
}
@@ -154,7 +163,7 @@ Outer:
return nil, nil, fmt.Errorf("cannot find location to insert extraction: %v", err)
}
// Within function: compute appropriate statement indentation.
- indent, err := calculateIndentation(src, tokFile, before)
+ indent, err := calculateIndentation(pgf.Src, tokFile, before)
if err != nil {
return nil, nil, err
}
@@ -375,16 +384,18 @@ func stmtToInsertVarBefore(path []ast.Node, variables []*variable) (ast.Stmt, er
}
return parent, nil
}
- return enclosingStmt.(ast.Stmt), nil
+ return enclosingStmt, nil
}
// canExtractVariable reports whether the code in the given range can be
// extracted to a variable (or constant). It returns the selected expression or, if 'all',
// all structurally equivalent expressions within the same function body, in lexical order.
-func canExtractVariable(info *types.Info, file *ast.File, start, end token.Pos, all bool) ([]ast.Expr, error) {
+func canExtractVariable(info *types.Info, curFile cursor.Cursor, start, end token.Pos, all bool) ([]ast.Expr, error) {
if start == end {
return nil, fmt.Errorf("empty selection")
}
+ file := curFile.Node().(*ast.File)
+ // TODO(adonovan): simplify, using Cursor.
path, exact := astutil.PathEnclosingInterval(file, start, end)
if !exact {
return nil, fmt.Errorf("selection is not an expression")
@@ -571,13 +582,13 @@ type returnVariable struct {
}
// extractMethod refactors the selected block of code into a new method.
-func extractMethod(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, pkg *types.Package, info *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
- return extractFunctionMethod(fset, start, end, src, file, pkg, info, true)
+func extractMethod(pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
+ return extractFunctionMethod(pkg, pgf, start, end, true)
}
// extractFunction refactors the selected block of code into a new function.
-func extractFunction(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, pkg *types.Package, info *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
- return extractFunctionMethod(fset, start, end, src, file, pkg, info, false)
+func extractFunction(pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
+ return extractFunctionMethod(pkg, pgf, start, end, false)
}
// extractFunctionMethod refactors the selected block of code into a new function/method.
@@ -588,17 +599,26 @@ func extractFunction(fset *token.FileSet, start, end token.Pos, src []byte, file
// and return values of the extracted function/method. Lastly, we construct the call
// of the function/method and insert this call as well as the extracted function/method into
// their proper locations.
-func extractFunctionMethod(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, pkg *types.Package, info *types.Info, isMethod bool) (*token.FileSet, *analysis.SuggestedFix, error) {
+func extractFunctionMethod(cpkg *cache.Package, pgf *parsego.File, start, end token.Pos, isMethod bool) (*token.FileSet, *analysis.SuggestedFix, error) {
+ var (
+ fset = cpkg.FileSet()
+ pkg = cpkg.Types()
+ info = cpkg.TypesInfo()
+ src = pgf.Src
+ )
+
errorPrefix := "extractFunction"
if isMethod {
errorPrefix = "extractMethod"
}
+ file := pgf.Cursor.Node().(*ast.File)
+ // TODO(adonovan): simplify, using Cursor.
tok := fset.File(file.FileStart)
if tok == nil {
return nil, nil, bug.Errorf("no file for position")
}
- p, ok, methodOk, err := canExtractFunction(tok, start, end, src, file)
+ p, ok, methodOk, err := canExtractFunction(tok, start, end, src, pgf.Cursor)
if (!ok && !isMethod) || (!methodOk && isMethod) {
return nil, nil, fmt.Errorf("%s: cannot extract %s: %v", errorPrefix,
safetoken.StartPosition(fset, start), err)
@@ -1086,7 +1106,10 @@ func moveParamToFrontIfFound(params []ast.Expr, paramTypes []*ast.Field, x, sel
// their cursors for whitespace. To support this use case, we must manually adjust the
// ranges to match the correct AST node. In this particular example, we would adjust
// rng.Start forward to the start of 'if' and rng.End backward to after '}'.
-func adjustRangeForCommentsAndWhiteSpace(tok *token.File, start, end token.Pos, content []byte, file *ast.File) (token.Pos, token.Pos, error) {
+func adjustRangeForCommentsAndWhiteSpace(tok *token.File, start, end token.Pos, content []byte, curFile cursor.Cursor) (token.Pos, token.Pos, error) {
+ file := curFile.Node().(*ast.File)
+ // TODO(adonovan): simplify, using Cursor.
+
// Adjust the end of the range to after leading whitespace and comments.
prevStart := token.NoPos
startComment := sort.Search(len(file.Comments), func(i int) bool {
@@ -1229,7 +1252,7 @@ func collectFreeVars(info *types.Info, file *ast.File, start, end token.Pos, nod
// return value acts as an indicator for where it was defined.
var sel func(n *ast.SelectorExpr) (types.Object, bool)
sel = func(n *ast.SelectorExpr) (types.Object, bool) {
- switch x := astutil.Unparen(n.X).(type) {
+ switch x := ast.Unparen(n.X).(type) {
case *ast.SelectorExpr:
return sel(x)
case *ast.Ident:
@@ -1410,12 +1433,14 @@ type fnExtractParams struct {
// canExtractFunction reports whether the code in the given range can be
// extracted to a function.
-func canExtractFunction(tok *token.File, start, end token.Pos, src []byte, file *ast.File) (*fnExtractParams, bool, bool, error) {
+func canExtractFunction(tok *token.File, start, end token.Pos, src []byte, curFile cursor.Cursor) (*fnExtractParams, bool, bool, error) {
if start == end {
return nil, false, false, fmt.Errorf("start and end are equal")
}
var err error
- start, end, err = adjustRangeForCommentsAndWhiteSpace(tok, start, end, src, file)
+ file := curFile.Node().(*ast.File)
+ // TODO(adonovan): simplify, using Cursor.
+ start, end, err = adjustRangeForCommentsAndWhiteSpace(tok, start, end, src, curFile)
if err != nil {
return nil, false, false, err
}
diff --git a/gopls/internal/golang/extracttofile.go b/gopls/internal/golang/extracttofile.go
index 39fb28e624b..d3026d4ee0f 100644
--- a/gopls/internal/golang/extracttofile.go
+++ b/gopls/internal/golang/extracttofile.go
@@ -138,7 +138,7 @@ func ExtractToNewFile(ctx context.Context, snapshot *cache.Snapshot, fh file.Han
}
var buf bytes.Buffer
- if c := copyrightComment(pgf.File); c != nil {
+ if c := CopyrightComment(pgf.File); c != nil {
start, end, err := pgf.NodeOffsets(c)
if err != nil {
return nil, err
diff --git a/gopls/internal/golang/fix.go b/gopls/internal/golang/fix.go
index e812c677541..dbd83ef071f 100644
--- a/gopls/internal/golang/fix.go
+++ b/gopls/internal/golang/fix.go
@@ -7,9 +7,7 @@ package golang
import (
"context"
"fmt"
- "go/ast"
"go/token"
- "go/types"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/gopls/internal/analysis/embeddirective"
@@ -41,18 +39,14 @@ import (
// A fixer may return (nil, nil) if no fix is available.
type fixer func(ctx context.Context, s *cache.Snapshot, pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error)
-// A singleFileFixer is a Fixer that inspects only a single file,
-// and does not depend on data types from the cache package.
-//
-// TODO(adonovan): move fillstruct and undeclaredname into this
-// package, so we can remove the import restriction and push
-// the singleFile wrapper down into each singleFileFixer?
-type singleFileFixer func(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, pkg *types.Package, info *types.Info) (*token.FileSet, *analysis.SuggestedFix, error)
+// A singleFileFixer is a [fixer] that inspects only a single file.
+type singleFileFixer func(pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error)
-// singleFile adapts a single-file fixer to a Fixer.
+// singleFile adapts a [singleFileFixer] to a [fixer]
+// by discarding the snapshot and the context it needs.
func singleFile(fixer1 singleFileFixer) fixer {
- return func(ctx context.Context, snapshot *cache.Snapshot, pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
- return fixer1(pkg.FileSet(), start, end, pgf.Src, pgf.File, pkg.Types(), pkg.TypesInfo())
+ return func(_ context.Context, _ *cache.Snapshot, pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
+ return fixer1(pkg, pgf, start, end)
}
}
diff --git a/gopls/internal/golang/folding_range.go b/gopls/internal/golang/folding_range.go
index 9d80cc8de29..eed31e92944 100644
--- a/gopls/internal/golang/folding_range.go
+++ b/gopls/internal/golang/folding_range.go
@@ -6,6 +6,7 @@ package golang
import (
"bytes"
+ "cmp"
"context"
"go/ast"
"go/token"
@@ -20,14 +21,8 @@ import (
"golang.org/x/tools/gopls/internal/util/safetoken"
)
-// FoldingRangeInfo holds range and kind info of folding for an ast.Node
-type FoldingRangeInfo struct {
- Range protocol.Range
- Kind protocol.FoldingRangeKind
-}
-
// FoldingRange gets all of the folding range for f.
-func FoldingRange(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, lineFoldingOnly bool) (ranges []*FoldingRangeInfo, err error) {
+func FoldingRange(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, lineFoldingOnly bool) ([]protocol.FoldingRange, error) {
// TODO(suzmue): consider limiting the number of folding ranges returned, and
// implement a way to prioritize folding ranges in that case.
pgf, err := snapshot.ParseGo(ctx, fh, parsego.Full)
@@ -48,86 +43,97 @@ func FoldingRange(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle,
}
// Get folding ranges for comments separately as they are not walked by ast.Inspect.
- ranges = append(ranges, commentsFoldingRange(pgf)...)
+ ranges := commentsFoldingRange(pgf)
- visit := func(n ast.Node) bool {
- rng := foldingRangeFunc(pgf, n, lineFoldingOnly)
- if rng != nil {
- ranges = append(ranges, rng)
- }
- return true
- }
// Walk the ast and collect folding ranges.
- ast.Inspect(pgf.File, visit)
-
- slices.SortFunc(ranges, func(x, y *FoldingRangeInfo) int {
- return protocol.CompareRange(x.Range, y.Range)
- })
-
- return ranges, nil
-}
+ filter := []ast.Node{
+ (*ast.BasicLit)(nil),
+ (*ast.BlockStmt)(nil),
+ (*ast.CallExpr)(nil),
+ (*ast.CaseClause)(nil),
+ (*ast.CommClause)(nil),
+ (*ast.CompositeLit)(nil),
+ (*ast.FieldList)(nil),
+ (*ast.GenDecl)(nil),
+ }
+ for cur := range pgf.Cursor.Preorder(filter...) {
+ // TODO(suzmue): include trailing empty lines before the closing
+ // parenthesis/brace.
+ var kind protocol.FoldingRangeKind
+ // start and end define the range of content to fold away.
+ var start, end token.Pos
+ switch n := cur.Node().(type) {
+ case *ast.BlockStmt:
+ // Fold between positions of or lines between "{" and "}".
+ start, end = getLineFoldingRange(pgf, n.Lbrace, n.Rbrace, lineFoldingOnly)
+
+ case *ast.CaseClause:
+ // Fold from position of ":" to end.
+ start, end = n.Colon+1, n.End()
+
+ case *ast.CommClause:
+ // Fold from position of ":" to end.
+ start, end = n.Colon+1, n.End()
+
+ case *ast.CallExpr:
+ // Fold between positions of or lines between "(" and ")".
+ start, end = getLineFoldingRange(pgf, n.Lparen, n.Rparen, lineFoldingOnly)
+
+ case *ast.FieldList:
+ // Fold between positions of or lines between opening parenthesis/brace and closing parenthesis/brace.
+ start, end = getLineFoldingRange(pgf, n.Opening, n.Closing, lineFoldingOnly)
+
+ case *ast.GenDecl:
+ // If this is an import declaration, set the kind to be protocol.Imports.
+ if n.Tok == token.IMPORT {
+ kind = protocol.Imports
+ }
+ // Fold between positions of or lines between "(" and ")".
+ start, end = getLineFoldingRange(pgf, n.Lparen, n.Rparen, lineFoldingOnly)
+
+ case *ast.BasicLit:
+ // Fold raw string literals from position of "`" to position of "`".
+ if n.Kind == token.STRING && len(n.Value) >= 2 && n.Value[0] == '`' && n.Value[len(n.Value)-1] == '`' {
+ start, end = n.Pos(), n.End()
+ }
+
+ case *ast.CompositeLit:
+ // Fold between positions of or lines between "{" and "}".
+ start, end = getLineFoldingRange(pgf, n.Lbrace, n.Rbrace, lineFoldingOnly)
+
+ default:
+ panic(n)
+ }
-// foldingRangeFunc calculates the line folding range for ast.Node n
-func foldingRangeFunc(pgf *parsego.File, n ast.Node, lineFoldingOnly bool) *FoldingRangeInfo {
- // TODO(suzmue): include trailing empty lines before the closing
- // parenthesis/brace.
- var kind protocol.FoldingRangeKind
- // start and end define the range of content to fold away.
- var start, end token.Pos
- switch n := n.(type) {
- case *ast.BlockStmt:
- // Fold between positions of or lines between "{" and "}".
- start, end = getLineFoldingRange(pgf, n.Lbrace, n.Rbrace, lineFoldingOnly)
- case *ast.CaseClause:
- // Fold from position of ":" to end.
- start, end = n.Colon+1, n.End()
- case *ast.CommClause:
- // Fold from position of ":" to end.
- start, end = n.Colon+1, n.End()
- case *ast.CallExpr:
- // Fold between positions of or lines between "(" and ")".
- start, end = getLineFoldingRange(pgf, n.Lparen, n.Rparen, lineFoldingOnly)
- case *ast.FieldList:
- // Fold between positions of or lines between opening parenthesis/brace and closing parenthesis/brace.
- start, end = getLineFoldingRange(pgf, n.Opening, n.Closing, lineFoldingOnly)
- case *ast.GenDecl:
- // If this is an import declaration, set the kind to be protocol.Imports.
- if n.Tok == token.IMPORT {
- kind = protocol.Imports
+ // Check that folding positions are valid.
+ if !start.IsValid() || !end.IsValid() {
+ continue
+ }
+ if start == end {
+ // Nothing to fold.
+ continue
+ }
+ // in line folding mode, do not fold if the start and end lines are the same.
+ if lineFoldingOnly && safetoken.Line(pgf.Tok, start) == safetoken.Line(pgf.Tok, end) {
+ continue
}
- // Fold between positions of or lines between "(" and ")".
- start, end = getLineFoldingRange(pgf, n.Lparen, n.Rparen, lineFoldingOnly)
- case *ast.BasicLit:
- // Fold raw string literals from position of "`" to position of "`".
- if n.Kind == token.STRING && len(n.Value) >= 2 && n.Value[0] == '`' && n.Value[len(n.Value)-1] == '`' {
- start, end = n.Pos(), n.End()
+ rng, err := pgf.PosRange(start, end)
+ if err != nil {
+ bug.Reportf("failed to create range: %s", err) // can't happen
+ continue
}
- case *ast.CompositeLit:
- // Fold between positions of or lines between "{" and "}".
- start, end = getLineFoldingRange(pgf, n.Lbrace, n.Rbrace, lineFoldingOnly)
+ ranges = append(ranges, foldingRange(kind, rng))
}
- // Check that folding positions are valid.
- if !start.IsValid() || !end.IsValid() {
- return nil
- }
- if start == end {
- // Nothing to fold.
- return nil
- }
- // in line folding mode, do not fold if the start and end lines are the same.
- if lineFoldingOnly && safetoken.Line(pgf.Tok, start) == safetoken.Line(pgf.Tok, end) {
- return nil
- }
- rng, err := pgf.PosRange(start, end)
- if err != nil {
- bug.Reportf("failed to create range: %s", err) // can't happen
- return nil
- }
- return &FoldingRangeInfo{
- Range: rng,
- Kind: kind,
- }
+ // Sort by start position.
+ slices.SortFunc(ranges, func(x, y protocol.FoldingRange) int {
+ if d := cmp.Compare(x.StartLine, y.StartLine); d != 0 {
+ return d
+ }
+ return cmp.Compare(x.StartCharacter, y.StartCharacter)
+ })
+
+ return ranges, nil
}
// getLineFoldingRange returns the folding range for nodes with parentheses/braces/brackets
@@ -196,7 +202,7 @@ func getLineFoldingRange(pgf *parsego.File, open, close token.Pos, lineFoldingOn
// commentsFoldingRange returns the folding ranges for all comment blocks in file.
// The folding range starts at the end of the first line of the comment block, and ends at the end of the
// comment block and has kind protocol.Comment.
-func commentsFoldingRange(pgf *parsego.File) (comments []*FoldingRangeInfo) {
+func commentsFoldingRange(pgf *parsego.File) (comments []protocol.FoldingRange) {
tokFile := pgf.Tok
for _, commentGrp := range pgf.File.Comments {
startGrpLine, endGrpLine := safetoken.Line(tokFile, commentGrp.Pos()), safetoken.Line(tokFile, commentGrp.End())
@@ -218,11 +224,19 @@ func commentsFoldingRange(pgf *parsego.File) (comments []*FoldingRangeInfo) {
bug.Reportf("failed to create mapped range: %s", err) // can't happen
continue
}
- comments = append(comments, &FoldingRangeInfo{
- // Fold from the end of the first line comment to the end of the comment block.
- Range: rng,
- Kind: protocol.Comment,
- })
+ // Fold from the end of the first line comment to the end of the comment block.
+ comments = append(comments, foldingRange(protocol.Comment, rng))
}
return comments
}
+
+func foldingRange(kind protocol.FoldingRangeKind, rng protocol.Range) protocol.FoldingRange {
+ return protocol.FoldingRange{
+ // I have no idea why LSP doesn't use a protocol.Range here.
+ StartLine: rng.Start.Line,
+ StartCharacter: rng.Start.Character,
+ EndLine: rng.End.Line,
+ EndCharacter: rng.End.Character,
+ Kind: string(kind),
+ }
+}
diff --git a/gopls/internal/golang/format.go b/gopls/internal/golang/format.go
index de4ec3a642c..ded00deef38 100644
--- a/gopls/internal/golang/format.go
+++ b/gopls/internal/golang/format.go
@@ -35,15 +35,16 @@ func Format(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle) ([]pr
ctx, done := event.Start(ctx, "golang.Format")
defer done()
- // Generated files shouldn't be edited. So, don't format them
- if IsGenerated(ctx, snapshot, fh.URI()) {
- return nil, fmt.Errorf("can't format %q: file is generated", fh.URI().Path())
- }
-
pgf, err := snapshot.ParseGo(ctx, fh, parsego.Full)
if err != nil {
return nil, err
}
+
+ // Generated files shouldn't be edited. So, don't format them.
+ if ast.IsGenerated(pgf.File) {
+ return nil, fmt.Errorf("can't format %q: file is generated", fh.URI().Path())
+ }
+
// Even if this file has parse errors, it might still be possible to format it.
// Using format.Node on an AST with errors may result in code being modified.
// Attempt to format the source of this file instead.
@@ -137,7 +138,13 @@ func computeImportEdits(ctx context.Context, pgf *parsego.File, snapshot *cache.
// Build up basic information about the original file.
isource, err := imports.NewProcessEnvSource(options.Env, filename, pgf.File.Name.Name)
+ if err != nil {
+ return nil, nil, err
+ }
var source imports.Source
+
+ // Keep this in sync with [cache.Session.createView] (see the TODO there: we
+ // should factor out the handling of the ImportsSource setting).
switch snapshot.Options().ImportsSource {
case settings.ImportsSourceGopls:
source = snapshot.NewGoplsSource(isource)
@@ -146,6 +153,9 @@ func computeImportEdits(ctx context.Context, pgf *parsego.File, snapshot *cache.
case settings.ImportsSourceGoimports:
source = isource
}
+ // imports require a current metadata graph
+ // TODO(rfindlay) improve the API
+ snapshot.WorkspaceMetadata(ctx)
allFixes, err := imports.FixImports(ctx, filename, pgf.Src, goroot, options.Env.Logf, source)
if err != nil {
return nil, nil, err
diff --git a/gopls/internal/golang/freesymbols.go b/gopls/internal/golang/freesymbols.go
index 2c9e25165f6..336025367f5 100644
--- a/gopls/internal/golang/freesymbols.go
+++ b/gopls/internal/golang/freesymbols.go
@@ -342,7 +342,7 @@ func freeRefs(pkg *types.Package, info *types.Info, file *ast.File, start, end t
for {
suffix = append(suffix, info.Uses[sel.Sel])
- switch x := astutil.Unparen(sel.X).(type) {
+ switch x := ast.Unparen(sel.X).(type) {
case *ast.Ident:
return id(x, suffix)
default:
diff --git a/gopls/internal/golang/hover.go b/gopls/internal/golang/hover.go
index 7fc584f2c1a..c3fecd1c9d1 100644
--- a/gopls/internal/golang/hover.go
+++ b/gopls/internal/golang/hover.go
@@ -7,6 +7,7 @@ package golang
import (
"bytes"
"context"
+ "encoding/json"
"fmt"
"go/ast"
"go/constant"
@@ -48,37 +49,47 @@ import (
// It is formatted in one of several formats as determined by the
// HoverKind setting.
type hoverResult struct {
- // synopsis is a single sentence synopsis of the symbol's documentation.
+ // The fields below are exported to define the JSON hover format.
+ // TODO(golang/go#70233): (re)remove support for JSON hover.
+
+ // Synopsis is a single sentence Synopsis of the symbol's documentation.
//
- // TODO(adonovan): in what syntax? It (usually) comes from doc.synopsis,
+ // TODO(adonovan): in what syntax? It (usually) comes from doc.Synopsis,
// which produces "Text" form, but it may be fed to
// DocCommentToMarkdown, which expects doc comment syntax.
- synopsis string
+ Synopsis string `json:"synopsis"`
- // fullDocumentation is the symbol's full documentation.
- fullDocumentation string
+ // FullDocumentation is the symbol's full documentation.
+ FullDocumentation string `json:"fullDocumentation"`
- // signature is the symbol's signature.
- signature string
+ // Signature is the symbol's Signature.
+ Signature string `json:"signature"`
- // singleLine is a single line describing the symbol.
+ // SingleLine is a single line describing the symbol.
// This is recommended only for use in clients that show a single line for hover.
- singleLine string
+ SingleLine string `json:"singleLine"`
- // symbolName is the human-readable name to use for the symbol in links.
- symbolName string
+ // SymbolName is the human-readable name to use for the symbol in links.
+ SymbolName string `json:"symbolName"`
- // linkPath is the path of the package enclosing the given symbol,
+ // LinkPath is the path of the package enclosing the given symbol,
// with the module portion (if any) replaced by "module@version".
//
// For example: "github.com/google/go-github/v48@v48.1.0/github".
//
- // Use LinkTarget + "/" + linkPath + "#" + LinkAnchor to form a pkgsite URL.
- linkPath string
+ // Use LinkTarget + "/" + LinkPath + "#" + LinkAnchor to form a pkgsite URL.
+ LinkPath string `json:"linkPath"`
- // linkAnchor is the pkg.go.dev link anchor for the given symbol.
+ // LinkAnchor is the pkg.go.dev link anchor for the given symbol.
// For example, the "Node" part of "pkg.go.dev/go/ast#Node".
- linkAnchor string
+ LinkAnchor string `json:"linkAnchor"`
+
+ // New fields go below, and are unexported. The existing
+ // exported fields are underspecified and have already
+ // constrained our movements too much. A detailed JSON
+ // interface might be nice, but it needs a design and a
+ // precise specification.
+ // TODO(golang/go#70233): (re)deprecate the JSON hover output.
// typeDecl is the declaration syntax for a type,
// or "" for a non-type.
@@ -127,6 +138,28 @@ func Hover(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, positi
}, nil
}
+// findRhsTypeDecl finds an alias's rhs type and returns its declaration.
+// The rhs of an alias might be an alias as well, but we feel this is a rare case.
+// It returns an empty string if the given obj is not an alias.
+func findRhsTypeDecl(ctx context.Context, snapshot *cache.Snapshot, pkg *cache.Package, obj types.Object) (string, error) {
+ if alias, ok := obj.Type().(*types.Alias); ok {
+ // we choose Rhs instead of types.Unalias to make the connection between original alias
+ // and the corresponding aliased type clearer.
+ // types.Unalias brings confusion because it breaks the connection from A to C given
+ // the alias chain like 'type ( A = B; B =C ; )' except we show all transitive alias
+ // from start to the end. As it's rare, we don't do so.
+ t := alias.Rhs()
+ switch o := t.(type) {
+ case *types.Named:
+ obj = o.Obj()
+ declPGF1, declPos1, _ := parseFull(ctx, snapshot, pkg.FileSet(), obj.Pos())
+ realTypeDecl, _, err := typeDeclContent(declPGF1, declPos1, obj)
+ return realTypeDecl, err
+ }
+ }
+ return "", nil
+}
+
// hover computes hover information at the given position. If we do not support
// hovering at the position, it returns _, nil, nil: an error is only returned
// if the position is valid but we fail to compute hover information.
@@ -284,9 +317,9 @@ func hover(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, pp pro
typesinternal.SetVarKind(v, typesinternal.LocalVar)
signature := types.ObjectString(v, qual)
return *hoverRange, &hoverResult{
- signature: signature,
- singleLine: signature,
- symbolName: v.Name(),
+ Signature: signature,
+ SingleLine: signature,
+ SymbolName: v.Name(),
}, nil
}
@@ -342,15 +375,10 @@ func hover(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, pp pro
// use the default build config for all other types, even
// if they embed platform-variant types.
//
- var sizeOffset string // optional size/offset description
- // debugging #69362: unexpected nil Defs[ident] value (?)
- _ = ident.Pos() // (can't be nil due to check after referencedObject)
- _ = pkg.TypesInfo() // (can't be nil due to check in call to inferredSignature)
- _ = pkg.TypesInfo().Defs // (can't be nil due to nature of cache.Package)
- if def, ok := pkg.TypesInfo().Defs[ident]; ok {
- _ = def.Pos() // can't be nil due to reasoning in #69362.
- }
- if def, ok := pkg.TypesInfo().Defs[ident]; ok && ident.Pos() == def.Pos() {
+ var sizeOffset string
+
+ // As painfully learned in golang/go#69362, Defs can contain nil entries.
+ if def, _ := pkg.TypesInfo().Defs[ident]; def != nil && ident.Pos() == def.Pos() {
// This is the declaring identifier.
// (We can't simply use ident.Pos() == obj.Pos() because
// referencedObject prefers the TypeName for an embedded field).
@@ -393,46 +421,20 @@ func hover(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, pp pro
_, isTypeName := obj.(*types.TypeName)
_, isTypeParam := types.Unalias(obj.Type()).(*types.TypeParam)
if isTypeName && !isTypeParam {
- spec, ok := spec.(*ast.TypeSpec)
- if !ok {
- // We cannot find a TypeSpec for this type or alias declaration
- // (that is not a type parameter or a built-in).
- // This should be impossible even for ill-formed trees;
- // we suspect that AST repair may be creating inconsistent
- // positions. Don't report a bug in that case. (#64241)
- errorf := fmt.Errorf
- if !declPGF.Fixed() {
- errorf = bug.Errorf
- }
- return protocol.Range{}, nil, errorf("type name %q without type spec", obj.Name())
+ var spec1 *ast.TypeSpec
+ typeDecl, spec1, err = typeDeclContent(declPGF, declPos, obj)
+ if err != nil {
+ return protocol.Range{}, nil, err
}
- // Format the type's declaration syntax.
- {
- // Don't duplicate comments.
- spec2 := *spec
- spec2.Doc = nil
- spec2.Comment = nil
-
- var b strings.Builder
- b.WriteString("type ")
- fset := tokeninternal.FileSetFor(declPGF.Tok)
- // TODO(adonovan): use a smarter formatter that omits
- // inaccessible fields (non-exported ones from other packages).
- if err := format.Node(&b, fset, &spec2); err != nil {
- return protocol.Range{}, nil, err
- }
- typeDecl = b.String()
-
- // Splice in size/offset at end of first line.
- // "type T struct { // size=..."
- if sizeOffset != "" {
- nl := strings.IndexByte(typeDecl, '\n')
- if nl < 0 {
- nl = len(typeDecl)
- }
- typeDecl = typeDecl[:nl] + " // " + sizeOffset + typeDecl[nl:]
+ // Splice in size/offset at end of first line.
+ // "type T struct { // size=..."
+ if sizeOffset != "" {
+ nl := strings.IndexByte(typeDecl, '\n')
+ if nl < 0 {
+ nl = len(typeDecl)
}
+ typeDecl = typeDecl[:nl] + " // " + sizeOffset + typeDecl[nl:]
}
// Promoted fields
@@ -467,7 +469,7 @@ func hover(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, pp pro
// already been displayed when the node was formatted
// above. Don't list these again.
var skip map[string]bool
- if iface, ok := spec.Type.(*ast.InterfaceType); ok {
+ if iface, ok := spec1.Type.(*ast.InterfaceType); ok {
if iface.Methods.List != nil {
for _, m := range iface.Methods.List {
if len(m.Names) == 1 {
@@ -509,6 +511,12 @@ func hover(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, pp pro
}
}
+ // realTypeDecl is defined to store the underlying definition of an alias.
+ realTypeDecl, _ := findRhsTypeDecl(ctx, snapshot, pkg, obj) // tolerate the error
+ if realTypeDecl != "" {
+ typeDecl += fmt.Sprintf("\n\n%s", realTypeDecl)
+ }
+
// Compute link data (on pkg.go.dev or other documentation host).
//
// If linkPath is empty, the symbol is not linkable.
@@ -615,13 +623,13 @@ func hover(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, pp pro
}
return *hoverRange, &hoverResult{
- synopsis: doc.Synopsis(docText),
- fullDocumentation: docText,
- singleLine: singleLineSignature,
- symbolName: linkName,
- signature: signature,
- linkPath: linkPath,
- linkAnchor: anchor,
+ Synopsis: doc.Synopsis(docText),
+ FullDocumentation: docText,
+ SingleLine: singleLineSignature,
+ SymbolName: linkName,
+ Signature: signature,
+ LinkPath: linkPath,
+ LinkAnchor: anchor,
typeDecl: typeDecl,
methods: methods,
promotedFields: fields,
@@ -629,6 +637,39 @@ func hover(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, pp pro
}, nil
}
+// typeDeclContent returns a well formatted type definition.
+func typeDeclContent(declPGF *parsego.File, declPos token.Pos, obj types.Object) (string, *ast.TypeSpec, error) {
+ _, spec, _ := findDeclInfo([]*ast.File{declPGF.File}, declPos) // may be nil^3
+ // Don't duplicate comments.
+ spec1, ok := spec.(*ast.TypeSpec)
+ if !ok {
+ // We cannot find a TypeSpec for this type or alias declaration
+ // (that is not a type parameter or a built-in).
+ // This should be impossible even for ill-formed trees;
+ // we suspect that AST repair may be creating inconsistent
+ // positions. Don't report a bug in that case. (#64241)
+ errorf := fmt.Errorf
+ if !declPGF.Fixed() {
+ errorf = bug.Errorf
+ }
+ return "", nil, errorf("type name %q without type spec", obj.Name())
+ }
+ spec2 := *spec1
+ spec2.Doc = nil
+ spec2.Comment = nil
+
+ var b strings.Builder
+ b.WriteString("type ")
+ fset := tokeninternal.FileSetFor(declPGF.Tok)
+ // TODO(adonovan): use a smarter formatter that omits
+ // inaccessible fields (non-exported ones from other packages).
+ if err := format.Node(&b, fset, &spec2); err != nil {
+ return "", nil, err
+ }
+ typeDecl := b.String()
+ return typeDecl, spec1, nil
+}
+
// hoverBuiltin computes hover information when hovering over a builtin
// identifier.
func hoverBuiltin(ctx context.Context, snapshot *cache.Snapshot, obj types.Object) (*hoverResult, error) {
@@ -638,8 +679,8 @@ func hoverBuiltin(ctx context.Context, snapshot *cache.Snapshot, obj types.Objec
if obj.Name() == "Error" {
signature := obj.String()
return &hoverResult{
- signature: signature,
- singleLine: signature,
+ Signature: signature,
+ SingleLine: signature,
// TODO(rfindley): these are better than the current behavior.
// SymbolName: "(error).Error",
// LinkPath: "builtin",
@@ -682,13 +723,13 @@ func hoverBuiltin(ctx context.Context, snapshot *cache.Snapshot, obj types.Objec
docText := comment.Text()
return &hoverResult{
- synopsis: doc.Synopsis(docText),
- fullDocumentation: docText,
- signature: signature,
- singleLine: obj.String(),
- symbolName: obj.Name(),
- linkPath: "builtin",
- linkAnchor: obj.Name(),
+ Synopsis: doc.Synopsis(docText),
+ FullDocumentation: docText,
+ Signature: signature,
+ SingleLine: obj.String(),
+ SymbolName: obj.Name(),
+ LinkPath: "builtin",
+ LinkAnchor: obj.Name(),
}, nil
}
@@ -740,9 +781,9 @@ func hoverImport(ctx context.Context, snapshot *cache.Snapshot, pkg *cache.Packa
docText := comment.Text()
return rng, &hoverResult{
- signature: "package " + string(impMetadata.Name),
- synopsis: doc.Synopsis(docText),
- fullDocumentation: docText,
+ Signature: "package " + string(impMetadata.Name),
+ Synopsis: doc.Synopsis(docText),
+ FullDocumentation: docText,
}, nil
}
@@ -798,9 +839,9 @@ func hoverPackageName(pkg *cache.Package, pgf *parsego.File) (protocol.Range, *h
}
return rng, &hoverResult{
- signature: "package " + string(pkg.Metadata().Name),
- synopsis: doc.Synopsis(docText),
- fullDocumentation: docText,
+ Signature: "package " + string(pkg.Metadata().Name),
+ Synopsis: doc.Synopsis(docText),
+ FullDocumentation: docText,
footer: footer,
}, nil
}
@@ -926,8 +967,8 @@ func hoverLit(pgf *parsego.File, lit *ast.BasicLit, pos token.Pos) (protocol.Ran
}
hover := b.String()
return rng, &hoverResult{
- synopsis: hover,
- fullDocumentation: hover,
+ Synopsis: hover,
+ FullDocumentation: hover,
}, nil
}
@@ -966,7 +1007,7 @@ func hoverReturnStatement(pgf *parsego.File, path []ast.Node, ret *ast.ReturnStm
}
buf.WriteByte(')')
return rng, &hoverResult{
- signature: buf.String(),
+ Signature: buf.String(),
}, nil
}
@@ -1005,9 +1046,9 @@ func hoverEmbed(fh file.Handle, rng protocol.Range, pattern string) (protocol.Ra
}
res := &hoverResult{
- signature: fmt.Sprintf("Embedding %q", pattern),
- synopsis: s.String(),
- fullDocumentation: s.String(),
+ Signature: fmt.Sprintf("Embedding %q", pattern),
+ Synopsis: s.String(),
+ FullDocumentation: s.String(),
}
return rng, res, nil
}
@@ -1242,10 +1283,17 @@ func formatHover(h *hoverResult, options *settings.Options, pkgURL func(path Pac
switch options.HoverKind {
case settings.SingleLine:
- return h.singleLine, nil
+ return h.SingleLine, nil
case settings.NoDocumentation:
- return maybeFenced(h.signature), nil
+ return maybeFenced(h.Signature), nil
+
+ case settings.Structured:
+ b, err := json.Marshal(h)
+ if err != nil {
+ return "", err
+ }
+ return string(b), nil
case settings.SynopsisDocumentation, settings.FullDocumentation:
var sections [][]string // assembled below
@@ -1256,20 +1304,20 @@ func formatHover(h *hoverResult, options *settings.Options, pkgURL func(path Pac
// but not Signature, which is redundant (= TypeDecl + "\n" + Methods).
// For all other symbols, we display Signature;
// TypeDecl and Methods are empty.
- // (Now that JSON is no more, we could rationalize this.)
+ // TODO(golang/go#70233): When JSON is no more, we could rationalize this.
if h.typeDecl != "" {
sections = append(sections, []string{maybeFenced(h.typeDecl)})
} else {
- sections = append(sections, []string{maybeFenced(h.signature)})
+ sections = append(sections, []string{maybeFenced(h.Signature)})
}
// Doc section.
var doc string
switch options.HoverKind {
case settings.SynopsisDocumentation:
- doc = h.synopsis
+ doc = h.Synopsis
case settings.FullDocumentation:
- doc = h.fullDocumentation
+ doc = h.FullDocumentation
}
if options.PreferredContentFormat == protocol.Markdown {
doc = DocCommentToMarkdown(doc, options)
@@ -1392,7 +1440,7 @@ func StdSymbolOf(obj types.Object) *stdlib.Symbol {
// If pkgURL is non-nil, it should be used to generate doc links.
func formatLink(h *hoverResult, options *settings.Options, pkgURL func(path PackagePath, fragment string) protocol.URI) string {
- if options.LinksInHover == settings.LinksInHover_None || h.linkPath == "" {
+ if options.LinksInHover == settings.LinksInHover_None || h.LinkPath == "" {
return ""
}
var url protocol.URI
@@ -1400,26 +1448,26 @@ func formatLink(h *hoverResult, options *settings.Options, pkgURL func(path Pack
if pkgURL != nil { // LinksInHover == "gopls"
// Discard optional module version portion.
// (Ideally the hoverResult would retain the structure...)
- path := h.linkPath
- if module, versionDir, ok := strings.Cut(h.linkPath, "@"); ok {
+ path := h.LinkPath
+ if module, versionDir, ok := strings.Cut(h.LinkPath, "@"); ok {
// "module@version/dir"
path = module
if _, dir, ok := strings.Cut(versionDir, "/"); ok {
path += "/" + dir
}
}
- url = pkgURL(PackagePath(path), h.linkAnchor)
+ url = pkgURL(PackagePath(path), h.LinkAnchor)
caption = "in gopls doc viewer"
} else {
if options.LinkTarget == "" {
return ""
}
- url = cache.BuildLink(options.LinkTarget, h.linkPath, h.linkAnchor)
+ url = cache.BuildLink(options.LinkTarget, h.LinkPath, h.LinkAnchor)
caption = "on " + options.LinkTarget
}
switch options.PreferredContentFormat {
case protocol.Markdown:
- return fmt.Sprintf("[`%s` %s](%s)", h.symbolName, caption, url)
+ return fmt.Sprintf("[`%s` %s](%s)", h.SymbolName, caption, url)
case protocol.PlainText:
return ""
default:
diff --git a/gopls/internal/golang/implementation.go b/gopls/internal/golang/implementation.go
index fe0a34a1c80..a5ab5d19a13 100644
--- a/gopls/internal/golang/implementation.go
+++ b/gopls/internal/golang/implementation.go
@@ -11,7 +11,9 @@ import (
"go/ast"
"go/token"
"go/types"
+ "iter"
"reflect"
+ "slices"
"sort"
"strings"
"sync"
@@ -21,11 +23,16 @@ import (
"golang.org/x/tools/gopls/internal/cache"
"golang.org/x/tools/gopls/internal/cache/metadata"
"golang.org/x/tools/gopls/internal/cache/methodsets"
+ "golang.org/x/tools/gopls/internal/cache/parsego"
"golang.org/x/tools/gopls/internal/file"
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/gopls/internal/util/bug"
+ "golang.org/x/tools/gopls/internal/util/moreiters"
"golang.org/x/tools/gopls/internal/util/safetoken"
+ "golang.org/x/tools/internal/astutil/cursor"
+ "golang.org/x/tools/internal/astutil/edge"
"golang.org/x/tools/internal/event"
+ "golang.org/x/tools/internal/typesinternal"
)
// This file defines the new implementation of the 'implementation'
@@ -74,9 +81,26 @@ func Implementation(ctx context.Context, snapshot *cache.Snapshot, f file.Handle
}
func implementations(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, pp protocol.Position) ([]protocol.Location, error) {
- // First, find the object referenced at the cursor by type checking the
- // current package.
- obj, pkg, err := implementsObj(ctx, snapshot, fh.URI(), pp)
+ // Type check the current package.
+ pkg, pgf, err := NarrowestPackageForFile(ctx, snapshot, fh.URI())
+ if err != nil {
+ return nil, err
+ }
+ pos, err := pgf.PositionPos(pp)
+ if err != nil {
+ return nil, err
+ }
+
+ // Find implementations based on func signatures.
+ if locs, err := implFuncs(pkg, pgf, pos); err != errNotHandled {
+ return locs, err
+ }
+
+ // Find implementations based on method sets.
+
+ // First, find the object referenced at the cursor.
+ // The object may be declared in a different package.
+ obj, err := implementsObj(pkg, pgf, pos)
if err != nil {
return nil, err
}
@@ -272,21 +296,9 @@ func offsetToLocation(ctx context.Context, snapshot *cache.Snapshot, filename st
return m.OffsetLocation(start, end)
}
-// implementsObj returns the object to query for implementations, which is a
-// type name or method.
-//
-// The returned Package is the narrowest package containing ppos, which is the
-// package using the resulting obj but not necessarily the declaring package.
-func implementsObj(ctx context.Context, snapshot *cache.Snapshot, uri protocol.DocumentURI, ppos protocol.Position) (types.Object, *cache.Package, error) {
- pkg, pgf, err := NarrowestPackageForFile(ctx, snapshot, uri)
- if err != nil {
- return nil, nil, err
- }
- pos, err := pgf.PositionPos(ppos)
- if err != nil {
- return nil, nil, err
- }
-
+// implementsObj returns the object to query for implementations,
+// which is a type name or method.
+func implementsObj(pkg *cache.Package, pgf *parsego.File, pos token.Pos) (types.Object, error) {
// This function inherits the limitation of its predecessor in
// requiring the selection to be an identifier (of a type or
// method). But there's no fundamental reason why one could
@@ -299,11 +311,11 @@ func implementsObj(ctx context.Context, snapshot *cache.Snapshot, uri protocol.D
// TODO(adonovan): simplify: use objectsAt?
path := pathEnclosingObjNode(pgf.File, pos)
if path == nil {
- return nil, nil, ErrNoIdentFound
+ return nil, ErrNoIdentFound
}
id, ok := path[0].(*ast.Ident)
if !ok {
- return nil, nil, ErrNoIdentFound
+ return nil, ErrNoIdentFound
}
// Is the object a type or method? Reject other kinds.
@@ -319,17 +331,18 @@ func implementsObj(ctx context.Context, snapshot *cache.Snapshot, uri protocol.D
// ok
case *types.Func:
if obj.Signature().Recv() == nil {
- return nil, nil, fmt.Errorf("%s is a function, not a method", id.Name)
+ return nil, fmt.Errorf("%s is a function, not a method (query at 'func' token to find matching signatures)", id.Name)
}
case nil:
- return nil, nil, fmt.Errorf("%s denotes unknown object", id.Name)
+ return nil, fmt.Errorf("%s denotes unknown object", id.Name)
default:
// e.g. *types.Var -> "var".
kind := strings.ToLower(strings.TrimPrefix(reflect.TypeOf(obj).String(), "*types."))
- return nil, nil, fmt.Errorf("%s is a %s, not a type", id.Name, kind)
+ // TODO(adonovan): improve upon "nil is a nil, not a type".
+ return nil, fmt.Errorf("%s is a %s, not a type", id.Name, kind)
}
- return obj, pkg, nil
+ return obj, nil
}
// localImplementations searches within pkg for declarations of all
@@ -352,17 +365,14 @@ func localImplementations(ctx context.Context, snapshot *cache.Snapshot, pkg *ca
var locs []protocol.Location
var methodLocs []methodsets.Location
for _, pgf := range pkg.CompiledGoFiles() {
- ast.Inspect(pgf.File, func(n ast.Node) bool {
- spec, ok := n.(*ast.TypeSpec)
- if !ok {
- return true // not a type declaration
- }
+ for cur := range pgf.Cursor.Preorder((*ast.TypeSpec)(nil)) {
+ spec := cur.Node().(*ast.TypeSpec)
def := pkg.TypesInfo().Defs[spec.Name]
if def == nil {
- return true // "can't happen" for types
+ continue // "can't happen" for types
}
if def.(*types.TypeName).IsAlias() {
- return true // skip type aliases to avoid duplicate reporting
+ continue // skip type aliases to avoid duplicate reporting
}
candidateType := methodsets.EnsurePointer(def.Type())
@@ -373,20 +383,20 @@ func localImplementations(ctx context.Context, snapshot *cache.Snapshot, pkg *ca
// TODO(adonovan): UX: report I/I pairs too?
// The same question appears in the global algorithm (methodsets).
if !concreteImplementsIntf(&msets, candidateType, queryType) {
- return true // not assignable
+ continue // not assignable
}
// Ignore types with empty method sets.
// (No point reporting that every type satisfies 'any'.)
mset := msets.MethodSet(candidateType)
if mset.Len() == 0 {
- return true
+ continue
}
if method == nil {
// Found matching type.
locs = append(locs, mustLocation(pgf, spec.Name))
- return true
+ continue
}
// Find corresponding method.
@@ -407,8 +417,7 @@ func localImplementations(ctx context.Context, snapshot *cache.Snapshot, pkg *ca
break
}
}
- return true
- })
+ }
}
// Finally convert method positions to protocol form by reading the files.
@@ -491,133 +500,327 @@ func concreteImplementsIntf(msets *typeutil.MethodSetCache, x, y types.Type) boo
if !ok {
return false // x lacks a method of y
}
- if !unify(xm.Signature(), ym.Signature()) {
+ if !unify(xm.Signature(), ym.Signature(), nil) {
return false // signatures do not match
}
}
return true // all methods found
}
-// unify reports whether the types of x and y match, allowing free
-// type parameters to stand for anything at all, without regard to
-// consistency of substitutions.
+// unify reports whether the types of x and y match.
//
-// TODO(adonovan): implement proper unification (#63982), finding the
-// most general unifier across all the interface methods.
+// If unifier is nil, unify reports only whether it succeeded.
+// If unifier is non-nil, it is populated with the values
+// of type parameters determined during a successful unification.
+// If unification succeeds without binding a type parameter, that parameter
+// will not be present in the map.
//
-// See also: unify in cache/methodsets/fingerprint, which uses a
-// similar ersatz unification approach on type fingerprints, for
-// the global index.
-func unify(x, y types.Type) bool {
- x = types.Unalias(x)
- y = types.Unalias(y)
-
- // For now, allow a type parameter to match anything,
- // without regard to consistency of substitutions.
- if is[*types.TypeParam](x) || is[*types.TypeParam](y) {
- return true
+// On entry, the unifier's contents are treated as the values of already-bound type
+// parameters, constraining the unification.
+//
+// For example, if unifier is an empty (not nil) map on entry, then the types
+//
+// func[T any](T, int)
+//
+// and
+//
+// func[U any](bool, U)
+//
+// will unify, with T=bool and U=int.
+// That is, the contents of unifier after unify returns will be
+//
+// {T: bool, U: int}
+//
+// where "T" is the type parameter T and "bool" is the basic type for bool.
+//
+// But if unifier is {T: int} is int on entry, then unification will fail, because T
+// does not unify with bool.
+//
+// Unify does not preserve aliases. For example, given the following:
+//
+// type String = string
+// type A[T] = T
+//
+// unification succeeds with T bound to string, not String.
+//
+// See also: unify in cache/methodsets/fingerprint, which implements
+// unification for type fingerprints, for the global index.
+//
+// BUG: literal interfaces are not handled properly. But this function is currently
+// used only for signatures, where such types are very rare.
+func unify(x, y types.Type, unifier map[*types.TypeParam]types.Type) bool {
+ // bindings[tp] is the binding for type parameter tp.
+ // Although type parameters are nominally bound to types, each bindings[tp]
+ // is a pointer to a type, so unbound variables that unify can share a binding.
+ bindings := map[*types.TypeParam]*types.Type{}
+
+ // Bindings is initialized with pointers to the provided types.
+ for tp, t := range unifier {
+ bindings[tp] = &t
}
- if reflect.TypeOf(x) != reflect.TypeOf(y) {
- return false // mismatched types
- }
-
- switch x := x.(type) {
- case *types.Array:
- y := y.(*types.Array)
- return x.Len() == y.Len() &&
- unify(x.Elem(), y.Elem())
-
- case *types.Basic:
- y := y.(*types.Basic)
- return x.Kind() == y.Kind()
-
- case *types.Chan:
- y := y.(*types.Chan)
- return x.Dir() == y.Dir() &&
- unify(x.Elem(), y.Elem())
-
- case *types.Interface:
- y := y.(*types.Interface)
- // TODO(adonovan): fix: for correctness, we must check
- // that both interfaces have the same set of methods
- // modulo type parameters, while avoiding the risk of
- // unbounded interface recursion.
- //
- // Since non-empty interface literals are vanishingly
- // rare in methods signatures, we ignore this for now.
- // If more precision is needed we could compare method
- // names and arities, still without full recursion.
- return x.NumMethods() == y.NumMethods()
-
- case *types.Map:
- y := y.(*types.Map)
- return unify(x.Key(), y.Key()) &&
- unify(x.Elem(), y.Elem())
-
- case *types.Named:
- y := y.(*types.Named)
- if x.Origin() != y.Origin() {
- return false // different named types
+ // bindingFor returns the *types.Type in bindings for tp if tp is not nil,
+ // creating one if needed.
+ bindingFor := func(tp *types.TypeParam) *types.Type {
+ if tp == nil {
+ return nil
}
- xtargs := x.TypeArgs()
- ytargs := y.TypeArgs()
- if xtargs.Len() != ytargs.Len() {
- return false // arity error (ill-typed)
+ b := bindings[tp]
+ if b == nil {
+ b = new(types.Type)
+ bindings[tp] = b
}
- for i := range xtargs.Len() {
- if !unify(xtargs.At(i), ytargs.At(i)) {
- return false // mismatched type args
+ return b
+ }
+
+ // bind sets b to t if b does not occur in t.
+ bind := func(b *types.Type, t types.Type) bool {
+ for tp := range typeParams(t) {
+ if b == bindings[tp] {
+ return false // failed "occurs" check
}
}
+ *b = t
return true
+ }
- case *types.Pointer:
- y := y.(*types.Pointer)
- return unify(x.Elem(), y.Elem())
+ // uni performs the actual unification.
+ depth := 0
+ var uni func(x, y types.Type) bool
+ uni = func(x, y types.Type) bool {
+ // Panic if recursion gets too deep, to detect bugs before
+ // overflowing the stack.
+ depth++
+ defer func() { depth-- }()
+ if depth > 100 {
+ panic("unify: max depth exceeded")
+ }
- case *types.Signature:
- y := y.(*types.Signature)
- return x.Variadic() == y.Variadic() &&
- unify(x.Params(), y.Params()) &&
- unify(x.Results(), y.Results())
+ x = types.Unalias(x)
+ y = types.Unalias(y)
- case *types.Slice:
- y := y.(*types.Slice)
- return unify(x.Elem(), y.Elem())
+ tpx, _ := x.(*types.TypeParam)
+ tpy, _ := y.(*types.TypeParam)
+ if tpx != nil || tpy != nil {
+ // Identical type params unify.
+ if tpx == tpy {
+ return true
+ }
+ bx := bindingFor(tpx)
+ by := bindingFor(tpy)
- case *types.Struct:
- y := y.(*types.Struct)
- if x.NumFields() != y.NumFields() {
- return false
+ // If both args are type params and neither is bound, have them share a binding.
+ if bx != nil && by != nil && *bx == nil && *by == nil {
+ // Arbitrarily give y's binding to x.
+ bindings[tpx] = by
+ return true
+ }
+ // Treat param bindings like original args in what follows.
+ if bx != nil && *bx != nil {
+ x = *bx
+ }
+ if by != nil && *by != nil {
+ y = *by
+ }
+ // If the x param is unbound, bind it to y.
+ if bx != nil && *bx == nil {
+ return bind(bx, y)
+ }
+ // If the y param is unbound, bind it to x.
+ if by != nil && *by == nil {
+ return bind(by, x)
+ }
+ // Unify the binding of a bound parameter.
+ return uni(x, y)
}
- for i := range x.NumFields() {
- xf := x.Field(i)
- yf := y.Field(i)
- if xf.Embedded() != yf.Embedded() ||
- xf.Name() != yf.Name() ||
- x.Tag(i) != y.Tag(i) ||
- !xf.Exported() && xf.Pkg() != yf.Pkg() ||
- !unify(xf.Type(), yf.Type()) {
+
+ // Neither arg is a type param.
+
+ if reflect.TypeOf(x) != reflect.TypeOf(y) {
+ return false // mismatched types
+ }
+
+ switch x := x.(type) {
+ case *types.Array:
+ y := y.(*types.Array)
+ return x.Len() == y.Len() &&
+ uni(x.Elem(), y.Elem())
+
+ case *types.Basic:
+ y := y.(*types.Basic)
+ return x.Kind() == y.Kind()
+
+ case *types.Chan:
+ y := y.(*types.Chan)
+ return x.Dir() == y.Dir() &&
+ uni(x.Elem(), y.Elem())
+
+ case *types.Interface:
+ y := y.(*types.Interface)
+ // TODO(adonovan,jba): fix: for correctness, we must check
+ // that both interfaces have the same set of methods
+ // modulo type parameters, while avoiding the risk of
+ // unbounded interface recursion.
+ //
+ // Since non-empty interface literals are vanishingly
+ // rare in methods signatures, we ignore this for now.
+ // If more precision is needed we could compare method
+ // names and arities, still without full recursion.
+ return x.NumMethods() == y.NumMethods()
+
+ case *types.Map:
+ y := y.(*types.Map)
+ return uni(x.Key(), y.Key()) &&
+ uni(x.Elem(), y.Elem())
+
+ case *types.Named:
+ y := y.(*types.Named)
+ if x.Origin() != y.Origin() {
+ return false // different named types
+ }
+ xtargs := x.TypeArgs()
+ ytargs := y.TypeArgs()
+ if xtargs.Len() != ytargs.Len() {
+ return false // arity error (ill-typed)
+ }
+ for i := range xtargs.Len() {
+ if !uni(xtargs.At(i), ytargs.At(i)) {
+ return false // mismatched type args
+ }
+ }
+ return true
+
+ case *types.Pointer:
+ y := y.(*types.Pointer)
+ return uni(x.Elem(), y.Elem())
+
+ case *types.Signature:
+ y := y.(*types.Signature)
+ return x.Variadic() == y.Variadic() &&
+ uni(x.Params(), y.Params()) &&
+ uni(x.Results(), y.Results())
+
+ case *types.Slice:
+ y := y.(*types.Slice)
+ return uni(x.Elem(), y.Elem())
+
+ case *types.Struct:
+ y := y.(*types.Struct)
+ if x.NumFields() != y.NumFields() {
return false
}
+ for i := range x.NumFields() {
+ xf := x.Field(i)
+ yf := y.Field(i)
+ if xf.Embedded() != yf.Embedded() ||
+ xf.Name() != yf.Name() ||
+ x.Tag(i) != y.Tag(i) ||
+ !xf.Exported() && xf.Pkg() != yf.Pkg() ||
+ !uni(xf.Type(), yf.Type()) {
+ return false
+ }
+ }
+ return true
+
+ case *types.Tuple:
+ y := y.(*types.Tuple)
+ if x.Len() != y.Len() {
+ return false
+ }
+ for i := range x.Len() {
+ if !uni(x.At(i).Type(), y.At(i).Type()) {
+ return false
+ }
+ }
+ return true
+
+ default: // incl. *Union, *TypeParam
+ panic(fmt.Sprintf("unexpected Type %#v", x))
}
- return true
+ }
- case *types.Tuple:
- y := y.(*types.Tuple)
- if x.Len() != y.Len() {
- return false
+ if !uni(x, y) {
+ clear(unifier)
+ return false
+ }
+
+ // Populate the input map with the resulting types.
+ if unifier != nil {
+ for tparam, tptr := range bindings {
+ unifier[tparam] = *tptr
}
- for i := range x.Len() {
- if !unify(x.At(i).Type(), y.At(i).Type()) {
- return false
+ }
+ return true
+}
+
+// typeParams yields all the free type parameters within t that are relevant for
+// unification.
+func typeParams(t types.Type) iter.Seq[*types.TypeParam] {
+
+ return func(yield func(*types.TypeParam) bool) {
+ seen := map[*types.TypeParam]bool{} // yield each type param only once
+
+ // tps(t) yields each TypeParam in t and returns false to stop.
+ var tps func(types.Type) bool
+ tps = func(t types.Type) bool {
+ t = types.Unalias(t)
+
+ switch t := t.(type) {
+ case *types.TypeParam:
+ if seen[t] {
+ return true
+ }
+ seen[t] = true
+ return yield(t)
+
+ case *types.Basic:
+ return true
+
+ case *types.Array:
+ return tps(t.Elem())
+
+ case *types.Chan:
+ return tps(t.Elem())
+
+ case *types.Interface:
+ // TODO(jba): implement.
+ return true
+
+ case *types.Map:
+ return tps(t.Key()) && tps(t.Elem())
+
+ case *types.Named:
+ if t.Origin() == t {
+ // generic type: look at type params
+ return moreiters.Every(t.TypeParams().TypeParams(),
+ func(tp *types.TypeParam) bool { return tps(tp) })
+ }
+ // instantiated type: look at type args
+ return moreiters.Every(t.TypeArgs().Types(), tps)
+
+ case *types.Pointer:
+ return tps(t.Elem())
+
+ case *types.Signature:
+ return tps(t.Params()) && tps(t.Results())
+
+ case *types.Slice:
+ return tps(t.Elem())
+
+ case *types.Struct:
+ return moreiters.Every(t.Fields(),
+ func(v *types.Var) bool { return tps(v.Type()) })
+
+ case *types.Tuple:
+ return moreiters.Every(t.Variables(),
+ func(v *types.Var) bool { return tps(v.Type()) })
+
+ default: // incl. *Union
+ panic(fmt.Sprintf("unexpected Type %#v", t))
}
}
- return true
- default: // incl. *Union, *TypeParam
- panic(fmt.Sprintf("unexpected Type %#v", x))
+ tps(t)
}
}
@@ -659,6 +862,7 @@ func pathEnclosingObjNode(f *ast.File, pos token.Pos) []ast.Node {
// handled this by calling astutil.PathEnclosingInterval twice,
// once for "pos" and once for "pos-1".
found = n.Pos() <= pos && pos <= n.End()
+
case *ast.ImportSpec:
if n.Path.Pos() <= pos && pos < n.Path.End() {
found = true
@@ -668,6 +872,7 @@ func pathEnclosingObjNode(f *ast.File, pos token.Pos) []ast.Node {
path = append(path, n.Name)
}
}
+
case *ast.StarExpr:
// Follow star expressions to the inner identifier.
if pos == n.Star {
@@ -683,9 +888,218 @@ func pathEnclosingObjNode(f *ast.File, pos token.Pos) []ast.Node {
}
// Reverse path so leaf is first element.
- for i := 0; i < len(path)/2; i++ {
- path[i], path[len(path)-1-i] = path[len(path)-1-i], path[i]
+ slices.Reverse(path)
+ return path
+}
+
+// --- Implementations based on signature types --
+
+// implFuncs finds Implementations based on func types.
+//
+// Just as an interface type abstracts a set of concrete methods, a
+// function type abstracts a set of concrete functions. Gopls provides
+// analogous operations for navigating from abstract to concrete and
+// back in the domain of function types.
+//
+// A single type (for example http.HandlerFunc) can have both an
+// underlying type of function (types.Signature) and have methods that
+// cause it to implement an interface. To avoid a confusing user
+// interface we want to separate the two operations so that the user
+// can unambiguously specify the query they want.
+//
+// So, whereas Implementations queries on interface types are usually
+// keyed by an identifier of a named type, Implementations queries on
+// function types are keyed by the "func" keyword, or by the "(" of a
+// call expression. The query relates two sets of locations:
+//
+// 1. the "func" token of each function declaration (FuncDecl or
+// FuncLit). These are analogous to declarations of concrete
+// methods.
+//
+// 2. uses of abstract functions:
+//
+// (a) the "func" token of each FuncType that is not part of
+// Func{Decl,Lit}. These are analogous to interface{...} types.
+//
+// (b) the "(" paren of each dynamic call on a value of an
+// abstract function type. These are analogous to references to
+// interface method names, but no names are involved, which has
+// historically made them hard to search for.
+//
+// An Implementations query on a location in set 1 returns set 2,
+// and vice versa.
+//
+// implFuncs returns errNotHandled to indicate that we should try the
+// regular method-sets algorithm.
+func implFuncs(pkg *cache.Package, pgf *parsego.File, pos token.Pos) ([]protocol.Location, error) {
+ curSel, ok := pgf.Cursor.FindPos(pos, pos)
+ if !ok {
+ return nil, fmt.Errorf("no code selected")
}
- return path
+ info := pkg.TypesInfo()
+ if info.Types == nil || info.Defs == nil || info.Uses == nil {
+ panic("one of info.Types, .Defs or .Uses is nil")
+ }
+
+ // Find innermost enclosing FuncType or CallExpr.
+ //
+ // We are looking for specific tokens (FuncType.Func and
+ // CallExpr.Lparen), but FindPos prefers an adjoining
+ // subexpression: given f(x) without additional spaces between
+ // tokens, FindPos always returns either f or x, never the
+ // CallExpr itself. Thus we must ascend the tree.
+ //
+ // Another subtlety: due to an edge case in go/ast, FindPos at
+ // FuncDecl.Type.Func does not return FuncDecl.Type, only the
+ // FuncDecl, because the orders of tree positions and tokens
+ // are inconsistent. Consequently, the ancestors for a "func"
+ // token of Func{Lit,Decl} do not include FuncType, hence the
+ // explicit cases below.
+ for _, cur := range curSel.Stack(nil) {
+ switch n := cur.Node().(type) {
+ case *ast.FuncDecl, *ast.FuncLit:
+ if inToken(n.Pos(), "func", pos) {
+ // Case 1: concrete function declaration.
+ // Report uses of corresponding function types.
+ switch n := n.(type) {
+ case *ast.FuncDecl:
+ return funcUses(pkg, info.Defs[n.Name].Type())
+ case *ast.FuncLit:
+ return funcUses(pkg, info.TypeOf(n.Type))
+ }
+ }
+
+ case *ast.FuncType:
+ if n.Func.IsValid() && inToken(n.Func, "func", pos) && !beneathFuncDef(cur) {
+ // Case 2a: function type.
+ // Report declarations of corresponding concrete functions.
+ return funcDefs(pkg, info.TypeOf(n))
+ }
+
+ case *ast.CallExpr:
+ if inToken(n.Lparen, "(", pos) {
+ t := dynamicFuncCallType(info, n)
+ if t == nil {
+ return nil, fmt.Errorf("not a dynamic function call")
+ }
+ // Case 2b: dynamic call of function value.
+ // Report declarations of corresponding concrete functions.
+ return funcDefs(pkg, t)
+ }
+ }
+ }
+
+ // It's probably a query of a named type or method.
+ // Fall back to the method-sets computation.
+ return nil, errNotHandled
+}
+
+var errNotHandled = errors.New("not handled")
+
+// funcUses returns all locations in the workspace that are dynamic
+// uses of the specified function type.
+func funcUses(pkg *cache.Package, t types.Type) ([]protocol.Location, error) {
+ var locs []protocol.Location
+
+ // local search
+ for _, pgf := range pkg.CompiledGoFiles() {
+ for cur := range pgf.Cursor.Preorder((*ast.CallExpr)(nil), (*ast.FuncType)(nil)) {
+ var pos, end token.Pos
+ var ftyp types.Type
+ switch n := cur.Node().(type) {
+ case *ast.CallExpr:
+ ftyp = dynamicFuncCallType(pkg.TypesInfo(), n)
+ pos, end = n.Lparen, n.Lparen+token.Pos(len("("))
+
+ case *ast.FuncType:
+ if !beneathFuncDef(cur) {
+ // func type (not def)
+ ftyp = pkg.TypesInfo().TypeOf(n)
+ pos, end = n.Func, n.Func+token.Pos(len("func"))
+ }
+ }
+ if ftyp == nil {
+ continue // missing type information
+ }
+ if unify(t, ftyp, nil) {
+ loc, err := pgf.PosLocation(pos, end)
+ if err != nil {
+ return nil, err
+ }
+ locs = append(locs, loc)
+ }
+ }
+ }
+
+ // TODO(adonovan): implement global search
+
+ return locs, nil
+}
+
+// funcDefs returns all locations in the workspace that define
+// functions of the specified type.
+func funcDefs(pkg *cache.Package, t types.Type) ([]protocol.Location, error) {
+ var locs []protocol.Location
+
+ // local search
+ for _, pgf := range pkg.CompiledGoFiles() {
+ for curFn := range pgf.Cursor.Preorder((*ast.FuncDecl)(nil), (*ast.FuncLit)(nil)) {
+ fn := curFn.Node()
+ var ftyp types.Type
+ switch fn := fn.(type) {
+ case *ast.FuncDecl:
+ ftyp = pkg.TypesInfo().Defs[fn.Name].Type()
+ case *ast.FuncLit:
+ ftyp = pkg.TypesInfo().TypeOf(fn)
+ }
+ if ftyp == nil {
+ continue // missing type information
+ }
+ if unify(t, ftyp, nil) {
+ pos := fn.Pos()
+ loc, err := pgf.PosLocation(pos, pos+token.Pos(len("func")))
+ if err != nil {
+ return nil, err
+ }
+ locs = append(locs, loc)
+ }
+ }
+ }
+
+ // TODO(adonovan): implement global search, by analogy with
+ // methodsets algorithm.
+ //
+ // One optimization: if any signature type has free package
+ // names, look for matches only in packages among the rdeps of
+ // those packages.
+
+ return locs, nil
+}
+
+// beneathFuncDef reports whether the specified FuncType cursor is a
+// child of Func{Decl,Lit}.
+func beneathFuncDef(cur cursor.Cursor) bool {
+ switch ek, _ := cur.ParentEdge(); ek {
+ case edge.FuncDecl_Type, edge.FuncLit_Type:
+ return true
+ }
+ return false
+}
+
+// dynamicFuncCallType reports whether call is a dynamic (non-method) function call.
+// If so, it returns the function type, otherwise nil.
+//
+// Tested via ../test/marker/testdata/implementation/signature.txt.
+func dynamicFuncCallType(info *types.Info, call *ast.CallExpr) types.Type {
+ if typesinternal.ClassifyCall(info, call) == typesinternal.CallDynamic {
+ return info.Types[call.Fun].Type.Underlying()
+ }
+ return nil
+}
+
+// inToken reports whether pos is within the token of
+// the specified position and string.
+func inToken(tokPos token.Pos, tokStr string, pos token.Pos) bool {
+ return tokPos <= pos && pos <= tokPos+token.Pos(len(tokStr))
}
diff --git a/gopls/internal/golang/implementation_test.go b/gopls/internal/golang/implementation_test.go
new file mode 100644
index 00000000000..b7253bb8bf7
--- /dev/null
+++ b/gopls/internal/golang/implementation_test.go
@@ -0,0 +1,303 @@
+// Copyright 2025 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 golang
+
+import (
+ "go/types"
+ "maps"
+ "testing"
+
+ "golang.org/x/tools/internal/testfiles"
+ "golang.org/x/tools/txtar"
+)
+
+func TestUnify(t *testing.T) {
+ // Most cases from TestMatches in gopls/internal/util/fingerprint/fingerprint_test.go.
+ const src = `
+-- go.mod --
+module example.com
+go 1.24
+
+-- a/a.go --
+package a
+
+type Int = int
+type String = string
+
+// Eq.Equal matches casefold.Equal.
+type Eq[T any] interface { Equal(T, T) bool }
+type casefold struct{}
+func (casefold) Equal(x, y string) bool
+
+// A matches AString.
+type A[T any] = struct { x T }
+type AString = struct { x string }
+
+// B matches anything!
+type B[T any] = T
+
+func C1[T any](int, T, ...string) T { panic(0) }
+func C2[U any](int, int, ...U) bool { panic(0) }
+func C3(int, bool, ...string) rune
+func C4(int, bool, ...string)
+func C5(int, float64, bool, string) bool
+func C6(int, bool, ...string) bool
+
+func DAny[T any](Named[T]) { panic(0) }
+func DString(Named[string])
+func DInt(Named[int])
+
+type Named[T any] struct { x T }
+
+func E1(byte) rune
+func E2(uint8) int32
+func E3(int8) uint32
+
+// generic vs. generic
+func F1[T any](T) { panic(0) }
+func F2[T any](*T) { panic(0) }
+func F3[T any](T, T) { panic(0) }
+func F4[U any](U, *U) {panic(0) }
+func F4a[U any](U, Named[U]) {panic(0) }
+func F5[T, U any](T, U, U) { panic(0) }
+func F6[T any](T, int, T) { panic(0) }
+func F7[T any](bool, T, T) { panic(0) }
+func F8[V any](*V, int, int) { panic(0) }
+func F9[V any](V, *V, V) { panic(0) }
+`
+ type tmap = map[*types.TypeParam]types.Type
+
+ var (
+ boolType = types.Typ[types.Bool]
+ intType = types.Typ[types.Int]
+ stringType = types.Typ[types.String]
+ )
+
+ pkg := testfiles.LoadPackages(t, txtar.Parse([]byte(src)), "./a")[0]
+ scope := pkg.Types.Scope()
+
+ tparam := func(name string, index int) *types.TypeParam {
+ obj := scope.Lookup(name)
+ var tps *types.TypeParamList
+ switch obj := obj.(type) {
+ case *types.Func:
+ tps = obj.Signature().TypeParams()
+ case *types.TypeName:
+ if n, ok := obj.Type().(*types.Named); ok {
+ tps = n.TypeParams()
+ } else {
+ tps = obj.Type().(*types.Alias).TypeParams()
+ }
+ default:
+ t.Fatalf("unsupported object of type %T", obj)
+ }
+ return tps.At(index)
+ }
+
+ for _, test := range []struct {
+ x, y string // the symbols in the above source code whose types to unify
+ method string // optional field or method
+ params tmap // initial values of type params
+ want bool // success or failure
+ wantParams tmap // expected output
+ }{
+ {
+ // In Eq[T], T is bound to string.
+ x: "Eq",
+ y: "casefold",
+ method: "Equal",
+ want: true,
+ wantParams: tmap{tparam("Eq", 0): stringType},
+ },
+ {
+ // If we unify A[T] and A[string], T should be bound to string.
+ x: "A",
+ y: "AString",
+ want: true,
+ wantParams: tmap{tparam("A", 0): stringType},
+ },
+ {x: "A", y: "Eq", want: false}, // completely unrelated
+ {
+ x: "B",
+ y: "String",
+ want: true,
+ wantParams: tmap{tparam("B", 0): stringType},
+ },
+ {
+ x: "B",
+ y: "Int",
+ want: true,
+ wantParams: tmap{tparam("B", 0): intType},
+ },
+ {
+ x: "B",
+ y: "A",
+ want: true,
+ // B's T is bound to A's struct { x T }
+ wantParams: tmap{tparam("B", 0): scope.Lookup("A").Type().Underlying()},
+ },
+ {
+ // C1's U unifies with C6's bool.
+ x: "C1",
+ y: "C6",
+ wantParams: tmap{tparam("C1", 0): boolType},
+ want: true,
+ },
+ // C1 fails to unify with C2 because C1's T must be bound to both int and bool.
+ {x: "C1", y: "C2", want: false},
+ // The remaining "C" cases fail for less interesting reasons, usually different numbers
+ // or types of parameters or results.
+ {x: "C1", y: "C3", want: false},
+ {x: "C1", y: "C4", want: false},
+ {x: "C1", y: "C5", want: false},
+ {x: "C2", y: "C3", want: false},
+ {x: "C2", y: "C4", want: false},
+ {x: "C3", y: "C4", want: false},
+ {
+ x: "DAny",
+ y: "DString",
+ want: true,
+ wantParams: tmap{tparam("DAny", 0): stringType},
+ },
+ {x: "DString", y: "DInt", want: false}, // different instantiations of Named
+ {x: "E1", y: "E2", want: true}, // byte and rune are just aliases
+ {x: "E2", y: "E3", want: false},
+
+ // The following tests cover all of the type param cases of unify.
+ {
+ // F1[*int] = F2[int], for example
+ // F1's T is bound to a pointer to F2's T.
+ x: "F1",
+ // F2's T is unbound: any instantiation works.
+ y: "F2",
+ want: true,
+ wantParams: tmap{tparam("F1", 0): types.NewPointer(tparam("F2", 0))},
+ },
+ {x: "F3", y: "F4", want: false}, // would require U identical to *U, prevented by occur check
+ {x: "F3", y: "F4a", want: false}, // occur check through Named[T]
+ {
+ x: "F5",
+ y: "F6",
+ want: true,
+ wantParams: tmap{
+ tparam("F5", 0): intType,
+ tparam("F5", 1): intType,
+ tparam("F6", 0): intType,
+ },
+ },
+ {x: "F6", y: "F7", want: false}, // both are bound
+ {
+ x: "F5",
+ y: "F6",
+ params: tmap{tparam("F6", 0): intType}, // consistent with the result
+ want: true,
+ wantParams: tmap{
+ tparam("F5", 0): intType,
+ tparam("F5", 1): intType,
+ tparam("F6", 0): intType,
+ },
+ },
+ {
+ x: "F5",
+ y: "F6",
+ params: tmap{tparam("F6", 0): boolType}, // not consistent
+ want: false,
+ },
+ {x: "F6", y: "F7", want: false}, // both are bound
+ {
+ // T=*V, U=int, V=int
+ x: "F5",
+ y: "F8",
+ want: true,
+ wantParams: tmap{
+ tparam("F5", 0): types.NewPointer(tparam("F8", 0)),
+ tparam("F5", 1): intType,
+ },
+ },
+ {
+ // T=*V, U=int, V=int
+ // Partial initial information is fine, as long as it's consistent.
+ x: "F5",
+ y: "F8",
+ want: true,
+ params: tmap{tparam("F5", 1): intType},
+ wantParams: tmap{
+ tparam("F5", 0): types.NewPointer(tparam("F8", 0)),
+ tparam("F5", 1): intType,
+ },
+ },
+ {
+ // T=*V, U=int, V=int
+ // Partial initial information is fine, as long as it's consistent.
+ x: "F5",
+ y: "F8",
+ want: true,
+ params: tmap{tparam("F5", 0): types.NewPointer(tparam("F8", 0))},
+ wantParams: tmap{
+ tparam("F5", 0): types.NewPointer(tparam("F8", 0)),
+ tparam("F5", 1): intType,
+ },
+ },
+ {x: "F5", y: "F9", want: false}, // T is unbound, V is bound, and T occurs in V
+ {
+ // T bound to Named[T']
+ x: "F1",
+ y: "DAny",
+ want: true,
+ wantParams: tmap{
+ tparam("F1", 0): scope.Lookup("DAny").(*types.Func).Signature().Params().At(0).Type()},
+ },
+ } {
+
+ lookup := func(name string) types.Type {
+ obj := scope.Lookup(name)
+ if obj == nil {
+ t.Fatalf("Lookup %s failed", name)
+ }
+ if test.method != "" {
+ obj, _, _ = types.LookupFieldOrMethod(obj.Type(), true, pkg.Types, test.method)
+ if obj == nil {
+ t.Fatalf("Lookup %s.%s failed", name, test.method)
+ }
+ }
+ return obj.Type()
+ }
+
+ check := func(a, b string, want, compareParams bool) {
+ t.Helper()
+
+ ta := lookup(a)
+ tb := lookup(b)
+
+ var gotParams tmap
+ if test.params == nil {
+ // Get the unifier even if there are no input params.
+ gotParams = tmap{}
+ } else {
+ gotParams = maps.Clone(test.params)
+ }
+ got := unify(ta, tb, gotParams)
+ if got != want {
+ t.Errorf("a=%s b=%s method=%s: unify returned %t for these inputs:\n- %s\n- %s",
+ a, b, test.method, got, ta, tb)
+ return
+ }
+ if !compareParams {
+ return
+ }
+ if !maps.EqualFunc(gotParams, test.wantParams, types.Identical) {
+ t.Errorf("x=%s y=%s method=%s: params: got %v, want %v",
+ a, b, test.method, gotParams, test.wantParams)
+ }
+ }
+
+ check(test.x, test.y, test.want, true)
+ // unify is symmetric
+ check(test.y, test.x, test.want, true)
+ // unify is reflexive
+ check(test.x, test.x, true, false)
+ check(test.y, test.y, true, false)
+ }
+}
diff --git a/gopls/internal/golang/inlay_hint.go b/gopls/internal/golang/inlay_hint.go
index bc85745cb0b..b49ebd85e21 100644
--- a/gopls/internal/golang/inlay_hint.go
+++ b/gopls/internal/golang/inlay_hint.go
@@ -14,9 +14,11 @@ import (
"strings"
"golang.org/x/tools/gopls/internal/cache"
+ "golang.org/x/tools/gopls/internal/cache/parsego"
"golang.org/x/tools/gopls/internal/file"
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/gopls/internal/settings"
+ "golang.org/x/tools/internal/astutil/cursor"
"golang.org/x/tools/internal/event"
"golang.org/x/tools/internal/typeparams"
"golang.org/x/tools/internal/typesinternal"
@@ -47,7 +49,7 @@ func InlayHint(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, pR
}
info := pkg.TypesInfo()
- q := typesinternal.FileQualifier(pgf.File, pkg.Types())
+ qual := typesinternal.FileQualifier(pgf.File, pkg.Types())
// Set the range to the full file if the range is not valid.
start, end := pgf.File.FileStart, pgf.File.FileEnd
@@ -63,20 +65,16 @@ func InlayHint(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, pR
}
var hints []protocol.InlayHint
- ast.Inspect(pgf.File, func(node ast.Node) bool {
- // If not in range, we can stop looking.
- if node == nil || node.End() < start || node.Pos() > end {
- return false
- }
+ if curSubrange, ok := pgf.Cursor.FindPos(start, end); ok {
+ add := func(hint protocol.InlayHint) { hints = append(hints, hint) }
for _, fn := range enabledHints {
- hints = append(hints, fn(node, pgf.Mapper, pgf.Tok, info, &q)...)
+ fn(info, pgf, qual, curSubrange, add)
}
- return true
- })
+ }
return hints, nil
}
-type inlayHintFunc func(node ast.Node, m *protocol.Mapper, tf *token.File, info *types.Info, q *types.Qualifier) []protocol.InlayHint
+type inlayHintFunc func(info *types.Info, pgf *parsego.File, qual types.Qualifier, cur cursor.Cursor, add func(protocol.InlayHint))
var allInlayHints = map[settings.InlayHint]inlayHintFunc{
settings.AssignVariableTypes: assignVariableTypes,
@@ -88,259 +86,246 @@ var allInlayHints = map[settings.InlayHint]inlayHintFunc{
settings.FunctionTypeParameters: funcTypeParams,
}
-func parameterNames(node ast.Node, m *protocol.Mapper, tf *token.File, info *types.Info, _ *types.Qualifier) []protocol.InlayHint {
- callExpr, ok := node.(*ast.CallExpr)
- if !ok {
- return nil
- }
- t := info.TypeOf(callExpr.Fun)
- if t == nil {
- return nil
- }
- signature, ok := typeparams.CoreType(t).(*types.Signature)
- if !ok {
- return nil
+func parameterNames(info *types.Info, pgf *parsego.File, qual types.Qualifier, cur cursor.Cursor, add func(protocol.InlayHint)) {
+ for curCall := range cur.Preorder((*ast.CallExpr)(nil)) {
+ callExpr := curCall.Node().(*ast.CallExpr)
+ t := info.TypeOf(callExpr.Fun)
+ if t == nil {
+ continue
+ }
+ signature, ok := typeparams.CoreType(t).(*types.Signature)
+ if !ok {
+ continue
+ }
+
+ for i, v := range callExpr.Args {
+ start, err := pgf.PosPosition(v.Pos())
+ if err != nil {
+ continue
+ }
+ params := signature.Params()
+ // When a function has variadic params, we skip args after
+ // params.Len().
+ if i > params.Len()-1 {
+ break
+ }
+ param := params.At(i)
+ // param.Name is empty for built-ins like append
+ if param.Name() == "" {
+ continue
+ }
+ // Skip the parameter name hint if the arg matches
+ // the parameter name.
+ if i, ok := v.(*ast.Ident); ok && i.Name == param.Name() {
+ continue
+ }
+
+ label := param.Name()
+ if signature.Variadic() && i == params.Len()-1 {
+ label = label + "..."
+ }
+ add(protocol.InlayHint{
+ Position: start,
+ Label: buildLabel(label + ":"),
+ Kind: protocol.Parameter,
+ PaddingRight: true,
+ })
+ }
}
+}
- var hints []protocol.InlayHint
- for i, v := range callExpr.Args {
- start, err := m.PosPosition(tf, v.Pos())
- if err != nil {
+func funcTypeParams(info *types.Info, pgf *parsego.File, qual types.Qualifier, cur cursor.Cursor, add func(protocol.InlayHint)) {
+ for curCall := range cur.Preorder((*ast.CallExpr)(nil)) {
+ call := curCall.Node().(*ast.CallExpr)
+ id, ok := call.Fun.(*ast.Ident)
+ if !ok {
continue
}
- params := signature.Params()
- // When a function has variadic params, we skip args after
- // params.Len().
- if i > params.Len()-1 {
- break
- }
- param := params.At(i)
- // param.Name is empty for built-ins like append
- if param.Name() == "" {
+ inst := info.Instances[id]
+ if inst.TypeArgs == nil {
continue
}
- // Skip the parameter name hint if the arg matches
- // the parameter name.
- if i, ok := v.(*ast.Ident); ok && i.Name == param.Name() {
+ start, err := pgf.PosPosition(id.End())
+ if err != nil {
continue
}
-
- label := param.Name()
- if signature.Variadic() && i == params.Len()-1 {
- label = label + "..."
+ var args []string
+ for i := 0; i < inst.TypeArgs.Len(); i++ {
+ args = append(args, inst.TypeArgs.At(i).String())
+ }
+ if len(args) == 0 {
+ continue
}
- hints = append(hints, protocol.InlayHint{
- Position: start,
- Label: buildLabel(label + ":"),
- Kind: protocol.Parameter,
- PaddingRight: true,
+ add(protocol.InlayHint{
+ Position: start,
+ Label: buildLabel("[" + strings.Join(args, ", ") + "]"),
+ Kind: protocol.Type,
})
}
- return hints
}
-func funcTypeParams(node ast.Node, m *protocol.Mapper, tf *token.File, info *types.Info, _ *types.Qualifier) []protocol.InlayHint {
- ce, ok := node.(*ast.CallExpr)
- if !ok {
- return nil
- }
- id, ok := ce.Fun.(*ast.Ident)
- if !ok {
- return nil
- }
- inst := info.Instances[id]
- if inst.TypeArgs == nil {
- return nil
- }
- start, err := m.PosPosition(tf, id.End())
- if err != nil {
- return nil
- }
- var args []string
- for i := 0; i < inst.TypeArgs.Len(); i++ {
- args = append(args, inst.TypeArgs.At(i).String())
- }
- if len(args) == 0 {
- return nil
- }
- return []protocol.InlayHint{{
- Position: start,
- Label: buildLabel("[" + strings.Join(args, ", ") + "]"),
- Kind: protocol.Type,
- }}
-}
-
-func assignVariableTypes(node ast.Node, m *protocol.Mapper, tf *token.File, info *types.Info, q *types.Qualifier) []protocol.InlayHint {
- stmt, ok := node.(*ast.AssignStmt)
- if !ok || stmt.Tok != token.DEFINE {
- return nil
- }
-
- var hints []protocol.InlayHint
- for _, v := range stmt.Lhs {
- if h := variableType(v, m, tf, info, q); h != nil {
- hints = append(hints, *h)
+func assignVariableTypes(info *types.Info, pgf *parsego.File, qual types.Qualifier, cur cursor.Cursor, add func(protocol.InlayHint)) {
+ for curAssign := range cur.Preorder((*ast.AssignStmt)(nil)) {
+ stmt := curAssign.Node().(*ast.AssignStmt)
+ if stmt.Tok != token.DEFINE {
+ continue
+ }
+ for _, v := range stmt.Lhs {
+ variableType(info, pgf, qual, v, add)
}
}
- return hints
}
-func rangeVariableTypes(node ast.Node, m *protocol.Mapper, tf *token.File, info *types.Info, q *types.Qualifier) []protocol.InlayHint {
- rStmt, ok := node.(*ast.RangeStmt)
- if !ok {
- return nil
- }
- var hints []protocol.InlayHint
- if h := variableType(rStmt.Key, m, tf, info, q); h != nil {
- hints = append(hints, *h)
- }
- if h := variableType(rStmt.Value, m, tf, info, q); h != nil {
- hints = append(hints, *h)
+func rangeVariableTypes(info *types.Info, pgf *parsego.File, qual types.Qualifier, cur cursor.Cursor, add func(protocol.InlayHint)) {
+ for curRange := range cur.Preorder((*ast.RangeStmt)(nil)) {
+ rStmt := curRange.Node().(*ast.RangeStmt)
+ variableType(info, pgf, qual, rStmt.Key, add)
+ variableType(info, pgf, qual, rStmt.Value, add)
}
- return hints
}
-func variableType(e ast.Expr, m *protocol.Mapper, tf *token.File, info *types.Info, q *types.Qualifier) *protocol.InlayHint {
+func variableType(info *types.Info, pgf *parsego.File, qual types.Qualifier, e ast.Expr, add func(protocol.InlayHint)) {
typ := info.TypeOf(e)
if typ == nil {
- return nil
+ return
}
- end, err := m.PosPosition(tf, e.End())
+ end, err := pgf.PosPosition(e.End())
if err != nil {
- return nil
+ return
}
- return &protocol.InlayHint{
+ add(protocol.InlayHint{
Position: end,
- Label: buildLabel(types.TypeString(typ, *q)),
+ Label: buildLabel(types.TypeString(typ, qual)),
Kind: protocol.Type,
PaddingLeft: true,
- }
+ })
}
-func constantValues(node ast.Node, m *protocol.Mapper, tf *token.File, info *types.Info, _ *types.Qualifier) []protocol.InlayHint {
- genDecl, ok := node.(*ast.GenDecl)
- if !ok || genDecl.Tok != token.CONST {
- return nil
- }
-
- var hints []protocol.InlayHint
- for _, v := range genDecl.Specs {
- spec, ok := v.(*ast.ValueSpec)
- if !ok {
- continue
- }
- end, err := m.PosPosition(tf, v.End())
- if err != nil {
+func constantValues(info *types.Info, pgf *parsego.File, qual types.Qualifier, cur cursor.Cursor, add func(protocol.InlayHint)) {
+ for curDecl := range cur.Preorder((*ast.GenDecl)(nil)) {
+ genDecl := curDecl.Node().(*ast.GenDecl)
+ if genDecl.Tok != token.CONST {
continue
}
- // Show hints when values are missing or at least one value is not
- // a basic literal.
- showHints := len(spec.Values) == 0
- checkValues := len(spec.Names) == len(spec.Values)
- var values []string
- for i, w := range spec.Names {
- obj, ok := info.ObjectOf(w).(*types.Const)
- if !ok || obj.Val().Kind() == constant.Unknown {
- return nil
+
+ for _, v := range genDecl.Specs {
+ spec, ok := v.(*ast.ValueSpec)
+ if !ok {
+ continue
}
- if checkValues {
- switch spec.Values[i].(type) {
- case *ast.BadExpr:
- return nil
- case *ast.BasicLit:
- default:
- if obj.Val().Kind() != constant.Bool {
- showHints = true
+ end, err := pgf.PosPosition(v.End())
+ if err != nil {
+ continue
+ }
+ // Show hints when values are missing or at least one value is not
+ // a basic literal.
+ showHints := len(spec.Values) == 0
+ checkValues := len(spec.Names) == len(spec.Values)
+ var values []string
+ for i, w := range spec.Names {
+ obj, ok := info.ObjectOf(w).(*types.Const)
+ if !ok || obj.Val().Kind() == constant.Unknown {
+ continue
+ }
+ if checkValues {
+ switch spec.Values[i].(type) {
+ case *ast.BadExpr:
+ continue
+ case *ast.BasicLit:
+ default:
+ if obj.Val().Kind() != constant.Bool {
+ showHints = true
+ }
}
}
+ values = append(values, fmt.Sprintf("%v", obj.Val()))
}
- values = append(values, fmt.Sprintf("%v", obj.Val()))
- }
- if !showHints || len(values) == 0 {
- continue
+ if !showHints || len(values) == 0 {
+ continue
+ }
+ add(protocol.InlayHint{
+ Position: end,
+ Label: buildLabel("= " + strings.Join(values, ", ")),
+ PaddingLeft: true,
+ })
}
- hints = append(hints, protocol.InlayHint{
- Position: end,
- Label: buildLabel("= " + strings.Join(values, ", ")),
- PaddingLeft: true,
- })
}
- return hints
}
-func compositeLiteralFields(node ast.Node, m *protocol.Mapper, tf *token.File, info *types.Info, _ *types.Qualifier) []protocol.InlayHint {
- compLit, ok := node.(*ast.CompositeLit)
- if !ok {
- return nil
- }
- typ := info.TypeOf(compLit)
- if typ == nil {
- return nil
- }
- typ = typesinternal.Unpointer(typ)
- strct, ok := typeparams.CoreType(typ).(*types.Struct)
- if !ok {
- return nil
- }
+func compositeLiteralFields(info *types.Info, pgf *parsego.File, qual types.Qualifier, cur cursor.Cursor, add func(protocol.InlayHint)) {
+ for curCompLit := range cur.Preorder((*ast.CompositeLit)(nil)) {
+ compLit, ok := curCompLit.Node().(*ast.CompositeLit)
+ if !ok {
+ continue
+ }
+ typ := info.TypeOf(compLit)
+ if typ == nil {
+ continue
+ }
+ typ = typesinternal.Unpointer(typ)
+ strct, ok := typeparams.CoreType(typ).(*types.Struct)
+ if !ok {
+ continue
+ }
- var hints []protocol.InlayHint
- var allEdits []protocol.TextEdit
- for i, v := range compLit.Elts {
- if _, ok := v.(*ast.KeyValueExpr); !ok {
- start, err := m.PosPosition(tf, v.Pos())
- if err != nil {
- continue
- }
- if i > strct.NumFields()-1 {
- break
+ var hints []protocol.InlayHint
+ var allEdits []protocol.TextEdit
+ for i, v := range compLit.Elts {
+ if _, ok := v.(*ast.KeyValueExpr); !ok {
+ start, err := pgf.PosPosition(v.Pos())
+ if err != nil {
+ continue
+ }
+ if i > strct.NumFields()-1 {
+ break
+ }
+ hints = append(hints, protocol.InlayHint{
+ Position: start,
+ Label: buildLabel(strct.Field(i).Name() + ":"),
+ Kind: protocol.Parameter,
+ PaddingRight: true,
+ })
+ allEdits = append(allEdits, protocol.TextEdit{
+ Range: protocol.Range{Start: start, End: start},
+ NewText: strct.Field(i).Name() + ": ",
+ })
}
- hints = append(hints, protocol.InlayHint{
- Position: start,
- Label: buildLabel(strct.Field(i).Name() + ":"),
- Kind: protocol.Parameter,
- PaddingRight: true,
- })
- allEdits = append(allEdits, protocol.TextEdit{
- Range: protocol.Range{Start: start, End: start},
- NewText: strct.Field(i).Name() + ": ",
- })
+ }
+ // It is not allowed to have a mix of keyed and unkeyed fields, so
+ // have the text edits add keys to all fields.
+ for i := range hints {
+ hints[i].TextEdits = allEdits
+ add(hints[i])
}
}
- // It is not allowed to have a mix of keyed and unkeyed fields, so
- // have the text edits add keys to all fields.
- for i := range hints {
- hints[i].TextEdits = allEdits
- }
- return hints
}
-func compositeLiteralTypes(node ast.Node, m *protocol.Mapper, tf *token.File, info *types.Info, q *types.Qualifier) []protocol.InlayHint {
- compLit, ok := node.(*ast.CompositeLit)
- if !ok {
- return nil
- }
- typ := info.TypeOf(compLit)
- if typ == nil {
- return nil
- }
- if compLit.Type != nil {
- return nil
- }
- prefix := ""
- if t, ok := typeparams.CoreType(typ).(*types.Pointer); ok {
- typ = t.Elem()
- prefix = "&"
- }
- // The type for this composite literal is implicit, add an inlay hint.
- start, err := m.PosPosition(tf, compLit.Lbrace)
- if err != nil {
- return nil
+func compositeLiteralTypes(info *types.Info, pgf *parsego.File, qual types.Qualifier, cur cursor.Cursor, add func(protocol.InlayHint)) {
+ for curCompLit := range cur.Preorder((*ast.CompositeLit)(nil)) {
+ compLit := curCompLit.Node().(*ast.CompositeLit)
+ typ := info.TypeOf(compLit)
+ if typ == nil {
+ continue
+ }
+ if compLit.Type != nil {
+ continue
+ }
+ prefix := ""
+ if t, ok := typeparams.CoreType(typ).(*types.Pointer); ok {
+ typ = t.Elem()
+ prefix = "&"
+ }
+ // The type for this composite literal is implicit, add an inlay hint.
+ start, err := pgf.PosPosition(compLit.Lbrace)
+ if err != nil {
+ continue
+ }
+ add(protocol.InlayHint{
+ Position: start,
+ Label: buildLabel(fmt.Sprintf("%s%s", prefix, types.TypeString(typ, qual))),
+ Kind: protocol.Type,
+ })
}
- return []protocol.InlayHint{{
- Position: start,
- Label: buildLabel(fmt.Sprintf("%s%s", prefix, types.TypeString(typ, *q))),
- Kind: protocol.Type,
- }}
}
func buildLabel(s string) []protocol.InlayHintLabelPart {
diff --git a/gopls/internal/golang/invertifcondition.go b/gopls/internal/golang/invertifcondition.go
index 0fb7d1e4d0a..012278df79e 100644
--- a/gopls/internal/golang/invertifcondition.go
+++ b/gopls/internal/golang/invertifcondition.go
@@ -8,17 +8,24 @@ import (
"fmt"
"go/ast"
"go/token"
- "go/types"
"strings"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/ast/astutil"
+ "golang.org/x/tools/gopls/internal/cache"
+ "golang.org/x/tools/gopls/internal/cache/parsego"
"golang.org/x/tools/gopls/internal/util/safetoken"
+ "golang.org/x/tools/internal/astutil/cursor"
)
// invertIfCondition is a singleFileFixFunc that inverts an if/else statement
-func invertIfCondition(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, _ *types.Package, _ *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
- ifStatement, _, err := canInvertIfCondition(file, start, end)
+func invertIfCondition(pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
+ var (
+ fset = pkg.FileSet()
+ src = pgf.Src
+ )
+
+ ifStatement, _, err := canInvertIfCondition(pgf.Cursor, start, end)
if err != nil {
return nil, nil, err
}
@@ -241,7 +248,9 @@ func invertAndOr(fset *token.FileSet, expr *ast.BinaryExpr, src []byte) ([]byte,
// canInvertIfCondition reports whether we can do invert-if-condition on the
// code in the given range.
-func canInvertIfCondition(file *ast.File, start, end token.Pos) (*ast.IfStmt, bool, error) {
+func canInvertIfCondition(curFile cursor.Cursor, start, end token.Pos) (*ast.IfStmt, bool, error) {
+ file := curFile.Node().(*ast.File)
+ // TODO(adonovan): simplify, using Cursor.
path, _ := astutil.PathEnclosingInterval(file, start, end)
for _, node := range path {
stmt, isIfStatement := node.(*ast.IfStmt)
diff --git a/gopls/internal/golang/lines.go b/gopls/internal/golang/lines.go
index b6a9823957d..cb161671726 100644
--- a/gopls/internal/golang/lines.go
+++ b/gopls/internal/golang/lines.go
@@ -12,20 +12,22 @@ import (
"bytes"
"go/ast"
"go/token"
- "go/types"
"slices"
"sort"
"strings"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/ast/astutil"
+ "golang.org/x/tools/gopls/internal/cache"
+ "golang.org/x/tools/gopls/internal/cache/parsego"
"golang.org/x/tools/gopls/internal/util/safetoken"
+ "golang.org/x/tools/internal/astutil/cursor"
)
// canSplitLines checks whether we can split lists of elements inside
// an enclosing curly bracket/parens into separate lines.
-func canSplitLines(file *ast.File, fset *token.FileSet, start, end token.Pos) (string, bool, error) {
- itemType, items, comments, _, _, _ := findSplitJoinTarget(fset, file, nil, start, end)
+func canSplitLines(curFile cursor.Cursor, fset *token.FileSet, start, end token.Pos) (string, bool, error) {
+ itemType, items, comments, _, _, _ := findSplitJoinTarget(fset, curFile, nil, start, end)
if itemType == "" {
return "", false, nil
}
@@ -47,8 +49,8 @@ func canSplitLines(file *ast.File, fset *token.FileSet, start, end token.Pos) (s
// canJoinLines checks whether we can join lists of elements inside an
// enclosing curly bracket/parens into a single line.
-func canJoinLines(file *ast.File, fset *token.FileSet, start, end token.Pos) (string, bool, error) {
- itemType, items, comments, _, _, _ := findSplitJoinTarget(fset, file, nil, start, end)
+func canJoinLines(curFile cursor.Cursor, fset *token.FileSet, start, end token.Pos) (string, bool, error) {
+ itemType, items, comments, _, _, _ := findSplitJoinTarget(fset, curFile, nil, start, end)
if itemType == "" {
return "", false, nil
}
@@ -84,23 +86,25 @@ func canSplitJoinLines(items []ast.Node, comments []*ast.CommentGroup) bool {
}
// splitLines is a singleFile fixer.
-func splitLines(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, _ *types.Package, _ *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
- itemType, items, comments, indent, braceOpen, braceClose := findSplitJoinTarget(fset, file, src, start, end)
+func splitLines(pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
+ fset := pkg.FileSet()
+ itemType, items, comments, indent, braceOpen, braceClose := findSplitJoinTarget(fset, pgf.Cursor, pgf.Src, start, end)
if itemType == "" {
return nil, nil, nil // no fix available
}
- return fset, processLines(fset, items, comments, src, braceOpen, braceClose, ",\n", "\n", ",\n"+indent, indent+"\t"), nil
+ return fset, processLines(fset, items, comments, pgf.Src, braceOpen, braceClose, ",\n", "\n", ",\n"+indent, indent+"\t"), nil
}
// joinLines is a singleFile fixer.
-func joinLines(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, _ *types.Package, _ *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
- itemType, items, comments, _, braceOpen, braceClose := findSplitJoinTarget(fset, file, src, start, end)
+func joinLines(pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
+ fset := pkg.FileSet()
+ itemType, items, comments, _, braceOpen, braceClose := findSplitJoinTarget(fset, pgf.Cursor, pgf.Src, start, end)
if itemType == "" {
return nil, nil, nil // no fix available
}
- return fset, processLines(fset, items, comments, src, braceOpen, braceClose, ", ", "", "", ""), nil
+ return fset, processLines(fset, items, comments, pgf.Src, braceOpen, braceClose, ", ", "", "", ""), nil
}
// processLines is the common operation for both split and join lines because this split/join operation is
@@ -166,11 +170,14 @@ func processLines(fset *token.FileSet, items []ast.Node, comments []*ast.Comment
}
// findSplitJoinTarget returns the first curly bracket/parens that encloses the current cursor.
-func findSplitJoinTarget(fset *token.FileSet, file *ast.File, src []byte, start, end token.Pos) (itemType string, items []ast.Node, comments []*ast.CommentGroup, indent string, open, close token.Pos) {
+func findSplitJoinTarget(fset *token.FileSet, curFile cursor.Cursor, src []byte, start, end token.Pos) (itemType string, items []ast.Node, comments []*ast.CommentGroup, indent string, open, close token.Pos) {
isCursorInside := func(nodePos, nodeEnd token.Pos) bool {
return nodePos < start && end < nodeEnd
}
+ file := curFile.Node().(*ast.File)
+ // TODO(adonovan): simplify, using Cursor.
+
findTarget := func() (targetType string, target ast.Node, open, close token.Pos) {
path, _ := astutil.PathEnclosingInterval(file, start, end)
for _, node := range path {
diff --git a/gopls/internal/golang/pkgdoc.go b/gopls/internal/golang/pkgdoc.go
index a5f9cc97fa4..2faff1a1526 100644
--- a/gopls/internal/golang/pkgdoc.go
+++ b/gopls/internal/golang/pkgdoc.go
@@ -39,7 +39,6 @@ import (
"go/token"
"go/types"
"html"
- "iter"
"path/filepath"
"slices"
"strings"
@@ -666,7 +665,7 @@ window.addEventListener('load', function() {
cloneTparams(sig.RecvTypeParams()),
cloneTparams(sig.TypeParams()),
types.NewTuple(append(
- slices.Collect(tupleVariables(sig.Params()))[:3],
+ slices.Collect(sig.Params().Variables())[:3],
types.NewParam(0, nil, "", types.Typ[types.Invalid]))...),
sig.Results(),
false) // any final ...T parameter is truncated
@@ -851,17 +850,3 @@ window.addEventListener('load', function() {
return buf.Bytes(), nil
}
-
-// tupleVariables returns a go1.23 iterator over the variables of a tuple type.
-//
-// Example: for v := range tuple.Variables() { ... }
-// TODO(adonovan): use t.Variables in go1.24.
-func tupleVariables(t *types.Tuple) iter.Seq[*types.Var] {
- return func(yield func(v *types.Var) bool) {
- for i := range t.Len() {
- if !yield(t.At(i)) {
- break
- }
- }
- }
-}
diff --git a/gopls/internal/golang/references.go b/gopls/internal/golang/references.go
index 3ecaab6e3e1..12152453dcd 100644
--- a/gopls/internal/golang/references.go
+++ b/gopls/internal/golang/references.go
@@ -602,14 +602,12 @@ func localReferences(pkg *cache.Package, targets map[types.Object]bool, correspo
// Scan through syntax looking for uses of one of the target objects.
for _, pgf := range pkg.CompiledGoFiles() {
- ast.Inspect(pgf.File, func(n ast.Node) bool {
- if id, ok := n.(*ast.Ident); ok {
- if obj, ok := pkg.TypesInfo().Uses[id]; ok && matches(obj) {
- report(mustLocation(pgf, id), false)
- }
+ for curId := range pgf.Cursor.Preorder((*ast.Ident)(nil)) {
+ id := curId.Node().(*ast.Ident)
+ if obj, ok := pkg.TypesInfo().Uses[id]; ok && matches(obj) {
+ report(mustLocation(pgf, id), false)
}
- return true
- })
+ }
}
return nil
}
diff --git a/gopls/internal/golang/rename_check.go b/gopls/internal/golang/rename_check.go
index 280795abe5e..97423fe87a7 100644
--- a/gopls/internal/golang/rename_check.go
+++ b/gopls/internal/golang/rename_check.go
@@ -51,7 +51,7 @@ import (
)
// errorf reports an error (e.g. conflict) and prevents file modification.
-func (r *renamer) errorf(pos token.Pos, format string, args ...interface{}) {
+func (r *renamer) errorf(pos token.Pos, format string, args ...any) {
// Conflict error messages in the old gorename tool (whence this
// logic originated) contain rich information associated with
// multiple source lines, such as:
diff --git a/gopls/internal/golang/semtok.go b/gopls/internal/golang/semtok.go
index cb3f2cfd478..121531d8280 100644
--- a/gopls/internal/golang/semtok.go
+++ b/gopls/internal/golang/semtok.go
@@ -616,7 +616,7 @@ func (tv *tokenVisitor) ident(id *ast.Ident) {
obj types.Object
ok bool
)
- if obj, ok = tv.info.Defs[id]; obj != nil {
+ if obj, _ = tv.info.Defs[id]; obj != nil {
// definition
mods = append(mods, semtok.ModDefinition)
tok, mods = tv.appendObjectModifiers(mods, obj)
diff --git a/gopls/internal/golang/snapshot.go b/gopls/internal/golang/snapshot.go
index c381c962d08..30199d45463 100644
--- a/gopls/internal/golang/snapshot.go
+++ b/gopls/internal/golang/snapshot.go
@@ -14,19 +14,9 @@ import (
"golang.org/x/tools/gopls/internal/protocol"
)
-// NarrowestMetadataForFile returns metadata for the narrowest package
-// (the one with the fewest files) that encloses the specified file.
-// The result may be a test variant, but never an intermediate test variant.
+//go:fix inline
func NarrowestMetadataForFile(ctx context.Context, snapshot *cache.Snapshot, uri protocol.DocumentURI) (*metadata.Package, error) {
- mps, err := snapshot.MetadataForFile(ctx, uri)
- if err != nil {
- return nil, err
- }
- metadata.RemoveIntermediateTestVariants(&mps)
- if len(mps) == 0 {
- return nil, fmt.Errorf("no package metadata for file %s", uri)
- }
- return mps[0], nil
+ return snapshot.NarrowestMetadataForFile(ctx, uri)
}
// NarrowestPackageForFile is a convenience function that selects the narrowest
diff --git a/gopls/internal/golang/stub.go b/gopls/internal/golang/stub.go
index a04a82988c5..c85080f8a0c 100644
--- a/gopls/internal/golang/stub.go
+++ b/gopls/internal/golang/stub.go
@@ -31,8 +31,7 @@ import (
// methods of the concrete type that is assigned to an interface type
// at the cursor position.
func stubMissingInterfaceMethodsFixer(ctx context.Context, snapshot *cache.Snapshot, pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
- nodes, _ := astutil.PathEnclosingInterval(pgf.File, start, end)
- si := stubmethods.GetIfaceStubInfo(pkg.FileSet(), pkg.TypesInfo(), nodes, start)
+ si := stubmethods.GetIfaceStubInfo(pkg.FileSet(), pkg.TypesInfo(), pgf, start, end)
if si == nil {
return nil, nil, fmt.Errorf("nil interface request")
}
@@ -43,8 +42,7 @@ func stubMissingInterfaceMethodsFixer(ctx context.Context, snapshot *cache.Snaps
// method that the user may want to generate based on CallExpr
// at the cursor position.
func stubMissingCalledFunctionFixer(ctx context.Context, snapshot *cache.Snapshot, pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
- nodes, _ := astutil.PathEnclosingInterval(pgf.File, start, end)
- si := stubmethods.GetCallStubInfo(pkg.FileSet(), pkg.TypesInfo(), nodes, start)
+ si := stubmethods.GetCallStubInfo(pkg.FileSet(), pkg.TypesInfo(), pgf, start, end)
if si == nil {
return nil, nil, fmt.Errorf("invalid type request")
}
diff --git a/gopls/internal/golang/stubmethods/stubcalledfunc.go b/gopls/internal/golang/stubmethods/stubcalledfunc.go
index 1b1b6aba7de..b4b59340d83 100644
--- a/gopls/internal/golang/stubmethods/stubcalledfunc.go
+++ b/gopls/internal/golang/stubmethods/stubcalledfunc.go
@@ -13,6 +13,8 @@ import (
"strings"
"unicode"
+ "golang.org/x/tools/go/ast/astutil"
+ "golang.org/x/tools/gopls/internal/cache/parsego"
"golang.org/x/tools/gopls/internal/util/typesutil"
"golang.org/x/tools/internal/typesinternal"
)
@@ -34,7 +36,9 @@ type CallStubInfo struct {
// GetCallStubInfo extracts necessary information to generate a method definition from
// a CallExpr.
-func GetCallStubInfo(fset *token.FileSet, info *types.Info, path []ast.Node, pos token.Pos) *CallStubInfo {
+func GetCallStubInfo(fset *token.FileSet, info *types.Info, pgf *parsego.File, start, end token.Pos) *CallStubInfo {
+ // TODO(adonovan): simplify, using pgf.Cursor.
+ path, _ := astutil.PathEnclosingInterval(pgf.File, start, end)
for i, n := range path {
switch n := n.(type) {
case *ast.CallExpr:
diff --git a/gopls/internal/golang/stubmethods/stubmethods.go b/gopls/internal/golang/stubmethods/stubmethods.go
index f380f5b984d..43842264d70 100644
--- a/gopls/internal/golang/stubmethods/stubmethods.go
+++ b/gopls/internal/golang/stubmethods/stubmethods.go
@@ -15,8 +15,10 @@ import (
"go/types"
"strings"
+ "golang.org/x/tools/go/ast/astutil"
"golang.org/x/tools/internal/typesinternal"
+ "golang.org/x/tools/gopls/internal/cache/parsego"
"golang.org/x/tools/gopls/internal/util/bug"
"golang.org/x/tools/gopls/internal/util/typesutil"
)
@@ -49,7 +51,12 @@ type IfaceStubInfo struct {
// function call. This is essentially what the refactor/satisfy does,
// more generally. Refactor to share logic, after auditing 'satisfy'
// for safety on ill-typed code.
-func GetIfaceStubInfo(fset *token.FileSet, info *types.Info, path []ast.Node, pos token.Pos) *IfaceStubInfo {
+func GetIfaceStubInfo(fset *token.FileSet, info *types.Info, pgf *parsego.File, pos, end token.Pos) *IfaceStubInfo {
+ // TODO(adonovan): simplify, using Cursor:
+ // curErr, _ := pgf.Cursor.FindPos(pos, end)
+ // for cur := range curErr.Enclosing() {
+ // switch n := cur.Node().(type) {...
+ path, _ := astutil.PathEnclosingInterval(pgf.File, pos, end)
for _, n := range path {
switch n := n.(type) {
case *ast.ValueSpec:
diff --git a/gopls/internal/golang/symbols.go b/gopls/internal/golang/symbols.go
index 14f2703441c..53fbb663800 100644
--- a/gopls/internal/golang/symbols.go
+++ b/gopls/internal/golang/symbols.go
@@ -82,21 +82,29 @@ func DocumentSymbols(ctx context.Context, snapshot *cache.Snapshot, fh file.Hand
// The PackageSymbol data type contains the same fields as protocol.DocumentSymbol, with
// an additional int field "File" that stores the index of that symbol's file in the
// PackageSymbolsResult.Files.
+// Symbols are gathered using syntax rather than type information because type checking is
+// significantly slower. Syntax information provides enough value to the user without
+// causing a lag when loading symbol information across different files.
func PackageSymbols(ctx context.Context, snapshot *cache.Snapshot, uri protocol.DocumentURI) (command.PackageSymbolsResult, error) {
ctx, done := event.Start(ctx, "source.PackageSymbols")
defer done()
- mp, err := NarrowestMetadataForFile(ctx, snapshot, uri)
- if err != nil {
- return command.PackageSymbolsResult{}, err
+ pkgFiles := []protocol.DocumentURI{uri}
+
+ // golang/vscode-go#3681: do our best if the file is not in a package.
+ // TODO(rfindley): revisit this in the future once there is more graceful
+ // handling in VS Code.
+ if mp, err := NarrowestMetadataForFile(ctx, snapshot, uri); err == nil {
+ pkgFiles = mp.CompiledGoFiles
}
- pkgfiles := mp.CompiledGoFiles
- // Maps receiver name to the methods that use it
- receiverToMethods := make(map[string][]command.PackageSymbol)
- // Maps type symbol name to its index in symbols
- typeSymbolToIdx := make(map[string]int)
- var symbols []command.PackageSymbol
- for fidx, f := range pkgfiles {
+
+ var (
+ pkgName string
+ symbols []command.PackageSymbol
+ receiverToMethods = make(map[string][]command.PackageSymbol) // receiver name -> methods
+ typeSymbolToIdx = make(map[string]int) // type name -> index in symbols
+ )
+ for fidx, f := range pkgFiles {
fh, err := snapshot.ReadFile(ctx, f)
if err != nil {
return command.PackageSymbolsResult{}, err
@@ -105,6 +113,9 @@ func PackageSymbols(ctx context.Context, snapshot *cache.Snapshot, uri protocol.
if err != nil {
return command.PackageSymbolsResult{}, err
}
+ if pkgName == "" && pgf.File != nil && pgf.File.Name != nil {
+ pkgName = pgf.File.Name.Name
+ }
for _, decl := range pgf.File.Decls {
switch decl := decl.(type) {
case *ast.FuncDecl:
@@ -154,8 +165,8 @@ func PackageSymbols(ctx context.Context, snapshot *cache.Snapshot, uri protocol.
}
}
return command.PackageSymbolsResult{
- PackageName: string(mp.Name),
- Files: pkgfiles,
+ PackageName: pkgName,
+ Files: pkgFiles,
Symbols: symbols,
}, nil
diff --git a/gopls/internal/golang/undeclared.go b/gopls/internal/golang/undeclared.go
index 0615386e9bf..9df8e2bfd2e 100644
--- a/gopls/internal/golang/undeclared.go
+++ b/gopls/internal/golang/undeclared.go
@@ -16,6 +16,8 @@ import (
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/ast/astutil"
+ "golang.org/x/tools/gopls/internal/cache"
+ "golang.org/x/tools/gopls/internal/cache/parsego"
"golang.org/x/tools/gopls/internal/util/typesutil"
"golang.org/x/tools/internal/typesinternal"
)
@@ -69,8 +71,14 @@ func undeclaredFixTitle(path []ast.Node, errMsg string) string {
}
// createUndeclared generates a suggested declaration for an undeclared variable or function.
-func createUndeclared(fset *token.FileSet, start, end token.Pos, content []byte, file *ast.File, pkg *types.Package, info *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
- pos := start // don't use the end
+func createUndeclared(pkg *cache.Package, pgf *parsego.File, start, end token.Pos) (*token.FileSet, *analysis.SuggestedFix, error) {
+ var (
+ fset = pkg.FileSet()
+ info = pkg.TypesInfo()
+ file = pgf.File
+ pos = start // don't use end
+ )
+ // TODO(adonovan): simplify, using Cursor.
path, _ := astutil.PathEnclosingInterval(file, pos, pos)
if len(path) < 2 {
return nil, nil, fmt.Errorf("no expression found")
@@ -83,7 +91,7 @@ func createUndeclared(fset *token.FileSet, start, end token.Pos, content []byte,
// Check for a possible call expression, in which case we should add a
// new function declaration.
if isCallPosition(path) {
- return newFunctionDeclaration(path, file, pkg, info, fset)
+ return newFunctionDeclaration(path, file, pkg.Types(), info, fset)
}
var (
firstRef *ast.Ident // We should insert the new declaration before the first occurrence of the undefined ident.
@@ -129,7 +137,7 @@ func createUndeclared(fset *token.FileSet, start, end token.Pos, content []byte,
if err != nil {
return nil, nil, fmt.Errorf("could not locate insertion point: %v", err)
}
- indent, err := calculateIndentation(content, fset.File(file.FileStart), insertBeforeStmt)
+ indent, err := calculateIndentation(pgf.Src, fset.File(file.FileStart), insertBeforeStmt)
if err != nil {
return nil, nil, err
}
@@ -138,7 +146,7 @@ func createUndeclared(fset *token.FileSet, start, end token.Pos, content []byte,
// Default to 0.
typs = []types.Type{types.Typ[types.Int]}
}
- expr, _ := typesinternal.ZeroExpr(typs[0], typesinternal.FileQualifier(file, pkg))
+ expr, _ := typesinternal.ZeroExpr(typs[0], typesinternal.FileQualifier(file, pkg.Types()))
assignStmt := &ast.AssignStmt{
Lhs: []ast.Expr{ast.NewIdent(ident.Name)},
Tok: token.DEFINE,
diff --git a/gopls/internal/golang/util.go b/gopls/internal/golang/util.go
index 23fd3443fac..b13056e02b9 100644
--- a/gopls/internal/golang/util.go
+++ b/gopls/internal/golang/util.go
@@ -19,16 +19,11 @@ import (
"golang.org/x/tools/gopls/internal/cache/parsego"
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/gopls/internal/util/bug"
- "golang.org/x/tools/gopls/internal/util/safetoken"
"golang.org/x/tools/internal/tokeninternal"
)
-// IsGenerated gets and reads the file denoted by uri and reports
-// whether it contains a "generated file" comment as described at
-// https://golang.org/s/generatedcode.
-//
-// TODO(adonovan): opt: this function does too much.
-// Move snapshot.ReadFile into the caller (most of which have already done it).
+// IsGenerated reads and parses the header of the file denoted by uri
+// and reports whether it [ast.IsGenerated].
func IsGenerated(ctx context.Context, snapshot *cache.Snapshot, uri protocol.DocumentURI) bool {
fh, err := snapshot.ReadFile(ctx, uri)
if err != nil {
@@ -38,17 +33,7 @@ func IsGenerated(ctx context.Context, snapshot *cache.Snapshot, uri protocol.Doc
if err != nil {
return false
}
- for _, commentGroup := range pgf.File.Comments {
- for _, comment := range commentGroup.List {
- if matched := generatedRx.MatchString(comment.Text); matched {
- // Check if comment is at the beginning of the line in source.
- if safetoken.Position(pgf.Tok, comment.Slash).Column == 1 {
- return true
- }
- }
- }
- }
- return false
+ return ast.IsGenerated(pgf.File)
}
// adjustedObjEnd returns the end position of obj, possibly modified for
@@ -76,11 +61,6 @@ func adjustedObjEnd(obj types.Object) token.Pos {
return obj.Pos() + token.Pos(nameLen)
}
-// Matches cgo generated comment as well as the proposed standard:
-//
-// https://golang.org/s/generatedcode
-var generatedRx = regexp.MustCompile(`// .*DO NOT EDIT\.?`)
-
// FormatNode returns the "pretty-print" output for an ast node.
func FormatNode(fset *token.FileSet, n ast.Node) string {
var buf strings.Builder
@@ -381,9 +361,9 @@ func AbbreviateVarName(s string) string {
return b.String()
}
-// copyrightComment returns the copyright comment group from the input file, or
+// CopyrightComment returns the copyright comment group from the input file, or
// nil if not found.
-func copyrightComment(file *ast.File) *ast.CommentGroup {
+func CopyrightComment(file *ast.File) *ast.CommentGroup {
if len(file.Comments) == 0 {
return nil
}
diff --git a/gopls/internal/golang/workspace_symbol.go b/gopls/internal/golang/workspace_symbol.go
index feba6081515..91c5ee22925 100644
--- a/gopls/internal/golang/workspace_symbol.go
+++ b/gopls/internal/golang/workspace_symbol.go
@@ -293,17 +293,14 @@ func (c comboMatcher) match(chunks []string) (int, float64) {
func collectSymbols(ctx context.Context, snapshots []*cache.Snapshot, matcherType settings.SymbolMatcher, symbolizer symbolizer, query string) ([]protocol.SymbolInformation, error) {
// Extract symbols from all files.
var work []symbolFile
- var roots []string
seen := make(map[protocol.DocumentURI]*metadata.Package) // only scan each file once
for _, snapshot := range snapshots {
// Use the root view URIs for determining (lexically)
// whether a URI is in any open workspace.
folderURI := snapshot.Folder()
- roots = append(roots, strings.TrimRight(string(folderURI), "/"))
- filters := snapshot.Options().DirectoryFilters
- filterer := cache.NewFilterer(filters)
+ pathIncluded := cache.PathIncludeFunc(snapshot.Options().DirectoryFilters)
folder := filepath.ToSlash(folderURI.Path())
var (
@@ -373,7 +370,7 @@ func collectSymbols(ctx context.Context, snapshots []*cache.Snapshot, matcherTyp
uri := sp.Files[i]
norm := filepath.ToSlash(uri.Path())
nm := strings.TrimPrefix(norm, folder)
- if filterer.Disallow(nm) {
+ if !pathIncluded(nm) {
continue
}
// Only scan each file once.
diff --git a/gopls/internal/golang/workspace_symbol_test.go b/gopls/internal/golang/workspace_symbol_test.go
index 4982b767754..fbfec8e1204 100644
--- a/gopls/internal/golang/workspace_symbol_test.go
+++ b/gopls/internal/golang/workspace_symbol_test.go
@@ -47,7 +47,7 @@ func TestParseQuery(t *testing.T) {
}
}
-func TestFiltererDisallow(t *testing.T) {
+func TestPathIncludeFunc(t *testing.T) {
tests := []struct {
filters []string
included []string
@@ -119,18 +119,24 @@ func TestFiltererDisallow(t *testing.T) {
[]string{"a/b/c.go", "bb"},
[]string{"b/c/d.go", "b"},
},
+ // golang/vscode-go#3692
+ {
+ []string{"-**/foo", "+**/bar"},
+ []string{"bar/a.go", "a/bar/b.go"},
+ []string{"foo/a.go", "a/foo/b.go"},
+ },
}
for _, test := range tests {
- filterer := cache.NewFilterer(test.filters)
+ pathIncluded := cache.PathIncludeFunc(test.filters)
for _, inc := range test.included {
- if filterer.Disallow(inc) {
+ if !pathIncluded(inc) {
t.Errorf("Filters %v excluded %v, wanted included", test.filters, inc)
}
}
for _, exc := range test.excluded {
- if !filterer.Disallow(exc) {
+ if pathIncluded(exc) {
t.Errorf("Filters %v included %v, wanted excluded", test.filters, exc)
}
}
diff --git a/gopls/internal/lsprpc/binder_test.go b/gopls/internal/lsprpc/binder_test.go
index 042056e7777..07a8b2cdf99 100644
--- a/gopls/internal/lsprpc/binder_test.go
+++ b/gopls/internal/lsprpc/binder_test.go
@@ -56,7 +56,7 @@ func (b *ServerBinder) Bind(ctx context.Context, conn *jsonrpc2_v2.Connection) j
serverHandler := protocol.ServerHandlerV2(server)
// Wrap the server handler to inject the client into each request context, so
// that log events are reflected back to the client.
- wrapped := jsonrpc2_v2.HandlerFunc(func(ctx context.Context, req *jsonrpc2_v2.Request) (interface{}, error) {
+ wrapped := jsonrpc2_v2.HandlerFunc(func(ctx context.Context, req *jsonrpc2_v2.Request) (any, error) {
ctx = protocol.WithClient(ctx, client)
return serverHandler.Handle(ctx, req)
})
diff --git a/gopls/internal/lsprpc/commandinterceptor_test.go b/gopls/internal/lsprpc/commandinterceptor_test.go
index 7c83ef993f0..3cfa2e35a7f 100644
--- a/gopls/internal/lsprpc/commandinterceptor_test.go
+++ b/gopls/internal/lsprpc/commandinterceptor_test.go
@@ -15,9 +15,9 @@ import (
. "golang.org/x/tools/gopls/internal/lsprpc"
)
-func CommandInterceptor(command string, run func(*protocol.ExecuteCommandParams) (interface{}, error)) Middleware {
+func CommandInterceptor(command string, run func(*protocol.ExecuteCommandParams) (any, error)) Middleware {
return BindHandler(func(delegate jsonrpc2_v2.Handler) jsonrpc2_v2.Handler {
- return jsonrpc2_v2.HandlerFunc(func(ctx context.Context, req *jsonrpc2_v2.Request) (interface{}, error) {
+ return jsonrpc2_v2.HandlerFunc(func(ctx context.Context, req *jsonrpc2_v2.Request) (any, error) {
if req.Method == "workspace/executeCommand" {
var params protocol.ExecuteCommandParams
if err := json.Unmarshal(req.Params, ¶ms); err == nil {
@@ -35,9 +35,9 @@ func CommandInterceptor(command string, run func(*protocol.ExecuteCommandParams)
func TestCommandInterceptor(t *testing.T) {
const command = "foo"
caught := false
- intercept := func(_ *protocol.ExecuteCommandParams) (interface{}, error) {
+ intercept := func(_ *protocol.ExecuteCommandParams) (any, error) {
caught = true
- return map[string]interface{}{}, nil
+ return map[string]any{}, nil
}
ctx := context.Background()
@@ -50,7 +50,7 @@ func TestCommandInterceptor(t *testing.T) {
params := &protocol.ExecuteCommandParams{
Command: command,
}
- var res interface{}
+ var res any
err := conn.Call(ctx, "workspace/executeCommand", params).Await(ctx, &res)
if err != nil {
t.Fatal(err)
diff --git a/gopls/internal/lsprpc/export_test.go b/gopls/internal/lsprpc/export_test.go
index 509129870dc..8cbdecc98a2 100644
--- a/gopls/internal/lsprpc/export_test.go
+++ b/gopls/internal/lsprpc/export_test.go
@@ -26,7 +26,7 @@ type Canceler struct {
Conn *jsonrpc2_v2.Connection
}
-func (c *Canceler) Preempt(ctx context.Context, req *jsonrpc2_v2.Request) (interface{}, error) {
+func (c *Canceler) Preempt(ctx context.Context, req *jsonrpc2_v2.Request) (any, error) {
if req.Method != "$/cancelRequest" {
return nil, jsonrpc2_v2.ErrNotHandled
}
@@ -65,7 +65,7 @@ func (b *ForwardBinder) Bind(ctx context.Context, conn *jsonrpc2_v2.Connection)
serverConn, err := jsonrpc2_v2.Dial(context.Background(), b.dialer, clientBinder)
if err != nil {
return jsonrpc2_v2.ConnectionOptions{
- Handler: jsonrpc2_v2.HandlerFunc(func(context.Context, *jsonrpc2_v2.Request) (interface{}, error) {
+ Handler: jsonrpc2_v2.HandlerFunc(func(context.Context, *jsonrpc2_v2.Request) (any, error) {
return nil, fmt.Errorf("%w: %v", jsonrpc2_v2.ErrInternal, err)
}),
}
diff --git a/gopls/internal/lsprpc/goenv.go b/gopls/internal/lsprpc/goenv.go
index 52ec08ff7eb..2b8b94345ca 100644
--- a/gopls/internal/lsprpc/goenv.go
+++ b/gopls/internal/lsprpc/goenv.go
@@ -12,7 +12,7 @@ import (
"golang.org/x/tools/internal/gocommand"
)
-func getGoEnv(ctx context.Context, env map[string]interface{}) (map[string]string, error) {
+func getGoEnv(ctx context.Context, env map[string]any) (map[string]string, error) {
var runEnv []string
for k, v := range env {
runEnv = append(runEnv, fmt.Sprintf("%s=%s", k, v))
diff --git a/gopls/internal/lsprpc/goenv_test.go b/gopls/internal/lsprpc/goenv_test.go
index 6c41540fafb..bc39228c614 100644
--- a/gopls/internal/lsprpc/goenv_test.go
+++ b/gopls/internal/lsprpc/goenv_test.go
@@ -21,7 +21,7 @@ import (
func GoEnvMiddleware() (Middleware, error) {
return BindHandler(func(delegate jsonrpc2_v2.Handler) jsonrpc2_v2.Handler {
- return jsonrpc2_v2.HandlerFunc(func(ctx context.Context, req *jsonrpc2_v2.Request) (interface{}, error) {
+ return jsonrpc2_v2.HandlerFunc(func(ctx context.Context, req *jsonrpc2_v2.Request) (any, error) {
if req.Method == "initialize" {
if err := addGoEnvToInitializeRequestV2(ctx, req); err != nil {
event.Error(ctx, "adding go env to initialize", err)
@@ -39,20 +39,20 @@ func addGoEnvToInitializeRequestV2(ctx context.Context, req *jsonrpc2_v2.Request
if err := json.Unmarshal(req.Params, ¶ms); err != nil {
return err
}
- var opts map[string]interface{}
+ var opts map[string]any
switch v := params.InitializationOptions.(type) {
case nil:
- opts = make(map[string]interface{})
- case map[string]interface{}:
+ opts = make(map[string]any)
+ case map[string]any:
opts = v
default:
return fmt.Errorf("unexpected type for InitializationOptions: %T", v)
}
envOpt, ok := opts["env"]
if !ok {
- envOpt = make(map[string]interface{})
+ envOpt = make(map[string]any)
}
- env, ok := envOpt.(map[string]interface{})
+ env, ok := envOpt.(map[string]any)
if !ok {
return fmt.Errorf("env option is %T, expected a map", envOpt)
}
@@ -108,8 +108,8 @@ func TestGoEnvMiddleware(t *testing.T) {
conn := env.dial(ctx, t, l.Dialer(), noopBinder, true)
dispatch := protocol.ServerDispatcherV2(conn)
initParams := &protocol.ParamInitialize{}
- initParams.InitializationOptions = map[string]interface{}{
- "env": map[string]interface{}{
+ initParams.InitializationOptions = map[string]any{
+ "env": map[string]any{
"GONOPROXY": "example.com",
},
}
@@ -120,7 +120,7 @@ func TestGoEnvMiddleware(t *testing.T) {
if server.params == nil {
t.Fatalf("initialize params are unset")
}
- envOpts := server.params.InitializationOptions.(map[string]interface{})["env"].(map[string]interface{})
+ envOpts := server.params.InitializationOptions.(map[string]any)["env"].(map[string]any)
// Check for an arbitrary Go variable. It should be set.
if _, ok := envOpts["GOPRIVATE"]; !ok {
diff --git a/gopls/internal/lsprpc/lsprpc.go b/gopls/internal/lsprpc/lsprpc.go
index b77557c9a4b..3d26bdd6896 100644
--- a/gopls/internal/lsprpc/lsprpc.go
+++ b/gopls/internal/lsprpc/lsprpc.go
@@ -323,20 +323,20 @@ func addGoEnvToInitializeRequest(ctx context.Context, r jsonrpc2.Request) (jsonr
if err := json.Unmarshal(r.Params(), ¶ms); err != nil {
return nil, err
}
- var opts map[string]interface{}
+ var opts map[string]any
switch v := params.InitializationOptions.(type) {
case nil:
- opts = make(map[string]interface{})
- case map[string]interface{}:
+ opts = make(map[string]any)
+ case map[string]any:
opts = v
default:
return nil, fmt.Errorf("unexpected type for InitializationOptions: %T", v)
}
envOpt, ok := opts["env"]
if !ok {
- envOpt = make(map[string]interface{})
+ envOpt = make(map[string]any)
}
- env, ok := envOpt.(map[string]interface{})
+ env, ok := envOpt.(map[string]any)
if !ok {
return nil, fmt.Errorf(`env option is %T, expected a map`, envOpt)
}
@@ -368,7 +368,7 @@ func (f *forwarder) replyWithDebugAddress(outerCtx context.Context, r jsonrpc2.R
event.Log(outerCtx, "no debug instance to start")
return r
}
- return func(ctx context.Context, result interface{}, outerErr error) error {
+ return func(ctx context.Context, result any, outerErr error) error {
if outerErr != nil {
return r(ctx, result, outerErr)
}
@@ -392,7 +392,7 @@ func (f *forwarder) replyWithDebugAddress(outerCtx context.Context, r jsonrpc2.R
addr, err = di.Serve(outerCtx, addr)
if err != nil {
event.Error(outerCtx, "starting debug server", err)
- return r(ctx, result, outerErr)
+ return r(ctx, result, err)
}
urls := []string{"http://" + addr}
modified.URLs = append(urls, modified.URLs...)
diff --git a/gopls/internal/lsprpc/lsprpc_test.go b/gopls/internal/lsprpc/lsprpc_test.go
index c4ccab71a3e..eda00b28c7a 100644
--- a/gopls/internal/lsprpc/lsprpc_test.go
+++ b/gopls/internal/lsprpc/lsprpc_test.go
@@ -58,7 +58,7 @@ func TestClientLogging(t *testing.T) {
server := PingServer{}
client := FakeClient{Logs: make(chan string, 10)}
- ctx = debug.WithInstance(ctx, "")
+ ctx = debug.WithInstance(ctx)
ss := NewStreamServer(cache.New(nil), false, nil).(*StreamServer)
ss.serverForTest = server
ts := servertest.NewPipeServer(ss, nil)
@@ -121,7 +121,7 @@ func checkClose(t *testing.T, closer func() error) {
func setupForwarding(ctx context.Context, t *testing.T, s protocol.Server) (direct, forwarded servertest.Connector, cleanup func()) {
t.Helper()
- serveCtx := debug.WithInstance(ctx, "")
+ serveCtx := debug.WithInstance(ctx)
ss := NewStreamServer(cache.New(nil), false, nil).(*StreamServer)
ss.serverForTest = s
tsDirect := servertest.NewTCPServer(serveCtx, ss, nil)
@@ -214,8 +214,8 @@ func TestDebugInfoLifecycle(t *testing.T) {
baseCtx, cancel := context.WithCancel(context.Background())
defer cancel()
- clientCtx := debug.WithInstance(baseCtx, "")
- serverCtx := debug.WithInstance(baseCtx, "")
+ clientCtx := debug.WithInstance(baseCtx)
+ serverCtx := debug.WithInstance(baseCtx)
cache := cache.New(nil)
ss := NewStreamServer(cache, false, nil)
@@ -302,8 +302,8 @@ func TestEnvForwarding(t *testing.T) {
conn.Go(ctx, jsonrpc2.MethodNotFound)
dispatch := protocol.ServerDispatcher(conn)
initParams := &protocol.ParamInitialize{}
- initParams.InitializationOptions = map[string]interface{}{
- "env": map[string]interface{}{
+ initParams.InitializationOptions = map[string]any{
+ "env": map[string]any{
"GONOPROXY": "example.com",
},
}
@@ -314,7 +314,7 @@ func TestEnvForwarding(t *testing.T) {
if server.params == nil {
t.Fatalf("initialize params are unset")
}
- env := server.params.InitializationOptions.(map[string]interface{})["env"].(map[string]interface{})
+ env := server.params.InitializationOptions.(map[string]any)["env"].(map[string]any)
// Check for an arbitrary Go variable. It should be set.
if _, ok := env["GOPRIVATE"]; !ok {
diff --git a/gopls/internal/lsprpc/middleware_test.go b/gopls/internal/lsprpc/middleware_test.go
index 526c7343b78..afa6ae78d2f 100644
--- a/gopls/internal/lsprpc/middleware_test.go
+++ b/gopls/internal/lsprpc/middleware_test.go
@@ -154,7 +154,7 @@ func (h *Handshaker) Middleware(inner jsonrpc2_v2.Binder) jsonrpc2_v2.Binder {
// Wrap the delegated handler to accept the handshake.
delegate := opts.Handler
- opts.Handler = jsonrpc2_v2.HandlerFunc(func(ctx context.Context, req *jsonrpc2_v2.Request) (interface{}, error) {
+ opts.Handler = jsonrpc2_v2.HandlerFunc(func(ctx context.Context, req *jsonrpc2_v2.Request) (any, error) {
if req.Method == HandshakeMethod {
var peerInfo PeerInfo
if err := json.Unmarshal(req.Params, &peerInfo); err != nil {
diff --git a/gopls/internal/mod/diagnostics.go b/gopls/internal/mod/diagnostics.go
index a89c148d7a7..8ad1ece05e7 100644
--- a/gopls/internal/mod/diagnostics.go
+++ b/gopls/internal/mod/diagnostics.go
@@ -34,7 +34,7 @@ func ParseDiagnostics(ctx context.Context, snapshot *cache.Snapshot) (map[protoc
return collectDiagnostics(ctx, snapshot, parseDiagnostics)
}
-// Diagnostics returns diagnostics from running go mod tidy.
+// TidyDiagnostics returns diagnostics from running go mod tidy.
func TidyDiagnostics(ctx context.Context, snapshot *cache.Snapshot) (map[protocol.DocumentURI][]*cache.Diagnostic, error) {
ctx, done := event.Start(ctx, "mod.Diagnostics", snapshot.Labels()...)
defer done()
diff --git a/gopls/internal/protocol/command/interface.go b/gopls/internal/protocol/command/interface.go
index 32e03dd388a..34adf59b38e 100644
--- a/gopls/internal/protocol/command/interface.go
+++ b/gopls/internal/protocol/command/interface.go
@@ -814,6 +814,9 @@ type PackageSymbol struct {
Detail string `json:"detail,omitempty"`
+ // protocol.SymbolKind maps an integer to an enum:
+ // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#symbolKind
+ // i.e. File = 1
Kind protocol.SymbolKind `json:"kind"`
Tags []protocol.SymbolTag `json:"tags,omitempty"`
diff --git a/gopls/internal/protocol/generate/generate.go b/gopls/internal/protocol/generate/generate.go
index 2bb14790940..9c7009113ab 100644
--- a/gopls/internal/protocol/generate/generate.go
+++ b/gopls/internal/protocol/generate/generate.go
@@ -54,39 +54,44 @@ func generateDoc(out *bytes.Buffer, doc string) {
// decide if a property is optional, and if it needs a *
// return ",omitempty" if it is optional, and "*" if it needs a pointer
-func propStar(name string, t NameType, gotype string) (string, string) {
- var opt, star string
+func propStar(name string, t NameType, gotype string) (omitempty, indirect bool) {
if t.Optional {
- star = "*"
- opt = ",omitempty"
+ switch gotype {
+ case "uint32", "int32":
+ // in FoldingRange.endLine, 0 and empty have different semantics
+ // There seem to be no other cases.
+ default:
+ indirect = true
+ omitempty = true
+ }
}
if strings.HasPrefix(gotype, "[]") || strings.HasPrefix(gotype, "map[") {
- star = "" // passed by reference, so no need for *
+ indirect = false // passed by reference, so no need for *
} else {
switch gotype {
- case "bool", "uint32", "int32", "string", "interface{}", "any":
- star = "" // gopls compatibility if t.Optional
+ case "bool", "string", "interface{}", "any":
+ indirect = false // gopls compatibility if t.Optional
}
}
- ostar, oopt := star, opt
+ oind, oomit := indirect, omitempty
if newStar, ok := goplsStar[prop{name, t.Name}]; ok {
switch newStar {
case nothing:
- star, opt = "", ""
+ indirect, omitempty = false, false
case wantStar:
- star, opt = "*", ""
+ indirect, omitempty = false, false
case wantOpt:
- star, opt = "", ",omitempty"
+ indirect, omitempty = false, true
case wantOptStar:
- star, opt = "*", ",omitempty"
+ indirect, omitempty = true, true
}
- if star == ostar && opt == oopt { // no change
- log.Printf("goplsStar[ {%q, %q} ](%d) useless %s/%s %s/%s", name, t.Name, t.Line, ostar, star, oopt, opt)
+ if indirect == oind && omitempty == oomit { // no change
+ log.Printf("goplsStar[ {%q, %q} ](%d) useless %v/%v %v/%v", name, t.Name, t.Line, oind, indirect, oomit, omitempty)
}
usedGoplsStar[prop{name, t.Name}] = true
}
- return opt, star
+ return
}
func goName(s string) string {
diff --git a/gopls/internal/protocol/generate/output.go b/gopls/internal/protocol/generate/output.go
index ba9d0cb909f..5eaa0cba969 100644
--- a/gopls/internal/protocol/generate/output.go
+++ b/gopls/internal/protocol/generate/output.go
@@ -273,10 +273,17 @@ func genProps(out *bytes.Buffer, props []NameType, name string) {
tp = newNm
}
// it's a pointer if it is optional, or for gopls compatibility
- opt, star := propStar(name, p, tp)
- json := fmt.Sprintf(" `json:\"%s%s\"`", p.Name, opt)
+ omit, star := propStar(name, p, tp)
+ json := fmt.Sprintf(" `json:\"%s\"`", p.Name)
+ if omit {
+ json = fmt.Sprintf(" `json:\"%s,omitempty\"`", p.Name)
+ }
generateDoc(out, p.Documentation)
- fmt.Fprintf(out, "\t%s %s%s %s\n", goName(p.Name), star, tp, json)
+ if star {
+ fmt.Fprintf(out, "\t%s *%s %s\n", goName(p.Name), tp, json)
+ } else {
+ fmt.Fprintf(out, "\t%s %s %s\n", goName(p.Name), tp, json)
+ }
}
}
diff --git a/gopls/internal/protocol/tsprotocol.go b/gopls/internal/protocol/tsprotocol.go
index 444e51e0717..7306f62a7ad 100644
--- a/gopls/internal/protocol/tsprotocol.go
+++ b/gopls/internal/protocol/tsprotocol.go
@@ -55,7 +55,7 @@ type ApplyWorkspaceEditResult struct {
// Depending on the client's failure handling strategy `failedChange` might
// contain the index of the change that failed. This property is only available
// if the client signals a `failureHandlingStrategy` in its client capabilities.
- FailedChange uint32 `json:"failedChange,omitempty"`
+ FailedChange uint32 `json:"failedChange"`
}
// A base for all symbol information.
@@ -2377,12 +2377,12 @@ type FoldingRange struct {
// To be valid, the end must be zero or larger and smaller than the number of lines in the document.
StartLine uint32 `json:"startLine"`
// The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
- StartCharacter uint32 `json:"startCharacter,omitempty"`
+ StartCharacter uint32 `json:"startCharacter"`
// The zero-based end line of the range to fold. The folded area ends with the line's last character.
// To be valid, the end must be zero or larger and smaller than the number of lines in the document.
EndLine uint32 `json:"endLine"`
// The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
- EndCharacter uint32 `json:"endCharacter,omitempty"`
+ EndCharacter uint32 `json:"endCharacter"`
// Describes the kind of the folding range such as 'comment' or 'region'. The kind
// is used to categorize folding ranges and used by commands like 'Fold all comments'.
// See {@link FoldingRangeKind} for an enumeration of standardized kinds.
@@ -2405,7 +2405,7 @@ type FoldingRangeClientCapabilities struct {
// The maximum number of folding ranges that the client prefers to receive
// per document. The value serves as a hint, servers are free to follow the
// limit.
- RangeLimit uint32 `json:"rangeLimit,omitempty"`
+ RangeLimit uint32 `json:"rangeLimit"`
// If set, the client signals that it only supports folding complete lines.
// If set, client will ignore specified `startCharacter` and `endCharacter`
// properties in a FoldingRange.
@@ -4148,7 +4148,7 @@ type PublishDiagnosticsParams struct {
// Optional the version number of the document the diagnostics are published for.
//
// @since 3.15.0
- Version int32 `json:"version,omitempty"`
+ Version int32 `json:"version"`
// An array of diagnostic information items.
Diagnostics []Diagnostic `json:"diagnostics"`
}
@@ -4907,7 +4907,7 @@ type SignatureHelp struct {
//
// In future version of the protocol this property might become
// mandatory to better express this.
- ActiveSignature uint32 `json:"activeSignature,omitempty"`
+ ActiveSignature uint32 `json:"activeSignature"`
// The active parameter of the active signature.
//
// If `null`, no parameter of the signature is active (for example a named
@@ -4924,7 +4924,7 @@ type SignatureHelp struct {
// In future version of the protocol this property might become
// mandatory (but still nullable) to better express the active parameter if
// the active signature does have any.
- ActiveParameter uint32 `json:"activeParameter,omitempty"`
+ ActiveParameter uint32 `json:"activeParameter"`
}
// Client Capabilities for a {@link SignatureHelpRequest}.
@@ -5036,7 +5036,7 @@ type SignatureInformation struct {
// `SignatureHelp.activeParameter`.
//
// @since 3.16.0
- ActiveParameter uint32 `json:"activeParameter,omitempty"`
+ ActiveParameter uint32 `json:"activeParameter"`
}
// An interactive text edit.
@@ -5261,7 +5261,7 @@ type TextDocumentContentChangePartial struct {
// The optional length of the range that got replaced.
//
// @deprecated use range instead.
- RangeLength uint32 `json:"rangeLength,omitempty"`
+ RangeLength uint32 `json:"rangeLength"`
// The new text for the provided range.
Text string `json:"text"`
}
@@ -5764,7 +5764,7 @@ type WorkDoneProgressBegin struct {
//
// The value should be steadily rising. Clients are free to ignore values
// that are not following this rule. The value range is [0, 100].
- Percentage uint32 `json:"percentage,omitempty"`
+ Percentage uint32 `json:"percentage"`
}
// See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workDoneProgressCancelParams
@@ -5824,7 +5824,7 @@ type WorkDoneProgressReport struct {
//
// The value should be steadily rising. Clients are free to ignore values
// that are not following this rule. The value range is [0, 100]
- Percentage uint32 `json:"percentage,omitempty"`
+ Percentage uint32 `json:"percentage"`
}
// Workspace specific client capabilities.
diff --git a/gopls/internal/server/call_hierarchy.go b/gopls/internal/server/call_hierarchy.go
index 671d4f8c81c..758a4628948 100644
--- a/gopls/internal/server/call_hierarchy.go
+++ b/gopls/internal/server/call_hierarchy.go
@@ -14,7 +14,7 @@ import (
)
func (s *server) PrepareCallHierarchy(ctx context.Context, params *protocol.CallHierarchyPrepareParams) ([]protocol.CallHierarchyItem, error) {
- ctx, done := event.Start(ctx, "lsp.Server.prepareCallHierarchy")
+ ctx, done := event.Start(ctx, "server.PrepareCallHierarchy")
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
@@ -29,7 +29,7 @@ func (s *server) PrepareCallHierarchy(ctx context.Context, params *protocol.Call
}
func (s *server) IncomingCalls(ctx context.Context, params *protocol.CallHierarchyIncomingCallsParams) ([]protocol.CallHierarchyIncomingCall, error) {
- ctx, done := event.Start(ctx, "lsp.Server.incomingCalls")
+ ctx, done := event.Start(ctx, "server.IncomingCalls")
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.Item.URI)
@@ -44,7 +44,7 @@ func (s *server) IncomingCalls(ctx context.Context, params *protocol.CallHierarc
}
func (s *server) OutgoingCalls(ctx context.Context, params *protocol.CallHierarchyOutgoingCallsParams) ([]protocol.CallHierarchyOutgoingCall, error) {
- ctx, done := event.Start(ctx, "lsp.Server.outgoingCalls")
+ ctx, done := event.Start(ctx, "server.OutgoingCalls")
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.Item.URI)
diff --git a/gopls/internal/server/code_action.go b/gopls/internal/server/code_action.go
index c36e7c33f94..4617fad5de7 100644
--- a/gopls/internal/server/code_action.go
+++ b/gopls/internal/server/code_action.go
@@ -22,7 +22,7 @@ import (
)
func (s *server) CodeAction(ctx context.Context, params *protocol.CodeActionParams) ([]protocol.CodeAction, error) {
- ctx, done := event.Start(ctx, "lsp.Server.codeAction")
+ ctx, done := event.Start(ctx, "server.CodeAction")
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
@@ -225,7 +225,7 @@ func triggerKind(params *protocol.CodeActionParams) protocol.CodeActionTriggerKi
// This feature allows capable clients to preview and selectively apply the diff
// instead of applying the whole thing unconditionally through workspace/applyEdit.
func (s *server) ResolveCodeAction(ctx context.Context, ca *protocol.CodeAction) (*protocol.CodeAction, error) {
- ctx, done := event.Start(ctx, "lsp.Server.resolveCodeAction")
+ ctx, done := event.Start(ctx, "server.ResolveCodeAction")
defer done()
// Only resolve the code action if there is Data provided.
diff --git a/gopls/internal/server/code_lens.go b/gopls/internal/server/code_lens.go
index 67b359e866c..2509452f0b5 100644
--- a/gopls/internal/server/code_lens.go
+++ b/gopls/internal/server/code_lens.go
@@ -22,7 +22,7 @@ import (
// CodeLens reports the set of available CodeLenses
// (range-associated commands) in the given file.
func (s *server) CodeLens(ctx context.Context, params *protocol.CodeLensParams) ([]protocol.CodeLens, error) {
- ctx, done := event.Start(ctx, "lsp.Server.codeLens", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.CodeLens", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
diff --git a/gopls/internal/server/command.go b/gopls/internal/server/command.go
index 2b5c282a28f..ca8177530e5 100644
--- a/gopls/internal/server/command.go
+++ b/gopls/internal/server/command.go
@@ -46,8 +46,8 @@ import (
"golang.org/x/tools/internal/xcontext"
)
-func (s *server) ExecuteCommand(ctx context.Context, params *protocol.ExecuteCommandParams) (interface{}, error) {
- ctx, done := event.Start(ctx, "lsp.Server.executeCommand")
+func (s *server) ExecuteCommand(ctx context.Context, params *protocol.ExecuteCommandParams) (any, error) {
+ ctx, done := event.Start(ctx, "server.ExecuteCommand")
defer done()
// For test synchronization, always create a progress notification.
@@ -1652,7 +1652,7 @@ func (c *commandHandler) DiagnoseFiles(ctx context.Context, args command.Diagnos
// Though note that implementing pull diagnostics may cause some servers to
// request diagnostics in an ad-hoc manner, and break our intentional pacing.
- ctx, done := event.Start(ctx, "lsp.server.DiagnoseFiles")
+ ctx, done := event.Start(ctx, "commandHandler.DiagnoseFiles")
defer done()
snapshots := make(map[*cache.Snapshot]bool)
@@ -1741,6 +1741,10 @@ func (c *commandHandler) PackageSymbols(ctx context.Context, args command.Packag
err := c.run(ctx, commandConfig{
forURI: args.URI,
}, func(ctx context.Context, deps commandDeps) error {
+ if deps.snapshot.FileKind(deps.fh) != file.Go {
+ // golang/vscode-go#3681: fail silently, to avoid spurious error popups.
+ return nil
+ }
res, err := golang.PackageSymbols(ctx, deps.snapshot, args.URI)
if err != nil {
return err
diff --git a/gopls/internal/server/completion.go b/gopls/internal/server/completion.go
index 6c185e93717..02604b2f710 100644
--- a/gopls/internal/server/completion.go
+++ b/gopls/internal/server/completion.go
@@ -27,7 +27,7 @@ func (s *server) Completion(ctx context.Context, params *protocol.CompletionPara
recordLatency(ctx, rerr)
}()
- ctx, done := event.Start(ctx, "lsp.Server.completion", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.Completion", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
@@ -102,6 +102,8 @@ func (s *server) saveLastCompletion(uri protocol.DocumentURI, version int32, ite
s.efficacyItems = items
}
+// toProtocolCompletionItems converts the candidates to the protocol completion items,
+// the candidates must be sorted based on score as it will be respected by client side.
func toProtocolCompletionItems(candidates []completion.CompletionItem, surrounding *completion.Selection, options *settings.Options) ([]protocol.CompletionItem, error) {
replaceRng, err := surrounding.Range()
if err != nil {
diff --git a/gopls/internal/server/definition.go b/gopls/internal/server/definition.go
index 7b4df3c7c07..8b9d42413be 100644
--- a/gopls/internal/server/definition.go
+++ b/gopls/internal/server/definition.go
@@ -9,6 +9,7 @@ import (
"fmt"
"golang.org/x/tools/gopls/internal/file"
+ "golang.org/x/tools/gopls/internal/goasm"
"golang.org/x/tools/gopls/internal/golang"
"golang.org/x/tools/gopls/internal/label"
"golang.org/x/tools/gopls/internal/protocol"
@@ -23,7 +24,7 @@ func (s *server) Definition(ctx context.Context, params *protocol.DefinitionPara
recordLatency(ctx, rerr)
}()
- ctx, done := event.Start(ctx, "lsp.Server.definition", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.Definition", label.URI.Of(params.TextDocument.URI))
defer done()
// TODO(rfindley): definition requests should be multiplexed across all views.
@@ -37,13 +38,15 @@ func (s *server) Definition(ctx context.Context, params *protocol.DefinitionPara
return template.Definition(snapshot, fh, params.Position)
case file.Go:
return golang.Definition(ctx, snapshot, fh, params.Position)
+ case file.Asm:
+ return goasm.Definition(ctx, snapshot, fh, params.Position)
default:
return nil, fmt.Errorf("can't find definitions for file type %s", kind)
}
}
func (s *server) TypeDefinition(ctx context.Context, params *protocol.TypeDefinitionParams) ([]protocol.Location, error) {
- ctx, done := event.Start(ctx, "lsp.Server.typeDefinition", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.TypeDefinition", label.URI.Of(params.TextDocument.URI))
defer done()
// TODO(rfindley): type definition requests should be multiplexed across all views.
diff --git a/gopls/internal/server/diagnostics.go b/gopls/internal/server/diagnostics.go
index b4e764b1233..92ca54e226a 100644
--- a/gopls/internal/server/diagnostics.go
+++ b/gopls/internal/server/diagnostics.go
@@ -200,7 +200,7 @@ func (s *server) diagnoseChangedViews(ctx context.Context, modID uint64, lastCha
// snapshot (or a subsequent snapshot in the same View) is eventually
// diagnosed.
func (s *server) diagnoseSnapshot(ctx context.Context, snapshot *cache.Snapshot, changedURIs []protocol.DocumentURI, delay time.Duration) {
- ctx, done := event.Start(ctx, "Server.diagnoseSnapshot", snapshot.Labels()...)
+ ctx, done := event.Start(ctx, "server.diagnoseSnapshot", snapshot.Labels()...)
defer done()
if delay > 0 {
@@ -241,7 +241,7 @@ func (s *server) diagnoseSnapshot(ctx context.Context, snapshot *cache.Snapshot,
}
func (s *server) diagnoseChangedFiles(ctx context.Context, snapshot *cache.Snapshot, uris []protocol.DocumentURI) (diagMap, error) {
- ctx, done := event.Start(ctx, "Server.diagnoseChangedFiles", snapshot.Labels()...)
+ ctx, done := event.Start(ctx, "server.diagnoseChangedFiles", snapshot.Labels()...)
defer done()
toDiagnose := make(map[metadata.PackageID]*metadata.Package)
@@ -311,7 +311,7 @@ func (s *server) diagnoseChangedFiles(ctx context.Context, snapshot *cache.Snaps
}
func (s *server) diagnose(ctx context.Context, snapshot *cache.Snapshot) (diagMap, error) {
- ctx, done := event.Start(ctx, "Server.diagnose", snapshot.Labels()...)
+ ctx, done := event.Start(ctx, "server.diagnose", snapshot.Labels()...)
defer done()
// Wait for a free diagnostics slot.
@@ -640,7 +640,7 @@ func (s *server) updateCriticalErrorStatus(ctx context.Context, snapshot *cache.
// updateDiagnostics records the result of diagnosing a snapshot, and publishes
// any diagnostics that need to be updated on the client.
func (s *server) updateDiagnostics(ctx context.Context, snapshot *cache.Snapshot, diagnostics diagMap, final bool) {
- ctx, done := event.Start(ctx, "Server.publishDiagnostics")
+ ctx, done := event.Start(ctx, "server.publishDiagnostics")
defer done()
s.diagnosticsMu.Lock()
diff --git a/gopls/internal/server/folding_range.go b/gopls/internal/server/folding_range.go
index 95b2ffc0744..5dbfd697db4 100644
--- a/gopls/internal/server/folding_range.go
+++ b/gopls/internal/server/folding_range.go
@@ -15,7 +15,7 @@ import (
)
func (s *server) FoldingRange(ctx context.Context, params *protocol.FoldingRangeParams) ([]protocol.FoldingRange, error) {
- ctx, done := event.Start(ctx, "lsp.Server.foldingRange", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.FoldingRange", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
@@ -26,24 +26,5 @@ func (s *server) FoldingRange(ctx context.Context, params *protocol.FoldingRange
if snapshot.FileKind(fh) != file.Go {
return nil, nil // empty result
}
- ranges, err := golang.FoldingRange(ctx, snapshot, fh, snapshot.Options().LineFoldingOnly)
- if err != nil {
- return nil, err
- }
- return toProtocolFoldingRanges(ranges)
-}
-
-func toProtocolFoldingRanges(ranges []*golang.FoldingRangeInfo) ([]protocol.FoldingRange, error) {
- result := make([]protocol.FoldingRange, 0, len(ranges))
- for _, info := range ranges {
- rng := info.Range
- result = append(result, protocol.FoldingRange{
- StartLine: rng.Start.Line,
- StartCharacter: rng.Start.Character,
- EndLine: rng.End.Line,
- EndCharacter: rng.End.Character,
- Kind: string(info.Kind),
- })
- }
- return result, nil
+ return golang.FoldingRange(ctx, snapshot, fh, snapshot.Options().LineFoldingOnly)
}
diff --git a/gopls/internal/server/format.go b/gopls/internal/server/format.go
index 1e6344dcff4..6abbb96d5b6 100644
--- a/gopls/internal/server/format.go
+++ b/gopls/internal/server/format.go
@@ -17,7 +17,7 @@ import (
)
func (s *server) Formatting(ctx context.Context, params *protocol.DocumentFormattingParams) ([]protocol.TextEdit, error) {
- ctx, done := event.Start(ctx, "lsp.Server.formatting", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.Formatting", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
diff --git a/gopls/internal/server/general.go b/gopls/internal/server/general.go
index 35614945f9d..5e02b832747 100644
--- a/gopls/internal/server/general.go
+++ b/gopls/internal/server/general.go
@@ -28,6 +28,7 @@ import (
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/gopls/internal/protocol/semtok"
"golang.org/x/tools/gopls/internal/settings"
+ "golang.org/x/tools/gopls/internal/telemetry"
"golang.org/x/tools/gopls/internal/util/bug"
"golang.org/x/tools/gopls/internal/util/goversion"
"golang.org/x/tools/gopls/internal/util/moremaps"
@@ -37,7 +38,7 @@ import (
)
func (s *server) Initialize(ctx context.Context, params *protocol.ParamInitialize) (*protocol.InitializeResult, error) {
- ctx, done := event.Start(ctx, "lsp.Server.initialize")
+ ctx, done := event.Start(ctx, "server.Initialize")
defer done()
var clientName string
@@ -74,7 +75,11 @@ func (s *server) Initialize(ctx context.Context, params *protocol.ParamInitializ
// TODO(rfindley): eliminate this defer.
defer func() { s.SetOptions(options) }()
- s.handleOptionErrors(ctx, options.Set(params.InitializationOptions))
+ // Process initialization options.
+ {
+ res, errs := options.Set(params.InitializationOptions)
+ s.handleOptionResult(ctx, res, errs)
+ }
options.ForClientCapabilities(params.ClientInfo, params.Capabilities)
if options.ShowBugReports {
@@ -99,7 +104,7 @@ func (s *server) Initialize(ctx context.Context, params *protocol.ParamInitializ
}
s.pendingFolders = append(s.pendingFolders, folders...)
- var codeActionProvider interface{} = true
+ var codeActionProvider any = true
if ca := params.Capabilities.TextDocument.CodeAction; len(ca.CodeActionLiteralSupport.CodeActionKind.ValueSet) > 0 {
// If the client has specified CodeActionLiteralSupport,
// send the code actions we support.
@@ -121,7 +126,7 @@ func (s *server) Initialize(ctx context.Context, params *protocol.ParamInitializ
}
}
- var renameOpts interface{} = true
+ var renameOpts any = true
if r := params.Capabilities.TextDocument.Rename; r != nil && r.PrepareSupport {
renameOpts = protocol.RenameOptions{
PrepareProvider: r.PrepareSupport,
@@ -184,6 +189,15 @@ func (s *server) Initialize(ctx context.Context, params *protocol.ParamInitializ
Supported: true,
ChangeNotifications: "workspace/didChangeWorkspaceFolders",
},
+ FileOperations: &protocol.FileOperationOptions{
+ DidCreate: &protocol.FileOperationRegistrationOptions{
+ Filters: []protocol.FileOperationFilter{{
+ Scheme: "file",
+ // gopls is only interested with files in .go extension.
+ Pattern: protocol.FileOperationPattern{Glob: "**/*.go"},
+ }},
+ },
+ },
},
},
ServerInfo: &protocol.ServerInfo{
@@ -194,7 +208,7 @@ func (s *server) Initialize(ctx context.Context, params *protocol.ParamInitializ
}
func (s *server) Initialized(ctx context.Context, params *protocol.InitializedParams) error {
- ctx, done := event.Start(ctx, "lsp.Server.initialized")
+ ctx, done := event.Start(ctx, "server.Initialized")
defer done()
s.stateMu.Lock()
@@ -541,7 +555,8 @@ func (s *server) fetchFolderOptions(ctx context.Context, folder protocol.Documen
opts = opts.Clone()
for _, config := range configs {
- s.handleOptionErrors(ctx, opts.Set(config))
+ res, errs := opts.Set(config)
+ s.handleOptionResult(ctx, res, errs)
}
return opts, nil
}
@@ -555,7 +570,12 @@ func (s *server) eventuallyShowMessage(ctx context.Context, msg *protocol.ShowMe
s.notifications = append(s.notifications, msg)
}
-func (s *server) handleOptionErrors(ctx context.Context, optionErrors []error) {
+func (s *server) handleOptionResult(ctx context.Context, applied []telemetry.CounterPath, optionErrors []error) {
+ for _, path := range applied {
+ path = append(settings.CounterPath{"gopls", "setting"}, path...)
+ counter.Inc(path.FullName())
+ }
+
var warnings, errs []string
for _, err := range optionErrors {
if err == nil {
@@ -615,7 +635,7 @@ func (s *server) fileOf(ctx context.Context, uri protocol.DocumentURI) (file.Han
// Shutdown implements the 'shutdown' LSP handler. It releases resources
// associated with the server and waits for all ongoing work to complete.
func (s *server) Shutdown(ctx context.Context) error {
- ctx, done := event.Start(ctx, "lsp.Server.shutdown")
+ ctx, done := event.Start(ctx, "server.Shutdown")
defer done()
s.stateMu.Lock()
@@ -642,7 +662,7 @@ func (s *server) Shutdown(ctx context.Context) error {
}
func (s *server) Exit(ctx context.Context) error {
- ctx, done := event.Start(ctx, "lsp.Server.exit")
+ ctx, done := event.Start(ctx, "server.Exit")
defer done()
s.stateMu.Lock()
diff --git a/gopls/internal/server/highlight.go b/gopls/internal/server/highlight.go
index 35ffc2db2f5..04ebbfa25ec 100644
--- a/gopls/internal/server/highlight.go
+++ b/gopls/internal/server/highlight.go
@@ -16,7 +16,7 @@ import (
)
func (s *server) DocumentHighlight(ctx context.Context, params *protocol.DocumentHighlightParams) ([]protocol.DocumentHighlight, error) {
- ctx, done := event.Start(ctx, "lsp.Server.documentHighlight", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.DocumentHighlight", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
diff --git a/gopls/internal/server/hover.go b/gopls/internal/server/hover.go
index 80c35c09565..ed70ce493ba 100644
--- a/gopls/internal/server/hover.go
+++ b/gopls/internal/server/hover.go
@@ -25,7 +25,7 @@ func (s *server) Hover(ctx context.Context, params *protocol.HoverParams) (_ *pr
recordLatency(ctx, rerr)
}()
- ctx, done := event.Start(ctx, "lsp.Server.hover", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.Hover", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
diff --git a/gopls/internal/server/implementation.go b/gopls/internal/server/implementation.go
index 9e61ebc4d88..9b2c103b2c3 100644
--- a/gopls/internal/server/implementation.go
+++ b/gopls/internal/server/implementation.go
@@ -21,7 +21,7 @@ func (s *server) Implementation(ctx context.Context, params *protocol.Implementa
recordLatency(ctx, rerr)
}()
- ctx, done := event.Start(ctx, "lsp.Server.implementation", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.Implementation", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
diff --git a/gopls/internal/server/inlay_hint.go b/gopls/internal/server/inlay_hint.go
index fca8bcbc1c8..a11ab4c313a 100644
--- a/gopls/internal/server/inlay_hint.go
+++ b/gopls/internal/server/inlay_hint.go
@@ -16,7 +16,7 @@ import (
)
func (s *server) InlayHint(ctx context.Context, params *protocol.InlayHintParams) ([]protocol.InlayHint, error) {
- ctx, done := event.Start(ctx, "lsp.Server.inlayHint", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.InlayHint", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
diff --git a/gopls/internal/server/link.go b/gopls/internal/server/link.go
index 13097d89887..cf475ca90c9 100644
--- a/gopls/internal/server/link.go
+++ b/gopls/internal/server/link.go
@@ -29,7 +29,7 @@ import (
)
func (s *server) DocumentLink(ctx context.Context, params *protocol.DocumentLinkParams) (links []protocol.DocumentLink, err error) {
- ctx, done := event.Start(ctx, "lsp.Server.documentLink")
+ ctx, done := event.Start(ctx, "server.DocumentLink")
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
@@ -164,17 +164,15 @@ func goLinks(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle) ([]p
// Gather links found in string literals.
var str []*ast.BasicLit
- ast.Inspect(pgf.File, func(node ast.Node) bool {
- switch n := node.(type) {
- case *ast.ImportSpec:
- return false // don't process import strings again
- case *ast.BasicLit:
- if n.Kind == token.STRING {
- str = append(str, n)
+ for curLit := range pgf.Cursor.Preorder((*ast.BasicLit)(nil)) {
+ lit := curLit.Node().(*ast.BasicLit)
+ if lit.Kind == token.STRING {
+ if _, ok := curLit.Parent().Node().(*ast.ImportSpec); ok {
+ continue // ignore import strings
}
+ str = append(str, lit)
}
- return true
- })
+ }
for _, s := range str {
strOffset, err := safetoken.Offset(pgf.Tok, s.Pos())
if err != nil {
@@ -213,7 +211,7 @@ var acceptedSchemes = map[string]bool{
"https": true,
}
-// urlRegexp is the user-supplied regular expression to match URL.
+// findLinksInString is the user-supplied regular expression to match URL.
// srcOffset is the start offset of 'src' within m's file.
func findLinksInString(urlRegexp *regexp.Regexp, src string, srcOffset int, m *protocol.Mapper) ([]protocol.DocumentLink, error) {
var links []protocol.DocumentLink
diff --git a/gopls/internal/server/references.go b/gopls/internal/server/references.go
index f5019693946..8a01e96498b 100644
--- a/gopls/internal/server/references.go
+++ b/gopls/internal/server/references.go
@@ -22,7 +22,7 @@ func (s *server) References(ctx context.Context, params *protocol.ReferenceParam
recordLatency(ctx, rerr)
}()
- ctx, done := event.Start(ctx, "lsp.Server.references", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.References", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
diff --git a/gopls/internal/server/rename.go b/gopls/internal/server/rename.go
index b6fac8ba219..218740bd679 100644
--- a/gopls/internal/server/rename.go
+++ b/gopls/internal/server/rename.go
@@ -17,7 +17,7 @@ import (
)
func (s *server) Rename(ctx context.Context, params *protocol.RenameParams) (*protocol.WorkspaceEdit, error) {
- ctx, done := event.Start(ctx, "lsp.Server.rename", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.Rename", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
@@ -68,7 +68,7 @@ func (s *server) Rename(ctx context.Context, params *protocol.RenameParams) (*pr
// TODO(rfindley): why wouldn't we want to show an error to the user, if the
// user initiated a rename request at the cursor?
func (s *server) PrepareRename(ctx context.Context, params *protocol.PrepareRenameParams) (*protocol.PrepareRenamePlaceholder, error) {
- ctx, done := event.Start(ctx, "lsp.Server.prepareRename", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.PrepareRename", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
diff --git a/gopls/internal/server/selection_range.go b/gopls/internal/server/selection_range.go
index 484e1cf67ab..afc878b1544 100644
--- a/gopls/internal/server/selection_range.go
+++ b/gopls/internal/server/selection_range.go
@@ -27,7 +27,7 @@ import (
// returned for each cursor to avoid multiple round-trips when the user is
// likely to issue this command multiple times in quick succession.
func (s *server) SelectionRange(ctx context.Context, params *protocol.SelectionRangeParams) ([]protocol.SelectionRange, error) {
- ctx, done := event.Start(ctx, "lsp.Server.selectionRange")
+ ctx, done := event.Start(ctx, "server.SelectionRange")
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
diff --git a/gopls/internal/server/semantic.go b/gopls/internal/server/semantic.go
index f746593a3dd..f0a2e11dd98 100644
--- a/gopls/internal/server/semantic.go
+++ b/gopls/internal/server/semantic.go
@@ -24,7 +24,7 @@ func (s *server) SemanticTokensRange(ctx context.Context, params *protocol.Seman
}
func (s *server) semanticTokens(ctx context.Context, td protocol.TextDocumentIdentifier, rng *protocol.Range) (*protocol.SemanticTokens, error) {
- ctx, done := event.Start(ctx, "lsp.Server.semanticTokens", label.URI.Of(td.URI))
+ ctx, done := event.Start(ctx, "server.semanticTokens", label.URI.Of(td.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, td.URI)
diff --git a/gopls/internal/server/server.go b/gopls/internal/server/server.go
index d9090250a66..c22e8f19750 100644
--- a/gopls/internal/server/server.go
+++ b/gopls/internal/server/server.go
@@ -181,7 +181,7 @@ type server struct {
}
func (s *server) WorkDoneProgressCancel(ctx context.Context, params *protocol.WorkDoneProgressCancelParams) error {
- ctx, done := event.Start(ctx, "lsp.Server.workDoneProgressCancel")
+ ctx, done := event.Start(ctx, "server.WorkDoneProgressCancel")
defer done()
return s.progress.Cancel(params.Token)
@@ -447,12 +447,7 @@ func (s *server) initWeb() (*web, error) {
pkg := pkgs[0]
// Produce report.
- html, err := golang.AssemblyHTML(ctx, snapshot, pkg, symbol, web)
- if err != nil {
- http.Error(w, err.Error(), http.StatusInternalServerError)
- return
- }
- w.Write(html)
+ golang.AssemblyHTML(ctx, snapshot, w, pkg, symbol, web)
})
return web, nil
diff --git a/gopls/internal/server/signature_help.go b/gopls/internal/server/signature_help.go
index addcfe1e262..eb464c48e27 100644
--- a/gopls/internal/server/signature_help.go
+++ b/gopls/internal/server/signature_help.go
@@ -15,7 +15,7 @@ import (
)
func (s *server) SignatureHelp(ctx context.Context, params *protocol.SignatureHelpParams) (*protocol.SignatureHelp, error) {
- ctx, done := event.Start(ctx, "lsp.Server.signatureHelp", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.SignatureHelp", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
diff --git a/gopls/internal/server/symbols.go b/gopls/internal/server/symbols.go
index e35b2c75451..40df7369f51 100644
--- a/gopls/internal/server/symbols.go
+++ b/gopls/internal/server/symbols.go
@@ -16,7 +16,7 @@ import (
)
func (s *server) DocumentSymbol(ctx context.Context, params *protocol.DocumentSymbolParams) ([]any, error) {
- ctx, done := event.Start(ctx, "lsp.Server.documentSymbol", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.DocumentSymbol", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
diff --git a/gopls/internal/server/text_synchronization.go b/gopls/internal/server/text_synchronization.go
index ad1266d783e..ad8554d9302 100644
--- a/gopls/internal/server/text_synchronization.go
+++ b/gopls/internal/server/text_synchronization.go
@@ -92,7 +92,7 @@ func (m ModificationSource) String() string {
}
func (s *server) DidOpen(ctx context.Context, params *protocol.DidOpenTextDocumentParams) error {
- ctx, done := event.Start(ctx, "lsp.Server.didOpen", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.DidOpen", label.URI.Of(params.TextDocument.URI))
defer done()
uri := params.TextDocument.URI
@@ -121,7 +121,7 @@ func (s *server) DidOpen(ctx context.Context, params *protocol.DidOpenTextDocume
}
func (s *server) DidChange(ctx context.Context, params *protocol.DidChangeTextDocumentParams) error {
- ctx, done := event.Start(ctx, "lsp.Server.didChange", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.DidChange", label.URI.Of(params.TextDocument.URI))
defer done()
uri := params.TextDocument.URI
@@ -174,7 +174,7 @@ func (s *server) warnAboutModifyingGeneratedFiles(ctx context.Context, uri proto
}
func (s *server) DidChangeWatchedFiles(ctx context.Context, params *protocol.DidChangeWatchedFilesParams) error {
- ctx, done := event.Start(ctx, "lsp.Server.didChangeWatchedFiles")
+ ctx, done := event.Start(ctx, "server.DidChangeWatchedFiles")
defer done()
var modifications []file.Modification
@@ -190,7 +190,7 @@ func (s *server) DidChangeWatchedFiles(ctx context.Context, params *protocol.Did
}
func (s *server) DidSave(ctx context.Context, params *protocol.DidSaveTextDocumentParams) error {
- ctx, done := event.Start(ctx, "lsp.Server.didSave", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.DidSave", label.URI.Of(params.TextDocument.URI))
defer done()
c := file.Modification{
@@ -204,7 +204,7 @@ func (s *server) DidSave(ctx context.Context, params *protocol.DidSaveTextDocume
}
func (s *server) DidClose(ctx context.Context, params *protocol.DidCloseTextDocumentParams) error {
- ctx, done := event.Start(ctx, "lsp.Server.didClose", label.URI.Of(params.TextDocument.URI))
+ ctx, done := event.Start(ctx, "server.DidClose", label.URI.Of(params.TextDocument.URI))
defer done()
return s.didModifyFiles(ctx, []file.Modification{
diff --git a/gopls/internal/server/unimplemented.go b/gopls/internal/server/unimplemented.go
index 470a7cbb0ee..d3bb07cb647 100644
--- a/gopls/internal/server/unimplemented.go
+++ b/gopls/internal/server/unimplemented.go
@@ -34,10 +34,6 @@ func (s *server) DidCloseNotebookDocument(context.Context, *protocol.DidCloseNot
return notImplemented("DidCloseNotebookDocument")
}
-func (s *server) DidCreateFiles(context.Context, *protocol.CreateFilesParams) error {
- return notImplemented("DidCreateFiles")
-}
-
func (s *server) DidDeleteFiles(context.Context, *protocol.DeleteFilesParams) error {
return notImplemented("DidDeleteFiles")
}
@@ -114,7 +110,7 @@ func (s *server) ResolveWorkspaceSymbol(context.Context, *protocol.WorkspaceSymb
return nil, notImplemented("ResolveWorkspaceSymbol")
}
-func (s *server) SemanticTokensFullDelta(context.Context, *protocol.SemanticTokensDeltaParams) (interface{}, error) {
+func (s *server) SemanticTokensFullDelta(context.Context, *protocol.SemanticTokensDeltaParams) (any, error) {
return nil, notImplemented("SemanticTokensFullDelta")
}
diff --git a/gopls/internal/server/workspace.go b/gopls/internal/server/workspace.go
index 84e663c1049..ced5656c6ac 100644
--- a/gopls/internal/server/workspace.go
+++ b/gopls/internal/server/workspace.go
@@ -12,6 +12,8 @@ import (
"sync"
"golang.org/x/tools/gopls/internal/cache"
+ "golang.org/x/tools/gopls/internal/file"
+ "golang.org/x/tools/gopls/internal/golang/completion"
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/gopls/internal/settings"
"golang.org/x/tools/internal/event"
@@ -59,7 +61,7 @@ func (s *server) addView(ctx context.Context, name string, dir protocol.Document
}
func (s *server) DidChangeConfiguration(ctx context.Context, _ *protocol.DidChangeConfigurationParams) error {
- ctx, done := event.Start(ctx, "lsp.Server.didChangeConfiguration")
+ ctx, done := event.Start(ctx, "server.DidChangeConfiguration")
defer done()
var wg sync.WaitGroup
@@ -139,3 +141,31 @@ func (s *server) DidChangeConfiguration(ctx context.Context, _ *protocol.DidChan
return nil
}
+
+func (s *server) DidCreateFiles(ctx context.Context, params *protocol.CreateFilesParams) error {
+ ctx, done := event.Start(ctx, "server.DidCreateFiles")
+ defer done()
+
+ var allChanges []protocol.DocumentChange
+ for _, createdFile := range params.Files {
+ uri := protocol.DocumentURI(createdFile.URI)
+ fh, snapshot, release, err := s.fileOf(ctx, uri)
+ if err != nil {
+ event.Error(ctx, "fail to call fileOf", err)
+ continue
+ }
+ defer release()
+
+ switch snapshot.FileKind(fh) {
+ case file.Go:
+ change, err := completion.NewFile(ctx, snapshot, fh)
+ if err != nil {
+ continue
+ }
+ allChanges = append(allChanges, *change)
+ default:
+ }
+ }
+
+ return applyChanges(ctx, s.client, allChanges)
+}
diff --git a/gopls/internal/server/workspace_symbol.go b/gopls/internal/server/workspace_symbol.go
index 9eafeb015ad..f34e76f7937 100644
--- a/gopls/internal/server/workspace_symbol.go
+++ b/gopls/internal/server/workspace_symbol.go
@@ -20,7 +20,7 @@ func (s *server) Symbol(ctx context.Context, params *protocol.WorkspaceSymbolPar
recordLatency(ctx, rerr)
}()
- ctx, done := event.Start(ctx, "lsp.Server.symbol")
+ ctx, done := event.Start(ctx, "server.Symbol")
defer done()
views := s.session.Views()
diff --git a/gopls/internal/settings/analysis.go b/gopls/internal/settings/analysis.go
index 5ba8bdd06b0..e914407fe6b 100644
--- a/gopls/internal/settings/analysis.go
+++ b/gopls/internal/settings/analysis.go
@@ -49,7 +49,6 @@ import (
"golang.org/x/tools/gopls/internal/analysis/deprecated"
"golang.org/x/tools/gopls/internal/analysis/embeddirective"
"golang.org/x/tools/gopls/internal/analysis/fillreturns"
- "golang.org/x/tools/gopls/internal/analysis/gofix"
"golang.org/x/tools/gopls/internal/analysis/hostport"
"golang.org/x/tools/gopls/internal/analysis/infertypeargs"
"golang.org/x/tools/gopls/internal/analysis/modernize"
@@ -63,6 +62,7 @@ import (
"golang.org/x/tools/gopls/internal/analysis/unusedvariable"
"golang.org/x/tools/gopls/internal/analysis/yield"
"golang.org/x/tools/gopls/internal/protocol"
+ "golang.org/x/tools/internal/gofix"
)
// Analyzer augments a [analysis.Analyzer] with additional LSP configuration.
diff --git a/gopls/internal/settings/codeactionkind.go b/gopls/internal/settings/codeactionkind.go
index fcce7cd2682..f6f8a4df2a4 100644
--- a/gopls/internal/settings/codeactionkind.go
+++ b/gopls/internal/settings/codeactionkind.go
@@ -81,20 +81,22 @@ const (
GoTest protocol.CodeActionKind = "source.test"
GoToggleCompilerOptDetails protocol.CodeActionKind = "source.toggleCompilerOptDetails"
AddTest protocol.CodeActionKind = "source.addTest"
+ OrganizeImports protocol.CodeActionKind = "source.organizeImports"
// gopls
GoplsDocFeatures protocol.CodeActionKind = "gopls.doc.features"
// refactor.rewrite
- RefactorRewriteChangeQuote protocol.CodeActionKind = "refactor.rewrite.changeQuote"
- RefactorRewriteFillStruct protocol.CodeActionKind = "refactor.rewrite.fillStruct"
- RefactorRewriteFillSwitch protocol.CodeActionKind = "refactor.rewrite.fillSwitch"
- RefactorRewriteInvertIf protocol.CodeActionKind = "refactor.rewrite.invertIf"
- RefactorRewriteJoinLines protocol.CodeActionKind = "refactor.rewrite.joinLines"
- RefactorRewriteRemoveUnusedParam protocol.CodeActionKind = "refactor.rewrite.removeUnusedParam"
- RefactorRewriteMoveParamLeft protocol.CodeActionKind = "refactor.rewrite.moveParamLeft"
- RefactorRewriteMoveParamRight protocol.CodeActionKind = "refactor.rewrite.moveParamRight"
- RefactorRewriteSplitLines protocol.CodeActionKind = "refactor.rewrite.splitLines"
+ RefactorRewriteChangeQuote protocol.CodeActionKind = "refactor.rewrite.changeQuote"
+ RefactorRewriteFillStruct protocol.CodeActionKind = "refactor.rewrite.fillStruct"
+ RefactorRewriteFillSwitch protocol.CodeActionKind = "refactor.rewrite.fillSwitch"
+ RefactorRewriteInvertIf protocol.CodeActionKind = "refactor.rewrite.invertIf"
+ RefactorRewriteJoinLines protocol.CodeActionKind = "refactor.rewrite.joinLines"
+ RefactorRewriteRemoveUnusedParam protocol.CodeActionKind = "refactor.rewrite.removeUnusedParam"
+ RefactorRewriteMoveParamLeft protocol.CodeActionKind = "refactor.rewrite.moveParamLeft"
+ RefactorRewriteMoveParamRight protocol.CodeActionKind = "refactor.rewrite.moveParamRight"
+ RefactorRewriteSplitLines protocol.CodeActionKind = "refactor.rewrite.splitLines"
+ RefactorRewriteEliminateDotImport protocol.CodeActionKind = "refactor.rewrite.eliminateDotImport"
// refactor.inline
RefactorInlineCall protocol.CodeActionKind = "refactor.inline.call"
diff --git a/gopls/internal/settings/default.go b/gopls/internal/settings/default.go
index ebb3f1ccfae..aa81640f3e8 100644
--- a/gopls/internal/settings/default.go
+++ b/gopls/internal/settings/default.go
@@ -91,6 +91,12 @@ func DefaultOptions(overrides ...func(*Options)) *Options {
},
UIOptions: UIOptions{
DiagnosticOptions: DiagnosticOptions{
+ Annotations: map[Annotation]bool{
+ Bounds: true,
+ Escape: true,
+ Inline: true,
+ Nil: true,
+ },
Vulncheck: ModeVulncheckOff,
DiagnosticsDelay: 1 * time.Second,
DiagnosticsTrigger: DiagnosticsOnEdit,
diff --git a/gopls/internal/settings/settings.go b/gopls/internal/settings/settings.go
index 8f33bdae96b..a47a69b0296 100644
--- a/gopls/internal/settings/settings.go
+++ b/gopls/internal/settings/settings.go
@@ -14,9 +14,27 @@ import (
"golang.org/x/tools/gopls/internal/file"
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/gopls/internal/protocol/semtok"
+ "golang.org/x/tools/gopls/internal/telemetry"
"golang.org/x/tools/gopls/internal/util/frob"
)
+// An Annotation is a category of Go compiler optimization diagnostic.
+type Annotation string
+
+const (
+ // Nil controls nil checks.
+ Nil Annotation = "nil"
+
+ // Escape controls diagnostics about escape choices.
+ Escape Annotation = "escape"
+
+ // Inline controls diagnostics about inlining choices.
+ Inline Annotation = "inline"
+
+ // Bounds controls bounds checking diagnostics.
+ Bounds Annotation = "bounds"
+)
+
// Options holds various configuration that affects Gopls execution, organized
// by the nature or origin of the settings.
//
@@ -251,6 +269,8 @@ const (
// computes the set of functions reachable within your application, including
// dependencies; queries a database of known security vulnerabilities; and
// reports any potential problems it finds.
+ //
+ //gopls:status experimental
CodeLensVulncheck CodeLensSource = "vulncheck"
// Run govulncheck (legacy)
@@ -262,6 +282,8 @@ const (
// computes the set of functions reachable within your application, including
// dependencies; queries a database of known security vulnerabilities; and
// reports any potential problems it finds.
+ //
+ //gopls:status experimental
CodeLensRunGovulncheck CodeLensSource = "run_govulncheck"
// Run tests and benchmarks
@@ -435,6 +457,19 @@ type DiagnosticOptions struct {
// [Staticcheck's website](https://staticcheck.io/docs/checks/).
Staticcheck bool `status:"experimental"`
+ // Annotations specifies the various kinds of compiler
+ // optimization details that should be reported as diagnostics
+ // when enabled for a package by the "Toggle compiler
+ // optimization details" (`gopls.gc_details`) command.
+ //
+ // (Some users care only about one kind of annotation in their
+ // profiling efforts. More importantly, in large packages, the
+ // number of annotations can sometimes overwhelm the user
+ // interface and exceed the per-file diagnostic limit.)
+ //
+ // TODO(adonovan): rename this field to CompilerOptDetail.
+ Annotations map[Annotation]bool
+
// Vulncheck enables vulnerability scanning.
Vulncheck VulncheckMode `status:"experimental"`
@@ -739,8 +774,8 @@ type ImportsSourceEnum string
const (
ImportsSourceOff ImportsSourceEnum = "off"
- ImportsSourceGopls = "gopls"
- ImportsSourceGoimports = "goimports"
+ ImportsSourceGopls ImportsSourceEnum = "gopls"
+ ImportsSourceGoimports ImportsSourceEnum = "goimports"
)
type Matcher string
@@ -797,6 +832,11 @@ const (
NoDocumentation HoverKind = "NoDocumentation"
SynopsisDocumentation HoverKind = "SynopsisDocumentation"
FullDocumentation HoverKind = "FullDocumentation"
+
+ // Structured is a misguided experimental setting that returns a JSON
+ // hover format. This setting should not be used, as it will be removed in a
+ // future release of gopls.
+ Structured HoverKind = "Structured"
)
type VulncheckMode string
@@ -822,10 +862,18 @@ const (
// TODO: support "Manual"?
)
-// Set updates *options based on the provided JSON value:
+type CounterPath = telemetry.CounterPath
+
+// Set updates *Options based on the provided JSON value:
// null, bool, string, number, array, or object.
+//
+// The applied result describes settings that were applied. Each CounterPath
+// contains at least the name of the setting, but may also include sub-setting
+// names for settings that are themselves maps, and/or a non-empty bucket name
+// when bucketing is desirable.
+//
// On failure, it returns one or more non-nil errors.
-func (o *Options) Set(value any) (errors []error) {
+func (o *Options) Set(value any) (applied []CounterPath, errs []error) {
switch value := value.(type) {
case nil:
case map[string]any:
@@ -840,19 +888,32 @@ func (o *Options) Set(value any) (errors []error) {
name = split[len(split)-1]
if _, ok := seen[name]; ok {
- errors = append(errors, fmt.Errorf("duplicate value for %s", name))
+ errs = append(errs, fmt.Errorf("duplicate value for %s", name))
}
seen[name] = struct{}{}
- if err := o.setOne(name, value); err != nil {
+ paths, err := o.setOne(name, value)
+ if err != nil {
err := fmt.Errorf("setting option %q: %w", name, err)
- errors = append(errors, err)
+ errs = append(errs, err)
+ }
+ _, soft := err.(*SoftError)
+ if err == nil || soft {
+ if len(paths) == 0 {
+ path := CounterPath{name, ""}
+ applied = append(applied, path)
+ } else {
+ for _, subpath := range paths {
+ path := append(CounterPath{name}, subpath...)
+ applied = append(applied, path)
+ }
+ }
}
}
default:
- errors = append(errors, fmt.Errorf("invalid options type %T (want JSON null or object)", value))
+ errs = append(errs, fmt.Errorf("invalid options type %T (want JSON null or object)", value))
}
- return errors
+ return applied, errs
}
func (o *Options) ForClientCapabilities(clientInfo *protocol.ClientInfo, caps protocol.ClientCapabilities) {
@@ -945,7 +1006,7 @@ func validateDirectoryFilter(ifilter string) (string, error) {
if seg != "**" {
for _, op := range unsupportedOps {
if strings.Contains(seg, op) {
- return "", fmt.Errorf("invalid filter %v, operator %v not supported. If you want to have this operator supported, consider filing an issue.", filter, op)
+ return "", fmt.Errorf("invalid filter %v, operator %v not supported. If you want to have this operator supported, consider filing an issue", filter, op)
}
}
}
@@ -955,14 +1016,26 @@ func validateDirectoryFilter(ifilter string) (string, error) {
}
// setOne updates a field of o based on the name and value.
+//
+// The applied result describes the counter values to be updated as a result of
+// the applied setting. If the result is nil, the default counter for this
+// setting should be updated.
+//
+// For example, if the setting name is "foo",
+// - If applied is nil, update the count for "foo".
+// - If applied is []CounterPath{{"bucket"}}, update the count for
+// foo:bucket.
+// - If applied is []CounterPath{{"a","b"}, {"c","d"}}, update foo/a:b and
+// foo/c:d.
+//
// It returns an error if the value was invalid or duplicate.
// It is the caller's responsibility to augment the error with 'name'.
-func (o *Options) setOne(name string, value any) error {
+func (o *Options) setOne(name string, value any) (applied []CounterPath, _ error) {
switch name {
case "env":
env, ok := value.(map[string]any)
if !ok {
- return fmt.Errorf("invalid type %T (want JSON object)", value)
+ return nil, fmt.Errorf("invalid type %T (want JSON object)", value)
}
if o.Env == nil {
o.Env = make(map[string]string)
@@ -973,30 +1046,32 @@ func (o *Options) setOne(name string, value any) error {
case string, int:
o.Env[k] = fmt.Sprint(v)
default:
- return fmt.Errorf("invalid map value %T (want string)", v)
+ return nil, fmt.Errorf("invalid map value %T (want string)", v)
}
}
+ return nil, nil
case "buildFlags":
- return setStringSlice(&o.BuildFlags, value)
+ return nil, setStringSlice(&o.BuildFlags, value)
case "directoryFilters":
filterStrings, err := asStringSlice(value)
if err != nil {
- return err
+ return nil, err
}
var filters []string
for _, filterStr := range filterStrings {
filter, err := validateDirectoryFilter(filterStr)
if err != nil {
- return err
+ return nil, err
}
filters = append(filters, strings.TrimRight(filepath.FromSlash(filter), "/"))
}
o.DirectoryFilters = filters
+ return nil, nil
case "workspaceFiles":
- return setStringSlice(&o.WorkspaceFiles, value)
+ return nil, setStringSlice(&o.WorkspaceFiles, value)
case "completionDocumentation":
return setBool(&o.CompletionDocumentation, value)
case "usePlaceholders":
@@ -1006,7 +1081,7 @@ func (o *Options) setOne(name string, value any) error {
case "completeUnimported":
return setBool(&o.CompleteUnimported, value)
case "completionBudget":
- return setDuration(&o.CompletionBudget, value)
+ return nil, setDuration(&o.CompletionBudget, value)
case "importsSource":
return setEnum(&o.ImportsSource, value,
ImportsSourceOff,
@@ -1037,17 +1112,18 @@ func (o *Options) setOne(name string, value any) error {
AllSymbolScope)
case "hoverKind":
- if s, ok := value.(string); ok && strings.EqualFold(s, "structured") {
- return deprecatedError("the experimental hoverKind='structured' setting was removed in gopls/v0.18.0 (https://go.dev/issue/70233)")
- }
+ // TODO(rfindley): reinstate the deprecation of Structured hover by making
+ // it a warning in gopls v0.N+1, and removing it in gopls v0.N+2.
return setEnum(&o.HoverKind, value,
NoDocumentation,
SingleLine,
SynopsisDocumentation,
- FullDocumentation)
+ FullDocumentation,
+ Structured,
+ )
case "linkTarget":
- return setString(&o.LinkTarget, value)
+ return nil, setString(&o.LinkTarget, value)
case "linksInHover":
switch value {
@@ -1058,9 +1134,9 @@ func (o *Options) setOne(name string, value any) error {
case "gopls":
o.LinksInHover = LinksInHover_Gopls
default:
- return fmt.Errorf(`invalid value %s; expect false, true, or "gopls"`,
- value)
+ return nil, fmt.Errorf(`invalid value %s; expect false, true, or "gopls"`, value)
}
+ return nil, nil
case "importShortcut":
return setEnum(&o.ImportShortcut, value,
@@ -1069,18 +1145,20 @@ func (o *Options) setOne(name string, value any) error {
DefinitionShortcut)
case "analyses":
- if err := setBoolMap(&o.Analyses, value); err != nil {
- return err
+ counts, err := setBoolMap(&o.Analyses, value)
+ if err != nil {
+ return nil, err
}
if o.Analyses["fieldalignment"] {
- return deprecatedError("the 'fieldalignment' analyzer was removed in gopls/v0.17.0; instead, hover over struct fields to see size/offset information (https://go.dev/issue/66861)")
+ return counts, &SoftError{"the 'fieldalignment' analyzer was removed in gopls/v0.17.0; instead, hover over struct fields to see size/offset information (https://go.dev/issue/66861)"}
}
+ return counts, nil
case "hints":
return setBoolMap(&o.Hints, value)
case "annotations":
- return deprecatedError("the 'annotations' setting was removed in gopls/v0.18.0; all compiler optimization details are now shown")
+ return setAnnotationMap(&o.Annotations, value)
case "vulncheck":
return setEnum(&o.Vulncheck, value,
@@ -1090,7 +1168,7 @@ func (o *Options) setOne(name string, value any) error {
case "codelenses", "codelens":
lensOverrides, err := asBoolMap[CodeLensSource](value)
if err != nil {
- return err
+ return nil, err
}
if o.Codelenses == nil {
o.Codelenses = make(map[CodeLensSource]bool)
@@ -1098,15 +1176,21 @@ func (o *Options) setOne(name string, value any) error {
o.Codelenses = maps.Clone(o.Codelenses)
maps.Copy(o.Codelenses, lensOverrides)
+ var counts []CounterPath
+ for k, v := range lensOverrides {
+ counts = append(counts, CounterPath{string(k), fmt.Sprint(v)})
+ }
+
if name == "codelens" {
- return deprecatedError("codelenses")
+ return counts, deprecatedError("codelenses")
}
+ return counts, nil
case "staticcheck":
return setBool(&o.Staticcheck, value)
case "local":
- return setString(&o.Local, value)
+ return nil, setString(&o.Local, value)
case "verboseOutput":
return setBool(&o.VerboseOutput, value)
@@ -1128,16 +1212,18 @@ func (o *Options) setOne(name string, value any) error {
// TODO(hxjiang): deprecate noSemanticString and noSemanticNumber.
case "noSemanticString":
- if err := setBool(&o.NoSemanticString, value); err != nil {
- return err
+ counts, err := setBool(&o.NoSemanticString, value)
+ if err != nil {
+ return nil, err
}
- return &SoftError{fmt.Sprintf("noSemanticString setting is deprecated, use semanticTokenTypes instead (though you can continue to apply them for the time being).")}
+ return counts, &SoftError{"noSemanticString setting is deprecated, use semanticTokenTypes instead (though you can continue to apply them for the time being)."}
case "noSemanticNumber":
- if err := setBool(&o.NoSemanticNumber, value); err != nil {
- return nil
+ counts, err := setBool(&o.NoSemanticNumber, value)
+ if err != nil {
+ return nil, err
}
- return &SoftError{fmt.Sprintf("noSemanticNumber setting is deprecated, use semanticTokenTypes instead (though you can continue to apply them for the time being).")}
+ return counts, &SoftError{"noSemanticNumber setting is deprecated, use semanticTokenTypes instead (though you can continue to apply them for the time being)."}
case "semanticTokenTypes":
return setBoolMap(&o.SemanticTokenTypes, value)
@@ -1157,15 +1243,16 @@ func (o *Options) setOne(name string, value any) error {
case "templateExtensions":
switch value := value.(type) {
case []any:
- return setStringSlice(&o.TemplateExtensions, value)
+ return nil, setStringSlice(&o.TemplateExtensions, value)
case nil:
o.TemplateExtensions = nil
default:
- return fmt.Errorf("unexpected type %T (want JSON array of string)", value)
+ return nil, fmt.Errorf("unexpected type %T (want JSON array of string)", value)
}
+ return nil, nil
case "diagnosticsDelay":
- return setDuration(&o.DiagnosticsDelay, value)
+ return nil, setDuration(&o.DiagnosticsDelay, value)
case "diagnosticsTrigger":
return setEnum(&o.DiagnosticsTrigger, value,
@@ -1175,11 +1262,8 @@ func (o *Options) setOne(name string, value any) error {
case "analysisProgressReporting":
return setBool(&o.AnalysisProgressReporting, value)
- case "allowImplicitNetworkAccess":
- return deprecatedError("")
-
case "standaloneTags":
- return setStringSlice(&o.StandaloneTags, value)
+ return nil, setStringSlice(&o.StandaloneTags, value)
case "subdirWatchPatterns":
return setEnum(&o.SubdirWatchPatterns, value,
@@ -1188,7 +1272,7 @@ func (o *Options) setOne(name string, value any) error {
SubdirWatchPatternsAuto)
case "reportAnalysisProgressAfter":
- return setDuration(&o.ReportAnalysisProgressAfter, value)
+ return nil, setDuration(&o.ReportAnalysisProgressAfter, value)
case "telemetryPrompt":
return setBool(&o.TelemetryPrompt, value)
@@ -1213,50 +1297,54 @@ func (o *Options) setOne(name string, value any) error {
// renamed
case "experimentalDisabledAnalyses":
- return deprecatedError("analyses")
+ return nil, deprecatedError("analyses")
case "disableDeepCompletion":
- return deprecatedError("deepCompletion")
+ return nil, deprecatedError("deepCompletion")
case "disableFuzzyMatching":
- return deprecatedError("fuzzyMatching")
+ return nil, deprecatedError("fuzzyMatching")
case "wantCompletionDocumentation":
- return deprecatedError("completionDocumentation")
+ return nil, deprecatedError("completionDocumentation")
case "wantUnimportedCompletions":
- return deprecatedError("completeUnimported")
+ return nil, deprecatedError("completeUnimported")
case "fuzzyMatching":
- return deprecatedError("matcher")
+ return nil, deprecatedError("matcher")
case "caseSensitiveCompletion":
- return deprecatedError("matcher")
+ return nil, deprecatedError("matcher")
case "experimentalDiagnosticsDelay":
- return deprecatedError("diagnosticsDelay")
+ return nil, deprecatedError("diagnosticsDelay")
// deprecated
+
+ case "allowImplicitNetworkAccess":
+ return nil, deprecatedError("")
+
case "memoryMode":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "tempModFile":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "experimentalWorkspaceModule":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "experimentalTemplateSupport":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "experimentalWatchedFileDelay":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "experimentalPackageCacheKey":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "allowModfileModifications":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "allExperiments":
// golang/go#65548: this setting is a no-op, but we fail don't report it as
@@ -1265,29 +1353,29 @@ func (o *Options) setOne(name string, value any) error {
// If, in the future, VS Code stops injecting this, we could theoretically
// report an error here, but it also seems harmless to keep ignoring this
// setting forever.
+ return nil, nil
case "experimentalUseInvalidMetadata":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "newDiff":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "wantSuggestedFixes":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "noIncrementalSync":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "watchFileChanges":
- return deprecatedError("")
+ return nil, deprecatedError("")
case "go-diff":
- return deprecatedError("")
+ return nil, deprecatedError("")
default:
- return fmt.Errorf("unexpected setting")
+ return nil, fmt.Errorf("unexpected setting")
}
- return nil
}
// EnabledSemanticTokenModifiers returns a map of modifiers to boolean.
@@ -1299,10 +1387,10 @@ func (o *Options) EnabledSemanticTokenModifiers() map[semtok.Modifier]bool {
return copy
}
-// EncodeSemanticTokenTypes returns a map of types to boolean.
+// EnabledSemanticTokenTypes returns a map of types to boolean.
func (o *Options) EnabledSemanticTokenTypes() map[semtok.Type]bool {
copy := make(map[semtok.Type]bool, len(o.SemanticTokenTypes))
- for k, v := range o.SemanticTokenModifiers {
+ for k, v := range o.SemanticTokenTypes {
copy[semtok.Type(k)] = v
}
if o.NoSemanticString {
@@ -1323,15 +1411,10 @@ func (e *SoftError) Error() string {
return e.msg
}
-// softErrorf reports a soft error related to the current option.
-func softErrorf(format string, args ...any) error {
- return &SoftError{fmt.Sprintf(format, args...)}
-}
-
// deprecatedError reports the current setting as deprecated.
// The optional replacement is suggested to the user.
func deprecatedError(replacement string) error {
- msg := fmt.Sprintf("this setting is deprecated")
+ msg := "this setting is deprecated"
if replacement != "" {
msg = fmt.Sprintf("%s, use %q instead", msg, replacement)
}
@@ -1341,13 +1424,13 @@ func deprecatedError(replacement string) error {
// setT() and asT() helpers: the setT forms write to the 'dest *T'
// variable only on success, to reduce boilerplate in Option.set.
-func setBool(dest *bool, value any) error {
+func setBool(dest *bool, value any) ([]CounterPath, error) {
b, err := asBool(value)
if err != nil {
- return err
+ return nil, err
}
*dest = b
- return nil
+ return []CounterPath{{fmt.Sprint(b)}}, nil
}
func asBool(value any) (bool, error) {
@@ -1371,13 +1454,62 @@ func setDuration(dest *time.Duration, value any) error {
return nil
}
-func setBoolMap[K ~string](dest *map[K]bool, value any) error {
+func setAnnotationMap(dest *map[Annotation]bool, value any) ([]CounterPath, error) {
+ all, err := asBoolMap[string](value)
+ if err != nil {
+ return nil, err
+ }
+ var counters []CounterPath
+ // Default to everything enabled by default.
+ m := make(map[Annotation]bool)
+ for k, enabled := range all {
+ var a Annotation
+ cnts, err := setEnum(&a, k,
+ Nil,
+ Escape,
+ Inline,
+ Bounds)
+ if err != nil {
+ // In case of an error, process any legacy values.
+ switch k {
+ case "noEscape":
+ m[Escape] = false
+ return nil, fmt.Errorf(`"noEscape" is deprecated, set "Escape: false" instead`)
+
+ case "noNilcheck":
+ m[Nil] = false
+ return nil, fmt.Errorf(`"noNilcheck" is deprecated, set "Nil: false" instead`)
+
+ case "noInline":
+ m[Inline] = false
+ return nil, fmt.Errorf(`"noInline" is deprecated, set "Inline: false" instead`)
+
+ case "noBounds":
+ m[Bounds] = false
+ return nil, fmt.Errorf(`"noBounds" is deprecated, set "Bounds: false" instead`)
+
+ default:
+ return nil, err
+ }
+ }
+ counters = append(counters, cnts...)
+ m[a] = enabled
+ }
+ *dest = m
+ return counters, nil
+}
+
+func setBoolMap[K ~string](dest *map[K]bool, value any) ([]CounterPath, error) {
m, err := asBoolMap[K](value)
if err != nil {
- return err
+ return nil, err
}
*dest = m
- return nil
+ var counts []CounterPath
+ for k, v := range m {
+ counts = append(counts, CounterPath{string(k), fmt.Sprint(v)})
+ }
+ return counts, nil
}
func asBoolMap[K ~string](value any) (map[K]bool, error) {
@@ -1438,13 +1570,13 @@ func asStringSlice(value any) ([]string, error) {
return slice, nil
}
-func setEnum[S ~string](dest *S, value any, options ...S) error {
+func setEnum[S ~string](dest *S, value any, options ...S) ([]CounterPath, error) {
enum, err := asEnum(value, options...)
if err != nil {
- return err
+ return nil, err
}
*dest = enum
- return nil
+ return []CounterPath{{string(enum)}}, nil
}
func asEnum[S ~string](value any, options ...S) (S, error) {
diff --git a/gopls/internal/settings/settings_test.go b/gopls/internal/settings/settings_test.go
index 63b4aded8bd..d7a032e1938 100644
--- a/gopls/internal/settings/settings_test.go
+++ b/gopls/internal/settings/settings_test.go
@@ -91,19 +91,19 @@ func TestOptions_Set(t *testing.T) {
},
},
{
- name: "hoverKind",
- value: "Structured",
- wantError: true,
+ name: "hoverKind",
+ value: "Structured",
+ // wantError: true, // TODO(rfindley): reinstate this error
check: func(o Options) bool {
- return o.HoverKind == FullDocumentation
+ return o.HoverKind == Structured
},
},
{
- name: "ui.documentation.hoverKind",
- value: "Structured",
- wantError: true,
+ name: "ui.documentation.hoverKind",
+ value: "Structured",
+ // wantError: true, // TODO(rfindley): reinstate this error
check: func(o Options) bool {
- return o.HoverKind == FullDocumentation
+ return o.HoverKind == Structured
},
},
{
@@ -180,6 +180,17 @@ func TestOptions_Set(t *testing.T) {
return len(o.DirectoryFilters) == 0
},
},
+ {
+ name: "annotations",
+ value: map[string]any{
+ "Nil": false,
+ "noBounds": true,
+ },
+ wantError: true,
+ check: func(o Options) bool {
+ return !o.Annotations[Nil] && !o.Annotations[Bounds]
+ },
+ },
{
name: "vulncheck",
value: []any{"invalid"},
@@ -206,7 +217,7 @@ func TestOptions_Set(t *testing.T) {
for _, test := range tests {
var opts Options
- err := opts.Set(map[string]any{test.name: test.value})
+ _, err := opts.Set(map[string]any{test.name: test.value})
if err != nil {
if !test.wantError {
t.Errorf("Options.set(%q, %v) failed: %v",
diff --git a/gopls/internal/telemetry/cmd/stacks/stacks.go b/gopls/internal/telemetry/cmd/stacks/stacks.go
index 7cb20012657..f8caabd67e6 100644
--- a/gopls/internal/telemetry/cmd/stacks/stacks.go
+++ b/gopls/internal/telemetry/cmd/stacks/stacks.go
@@ -479,11 +479,20 @@ func parsePredicate(s string) (func(string) bool, error) {
if err != nil {
return err
}
- // The literal should match complete words. It may match multiple words,
- // if it contains non-word runes like whitespace; but it must match word
- // boundaries at each end.
+ // The end of the literal (usually "symbol",
+ // "pkg.symbol", or "pkg.symbol:+1") must
+ // match a word boundary. However, the start
+ // of the literal need not: an input line such
+ // as "domain.name/dir/pkg.symbol:+1" should
+ // match literal "pkg.symbol", but the slash
+ // is not a word boundary (witness:
+ // https://go.dev/play/p/w-8ev_VUBSq).
+ //
+ // It may match multiple words if it contains
+ // non-word runes like whitespace.
+ //
// The constructed regular expression is always valid.
- literalRegexps[e] = regexp.MustCompile(`\b` + regexp.QuoteMeta(lit) + `\b`)
+ literalRegexps[e] = regexp.MustCompile(regexp.QuoteMeta(lit) + `\b`)
default:
return fmt.Errorf("syntax error (%T)", e)
@@ -520,7 +529,7 @@ func parsePredicate(s string) (func(string) bool, error) {
}, nil
}
-// claimStack maps each stack ID to its issue (if any).
+// claimStacks maps each stack ID to its issue (if any).
//
// It returns a map of stack text to the issue that claimed it.
//
@@ -1084,6 +1093,8 @@ type Issue struct {
newStacks []string // new stacks to add to existing issue (comments and IDs)
}
+func (issue *Issue) String() string { return fmt.Sprintf("#%d", issue.Number) }
+
type User struct {
Login string
HTMLURL string `json:"html_url"`
diff --git a/gopls/internal/telemetry/cmd/stacks/stacks_test.go b/gopls/internal/telemetry/cmd/stacks/stacks_test.go
index 452113a1581..9f798aa43a3 100644
--- a/gopls/internal/telemetry/cmd/stacks/stacks_test.go
+++ b/gopls/internal/telemetry/cmd/stacks/stacks_test.go
@@ -85,13 +85,15 @@ func TestParsePredicate(t *testing.T) {
want bool
}{
{`"x"`, `"x"`, true},
- {`"x"`, `"axe"`, false}, // literals match whole words
+ {`"x"`, `"axe"`, false}, // literals must match word ends
+ {`"xe"`, `"axe"`, true},
{`"x"`, "val:x+5", true},
{`"fu+12"`, "x:fu+12,", true},
- {`"fu+12"`, "snafu+12,", false},
+ {`"fu+12"`, "snafu+12,", true}, // literals needn't match word start
{`"fu+12"`, "x:fu+123,", false},
- {`"a.*b"`, "a.*b", true}, // regexp metachars are escaped
- {`"a.*b"`, "axxb", false}, // ditto
+ {`"foo:+12"`, "dir/foo:+12,", true}, // literals needn't match word start
+ {`"a.*b"`, "a.*b", true}, // regexp metachars are escaped
+ {`"a.*b"`, "axxb", false}, // ditto
{`"x"`, `"y"`, false},
{`!"x"`, "x", false},
{`!"x"`, "y", true},
diff --git a/gopls/internal/telemetry/counterpath.go b/gopls/internal/telemetry/counterpath.go
new file mode 100644
index 00000000000..e6d9d84b531
--- /dev/null
+++ b/gopls/internal/telemetry/counterpath.go
@@ -0,0 +1,30 @@
+// Copyright 2025 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 telemetry
+
+import "strings"
+
+// A CounterPath represents the components of a telemetry counter name.
+//
+// By convention, counter names follow the format path/to/counter:bucket. The
+// CounterPath holds the '/'-separated components of this path, along with a
+// final element representing the bucket.
+//
+// CounterPaths may be used to build up counters incrementally, such as when a
+// set of observed counters shared a common prefix, to be controlled by the
+// caller.
+type CounterPath []string
+
+// FullName returns the counter name for the receiver.
+func (p CounterPath) FullName() string {
+ if len(p) == 0 {
+ return ""
+ }
+ name := strings.Join([]string(p[:len(p)-1]), "/")
+ if bucket := p[len(p)-1]; bucket != "" {
+ name += ":" + bucket
+ }
+ return name
+}
diff --git a/gopls/internal/telemetry/counterpath_test.go b/gopls/internal/telemetry/counterpath_test.go
new file mode 100644
index 00000000000..b6ac7478b72
--- /dev/null
+++ b/gopls/internal/telemetry/counterpath_test.go
@@ -0,0 +1,47 @@
+// Copyright 2025 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 telemetry
+
+import (
+ "testing"
+)
+
+// TestCounterPath tests the formatting of various counter paths.
+func TestCounterPath(t *testing.T) {
+ tests := []struct {
+ path CounterPath
+ want string
+ }{
+ {
+ path: CounterPath{},
+ want: "",
+ },
+ {
+ path: CounterPath{"counter"},
+ want: ":counter",
+ },
+ {
+ path: CounterPath{"counter", "bucket"},
+ want: "counter:bucket",
+ },
+ {
+ path: CounterPath{"path", "to", "counter"},
+ want: "path/to:counter",
+ },
+ {
+ path: CounterPath{"multi", "component", "path", "bucket"},
+ want: "multi/component/path:bucket",
+ },
+ {
+ path: CounterPath{"path", ""},
+ want: "path",
+ },
+ }
+ for _, tt := range tests {
+ if got := tt.path.FullName(); got != tt.want {
+ t.Errorf("CounterPath(%v).FullName() = %v, want %v", tt.path, got, tt.want)
+ }
+ }
+}
diff --git a/gopls/internal/telemetry/telemetry_test.go b/gopls/internal/telemetry/telemetry_test.go
index 7aaca41ab55..1e56012182f 100644
--- a/gopls/internal/telemetry/telemetry_test.go
+++ b/gopls/internal/telemetry/telemetry_test.go
@@ -119,12 +119,56 @@ func TestTelemetry(t *testing.T) {
}
}
+func TestSettingTelemetry(t *testing.T) {
+ // counters that should be incremented by each session
+ sessionCounters := []*counter.Counter{
+ counter.New("gopls/setting/diagnosticsDelay"),
+ counter.New("gopls/setting/staticcheck:true"),
+ counter.New("gopls/setting/noSemanticString:true"),
+ counter.New("gopls/setting/analyses/deprecated:false"),
+ }
+
+ initialCounts := make([]uint64, len(sessionCounters))
+ for i, c := range sessionCounters {
+ count, err := countertest.ReadCounter(c)
+ if err != nil {
+ continue // counter db not open, or counter not found
+ }
+ initialCounts[i] = count
+ }
+
+ // Run gopls.
+ WithOptions(
+ Modes(Default),
+ Settings{
+ "staticcheck": true,
+ "analyses": map[string]bool{
+ "deprecated": false,
+ },
+ "diagnosticsDelay": "0s",
+ "noSemanticString": true,
+ },
+ ).Run(t, "", func(_ *testing.T, env *Env) {
+ })
+
+ for i, c := range sessionCounters {
+ count, err := countertest.ReadCounter(c)
+ if err != nil {
+ t.Errorf("ReadCounter(%q) failed: %v", c.Name(), err)
+ continue
+ }
+ if count <= initialCounts[i] {
+ t.Errorf("ReadCounter(%q) = %d, want > %d", c.Name(), count, initialCounts[i])
+ }
+ }
+}
+
func addForwardedCounters(env *Env, names []string, values []int64) {
args, err := command.MarshalArgs(command.AddTelemetryCountersArgs{
Names: names, Values: values,
})
if err != nil {
- env.T.Fatal(err)
+ env.TB.Fatal(err)
}
var res error
env.ExecuteCommand(&protocol.ExecuteCommandParams{
@@ -132,7 +176,7 @@ func addForwardedCounters(env *Env, names []string, values []int64) {
Arguments: args,
}, &res)
if res != nil {
- env.T.Errorf("%v failed - %v", command.AddTelemetryCounters, res)
+ env.TB.Errorf("%v failed - %v", command.AddTelemetryCounters, res)
}
}
diff --git a/gopls/internal/template/parse.go b/gopls/internal/template/parse.go
index 448a5ab51e8..f1b26bbb14f 100644
--- a/gopls/internal/template/parse.go
+++ b/gopls/internal/template/parse.go
@@ -114,7 +114,7 @@ func parseBuffer(buf []byte) *Parsed {
matches := parseErrR.FindStringSubmatch(err.Error())
if len(matches) == 2 {
// suppress the error by giving it a function with the right name
- funcs[matches[1]] = func() interface{} { return nil }
+ funcs[matches[1]] = func() any { return nil }
t, err = template.New("").Funcs(funcs).Parse(string(ans.buf))
continue
}
diff --git a/gopls/internal/test/integration/bench/completion_test.go b/gopls/internal/test/integration/bench/completion_test.go
index bbbba0e3fd1..48ecf0cefd6 100644
--- a/gopls/internal/test/integration/bench/completion_test.go
+++ b/gopls/internal/test/integration/bench/completion_test.go
@@ -69,7 +69,7 @@ func endRangeInBuffer(env *Env, name string) protocol.Range {
m := protocol.NewMapper("", []byte(buffer))
rng, err := m.OffsetRange(len(buffer), len(buffer))
if err != nil {
- env.T.Fatal(err)
+ env.TB.Fatal(err)
}
return rng
}
@@ -282,7 +282,7 @@ func runCompletion(b *testing.B, test completionTest, followingEdit, completeUni
env := repo.newEnv(b, fake.EditorConfig{
Env: envvars,
- Settings: map[string]interface{}{
+ Settings: map[string]any{
"completeUnimported": completeUnimported,
"completionBudget": budget,
},
diff --git a/gopls/internal/test/integration/bench/didchange_test.go b/gopls/internal/test/integration/bench/didchange_test.go
index 57ed01bbcd6..b1613bb1b03 100644
--- a/gopls/internal/test/integration/bench/didchange_test.go
+++ b/gopls/internal/test/integration/bench/didchange_test.go
@@ -118,7 +118,7 @@ func runChangeDiagnosticsBenchmark(b *testing.B, test changeTest, save bool, ope
Env: map[string]string{
"GOPATH": sharedEnv.Sandbox.GOPATH(),
},
- Settings: map[string]interface{}{
+ Settings: map[string]any{
"diagnosticsDelay": "0s",
},
}
diff --git a/gopls/internal/test/integration/bench/repo_test.go b/gopls/internal/test/integration/bench/repo_test.go
index 50370e73491..65728c00552 100644
--- a/gopls/internal/test/integration/bench/repo_test.go
+++ b/gopls/internal/test/integration/bench/repo_test.go
@@ -211,7 +211,7 @@ func (r *repo) sharedEnv(tb testing.TB) *Env {
})
return &Env{
- T: tb,
+ TB: tb,
Ctx: context.Background(),
Editor: r.editor,
Sandbox: r.sandbox,
@@ -238,7 +238,7 @@ func (r *repo) newEnv(tb testing.TB, config fake.EditorConfig, forOperation stri
}
return &Env{
- T: tb,
+ TB: tb,
Ctx: context.Background(),
Editor: editor,
Sandbox: sandbox,
diff --git a/gopls/internal/test/integration/completion/completion_test.go b/gopls/internal/test/integration/completion/completion_test.go
index 1d293fe9019..8fa03908c01 100644
--- a/gopls/internal/test/integration/completion/completion_test.go
+++ b/gopls/internal/test/integration/completion/completion_test.go
@@ -53,6 +53,10 @@ func TestPackageCompletion(t *testing.T) {
module mod.com
go 1.12
+-- cmd/main.go --
+package main
+-- cmd/testfile.go --
+package
-- fruits/apple.go --
package apple
@@ -95,6 +99,13 @@ package
want []string
editRegexp string
}{
+ {
+ name: "main package completion after package keyword",
+ filename: "cmd/testfile.go",
+ triggerRegexp: "package()",
+ want: []string{"package main", "package cmd", "package cmd_test"},
+ editRegexp: "package",
+ },
{
name: "package completion at valid position",
filename: "fruits/testfile.go",
@@ -1212,25 +1223,21 @@ func TestDoubleParamReturnCompletion(t *testing.T) {
Run(t, src, func(t *testing.T, env *Env) {
env.OpenFile("a.go")
- compl := env.RegexpSearch("a.go", `DoubleWrap\[()\]\(\)`)
- result := env.Completion(compl)
-
- wantLabel := []string{"InterfaceA", "TypeA", "InterfaceB", "TypeB", "TypeC"}
-
- for i, item := range result.Items[:len(wantLabel)] {
- if diff := cmp.Diff(wantLabel[i], item.Label); diff != "" {
- t.Errorf("Completion: unexpected label mismatch (-want +got):\n%s", diff)
- }
+ tests := map[string][]string{
+ `DoubleWrap\[()\]\(\)`: {"InterfaceA", "TypeA", "InterfaceB", "TypeB", "TypeC"},
+ `DoubleWrap\[InterfaceA, (_)\]\(\)`: {"InterfaceB", "TypeB", "TypeX", "InterfaceA", "TypeA"},
}
- compl = env.RegexpSearch("a.go", `DoubleWrap\[InterfaceA, (_)\]\(\)`)
- result = env.Completion(compl)
-
- wantLabel = []string{"InterfaceB", "TypeB", "TypeX", "InterfaceA", "TypeA"}
-
- for i, item := range result.Items[:len(wantLabel)] {
- if diff := cmp.Diff(wantLabel[i], item.Label); diff != "" {
- t.Errorf("Completion: unexpected label mismatch (-want +got):\n%s", diff)
+ for re, wantLabels := range tests {
+ compl := env.RegexpSearch("a.go", re)
+ result := env.Completion(compl)
+ if len(result.Items) < len(wantLabels) {
+ t.Fatalf("Completion(%q) returned mismatching labels: got %v, want at least labels %v", re, result.Items, wantLabels)
+ }
+ for i, item := range result.Items[:len(wantLabels)] {
+ if diff := cmp.Diff(wantLabels[i], item.Label); diff != "" {
+ t.Errorf("Completion(%q): unexpected label mismatch (-want +got):\n%s", re, diff)
+ }
}
}
})
diff --git a/gopls/internal/test/integration/completion/fixedbugs_test.go b/gopls/internal/test/integration/completion/fixedbugs_test.go
index faa5324e138..ccec432904e 100644
--- a/gopls/internal/test/integration/completion/fixedbugs_test.go
+++ b/gopls/internal/test/integration/completion/fixedbugs_test.go
@@ -38,3 +38,20 @@ package
}
})
}
+
+func TestFixInitStatementCrash_Issue72026(t *testing.T) {
+ // This test checks that we don't crash when the if condition overflows the
+ // file (as is possible with a malformed struct type).
+
+ const files = `
+-- go.mod --
+module example.com
+
+go 1.18
+`
+
+ Run(t, files, func(t *testing.T, env *Env) {
+ env.CreateBuffer("p.go", "package p\nfunc _() {\n\tfor i := struct")
+ env.AfterChange()
+ })
+}
diff --git a/gopls/internal/test/integration/diagnostics/diagnostics_test.go b/gopls/internal/test/integration/diagnostics/diagnostics_test.go
index c496f6464a3..5ef39a5f0c5 100644
--- a/gopls/internal/test/integration/diagnostics/diagnostics_test.go
+++ b/gopls/internal/test/integration/diagnostics/diagnostics_test.go
@@ -542,27 +542,34 @@ var X = 0
// Tests golang/go#38467.
func TestNoSuggestedFixesForGeneratedFiles_Issue38467(t *testing.T) {
+ // This test ensures that gopls' CodeAction handler suppresses
+ // diagnostics in generated code. Beware that many analyzers
+ // themselves suppress diagnostics in generated files, in
+ // particular the low-status "simplifiers" (modernize,
+ // simplify{range,slice,compositelit}), so we use the hostport
+ // analyzer here.
const generated = `
-- go.mod --
module mod.com
go 1.12
-- main.go --
+// Code generated by generator.go. DO NOT EDIT.
+
package main
-// Code generated by generator.go. DO NOT EDIT.
+import ("fmt"; "net")
func _() {
- for i, _ := range []string{} {
- _ = i
- }
+ addr := fmt.Sprintf("%s:%d", "localhost", 12345)
+ net.Dial("tcp", addr)
}
`
Run(t, generated, func(t *testing.T, env *Env) {
env.OpenFile("main.go")
var d protocol.PublishDiagnosticsParams
env.AfterChange(
- Diagnostics(AtPosition("main.go", 5, 8)),
+ Diagnostics(AtPosition("main.go", 7, 21)),
ReadDiagnostics("main.go", &d),
)
if fixes := env.GetQuickFixes("main.go", d.Diagnostics); len(fixes) != 0 {
diff --git a/gopls/internal/test/integration/env.go b/gopls/internal/test/integration/env.go
index 64344d0d146..822120e8324 100644
--- a/gopls/internal/test/integration/env.go
+++ b/gopls/internal/test/integration/env.go
@@ -21,7 +21,7 @@ import (
// wrapper methods that hide the boilerplate of plumbing contexts and checking
// errors.
type Env struct {
- T testing.TB // TODO(rfindley): rename to TB
+ TB testing.TB
Ctx context.Context
// Most tests should not need to access the scratch area, editor, server, or
@@ -114,53 +114,16 @@ type workProgress struct {
complete bool // seen 'end'
}
-// This method, provided for debugging, accesses mutable fields without a lock,
-// so it must not be called concurrent with any State mutation.
-func (s State) String() string {
- var b strings.Builder
- b.WriteString("#### log messages (see RPC logs for full text):\n")
- for _, msg := range s.logs {
- summary := fmt.Sprintf("%v: %q", msg.Type, msg.Message)
- if len(summary) > 60 {
- summary = summary[:57] + "..."
- }
- // Some logs are quite long, and since they should be reproduced in the RPC
- // logs on any failure we include here just a short summary.
- fmt.Fprint(&b, "\t"+summary+"\n")
- }
- b.WriteString("\n")
- b.WriteString("#### diagnostics:\n")
- for name, params := range s.diagnostics {
- fmt.Fprintf(&b, "\t%s (version %d):\n", name, params.Version)
- for _, d := range params.Diagnostics {
- fmt.Fprintf(&b, "\t\t%d:%d [%s]: %s\n", d.Range.Start.Line, d.Range.Start.Character, d.Source, d.Message)
- }
- }
- b.WriteString("\n")
- b.WriteString("#### outstanding work:\n")
- for token, state := range s.work {
- if state.complete {
- continue
- }
- name := state.title
- if name == "" {
- name = fmt.Sprintf("!NO NAME(token: %s)", token)
- }
- fmt.Fprintf(&b, "\t%s: %.2f\n", name, state.percent)
- }
- b.WriteString("#### completed work:\n")
- for name, count := range s.completedWork {
- fmt.Fprintf(&b, "\t%s: %d\n", name, count)
- }
- return b.String()
+type awaitResult struct {
+ verdict Verdict
+ reason string
}
-// A condition is satisfied when all expectations are simultaneously
-// met. At that point, the 'met' channel is closed. On any failure, err is set
-// and the failed channel is closed.
+// A condition is satisfied when its expectation is [Met] or [Unmeetable]. The
+// result is sent on the verdict channel.
type condition struct {
- expectations []Expectation
- verdict chan Verdict
+ expectation Expectation
+ verdict chan awaitResult
}
func (a *Awaiter) onDiagnostics(_ context.Context, d *protocol.PublishDiagnosticsParams) error {
@@ -282,7 +245,7 @@ func (a *Awaiter) onProgress(_ context.Context, m *protocol.ProgressParams) erro
if !ok {
panic(fmt.Sprintf("got progress report for unknown report %v: %v", m.Token, m))
}
- v := m.Value.(map[string]interface{})
+ v := m.Value.(map[string]any)
switch kind := v["kind"]; kind {
case "begin":
work.title = v["title"].(string)
@@ -334,27 +297,13 @@ func (a *Awaiter) onUnregisterCapability(_ context.Context, m *protocol.Unregist
func (a *Awaiter) checkConditionsLocked() {
for id, condition := range a.waiters {
- if v, _ := checkExpectations(a.state, condition.expectations); v != Unmet {
+ if v, why := condition.expectation.Check(a.state); v != Unmet {
delete(a.waiters, id)
- condition.verdict <- v
+ condition.verdict <- awaitResult{v, why}
}
}
}
-// checkExpectations reports whether s meets all expectations.
-func checkExpectations(s State, expectations []Expectation) (Verdict, string) {
- finalVerdict := Met
- var summary strings.Builder
- for _, e := range expectations {
- v := e.Check(s)
- if v > finalVerdict {
- finalVerdict = v
- }
- fmt.Fprintf(&summary, "%v: %s\n", v, e.Description)
- }
- return finalVerdict, summary.String()
-}
-
// Await blocks until the given expectations are all simultaneously met.
//
// Generally speaking Await should be avoided because it blocks indefinitely if
@@ -362,39 +311,39 @@ func checkExpectations(s State, expectations []Expectation) (Verdict, string) {
// Use AfterChange or OnceMet instead, so that the runner knows when to stop
// waiting.
func (e *Env) Await(expectations ...Expectation) {
- e.T.Helper()
- if err := e.Awaiter.Await(e.Ctx, expectations...); err != nil {
- e.T.Fatal(err)
+ e.TB.Helper()
+ if err := e.Awaiter.Await(e.Ctx, AllOf(expectations...)); err != nil {
+ e.TB.Fatal(err)
}
}
// OnceMet blocks until the precondition is met by the state or becomes
// unmeetable. If it was met, OnceMet checks that the state meets all
// expectations in mustMeets.
-func (e *Env) OnceMet(precondition Expectation, mustMeets ...Expectation) {
- e.T.Helper()
- e.Await(OnceMet(precondition, mustMeets...))
+func (e *Env) OnceMet(pre Expectation, mustMeets ...Expectation) {
+ e.TB.Helper()
+ e.Await(OnceMet(pre, AllOf(mustMeets...)))
}
// Await waits for all expectations to simultaneously be met. It should only be
// called from the main test goroutine.
-func (a *Awaiter) Await(ctx context.Context, expectations ...Expectation) error {
+func (a *Awaiter) Await(ctx context.Context, expectation Expectation) error {
a.mu.Lock()
// Before adding the waiter, we check if the condition is currently met or
// failed to avoid a race where the condition was realized before Await was
// called.
- switch verdict, summary := checkExpectations(a.state, expectations); verdict {
+ switch verdict, why := expectation.Check(a.state); verdict {
case Met:
a.mu.Unlock()
return nil
case Unmeetable:
- err := fmt.Errorf("unmeetable expectations:\n%s\nstate:\n%v", summary, a.state)
+ err := fmt.Errorf("unmeetable expectation:\n%s\nreason:\n%s", indent(expectation.Description), indent(why))
a.mu.Unlock()
return err
}
cond := &condition{
- expectations: expectations,
- verdict: make(chan Verdict),
+ expectation: expectation,
+ verdict: make(chan awaitResult),
}
a.waiters[nextAwaiterRegistration.Add(1)] = cond
a.mu.Unlock()
@@ -403,19 +352,17 @@ func (a *Awaiter) Await(ctx context.Context, expectations ...Expectation) error
select {
case <-ctx.Done():
err = ctx.Err()
- case v := <-cond.verdict:
- if v != Met {
- err = fmt.Errorf("condition has final verdict %v", v)
+ case res := <-cond.verdict:
+ if res.verdict != Met {
+ err = fmt.Errorf("the following condition is %s:\n%s\nreason:\n%s",
+ res.verdict, indent(expectation.Description), indent(res.reason))
}
}
- a.mu.Lock()
- defer a.mu.Unlock()
- _, summary := checkExpectations(a.state, expectations)
+ return err
+}
- // Debugging an unmet expectation can be tricky, so we put some effort into
- // nicely formatting the failure.
- if err != nil {
- return fmt.Errorf("waiting on:\n%s\nerr:%v\n\nstate:\n%v", summary, err, a.state)
- }
- return nil
+// indent indents all lines of msg, including the first.
+func indent(msg string) string {
+ const prefix = " "
+ return prefix + strings.ReplaceAll(msg, "\n", "\n"+prefix)
}
diff --git a/gopls/internal/test/integration/env_test.go b/gopls/internal/test/integration/env_test.go
index 32203f7cb83..1fa68676b5c 100644
--- a/gopls/internal/test/integration/env_test.go
+++ b/gopls/internal/test/integration/env_test.go
@@ -33,7 +33,7 @@ func TestProgressUpdating(t *testing.T) {
}
updates := []struct {
token string
- value interface{}
+ value any
}{
{"foo", protocol.WorkDoneProgressBegin{Kind: "begin", Title: "foo work"}},
{"bar", protocol.WorkDoneProgressBegin{Kind: "begin", Title: "bar work"}},
diff --git a/gopls/internal/test/integration/expectation.go b/gopls/internal/test/integration/expectation.go
index ad41423d098..98554ddccc3 100644
--- a/gopls/internal/test/integration/expectation.go
+++ b/gopls/internal/test/integration/expectation.go
@@ -5,14 +5,17 @@
package integration
import (
+ "bytes"
"fmt"
+ "maps"
"regexp"
- "sort"
+ "slices"
"strings"
"github.com/google/go-cmp/cmp"
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/gopls/internal/server"
+ "golang.org/x/tools/gopls/internal/util/constraints"
)
var (
@@ -55,16 +58,11 @@ func (v Verdict) String() string {
//
// Expectations are combinators. By composing them, tests may express
// complex expectations in terms of simpler ones.
-//
-// TODO(rfindley): as expectations are combined, it becomes harder to identify
-// why they failed. A better signature for Check would be
-//
-// func(State) (Verdict, string)
-//
-// returning a reason for the verdict that can be composed similarly to
-// descriptions.
type Expectation struct {
- Check func(State) Verdict
+ // Check returns the verdict of this expectation for the given state.
+ // If the vertict is not [Met], the second result should return a reason
+ // that the verdict is not (yet) met.
+ Check func(State) (Verdict, string)
// Description holds a noun-phrase identifying what the expectation checks.
//
@@ -74,117 +72,117 @@ type Expectation struct {
// OnceMet returns an Expectation that, once the precondition is met, asserts
// that mustMeet is met.
-func OnceMet(precondition Expectation, mustMeets ...Expectation) Expectation {
- check := func(s State) Verdict {
- switch pre := precondition.Check(s); pre {
- case Unmeetable:
- return Unmeetable
+func OnceMet(pre, post Expectation) Expectation {
+ check := func(s State) (Verdict, string) {
+ switch v, why := pre.Check(s); v {
+ case Unmeetable, Unmet:
+ return v, fmt.Sprintf("precondition is %s: %s", v, why)
case Met:
- for _, mustMeet := range mustMeets {
- verdict := mustMeet.Check(s)
- if verdict != Met {
- return Unmeetable
- }
+ v, why := post.Check(s)
+ if v != Met {
+ return Unmeetable, fmt.Sprintf("postcondition is not met:\n%s", indent(why))
}
- return Met
+ return Met, ""
default:
- return Unmet
+ panic(fmt.Sprintf("unknown precondition verdict %s", v))
}
}
- description := describeExpectations(mustMeets...)
+ desc := fmt.Sprintf("once the following is met:\n%s\nmust have:\n%s",
+ indent(pre.Description), indent(post.Description))
return Expectation{
Check: check,
- Description: fmt.Sprintf("once %q is met, must have:\n%s", precondition.Description, description),
- }
-}
-
-func describeExpectations(expectations ...Expectation) string {
- var descriptions []string
- for _, e := range expectations {
- descriptions = append(descriptions, e.Description)
+ Description: desc,
}
- return strings.Join(descriptions, "\n")
}
// Not inverts the sense of an expectation: a met expectation is unmet, and an
// unmet expectation is met.
func Not(e Expectation) Expectation {
- check := func(s State) Verdict {
- switch v := e.Check(s); v {
+ check := func(s State) (Verdict, string) {
+ switch v, _ := e.Check(s); v {
case Met:
- return Unmet
+ return Unmet, "condition unexpectedly satisfied"
case Unmet, Unmeetable:
- return Met
+ return Met, ""
default:
panic(fmt.Sprintf("unexpected verdict %v", v))
}
}
- description := describeExpectations(e)
return Expectation{
Check: check,
- Description: fmt.Sprintf("not: %s", description),
+ Description: fmt.Sprintf("not: %s", e.Description),
}
}
// AnyOf returns an expectation that is satisfied when any of the given
// expectations is met.
func AnyOf(anyOf ...Expectation) Expectation {
- check := func(s State) Verdict {
+ if len(anyOf) == 1 {
+ return anyOf[0] // avoid unnecessary boilerplate
+ }
+ check := func(s State) (Verdict, string) {
for _, e := range anyOf {
- verdict := e.Check(s)
+ verdict, _ := e.Check(s)
if verdict == Met {
- return Met
+ return Met, ""
}
}
- return Unmet
+ return Unmet, "none of the expectations were met"
}
description := describeExpectations(anyOf...)
return Expectation{
Check: check,
- Description: fmt.Sprintf("Any of:\n%s", description),
+ Description: fmt.Sprintf("any of:\n%s", description),
}
}
// AllOf expects that all given expectations are met.
-//
-// TODO(rfindley): the problem with these types of combinators (OnceMet, AnyOf
-// and AllOf) is that we lose the information of *why* they failed: the Awaiter
-// is not smart enough to look inside.
-//
-// Refactor the API such that the Check function is responsible for explaining
-// why an expectation failed. This should allow us to significantly improve
-// test output: we won't need to summarize state at all, as the verdict
-// explanation itself should describe clearly why the expectation not met.
func AllOf(allOf ...Expectation) Expectation {
- check := func(s State) Verdict {
- verdict := Met
+ if len(allOf) == 1 {
+ return allOf[0] // avoid unnecessary boilerplate
+ }
+ check := func(s State) (Verdict, string) {
+ var (
+ verdict = Met
+ reason string
+ )
for _, e := range allOf {
- if v := e.Check(s); v > verdict {
+ v, why := e.Check(s)
+ if v > verdict {
verdict = v
+ reason = why
}
}
- return verdict
+ return verdict, reason
}
- description := describeExpectations(allOf...)
+ desc := describeExpectations(allOf...)
return Expectation{
Check: check,
- Description: fmt.Sprintf("All of:\n%s", description),
+ Description: fmt.Sprintf("all of:\n%s", indent(desc)),
}
}
+func describeExpectations(expectations ...Expectation) string {
+ var descriptions []string
+ for _, e := range expectations {
+ descriptions = append(descriptions, e.Description)
+ }
+ return strings.Join(descriptions, "\n")
+}
+
// ReadDiagnostics is an Expectation that stores the current diagnostics for
// fileName in into, whenever it is evaluated.
//
// It can be used in combination with OnceMet or AfterChange to capture the
// state of diagnostics when other expectations are satisfied.
func ReadDiagnostics(fileName string, into *protocol.PublishDiagnosticsParams) Expectation {
- check := func(s State) Verdict {
+ check := func(s State) (Verdict, string) {
diags, ok := s.diagnostics[fileName]
if !ok {
- return Unmeetable
+ return Unmeetable, fmt.Sprintf("no diagnostics for %q", fileName)
}
*into = *diags
- return Met
+ return Met, ""
}
return Expectation{
Check: check,
@@ -198,13 +196,10 @@ func ReadDiagnostics(fileName string, into *protocol.PublishDiagnosticsParams) E
// It can be used in combination with OnceMet or AfterChange to capture the
// state of diagnostics when other expectations are satisfied.
func ReadAllDiagnostics(into *map[string]*protocol.PublishDiagnosticsParams) Expectation {
- check := func(s State) Verdict {
- allDiags := make(map[string]*protocol.PublishDiagnosticsParams)
- for name, diags := range s.diagnostics {
- allDiags[name] = diags
- }
+ check := func(s State) (Verdict, string) {
+ allDiags := maps.Clone(s.diagnostics)
*into = allDiags
- return Met
+ return Met, ""
}
return Expectation{
Check: check,
@@ -215,13 +210,13 @@ func ReadAllDiagnostics(into *map[string]*protocol.PublishDiagnosticsParams) Exp
// ShownDocument asserts that the client has received a
// ShowDocumentRequest for the given URI.
func ShownDocument(uri protocol.URI) Expectation {
- check := func(s State) Verdict {
+ check := func(s State) (Verdict, string) {
for _, params := range s.showDocument {
if params.URI == uri {
- return Met
+ return Met, ""
}
}
- return Unmet
+ return Unmet, fmt.Sprintf("no ShowDocumentRequest received for %s", uri)
}
return Expectation{
Check: check,
@@ -236,9 +231,9 @@ func ShownDocument(uri protocol.URI) Expectation {
// capture the set of showDocument requests when other expectations
// are satisfied.
func ShownDocuments(into *[]*protocol.ShowDocumentParams) Expectation {
- check := func(s State) Verdict {
+ check := func(s State) (Verdict, string) {
*into = append(*into, s.showDocument...)
- return Met
+ return Met, ""
}
return Expectation{
Check: check,
@@ -247,31 +242,39 @@ func ShownDocuments(into *[]*protocol.ShowDocumentParams) Expectation {
}
// NoShownMessage asserts that the editor has not received a ShowMessage.
-func NoShownMessage(subString string) Expectation {
- check := func(s State) Verdict {
+func NoShownMessage(containing string) Expectation {
+ check := func(s State) (Verdict, string) {
for _, m := range s.showMessage {
- if strings.Contains(m.Message, subString) {
- return Unmeetable
+ if strings.Contains(m.Message, containing) {
+ // Format the message (which may contain newlines) as a block quote.
+ msg := fmt.Sprintf("\"\"\"\n%s\n\"\"\"", strings.TrimSpace(m.Message))
+ return Unmeetable, fmt.Sprintf("observed the following message:\n%s", indent(msg))
}
}
- return Met
+ return Met, ""
+ }
+ var desc string
+ if containing != "" {
+ desc = fmt.Sprintf("received no ShowMessage containing %q", containing)
+ } else {
+ desc = "received no ShowMessage requests"
}
return Expectation{
Check: check,
- Description: fmt.Sprintf("no ShowMessage received containing %q", subString),
+ Description: desc,
}
}
// ShownMessage asserts that the editor has received a ShowMessageRequest
// containing the given substring.
func ShownMessage(containing string) Expectation {
- check := func(s State) Verdict {
+ check := func(s State) (Verdict, string) {
for _, m := range s.showMessage {
if strings.Contains(m.Message, containing) {
- return Met
+ return Met, ""
}
}
- return Unmet
+ return Unmet, fmt.Sprintf("no ShowMessage containing %q", containing)
}
return Expectation{
Check: check,
@@ -281,22 +284,22 @@ func ShownMessage(containing string) Expectation {
// ShownMessageRequest asserts that the editor has received a
// ShowMessageRequest with message matching the given regular expression.
-func ShownMessageRequest(messageRegexp string) Expectation {
- msgRE := regexp.MustCompile(messageRegexp)
- check := func(s State) Verdict {
+func ShownMessageRequest(matchingRegexp string) Expectation {
+ msgRE := regexp.MustCompile(matchingRegexp)
+ check := func(s State) (Verdict, string) {
if len(s.showMessageRequest) == 0 {
- return Unmet
+ return Unmet, "no ShowMessageRequest have been received"
}
for _, m := range s.showMessageRequest {
if msgRE.MatchString(m.Message) {
- return Met
+ return Met, ""
}
}
- return Unmet
+ return Unmet, fmt.Sprintf("no ShowMessageRequest (out of %d) match %q", len(s.showMessageRequest), matchingRegexp)
}
return Expectation{
Check: check,
- Description: fmt.Sprintf("ShowMessageRequest matching %q", messageRegexp),
+ Description: fmt.Sprintf("ShowMessageRequest matching %q", matchingRegexp),
}
}
@@ -328,9 +331,7 @@ func (e *Env) DoneDiagnosingChanges() Expectation {
}
// Sort for stability.
- sort.Slice(expected, func(i, j int) bool {
- return expected[i] < expected[j]
- })
+ slices.Sort(expected)
var all []Expectation
for _, source := range expected {
@@ -351,7 +352,7 @@ func (e *Env) DoneDiagnosingChanges() Expectation {
// - workspace/didChangeWatchedFiles
// - workspace/didChangeConfiguration
func (e *Env) AfterChange(expectations ...Expectation) {
- e.T.Helper()
+ e.TB.Helper()
e.OnceMet(
e.DoneDiagnosingChanges(),
expectations...,
@@ -411,15 +412,16 @@ func (e *Env) DoneWithClose() Expectation {
//
// See CompletedWork.
func StartedWork(title string, atLeast uint64) Expectation {
- check := func(s State) Verdict {
- if s.startedWork[title] >= atLeast {
- return Met
+ check := func(s State) (Verdict, string) {
+ started := s.startedWork[title]
+ if started >= atLeast {
+ return Met, ""
}
- return Unmet
+ return Unmet, fmt.Sprintf("started work %d %s", started, pluralize("time", started))
}
return Expectation{
Check: check,
- Description: fmt.Sprintf("started work %q at least %d time(s)", title, atLeast),
+ Description: fmt.Sprintf("started work %q at least %d %s", title, atLeast, pluralize("time", atLeast)),
}
}
@@ -428,16 +430,16 @@ func StartedWork(title string, atLeast uint64) Expectation {
// Since the Progress API doesn't include any hidden metadata, we must use the
// progress notification title to identify the work we expect to be completed.
func CompletedWork(title string, count uint64, atLeast bool) Expectation {
- check := func(s State) Verdict {
+ check := func(s State) (Verdict, string) {
completed := s.completedWork[title]
if completed == count || atLeast && completed > count {
- return Met
+ return Met, ""
}
- return Unmet
+ return Unmet, fmt.Sprintf("completed %d %s", completed, pluralize("time", completed))
}
- desc := fmt.Sprintf("completed work %q %v times", title, count)
+ desc := fmt.Sprintf("completed work %q %v %s", title, count, pluralize("time", count))
if atLeast {
- desc = fmt.Sprintf("completed work %q at least %d time(s)", title, count)
+ desc = fmt.Sprintf("completed work %q at least %d %s", title, count, pluralize("time", count))
}
return Expectation{
Check: check,
@@ -445,6 +447,14 @@ func CompletedWork(title string, count uint64, atLeast bool) Expectation {
}
}
+// pluralize adds an 's' suffix to name if n > 1.
+func pluralize[T constraints.Integer](name string, n T) string {
+ if n > 1 {
+ return name + "s"
+ }
+ return name
+}
+
type WorkStatus struct {
// Last seen message from either `begin` or `report` progress.
Msg string
@@ -459,24 +469,23 @@ type WorkStatus struct {
// If the token is not a progress token that the client has seen, this
// expectation is Unmeetable.
func CompletedProgressToken(token protocol.ProgressToken, into *WorkStatus) Expectation {
- check := func(s State) Verdict {
+ check := func(s State) (Verdict, string) {
work, ok := s.work[token]
if !ok {
- return Unmeetable // TODO(rfindley): refactor to allow the verdict to explain this result
+ return Unmeetable, "no matching work items"
}
if work.complete {
if into != nil {
into.Msg = work.msg
into.EndMsg = work.endMsg
}
- return Met
+ return Met, ""
}
- return Unmet
+ return Unmet, fmt.Sprintf("work is not complete; last message: %q", work.msg)
}
- desc := fmt.Sprintf("completed work for token %v", token)
return Expectation{
Check: check,
- Description: desc,
+ Description: fmt.Sprintf("completed work for token %v", token),
}
}
@@ -488,28 +497,27 @@ func CompletedProgressToken(token protocol.ProgressToken, into *WorkStatus) Expe
// This expectation is a vestige of older workarounds for asynchronous command
// execution.
func CompletedProgress(title string, into *WorkStatus) Expectation {
- check := func(s State) Verdict {
+ check := func(s State) (Verdict, string) {
var work *workProgress
for _, w := range s.work {
if w.title == title {
if work != nil {
- // TODO(rfindley): refactor to allow the verdict to explain this result
- return Unmeetable // multiple matches
+ return Unmeetable, "multiple matching work items"
}
work = w
}
}
if work == nil {
- return Unmeetable // zero matches
+ return Unmeetable, "no matching work items"
}
if work.complete {
if into != nil {
into.Msg = work.msg
into.EndMsg = work.endMsg
}
- return Met
+ return Met, ""
}
- return Unmet
+ return Unmet, fmt.Sprintf("work is not complete; last message: %q", work.msg)
}
desc := fmt.Sprintf("exactly 1 completed workDoneProgress with title %v", title)
return Expectation{
@@ -522,16 +530,16 @@ func CompletedProgress(title string, into *WorkStatus) Expectation {
// be an exact match, whereas the given msg must only be contained in the work
// item's message.
func OutstandingWork(title, msg string) Expectation {
- check := func(s State) Verdict {
+ check := func(s State) (Verdict, string) {
for _, work := range s.work {
if work.complete {
continue
}
if work.title == title && strings.Contains(work.msg, msg) {
- return Met
+ return Met, ""
}
}
- return Unmet
+ return Unmet, "no matching work"
}
return Expectation{
Check: check,
@@ -548,7 +556,7 @@ func OutstandingWork(title, msg string) Expectation {
// TODO(rfindley): consider refactoring to treat outstanding work the same way
// we treat diagnostics: with an algebra of filters.
func NoOutstandingWork(ignore func(title, msg string) bool) Expectation {
- check := func(s State) Verdict {
+ check := func(s State) (Verdict, string) {
for _, w := range s.work {
if w.complete {
continue
@@ -563,9 +571,9 @@ func NoOutstandingWork(ignore func(title, msg string) bool) Expectation {
if ignore != nil && ignore(w.title, w.msg) {
continue
}
- return Unmet
+ return Unmet, fmt.Sprintf("found outstanding work %q: %q", w.title, w.msg)
}
- return Met
+ return Met, ""
}
return Expectation{
Check: check,
@@ -600,7 +608,7 @@ func LogMatching(typ protocol.MessageType, re string, count int, atLeast bool) E
if err != nil {
panic(err)
}
- check := func(state State) Verdict {
+ check := func(state State) (Verdict, string) {
var found int
for _, msg := range state.logs {
if msg.Type == typ && rec.Match([]byte(msg.Message)) {
@@ -609,14 +617,15 @@ func LogMatching(typ protocol.MessageType, re string, count int, atLeast bool) E
}
// Check for an exact or "at least" match.
if found == count || (found >= count && atLeast) {
- return Met
+ return Met, ""
}
// If we require an exact count, and have received more than expected, the
// expectation can never be met.
+ verdict := Unmet
if found > count && !atLeast {
- return Unmeetable
+ verdict = Unmeetable
}
- return Unmet
+ return verdict, fmt.Sprintf("found %d matching logs", found)
}
desc := fmt.Sprintf("log message matching %q expected %v times", re, count)
if atLeast {
@@ -640,20 +649,24 @@ func NoLogMatching(typ protocol.MessageType, re string) Expectation {
panic(err)
}
}
- check := func(state State) Verdict {
+ check := func(state State) (Verdict, string) {
for _, msg := range state.logs {
if msg.Type != typ {
continue
}
if r == nil || r.Match([]byte(msg.Message)) {
- return Unmeetable
+ return Unmeetable, fmt.Sprintf("found matching log %q", msg.Message)
}
}
- return Met
+ return Met, ""
+ }
+ desc := fmt.Sprintf("no %s log messages", typ)
+ if re != "" {
+ desc += fmt.Sprintf(" matching %q", re)
}
return Expectation{
Check: check,
- Description: fmt.Sprintf("no log message matching %q", re),
+ Description: desc,
}
}
@@ -673,18 +686,18 @@ func NoFileWatchMatching(re string) Expectation {
}
}
-func checkFileWatch(re string, onMatch, onNoMatch Verdict) func(State) Verdict {
+func checkFileWatch(re string, onMatch, onNoMatch Verdict) func(State) (Verdict, string) {
rec := regexp.MustCompile(re)
- return func(s State) Verdict {
+ return func(s State) (Verdict, string) {
r := s.registeredCapabilities["workspace/didChangeWatchedFiles"]
- watchers := jsonProperty(r.RegisterOptions, "watchers").([]interface{})
+ watchers := jsonProperty(r.RegisterOptions, "watchers").([]any)
for _, watcher := range watchers {
pattern := jsonProperty(watcher, "globPattern").(string)
if rec.MatchString(pattern) {
- return onMatch
+ return onMatch, fmt.Sprintf("matches watcher pattern %q", pattern)
}
}
- return onNoMatch
+ return onNoMatch, "no matching watchers"
}
}
@@ -699,18 +712,22 @@ func checkFileWatch(re string, onMatch, onNoMatch Verdict) func(State) Verdict {
// }
//
// Then jsonProperty(obj, "foo", "bar") will be 3.
-func jsonProperty(obj interface{}, path ...string) interface{} {
+func jsonProperty(obj any, path ...string) any {
if len(path) == 0 || obj == nil {
return obj
}
- m := obj.(map[string]interface{})
+ m := obj.(map[string]any)
return jsonProperty(m[path[0]], path[1:]...)
}
+func formatDiagnostic(d protocol.Diagnostic) string {
+ return fmt.Sprintf("%d:%d [%s]: %s\n", d.Range.Start.Line, d.Range.Start.Character, d.Source, d.Message)
+}
+
// Diagnostics asserts that there is at least one diagnostic matching the given
// filters.
func Diagnostics(filters ...DiagnosticFilter) Expectation {
- check := func(s State) Verdict {
+ check := func(s State) (Verdict, string) {
diags := flattenDiagnostics(s)
for _, filter := range filters {
var filtered []flatDiagnostic
@@ -720,14 +737,22 @@ func Diagnostics(filters ...DiagnosticFilter) Expectation {
}
}
if len(filtered) == 0 {
- // TODO(rfindley): if/when expectations describe their own failure, we
- // can provide more useful information here as to which filter caused
- // the failure.
- return Unmet
+ // Reprinting the description of the filters is too verbose.
+ //
+ // We can probably do better here, but for now just format the
+ // diagnostics.
+ var b bytes.Buffer
+ for name, params := range s.diagnostics {
+ fmt.Fprintf(&b, "\t%s (version %d):\n", name, params.Version)
+ for _, d := range params.Diagnostics {
+ fmt.Fprintf(&b, "\t\t%s", formatDiagnostic(d))
+ }
+ }
+ return Unmet, fmt.Sprintf("diagnostics:\n%s", b.String())
}
diags = filtered
}
- return Met
+ return Met, ""
}
var descs []string
for _, filter := range filters {
@@ -743,7 +768,7 @@ func Diagnostics(filters ...DiagnosticFilter) Expectation {
// filters. Notably, if no filters are supplied this assertion checks that
// there are no diagnostics at all, for any file.
func NoDiagnostics(filters ...DiagnosticFilter) Expectation {
- check := func(s State) Verdict {
+ check := func(s State) (Verdict, string) {
diags := flattenDiagnostics(s)
for _, filter := range filters {
var filtered []flatDiagnostic
@@ -755,9 +780,11 @@ func NoDiagnostics(filters ...DiagnosticFilter) Expectation {
diags = filtered
}
if len(diags) > 0 {
- return Unmet
+ d := diags[0]
+ why := fmt.Sprintf("have diagnostic: %s: %v", d.name, formatDiagnostic(d.diag))
+ return Unmet, why
}
- return Met
+ return Met, ""
}
var descs []string
for _, filter := range filters {
diff --git a/gopls/internal/test/integration/fake/client.go b/gopls/internal/test/integration/fake/client.go
index 93eeab4a8af..aee6c1cfc3e 100644
--- a/gopls/internal/test/integration/fake/client.go
+++ b/gopls/internal/test/integration/fake/client.go
@@ -103,7 +103,7 @@ func (c *Client) LogMessage(ctx context.Context, params *protocol.LogMessagePara
return nil
}
-func (c *Client) Event(ctx context.Context, event *interface{}) error {
+func (c *Client) Event(ctx context.Context, event *any) error {
return nil
}
@@ -118,8 +118,8 @@ func (c *Client) WorkspaceFolders(context.Context) ([]protocol.WorkspaceFolder,
return []protocol.WorkspaceFolder{}, nil
}
-func (c *Client) Configuration(_ context.Context, p *protocol.ParamConfiguration) ([]interface{}, error) {
- results := make([]interface{}, len(p.Items))
+func (c *Client) Configuration(_ context.Context, p *protocol.ParamConfiguration) ([]any, error) {
+ results := make([]any, len(p.Items))
for i, item := range p.Items {
if item.ScopeURI != nil && *item.ScopeURI == "" {
return nil, fmt.Errorf(`malformed ScopeURI ""`)
diff --git a/gopls/internal/test/integration/fake/editor.go b/gopls/internal/test/integration/fake/editor.go
index adc9df6c17d..01f3de8aba9 100644
--- a/gopls/internal/test/integration/fake/editor.go
+++ b/gopls/internal/test/integration/fake/editor.go
@@ -113,11 +113,12 @@ type EditorConfig struct {
// Map of language ID -> regexp to match, used to set the file type of new
// buffers. Applied as an overlay on top of the following defaults:
- // "go" -> ".*\.go"
+ // "go" -> ".*\.go"
// "go.mod" -> "go\.mod"
// "go.sum" -> "go\.sum"
// "gotmpl" -> ".*tmpl"
- FileAssociations map[string]string
+ // "go.s" -> ".*\.s"
+ FileAssociations map[protocol.LanguageKind]string
// Settings holds user-provided configuration for the LSP server.
Settings map[string]any
@@ -619,27 +620,28 @@ func (e *Editor) sendDidOpen(ctx context.Context, item protocol.TextDocumentItem
return nil
}
-var defaultFileAssociations = map[string]*regexp.Regexp{
+var defaultFileAssociations = map[protocol.LanguageKind]*regexp.Regexp{
"go": regexp.MustCompile(`^.*\.go$`), // '$' is important: don't match .gotmpl!
"go.mod": regexp.MustCompile(`^go\.mod$`),
"go.sum": regexp.MustCompile(`^go(\.work)?\.sum$`),
"go.work": regexp.MustCompile(`^go\.work$`),
"gotmpl": regexp.MustCompile(`^.*tmpl$`),
+ "go.s": regexp.MustCompile(`\.s$`),
}
// languageID returns the language identifier for the path p given the user
// configured fileAssociations.
-func languageID(p string, fileAssociations map[string]string) protocol.LanguageKind {
+func languageID(p string, fileAssociations map[protocol.LanguageKind]string) protocol.LanguageKind {
base := path.Base(p)
for lang, re := range fileAssociations {
re := regexp.MustCompile(re)
if re.MatchString(base) {
- return protocol.LanguageKind(lang)
+ return lang
}
}
for lang, re := range defaultFileAssociations {
if re.MatchString(base) {
- return protocol.LanguageKind(lang)
+ return lang
}
}
return ""
@@ -1307,6 +1309,19 @@ func (e *Editor) Completion(ctx context.Context, loc protocol.Location) (*protoc
return completions, nil
}
+func (e *Editor) DidCreateFiles(ctx context.Context, files ...protocol.DocumentURI) error {
+ if e.Server == nil {
+ return nil
+ }
+ params := &protocol.CreateFilesParams{}
+ for _, file := range files {
+ params.Files = append(params.Files, protocol.FileCreate{
+ URI: string(file),
+ })
+ }
+ return e.Server.DidCreateFiles(ctx, params)
+}
+
func (e *Editor) SetSuggestionInsertReplaceMode(_ context.Context, useReplaceMode bool) {
e.mu.Lock()
defer e.mu.Unlock()
diff --git a/gopls/internal/test/integration/fake/glob/glob.go b/gopls/internal/test/integration/fake/glob/glob.go
index a540ebefac5..3bda93bee6d 100644
--- a/gopls/internal/test/integration/fake/glob/glob.go
+++ b/gopls/internal/test/integration/fake/glob/glob.go
@@ -217,7 +217,7 @@ func (g *Glob) Match(input string) bool {
}
func match(elems []element, input string) (ok bool) {
- var elem interface{}
+ var elem any
for len(elems) > 0 {
elem, elems = elems[0], elems[1:]
switch elem := elem.(type) {
diff --git a/gopls/internal/test/integration/fake/sandbox.go b/gopls/internal/test/integration/fake/sandbox.go
index 7adf3e3e4a9..1d8918babd4 100644
--- a/gopls/internal/test/integration/fake/sandbox.go
+++ b/gopls/internal/test/integration/fake/sandbox.go
@@ -208,6 +208,7 @@ func (sb *Sandbox) GoEnv() map[string]string {
"GO111MODULE": "",
"GOSUMDB": "off",
"GOPACKAGESDRIVER": "off",
+ "GOTOOLCHAIN": "local", // tests should not download toolchains
}
if testenv.Go1Point() >= 5 {
vars["GOMODCACHE"] = ""
diff --git a/gopls/internal/test/integration/misc/codeactions_test.go b/gopls/internal/test/integration/misc/codeactions_test.go
index c62a3898e9b..d9c83186d69 100644
--- a/gopls/internal/test/integration/misc/codeactions_test.go
+++ b/gopls/internal/test/integration/misc/codeactions_test.go
@@ -35,25 +35,28 @@ package a
func f() { g() }
func g() {}
+
+-- issue72742/a.go --
+package main
+
+func main(){
+ fmt.Println("helloworld")
+}
`
Run(t, src, func(t *testing.T, env *Env) {
- check := func(filename string, wantKind ...protocol.CodeActionKind) {
+ check := func(filename string, re string, want []protocol.CodeActionKind) {
env.OpenFile(filename)
- loc := env.RegexpSearch(filename, `g\(\)`)
+ loc := env.RegexpSearch(filename, re)
actions, err := env.Editor.CodeAction(env.Ctx, loc, nil, protocol.CodeActionUnknownTrigger)
if err != nil {
t.Fatal(err)
}
- type kinds = map[protocol.CodeActionKind]bool
- got := make(kinds)
+ type kinds = []protocol.CodeActionKind
+ got := make(kinds, 0)
for _, act := range actions {
- got[act.Kind] = true
- }
- want := make(kinds)
- for _, kind := range wantKind {
- want[kind] = true
+ got = append(got, act.Kind)
}
if diff := cmp.Diff(want, got); diff != "" {
@@ -63,20 +66,33 @@ func g() {}
}
}
- check("src/a.go",
+ check("src/a.go", `g\(\)`, []protocol.CodeActionKind{
settings.AddTest,
settings.GoAssembly,
settings.GoDoc,
settings.GoFreeSymbols,
settings.GoToggleCompilerOptDetails,
+ settings.RefactorInlineCall,
settings.GoplsDocFeatures,
- settings.RefactorInlineCall)
- check("gen/a.go",
+ })
+
+ check("gen/a.go", `g\(\)`, []protocol.CodeActionKind{
settings.GoAssembly,
settings.GoDoc,
settings.GoFreeSymbols,
settings.GoToggleCompilerOptDetails,
- settings.GoplsDocFeatures)
+ settings.GoplsDocFeatures,
+ })
+
+ check("issue72742/a.go", `fmt`, []protocol.CodeActionKind{
+ settings.OrganizeImports,
+ settings.AddTest,
+ settings.GoAssembly,
+ settings.GoDoc,
+ settings.GoFreeSymbols,
+ settings.GoToggleCompilerOptDetails,
+ settings.GoplsDocFeatures,
+ })
})
}
diff --git a/gopls/internal/test/integration/misc/compileropt_test.go b/gopls/internal/test/integration/misc/compileropt_test.go
index 175ec640042..68138fabc43 100644
--- a/gopls/internal/test/integration/misc/compileropt_test.go
+++ b/gopls/internal/test/integration/misc/compileropt_test.go
@@ -166,3 +166,66 @@ func H(x int) any { return &x }
)
})
}
+
+// TestCompilerOptDetails_config exercises that the "want optimization
+// details" flag honors the "annotation" configuration setting.
+func TestCompilerOptDetails_config(t *testing.T) {
+ if runtime.GOOS == "android" {
+ t.Skipf("the compiler optimization details code action doesn't work on Android")
+ }
+
+ const mod = `
+-- go.mod --
+module mod.com
+go 1.18
+
+-- a/a.go --
+package a
+
+func F(x int) any { return &x } // escape(x escapes to heap)
+func G() { defer func(){} () } // cannotInlineFunction(unhandled op DEFER)
+`
+
+ for _, escape := range []bool{true, false} {
+ WithOptions(
+ Settings{"annotations": map[string]any{"inline": true, "escape": escape}},
+ ).Run(t, mod, func(t *testing.T, env *Env) {
+ env.OpenFile("a/a.go")
+ actions := env.CodeActionForFile("a/a.go", nil)
+
+ docAction, err := codeActionByKind(actions, settings.GoToggleCompilerOptDetails)
+ if err != nil {
+ t.Fatal(err)
+ }
+ params := &protocol.ExecuteCommandParams{
+ Command: docAction.Command.Command,
+ Arguments: docAction.Command.Arguments,
+ }
+ env.ExecuteCommand(params, nil)
+
+ env.OnceMet(
+ CompletedWork(server.DiagnosticWorkTitle(server.FromToggleCompilerOptDetails), 1, true),
+ cond(escape, Diagnostics, NoDiagnostics)(
+ ForFile("a/a.go"),
+ AtPosition("a/a.go", 2, 7),
+ WithMessage("x escapes to heap"),
+ WithSeverityTags("optimizer details", protocol.SeverityInformation, nil),
+ ),
+ Diagnostics(
+ ForFile("a/a.go"),
+ AtPosition("a/a.go", 3, 5),
+ WithMessage("cannotInlineFunction(unhandled op DEFER)"),
+ WithSeverityTags("optimizer details", protocol.SeverityInformation, nil),
+ ),
+ )
+ })
+ }
+}
+
+func cond[T any](cond bool, x, y T) T {
+ if cond {
+ return x
+ } else {
+ return y
+ }
+}
diff --git a/gopls/internal/test/integration/misc/highlight_test.go b/gopls/internal/test/integration/misc/highlight_test.go
index e4da558e5d0..36bddf25057 100644
--- a/gopls/internal/test/integration/misc/highlight_test.go
+++ b/gopls/internal/test/integration/misc/highlight_test.go
@@ -124,7 +124,7 @@ func main() {}`
}
func checkHighlights(env *Env, loc protocol.Location, highlightCount int) {
- t := env.T
+ t := env.TB
t.Helper()
highlights := env.DocumentHighlight(loc)
diff --git a/gopls/internal/test/integration/misc/imports_test.go b/gopls/internal/test/integration/misc/imports_test.go
index 98a70478ecf..bcbfacc967a 100644
--- a/gopls/internal/test/integration/misc/imports_test.go
+++ b/gopls/internal/test/integration/misc/imports_test.go
@@ -401,6 +401,31 @@ return nil
}
})
}
+
+// use the import from a different package in the same module
+func Test44510(t *testing.T) {
+ const files = `-- go.mod --
+module test
+go 1.19
+-- foo/foo.go --
+package main
+import strs "strings"
+var _ = strs.Count
+-- bar/bar.go --
+package main
+var _ = strs.Builder
+`
+ WithOptions(
+ WriteGoSum("."),
+ ).Run(t, files, func(T *testing.T, env *Env) {
+ env.OpenFile("bar/bar.go")
+ env.SaveBuffer("bar/bar.go")
+ buf := env.BufferText("bar/bar.go")
+ if !strings.Contains(buf, "strs") {
+ t.Error(buf)
+ }
+ })
+}
func TestRelativeReplace(t *testing.T) {
const files = `
-- go.mod --
@@ -688,3 +713,33 @@ func Test() {
}
})
}
+
+// this test replaces 'package bar' with 'package foo'
+// saves the file, and then looks for the import in the main package.s
+func Test67973(t *testing.T) {
+ const files = `-- go.mod --
+module hello
+go 1.19
+-- hello.go --
+package main
+var _ = foo.Bar
+-- internal/foo/foo.go --
+package bar
+func Bar() {}
+`
+ WithOptions(
+ Settings{"importsSource": settings.ImportsSourceGopls},
+ ).Run(t, files, func(t *testing.T, env *Env) {
+ env.OpenFile("hello.go")
+ env.AfterChange(env.DoneWithOpen())
+ env.SaveBuffer("hello.go")
+ env.OpenFile("internal/foo/foo.go")
+ env.RegexpReplace("internal/foo/foo.go", "bar", "foo")
+ env.SaveBuffer("internal/foo/foo.go")
+ env.SaveBuffer("hello.go")
+ buf := env.BufferText("hello.go")
+ if !strings.Contains(buf, "internal/foo") {
+ t.Errorf(`expected import "hello/internal/foo" but got %q`, buf)
+ }
+ })
+}
diff --git a/gopls/internal/test/integration/misc/package_symbols_test.go b/gopls/internal/test/integration/misc/package_symbols_test.go
index 860264f2bb0..1e06a655935 100644
--- a/gopls/internal/test/integration/misc/package_symbols_test.go
+++ b/gopls/internal/test/integration/misc/package_symbols_test.go
@@ -16,6 +16,11 @@ import (
func TestPackageSymbols(t *testing.T) {
const files = `
+-- go.mod --
+module example.com
+
+go 1.20
+
-- a.go --
package a
@@ -33,68 +38,74 @@ func (s *S) M2() {}
func (s *S) M3() {}
func F() {}
+-- unloaded.go --
+//go:build unloaded
+
+package a
+
+var Unloaded int
`
integration.Run(t, files, func(t *testing.T, env *integration.Env) {
- a_uri := env.Sandbox.Workdir.URI("a.go")
- b_uri := env.Sandbox.Workdir.URI("b.go")
+ aURI := env.Sandbox.Workdir.URI("a.go")
+ bURI := env.Sandbox.Workdir.URI("b.go")
args, err := command.MarshalArgs(command.PackageSymbolsArgs{
- URI: a_uri,
+ URI: aURI,
})
if err != nil {
- t.Fatalf("failed to MarshalArgs: %v", err)
+ t.Fatal(err)
}
var res command.PackageSymbolsResult
env.ExecuteCommand(&protocol.ExecuteCommandParams{
- Command: "gopls.package_symbols",
+ Command: command.PackageSymbols.String(),
Arguments: args,
}, &res)
want := command.PackageSymbolsResult{
PackageName: "a",
- Files: []protocol.DocumentURI{a_uri, b_uri},
+ Files: []protocol.DocumentURI{aURI, bURI},
Symbols: []command.PackageSymbol{
- {
- Name: "A",
- Kind: protocol.Variable,
- File: 0,
- },
- {
- Name: "F",
- Kind: protocol.Function,
- File: 1,
- },
- {
- Name: "S",
- Kind: protocol.Struct,
- File: 0,
- Children: []command.PackageSymbol{
- {
- Name: "M1",
- Kind: protocol.Method,
- File: 0,
- },
- {
- Name: "M2",
- Kind: protocol.Method,
- File: 1,
- },
- {
- Name: "M3",
- Kind: protocol.Method,
- File: 1,
- },
- },
- },
- {
- Name: "b",
- Kind: protocol.Variable,
- File: 1,
- },
+ {Name: "A", Kind: protocol.Variable, File: 0},
+ {Name: "F", Kind: protocol.Function, File: 1},
+ {Name: "S", Kind: protocol.Struct, File: 0, Children: []command.PackageSymbol{
+ {Name: "M1", Kind: protocol.Method, File: 0},
+ {Name: "M2", Kind: protocol.Method, File: 1},
+ {Name: "M3", Kind: protocol.Method, File: 1},
+ }},
+ {Name: "b", Kind: protocol.Variable, File: 1},
},
}
- if diff := cmp.Diff(want, res, cmpopts.IgnoreFields(command.PackageSymbol{}, "Range", "SelectionRange", "Detail")); diff != "" {
- t.Errorf("gopls.package_symbols returned unexpected diff (-want +got):\n%s", diff)
+ ignore := cmpopts.IgnoreFields(command.PackageSymbol{}, "Range", "SelectionRange", "Detail")
+ if diff := cmp.Diff(want, res, ignore); diff != "" {
+ t.Errorf("package_symbols returned unexpected diff (-want +got):\n%s", diff)
+ }
+
+ for file, want := range map[string]command.PackageSymbolsResult{
+ "go.mod": {},
+ "unloaded.go": {
+ PackageName: "a",
+ Files: []protocol.DocumentURI{env.Sandbox.Workdir.URI("unloaded.go")},
+ Symbols: []command.PackageSymbol{
+ {Name: "Unloaded", Kind: protocol.Variable, File: 0},
+ },
+ },
+ } {
+ uri := env.Sandbox.Workdir.URI(file)
+ args, err := command.MarshalArgs(command.PackageSymbolsArgs{
+ URI: uri,
+ })
+ if err != nil {
+ t.Fatal(err)
+ }
+ var res command.PackageSymbolsResult
+ env.ExecuteCommand(&protocol.ExecuteCommandParams{
+ Command: command.PackageSymbols.String(),
+ Arguments: args,
+ }, &res)
+
+ if diff := cmp.Diff(want, res, ignore); diff != "" {
+ t.Errorf("package_symbols returned unexpected diff (-want +got):\n%s", diff)
+ }
}
})
}
diff --git a/gopls/internal/test/integration/misc/references_test.go b/gopls/internal/test/integration/misc/references_test.go
index e84dcd71dc3..58fdb3c5cd8 100644
--- a/gopls/internal/test/integration/misc/references_test.go
+++ b/gopls/internal/test/integration/misc/references_test.go
@@ -126,7 +126,7 @@ var _ = unsafe.Slice(nil, 0)
Run(t, files, func(t *testing.T, env *Env) {
env.OpenFile("a.go")
- for _, name := range strings.Fields(
+ for name := range strings.FieldsSeq(
"iota error int nil append iota Pointer Sizeof Alignof Add Slice") {
loc := env.RegexpSearch("a.go", `\b`+name+`\b`)
diff --git a/gopls/internal/test/integration/misc/test_test.go b/gopls/internal/test/integration/misc/test_test.go
new file mode 100644
index 00000000000..b282bf57a95
--- /dev/null
+++ b/gopls/internal/test/integration/misc/test_test.go
@@ -0,0 +1,82 @@
+// Copyright 2025 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 misc
+
+// This file defines tests of the source.test ("Run tests and
+// benchmarks") code action.
+
+import (
+ "os"
+ "path/filepath"
+ "testing"
+
+ "golang.org/x/tools/gopls/internal/protocol"
+ "golang.org/x/tools/gopls/internal/settings"
+ . "golang.org/x/tools/gopls/internal/test/integration"
+)
+
+func TestRunTestsAndBenchmarks(t *testing.T) {
+ file := filepath.Join(t.TempDir(), "out")
+ os.Setenv("TESTFILE", file)
+
+ const src = `
+-- go.mod --
+module example.com
+go 1.19
+
+-- a/a.go --
+package a
+
+-- a/a_test.go --
+package a
+
+import (
+ "os"
+ "testing"
+)
+
+func Test(t *testing.T) {
+ os.WriteFile(os.Getenv("TESTFILE"), []byte("ok"), 0644)
+}
+
+`
+ Run(t, src, func(t *testing.T, env *Env) {
+ env.OpenFile("a/a_test.go")
+ loc := env.RegexpSearch("a/a_test.go", "WriteFile")
+
+ // Request code actions. (settings.GoTest is special:
+ // it is returned only when explicitly requested.)
+ actions, err := env.Editor.Server.CodeAction(env.Ctx, &protocol.CodeActionParams{
+ TextDocument: protocol.TextDocumentIdentifier{URI: loc.URI},
+ Range: loc.Range,
+ Context: protocol.CodeActionContext{
+ Only: []protocol.CodeActionKind{settings.GoTest},
+ },
+ })
+ if err != nil {
+ t.Fatal(err)
+ }
+ if len(actions) != 1 {
+ t.Fatalf("CodeAction returned %#v, want one source.test action", actions)
+ }
+ if actions[0].Command == nil {
+ t.Fatalf("CodeActions()[0] has no Command")
+ }
+
+ // Execute test.
+ // (ExecuteCommand fails if the test fails.)
+ t.Logf("Running %s...", actions[0].Title)
+ env.ExecuteCommand(&protocol.ExecuteCommandParams{
+ Command: actions[0].Command.Command,
+ Arguments: actions[0].Command.Arguments,
+ }, nil)
+
+ // Check test had expected side effect.
+ data, err := os.ReadFile(file)
+ if string(data) != "ok" {
+ t.Fatalf("Test did not write expected content of %s; ReadFile returned (%q, %v)", file, data, err)
+ }
+ })
+}
diff --git a/gopls/internal/test/integration/misc/webserver_test.go b/gopls/internal/test/integration/misc/webserver_test.go
index 2bde7df8aa2..691d45baa6e 100644
--- a/gopls/internal/test/integration/misc/webserver_test.go
+++ b/gopls/internal/test/integration/misc/webserver_test.go
@@ -520,43 +520,57 @@ module example.com
-- a/a.go --
package a
-func f() {
+func f(x int) int {
println("hello")
defer println("world")
+ return x
}
func g() {
println("goodbye")
}
+
+var v = [...]int{
+ f(123),
+ f(456),
+}
+
+func init() {
+ f(789)
+}
`
Run(t, files, func(t *testing.T, env *Env) {
env.OpenFile("a/a.go")
- // Invoke the "Browse assembly" code action to start the server.
- loc := env.RegexpSearch("a/a.go", "println")
- actions, err := env.Editor.CodeAction(env.Ctx, loc, nil, protocol.CodeActionUnknownTrigger)
- if err != nil {
- t.Fatalf("CodeAction: %v", err)
- }
- action, err := codeActionByKind(actions, settings.GoAssembly)
- if err != nil {
- t.Fatal(err)
- }
+ asmFor := func(pattern string) []byte {
+ // Invoke the "Browse assembly" code action to start the server.
+ loc := env.RegexpSearch("a/a.go", pattern)
+ actions, err := env.Editor.CodeAction(env.Ctx, loc, nil, protocol.CodeActionUnknownTrigger)
+ if err != nil {
+ t.Fatalf("CodeAction: %v", err)
+ }
+ action, err := codeActionByKind(actions, settings.GoAssembly)
+ if err != nil {
+ t.Fatal(err)
+ }
- // Execute the command.
- // Its side effect should be a single showDocument request.
- params := &protocol.ExecuteCommandParams{
- Command: action.Command.Command,
- Arguments: action.Command.Arguments,
- }
- var result command.DebuggingResult
- collectDocs := env.Awaiter.ListenToShownDocuments()
- env.ExecuteCommand(params, &result)
- doc := shownDocument(t, collectDocs(), "http:")
- if doc == nil {
- t.Fatalf("no showDocument call had 'file:' prefix")
+ // Execute the command.
+ // Its side effect should be a single showDocument request.
+ params := &protocol.ExecuteCommandParams{
+ Command: action.Command.Command,
+ Arguments: action.Command.Arguments,
+ }
+ var result command.DebuggingResult
+ collectDocs := env.Awaiter.ListenToShownDocuments()
+ env.ExecuteCommand(params, &result)
+ doc := shownDocument(t, collectDocs(), "http:")
+ if doc == nil {
+ t.Fatalf("no showDocument call had 'file:' prefix")
+ }
+ t.Log("showDocument(package doc) URL:", doc.URI)
+
+ return get(t, doc.URI)
}
- t.Log("showDocument(package doc) URL:", doc.URI)
// Get the report and do some minimal checks for sensible results.
//
@@ -567,23 +581,50 @@ func g() {
// (e.g. uses JAL for CALL, or BL for RET).
// We conservatively test only on the two most popular
// architectures.
- report := get(t, doc.URI)
- checkMatch(t, true, report, `TEXT.*example.com/a.f`)
- switch runtime.GOARCH {
- case "amd64", "arm64":
- checkMatch(t, true, report, `CALL runtime.printlock`)
- checkMatch(t, true, report, `CALL runtime.printstring`)
- checkMatch(t, true, report, `CALL runtime.printunlock`)
- checkMatch(t, true, report, `CALL example.com/a.f.deferwrap1`)
- checkMatch(t, true, report, `RET`)
- checkMatch(t, true, report, `CALL runtime.morestack_noctxt`)
+ {
+ report := asmFor("println")
+ checkMatch(t, true, report, `TEXT.*example.com/a.f`)
+ switch runtime.GOARCH {
+ case "amd64", "arm64":
+ checkMatch(t, true, report, `CALL runtime.printlock`)
+ checkMatch(t, true, report, `CALL runtime.printstring`)
+ checkMatch(t, true, report, `CALL runtime.printunlock`)
+ checkMatch(t, true, report, `CALL example.com/a.f.deferwrap`)
+ checkMatch(t, true, report, `RET`)
+ checkMatch(t, true, report, `CALL runtime.morestack_noctxt`)
+ }
+
+ // Nested functions are also shown.
+ //
+ // The condition here was relaxed to unblock go.dev/cl/639515.
+ checkMatch(t, true, report, `example.com/a.f.deferwrap`)
+
+ // But other functions are not.
+ checkMatch(t, false, report, `TEXT.*example.com/a.g`)
}
- // Nested functions are also shown.
- checkMatch(t, true, report, `TEXT.*example.com/a.f.deferwrap1`)
+ // Check that code in a package-level var initializer is found too.
+ {
+ report := asmFor(`f\(123\)`)
+ switch runtime.GOARCH {
+ case "amd64", "arm64":
+ checkMatch(t, true, report, `TEXT.*example.com/a.init`)
+ checkMatch(t, true, report, `MOV.? \$123`)
+ checkMatch(t, true, report, `MOV.? \$456`)
+ checkMatch(t, true, report, `CALL example.com/a.f`)
+ }
+ }
- // But other functions are not.
- checkMatch(t, false, report, `TEXT.*example.com/a.g`)
+ // And code in a source-level init function.
+ {
+ report := asmFor(`f\(789\)`)
+ switch runtime.GOARCH {
+ case "amd64", "arm64":
+ checkMatch(t, true, report, `TEXT.*example.com/a.init`)
+ checkMatch(t, true, report, `MOV.? \$789`)
+ checkMatch(t, true, report, `CALL example.com/a.f`)
+ }
+ }
})
}
diff --git a/gopls/internal/test/integration/misc/workspace_symbol_test.go b/gopls/internal/test/integration/misc/workspace_symbol_test.go
index 9420b146d85..f1148539447 100644
--- a/gopls/internal/test/integration/misc/workspace_symbol_test.go
+++ b/gopls/internal/test/integration/misc/workspace_symbol_test.go
@@ -8,8 +8,8 @@ import (
"testing"
"github.com/google/go-cmp/cmp"
- . "golang.org/x/tools/gopls/internal/test/integration"
"golang.org/x/tools/gopls/internal/settings"
+ . "golang.org/x/tools/gopls/internal/test/integration"
)
func TestWorkspaceSymbolMissingMetadata(t *testing.T) {
@@ -103,12 +103,12 @@ const (
}
func checkSymbols(env *Env, query string, want ...string) {
- env.T.Helper()
+ env.TB.Helper()
var got []string
for _, info := range env.Symbol(query) {
got = append(got, info.Name)
}
if diff := cmp.Diff(got, want); diff != "" {
- env.T.Errorf("unexpected Symbol(%q) result (+want -got):\n%s", query, diff)
+ env.TB.Errorf("unexpected Symbol(%q) result (+want -got):\n%s", query, diff)
}
}
diff --git a/gopls/internal/test/integration/options.go b/gopls/internal/test/integration/options.go
index 8090388e17d..11824aa7c16 100644
--- a/gopls/internal/test/integration/options.go
+++ b/gopls/internal/test/integration/options.go
@@ -25,7 +25,7 @@ type runConfig struct {
func defaultConfig() runConfig {
return runConfig{
editor: fake.EditorConfig{
- Settings: map[string]interface{}{
+ Settings: map[string]any{
// Shorten the diagnostic delay to speed up test execution (else we'd add
// the default delay to each assertion about diagnostics)
"diagnosticsDelay": "10ms",
@@ -109,11 +109,11 @@ func CapabilitiesJSON(capabilities []byte) RunOption {
//
// As a special case, the env setting must not be provided via Settings: use
// EnvVars instead.
-type Settings map[string]interface{}
+type Settings map[string]any
func (s Settings) set(opts *runConfig) {
if opts.editor.Settings == nil {
- opts.editor.Settings = make(map[string]interface{})
+ opts.editor.Settings = make(map[string]any)
}
for k, v := range s {
opts.editor.Settings[k] = v
diff --git a/gopls/internal/test/integration/runner.go b/gopls/internal/test/integration/runner.go
index 6d10b16cab3..c4609cb8f91 100644
--- a/gopls/internal/test/integration/runner.go
+++ b/gopls/internal/test/integration/runner.go
@@ -173,7 +173,7 @@ func (r *Runner) Run(t *testing.T, files string, test TestFunc, opts ...RunOptio
}
// TODO(rfindley): do we need an instance at all? Can it be removed?
- ctx = debug.WithInstance(ctx, "off")
+ ctx = debug.WithInstance(ctx)
rootDir := filepath.Join(r.tempDir, filepath.FromSlash(t.Name()))
if err := os.MkdirAll(rootDir, 0755); err != nil {
@@ -253,7 +253,7 @@ func ConnectGoplsEnv(t testing.TB, ctx context.Context, sandbox *fake.Sandbox, c
t.Fatal(err)
}
env := &Env{
- T: t,
+ TB: t,
Ctx: ctx,
Sandbox: sandbox,
Server: connector,
@@ -266,10 +266,10 @@ func ConnectGoplsEnv(t testing.TB, ctx context.Context, sandbox *fake.Sandbox, c
// longBuilders maps builders that are skipped when -short is set to a
// (possibly empty) justification.
var longBuilders = map[string]string{
- "openbsd-amd64-64": "go.dev/issue/42789",
- "openbsd-386-64": "go.dev/issue/42789",
- "openbsd-386-68": "go.dev/issue/42789",
- "openbsd-amd64-68": "go.dev/issue/42789",
+ "x_tools-gotip-openbsd-amd64": "go.dev/issue/72145",
+ "x_tools-go1.24-openbsd-amd64": "go.dev/issue/72145",
+ "x_tools-go1.23-openbsd-amd64": "go.dev/issue/72145",
+
"darwin-amd64-10_12": "",
"freebsd-amd64-race": "",
"illumos-amd64": "",
@@ -349,7 +349,7 @@ func (r *Runner) defaultServer() jsonrpc2.StreamServer {
func (r *Runner) forwardedServer() jsonrpc2.StreamServer {
r.tsOnce.Do(func() {
ctx := context.Background()
- ctx = debug.WithInstance(ctx, "off")
+ ctx = debug.WithInstance(ctx)
ss := lsprpc.NewStreamServer(cache.New(nil), false, nil)
r.ts = servertest.NewTCPServer(ctx, ss, nil)
})
diff --git a/gopls/internal/test/integration/workspace/didcreatefiles_test.go b/gopls/internal/test/integration/workspace/didcreatefiles_test.go
new file mode 100644
index 00000000000..cba0daf472e
--- /dev/null
+++ b/gopls/internal/test/integration/workspace/didcreatefiles_test.go
@@ -0,0 +1,146 @@
+// Copyright 2025 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 workspace
+
+import (
+ "context"
+ "fmt"
+ "testing"
+
+ . "golang.org/x/tools/gopls/internal/test/integration"
+)
+
+// TestAutoFillPackageDecl tests that creation of a new .go file causes
+// gopls to choose a sensible package name and fill in the package declaration.
+func TestAutoFillPackageDecl(t *testing.T) {
+ const existFiles = `
+-- go.mod --
+module mod.com
+
+go 1.12
+
+-- dog/a_test.go --
+package dog
+-- fruits/apple.go --
+package apple
+
+fun apple() int {
+ return 0
+}
+
+-- license/license.go --
+/* Copyright 2025 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 license
+
+-- license1/license.go --
+// Copyright 2025 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 license1
+
+-- cmd/main.go --
+package main
+
+-- integration/a_test.go --
+package integration_test
+
+-- nopkg/testfile.go --
+package
+`
+ for _, tc := range []struct {
+ name string
+ newfile string
+ want string
+ }{
+ {
+ name: "new file in folder with a_test.go",
+ newfile: "dog/newfile.go",
+ want: "package dog\n",
+ },
+ {
+ name: "new file in folder with go file",
+ newfile: "fruits/newfile.go",
+ want: "package apple\n",
+ },
+ {
+ name: "new test file in folder with go file",
+ newfile: "fruits/newfile_test.go",
+ want: "package apple\n",
+ },
+ {
+ name: "new file in folder with go file that contains license comment",
+ newfile: "license/newfile.go",
+ want: `/* Copyright 2025 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 license
+`,
+ },
+ {
+ name: "new file in folder with go file that contains license comment",
+ newfile: "license1/newfile.go",
+ want: `// Copyright 2025 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 license1
+`,
+ },
+ {
+ name: "new file in folder with main package",
+ newfile: "cmd/newfile.go",
+ want: "package main\n",
+ },
+ {
+ name: "new file in empty folder",
+ newfile: "empty_folder/newfile.go",
+ want: "package emptyfolder\n",
+ },
+ {
+ name: "new file in folder with integration_test package",
+ newfile: "integration/newfile.go",
+ want: "package integration\n",
+ },
+ {
+ name: "new test file in folder with integration_test package",
+ newfile: "integration/newfile_test.go",
+ want: "package integration\n",
+ },
+ {
+ name: "new file in folder with incomplete package clause",
+ newfile: "incomplete/newfile.go",
+ want: "package incomplete\n",
+ },
+ {
+ name: "package completion for dir name with punctuation",
+ newfile: "123f_r.u~its-123/newfile.go",
+ want: "package fruits123\n",
+ },
+ {
+ name: "package completion for dir name with invalid dir name",
+ newfile: "123f_r.u~its-123/newfile.go",
+ want: "package fruits123\n",
+ },
+ } {
+ t.Run(tc.name, func(t *testing.T) {
+ createFiles := fmt.Sprintf("%s\n-- %s --", existFiles, tc.newfile)
+ Run(t, createFiles, func(t *testing.T, env *Env) {
+ env.DidCreateFiles(env.Editor.DocumentURI(tc.newfile))
+ // save buffer to ensure the edits take effects in the file system.
+ if err := env.Editor.SaveBuffer(context.Background(), tc.newfile); err != nil {
+ t.Fatal(err)
+ }
+ if got := env.FileContent(tc.newfile); tc.want != got {
+ t.Fatalf("want '%s' but got '%s'", tc.want, got)
+ }
+ })
+ })
+ }
+}
diff --git a/gopls/internal/test/integration/workspace/packages_test.go b/gopls/internal/test/integration/workspace/packages_test.go
index fdee21d822f..3420e32e084 100644
--- a/gopls/internal/test/integration/workspace/packages_test.go
+++ b/gopls/internal/test/integration/workspace/packages_test.go
@@ -433,6 +433,66 @@ func (X) SubtestMethod(t *testing.T) {
})
}
+func TestRecursiveSubtest(t *testing.T) {
+ const files = `
+-- go.mod --
+module foo
+
+-- foo_test.go --
+package foo
+
+import "testing"
+
+func TestFoo(t *testing.T) { t.Run("Foo", TestFoo) }
+func TestBar(t *testing.T) { t.Run("Foo", TestFoo) }
+
+func TestBaz(t *testing.T) {
+ var sub func(t *testing.T)
+ sub = func(t *testing.T) { t.Run("Sub", sub) }
+ t.Run("Sub", sub)
+}
+`
+
+ Run(t, files, func(t *testing.T, env *Env) {
+ checkPackages(t, env, []protocol.DocumentURI{env.Editor.DocumentURI("foo_test.go")}, false, command.NeedTests, []command.Package{
+ {
+ Path: "foo",
+ ForTest: "foo",
+ ModulePath: "foo",
+ TestFiles: []command.TestFile{
+ {
+ URI: env.Editor.DocumentURI("foo_test.go"),
+ Tests: []command.TestCase{
+ {Name: "TestFoo"},
+ {Name: "TestFoo/Foo"},
+ {Name: "TestBar"},
+ {Name: "TestBar/Foo"},
+ {Name: "TestBaz"},
+ {Name: "TestBaz/Sub"},
+ },
+ },
+ },
+ },
+ }, map[string]command.Module{
+ "foo": {
+ Path: "foo",
+ GoMod: env.Editor.DocumentURI("go.mod"),
+ },
+ }, []string{
+ `func TestFoo(t *testing.T) { t.Run("Foo", TestFoo) }`,
+ `t.Run("Foo", TestFoo)`,
+ `func TestBar(t *testing.T) { t.Run("Foo", TestFoo) }`,
+ `t.Run("Foo", TestFoo)`,
+ `func TestBaz(t *testing.T) {
+ var sub func(t *testing.T)
+ sub = func(t *testing.T) { t.Run("Sub", sub) }
+ t.Run("Sub", sub)
+}`,
+ `t.Run("Sub", sub)`,
+ })
+ })
+}
+
func checkPackages(t testing.TB, env *Env, files []protocol.DocumentURI, recursive bool, mode command.PackagesMode, wantPkg []command.Package, wantModule map[string]command.Module, wantSource []string) {
t.Helper()
diff --git a/gopls/internal/test/integration/wrappers.go b/gopls/internal/test/integration/wrappers.go
index 989ae913acf..17e0cf329c4 100644
--- a/gopls/internal/test/integration/wrappers.go
+++ b/gopls/internal/test/integration/wrappers.go
@@ -18,19 +18,19 @@ import (
// RemoveWorkspaceFile deletes a file on disk but does nothing in the
// editor. It calls t.Fatal on any error.
func (e *Env) RemoveWorkspaceFile(name string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Sandbox.Workdir.RemoveFile(e.Ctx, name); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// ReadWorkspaceFile reads a file from the workspace, calling t.Fatal on any
// error.
func (e *Env) ReadWorkspaceFile(name string) string {
- e.T.Helper()
+ e.TB.Helper()
content, err := e.Sandbox.Workdir.ReadFile(name)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return string(content)
}
@@ -38,55 +38,55 @@ func (e *Env) ReadWorkspaceFile(name string) string {
// WriteWorkspaceFile writes a file to disk but does nothing in the editor.
// It calls t.Fatal on any error.
func (e *Env) WriteWorkspaceFile(name, content string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Sandbox.Workdir.WriteFile(e.Ctx, name, content); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// WriteWorkspaceFiles deletes a file on disk but does nothing in the
// editor. It calls t.Fatal on any error.
func (e *Env) WriteWorkspaceFiles(files map[string]string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Sandbox.Workdir.WriteFiles(e.Ctx, files); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// ListFiles lists relative paths to files in the given directory.
// It calls t.Fatal on any error.
func (e *Env) ListFiles(dir string) []string {
- e.T.Helper()
+ e.TB.Helper()
paths, err := e.Sandbox.Workdir.ListFiles(dir)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return paths
}
// OpenFile opens a file in the editor, calling t.Fatal on any error.
func (e *Env) OpenFile(name string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.OpenFile(e.Ctx, name); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// CreateBuffer creates a buffer in the editor, calling t.Fatal on any error.
func (e *Env) CreateBuffer(name string, content string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.CreateBuffer(e.Ctx, name, content); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// BufferText returns the current buffer contents for the file with the given
// relative path, calling t.Fatal if the file is not open in a buffer.
func (e *Env) BufferText(name string) string {
- e.T.Helper()
+ e.TB.Helper()
text, ok := e.Editor.BufferText(name)
if !ok {
- e.T.Fatalf("buffer %q is not open", name)
+ e.TB.Fatalf("buffer %q is not open", name)
}
return text
}
@@ -94,24 +94,24 @@ func (e *Env) BufferText(name string) string {
// CloseBuffer closes an editor buffer without saving, calling t.Fatal on any
// error.
func (e *Env) CloseBuffer(name string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.CloseBuffer(e.Ctx, name); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// EditBuffer applies edits to an editor buffer, calling t.Fatal on any error.
func (e *Env) EditBuffer(name string, edits ...protocol.TextEdit) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.EditBuffer(e.Ctx, name, edits); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
func (e *Env) SetBufferContent(name string, content string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.SetBufferContent(e.Ctx, name, content); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
@@ -119,7 +119,7 @@ func (e *Env) SetBufferContent(name string, content string) {
// editing session: it returns the buffer content for an open file, the
// on-disk content for an unopened file, or "" for a non-existent file.
func (e *Env) FileContent(name string) string {
- e.T.Helper()
+ e.TB.Helper()
text, ok := e.Editor.BufferText(name)
if ok {
return text
@@ -129,7 +129,7 @@ func (e *Env) FileContent(name string) string {
if errors.Is(err, os.ErrNotExist) {
return ""
} else {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
return string(content)
@@ -138,14 +138,14 @@ func (e *Env) FileContent(name string) string {
// FileContentAt returns the file content at the given location, using the
// file's mapper.
func (e *Env) FileContentAt(location protocol.Location) string {
- e.T.Helper()
+ e.TB.Helper()
mapper, err := e.Editor.Mapper(location.URI.Path())
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
start, end, err := mapper.RangeOffsets(location.Range)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return string(mapper.Content[start:end])
}
@@ -154,13 +154,13 @@ func (e *Env) FileContentAt(location protocol.Location) string {
// buffer specified by name, calling t.Fatal on any error. It first searches
// for the position in open buffers, then in workspace files.
func (e *Env) RegexpSearch(name, re string) protocol.Location {
- e.T.Helper()
+ e.TB.Helper()
loc, err := e.Editor.RegexpSearch(name, re)
if err == fake.ErrUnknownBuffer {
loc, err = e.Sandbox.Workdir.RegexpSearch(name, re)
}
if err != nil {
- e.T.Fatalf("RegexpSearch: %v, %v for %q", name, err, re)
+ e.TB.Fatalf("RegexpSearch: %v, %v for %q", name, err, re)
}
return loc
}
@@ -168,24 +168,24 @@ func (e *Env) RegexpSearch(name, re string) protocol.Location {
// RegexpReplace replaces the first group in the first match of regexpStr with
// the replace text, calling t.Fatal on any error.
func (e *Env) RegexpReplace(name, regexpStr, replace string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.RegexpReplace(e.Ctx, name, regexpStr, replace); err != nil {
- e.T.Fatalf("RegexpReplace: %v", err)
+ e.TB.Fatalf("RegexpReplace: %v", err)
}
}
// SaveBuffer saves an editor buffer, calling t.Fatal on any error.
func (e *Env) SaveBuffer(name string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.SaveBuffer(e.Ctx, name); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
func (e *Env) SaveBufferWithoutActions(name string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.SaveBufferWithoutActions(e.Ctx, name); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
@@ -194,64 +194,64 @@ func (e *Env) SaveBufferWithoutActions(name string) {
//
// TODO(rfindley): rename this to just 'Definition'.
func (e *Env) GoToDefinition(loc protocol.Location) protocol.Location {
- e.T.Helper()
+ e.TB.Helper()
loc, err := e.Editor.Definition(e.Ctx, loc)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return loc
}
func (e *Env) TypeDefinition(loc protocol.Location) protocol.Location {
- e.T.Helper()
+ e.TB.Helper()
loc, err := e.Editor.TypeDefinition(e.Ctx, loc)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return loc
}
// FormatBuffer formats the editor buffer, calling t.Fatal on any error.
func (e *Env) FormatBuffer(name string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.FormatBuffer(e.Ctx, name); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// OrganizeImports processes the source.organizeImports codeAction, calling
// t.Fatal on any error.
func (e *Env) OrganizeImports(name string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.OrganizeImports(e.Ctx, name); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// ApplyQuickFixes processes the quickfix codeAction, calling t.Fatal on any error.
func (e *Env) ApplyQuickFixes(path string, diagnostics []protocol.Diagnostic) {
- e.T.Helper()
+ e.TB.Helper()
loc := e.Sandbox.Workdir.EntireFile(path)
if err := e.Editor.ApplyQuickFixes(e.Ctx, loc, diagnostics); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// ApplyCodeAction applies the given code action, calling t.Fatal on any error.
func (e *Env) ApplyCodeAction(action protocol.CodeAction) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.ApplyCodeAction(e.Ctx, action); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// Diagnostics returns diagnostics for the given file, calling t.Fatal on any
// error.
func (e *Env) Diagnostics(name string) []protocol.Diagnostic {
- e.T.Helper()
+ e.TB.Helper()
diags, err := e.Editor.Diagnostics(e.Ctx, name)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return diags
}
@@ -259,11 +259,11 @@ func (e *Env) Diagnostics(name string) []protocol.Diagnostic {
// GetQuickFixes returns the available quick fix code actions, calling t.Fatal
// on any error.
func (e *Env) GetQuickFixes(path string, diagnostics []protocol.Diagnostic) []protocol.CodeAction {
- e.T.Helper()
+ e.TB.Helper()
loc := e.Sandbox.Workdir.EntireFile(path)
actions, err := e.Editor.GetQuickFixes(e.Ctx, loc, diagnostics)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return actions
}
@@ -271,28 +271,28 @@ func (e *Env) GetQuickFixes(path string, diagnostics []protocol.Diagnostic) []pr
// Hover in the editor, calling t.Fatal on any error.
// It may return (nil, zero) even on success.
func (e *Env) Hover(loc protocol.Location) (*protocol.MarkupContent, protocol.Location) {
- e.T.Helper()
+ e.TB.Helper()
c, loc, err := e.Editor.Hover(e.Ctx, loc)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return c, loc
}
func (e *Env) DocumentLink(name string) []protocol.DocumentLink {
- e.T.Helper()
+ e.TB.Helper()
links, err := e.Editor.DocumentLink(e.Ctx, name)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return links
}
func (e *Env) DocumentHighlight(loc protocol.Location) []protocol.DocumentHighlight {
- e.T.Helper()
+ e.TB.Helper()
highlights, err := e.Editor.DocumentHighlight(e.Ctx, loc)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return highlights
}
@@ -301,9 +301,9 @@ func (e *Env) DocumentHighlight(loc protocol.Location) []protocol.DocumentHighli
// It waits for the generate command to complete and checks for file changes
// before returning.
func (e *Env) RunGenerate(dir string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.RunGenerate(e.Ctx, dir); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
e.Await(NoOutstandingWork(IgnoreTelemetryPromptWork))
// Ideally the editor.Workspace would handle all synthetic file watching, but
@@ -315,10 +315,10 @@ func (e *Env) RunGenerate(dir string) {
// RunGoCommand runs the given command in the sandbox's default working
// directory.
func (e *Env) RunGoCommand(verb string, args ...string) []byte {
- e.T.Helper()
+ e.TB.Helper()
out, err := e.Sandbox.RunGoCommand(e.Ctx, "", verb, args, nil, true)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return out
}
@@ -326,28 +326,28 @@ func (e *Env) RunGoCommand(verb string, args ...string) []byte {
// RunGoCommandInDir is like RunGoCommand, but executes in the given
// relative directory of the sandbox.
func (e *Env) RunGoCommandInDir(dir, verb string, args ...string) {
- e.T.Helper()
+ e.TB.Helper()
if _, err := e.Sandbox.RunGoCommand(e.Ctx, dir, verb, args, nil, true); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// RunGoCommandInDirWithEnv is like RunGoCommand, but executes in the given
// relative directory of the sandbox with the given additional environment variables.
func (e *Env) RunGoCommandInDirWithEnv(dir string, env []string, verb string, args ...string) {
- e.T.Helper()
+ e.TB.Helper()
if _, err := e.Sandbox.RunGoCommand(e.Ctx, dir, verb, args, env, true); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// GoVersion checks the version of the go command.
// It returns the X in Go 1.X.
func (e *Env) GoVersion() int {
- e.T.Helper()
+ e.TB.Helper()
v, err := e.Sandbox.GoVersion(e.Ctx)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return v
}
@@ -355,33 +355,33 @@ func (e *Env) GoVersion() int {
// DumpGoSum prints the correct go.sum contents for dir in txtar format,
// for use in creating integration tests.
func (e *Env) DumpGoSum(dir string) {
- e.T.Helper()
+ e.TB.Helper()
if _, err := e.Sandbox.RunGoCommand(e.Ctx, dir, "list", []string{"-mod=mod", "./..."}, nil, true); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
sumFile := path.Join(dir, "go.sum")
- e.T.Log("\n\n-- " + sumFile + " --\n" + e.ReadWorkspaceFile(sumFile))
- e.T.Fatal("see contents above")
+ e.TB.Log("\n\n-- " + sumFile + " --\n" + e.ReadWorkspaceFile(sumFile))
+ e.TB.Fatal("see contents above")
}
// CheckForFileChanges triggers a manual poll of the workspace for any file
// changes since creation, or since last polling. It is a workaround for the
// lack of true file watching support in the fake workspace.
func (e *Env) CheckForFileChanges() {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Sandbox.Workdir.CheckForFileChanges(e.Ctx); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// CodeLens calls textDocument/codeLens for the given path, calling t.Fatal on
// any error.
func (e *Env) CodeLens(path string) []protocol.CodeLens {
- e.T.Helper()
+ e.TB.Helper()
lens, err := e.Editor.CodeLens(e.Ctx, path)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return lens
}
@@ -391,9 +391,9 @@ func (e *Env) CodeLens(path string) []protocol.CodeLens {
//
// result is a pointer to a variable to be populated by json.Unmarshal.
func (e *Env) ExecuteCodeLensCommand(path string, cmd command.Command, result any) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.ExecuteCodeLensCommand(e.Ctx, path, cmd, result); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
@@ -402,9 +402,9 @@ func (e *Env) ExecuteCodeLensCommand(path string, cmd command.Command, result an
//
// result is a pointer to a variable to be populated by json.Unmarshal.
func (e *Env) ExecuteCommand(params *protocol.ExecuteCommandParams, result any) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.ExecuteCommand(e.Ctx, params, result); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
@@ -430,7 +430,7 @@ func (e *Env) StartProfile() (stop func() string) {
// This would be a lot simpler if we generated params constructors.
args, err := command.MarshalArgs(command.StartProfileArgs{})
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
params := &protocol.ExecuteCommandParams{
Command: command.StartProfile.String(),
@@ -442,7 +442,7 @@ func (e *Env) StartProfile() (stop func() string) {
return func() string {
stopArgs, err := command.MarshalArgs(command.StopProfileArgs{})
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
stopParams := &protocol.ExecuteCommandParams{
Command: command.StopProfile.String(),
@@ -457,91 +457,99 @@ func (e *Env) StartProfile() (stop func() string) {
// InlayHints calls textDocument/inlayHints for the given path, calling t.Fatal on
// any error.
func (e *Env) InlayHints(path string) []protocol.InlayHint {
- e.T.Helper()
+ e.TB.Helper()
hints, err := e.Editor.InlayHint(e.Ctx, path)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return hints
}
// Symbol calls workspace/symbol
func (e *Env) Symbol(query string) []protocol.SymbolInformation {
- e.T.Helper()
+ e.TB.Helper()
ans, err := e.Editor.Symbols(e.Ctx, query)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return ans
}
// References wraps Editor.References, calling t.Fatal on any error.
func (e *Env) References(loc protocol.Location) []protocol.Location {
- e.T.Helper()
+ e.TB.Helper()
locations, err := e.Editor.References(e.Ctx, loc)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return locations
}
// Rename wraps Editor.Rename, calling t.Fatal on any error.
func (e *Env) Rename(loc protocol.Location, newName string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.Rename(e.Ctx, loc, newName); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// Implementations wraps Editor.Implementations, calling t.Fatal on any error.
func (e *Env) Implementations(loc protocol.Location) []protocol.Location {
- e.T.Helper()
+ e.TB.Helper()
locations, err := e.Editor.Implementations(e.Ctx, loc)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return locations
}
// RenameFile wraps Editor.RenameFile, calling t.Fatal on any error.
func (e *Env) RenameFile(oldPath, newPath string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.RenameFile(e.Ctx, oldPath, newPath); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// SignatureHelp wraps Editor.SignatureHelp, calling t.Fatal on error
func (e *Env) SignatureHelp(loc protocol.Location) *protocol.SignatureHelp {
- e.T.Helper()
+ e.TB.Helper()
sighelp, err := e.Editor.SignatureHelp(e.Ctx, loc)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return sighelp
}
// Completion executes a completion request on the server.
func (e *Env) Completion(loc protocol.Location) *protocol.CompletionList {
- e.T.Helper()
+ e.TB.Helper()
completions, err := e.Editor.Completion(e.Ctx, loc)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return completions
}
+func (e *Env) DidCreateFiles(files ...protocol.DocumentURI) {
+ e.TB.Helper()
+ err := e.Editor.DidCreateFiles(e.Ctx, files...)
+ if err != nil {
+ e.TB.Fatal(err)
+ }
+}
+
func (e *Env) SetSuggestionInsertReplaceMode(useReplaceMode bool) {
- e.T.Helper()
+ e.TB.Helper()
e.Editor.SetSuggestionInsertReplaceMode(e.Ctx, useReplaceMode)
}
// AcceptCompletion accepts a completion for the given item at the given
// position.
func (e *Env) AcceptCompletion(loc protocol.Location, item protocol.CompletionItem) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.AcceptCompletion(e.Ctx, loc, item); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
@@ -554,38 +562,38 @@ func (e *Env) CodeActionForFile(path string, diagnostics []protocol.Diagnostic)
// CodeAction calls textDocument/codeAction for a selection,
// and calls t.Fatal if there were errors.
func (e *Env) CodeAction(loc protocol.Location, diagnostics []protocol.Diagnostic, trigger protocol.CodeActionTriggerKind) []protocol.CodeAction {
- e.T.Helper()
+ e.TB.Helper()
actions, err := e.Editor.CodeAction(e.Ctx, loc, diagnostics, trigger)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return actions
}
// ChangeConfiguration updates the editor config, calling t.Fatal on any error.
func (e *Env) ChangeConfiguration(newConfig fake.EditorConfig) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.ChangeConfiguration(e.Ctx, newConfig); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// ChangeWorkspaceFolders updates the editor workspace folders, calling t.Fatal
// on any error.
func (e *Env) ChangeWorkspaceFolders(newFolders ...string) {
- e.T.Helper()
+ e.TB.Helper()
if err := e.Editor.ChangeWorkspaceFolders(e.Ctx, newFolders); err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
}
// SemanticTokensFull invokes textDocument/semanticTokens/full, calling t.Fatal
// on any error.
func (e *Env) SemanticTokensFull(path string) []fake.SemanticToken {
- e.T.Helper()
+ e.TB.Helper()
toks, err := e.Editor.SemanticTokensFull(e.Ctx, path)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return toks
}
@@ -593,10 +601,10 @@ func (e *Env) SemanticTokensFull(path string) []fake.SemanticToken {
// SemanticTokensRange invokes textDocument/semanticTokens/range, calling t.Fatal
// on any error.
func (e *Env) SemanticTokensRange(loc protocol.Location) []fake.SemanticToken {
- e.T.Helper()
+ e.TB.Helper()
toks, err := e.Editor.SemanticTokensRange(e.Ctx, loc)
if err != nil {
- e.T.Fatal(err)
+ e.TB.Fatal(err)
}
return toks
}
@@ -606,9 +614,9 @@ func (e *Env) SemanticTokensRange(loc protocol.Location) []fake.SemanticToken {
func (e *Env) Close() {
ctx := xcontext.Detach(e.Ctx)
if err := e.Editor.Close(ctx); err != nil {
- e.T.Errorf("closing editor: %v", err)
+ e.TB.Errorf("closing editor: %v", err)
}
if err := e.Sandbox.Close(); err != nil {
- e.T.Errorf("cleaning up sandbox: %v", err)
+ e.TB.Errorf("cleaning up sandbox: %v", err)
}
}
diff --git a/gopls/internal/test/marker/doc.go b/gopls/internal/test/marker/doc.go
index dff8dfa109f..2fc3e042061 100644
--- a/gopls/internal/test/marker/doc.go
+++ b/gopls/internal/test/marker/doc.go
@@ -212,9 +212,10 @@ Here is the list of supported action markers:
- hovererr(src, sm stringMatcher): performs a textDocument/hover at the src
location, and checks that the error matches the given stringMatcher.
- - implementations(src location, want ...location): makes a
- textDocument/implementation query at the src location and
- checks that the resulting set of locations matches want.
+ - implementation(src location, want ...location, err=stringMatcher):
+ makes a textDocument/implementation query at the src location and
+ checks that the resulting set of locations matches want. If err is
+ set, the implementation query must fail with the expected error.
- incomingcalls(src location, want ...location): makes a
callHierarchy/incomingCalls query at the src location, and checks that
diff --git a/gopls/internal/test/marker/marker_test.go b/gopls/internal/test/marker/marker_test.go
index 516dfeb3881..8c27adc9018 100644
--- a/gopls/internal/test/marker/marker_test.go
+++ b/gopls/internal/test/marker/marker_test.go
@@ -96,6 +96,9 @@ func Test(t *testing.T) {
if strings.HasPrefix(builder, "darwin-") || strings.Contains(builder, "solaris") {
t.Skip("golang/go#64473: skipping with -short: this test is too slow on darwin and solaris builders")
}
+ if strings.HasSuffix(builder, "freebsd-amd64-race") {
+ t.Skip("golang/go#71731: the marker tests are too slow to run on the amd64-race builder")
+ }
}
// The marker tests must be able to run go/packages.Load.
testenv.NeedsGoPackages(t)
@@ -318,7 +321,7 @@ type marker struct {
func (m marker) ctx() context.Context { return m.run.env.Ctx }
// T returns the testing.TB for this mark.
-func (m marker) T() testing.TB { return m.run.env.T }
+func (m marker) T() testing.TB { return m.run.env.TB }
// server returns the LSP server for the marker test run.
func (m marker) editor() *fake.Editor { return m.run.env.Editor }
@@ -581,7 +584,7 @@ var actionMarkerFuncs = map[string]func(marker){
"highlightall": actionMarkerFunc(highlightAllMarker),
"hover": actionMarkerFunc(hoverMarker),
"hovererr": actionMarkerFunc(hoverErrMarker),
- "implementation": actionMarkerFunc(implementationMarker),
+ "implementation": actionMarkerFunc(implementationMarker, "err"),
"incomingcalls": actionMarkerFunc(incomingCallsMarker),
"inlayhints": actionMarkerFunc(inlayhintsMarker),
"outgoingcalls": actionMarkerFunc(outgoingCallsMarker),
@@ -658,7 +661,7 @@ type stringListValue []string
func (l *stringListValue) Set(s string) error {
if s != "" {
- for _, d := range strings.Split(s, ",") {
+ for d := range strings.SplitSeq(s, ",") {
*l = append(*l, strings.TrimSpace(d))
}
}
@@ -961,7 +964,7 @@ func newEnv(t *testing.T, cache *cache.Cache, files, proxyFiles map[string][]byt
// Put a debug instance in the context to prevent logging to stderr.
// See associated TODO in runner.go: we should revisit this pattern.
ctx := context.Background()
- ctx = debug.WithInstance(ctx, "off")
+ ctx = debug.WithInstance(ctx)
awaiter := integration.NewAwaiter(sandbox.Workdir)
ss := lsprpc.NewStreamServer(cache, false, nil)
@@ -971,12 +974,15 @@ func newEnv(t *testing.T, cache *cache.Cache, files, proxyFiles map[string][]byt
sandbox.Close() // ignore error
t.Fatal(err)
}
- if err := awaiter.Await(ctx, integration.InitialWorkspaceLoad); err != nil {
+ if err := awaiter.Await(ctx, integration.OnceMet(
+ integration.InitialWorkspaceLoad,
+ integration.NoShownMessage(""),
+ )); err != nil {
sandbox.Close() // ignore error
t.Fatal(err)
}
return &integration.Env{
- T: t,
+ TB: t,
Ctx: ctx,
Editor: editor,
Sandbox: sandbox,
@@ -1029,17 +1035,17 @@ func (c *marker) sprintf(format string, args ...any) string {
func (run *markerTestRun) fmtPos(pos token.Pos) string {
file := run.test.fset.File(pos)
if file == nil {
- run.env.T.Errorf("position %d not in test fileset", pos)
+ run.env.TB.Errorf("position %d not in test fileset", pos)
return ""
}
m, err := run.env.Editor.Mapper(file.Name())
if err != nil {
- run.env.T.Errorf("%s", err)
+ run.env.TB.Errorf("%s", err)
return ""
}
loc, err := m.PosLocation(file, pos, pos)
if err != nil {
- run.env.T.Errorf("Mapper(%s).PosLocation failed: %v", file.Name(), err)
+ run.env.TB.Errorf("Mapper(%s).PosLocation failed: %v", file.Name(), err)
}
return run.fmtLoc(loc)
}
@@ -1049,7 +1055,7 @@ func (run *markerTestRun) fmtPos(pos token.Pos) string {
// archive file.
func (run *markerTestRun) fmtLoc(loc protocol.Location) string {
if loc == (protocol.Location{}) {
- run.env.T.Errorf("unable to find %s in test archive", loc)
+ run.env.TB.Errorf("unable to find %s in test archive", loc)
return ""
}
lines := bytes.Count(run.test.archive.Comment, []byte("\n"))
@@ -1088,12 +1094,12 @@ func (run *markerTestRun) mapLocation(loc protocol.Location) (name string, start
name = run.env.Sandbox.Workdir.URIToPath(loc.URI)
m, err := run.env.Editor.Mapper(name)
if err != nil {
- run.env.T.Errorf("internal error: %v", err)
+ run.env.TB.Errorf("internal error: %v", err)
return
}
start, end, err := m.RangeOffsets(loc.Range)
if err != nil {
- run.env.T.Errorf("error formatting location %s: %v", loc, err)
+ run.env.TB.Errorf("error formatting location %s: %v", loc, err)
return
}
startLine, startCol = m.OffsetLineCol8(start)
@@ -1835,7 +1841,7 @@ func removeDiagnostic(mark marker, loc protocol.Location, matchEnd bool, re *reg
diags := mark.run.diags[key]
for i, diag := range diags {
if re.MatchString(diag.Message) && (!matchEnd || diag.Range.End == loc.Range.End) {
- mark.run.diags[key] = append(diags[:i], diags[i+1:]...)
+ mark.run.diags[key] = slices.Delete(diags, i, i+1)
return diag, true
}
}
@@ -2300,11 +2306,11 @@ func codeActionChanges(env *integration.Env, uri protocol.DocumentURI, rng proto
if action.Edit != nil {
if len(action.Edit.Changes) > 0 {
- env.T.Errorf("internal error: discarding unexpected CodeAction{Kind=%s, Title=%q}.Edit.Changes", action.Kind, action.Title)
+ env.TB.Errorf("internal error: discarding unexpected CodeAction{Kind=%s, Title=%q}.Edit.Changes", action.Kind, action.Title)
}
if action.Edit.DocumentChanges != nil {
if action.Command != nil {
- env.T.Errorf("internal error: discarding unexpected CodeAction{Kind=%s, Title=%q}.Command", action.Kind, action.Title)
+ env.TB.Errorf("internal error: discarding unexpected CodeAction{Kind=%s, Title=%q}.Command", action.Kind, action.Title)
}
return action.Edit.DocumentChanges, nil
}
@@ -2369,13 +2375,19 @@ func refsMarker(mark marker, src protocol.Location, want ...protocol.Location) {
// implementationMarker implements the @implementation marker.
func implementationMarker(mark marker, src protocol.Location, want ...protocol.Location) {
+ wantErr := namedArgFunc(mark, "err", convertStringMatcher, stringMatcher{})
+
got, err := mark.server().Implementation(mark.ctx(), &protocol.ImplementationParams{
TextDocumentPositionParams: protocol.LocationTextDocumentPositionParams(src),
})
- if err != nil {
+ if err != nil && wantErr.empty() {
mark.errorf("implementation at %s failed: %v", src, err)
return
}
+ if !wantErr.empty() {
+ wantErr.checkErr(mark, err)
+ return
+ }
if err := compareLocations(mark, got, want); err != nil {
mark.errorf("implementation: %v", err)
}
diff --git a/gopls/internal/test/marker/testdata/codeaction/eliminate_dot_import.txt b/gopls/internal/test/marker/testdata/codeaction/eliminate_dot_import.txt
new file mode 100644
index 00000000000..e72d8bd5417
--- /dev/null
+++ b/gopls/internal/test/marker/testdata/codeaction/eliminate_dot_import.txt
@@ -0,0 +1,40 @@
+This test checks the behavior of the 'remove dot import' code action.
+
+-- go.mod --
+module golang.org/lsptests/removedotimport
+
+go 1.18
+
+-- a.go --
+package dotimport
+
+// Base case: action is OK.
+
+import (
+ . "fmt" //@codeaction(`.`, "refactor.rewrite.eliminateDotImport", edit=a1)
+ . "bytes" //@codeaction(`.`, "refactor.rewrite.eliminateDotImport", edit=a2)
+)
+
+var _ = a
+
+func a() {
+ Println("hello")
+
+ buf := NewBuffer(nil)
+ buf.Grow(10)
+}
+
+-- @a1/a.go --
+@@ -6 +6 @@
+- . "fmt" //@codeaction(`.`, "refactor.rewrite.eliminateDotImport", edit=a1)
++ "fmt" //@codeaction(`.`, "refactor.rewrite.eliminateDotImport", edit=a1)
+@@ -13 +13 @@
+- Println("hello")
++ fmt.Println("hello")
+-- @a2/a.go --
+@@ -7 +7 @@
+- . "bytes" //@codeaction(`.`, "refactor.rewrite.eliminateDotImport", edit=a2)
++ "bytes" //@codeaction(`.`, "refactor.rewrite.eliminateDotImport", edit=a2)
+@@ -15 +15 @@
+- buf := NewBuffer(nil)
++ buf := bytes.NewBuffer(nil)
diff --git a/gopls/internal/test/marker/testdata/codeaction/inline_issue67336.txt b/gopls/internal/test/marker/testdata/codeaction/inline_issue67336.txt
index 437fb474fb2..f15ca29397b 100644
--- a/gopls/internal/test/marker/testdata/codeaction/inline_issue67336.txt
+++ b/gopls/internal/test/marker/testdata/codeaction/inline_issue67336.txt
@@ -54,7 +54,6 @@ package c
import (
"context"
-
"example.com/define/my/typ"
"example.com/one/more/pkg"
pkg0 "example.com/some/other/pkg"
diff --git a/gopls/internal/test/marker/testdata/codeaction/removeparam_imports.txt b/gopls/internal/test/marker/testdata/codeaction/removeparam_imports.txt
index d9f4f22dc7e..cd5f910a70d 100644
--- a/gopls/internal/test/marker/testdata/codeaction/removeparam_imports.txt
+++ b/gopls/internal/test/marker/testdata/codeaction/removeparam_imports.txt
@@ -65,9 +65,7 @@ func B(x, y c.C) { //@codeaction("x", "refactor.rewrite.removeUnusedParam", resu
-- @b/a/a3.go --
package a
-import (
- "mod.test/b"
-)
+import "mod.test/b"
func _() {
b.B(<-b.Chan)
@@ -79,9 +77,7 @@ func _() {
-- @b/a/a2.go --
package a
-import (
- "mod.test/b"
-)
+import "mod.test/b"
func _() {
b.B(<-b.Chan)
@@ -90,9 +86,7 @@ func _() {
-- @b/a/a1.go --
package a
-import (
- "mod.test/b"
-)
+import "mod.test/b"
func _() {
b.B(<-b.Chan)
diff --git a/gopls/internal/test/marker/testdata/definition/asm.txt b/gopls/internal/test/marker/testdata/definition/asm.txt
new file mode 100644
index 00000000000..250f237d299
--- /dev/null
+++ b/gopls/internal/test/marker/testdata/definition/asm.txt
@@ -0,0 +1,36 @@
+This test exercises the Definition request in a Go assembly file.
+
+For now we support only references to package-level symbols defined in
+the same package or a dependency.
+
+Repeatedly jumping to Definition on ff ping-pongs between the Go and
+assembly declarations.
+
+-- go.mod --
+module example.com
+go 1.18
+
+-- a/a.go --
+package a
+
+import _ "fmt"
+import _ "example.com/b"
+
+func ff() //@ loc(ffgo, re"()ff"), def("ff", ffasm)
+
+var _ = ff // pacify unusedfunc analyzer
+
+-- a/asm.s --
+// portable assembly
+
+TEXT ·ff(SB), $16 //@ loc(ffasm, "ff"), def("ff", ffgo)
+ CALL example·com∕b·B //@ def("com", bB)
+ JMP ·ff //@ def("ff", ffgo)
+ JMP label //@ def("label", label)
+label: //@ loc(label,"label")
+ RET
+
+-- b/b.go --
+package b
+
+func B() {} //@ loc(bB, re"()B")
diff --git a/gopls/internal/test/marker/testdata/definition/embed.txt b/gopls/internal/test/marker/testdata/definition/embed.txt
index 8ff3e37adb3..5a29b31708f 100644
--- a/gopls/internal/test/marker/testdata/definition/embed.txt
+++ b/gopls/internal/test/marker/testdata/definition/embed.txt
@@ -322,6 +322,8 @@ func (a.A) Hi()
-- @aAlias --
```go
type aAlias = a.A // size=16 (0x10)
+
+type A string
```
---
diff --git a/gopls/internal/test/marker/testdata/diagnostics/generated.txt b/gopls/internal/test/marker/testdata/diagnostics/generated.txt
index 123602df3c3..80de61200a3 100644
--- a/gopls/internal/test/marker/testdata/diagnostics/generated.txt
+++ b/gopls/internal/test/marker/testdata/diagnostics/generated.txt
@@ -10,10 +10,10 @@ module example.com
go 1.12
-- generated.go --
-package generated
-
// Code generated by generator.go. DO NOT EDIT.
+package generated
+
func _() {
var y int //@diag("y", re"declared (and|but) not used")
}
diff --git a/gopls/internal/test/marker/testdata/highlight/controlflow.txt b/gopls/internal/test/marker/testdata/highlight/controlflow.txt
index c09f748a553..46ec48d030d 100644
--- a/gopls/internal/test/marker/testdata/highlight/controlflow.txt
+++ b/gopls/internal/test/marker/testdata/highlight/controlflow.txt
@@ -68,7 +68,6 @@ func _() {
}
func _() () {
- // TODO(golang/go#65966): fix the triplicate diagnostics here.
- return 0 //@hiloc(ret2, "0", text), diag("0", re"too many return"), diag("0", re"too many return"), diag("0", re"too many return")
+ return 0 //@hiloc(ret2, "0", text), diag("0", re"too many return")
//@highlight(ret2, ret2)
}
diff --git a/gopls/internal/test/marker/testdata/hover/hover_alias.txt b/gopls/internal/test/marker/testdata/hover/hover_alias.txt
new file mode 100644
index 00000000000..886a175981c
--- /dev/null
+++ b/gopls/internal/test/marker/testdata/hover/hover_alias.txt
@@ -0,0 +1,81 @@
+This test checks gopls behavior when hovering over alias type.
+
+-- flags --
+-skip_goarch=386,arm
+
+-- go.mod --
+module mod.com
+
+-- main.go --
+package main
+
+import "mod.com/a"
+import "mod.com/b"
+
+type ToTypeDecl = b.RealType //@hover("ToTypeDecl", "ToTypeDecl", ToTypeDecl)
+
+type ToAlias = a.Alias //@hover("ToAlias", "ToAlias", ToAlias)
+
+type ToAliasWithComment = a.AliasWithComment //@hover("ToAliasWithComment", "ToAliasWithComment", ToAliasWithComment)
+
+-- a/a.go --
+package a
+import "mod.com/b"
+
+type Alias = b.RealType
+
+// AliasWithComment is a type alias with comments.
+type AliasWithComment = b.RealType
+
+-- b/b.go --
+package b
+// RealType is a real type rather than an alias type.
+type RealType struct {
+ Name string
+ Age int
+}
+
+-- @ToTypeDecl --
+```go
+type ToTypeDecl = b.RealType // size=24 (0x18)
+
+type RealType struct {
+ Name string
+ Age int
+}
+```
+
+---
+
+@hover("ToTypeDecl", "ToTypeDecl", ToTypeDecl)
+
+
+---
+
+[`main.ToTypeDecl` on pkg.go.dev](https://pkg.go.dev/mod.com#ToTypeDecl)
+-- @ToAlias --
+```go
+type ToAlias = a.Alias // size=24 (0x18)
+```
+
+---
+
+@hover("ToAlias", "ToAlias", ToAlias)
+
+
+---
+
+[`main.ToAlias` on pkg.go.dev](https://pkg.go.dev/mod.com#ToAlias)
+-- @ToAliasWithComment --
+```go
+type ToAliasWithComment = a.AliasWithComment // size=24 (0x18)
+```
+
+---
+
+@hover("ToAliasWithComment", "ToAliasWithComment", ToAliasWithComment)
+
+
+---
+
+[`main.ToAliasWithComment` on pkg.go.dev](https://pkg.go.dev/mod.com#ToAliasWithComment)
diff --git a/gopls/internal/test/marker/testdata/hover/issues.txt b/gopls/internal/test/marker/testdata/hover/issues.txt
index 6212964dff2..eda0eea3efa 100644
--- a/gopls/internal/test/marker/testdata/hover/issues.txt
+++ b/gopls/internal/test/marker/testdata/hover/issues.txt
@@ -20,3 +20,15 @@ package issue64237
import "golang.org/lsptests/nonexistant" //@diag("\"golang", re"could not import")
var _ = nonexistant.Value //@hovererr("nonexistant", "no package data")
+
+-- issue69362/p.go --
+package issue69362
+
+// golang/go#69362: hover panics over undefined implicits.
+
+func _() {
+ switch x := y.(type) { //@diag("y", re"undefined"), hover("x", "x", "")
+ case int:
+ _ = x
+ }
+}
diff --git a/gopls/internal/test/marker/testdata/hover/json.txt b/gopls/internal/test/marker/testdata/hover/json.txt
new file mode 100644
index 00000000000..f3229805cb6
--- /dev/null
+++ b/gopls/internal/test/marker/testdata/hover/json.txt
@@ -0,0 +1,33 @@
+This test demonstrates support for "hoverKind": "Structured".
+
+Its size expectations assume a 64-bit machine.
+
+-- flags --
+-skip_goarch=386,arm
+
+-- go.mod --
+module example.com/p
+
+go 1.18
+
+-- settings.json --
+{
+ "hoverKind": "Structured"
+}
+-- p.go --
+package p
+
+// MyType is a type.
+type MyType struct { //@ hover("MyType", "MyType", MyType)
+ F int // a field
+ S string // a string field
+}
+
+// MyFunc is a function.
+func MyFunc(i int) string { //@ hover("MyFunc", "MyFunc", MyFunc)
+ return ""
+}
+-- @MyFunc --
+{"synopsis":"MyFunc is a function.","fullDocumentation":"MyFunc is a function.\n","signature":"func MyFunc(i int) string","singleLine":"func MyFunc(i int) string","symbolName":"p.MyFunc","linkPath":"example.com/p","linkAnchor":"MyFunc"}
+-- @MyType --
+{"synopsis":"MyType is a type.","fullDocumentation":"MyType is a type.\n","signature":"type MyType struct { // size=24 (0x18)\n\tF int // a field\n\tS string // a string field\n}\n","singleLine":"type MyType struct{F int; S string}","symbolName":"p.MyType","linkPath":"example.com/p","linkAnchor":"MyType"}
diff --git a/gopls/internal/test/marker/testdata/implementation/issue67041.txt b/gopls/internal/test/marker/testdata/implementation/issue67041.txt
index 3b058534cd3..78965200b20 100644
--- a/gopls/internal/test/marker/testdata/implementation/issue67041.txt
+++ b/gopls/internal/test/marker/testdata/implementation/issue67041.txt
@@ -1,5 +1,5 @@
-This test verifies that implementations uses the correct object when querying
-local implementations . As described in golang/go#67041), a bug led to it
+This test verifies that Implementations uses the correct object when querying
+local implementations. As described in golang/go#67041, a bug led to it
comparing types from different realms.
-- go.mod --
diff --git a/gopls/internal/test/marker/testdata/implementation/signature.txt b/gopls/internal/test/marker/testdata/implementation/signature.txt
new file mode 100644
index 00000000000..b94d048a135
--- /dev/null
+++ b/gopls/internal/test/marker/testdata/implementation/signature.txt
@@ -0,0 +1,79 @@
+Test of local Implementation queries using function signatures.
+
+Assertions:
+- Query on "func" of a function type returns the corresponding concrete functions.
+- Query on "func" of a concrete function returns corresponding function types.
+- Query on "(" of a dynamic function call returns corresponding function types.
+- Different signatures (Nullary vs Handler) don't correspond.
+
+The @loc markers use the suffixes Func, Type, Call for the three kinds.
+Each query maps between these two sets: {Func} <=> {Type,Call}.
+
+-- go.mod --
+module example.com
+go 1.18
+
+-- a/a.go --
+package a
+
+// R is short for Record.
+type R struct{}
+
+// H is short for Handler.
+type H func(*R) //@ loc(HType, "func"), implementation("func", aFunc, bFunc, cFunc)
+
+func aFunc(*R) {} //@ loc(aFunc, "func"), implementation("func", HType, hParamType, hCall)
+
+var bFunc = func(*R) {} //@ loc(bFunc, "func"), implementation("func", hParamType, hCall, HType)
+
+func nullary() { //@ loc(nullaryFunc, "func"), implementation("func", Nullary, fieldCall)
+ cFunc := func(*R) {} //@ loc(cFunc, "func"), implementation("func", hParamType, hCall, HType)
+ _ = cFunc
+}
+
+type Nullary func() //@ loc(Nullary, "func")
+
+func _(
+ h func(*R)) { //@ loc(hParamType, "func"), implementation("func", aFunc, bFunc, cFunc)
+
+ _ = aFunc // pacify unusedfunc
+ _ = nullary // pacify unusedfunc
+ _ = h
+
+ h(nil) //@ loc(hCall, "("), implementation("(", aFunc, bFunc, cFunc)
+}
+
+// generics:
+
+func _[T any](complex128) {
+ f1 := func(T) int { return 0 } //@ loc(f1Func, "func"), implementation("func", fParamType, fCall, f1Call, f2Call)
+ f2 := func(string) int { return 0 } //@ loc(f2Func, "func"), implementation("func", fParamType, fCall, f1Call, f2Call)
+ f3 := func(int) int { return 0 } //@ loc(f3Func, "func"), implementation("func", f1Call)
+
+ f1(*new(T)) //@ loc(f1Call, "("), implementation("(", f1Func, f2Func, f3Func, f4Func)
+ f2("") //@ loc(f2Call, "("), implementation("(", f1Func, f2Func, f4Func)
+ _ = f3 // not called
+}
+
+func f4[T any](T) int { return 0 } //@ loc(f4Func, "func"), implementation("func", fParamType, fCall, f1Call, f2Call)
+
+var _ = f4[string] // pacify unusedfunc
+
+func _(
+ f func(string) int, //@ loc(fParamType, "func"), implementation("func", f1Func, f2Func, f4Func)
+ err error) {
+
+ f("") //@ loc(fCall, "("), implementation("(", f1Func, f2Func, f4Func)
+
+ struct{x Nullary}{}.x() //@ loc(fieldCall, "("), implementation("(", nullaryFunc)
+
+ // Calls that are not dynamic function calls:
+ _ = len("") //@ implementation("(", err="not a dynamic function call")
+ _ = int(0) //@ implementation("(", err="not a dynamic function call")
+ _ = error.Error(nil) //@ implementation("(", err="not a dynamic function call")
+ _ = err.Error() //@ implementation("(", err="not a dynamic function call")
+ _ = f4(0) //@ implementation("(", err="not a dynamic function call"), loc(f4Call, "(")
+}
+
+
+
diff --git a/gopls/internal/util/asm/parse.go b/gopls/internal/util/asm/parse.go
new file mode 100644
index 00000000000..11c59a7cc3d
--- /dev/null
+++ b/gopls/internal/util/asm/parse.go
@@ -0,0 +1,245 @@
+// Copyright 2025 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 asm provides a simple parser for Go assembly files.
+package asm
+
+import (
+ "bufio"
+ "bytes"
+ "fmt"
+ "strings"
+ "unicode"
+)
+
+// Kind describes the nature of an identifier in an assembly file.
+type Kind uint8
+
+const (
+ Invalid Kind = iota // reserved zero value; not used by Ident
+ Ref // arbitrary reference to symbol or control label
+ Text // definition of TEXT (function) symbol
+ Global // definition of GLOBL (var) symbol
+ Data // initialization of GLOBL (var) symbol; effectively a reference
+ Label // definition of control label
+)
+
+func (k Kind) String() string {
+ if int(k) < len(kindString) {
+ return kindString[k]
+ }
+ return fmt.Sprintf("Kind(%d)", k)
+}
+
+var kindString = [...]string{
+ Invalid: "invalid",
+ Ref: "ref",
+ Text: "text",
+ Global: "global",
+ Data: "data",
+ Label: "label",
+}
+
+// A file represents a parsed file of Go assembly language.
+type File struct {
+ Idents []Ident
+
+ // TODO(adonovan): use token.File? This may be important in a
+ // future in which analyzers can report diagnostics in .s files.
+}
+
+// Ident represents an identifier in an assembly file.
+type Ident struct {
+ Name string // symbol name (after correcting [·∕]); Name[0]='.' => current package
+ Offset int // zero-based byte offset
+ Kind Kind
+}
+
+// End returns the identifier's end offset.
+func (id Ident) End() int { return id.Offset + len(id.Name) }
+
+// Parse extracts identifiers from Go assembly files.
+// Since it is a best-effort parser, it never returns an error.
+func Parse(content []byte) *File {
+ var idents []Ident
+ offset := 0 // byte offset of start of current line
+
+ // TODO(adonovan) use a proper tokenizer that respects
+ // comments, string literals, line continuations, etc.
+ scan := bufio.NewScanner(bytes.NewReader(content))
+ for ; scan.Scan(); offset += len(scan.Bytes()) + len("\n") {
+ line := scan.Text()
+
+ // Strip comments.
+ if idx := strings.Index(line, "//"); idx >= 0 {
+ line = line[:idx]
+ }
+
+ // Skip blank lines.
+ if strings.TrimSpace(line) == "" {
+ continue
+ }
+
+ // Check for label definitions (ending with colon).
+ if colon := strings.IndexByte(line, ':'); colon > 0 {
+ label := strings.TrimSpace(line[:colon])
+ if isIdent(label) {
+ idents = append(idents, Ident{
+ Name: label,
+ Offset: offset + strings.Index(line, label),
+ Kind: Label,
+ })
+ continue
+ }
+ }
+
+ // Split line into words.
+ words := strings.Fields(line)
+ if len(words) == 0 {
+ continue
+ }
+
+ // A line of the form
+ // TEXT ·sym(SB),NOSPLIT,$12
+ // declares a text symbol "·sym".
+ if len(words) > 1 {
+ kind := Invalid
+ switch words[0] {
+ case "TEXT":
+ kind = Text
+ case "GLOBL":
+ kind = Global
+ case "DATA":
+ kind = Data
+ }
+ if kind != Invalid {
+ sym := words[1]
+ sym = cutBefore(sym, ",") // strip ",NOSPLIT,$12" etc
+ sym = cutBefore(sym, "(") // "sym(SB)" -> "sym"
+ sym = cutBefore(sym, "<") // "sym" -> "sym"
+ sym = strings.TrimSpace(sym)
+ if isIdent(sym) {
+ // (The Index call assumes sym is not itself "TEXT" etc.)
+ idents = append(idents, Ident{
+ Name: cleanup(sym),
+ Kind: kind,
+ Offset: offset + strings.Index(line, sym),
+ })
+ }
+ continue
+ }
+ }
+
+ // Find references in the rest of the line.
+ pos := 0
+ for _, word := range words {
+ // Find actual position of word within line.
+ tokenPos := strings.Index(line[pos:], word)
+ if tokenPos < 0 {
+ panic(line)
+ }
+ tokenPos += pos
+ pos = tokenPos + len(word)
+
+ // Reject probable instruction mnemonics (e.g. MOV).
+ if len(word) >= 2 && word[0] != '·' &&
+ !strings.ContainsFunc(word, unicode.IsLower) {
+ continue
+ }
+
+ if word[0] == '$' {
+ word = word[1:]
+ tokenPos++
+
+ // Reject probable immediate values (e.g. "$123").
+ if !strings.ContainsFunc(word, isNonDigit) {
+ continue
+ }
+ }
+
+ // Reject probably registers (e.g. "PC").
+ if len(word) <= 3 && !strings.ContainsFunc(word, unicode.IsLower) {
+ continue
+ }
+
+ // Probable identifier reference.
+ //
+ // TODO(adonovan): handle FP symbols correctly;
+ // sym+8(FP) is essentially a comment about
+ // stack slot 8, not a reference to a symbol
+ // with a declaration somewhere; so they form
+ // an equivalence class without a canonical
+ // declaration.
+ //
+ // TODO(adonovan): handle pseudoregisters and field
+ // references such as:
+ // MOVD $runtime·g0(SB), g // pseudoreg
+ // MOVD R0, g_stackguard0(g) // field ref
+
+ sym := cutBefore(word, "(") // "·sym(SB)" => "sym"
+ sym = cutBefore(sym, "+") // "sym+8(FP)" => "sym"
+ sym = cutBefore(sym, "<") // "sym" =>> "sym"
+ if isIdent(sym) {
+ idents = append(idents, Ident{
+ Name: cleanup(sym),
+ Kind: Ref,
+ Offset: offset + tokenPos,
+ })
+ }
+ }
+ }
+
+ _ = scan.Err() // ignore scan errors
+
+ return &File{Idents: idents}
+}
+
+// isIdent reports whether s is a valid Go assembly identifier.
+func isIdent(s string) bool {
+ for i, r := range s {
+ if !isIdentRune(r, i) {
+ return false
+ }
+ }
+ return len(s) > 0
+}
+
+// cutBefore returns the portion of s before the first occurrence of sep, if any.
+func cutBefore(s, sep string) string {
+ if before, _, ok := strings.Cut(s, sep); ok {
+ return before
+ }
+ return s
+}
+
+// cleanup converts a symbol name from assembler syntax to linker syntax.
+func cleanup(sym string) string {
+ return repl.Replace(sym)
+}
+
+var repl = strings.NewReplacer(
+ "·", ".", // (U+00B7 MIDDLE DOT)
+ "∕", "/", // (U+2215 DIVISION SLASH)
+)
+
+func isNonDigit(r rune) bool { return !unicode.IsDigit(r) }
+
+// -- plundered from GOROOT/src/cmd/asm/internal/asm/parse.go --
+
+// We want center dot (·) and division slash (∕) to work as identifier characters.
+func isIdentRune(ch rune, i int) bool {
+ if unicode.IsLetter(ch) {
+ return true
+ }
+ switch ch {
+ case '_': // Underscore; traditional.
+ return true
+ case '\u00B7': // Represents the period in runtime.exit. U+00B7 '·' middle dot
+ return true
+ case '\u2215': // Represents the slash in runtime/debug.setGCPercent. U+2215 '∕' division slash
+ return true
+ }
+ // Digits are OK only after the first character.
+ return i > 0 && unicode.IsDigit(ch)
+}
diff --git a/gopls/internal/util/asm/parse_test.go b/gopls/internal/util/asm/parse_test.go
new file mode 100644
index 00000000000..67a1286d28b
--- /dev/null
+++ b/gopls/internal/util/asm/parse_test.go
@@ -0,0 +1,67 @@
+// Copyright 2025 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 asm_test
+
+import (
+ "bytes"
+ "fmt"
+ "testing"
+
+ "github.com/google/go-cmp/cmp"
+ "golang.org/x/tools/gopls/internal/protocol"
+ "golang.org/x/tools/gopls/internal/util/asm"
+)
+
+// TestIdents checks that (likely) identifiers are extracted in the expected places.
+func TestIdents(t *testing.T) {
+ src := []byte(`
+// This is a nonsense file containing a variety of syntax.
+
+#include "foo.h"
+#ifdef MACRO
+DATA hello<>+0x00(SB)/64, $"Hello"
+GLOBL hello<(SB), RODATA, $64
+#endif
+
+TEXT mypkg·f(SB),NOSPLIT,$0
+ MOVD R1, 16(RSP) // another comment
+ MOVD $otherpkg·data(SB), R2
+ JMP label
+label:
+ BL ·g(SB)
+
+TEXT ·g(SB),NOSPLIT,$0
+ MOVD $runtime·g0(SB), g
+ MOVD R0, g_stackguard0(g)
+ MOVD R0, (g_stack+stack_lo)(g)
+`[1:])
+ const filename = "asm.s"
+ m := protocol.NewMapper(protocol.URIFromPath(filename), src)
+ file := asm.Parse(src)
+
+ want := `
+asm.s:5:6-11: data "hello"
+asm.s:6:7-12: global "hello"
+asm.s:9:6-13: text "mypkg.f"
+asm.s:11:8-21: ref "otherpkg.data"
+asm.s:12:6-11: ref "label"
+asm.s:13:1-6: label "label"
+asm.s:14:5-7: ref ".g"
+asm.s:16:6-8: text ".g"
+asm.s:17:8-18: ref "runtime.g0"
+asm.s:17:25-26: ref "g"
+asm.s:18:11-24: ref "g_stackguard0"
+`[1:]
+ var buf bytes.Buffer
+ for _, id := range file.Idents {
+ line, col := m.OffsetLineCol8(id.Offset)
+ _, endCol := m.OffsetLineCol8(id.Offset + len(id.Name))
+ fmt.Fprintf(&buf, "%s:%d:%d-%d:\t%s %q\n", filename, line, col, endCol, id.Kind, id.Name)
+ }
+ got := buf.String()
+ if got != want {
+ t.Errorf("got:\n%s\nwant:\n%s\ndiff:\n%s", got, want, cmp.Diff(want, got))
+ }
+}
diff --git a/gopls/internal/util/bug/bug.go b/gopls/internal/util/bug/bug.go
index dcd242d4856..265ec9dac10 100644
--- a/gopls/internal/util/bug/bug.go
+++ b/gopls/internal/util/bug/bug.go
@@ -50,13 +50,13 @@ type Bug struct {
}
// Reportf reports a formatted bug message.
-func Reportf(format string, args ...interface{}) {
+func Reportf(format string, args ...any) {
report(fmt.Sprintf(format, args...))
}
// Errorf calls fmt.Errorf for the given arguments, and reports the resulting
// error message as a bug.
-func Errorf(format string, args ...interface{}) error {
+func Errorf(format string, args ...any) error {
err := fmt.Errorf(format, args...)
report(err.Error())
return err
diff --git a/gopls/internal/cache/methodsets/fingerprint.go b/gopls/internal/util/fingerprint/fingerprint.go
similarity index 62%
rename from gopls/internal/cache/methodsets/fingerprint.go
rename to gopls/internal/util/fingerprint/fingerprint.go
index 05ccfe0911c..b279003d081 100644
--- a/gopls/internal/cache/methodsets/fingerprint.go
+++ b/gopls/internal/util/fingerprint/fingerprint.go
@@ -1,7 +1,13 @@
-// Copyright 2024 The Go Authors. All rights reserved.
+// Copyright 2025 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 methodsets
+
+// Package fingerprint defines a function to [Encode] types as strings
+// with the property that identical types have equal string encodings,
+// in most cases. In the remaining cases (mostly involving generic
+// types), the encodings can be parsed using [Parse] into [Tree] form
+// and matched using [Matches].
+package fingerprint
import (
"fmt"
@@ -12,6 +18,52 @@ import (
"text/scanner"
)
+// Encode returns an encoding of a [types.Type] such that, in
+// most cases, Encode(x) == Encode(y) iff [types.Identical](x, y).
+//
+// For a minority of types, mostly involving type parameters, identity
+// cannot be reduced to string comparison; these types are called
+// "tricky", and are indicated by the boolean result.
+//
+// In general, computing identity correctly for tricky types requires
+// the type checker. However, the fingerprint encoding can be parsed
+// by [Parse] into a [Tree] form that permits simple matching sufficient
+// to allow a type parameter to unify with any subtree; see [Match].
+//
+// In the standard library, 99.8% of package-level types have a
+// non-tricky method-set. The most common exceptions are due to type
+// parameters.
+//
+// fingerprint.Encode is defined only for the signature types of functions
+// and methods. It must not be called for "untyped" basic types, nor
+// the type of a generic function.
+func Encode(t types.Type) (_ string, tricky bool) { return fingerprint(t) }
+
+// A Tree is a parsed form of a fingerprint for use with [Matches].
+type Tree struct{ tree sexpr }
+
+// String returns the tree in an unspecified human-readable form.
+func (tree Tree) String() string {
+ var out strings.Builder
+ writeSexpr(&out, tree.tree)
+ return out.String()
+}
+
+// Parse parses a fingerprint into tree form.
+//
+// The input must have been produced by [Encode] at the same source
+// version; parsing is thus infallible.
+func Parse(fp string) Tree {
+ return Tree{parseFingerprint(fp)}
+}
+
+// Matches reports whether two fingerprint trees match, meaning that
+// under some conditions (for example, particular instantiations of
+// type parameters) the two types may be identical.
+func Matches(x, y Tree) bool {
+ return unify(x.tree, y.tree)
+}
+
// Fingerprint syntax
//
// The lexical syntax is essentially Lisp S-expressions:
@@ -38,25 +90,6 @@ import (
//
// field = IDENT IDENT STRING τ -- name, embedded?, tag, type
-// fingerprint returns an encoding of a [types.Type] such that, in
-// most cases, fingerprint(x) == fingerprint(t) iff types.Identical(x, y).
-//
-// For a minority of types, mostly involving type parameters, identity
-// cannot be reduced to string comparison; these types are called
-// "tricky", and are indicated by the boolean result.
-//
-// In general, computing identity correctly for tricky types requires
-// the type checker. However, the fingerprint encoding can be parsed
-// by [parseFingerprint] into a tree form that permits simple matching
-// sufficient to allow a type parameter to unify with any subtree.
-//
-// In the standard library, 99.8% of package-level types have a
-// non-tricky method-set. The most common exceptions are due to type
-// parameters.
-//
-// fingerprint is defined only for the signature types of methods. It
-// must not be called for "untyped" basic types, nor the type of a
-// generic function.
func fingerprint(t types.Type) (string, bool) {
var buf strings.Builder
tricky := false
@@ -202,8 +235,6 @@ func fingerprint(t types.Type) (string, bool) {
return buf.String(), tricky
}
-const symTypeparam = "typeparam"
-
// sexpr defines the representation of a fingerprint tree.
type (
sexpr any // = string | int | symbol | *cons | nil
@@ -272,12 +303,6 @@ func parseFingerprint(fp string) sexpr {
return parse()
}
-func sexprString(x sexpr) string {
- var out strings.Builder
- writeSexpr(&out, x)
- return out.String()
-}
-
// writeSexpr formats an S-expression.
// It is provided for debugging.
func writeSexpr(out *strings.Builder, x sexpr) {
@@ -313,45 +338,129 @@ func writeSexpr(out *strings.Builder, x sexpr) {
}
}
-// unify reports whether the types of methods x and y match, in the
-// presence of type parameters, each of which matches anything at all.
-// (It's not true unification as we don't track substitutions.)
-//
-// TODO(adonovan): implement full unification.
+// unify reports whether x and y match, in the presence of type parameters.
+// The constraints on type parameters are ignored, but each type parameter must
+// have a consistent binding.
func unify(x, y sexpr) bool {
- if isTypeParam(x) >= 0 || isTypeParam(y) >= 0 {
- return true // a type parameter matches anything
+
+ // maxTypeParam returns the maximum type parameter index in x.
+ var maxTypeParam func(x sexpr) int
+ maxTypeParam = func(x sexpr) int {
+ if i := typeParamIndex(x); i >= 0 {
+ return i
+ }
+ if c, ok := x.(*cons); ok {
+ return max(maxTypeParam(c.car), maxTypeParam(c.cdr))
+ }
+ return -1
}
- if reflect.TypeOf(x) != reflect.TypeOf(y) {
- return false // type mismatch
+
+ // xBindings[i] is the binding for type parameter #i in x, and similarly for y.
+ // Although type parameters are nominally bound to sexprs, each bindings[i]
+ // is a *sexpr, so unbound variables can share a binding.
+ xBindings := make([]*sexpr, maxTypeParam(x)+1)
+ for i := range len(xBindings) {
+ xBindings[i] = new(sexpr)
}
- switch x := x.(type) {
- case nil, string, int, symbol:
- return x == y
- case *cons:
- y := y.(*cons)
- if !unify(x.car, y.car) {
+ yBindings := make([]*sexpr, maxTypeParam(y)+1)
+ for i := range len(yBindings) {
+ yBindings[i] = new(sexpr)
+ }
+
+ // bind sets binding b to s from bindings if it does not occur in s.
+ bind := func(b *sexpr, s sexpr, bindings []*sexpr) bool {
+ // occurs reports whether b is present in s.
+ var occurs func(s sexpr) bool
+ occurs = func(s sexpr) bool {
+ if j := typeParamIndex(s); j >= 0 {
+ return b == bindings[j]
+ }
+ if c, ok := s.(*cons); ok {
+ return occurs(c.car) || occurs(c.cdr)
+ }
return false
}
- if x.cdr == nil {
- return y.cdr == nil
- }
- if y.cdr == nil {
+
+ if occurs(s) {
return false
}
- return unify(x.cdr, y.cdr)
- default:
- panic(fmt.Sprintf("unify %T %T", x, y))
+ *b = s
+ return true
}
+
+ var uni func(x, y sexpr) bool
+ uni = func(x, y sexpr) bool {
+ var bx, by *sexpr
+ ix := typeParamIndex(x)
+ if ix >= 0 {
+ bx = xBindings[ix]
+ }
+ iy := typeParamIndex(y)
+ if iy >= 0 {
+ by = yBindings[iy]
+ }
+
+ if bx != nil || by != nil {
+ // If both args are type params and neither is bound, have them share a binding.
+ if bx != nil && by != nil && *bx == nil && *by == nil {
+ xBindings[ix] = yBindings[iy]
+ return true
+ }
+ // Treat param bindings like original args in what follows.
+ if bx != nil && *bx != nil {
+ x = *bx
+ }
+ if by != nil && *by != nil {
+ y = *by
+ }
+ // If the x param is unbound, bind it to y.
+ if bx != nil && *bx == nil {
+ return bind(bx, y, yBindings)
+ }
+ // If the y param is unbound, bind it to x.
+ if by != nil && *by == nil {
+ return bind(by, x, xBindings)
+ }
+ // Unify the binding of a bound parameter.
+ return uni(x, y)
+ }
+
+ // Neither arg is a type param.
+ if reflect.TypeOf(x) != reflect.TypeOf(y) {
+ return false // type mismatch
+ }
+ switch x := x.(type) {
+ case nil, string, int, symbol:
+ return x == y
+ case *cons:
+ y := y.(*cons)
+ if !uni(x.car, y.car) {
+ return false
+ }
+ if x.cdr == nil {
+ return y.cdr == nil
+ }
+ if y.cdr == nil {
+ return false
+ }
+ return uni(x.cdr, y.cdr)
+ default:
+ panic(fmt.Sprintf("unify %T %T", x, y))
+ }
+ }
+ // At least one param is bound. Unify its binding with the other.
+ return uni(x, y)
}
-// isTypeParam returns the index of the type parameter,
+// typeParamIndex returns the index of the type parameter,
// if x has the form "(typeparam INTEGER)", otherwise -1.
-func isTypeParam(x sexpr) int {
+func typeParamIndex(x sexpr) int {
if x, ok := x.(*cons); ok {
if sym, ok := x.car.(symbol); ok && sym == symTypeparam {
- return 0
+ return x.cdr.(*cons).car.(int)
}
}
return -1
}
+
+const symTypeparam = "typeparam"
diff --git a/gopls/internal/cache/methodsets/fingerprint_test.go b/gopls/internal/util/fingerprint/fingerprint_test.go
similarity index 63%
rename from gopls/internal/cache/methodsets/fingerprint_test.go
rename to gopls/internal/util/fingerprint/fingerprint_test.go
index a9f47c1a2e6..40ea2ede34e 100644
--- a/gopls/internal/cache/methodsets/fingerprint_test.go
+++ b/gopls/internal/util/fingerprint/fingerprint_test.go
@@ -1,13 +1,8 @@
-// Copyright 2024 The Go Authors. All rights reserved.
+// Copyright 2025 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 methodsets
-
-// This is an internal test of [fingerprint] and [unify].
-//
-// TODO(adonovan): avoid internal tests.
-// Break fingerprint.go off into its own package?
+package fingerprint_test
import (
"go/types"
@@ -15,15 +10,15 @@ import (
"golang.org/x/tools/go/packages"
"golang.org/x/tools/go/types/typeutil"
- "golang.org/x/tools/internal/testenv"
+ "golang.org/x/tools/gopls/internal/util/fingerprint"
"golang.org/x/tools/internal/testfiles"
"golang.org/x/tools/txtar"
)
-// Test_fingerprint runs the fingerprint encoder, decoder, and printer
+// Test runs the fingerprint encoder, decoder, and printer
// on the types of all package-level symbols in gopls, and ensures
// that parse+print is lossless.
-func Test_fingerprint(t *testing.T) {
+func Test(t *testing.T) {
if testing.Short() {
t.Skip("skipping slow test")
}
@@ -39,11 +34,6 @@ func Test_fingerprint(t *testing.T) {
// (Non-tricky types only.)
var fingerprints typeutil.Map
- type eqclass struct {
- class map[types.Type]bool
- fp string
- }
-
for _, pkg := range pkgs {
switch pkg.Types.Path() {
case "unsafe", "builtin":
@@ -59,7 +49,7 @@ func Test_fingerprint(t *testing.T) {
continue // untyped constant
}
- fp, tricky := fingerprint(typ) // check Type encoder doesn't panic
+ fp, tricky := fingerprint.Encode(typ) // check Type encoder doesn't panic
// All equivalent (non-tricky) types have the same fingerprint.
if !tricky {
@@ -71,8 +61,8 @@ func Test_fingerprint(t *testing.T) {
}
}
- tree := parseFingerprint(fp) // check parser doesn't panic
- fp2 := sexprString(tree) // check formatter doesn't pannic
+ tree := fingerprint.Parse(fp) // check parser doesn't panic
+ fp2 := tree.String() // check formatter doesn't pannic
// A parse+print round-trip should be lossless.
if fp != fp2 {
@@ -84,12 +74,8 @@ func Test_fingerprint(t *testing.T) {
}
}
-// Test_unify exercises the matching algorithm for generic types.
-func Test_unify(t *testing.T) {
- if testenv.Go1Point() < 24 {
- testenv.NeedsGoExperiment(t, "aliastypeparams") // testenv.Go1Point() >= 24 implies aliastypeparams=1
- }
-
+// TestMatches exercises the matching algorithm for generic types.
+func TestMatches(t *testing.T) {
const src = `
-- go.mod --
module example.com
@@ -118,6 +104,7 @@ func C2[U any](int, int, ...U) bool { panic(0) }
func C3(int, bool, ...string) rune
func C4(int, bool, ...string)
func C5(int, float64, bool, string) bool
+func C6(int, bool, ...string) bool
func DAny[T any](Named[T]) { panic(0) }
func DString(Named[string])
@@ -128,6 +115,17 @@ type Named[T any] struct { x T }
func E1(byte) rune
func E2(uint8) int32
func E3(int8) uint32
+
+// generic vs. generic
+func F1[T any](T) { panic(0) }
+func F2[T any](*T) { panic(0) }
+func F3[T any](T, T) { panic(0) }
+func F4[U any](U, *U) { panic(0) }
+func F5[T, U any](T, U, U) { panic(0) }
+func F6[T any](T, int, T) { panic(0) }
+func F7[T any](bool, T, T) { panic(0) }
+func F8[V any](*V, int, int) { panic(0) }
+func F9[V any](V, *V, V) { panic(0) }
`
pkg := testfiles.LoadPackages(t, txtar.Parse([]byte(src)), "./a")[0]
scope := pkg.Types.Scope()
@@ -142,11 +140,12 @@ func E3(int8) uint32
{"B", "String", "", true},
{"B", "Int", "", true},
{"B", "A", "", true},
- {"C1", "C2", "", true}, // matches despite inconsistent substitution
- {"C1", "C3", "", true},
+ {"C1", "C2", "", false},
+ {"C1", "C3", "", false},
{"C1", "C4", "", false},
{"C1", "C5", "", false},
- {"C2", "C3", "", false}, // intransitive (C1≡C2 ^ C1≡C3)
+ {"C1", "C6", "", true},
+ {"C2", "C3", "", false},
{"C2", "C4", "", false},
{"C3", "C4", "", false},
{"DAny", "DString", "", true},
@@ -154,6 +153,13 @@ func E3(int8) uint32
{"DString", "DInt", "", false}, // different instantiations of Named
{"E1", "E2", "", true}, // byte and rune are just aliases
{"E2", "E3", "", false},
+ // The following tests cover all of the type param cases of unify.
+ {"F1", "F2", "", true}, // F1[*int] = F2[int]
+ {"F3", "F4", "", false}, // would require U identical to *U, prevented by occur check
+ {"F5", "F6", "", true}, // one param is bound, the other is not
+ {"F6", "F7", "", false}, // both are bound
+ {"F5", "F8", "", true}, // T=*int, U=int, V=int
+ {"F5", "F9", "", false}, // T is unbound, V is bound, and T occurs in V
} {
lookup := func(name string) types.Type {
obj := scope.Lookup(name)
@@ -169,20 +175,30 @@ func E3(int8) uint32
return obj.Type()
}
- a := lookup(test.a)
- b := lookup(test.b)
+ check := func(sa, sb string, want bool) {
+ t.Helper()
+
+ a := lookup(sa)
+ b := lookup(sb)
- afp, _ := fingerprint(a)
- bfp, _ := fingerprint(b)
+ afp, _ := fingerprint.Encode(a)
+ bfp, _ := fingerprint.Encode(b)
- atree := parseFingerprint(afp)
- btree := parseFingerprint(bfp)
+ atree := fingerprint.Parse(afp)
+ btree := fingerprint.Parse(bfp)
- got := unify(atree, btree)
- if got != test.want {
- t.Errorf("a=%s b=%s method=%s: unify returned %t for these inputs:\n- %s\n- %s",
- test.a, test.b, test.method,
- got, sexprString(atree), sexprString(btree))
+ got := fingerprint.Matches(atree, btree)
+ if got != want {
+ t.Errorf("a=%s b=%s method=%s: unify returned %t for these inputs:\n- %s\n- %s",
+ sa, sb, test.method, got, a, b)
+ }
}
+
+ check(test.a, test.b, test.want)
+ // Matches is symmetric
+ check(test.b, test.a, test.want)
+ // Matches is reflexive
+ check(test.a, test.a, true)
+ check(test.b, test.b, true)
}
}
diff --git a/gopls/internal/util/moreiters/iters.go b/gopls/internal/util/moreiters/iters.go
index e4d83ae8618..69c76ccb9b6 100644
--- a/gopls/internal/util/moreiters/iters.go
+++ b/gopls/internal/util/moreiters/iters.go
@@ -14,3 +14,34 @@ func First[T any](seq iter.Seq[T]) (z T, ok bool) {
}
return z, false
}
+
+// Contains reports whether x is an element of the sequence seq.
+func Contains[T comparable](seq iter.Seq[T], x T) bool {
+ for cand := range seq {
+ if cand == x {
+ return true
+ }
+ }
+ return false
+}
+
+// Every reports whether every pred(t) for t in seq returns true,
+// stopping at the first false element.
+func Every[T any](seq iter.Seq[T], pred func(T) bool) bool {
+ for t := range seq {
+ if !pred(t) {
+ return false
+ }
+ }
+ return true
+}
+
+// Any reports whether any pred(t) for t in seq returns true.
+func Any[T any](seq iter.Seq[T], pred func(T) bool) bool {
+ for t := range seq {
+ if pred(t) {
+ return true
+ }
+ }
+ return false
+}
diff --git a/gopls/internal/util/persistent/map.go b/gopls/internal/util/persistent/map.go
index 193f98791d8..d97a9494c41 100644
--- a/gopls/internal/util/persistent/map.go
+++ b/gopls/internal/util/persistent/map.go
@@ -203,6 +203,8 @@ func (pm *Map[K, V]) SetAll(other *Map[K, V]) {
// Set updates the value associated with the specified key.
// If release is non-nil, it will be called with entry's key and value once the
// key is no longer contained in the map or any clone.
+//
+// TODO(adonovan): fix release, which has the wrong type.
func (pm *Map[K, V]) Set(key K, value V, release func(key, value any)) {
first := pm.root
second := newNodeWithRef(key, value, release)
diff --git a/gopls/internal/util/persistent/race_test.go b/gopls/internal/util/persistent/race_test.go
new file mode 100644
index 00000000000..827791a78dc
--- /dev/null
+++ b/gopls/internal/util/persistent/race_test.go
@@ -0,0 +1,66 @@
+// Copyright 2025 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.
+
+//go:build race
+
+package persistent
+
+import (
+ "context"
+ "maps"
+ "testing"
+ "time"
+
+ "golang.org/x/sync/errgroup"
+)
+
+// TestConcurrency exercises concurrent map access.
+// It doesn't assert anything, but it runs under the race detector.
+func TestConcurrency(t *testing.T) {
+ ctx, cancel := context.WithTimeout(t.Context(), 5*time.Second)
+ defer cancel()
+ var orig Map[int, int] // maps subset of [0-10] to itself (values aren't interesting)
+ for i := range 10 {
+ orig.Set(i, i, func(k, v any) { /* just for good measure*/ })
+ }
+ g, ctx := errgroup.WithContext(ctx)
+ const N = 10 // concurrency level
+ g.SetLimit(N)
+ for range N {
+ g.Go(func() error {
+ // Each thread has its own clone of the original,
+ // sharing internal structures. Each map is accessed
+ // only by a single thread; the shared data is immutable.
+ m := orig.Clone()
+
+ // Run until the timeout.
+ for ctx.Err() == nil {
+ for i := range 1000 {
+ key := i % 10
+
+ switch {
+ case i%2 == 0:
+ _, _ = m.Get(key)
+ case i%11 == 0:
+ m.Set(key, key, func(key, value any) {})
+ case i%13 == 0:
+ _ = maps.Collect(m.All())
+ case i%17 == 0:
+ _ = m.Delete(key)
+ case i%19 == 0:
+ _ = m.Keys()
+ case i%31 == 0:
+ _ = m.String()
+ case i%23 == 0:
+ _ = m.Clone()
+ }
+ // Don't call m.Clear(), as it would
+ // disentangle the various maps from each other.
+ }
+ }
+ return nil
+ })
+ }
+ g.Wait() // no errors
+}
diff --git a/gopls/internal/util/typesutil/typesutil.go b/gopls/internal/util/typesutil/typesutil.go
index 79042a24901..4b5c5e7fd4f 100644
--- a/gopls/internal/util/typesutil/typesutil.go
+++ b/gopls/internal/util/typesutil/typesutil.go
@@ -42,6 +42,8 @@ func FormatTypeParams(tparams *types.TypeParamList) string {
// the hole that must be filled by EXPR has type (string, int).
//
// It returns nil on failure.
+//
+// TODO(adonovan): simplify using Cursor.
func TypesFromContext(info *types.Info, path []ast.Node, pos token.Pos) []types.Type {
anyType := types.Universe.Lookup("any").Type()
var typs []types.Type
diff --git a/gopls/internal/vulncheck/vulntest/report.go b/gopls/internal/vulncheck/vulntest/report.go
index 6aa87221866..3b1bfcc5c96 100644
--- a/gopls/internal/vulncheck/vulntest/report.go
+++ b/gopls/internal/vulncheck/vulntest/report.go
@@ -134,7 +134,7 @@ func (v Version) Canonical() string {
// single-element mapping of type to URL.
type Reference osv.Reference
-func (r *Reference) MarshalYAML() (interface{}, error) {
+func (r *Reference) MarshalYAML() (any, error) {
return map[string]string{
strings.ToLower(string(r.Type)): r.URL,
}, nil
diff --git a/internal/analysisinternal/addimport_test.go b/internal/analysisinternal/addimport_test.go
index 145d5861b8f..da7c7f90114 100644
--- a/internal/analysisinternal/addimport_test.go
+++ b/internal/analysisinternal/addimport_test.go
@@ -18,9 +18,12 @@ import (
"github.com/google/go-cmp/cmp"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/internal/analysisinternal"
+ "golang.org/x/tools/internal/testenv"
)
func TestAddImport(t *testing.T) {
+ testenv.NeedsDefaultImporter(t)
+
descr := func(s string) string {
if _, _, line, ok := runtime.Caller(1); ok {
return fmt.Sprintf("L%d %s", line, s)
@@ -219,6 +222,28 @@ import . "fmt"
func _(Print fmt.Stringer) {
fmt
+}`,
+ },
+ {
+ descr: descr("add import to group"),
+ src: `package a
+
+import (
+ "io"
+)
+
+func _(io.Reader) {
+ «fmt fmt»
+}`,
+ want: `package a
+
+import (
+ "io"
+ "fmt"
+)
+
+func _(io.Reader) {
+ fmt
}`,
},
} {
@@ -248,6 +273,9 @@ func _(Print fmt.Stringer) {
Implicits: make(map[ast.Node]types.Object),
}
conf := &types.Config{
+ // We don't want to fail if there is an error during type checking:
+ // the error may be because we're missing an import, and adding imports
+ // is the whole point of AddImport.
Error: func(err error) { t.Log(err) },
Importer: importer.Default(),
}
diff --git a/internal/analysisinternal/analysis.go b/internal/analysisinternal/analysis.go
index abf708111bf..b22e314cf45 100644
--- a/internal/analysisinternal/analysis.go
+++ b/internal/analysisinternal/analysis.go
@@ -15,14 +15,19 @@ import (
"go/scanner"
"go/token"
"go/types"
+ "iter"
pathpkg "path"
"slices"
"strings"
"golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/internal/astutil/cursor"
"golang.org/x/tools/internal/typesinternal"
)
+// Deprecated: this heuristic is ill-defined.
+// TODO(adonovan): move to sole use in gopls/internal/cache.
func TypeErrorEndPos(fset *token.FileSet, src []byte, start token.Pos) token.Pos {
// Get the end position for the type error.
file := fset.File(start)
@@ -215,7 +220,7 @@ func CheckReadable(pass *analysis.Pass, filename string) error {
// to form a qualified name, and the edit for the new import.
//
// In the special case that pkgpath is dot-imported then member, the
-// identifer for which the import is being added, is consulted. If
+// identifier for which the import is being added, is consulted. If
// member is not shadowed at pos, AddImport returns (".", "", nil).
// (AddImport accepts the caller's implicit claim that the imported
// package declares member.)
@@ -247,24 +252,18 @@ func AddImport(info *types.Info, file *ast.File, preferredName, pkgpath, member
// We must add a new import.
// Ensure we have a fresh name.
- newName := preferredName
- for i := 0; ; i++ {
- if _, obj := scope.LookupParent(newName, pos); obj == nil {
- break // fresh
- }
- newName = fmt.Sprintf("%s%d", preferredName, i)
- }
+ newName := FreshName(scope, pos, preferredName)
- // For now, keep it real simple: create a new import
- // declaration before the first existing declaration (which
- // must exist), including its comments, and let goimports tidy it up.
+ // Create a new import declaration either before the first existing
+ // declaration (which must exist), including its comments; or
+ // inside the declaration, if it is an import group.
//
// Use a renaming import whenever the preferred name is not
// available, or the chosen name does not match the last
// segment of its path.
- newText := fmt.Sprintf("import %q\n\n", pkgpath)
+ newText := fmt.Sprintf("%q", pkgpath)
if newName != preferredName || newName != pathpkg.Base(pkgpath) {
- newText = fmt.Sprintf("import %s %q\n\n", newName, pkgpath)
+ newText = fmt.Sprintf("%s %q", newName, pkgpath)
}
decl0 := file.Decls[0]
var before ast.Node = decl0
@@ -278,13 +277,34 @@ func AddImport(info *types.Info, file *ast.File, preferredName, pkgpath, member
before = decl0.Doc
}
}
+ // If the first decl is an import group, add this new import at the end.
+ if gd, ok := before.(*ast.GenDecl); ok && gd.Tok == token.IMPORT && gd.Rparen.IsValid() {
+ pos = gd.Rparen
+ newText = "\t" + newText + "\n"
+ } else {
+ pos = before.Pos()
+ newText = "import " + newText + "\n\n"
+ }
return newName, newName + ".", []analysis.TextEdit{{
- Pos: before.Pos(),
- End: before.Pos(),
+ Pos: pos,
+ End: pos,
NewText: []byte(newText),
}}
}
+// FreshName returns the name of an identifier that is undefined
+// at the specified position, based on the preferred name.
+func FreshName(scope *types.Scope, pos token.Pos, preferred string) string {
+ newName := preferred
+ for i := 0; ; i++ {
+ if _, obj := scope.LookupParent(newName, pos); obj == nil {
+ break // fresh
+ }
+ newName = fmt.Sprintf("%s%d", preferred, i)
+ }
+ return newName
+}
+
// Format returns a string representation of the expression e.
func Format(fset *token.FileSet, e ast.Expr) string {
var buf strings.Builder
@@ -409,18 +429,19 @@ func validateFix(fset *token.FileSet, fix *analysis.SuggestedFix) error {
start := edit.Pos
file := fset.File(start)
if file == nil {
- return fmt.Errorf("missing file info for pos (%v)", edit.Pos)
+ return fmt.Errorf("no token.File for TextEdit.Pos (%v)", edit.Pos)
}
if end := edit.End; end.IsValid() {
if end < start {
- return fmt.Errorf("pos (%v) > end (%v)", edit.Pos, edit.End)
+ return fmt.Errorf("TextEdit.Pos (%v) > TextEdit.End (%v)", edit.Pos, edit.End)
}
endFile := fset.File(end)
if endFile == nil {
- return fmt.Errorf("malformed end position %v", end)
+ return fmt.Errorf("no token.File for TextEdit.End (%v; File(start).FileEnd is %d)", end, file.Base()+file.Size())
}
if endFile != file {
- return fmt.Errorf("edit spans files %v and %v", file.Name(), endFile.Name())
+ return fmt.Errorf("edit #%d spans files (%v and %v)",
+ i, file.Position(edit.Pos), endFile.Position(edit.End))
}
} else {
edit.End = start // update the SuggestedFix
@@ -449,3 +470,170 @@ func validateFix(fset *token.FileSet, fix *analysis.SuggestedFix) error {
return nil
}
+
+// CanImport reports whether one package is allowed to import another.
+//
+// TODO(adonovan): allow customization of the accessibility relation
+// (e.g. for Bazel).
+func CanImport(from, to string) bool {
+ // TODO(adonovan): better segment hygiene.
+ if to == "internal" || strings.HasPrefix(to, "internal/") {
+ // Special case: only std packages may import internal/...
+ // We can't reliably know whether we're in std, so we
+ // use a heuristic on the first segment.
+ first, _, _ := strings.Cut(from, "/")
+ if strings.Contains(first, ".") {
+ return false // example.com/foo ∉ std
+ }
+ if first == "testdata" {
+ return false // testdata/foo ∉ std
+ }
+ }
+ if strings.HasSuffix(to, "/internal") {
+ return strings.HasPrefix(from, to[:len(to)-len("/internal")])
+ }
+ if i := strings.LastIndex(to, "/internal/"); i >= 0 {
+ return strings.HasPrefix(from, to[:i])
+ }
+ return true
+}
+
+// DeleteStmt returns the edits to remove stmt if it is contained
+// in a BlockStmt, CaseClause, CommClause, or is the STMT in switch STMT; ... {...}
+// The report function abstracts gopls' bug.Report.
+func DeleteStmt(fset *token.FileSet, astFile *ast.File, stmt ast.Stmt, report func(string, ...any)) []analysis.TextEdit {
+ // TODO: pass in the cursor to a ast.Stmt. callers should provide the Cursor
+ insp := inspector.New([]*ast.File{astFile})
+ root := cursor.Root(insp)
+ cstmt, ok := root.FindNode(stmt)
+ if !ok {
+ report("%s not found in file", stmt.Pos())
+ return nil
+ }
+ // some paranoia
+ if !stmt.Pos().IsValid() || !stmt.End().IsValid() {
+ report("%s: stmt has invalid position", stmt.Pos())
+ return nil
+ }
+
+ // if the stmt is on a line by itself delete the whole line
+ // otherwise just delete the statement.
+
+ // this logic would be a lot simpler with the file contents, and somewhat simpler
+ // if the cursors included the comments.
+
+ tokFile := fset.File(stmt.Pos())
+ lineOf := tokFile.Line
+ stmtStartLine, stmtEndLine := lineOf(stmt.Pos()), lineOf(stmt.End())
+
+ var from, to token.Pos
+ // bounds of adjacent syntax/comments on same line, if any
+ limits := func(left, right token.Pos) {
+ if lineOf(left) == stmtStartLine {
+ from = left
+ }
+ if lineOf(right) == stmtEndLine {
+ to = right
+ }
+ }
+ // TODO(pjw): there are other places a statement might be removed:
+ // IfStmt = "if" [ SimpleStmt ";" ] Expression Block [ "else" ( IfStmt | Block ) ] .
+ // (removing the blocks requires more rewriting than this routine would do)
+ // CommCase = "case" ( SendStmt | RecvStmt ) | "default" .
+ // (removing the stmt requires more rewriting, and it's unclear what the user means)
+ switch parent := cstmt.Parent().Node().(type) {
+ case *ast.SwitchStmt:
+ limits(parent.Switch, parent.Body.Lbrace)
+ case *ast.TypeSwitchStmt:
+ limits(parent.Switch, parent.Body.Lbrace)
+ if parent.Assign == stmt {
+ return nil // don't let the user break the type switch
+ }
+ case *ast.BlockStmt:
+ limits(parent.Lbrace, parent.Rbrace)
+ case *ast.CommClause:
+ limits(parent.Colon, cstmt.Parent().Parent().Node().(*ast.BlockStmt).Rbrace)
+ if parent.Comm == stmt {
+ return nil // maybe the user meant to remove the entire CommClause?
+ }
+ case *ast.CaseClause:
+ limits(parent.Colon, cstmt.Parent().Parent().Node().(*ast.BlockStmt).Rbrace)
+ case *ast.ForStmt:
+ limits(parent.For, parent.Body.Lbrace)
+
+ default:
+ return nil // not one of ours
+ }
+
+ if prev, found := cstmt.PrevSibling(); found && lineOf(prev.Node().End()) == stmtStartLine {
+ from = prev.Node().End() // preceding statement ends on same line
+ }
+ if next, found := cstmt.NextSibling(); found && lineOf(next.Node().Pos()) == stmtEndLine {
+ to = next.Node().Pos() // following statement begins on same line
+ }
+ // and now for the comments
+Outer:
+ for _, cg := range astFile.Comments {
+ for _, co := range cg.List {
+ if lineOf(co.End()) < stmtStartLine {
+ continue
+ } else if lineOf(co.Pos()) > stmtEndLine {
+ break Outer // no more are possible
+ }
+ if lineOf(co.End()) == stmtStartLine && co.End() < stmt.Pos() {
+ if !from.IsValid() || co.End() > from {
+ from = co.End()
+ continue // maybe there are more
+ }
+ }
+ if lineOf(co.Pos()) == stmtEndLine && co.Pos() > stmt.End() {
+ if !to.IsValid() || co.Pos() < to {
+ to = co.Pos()
+ continue // maybe there are more
+ }
+ }
+ }
+ }
+ // if either from or to is valid, just remove the statement
+ // otherwise remove the line
+ edit := analysis.TextEdit{Pos: stmt.Pos(), End: stmt.End()}
+ if from.IsValid() || to.IsValid() {
+ // remove just the statment.
+ // we can't tell if there is a ; or whitespace right after the statment
+ // ideally we'd like to remove the former and leave the latter
+ // (if gofmt has run, there likely won't be a ;)
+ // In type switches we know there's a semicolon somewhere after the statement,
+ // but the extra work for this special case is not worth it, as gofmt will fix it.
+ return []analysis.TextEdit{edit}
+ }
+ // remove the whole line
+ for lineOf(edit.Pos) == stmtStartLine {
+ edit.Pos--
+ }
+ edit.Pos++ // get back tostmtStartLine
+ for lineOf(edit.End) == stmtEndLine {
+ edit.End++
+ }
+ return []analysis.TextEdit{edit}
+}
+
+// Comments returns an iterator over the comments overlapping the specified interval.
+func Comments(file *ast.File, start, end token.Pos) iter.Seq[*ast.Comment] {
+ // TODO(adonovan): optimize use binary O(log n) instead of linear O(n) search.
+ return func(yield func(*ast.Comment) bool) {
+ for _, cg := range file.Comments {
+ for _, co := range cg.List {
+ if co.Pos() > end {
+ return
+ }
+ if co.End() < start {
+ continue
+ }
+
+ if !yield(co) {
+ return
+ }
+ }
+ }
+ }
+}
diff --git a/internal/analysisinternal/analysis_test.go b/internal/analysisinternal/analysis_test.go
new file mode 100644
index 00000000000..e3c760aff5a
--- /dev/null
+++ b/internal/analysisinternal/analysis_test.go
@@ -0,0 +1,300 @@
+// Copyright 2025 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 analysisinternal
+
+import (
+ "go/ast"
+ "go/parser"
+ "go/token"
+ "slices"
+ "testing"
+
+ "golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/internal/astutil/cursor"
+)
+
+func TestCanImport(t *testing.T) {
+ for _, tt := range []struct {
+ from string
+ to string
+ want bool
+ }{
+ {"fmt", "internal", true},
+ {"fmt", "internal/foo", true},
+ {"a.com/b", "internal", false},
+ {"a.com/b", "xinternal", true},
+ {"a.com/b", "internal/foo", false},
+ {"a.com/b", "xinternal/foo", true},
+ {"a.com/b", "a.com/internal", true},
+ {"a.com/b", "a.com/b/internal", true},
+ {"a.com/b", "a.com/b/internal/foo", true},
+ {"a.com/b", "a.com/c/internal", false},
+ {"a.com/b", "a.com/c/xinternal", true},
+ {"a.com/b", "a.com/c/internal/foo", false},
+ {"a.com/b", "a.com/c/xinternal/foo", true},
+ } {
+ got := CanImport(tt.from, tt.to)
+ if got != tt.want {
+ t.Errorf("CanImport(%q, %q) = %v, want %v", tt.from, tt.to, got, tt.want)
+ }
+ }
+}
+
+func TestDeleteStmt(t *testing.T) {
+ type testCase struct {
+ in string
+ which int // count of ast.Stmt in ast.Inspect traversal to remove
+ want string
+ name string // should contain exactly one of [block,switch,case,comm,for,type]
+ }
+ tests := []testCase{
+ { // do nothing when asked to remove a function body
+ in: "package p; func f() { }",
+ which: 0,
+ want: "package p; func f() { }",
+ name: "block0",
+ },
+ {
+ in: "package p; func f() { abcd()}",
+ which: 1,
+ want: "package p; func f() { }",
+ name: "block1",
+ },
+ {
+ in: "package p; func f() { a() }",
+ which: 1,
+ want: "package p; func f() { }",
+ name: "block2",
+ },
+ {
+ in: "package p; func f() { a();}",
+ which: 1,
+ want: "package p; func f() { ;}",
+ name: "block3",
+ },
+ {
+ in: "package p; func f() {\n a() \n\n}",
+ which: 1,
+ want: "package p; func f() {\n\n}",
+ name: "block4",
+ },
+ {
+ in: "package p; func f() { a()// comment\n}",
+ which: 1,
+ want: "package p; func f() { // comment\n}",
+ name: "block5",
+ },
+ {
+ in: "package p; func f() { /*c*/a() \n}",
+ which: 1,
+ want: "package p; func f() { /*c*/ \n}",
+ name: "block6",
+ },
+ {
+ in: "package p; func f() { a();b();}",
+ which: 2,
+ want: "package p; func f() { a();;}",
+ name: "block7",
+ },
+ {
+ in: "package p; func f() {\n\ta()\n\tb()\n}",
+ which: 2,
+ want: "package p; func f() {\n\ta()\n}",
+ name: "block8",
+ },
+ {
+ in: "package p; func f() {\n\ta()\n\tb()\n\tc()\n}",
+ which: 2,
+ want: "package p; func f() {\n\ta()\n\tc()\n}",
+ name: "block9",
+ },
+ {
+ in: "package p\nfunc f() {a()+b()}",
+ which: 1,
+ want: "package p\nfunc f() {}",
+ name: "block10",
+ },
+ {
+ in: "package p\nfunc f() {(a()+b())}",
+ which: 1,
+ want: "package p\nfunc f() {}",
+ name: "block11",
+ },
+ {
+ in: "package p; func f() { switch a(); b() {}}",
+ which: 2, // 0 is the func body, 1 is the switch statement
+ want: "package p; func f() { switch ; b() {}}",
+ name: "switch0",
+ },
+ {
+ in: "package p; func f() { switch /*c*/a(); {}}",
+ which: 2, // 0 is the func body, 1 is the switch statement
+ want: "package p; func f() { switch /*c*/; {}}",
+ name: "switch1",
+ },
+ {
+ in: "package p; func f() { switch a()/*c*/; {}}",
+ which: 2, // 0 is the func body, 1 is the switch statement
+ want: "package p; func f() { switch /*c*/; {}}",
+ name: "switch2",
+ },
+ {
+ in: "package p; func f() { select {default: a()}}",
+ which: 4, // 0 is the func body, 1 is the select statement, 2 is its body, 3 is the comm clause
+ want: "package p; func f() { select {default: }}",
+ name: "comm0",
+ },
+ {
+ in: "package p; func f(x chan any) { select {case x <- a: a(x)}}",
+ which: 5, // 0 is the func body, 1 is the select statement, 2 is its body, 3 is the comm clause
+ want: "package p; func f(x chan any) { select {case x <- a: }}",
+ name: "comm1",
+ },
+ {
+ in: "package p; func f(x chan any) { select {case x <- a: a(x)}}",
+ which: 4, // 0 is the func body, 1 is the select statement, 2 is its body, 3 is the comm clause
+ want: "package p; func f(x chan any) { select {case x <- a: a(x)}}",
+ name: "comm2",
+ },
+ {
+ in: "package p; func f() { switch {default: a()}}",
+ which: 4, // 0 is the func body, 1 is the select statement, 2 is its body
+ want: "package p; func f() { switch {default: }}",
+ name: "case0",
+ },
+ {
+ in: "package p; func f() { switch {case 3: a()}}",
+ which: 4, // 0 is the func body, 1 is the select statement, 2 is its body
+ want: "package p; func f() { switch {case 3: }}",
+ name: "case1",
+ },
+ {
+ in: "package p; func f() {for a();;b() {}}",
+ which: 2,
+ want: "package p; func f() {for ;;b() {}}",
+ name: "for0",
+ },
+ {
+ in: "package p; func f() {for a();c();b() {}}",
+ which: 3,
+ want: "package p; func f() {for a();c(); {}}",
+ name: "for1",
+ },
+ {
+ in: "package p; func f() {for\na();c()\nb() {}}",
+ which: 2,
+ want: "package p; func f() {for\n;c()\nb() {}}",
+ name: "for2",
+ },
+ {
+ in: "package p; func f() {for a();\nc();b() {}}",
+ which: 3,
+ want: "package p; func f() {for a();\nc(); {}}",
+ name: "for3",
+ },
+ {
+ in: "package p; func f() {switch a();b().(type){}}",
+ which: 2,
+ want: "package p; func f() {switch ;b().(type){}}",
+ name: "type0",
+ },
+ {
+ in: "package p; func f() {switch a();b().(type){}}",
+ which: 3,
+ want: "package p; func f() {switch a();b().(type){}}",
+ name: "type1",
+ },
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ fset := token.NewFileSet()
+ f, err := parser.ParseFile(fset, tt.name, tt.in, parser.ParseComments)
+ if err != nil {
+ t.Fatalf("%s: %v", tt.name, err)
+ }
+ insp := inspector.New([]*ast.File{f})
+ root := cursor.Root(insp)
+ var stmt cursor.Cursor
+ cnt := 0
+ for cn := range root.Preorder() { // Preorder(ast.Stmt(nil)) doesn't work
+ if _, ok := cn.Node().(ast.Stmt); !ok {
+ continue
+ }
+ if cnt == tt.which {
+ stmt = cn
+ break
+ }
+ cnt++
+ }
+ if cnt != tt.which {
+ t.Fatalf("test %s does not contain desired statement %d", tt.name, tt.which)
+ }
+ edits := DeleteStmt(fset, f, stmt.Node().(ast.Stmt), nil)
+ if tt.want == tt.in {
+ if len(edits) != 0 {
+ t.Fatalf("%s: got %d edits, expected 0", tt.name, len(edits))
+ }
+ return
+ }
+ if len(edits) != 1 {
+ t.Fatalf("%s: got %d edits, expected 1", tt.name, len(edits))
+ }
+ tokFile := fset.File(f.Pos())
+
+ left := tokFile.Offset(edits[0].Pos)
+ right := tokFile.Offset(edits[0].End)
+
+ got := tt.in[:left] + tt.in[right:]
+ if got != tt.want {
+ t.Errorf("%s: got\n%q, want\n%q", tt.name, got, tt.want)
+ }
+ })
+
+ }
+}
+
+func TestComments(t *testing.T) {
+ src := `
+package main
+
+// A
+func fn() { }`
+ var fset token.FileSet
+ f, err := parser.ParseFile(&fset, "", []byte(src), parser.ParseComments|parser.AllErrors)
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ commentA := f.Comments[0].List[0]
+ commentAMidPos := (commentA.Pos() + commentA.End()) / 2
+
+ want := []*ast.Comment{commentA}
+ testCases := []struct {
+ name string
+ start, end token.Pos
+ want []*ast.Comment
+ }{
+ {name: "comment totally overlaps with given interval", start: f.Pos(), end: f.End(), want: want},
+ {name: "interval from file start to mid of comment A", start: f.Pos(), end: commentAMidPos, want: want},
+ {name: "interval from mid of comment A to file end", start: commentAMidPos, end: commentA.End(), want: want},
+ {name: "interval from start of comment A to mid of comment A", start: commentA.Pos(), end: commentAMidPos, want: want},
+ {name: "interval from mid of comment A to comment A end", start: commentAMidPos, end: commentA.End(), want: want},
+ {name: "interval at the start of comment A", start: commentA.Pos(), end: commentA.Pos(), want: want},
+ {name: "interval at the end of comment A", start: commentA.End(), end: commentA.End(), want: want},
+ {name: "interval from file start to the front of comment A start", start: f.Pos(), end: commentA.Pos() - 1, want: nil},
+ {name: "interval from the position after end of comment A to file end", start: commentA.End() + 1, end: f.End(), want: nil},
+ }
+ for _, tc := range testCases {
+ t.Run(tc.name, func(t *testing.T) {
+ var got []*ast.Comment
+ for co := range Comments(f, tc.start, tc.end) {
+ got = append(got, co)
+ }
+ if !slices.Equal(got, tc.want) {
+ t.Errorf("%s: got %v, want %v", tc.name, got, tc.want)
+ }
+ })
+ }
+}
diff --git a/internal/analysisinternal/typeindex/typeindex.go b/internal/analysisinternal/typeindex/typeindex.go
new file mode 100644
index 00000000000..bba21c6ea01
--- /dev/null
+++ b/internal/analysisinternal/typeindex/typeindex.go
@@ -0,0 +1,33 @@
+// Copyright 2025 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 typeindex defines an analyzer that provides a
+// [golang.org/x/tools/internal/typesinternal/typeindex.Index].
+//
+// Like [golang.org/x/tools/go/analysis/passes/inspect], it is
+// intended to be used as a helper by other analyzers; it reports no
+// diagnostics of its own.
+package typeindex
+
+import (
+ "reflect"
+
+ "golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/go/analysis/passes/inspect"
+ "golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
+)
+
+var Analyzer = &analysis.Analyzer{
+ Name: "typeindex",
+ Doc: "indexes of type information for later passes",
+ URL: "https://pkg.go.dev/golang.org/x/tools/internal/analysisinternal/typeindex",
+ Run: func(pass *analysis.Pass) (any, error) {
+ inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+ return typeindex.New(inspect, pass.Pkg, pass.TypesInfo), nil
+ },
+ RunDespiteErrors: true,
+ Requires: []*analysis.Analyzer{inspect.Analyzer},
+ ResultType: reflect.TypeOf(new(typeindex.Index)),
+}
diff --git a/internal/astutil/clone.go b/internal/astutil/clone.go
index d5ee82c58b2..2c9b6bb4841 100644
--- a/internal/astutil/clone.go
+++ b/internal/astutil/clone.go
@@ -25,7 +25,7 @@ func cloneNode(n ast.Node) ast.Node {
}
clone = func(x reflect.Value) reflect.Value {
switch x.Kind() {
- case reflect.Ptr:
+ case reflect.Pointer:
if x.IsNil() {
return x
}
diff --git a/internal/astutil/comment.go b/internal/astutil/comment.go
index 192d6430de0..ee4be23f226 100644
--- a/internal/astutil/comment.go
+++ b/internal/astutil/comment.go
@@ -6,6 +6,7 @@ package astutil
import (
"go/ast"
+ "go/token"
"strings"
)
@@ -26,3 +27,87 @@ func Deprecation(doc *ast.CommentGroup) string {
}
return ""
}
+
+// -- plundered from the future (CL 605517, issue #68021) --
+
+// TODO(adonovan): replace with ast.Directive after go1.25 (#68021).
+// Beware of our local mods to handle analysistest
+// "want" comments on the same line.
+
+// A directive is a comment line with special meaning to the Go
+// toolchain or another tool. It has the form:
+//
+// //tool:name args
+//
+// The "tool:" portion is missing for the three directives named
+// line, extern, and export.
+//
+// See https://go.dev/doc/comment#Syntax for details of Go comment
+// syntax and https://pkg.go.dev/cmd/compile#hdr-Compiler_Directives
+// for details of directives used by the Go compiler.
+type Directive struct {
+ Pos token.Pos // of preceding "//"
+ Tool string
+ Name string
+ Args string // may contain internal spaces
+}
+
+// isDirective reports whether c is a comment directive.
+// This code is also in go/printer.
+func isDirective(c string) bool {
+ // "//line " is a line directive.
+ // "//extern " is for gccgo.
+ // "//export " is for cgo.
+ // (The // has been removed.)
+ if strings.HasPrefix(c, "line ") || strings.HasPrefix(c, "extern ") || strings.HasPrefix(c, "export ") {
+ return true
+ }
+
+ // "//[a-z0-9]+:[a-z0-9]"
+ // (The // has been removed.)
+ colon := strings.Index(c, ":")
+ if colon <= 0 || colon+1 >= len(c) {
+ return false
+ }
+ for i := 0; i <= colon+1; i++ {
+ if i == colon {
+ continue
+ }
+ b := c[i]
+ if !('a' <= b && b <= 'z' || '0' <= b && b <= '9') {
+ return false
+ }
+ }
+ return true
+}
+
+// Directives returns the directives within the comment.
+func Directives(g *ast.CommentGroup) (res []*Directive) {
+ if g != nil {
+ // Avoid (*ast.CommentGroup).Text() as it swallows directives.
+ for _, c := range g.List {
+ if len(c.Text) > 2 &&
+ c.Text[1] == '/' &&
+ c.Text[2] != ' ' &&
+ isDirective(c.Text[2:]) {
+
+ tool, nameargs, ok := strings.Cut(c.Text[2:], ":")
+ if !ok {
+ // Must be one of {line,extern,export}.
+ tool, nameargs = "", tool
+ }
+ name, args, _ := strings.Cut(nameargs, " ") // tab??
+ // Permit an additional line comment after the args, chiefly to support
+ // [golang.org/x/tools/go/analysis/analysistest].
+ args, _, _ = strings.Cut(args, "//")
+ res = append(res, &Directive{
+ Pos: c.Slash,
+ Tool: tool,
+ Name: name,
+ Args: strings.TrimSpace(args),
+ })
+ }
+ }
+ }
+ return
+}
diff --git a/internal/astutil/cursor/cursor.go b/internal/astutil/cursor/cursor.go
index 1052f65acfb..3f015998c52 100644
--- a/internal/astutil/cursor/cursor.go
+++ b/internal/astutil/cursor/cursor.go
@@ -44,6 +44,37 @@ func Root(in *inspector.Inspector) Cursor {
return Cursor{in, -1}
}
+// At returns the cursor at the specified index in the traversal,
+// which must have been obtained from [Cursor.Index] on a Cursor
+// belonging to the same Inspector.
+func At(in *inspector.Inspector, index int32) Cursor {
+ if index < 0 {
+ panic("negative index")
+ }
+ events := events(in)
+ if int(index) >= len(events) {
+ panic("index out of range for this inspector")
+ }
+ if events[index].index < index {
+ panic("invalid index") // (a push, not a pop)
+ }
+ return Cursor{in, index}
+}
+
+// Index returns the index of this cursor position within the package.
+//
+// Clients should not assume anything about the numeric Index value
+// except that it increases monotonically throughout the traversal.
+// It is provided for use with [At].
+//
+// Index must not be called on the Root node.
+func (c Cursor) Index() int32 {
+ if c.index < 0 {
+ panic("Index called on Root node")
+ }
+ return c.index
+}
+
// Node returns the node at the current cursor position,
// or nil for the cursor returned by [Inspector.Root].
func (c Cursor) Node() ast.Node {
@@ -167,30 +198,29 @@ func (c Cursor) Stack(stack []Cursor) []Cursor {
panic("Cursor.Stack called on Root node")
}
- stack = append(stack, c)
- stack = slices.AppendSeq(stack, c.Ancestors())
+ stack = slices.AppendSeq(stack, c.Enclosing())
slices.Reverse(stack)
return stack
}
-// Ancestors returns an iterator over the ancestors of the current
-// node, starting with [Cursor.Parent].
+// Enclosing returns an iterator over the nodes enclosing the current
+// current node, starting with the Cursor itself.
//
-// Ancestors must not be called on the Root node (whose [Cursor.Node] returns nil).
+// Enclosing must not be called on the Root node (whose [Cursor.Node] returns nil).
//
// The types argument, if non-empty, enables type-based filtering of
-// events: the sequence includes only ancestors whose type matches an
-// element of the types slice.
-func (c Cursor) Ancestors(types ...ast.Node) iter.Seq[Cursor] {
+// events: the sequence includes only enclosing nodes whose type
+// matches an element of the types slice.
+func (c Cursor) Enclosing(types ...ast.Node) iter.Seq[Cursor] {
if c.index < 0 {
- panic("Cursor.Ancestors called on Root node")
+ panic("Cursor.Enclosing called on Root node")
}
mask := maskOf(types)
return func(yield func(Cursor) bool) {
events := c.events()
- for i := events[c.index].parent; i >= 0; i = events[i].parent {
+ for i := c.index; i >= 0; i = events[i].parent {
if events[i].typ&mask != 0 && !yield(Cursor{c.in, i}) {
break
}
@@ -209,25 +239,52 @@ func (c Cursor) Parent() Cursor {
return Cursor{c.in, c.events()[c.index].parent}
}
-// Edge returns the identity of the field in the parent node
+// ParentEdge returns the identity of the field in the parent node
// that holds this cursor's node, and if it is a list, the index within it.
//
// For example, f(x, y) is a CallExpr whose three children are Idents.
// f has edge kind [edge.CallExpr_Fun] and index -1.
// x and y have kind [edge.CallExpr_Args] and indices 0 and 1, respectively.
//
-// Edge must not be called on the Root node (whose [Cursor.Node] returns nil).
-//
// If called on a child of the Root node, it returns ([edge.Invalid], -1).
-func (c Cursor) Edge() (edge.Kind, int) {
+//
+// ParentEdge must not be called on the Root node (whose [Cursor.Node] returns nil).
+func (c Cursor) ParentEdge() (edge.Kind, int) {
if c.index < 0 {
- panic("Cursor.Edge called on Root node")
+ panic("Cursor.ParentEdge called on Root node")
}
events := c.events()
pop := events[c.index].index
return unpackEdgeKindAndIndex(events[pop].parent)
}
+// ChildAt returns the cursor for the child of the
+// current node identified by its edge and index.
+// The index must be -1 if the edge.Kind is not a slice.
+// The indicated child node must exist.
+//
+// ChildAt must not be called on the Root node (whose [Cursor.Node] returns nil).
+//
+// Invariant: c.Parent().ChildAt(c.ParentEdge()) == c.
+func (c Cursor) ChildAt(k edge.Kind, idx int) Cursor {
+ target := packEdgeKindAndIndex(k, idx)
+
+ // Unfortunately there's no shortcut to looping.
+ events := c.events()
+ i := c.index + 1
+ for {
+ pop := events[i].index
+ if pop < i {
+ break
+ }
+ if events[pop].parent == target {
+ return Cursor{c.in, i}
+ }
+ i = pop + 1
+ }
+ panic(fmt.Sprintf("ChildAt(%v, %d): no such child of %v", k, idx, c))
+}
+
// Child returns the cursor for n, which must be a direct child of c's Node.
//
// Child must not be called on the Root node (whose [Cursor.Node] returns nil).
@@ -355,7 +412,7 @@ func (c Cursor) LastChild() (Cursor, bool) {
// So, do not assume that the previous sibling of an ast.Stmt is also
// an ast.Stmt, or if it is, that they are executed sequentially,
// unless you have established that, say, its parent is a BlockStmt
-// or its [Cursor.Edge] is [edge.BlockStmt_List].
+// or its [Cursor.ParentEdge] is [edge.BlockStmt_List].
// For example, given "for S1; ; S2 {}", the predecessor of S2 is S1,
// even though they are not executed in sequence.
func (c Cursor) Children() iter.Seq[Cursor] {
@@ -367,6 +424,18 @@ func (c Cursor) Children() iter.Seq[Cursor] {
}
}
+// Contains reports whether c contains or is equal to c2.
+//
+// Both Cursors must belong to the same [Inspector];
+// neither may be its Root node.
+func (c Cursor) Contains(c2 Cursor) bool {
+ if c.in != c2.in {
+ panic("different inspectors")
+ }
+ events := c.events()
+ return c.index <= c2.index && events[c2.index].index <= events[c.index].index
+}
+
// FindNode returns the cursor for node n if it belongs to the subtree
// rooted at c. It returns zero if n is not found.
func (c Cursor) FindNode(n ast.Node) (Cursor, bool) {
@@ -407,6 +476,8 @@ func (c Cursor) FindNode(n ast.Node) (Cursor, bool) {
// FindPos returns the cursor for the innermost node n in the tree
// rooted at c such that n.Pos() <= start && end <= n.End().
+// (For an *ast.File, it uses the bounds n.FileStart-n.FileEnd.)
+//
// It returns zero if none is found.
// Precondition: start <= end.
//
@@ -425,10 +496,22 @@ func (c Cursor) FindPos(start, end token.Pos) (Cursor, bool) {
for i, limit := c.indices(); i < limit; i++ {
ev := events[i]
if ev.index > i { // push?
- if ev.node.Pos() > start {
- break // disjoint, after; stop
+ n := ev.node
+ var nodeEnd token.Pos
+ if file, ok := n.(*ast.File); ok {
+ nodeEnd = file.FileEnd
+ // Note: files may be out of Pos order.
+ if file.FileStart > start {
+ i = ev.index // disjoint, after; skip to next file
+ continue
+ }
+ } else {
+ nodeEnd = n.End()
+ if n.Pos() > start {
+ break // disjoint, after; stop
+ }
}
- nodeEnd := ev.node.End()
+ // Inv: node.{Pos,FileStart} <= start
if end <= nodeEnd {
// node fully contains target range
best = i
diff --git a/internal/astutil/cursor/cursor_test.go b/internal/astutil/cursor/cursor_test.go
index 01f791f2833..9effae912a3 100644
--- a/internal/astutil/cursor/cursor_test.go
+++ b/internal/astutil/cursor/cursor_test.go
@@ -14,6 +14,7 @@ import (
"go/token"
"iter"
"log"
+ "math/rand"
"path/filepath"
"reflect"
"slices"
@@ -130,9 +131,8 @@ func g() {
_ = curFunc.Node().(*ast.FuncDecl)
// Check edge and index.
- if e, idx := curFunc.Edge(); e != edge.File_Decls || idx != nfuncs {
- t.Errorf("%v.Edge() = (%v, %v), want edge.File_Decls, %d",
- curFunc, e, idx, nfuncs)
+ if k, idx := curFunc.ParentEdge(); k != edge.File_Decls || idx != nfuncs {
+ t.Errorf("%v.ParentEdge() = (%v, %d), want edge.File_Decls, %d", curFunc, k, idx, nfuncs)
}
nfuncs++
@@ -162,11 +162,10 @@ func g() {
t.Errorf("curCall.Stack() = %q, want %q", got, want)
}
- // Ancestors = Reverse(Stack[:last]).
- stack = stack[:len(stack)-1]
+ // Enclosing = Reverse(Stack()).
slices.Reverse(stack)
- if got, want := slices.Collect(curCall.Ancestors()), stack; !reflect.DeepEqual(got, want) {
- t.Errorf("Ancestors = %v, Reverse(Stack - last element) = %v", got, want)
+ if got, want := slices.Collect(curCall.Enclosing()), stack; !reflect.DeepEqual(got, want) {
+ t.Errorf("Enclosing = %v, Reverse(Stack - last element) = %v", got, want)
}
}
@@ -332,8 +331,31 @@ func TestCursor_FindNode(t *testing.T) {
}
}
}
+}
+
+// TestCursor_FindPos_order ensures that FindPos does not assume files are in Pos order.
+func TestCursor_FindPos_order(t *testing.T) {
+ // Pick an arbitrary decl.
+ target := netFiles[7].Decls[0]
+
+ // Find the target decl by its position.
+ cur, ok := cursor.Root(netInspect).FindPos(target.Pos(), target.End())
+ if !ok || cur.Node() != target {
+ t.Fatalf("unshuffled: FindPos(%T) = (%v, %t)", target, cur, ok)
+ }
+
+ // Shuffle the files out of Pos order.
+ files := slices.Clone(netFiles)
+ rand.Shuffle(len(files), func(i, j int) {
+ files[i], files[j] = files[j], files[i]
+ })
- // TODO(adonovan): FindPos needs a test (not just a benchmark).
+ // Find it again.
+ inspect := inspector.New(files)
+ cur, ok = cursor.Root(inspect).FindPos(target.Pos(), target.End())
+ if !ok || cur.Node() != target {
+ t.Fatalf("shuffled: FindPos(%T) = (%v, %t)", target, cur, ok)
+ }
}
func TestCursor_Edge(t *testing.T) {
@@ -343,8 +365,10 @@ func TestCursor_Edge(t *testing.T) {
continue // root node
}
- e, idx := cur.Edge()
- parent := cur.Parent()
+ var (
+ parent = cur.Parent()
+ e, idx = cur.ParentEdge()
+ )
// ast.File, child of root?
if parent.Node() == nil {
@@ -360,12 +384,18 @@ func TestCursor_Edge(t *testing.T) {
e.NodeType(), parent.Node())
}
- // Check consistency of c.Edge.Get(c.Parent().Node()) == c.Node().
+ // Check c.Edge.Get(c.Parent.Node) == c.Node.
if got := e.Get(parent.Node(), idx); got != cur.Node() {
t.Errorf("cur=%v@%s: %s.Get(cur.Parent().Node(), %d) = %T@%s, want cur.Node()",
cur, netFset.Position(cur.Node().Pos()), e, idx, got, netFset.Position(got.Pos()))
}
+ // Check c.Parent.ChildAt(c.ParentEdge()) == c.
+ if got := parent.ChildAt(e, idx); got != cur {
+ t.Errorf("cur=%v@%s: cur.Parent().ChildAt(%v, %d) = %T@%s, want cur",
+ cur, netFset.Position(cur.Node().Pos()), e, idx, got.Node(), netFset.Position(got.Node().Pos()))
+ }
+
// Check that reflection on the parent finds the current node.
fv := reflect.ValueOf(parent.Node()).Elem().FieldByName(e.FieldName())
if idx >= 0 {
@@ -384,6 +414,38 @@ func TestCursor_Edge(t *testing.T) {
if cur.Parent().Child(cur.Node()) != cur {
t.Errorf("Cursor.Parent.Child = %v, want %v", cur.Parent().Child(cur.Node()), cur)
}
+
+ // Check invariants of Contains:
+
+ // A cursor contains itself.
+ if !cur.Contains(cur) {
+ t.Errorf("!cur.Contains(cur): %v", cur)
+ }
+ // A parent contains its child, but not the inverse.
+ if !parent.Contains(cur) {
+ t.Errorf("!cur.Parent().Contains(cur): %v", cur)
+ }
+ if cur.Contains(parent) {
+ t.Errorf("cur.Contains(cur.Parent()): %v", cur)
+ }
+ // A grandparent contains its grandchild, but not the inverse.
+ if grandparent := cur.Parent(); grandparent.Node() != nil {
+ if !grandparent.Contains(cur) {
+ t.Errorf("!cur.Parent().Parent().Contains(cur): %v", cur)
+ }
+ if cur.Contains(grandparent) {
+ t.Errorf("cur.Contains(cur.Parent().Parent()): %v", cur)
+ }
+ }
+ // A cursor and its uncle/aunt do not contain each other.
+ if uncle, ok := parent.NextSibling(); ok {
+ if uncle.Contains(cur) {
+ t.Errorf("cur.Parent().NextSibling().Contains(cur): %v", cur)
+ }
+ if cur.Contains(uncle) {
+ t.Errorf("cur.Contains(cur.Parent().NextSibling()): %v", cur)
+ }
+ }
}
}
@@ -479,12 +541,12 @@ func BenchmarkInspectCalls(b *testing.B) {
}
})
- b.Run("CursorAncestors", func(b *testing.B) {
+ b.Run("CursorEnclosing", func(b *testing.B) {
var ncalls int
for range b.N {
for cur := range cursor.Root(inspect).Preorder(callExprs...) {
_ = cur.Node().(*ast.CallExpr)
- for range cur.Ancestors() {
+ for range cur.Enclosing() {
}
ncalls++
}
diff --git a/internal/astutil/cursor/hooks.go b/internal/astutil/cursor/hooks.go
index 8b61f5ddc11..0257d61d778 100644
--- a/internal/astutil/cursor/hooks.go
+++ b/internal/astutil/cursor/hooks.go
@@ -31,6 +31,9 @@ func maskOf(nodes []ast.Node) uint64
//go:linkname events golang.org/x/tools/go/ast/inspector.events
func events(in *inspector.Inspector) []event
+//go:linkname packEdgeKindAndIndex golang.org/x/tools/go/ast/inspector.packEdgeKindAndIndex
+func packEdgeKindAndIndex(edge.Kind, int) int32
+
//go:linkname unpackEdgeKindAndIndex golang.org/x/tools/go/ast/inspector.unpackEdgeKindAndIndex
func unpackEdgeKindAndIndex(int32) (edge.Kind, int)
diff --git a/internal/bisect/bisect.go b/internal/bisect/bisect.go
index 5a7da4871a8..7b1d112a7cd 100644
--- a/internal/bisect/bisect.go
+++ b/internal/bisect/bisect.go
@@ -320,7 +320,7 @@ func AppendMarker(dst []byte, id uint64) []byte {
const prefix = "[bisect-match 0x"
var buf [len(prefix) + 16 + 1]byte
copy(buf[:], prefix)
- for i := 0; i < 16; i++ {
+ for i := range 16 {
buf[len(prefix)+i] = "0123456789abcdef"[id>>60]
id <<= 4
}
@@ -504,7 +504,7 @@ func fnvString(h uint64, x string) uint64 {
}
func fnvUint64(h uint64, x uint64) uint64 {
- for i := 0; i < 8; i++ {
+ for range 8 {
h ^= uint64(x & 0xFF)
x >>= 8
h *= prime64
@@ -513,7 +513,7 @@ func fnvUint64(h uint64, x uint64) uint64 {
}
func fnvUint32(h uint64, x uint32) uint64 {
- for i := 0; i < 4; i++ {
+ for range 4 {
h ^= uint64(x & 0xFF)
x >>= 8
h *= prime64
diff --git a/internal/diff/diff.go b/internal/diff/diff.go
index a13547b7a7e..c12bdfd2acd 100644
--- a/internal/diff/diff.go
+++ b/internal/diff/diff.go
@@ -7,6 +7,7 @@ package diff
import (
"fmt"
+ "slices"
"sort"
"strings"
)
@@ -64,7 +65,7 @@ func ApplyBytes(src []byte, edits []Edit) ([]byte, error) {
// It may return a different slice.
func validate(src string, edits []Edit) ([]Edit, int, error) {
if !sort.IsSorted(editsSort(edits)) {
- edits = append([]Edit(nil), edits...)
+ edits = slices.Clone(edits)
SortEdits(edits)
}
diff --git a/internal/diff/diff_test.go b/internal/diff/diff_test.go
index 77a20baf272..9e2a1d23997 100644
--- a/internal/diff/diff_test.go
+++ b/internal/diff/diff_test.go
@@ -61,7 +61,7 @@ func TestNEdits(t *testing.T) {
func TestNRandom(t *testing.T) {
rand.Seed(1)
- for i := 0; i < 1000; i++ {
+ for i := range 1000 {
a := randstr("abω", 16)
b := randstr("abωc", 16)
edits := diff.Strings(a, b)
@@ -200,7 +200,7 @@ func TestRegressionOld002(t *testing.T) {
func randstr(s string, n int) string {
src := []rune(s)
x := make([]rune, n)
- for i := 0; i < n; i++ {
+ for i := range n {
x[i] = src[rand.Intn(len(src))]
}
return string(x)
diff --git a/internal/diff/lcs/common_test.go b/internal/diff/lcs/common_test.go
index f19245e404c..68f4485fdb8 100644
--- a/internal/diff/lcs/common_test.go
+++ b/internal/diff/lcs/common_test.go
@@ -7,6 +7,7 @@ package lcs
import (
"log"
"math/rand"
+ "slices"
"strings"
"testing"
)
@@ -72,10 +73,8 @@ func check(t *testing.T, str string, lcs lcs, want []string) {
got.WriteString(str[dd.X : dd.X+dd.Len])
}
ans := got.String()
- for _, w := range want {
- if ans == w {
- return
- }
+ if slices.Contains(want, ans) {
+ return
}
t.Fatalf("str=%q lcs=%v want=%q got=%q", str, lcs, want, ans)
}
@@ -109,7 +108,7 @@ func lcslen(l lcs) int {
func randstr(s string, n int) string {
src := []rune(s)
x := make([]rune, n)
- for i := 0; i < n; i++ {
+ for i := range n {
x[i] = src[rand.Intn(len(src))]
}
return string(x)
diff --git a/internal/diff/lcs/old.go b/internal/diff/lcs/old.go
index 7c74b47bb1c..c0d43a6c2c7 100644
--- a/internal/diff/lcs/old.go
+++ b/internal/diff/lcs/old.go
@@ -377,10 +377,7 @@ func (e *editGraph) twoDone(df, db int) (int, bool) {
if (df+db+e.delta)%2 != 0 {
return 0, false // diagonals cannot overlap
}
- kmin := -db + e.delta
- if -df > kmin {
- kmin = -df
- }
+ kmin := max(-df, -db+e.delta)
kmax := db + e.delta
if df < kmax {
kmax = df
diff --git a/internal/diff/lcs/old_test.go b/internal/diff/lcs/old_test.go
index ddc3bde0ed2..2eac1af6d2f 100644
--- a/internal/diff/lcs/old_test.go
+++ b/internal/diff/lcs/old_test.go
@@ -107,7 +107,7 @@ func TestRegressionOld003(t *testing.T) {
func TestRandOld(t *testing.T) {
rand.Seed(1)
- for i := 0; i < 1000; i++ {
+ for i := range 1000 {
// TODO(adonovan): use ASCII and bytesSeqs here? The use of
// non-ASCII isn't relevant to the property exercised by the test.
a := []rune(randstr("abω", 16))
@@ -186,7 +186,7 @@ func genBench(set string, n int) []struct{ before, after string } {
// before and after differing at least once, and about 5%
rand.Seed(3)
var ans []struct{ before, after string }
- for i := 0; i < 24; i++ {
+ for range 24 {
// maybe b should have an approximately known number of diffs
a := randstr(set, n)
cnt := 0
diff --git a/internal/diff/ndiff.go b/internal/diff/ndiff.go
index fbef4d730c5..a2eef26ac77 100644
--- a/internal/diff/ndiff.go
+++ b/internal/diff/ndiff.go
@@ -72,7 +72,7 @@ func diffRunes(before, after []rune) []Edit {
func runes(bytes []byte) []rune {
n := utf8.RuneCount(bytes)
runes := make([]rune, n)
- for i := 0; i < n; i++ {
+ for i := range n {
r, sz := utf8.DecodeRune(bytes)
bytes = bytes[sz:]
runes[i] = r
diff --git a/internal/diffp/diff.go b/internal/diffp/diff.go
index aa5ef81ac2e..54ab0888482 100644
--- a/internal/diffp/diff.go
+++ b/internal/diffp/diff.go
@@ -119,10 +119,7 @@ func Diff(oldName string, old []byte, newName string, new []byte) []byte {
// End chunk with common lines for context.
if len(ctext) > 0 {
- n := end.x - start.x
- if n > C {
- n = C
- }
+ n := min(end.x-start.x, C)
for _, s := range x[start.x : start.x+n] {
ctext = append(ctext, " "+s)
count.x++
@@ -237,7 +234,7 @@ func tgs(x, y []string) []pair {
for i := range T {
T[i] = n + 1
}
- for i := 0; i < n; i++ {
+ for i := range n {
k := sort.Search(n, func(k int) bool {
return T[k] >= J[i]
})
diff --git a/internal/event/export/id.go b/internal/event/export/id.go
index bf9938b38c1..fb6026462c1 100644
--- a/internal/event/export/id.go
+++ b/internal/event/export/id.go
@@ -39,7 +39,7 @@ var (
func initGenerator() {
var rngSeed int64
- for _, p := range []interface{}{
+ for _, p := range []any{
&rngSeed, &traceIDAdd, &nextSpanID, &spanIDInc,
} {
binary.Read(crand.Reader, binary.LittleEndian, p)
diff --git a/internal/event/export/metric/exporter.go b/internal/event/export/metric/exporter.go
index 4cafaa52928..588b8a108c7 100644
--- a/internal/event/export/metric/exporter.go
+++ b/internal/event/export/metric/exporter.go
@@ -19,14 +19,14 @@ import (
var Entries = keys.New("metric_entries", "The set of metrics calculated for an event")
type Config struct {
- subscribers map[interface{}][]subscriber
+ subscribers map[any][]subscriber
}
type subscriber func(time.Time, label.Map, label.Label) Data
func (e *Config) subscribe(key label.Key, s subscriber) {
if e.subscribers == nil {
- e.subscribers = make(map[interface{}][]subscriber)
+ e.subscribers = make(map[any][]subscriber)
}
e.subscribers[key] = append(e.subscribers[key], s)
}
diff --git a/internal/event/export/ocagent/README.md b/internal/event/export/ocagent/README.md
deleted file mode 100644
index 22e8469f06b..00000000000
--- a/internal/event/export/ocagent/README.md
+++ /dev/null
@@ -1,139 +0,0 @@
-# Exporting Metrics and Traces with OpenCensus, Zipkin, and Prometheus
-
-This tutorial provides a minimum example to verify that metrics and traces
-can be exported to OpenCensus from Go tools.
-
-## Setting up oragent
-
-1. Ensure you have [docker](https://www.docker.com/get-started) and [docker-compose](https://docs.docker.com/compose/install/).
-2. Clone [oragent](https://github.com/orijtech/oragent).
-3. In the oragent directory, start the services:
-```bash
-docker-compose up
-```
-If everything goes well, you should see output resembling the following:
-```
-Starting oragent_zipkin_1 ... done
-Starting oragent_oragent_1 ... done
-Starting oragent_prometheus_1 ... done
-...
-```
-* You can check the status of the OpenCensus agent using zPages at http://localhost:55679/debug/tracez.
-* You can now access the Prometheus UI at http://localhost:9445.
-* You can now access the Zipkin UI at http://localhost:9444.
-4. To shut down oragent, hit Ctrl+C in the terminal.
-5. You can also start oragent in detached mode by running `docker-compose up -d`. To stop oragent while detached, run `docker-compose down`.
-
-## Exporting Metrics and Traces
-1. Clone the [tools](https://golang.org/x/tools) subrepository.
-1. Inside `internal`, create a file named `main.go` with the following contents:
-```go
-package main
-
-import (
- "context"
- "fmt"
- "math/rand"
- "net/http"
- "time"
-
- "golang.org/x/tools/internal/event"
- "golang.org/x/tools/internal/event/export"
- "golang.org/x/tools/internal/event/export/metric"
- "golang.org/x/tools/internal/event/export/ocagent"
-)
-
-type testExporter struct {
- metrics metric.Exporter
- ocagent *ocagent.Exporter
-}
-
-func (e *testExporter) ProcessEvent(ctx context.Context, ev event.Event) (context.Context, event.Event) {
- ctx, ev = export.Tag(ctx, ev)
- ctx, ev = export.ContextSpan(ctx, ev)
- ctx, ev = e.metrics.ProcessEvent(ctx, ev)
- ctx, ev = e.ocagent.ProcessEvent(ctx, ev)
- return ctx, ev
-}
-
-func main() {
- exporter := &testExporter{}
-
- exporter.ocagent = ocagent.Connect(&ocagent.Config{
- Start: time.Now(),
- Address: "http://127.0.0.1:55678",
- Service: "go-tools-test",
- Rate: 5 * time.Second,
- Client: &http.Client{},
- })
- event.SetExporter(exporter)
-
- ctx := context.TODO()
- mLatency := event.NewFloat64Key("latency", "the latency in milliseconds")
- distribution := metric.HistogramFloat64Data{
- Info: &metric.HistogramFloat64{
- Name: "latencyDistribution",
- Description: "the various latencies",
- Buckets: []float64{0, 10, 50, 100, 200, 400, 800, 1000, 1400, 2000, 5000, 10000, 15000},
- },
- }
-
- distribution.Info.Record(&exporter.metrics, mLatency)
-
- for {
- sleep := randomSleep()
- _, end := event.StartSpan(ctx, "main.randomSleep()")
- time.Sleep(time.Duration(sleep) * time.Millisecond)
- end()
- event.Record(ctx, mLatency.Of(float64(sleep)))
-
- fmt.Println("Latency: ", float64(sleep))
- }
-}
-
-func randomSleep() int64 {
- var max int64
- switch modulus := time.Now().Unix() % 5; modulus {
- case 0:
- max = 17001
- case 1:
- max = 8007
- case 2:
- max = 917
- case 3:
- max = 87
- case 4:
- max = 1173
- }
- return rand.Int63n(max)
-}
-
-```
-3. Run the new file from within the tools repository:
-```bash
-go run internal/main.go
-```
-4. After about 5 seconds, OpenCensus should start receiving your new metrics, which you can see at http://localhost:8844/metrics. This page will look similar to the following:
-```
-# HELP promdemo_latencyDistribution the various latencies
-# TYPE promdemo_latencyDistribution histogram
-promdemo_latencyDistribution_bucket{vendor="otc",le="0"} 0
-promdemo_latencyDistribution_bucket{vendor="otc",le="10"} 2
-promdemo_latencyDistribution_bucket{vendor="otc",le="50"} 9
-promdemo_latencyDistribution_bucket{vendor="otc",le="100"} 22
-promdemo_latencyDistribution_bucket{vendor="otc",le="200"} 35
-promdemo_latencyDistribution_bucket{vendor="otc",le="400"} 49
-promdemo_latencyDistribution_bucket{vendor="otc",le="800"} 63
-promdemo_latencyDistribution_bucket{vendor="otc",le="1000"} 78
-promdemo_latencyDistribution_bucket{vendor="otc",le="1400"} 93
-promdemo_latencyDistribution_bucket{vendor="otc",le="2000"} 108
-promdemo_latencyDistribution_bucket{vendor="otc",le="5000"} 123
-promdemo_latencyDistribution_bucket{vendor="otc",le="10000"} 138
-promdemo_latencyDistribution_bucket{vendor="otc",le="15000"} 153
-promdemo_latencyDistribution_bucket{vendor="otc",le="+Inf"} 15
-promdemo_latencyDistribution_sum{vendor="otc"} 1641
-promdemo_latencyDistribution_count{vendor="otc"} 15
-```
-5. After a few more seconds, Prometheus should start displaying your new metrics. You can view the distribution at http://localhost:9445/graph?g0.range_input=5m&g0.stacked=1&g0.expr=rate(oragent_latencyDistribution_bucket%5B5m%5D)&g0.tab=0.
-
-6. Zipkin should also start displaying traces. You can view them at http://localhost:9444/zipkin/?limit=10&lookback=300000&serviceName=go-tools-test.
\ No newline at end of file
diff --git a/internal/event/export/ocagent/metrics.go b/internal/event/export/ocagent/metrics.go
deleted file mode 100644
index 78d65994db8..00000000000
--- a/internal/event/export/ocagent/metrics.go
+++ /dev/null
@@ -1,213 +0,0 @@
-// 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 ocagent
-
-import (
- "time"
-
- "golang.org/x/tools/internal/event/export/metric"
- "golang.org/x/tools/internal/event/export/ocagent/wire"
- "golang.org/x/tools/internal/event/label"
-)
-
-// dataToMetricDescriptor return a *wire.MetricDescriptor based on data.
-func dataToMetricDescriptor(data metric.Data) *wire.MetricDescriptor {
- if data == nil {
- return nil
- }
- descriptor := &wire.MetricDescriptor{
- Name: data.Handle(),
- Description: getDescription(data),
- // TODO: Unit?
- Type: dataToMetricDescriptorType(data),
- LabelKeys: getLabelKeys(data),
- }
-
- return descriptor
-}
-
-// getDescription returns the description of data.
-func getDescription(data metric.Data) string {
- switch d := data.(type) {
- case *metric.Int64Data:
- return d.Info.Description
-
- case *metric.Float64Data:
- return d.Info.Description
-
- case *metric.HistogramInt64Data:
- return d.Info.Description
-
- case *metric.HistogramFloat64Data:
- return d.Info.Description
- }
-
- return ""
-}
-
-// getLabelKeys returns a slice of *wire.LabelKeys based on the keys
-// in data.
-func getLabelKeys(data metric.Data) []*wire.LabelKey {
- switch d := data.(type) {
- case *metric.Int64Data:
- return infoKeysToLabelKeys(d.Info.Keys)
-
- case *metric.Float64Data:
- return infoKeysToLabelKeys(d.Info.Keys)
-
- case *metric.HistogramInt64Data:
- return infoKeysToLabelKeys(d.Info.Keys)
-
- case *metric.HistogramFloat64Data:
- return infoKeysToLabelKeys(d.Info.Keys)
- }
-
- return nil
-}
-
-// dataToMetricDescriptorType returns a wire.MetricDescriptor_Type based on the
-// underlying type of data.
-func dataToMetricDescriptorType(data metric.Data) wire.MetricDescriptor_Type {
- switch d := data.(type) {
- case *metric.Int64Data:
- if d.IsGauge {
- return wire.MetricDescriptor_GAUGE_INT64
- }
- return wire.MetricDescriptor_CUMULATIVE_INT64
-
- case *metric.Float64Data:
- if d.IsGauge {
- return wire.MetricDescriptor_GAUGE_DOUBLE
- }
- return wire.MetricDescriptor_CUMULATIVE_DOUBLE
-
- case *metric.HistogramInt64Data:
- return wire.MetricDescriptor_CUMULATIVE_DISTRIBUTION
-
- case *metric.HistogramFloat64Data:
- return wire.MetricDescriptor_CUMULATIVE_DISTRIBUTION
- }
-
- return wire.MetricDescriptor_UNSPECIFIED
-}
-
-// dataToTimeseries returns a slice of *wire.TimeSeries based on the
-// points in data.
-func dataToTimeseries(data metric.Data, start time.Time) []*wire.TimeSeries {
- if data == nil {
- return nil
- }
-
- numRows := numRows(data)
- startTimestamp := convertTimestamp(start)
- timeseries := make([]*wire.TimeSeries, 0, numRows)
-
- for i := 0; i < numRows; i++ {
- timeseries = append(timeseries, &wire.TimeSeries{
- StartTimestamp: &startTimestamp,
- // TODO: labels?
- Points: dataToPoints(data, i),
- })
- }
-
- return timeseries
-}
-
-// numRows returns the number of rows in data.
-func numRows(data metric.Data) int {
- switch d := data.(type) {
- case *metric.Int64Data:
- return len(d.Rows)
- case *metric.Float64Data:
- return len(d.Rows)
- case *metric.HistogramInt64Data:
- return len(d.Rows)
- case *metric.HistogramFloat64Data:
- return len(d.Rows)
- }
-
- return 0
-}
-
-// dataToPoints returns an array of *wire.Points based on the point(s)
-// in data at index i.
-func dataToPoints(data metric.Data, i int) []*wire.Point {
- switch d := data.(type) {
- case *metric.Int64Data:
- timestamp := convertTimestamp(d.EndTime)
- return []*wire.Point{
- {
- Value: wire.PointInt64Value{
- Int64Value: d.Rows[i],
- },
- Timestamp: ×tamp,
- },
- }
- case *metric.Float64Data:
- timestamp := convertTimestamp(d.EndTime)
- return []*wire.Point{
- {
- Value: wire.PointDoubleValue{
- DoubleValue: d.Rows[i],
- },
- Timestamp: ×tamp,
- },
- }
- case *metric.HistogramInt64Data:
- row := d.Rows[i]
- bucketBounds := make([]float64, len(d.Info.Buckets))
- for i, val := range d.Info.Buckets {
- bucketBounds[i] = float64(val)
- }
- return distributionToPoints(row.Values, row.Count, float64(row.Sum), bucketBounds, d.EndTime)
- case *metric.HistogramFloat64Data:
- row := d.Rows[i]
- return distributionToPoints(row.Values, row.Count, row.Sum, d.Info.Buckets, d.EndTime)
- }
-
- return nil
-}
-
-// distributionToPoints returns an array of *wire.Points containing a
-// wire.PointDistributionValue representing a distribution with the
-// supplied counts, count, and sum.
-func distributionToPoints(counts []int64, count int64, sum float64, bucketBounds []float64, end time.Time) []*wire.Point {
- buckets := make([]*wire.Bucket, len(counts))
- for i := 0; i < len(counts); i++ {
- buckets[i] = &wire.Bucket{
- Count: counts[i],
- }
- }
- timestamp := convertTimestamp(end)
- return []*wire.Point{
- {
- Value: wire.PointDistributionValue{
- DistributionValue: &wire.DistributionValue{
- Count: count,
- Sum: sum,
- // TODO: SumOfSquaredDeviation?
- Buckets: buckets,
- BucketOptions: &wire.BucketOptionsExplicit{
- Bounds: bucketBounds,
- },
- },
- },
- Timestamp: ×tamp,
- },
- }
-}
-
-// infoKeysToLabelKeys returns an array of *wire.LabelKeys containing the
-// string values of the elements of labelKeys.
-func infoKeysToLabelKeys(infoKeys []label.Key) []*wire.LabelKey {
- labelKeys := make([]*wire.LabelKey, 0, len(infoKeys))
- for _, key := range infoKeys {
- labelKeys = append(labelKeys, &wire.LabelKey{
- Key: key.Name(),
- })
- }
-
- return labelKeys
-}
diff --git a/internal/event/export/ocagent/metrics_test.go b/internal/event/export/ocagent/metrics_test.go
deleted file mode 100644
index 001e7f02dbf..00000000000
--- a/internal/event/export/ocagent/metrics_test.go
+++ /dev/null
@@ -1,144 +0,0 @@
-// Copyright 2020 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 ocagent_test
-
-import (
- "context"
- "errors"
- "testing"
-
- "golang.org/x/tools/internal/event"
- "golang.org/x/tools/internal/event/keys"
-)
-
-func TestEncodeMetric(t *testing.T) {
- exporter := registerExporter()
- const prefix = testNodeStr + `
- "metrics":[`
- const suffix = `]}`
- tests := []struct {
- name string
- run func(ctx context.Context)
- want string
- }{
- {
- name: "HistogramFloat64, HistogramInt64",
- run: func(ctx context.Context) {
- ctx = event.Label(ctx, keyMethod.Of("godoc.ServeHTTP"))
- event.Metric(ctx, latencyMs.Of(96.58))
- ctx = event.Label(ctx, keys.Err.Of(errors.New("panic: fatal signal")))
- event.Metric(ctx, bytesIn.Of(97e2))
- },
- want: prefix + `
- {
- "metric_descriptor": {
- "name": "latency_ms",
- "description": "The latency of calls in milliseconds",
- "type": 6,
- "label_keys": [
- {
- "key": "method"
- },
- {
- "key": "route"
- }
- ]
- },
- "timeseries": [
- {
- "start_timestamp": "1970-01-01T00:00:00Z",
- "points": [
- {
- "timestamp": "1970-01-01T00:00:40Z",
- "distributionValue": {
- "count": 1,
- "sum": 96.58,
- "bucket_options": {
- "explicit": {
- "bounds": [
- 0,
- 5,
- 10,
- 25,
- 50
- ]
- }
- },
- "buckets": [
- {},
- {},
- {},
- {},
- {}
- ]
- }
- }
- ]
- }
- ]
- },
- {
- "metric_descriptor": {
- "name": "latency_ms",
- "description": "The latency of calls in milliseconds",
- "type": 6,
- "label_keys": [
- {
- "key": "method"
- },
- {
- "key": "route"
- }
- ]
- },
- "timeseries": [
- {
- "start_timestamp": "1970-01-01T00:00:00Z",
- "points": [
- {
- "timestamp": "1970-01-01T00:00:40Z",
- "distributionValue": {
- "count": 1,
- "sum": 9700,
- "bucket_options": {
- "explicit": {
- "bounds": [
- 0,
- 10,
- 50,
- 100,
- 500,
- 1000,
- 2000
- ]
- }
- },
- "buckets": [
- {},
- {},
- {},
- {},
- {},
- {},
- {}
- ]
- }
- }
- ]
- }
- ]
- }` + suffix,
- },
- }
-
- ctx := context.TODO()
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- tt.run(ctx)
- got := exporter.Output("/v1/metrics")
- checkJSON(t, got, []byte(tt.want))
- })
- }
-}
diff --git a/internal/event/export/ocagent/ocagent.go b/internal/event/export/ocagent/ocagent.go
deleted file mode 100644
index 722a7446939..00000000000
--- a/internal/event/export/ocagent/ocagent.go
+++ /dev/null
@@ -1,358 +0,0 @@
-// 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 ocagent adds the ability to export all telemetry to an ocagent.
-// This keeps the compile time dependencies to zero and allows the agent to
-// have the exporters needed for telemetry aggregation and viewing systems.
-package ocagent
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "fmt"
- "net/http"
- "os"
- "path/filepath"
- "sync"
- "time"
-
- "golang.org/x/tools/internal/event"
- "golang.org/x/tools/internal/event/core"
- "golang.org/x/tools/internal/event/export"
- "golang.org/x/tools/internal/event/export/metric"
- "golang.org/x/tools/internal/event/export/ocagent/wire"
- "golang.org/x/tools/internal/event/keys"
- "golang.org/x/tools/internal/event/label"
-)
-
-type Config struct {
- Start time.Time
- Host string
- Process uint32
- Client *http.Client
- Service string
- Address string
- Rate time.Duration
-}
-
-var (
- connectMu sync.Mutex
- exporters = make(map[Config]*Exporter)
-)
-
-// Discover finds the local agent to export to, it will return nil if there
-// is not one running.
-// TODO: Actually implement a discovery protocol rather than a hard coded address
-func Discover() *Config {
- return &Config{
- Address: "http://localhost:55678",
- }
-}
-
-type Exporter struct {
- mu sync.Mutex
- config Config
- spans []*export.Span
- metrics []metric.Data
-}
-
-// Connect creates a process specific exporter with the specified
-// serviceName and the address of the ocagent to which it will upload
-// its telemetry.
-func Connect(config *Config) *Exporter {
- if config == nil || config.Address == "off" {
- return nil
- }
- resolved := *config
- if resolved.Host == "" {
- hostname, _ := os.Hostname()
- resolved.Host = hostname
- }
- if resolved.Process == 0 {
- resolved.Process = uint32(os.Getpid())
- }
- if resolved.Client == nil {
- resolved.Client = http.DefaultClient
- }
- if resolved.Service == "" {
- resolved.Service = filepath.Base(os.Args[0])
- }
- if resolved.Rate == 0 {
- resolved.Rate = 2 * time.Second
- }
-
- connectMu.Lock()
- defer connectMu.Unlock()
- if exporter, found := exporters[resolved]; found {
- return exporter
- }
- exporter := &Exporter{config: resolved}
- exporters[resolved] = exporter
- if exporter.config.Start.IsZero() {
- exporter.config.Start = time.Now()
- }
- go func() {
- for range time.Tick(exporter.config.Rate) {
- exporter.Flush()
- }
- }()
- return exporter
-}
-
-func (e *Exporter) ProcessEvent(ctx context.Context, ev core.Event, lm label.Map) context.Context {
- switch {
- case event.IsEnd(ev):
- e.mu.Lock()
- defer e.mu.Unlock()
- span := export.GetSpan(ctx)
- if span != nil {
- e.spans = append(e.spans, span)
- }
- case event.IsMetric(ev):
- e.mu.Lock()
- defer e.mu.Unlock()
- data := metric.Entries.Get(lm).([]metric.Data)
- e.metrics = append(e.metrics, data...)
- }
- return ctx
-}
-
-func (e *Exporter) Flush() {
- e.mu.Lock()
- defer e.mu.Unlock()
- spans := make([]*wire.Span, len(e.spans))
- for i, s := range e.spans {
- spans[i] = convertSpan(s)
- }
- e.spans = nil
- metrics := make([]*wire.Metric, len(e.metrics))
- for i, m := range e.metrics {
- metrics[i] = convertMetric(m, e.config.Start)
- }
- e.metrics = nil
-
- if len(spans) > 0 {
- e.send("/v1/trace", &wire.ExportTraceServiceRequest{
- Node: e.config.buildNode(),
- Spans: spans,
- //TODO: Resource?
- })
- }
- if len(metrics) > 0 {
- e.send("/v1/metrics", &wire.ExportMetricsServiceRequest{
- Node: e.config.buildNode(),
- Metrics: metrics,
- //TODO: Resource?
- })
- }
-}
-
-func (cfg *Config) buildNode() *wire.Node {
- return &wire.Node{
- Identifier: &wire.ProcessIdentifier{
- HostName: cfg.Host,
- Pid: cfg.Process,
- StartTimestamp: convertTimestamp(cfg.Start),
- },
- LibraryInfo: &wire.LibraryInfo{
- Language: wire.LanguageGo,
- ExporterVersion: "0.0.1",
- CoreLibraryVersion: "x/tools",
- },
- ServiceInfo: &wire.ServiceInfo{
- Name: cfg.Service,
- },
- }
-}
-
-func (e *Exporter) send(endpoint string, message interface{}) {
- blob, err := json.Marshal(message)
- if err != nil {
- errorInExport("ocagent failed to marshal message for %v: %v", endpoint, err)
- return
- }
- uri := e.config.Address + endpoint
- req, err := http.NewRequest("POST", uri, bytes.NewReader(blob))
- if err != nil {
- errorInExport("ocagent failed to build request for %v: %v", uri, err)
- return
- }
- req.Header.Set("Content-Type", "application/json")
- res, err := e.config.Client.Do(req)
- if err != nil {
- errorInExport("ocagent failed to send message: %v \n", err)
- return
- }
- if res.Body != nil {
- res.Body.Close()
- }
-}
-
-func errorInExport(message string, args ...interface{}) {
- // This function is useful when debugging the exporter, but in general we
- // want to just drop any export
-}
-
-func convertTimestamp(t time.Time) wire.Timestamp {
- return t.Format(time.RFC3339Nano)
-}
-
-func toTruncatableString(s string) *wire.TruncatableString {
- if s == "" {
- return nil
- }
- return &wire.TruncatableString{Value: s}
-}
-
-func convertSpan(span *export.Span) *wire.Span {
- result := &wire.Span{
- TraceID: span.ID.TraceID[:],
- SpanID: span.ID.SpanID[:],
- TraceState: nil, //TODO?
- ParentSpanID: span.ParentID[:],
- Name: toTruncatableString(span.Name),
- Kind: wire.UnspecifiedSpanKind,
- StartTime: convertTimestamp(span.Start().At()),
- EndTime: convertTimestamp(span.Finish().At()),
- Attributes: convertAttributes(span.Start(), 1),
- TimeEvents: convertEvents(span.Events()),
- SameProcessAsParentSpan: true,
- //TODO: StackTrace?
- //TODO: Links?
- //TODO: Status?
- //TODO: Resource?
- }
- return result
-}
-
-func convertMetric(data metric.Data, start time.Time) *wire.Metric {
- descriptor := dataToMetricDescriptor(data)
- timeseries := dataToTimeseries(data, start)
-
- if descriptor == nil && timeseries == nil {
- return nil
- }
-
- // TODO: handle Histogram metrics
- return &wire.Metric{
- MetricDescriptor: descriptor,
- Timeseries: timeseries,
- // TODO: attach Resource?
- }
-}
-
-func skipToValidLabel(list label.List, index int) (int, label.Label) {
- // skip to the first valid label
- for ; list.Valid(index); index++ {
- l := list.Label(index)
- if !l.Valid() || l.Key() == keys.Label {
- continue
- }
- return index, l
- }
- return -1, label.Label{}
-}
-
-func convertAttributes(list label.List, index int) *wire.Attributes {
- index, l := skipToValidLabel(list, index)
- if !l.Valid() {
- return nil
- }
- attributes := make(map[string]wire.Attribute)
- for {
- if l.Valid() {
- attributes[l.Key().Name()] = convertAttribute(l)
- }
- index++
- if !list.Valid(index) {
- return &wire.Attributes{AttributeMap: attributes}
- }
- l = list.Label(index)
- }
-}
-
-func convertAttribute(l label.Label) wire.Attribute {
- switch key := l.Key().(type) {
- case *keys.Int:
- return wire.IntAttribute{IntValue: int64(key.From(l))}
- case *keys.Int8:
- return wire.IntAttribute{IntValue: int64(key.From(l))}
- case *keys.Int16:
- return wire.IntAttribute{IntValue: int64(key.From(l))}
- case *keys.Int32:
- return wire.IntAttribute{IntValue: int64(key.From(l))}
- case *keys.Int64:
- return wire.IntAttribute{IntValue: int64(key.From(l))}
- case *keys.UInt:
- return wire.IntAttribute{IntValue: int64(key.From(l))}
- case *keys.UInt8:
- return wire.IntAttribute{IntValue: int64(key.From(l))}
- case *keys.UInt16:
- return wire.IntAttribute{IntValue: int64(key.From(l))}
- case *keys.UInt32:
- return wire.IntAttribute{IntValue: int64(key.From(l))}
- case *keys.UInt64:
- return wire.IntAttribute{IntValue: int64(key.From(l))}
- case *keys.Float32:
- return wire.DoubleAttribute{DoubleValue: float64(key.From(l))}
- case *keys.Float64:
- return wire.DoubleAttribute{DoubleValue: key.From(l)}
- case *keys.Boolean:
- return wire.BoolAttribute{BoolValue: key.From(l)}
- case *keys.String:
- return wire.StringAttribute{StringValue: toTruncatableString(key.From(l))}
- case *keys.Error:
- return wire.StringAttribute{StringValue: toTruncatableString(key.From(l).Error())}
- case *keys.Value:
- return wire.StringAttribute{StringValue: toTruncatableString(fmt.Sprint(key.From(l)))}
- default:
- return wire.StringAttribute{StringValue: toTruncatableString(fmt.Sprintf("%T", key))}
- }
-}
-
-func convertEvents(events []core.Event) *wire.TimeEvents {
- //TODO: MessageEvents?
- result := make([]wire.TimeEvent, len(events))
- for i, event := range events {
- result[i] = convertEvent(event)
- }
- return &wire.TimeEvents{TimeEvent: result}
-}
-
-func convertEvent(ev core.Event) wire.TimeEvent {
- return wire.TimeEvent{
- Time: convertTimestamp(ev.At()),
- Annotation: convertAnnotation(ev),
- }
-}
-
-func getAnnotationDescription(ev core.Event) (string, int) {
- l := ev.Label(0)
- if l.Key() != keys.Msg {
- return "", 0
- }
- if msg := keys.Msg.From(l); msg != "" {
- return msg, 1
- }
- l = ev.Label(1)
- if l.Key() != keys.Err {
- return "", 1
- }
- if err := keys.Err.From(l); err != nil {
- return err.Error(), 2
- }
- return "", 2
-}
-
-func convertAnnotation(ev core.Event) *wire.Annotation {
- description, index := getAnnotationDescription(ev)
- if _, l := skipToValidLabel(ev, index); !l.Valid() && description == "" {
- return nil
- }
- return &wire.Annotation{
- Description: toTruncatableString(description),
- Attributes: convertAttributes(ev, index),
- }
-}
diff --git a/internal/event/export/ocagent/ocagent_test.go b/internal/event/export/ocagent/ocagent_test.go
deleted file mode 100644
index 38a52faede5..00000000000
--- a/internal/event/export/ocagent/ocagent_test.go
+++ /dev/null
@@ -1,210 +0,0 @@
-// 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 ocagent_test
-
-import (
- "bytes"
- "context"
- "encoding/json"
- "fmt"
- "io"
- "net/http"
- "sync"
- "testing"
- "time"
-
- "golang.org/x/tools/internal/event"
- "golang.org/x/tools/internal/event/core"
- "golang.org/x/tools/internal/event/export"
- "golang.org/x/tools/internal/event/export/metric"
- "golang.org/x/tools/internal/event/export/ocagent"
- "golang.org/x/tools/internal/event/keys"
- "golang.org/x/tools/internal/event/label"
-)
-
-const testNodeStr = `{
- "node":{
- "identifier":{
- "host_name":"tester",
- "pid":1,
- "start_timestamp":"1970-01-01T00:00:00Z"
- },
- "library_info":{
- "language":4,
- "exporter_version":"0.0.1",
- "core_library_version":"x/tools"
- },
- "service_info":{
- "name":"ocagent-tests"
- }
- },`
-
-var (
- keyDB = keys.NewString("db", "the database name")
- keyMethod = keys.NewString("method", "a metric grouping key")
- keyRoute = keys.NewString("route", "another metric grouping key")
-
- key1DB = keys.NewString("1_db", "A test string key")
-
- key2aAge = keys.NewFloat64("2a_age", "A test float64 key")
- key2bTTL = keys.NewFloat32("2b_ttl", "A test float32 key")
- key2cExpiryMS = keys.NewFloat64("2c_expiry_ms", "A test float64 key")
-
- key3aRetry = keys.NewBoolean("3a_retry", "A test boolean key")
- key3bStale = keys.NewBoolean("3b_stale", "Another test boolean key")
-
- key4aMax = keys.NewInt("4a_max", "A test int key")
- key4bOpcode = keys.NewInt8("4b_opcode", "A test int8 key")
- key4cBase = keys.NewInt16("4c_base", "A test int16 key")
- key4eChecksum = keys.NewInt32("4e_checksum", "A test int32 key")
- key4fMode = keys.NewInt64("4f_mode", "A test int64 key")
-
- key5aMin = keys.NewUInt("5a_min", "A test uint key")
- key5bMix = keys.NewUInt8("5b_mix", "A test uint8 key")
- key5cPort = keys.NewUInt16("5c_port", "A test uint16 key")
- key5dMinHops = keys.NewUInt32("5d_min_hops", "A test uint32 key")
- key5eMaxHops = keys.NewUInt64("5e_max_hops", "A test uint64 key")
-
- recursiveCalls = keys.NewInt64("recursive_calls", "Number of recursive calls")
- bytesIn = keys.NewInt64("bytes_in", "Number of bytes in") //, unit.Bytes)
- latencyMs = keys.NewFloat64("latency", "The latency in milliseconds") //, unit.Milliseconds)
-
- metricLatency = metric.HistogramFloat64{
- Name: "latency_ms",
- Description: "The latency of calls in milliseconds",
- Keys: []label.Key{keyMethod, keyRoute},
- Buckets: []float64{0, 5, 10, 25, 50},
- }
-
- metricBytesIn = metric.HistogramInt64{
- Name: "latency_ms",
- Description: "The latency of calls in milliseconds",
- Keys: []label.Key{keyMethod, keyRoute},
- Buckets: []int64{0, 10, 50, 100, 500, 1000, 2000},
- }
-
- metricRecursiveCalls = metric.Scalar{
- Name: "latency_ms",
- Description: "The latency of calls in milliseconds",
- Keys: []label.Key{keyMethod, keyRoute},
- }
-)
-
-type testExporter struct {
- ocagent *ocagent.Exporter
- sent fakeSender
-}
-
-func registerExporter() *testExporter {
- exporter := &testExporter{}
- cfg := ocagent.Config{
- Host: "tester",
- Process: 1,
- Service: "ocagent-tests",
- Client: &http.Client{Transport: &exporter.sent},
- }
- cfg.Start, _ = time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00Z")
- exporter.ocagent = ocagent.Connect(&cfg)
-
- metrics := metric.Config{}
- metricLatency.Record(&metrics, latencyMs)
- metricBytesIn.Record(&metrics, bytesIn)
- metricRecursiveCalls.SumInt64(&metrics, recursiveCalls)
-
- e := exporter.ocagent.ProcessEvent
- e = metrics.Exporter(e)
- e = spanFixer(e)
- e = export.Spans(e)
- e = export.Labels(e)
- e = timeFixer(e)
- event.SetExporter(e)
- return exporter
-}
-
-func timeFixer(output event.Exporter) event.Exporter {
- start, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:30Z")
- at, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:40Z")
- end, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:50Z")
- return func(ctx context.Context, ev core.Event, lm label.Map) context.Context {
- switch {
- case event.IsStart(ev):
- ev = core.CloneEvent(ev, start)
- case event.IsEnd(ev):
- ev = core.CloneEvent(ev, end)
- default:
- ev = core.CloneEvent(ev, at)
- }
- return output(ctx, ev, lm)
- }
-}
-
-func spanFixer(output event.Exporter) event.Exporter {
- return func(ctx context.Context, ev core.Event, lm label.Map) context.Context {
- if event.IsStart(ev) {
- span := export.GetSpan(ctx)
- span.ID = export.SpanContext{}
- }
- return output(ctx, ev, lm)
- }
-}
-
-func (e *testExporter) Output(route string) []byte {
- e.ocagent.Flush()
- return e.sent.get(route)
-}
-
-func checkJSON(t *testing.T, got, want []byte) {
- // compare the compact form, to allow for formatting differences
- g := &bytes.Buffer{}
- if err := json.Compact(g, got); err != nil {
- t.Fatal(err)
- }
- w := &bytes.Buffer{}
- if err := json.Compact(w, want); err != nil {
- t.Fatal(err)
- }
- if g.String() != w.String() {
- t.Fatalf("Got:\n%s\nWant:\n%s", g, w)
- }
-}
-
-type fakeSender struct {
- mu sync.Mutex
- data map[string][]byte
-}
-
-func (s *fakeSender) get(route string) []byte {
- s.mu.Lock()
- defer s.mu.Unlock()
- data, found := s.data[route]
- if found {
- delete(s.data, route)
- }
- return data
-}
-
-func (s *fakeSender) RoundTrip(req *http.Request) (*http.Response, error) {
- s.mu.Lock()
- defer s.mu.Unlock()
- if s.data == nil {
- s.data = make(map[string][]byte)
- }
- data, err := io.ReadAll(req.Body)
- if err != nil {
- return nil, err
- }
- path := req.URL.EscapedPath()
- if _, found := s.data[path]; found {
- return nil, fmt.Errorf("duplicate delivery to %v", path)
- }
- s.data[path] = data
- return &http.Response{
- Status: "200 OK",
- StatusCode: 200,
- Proto: "HTTP/1.0",
- ProtoMajor: 1,
- ProtoMinor: 0,
- }, nil
-}
diff --git a/internal/event/export/ocagent/trace_test.go b/internal/event/export/ocagent/trace_test.go
deleted file mode 100644
index 99def34d149..00000000000
--- a/internal/event/export/ocagent/trace_test.go
+++ /dev/null
@@ -1,158 +0,0 @@
-// 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 ocagent_test
-
-import (
- "context"
- "errors"
- "testing"
-
- "golang.org/x/tools/internal/event"
-)
-
-func TestTrace(t *testing.T) {
- exporter := registerExporter()
- const prefix = testNodeStr + `
- "spans":[{
- "trace_id":"AAAAAAAAAAAAAAAAAAAAAA==",
- "span_id":"AAAAAAAAAAA=",
- "parent_span_id":"AAAAAAAAAAA=",
- "name":{"value":"event span"},
- "start_time":"1970-01-01T00:00:30Z",
- "end_time":"1970-01-01T00:00:50Z",
- "time_events":{
-`
- const suffix = `
- },
- "same_process_as_parent_span":true
- }]
-}`
-
- tests := []struct {
- name string
- run func(ctx context.Context)
- want string
- }{
- {
- name: "no labels",
- run: func(ctx context.Context) {
- event.Label(ctx)
- },
- want: prefix + `
- "timeEvent":[{"time":"1970-01-01T00:00:40Z"}]
- ` + suffix,
- },
- {
- name: "description no error",
- run: func(ctx context.Context) {
- event.Log(ctx, "cache miss", keyDB.Of("godb"))
- },
- want: prefix + `"timeEvent":[{"time":"1970-01-01T00:00:40Z","annotation":{
-"description": { "value": "cache miss" },
-"attributes": {
- "attributeMap": {
- "db": { "stringValue": { "value": "godb" } }
- }
-}
-}}]` + suffix,
- },
-
- {
- name: "description and error",
- run: func(ctx context.Context) {
- event.Error(ctx, "cache miss",
- errors.New("no network connectivity"),
- keyDB.Of("godb"),
- )
- },
- want: prefix + `"timeEvent":[{"time":"1970-01-01T00:00:40Z","annotation":{
-"description": { "value": "cache miss" },
-"attributes": {
- "attributeMap": {
- "db": { "stringValue": { "value": "godb" } },
- "error": { "stringValue": { "value": "no network connectivity" } }
- }
-}
-}}]` + suffix,
- },
- {
- name: "no description, but error",
- run: func(ctx context.Context) {
- event.Error(ctx, "",
- errors.New("no network connectivity"),
- keyDB.Of("godb"),
- )
- },
- want: prefix + `"timeEvent":[{"time":"1970-01-01T00:00:40Z","annotation":{
-"description": { "value": "no network connectivity" },
-"attributes": {
- "attributeMap": {
- "db": { "stringValue": { "value": "godb" } }
- }
-}
-}}]` + suffix,
- },
- {
- name: "enumerate all attribute types",
- run: func(ctx context.Context) {
- event.Log(ctx, "cache miss",
- key1DB.Of("godb"),
-
- key2aAge.Of(0.456), // Constant converted into "float64"
- key2bTTL.Of(float32(5000)),
- key2cExpiryMS.Of(float64(1e3)),
-
- key3aRetry.Of(false),
- key3bStale.Of(true),
-
- key4aMax.Of(0x7fff), // Constant converted into "int"
- key4bOpcode.Of(int8(0x7e)),
- key4cBase.Of(int16(1<<9)),
- key4eChecksum.Of(int32(0x11f7e294)),
- key4fMode.Of(int64(0644)),
-
- key5aMin.Of(uint(1)),
- key5bMix.Of(uint8(44)),
- key5cPort.Of(uint16(55678)),
- key5dMinHops.Of(uint32(1<<9)),
- key5eMaxHops.Of(uint64(0xffffff)),
- )
- },
- want: prefix + `"timeEvent":[{"time":"1970-01-01T00:00:40Z","annotation":{
-"description": { "value": "cache miss" },
-"attributes": {
- "attributeMap": {
- "1_db": { "stringValue": { "value": "godb" } },
- "2a_age": { "doubleValue": 0.456 },
- "2b_ttl": { "doubleValue": 5000 },
- "2c_expiry_ms": { "doubleValue": 1000 },
- "3a_retry": {},
- "3b_stale": { "boolValue": true },
- "4a_max": { "intValue": 32767 },
- "4b_opcode": { "intValue": 126 },
- "4c_base": { "intValue": 512 },
- "4e_checksum": { "intValue": 301458068 },
- "4f_mode": { "intValue": 420 },
- "5a_min": { "intValue": 1 },
- "5b_mix": { "intValue": 44 },
- "5c_port": { "intValue": 55678 },
- "5d_min_hops": { "intValue": 512 },
- "5e_max_hops": { "intValue": 16777215 }
- }
-}
-}}]` + suffix,
- },
- }
- ctx := context.TODO()
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- ctx, done := event.Start(ctx, "event span")
- tt.run(ctx)
- done()
- got := exporter.Output("/v1/trace")
- checkJSON(t, got, []byte(tt.want))
- })
- }
-}
diff --git a/internal/event/export/ocagent/wire/common.go b/internal/event/export/ocagent/wire/common.go
deleted file mode 100644
index f22b535654c..00000000000
--- a/internal/event/export/ocagent/wire/common.go
+++ /dev/null
@@ -1,101 +0,0 @@
-// 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 wire
-
-// This file holds common ocagent types
-
-type Node struct {
- Identifier *ProcessIdentifier `json:"identifier,omitempty"`
- LibraryInfo *LibraryInfo `json:"library_info,omitempty"`
- ServiceInfo *ServiceInfo `json:"service_info,omitempty"`
- Attributes map[string]string `json:"attributes,omitempty"`
-}
-
-type Resource struct {
- Type string `json:"type,omitempty"`
- Labels map[string]string `json:"labels,omitempty"`
-}
-
-type TruncatableString struct {
- Value string `json:"value,omitempty"`
- TruncatedByteCount int32 `json:"truncated_byte_count,omitempty"`
-}
-
-type Attributes struct {
- AttributeMap map[string]Attribute `json:"attributeMap,omitempty"`
- DroppedAttributesCount int32 `json:"dropped_attributes_count,omitempty"`
-}
-
-type StringAttribute struct {
- StringValue *TruncatableString `json:"stringValue,omitempty"`
-}
-
-type IntAttribute struct {
- IntValue int64 `json:"intValue,omitempty"`
-}
-
-type BoolAttribute struct {
- BoolValue bool `json:"boolValue,omitempty"`
-}
-
-type DoubleAttribute struct {
- DoubleValue float64 `json:"doubleValue,omitempty"`
-}
-
-type Attribute interface {
- labelAttribute()
-}
-
-func (StringAttribute) labelAttribute() {}
-func (IntAttribute) labelAttribute() {}
-func (BoolAttribute) labelAttribute() {}
-func (DoubleAttribute) labelAttribute() {}
-
-type StackTrace struct {
- StackFrames *StackFrames `json:"stack_frames,omitempty"`
- StackTraceHashID uint64 `json:"stack_trace_hash_id,omitempty"`
-}
-
-type StackFrames struct {
- Frame []*StackFrame `json:"frame,omitempty"`
- DroppedFramesCount int32 `json:"dropped_frames_count,omitempty"`
-}
-
-type StackFrame struct {
- FunctionName *TruncatableString `json:"function_name,omitempty"`
- OriginalFunctionName *TruncatableString `json:"original_function_name,omitempty"`
- FileName *TruncatableString `json:"file_name,omitempty"`
- LineNumber int64 `json:"line_number,omitempty"`
- ColumnNumber int64 `json:"column_number,omitempty"`
- LoadModule *Module `json:"load_module,omitempty"`
- SourceVersion *TruncatableString `json:"source_version,omitempty"`
-}
-
-type Module struct {
- Module *TruncatableString `json:"module,omitempty"`
- BuildID *TruncatableString `json:"build_id,omitempty"`
-}
-
-type ProcessIdentifier struct {
- HostName string `json:"host_name,omitempty"`
- Pid uint32 `json:"pid,omitempty"`
- StartTimestamp Timestamp `json:"start_timestamp,omitempty"`
-}
-
-type LibraryInfo struct {
- Language Language `json:"language,omitempty"`
- ExporterVersion string `json:"exporter_version,omitempty"`
- CoreLibraryVersion string `json:"core_library_version,omitempty"`
-}
-
-type Language int32
-
-const (
- LanguageGo Language = 4
-)
-
-type ServiceInfo struct {
- Name string `json:"name,omitempty"`
-}
diff --git a/internal/event/export/ocagent/wire/core.go b/internal/event/export/ocagent/wire/core.go
deleted file mode 100644
index 95c05d66906..00000000000
--- a/internal/event/export/ocagent/wire/core.go
+++ /dev/null
@@ -1,17 +0,0 @@
-// 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 wire
-
-// This file contains type that match core proto types
-
-type Timestamp = string
-
-type Int64Value struct {
- Value int64 `json:"value,omitempty"`
-}
-
-type DoubleValue struct {
- Value float64 `json:"value,omitempty"`
-}
diff --git a/internal/event/export/ocagent/wire/metrics.go b/internal/event/export/ocagent/wire/metrics.go
deleted file mode 100644
index 6cb58943c00..00000000000
--- a/internal/event/export/ocagent/wire/metrics.go
+++ /dev/null
@@ -1,204 +0,0 @@
-// 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 wire
-
-import (
- "encoding/json"
- "fmt"
-)
-
-type ExportMetricsServiceRequest struct {
- Node *Node `json:"node,omitempty"`
- Metrics []*Metric `json:"metrics,omitempty"`
- Resource *Resource `json:"resource,omitempty"`
-}
-
-type Metric struct {
- MetricDescriptor *MetricDescriptor `json:"metric_descriptor,omitempty"`
- Timeseries []*TimeSeries `json:"timeseries,omitempty"`
- Resource *Resource `json:"resource,omitempty"`
-}
-
-type MetricDescriptor struct {
- Name string `json:"name,omitempty"`
- Description string `json:"description,omitempty"`
- Unit string `json:"unit,omitempty"`
- Type MetricDescriptor_Type `json:"type,omitempty"`
- LabelKeys []*LabelKey `json:"label_keys,omitempty"`
-}
-
-type MetricDescriptor_Type int32
-
-const (
- MetricDescriptor_UNSPECIFIED MetricDescriptor_Type = 0
- MetricDescriptor_GAUGE_INT64 MetricDescriptor_Type = 1
- MetricDescriptor_GAUGE_DOUBLE MetricDescriptor_Type = 2
- MetricDescriptor_GAUGE_DISTRIBUTION MetricDescriptor_Type = 3
- MetricDescriptor_CUMULATIVE_INT64 MetricDescriptor_Type = 4
- MetricDescriptor_CUMULATIVE_DOUBLE MetricDescriptor_Type = 5
- MetricDescriptor_CUMULATIVE_DISTRIBUTION MetricDescriptor_Type = 6
- MetricDescriptor_SUMMARY MetricDescriptor_Type = 7
-)
-
-type LabelKey struct {
- Key string `json:"key,omitempty"`
- Description string `json:"description,omitempty"`
-}
-
-type TimeSeries struct {
- StartTimestamp *Timestamp `json:"start_timestamp,omitempty"`
- LabelValues []*LabelValue `json:"label_values,omitempty"`
- Points []*Point `json:"points,omitempty"`
-}
-
-type LabelValue struct {
- Value string `json:"value,omitempty"`
- HasValue bool `json:"has_value,omitempty"`
-}
-
-type Point struct {
- Timestamp *Timestamp `json:"timestamp,omitempty"`
- Value PointValue `json:"value,omitempty"`
-}
-
-type PointInt64Value struct {
- Int64Value int64 `json:"int64Value,omitempty"`
-}
-
-// MarshalJSON creates JSON formatted the same way as jsonpb so that the
-// OpenCensus service can correctly determine the underlying value type.
-// This custom MarshalJSON exists because,
-// by default *Point is JSON marshalled as:
-//
-// {"value": {"int64Value": 1}}
-//
-// but it should be marshalled as:
-//
-// {"int64Value": 1}
-func (p *Point) MarshalJSON() ([]byte, error) {
- if p == nil {
- return []byte("null"), nil
- }
-
- switch d := p.Value.(type) {
- case PointInt64Value:
- return json.Marshal(&struct {
- Timestamp *Timestamp `json:"timestamp,omitempty"`
- Value int64 `json:"int64Value,omitempty"`
- }{
- Timestamp: p.Timestamp,
- Value: d.Int64Value,
- })
- case PointDoubleValue:
- return json.Marshal(&struct {
- Timestamp *Timestamp `json:"timestamp,omitempty"`
- Value float64 `json:"doubleValue,omitempty"`
- }{
- Timestamp: p.Timestamp,
- Value: d.DoubleValue,
- })
- case PointDistributionValue:
- return json.Marshal(&struct {
- Timestamp *Timestamp `json:"timestamp,omitempty"`
- Value *DistributionValue `json:"distributionValue,omitempty"`
- }{
- Timestamp: p.Timestamp,
- Value: d.DistributionValue,
- })
- default:
- return nil, fmt.Errorf("unknown point type %T", p.Value)
- }
-}
-
-type PointDoubleValue struct {
- DoubleValue float64 `json:"doubleValue,omitempty"`
-}
-
-type PointDistributionValue struct {
- DistributionValue *DistributionValue `json:"distributionValue,omitempty"`
-}
-
-type PointSummaryValue struct {
- SummaryValue *SummaryValue `json:"summaryValue,omitempty"`
-}
-
-type PointValue interface {
- labelPointValue()
-}
-
-func (PointInt64Value) labelPointValue() {}
-func (PointDoubleValue) labelPointValue() {}
-func (PointDistributionValue) labelPointValue() {}
-func (PointSummaryValue) labelPointValue() {}
-
-type DistributionValue struct {
- Count int64 `json:"count,omitempty"`
- Sum float64 `json:"sum,omitempty"`
- SumOfSquaredDeviation float64 `json:"sum_of_squared_deviation,omitempty"`
- BucketOptions BucketOptions `json:"bucket_options,omitempty"`
- Buckets []*Bucket `json:"buckets,omitempty"`
-}
-
-type BucketOptionsExplicit struct {
- Bounds []float64 `json:"bounds,omitempty"`
-}
-
-type BucketOptions interface {
- labelBucketOptions()
-}
-
-func (*BucketOptionsExplicit) labelBucketOptions() {}
-
-var _ BucketOptions = (*BucketOptionsExplicit)(nil)
-var _ json.Marshaler = (*BucketOptionsExplicit)(nil)
-
-// Declared for the purpose of custom JSON marshaling without cycles.
-type bucketOptionsExplicitAlias BucketOptionsExplicit
-
-// MarshalJSON creates JSON formatted the same way as jsonpb so that the
-// OpenCensus service can correctly determine the underlying value type.
-// This custom MarshalJSON exists because,
-// by default BucketOptionsExplicit is JSON marshalled as:
-//
-// {"bounds":[1,2,3]}
-//
-// but it should be marshalled as:
-//
-// {"explicit":{"bounds":[1,2,3]}}
-func (be *BucketOptionsExplicit) MarshalJSON() ([]byte, error) {
- return json.Marshal(&struct {
- Explicit *bucketOptionsExplicitAlias `json:"explicit,omitempty"`
- }{
- Explicit: (*bucketOptionsExplicitAlias)(be),
- })
-}
-
-type Bucket struct {
- Count int64 `json:"count,omitempty"`
- Exemplar *Exemplar `json:"exemplar,omitempty"`
-}
-
-type Exemplar struct {
- Value float64 `json:"value,omitempty"`
- Timestamp *Timestamp `json:"timestamp,omitempty"`
- Attachments map[string]string `json:"attachments,omitempty"`
-}
-
-type SummaryValue struct {
- Count *Int64Value `json:"count,omitempty"`
- Sum *DoubleValue `json:"sum,omitempty"`
- Snapshot *Snapshot `json:"snapshot,omitempty"`
-}
-
-type Snapshot struct {
- Count *Int64Value `json:"count,omitempty"`
- Sum *DoubleValue `json:"sum,omitempty"`
- PercentileValues []*SnapshotValueAtPercentile `json:"percentile_values,omitempty"`
-}
-
-type SnapshotValueAtPercentile struct {
- Percentile float64 `json:"percentile,omitempty"`
- Value float64 `json:"value,omitempty"`
-}
diff --git a/internal/event/export/ocagent/wire/metrics_test.go b/internal/event/export/ocagent/wire/metrics_test.go
deleted file mode 100644
index 34247ad6332..00000000000
--- a/internal/event/export/ocagent/wire/metrics_test.go
+++ /dev/null
@@ -1,80 +0,0 @@
-// Copyright 2020 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 wire
-
-import (
- "reflect"
- "testing"
-)
-
-func TestMarshalJSON(t *testing.T) {
- tests := []struct {
- name string
- pt *Point
- want string
- }{
- {
- "PointInt64",
- &Point{
- Value: PointInt64Value{
- Int64Value: 5,
- },
- },
- `{"int64Value":5}`,
- },
- {
- "PointDouble",
- &Point{
- Value: PointDoubleValue{
- DoubleValue: 3.14,
- },
- },
- `{"doubleValue":3.14}`,
- },
- {
- "PointDistribution",
- &Point{
- Value: PointDistributionValue{
- DistributionValue: &DistributionValue{
- Count: 3,
- Sum: 10,
- Buckets: []*Bucket{
- {
- Count: 1,
- },
- {
- Count: 2,
- },
- },
- BucketOptions: &BucketOptionsExplicit{
- Bounds: []float64{
- 0, 5,
- },
- },
- },
- },
- },
- `{"distributionValue":{"count":3,"sum":10,"bucket_options":{"explicit":{"bounds":[0,5]}},"buckets":[{"count":1},{"count":2}]}}`,
- },
- {
- "nil point",
- nil,
- `null`,
- },
- }
-
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- buf, err := tt.pt.MarshalJSON()
- if err != nil {
- t.Fatalf("Got:\n%v\nWant:\n%v", err, nil)
- }
- got := string(buf)
- if !reflect.DeepEqual(got, tt.want) {
- t.Fatalf("Got:\n%s\nWant:\n%s", got, tt.want)
- }
- })
- }
-}
diff --git a/internal/event/export/ocagent/wire/trace.go b/internal/event/export/ocagent/wire/trace.go
deleted file mode 100644
index 88856673a18..00000000000
--- a/internal/event/export/ocagent/wire/trace.go
+++ /dev/null
@@ -1,112 +0,0 @@
-// 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 wire
-
-type ExportTraceServiceRequest struct {
- Node *Node `json:"node,omitempty"`
- Spans []*Span `json:"spans,omitempty"`
- Resource *Resource `json:"resource,omitempty"`
-}
-
-type Span struct {
- TraceID []byte `json:"trace_id,omitempty"`
- SpanID []byte `json:"span_id,omitempty"`
- TraceState *TraceState `json:"tracestate,omitempty"`
- ParentSpanID []byte `json:"parent_span_id,omitempty"`
- Name *TruncatableString `json:"name,omitempty"`
- Kind SpanKind `json:"kind,omitempty"`
- StartTime Timestamp `json:"start_time,omitempty"`
- EndTime Timestamp `json:"end_time,omitempty"`
- Attributes *Attributes `json:"attributes,omitempty"`
- StackTrace *StackTrace `json:"stack_trace,omitempty"`
- TimeEvents *TimeEvents `json:"time_events,omitempty"`
- Links *Links `json:"links,omitempty"`
- Status *Status `json:"status,omitempty"`
- Resource *Resource `json:"resource,omitempty"`
- SameProcessAsParentSpan bool `json:"same_process_as_parent_span,omitempty"`
- ChildSpanCount bool `json:"child_span_count,omitempty"`
-}
-
-type TraceState struct {
- Entries []*TraceStateEntry `json:"entries,omitempty"`
-}
-
-type TraceStateEntry struct {
- Key string `json:"key,omitempty"`
- Value string `json:"value,omitempty"`
-}
-
-type SpanKind int32
-
-const (
- UnspecifiedSpanKind SpanKind = 0
- ServerSpanKind SpanKind = 1
- ClientSpanKind SpanKind = 2
-)
-
-type TimeEvents struct {
- TimeEvent []TimeEvent `json:"timeEvent,omitempty"`
- DroppedAnnotationsCount int32 `json:"dropped_annotations_count,omitempty"`
- DroppedMessageEventsCount int32 `json:"dropped_message_events_count,omitempty"`
-}
-
-type TimeEvent struct {
- Time Timestamp `json:"time,omitempty"`
- MessageEvent *MessageEvent `json:"messageEvent,omitempty"`
- Annotation *Annotation `json:"annotation,omitempty"`
-}
-
-type Annotation struct {
- Description *TruncatableString `json:"description,omitempty"`
- Attributes *Attributes `json:"attributes,omitempty"`
-}
-
-type MessageEvent struct {
- Type MessageEventType `json:"type,omitempty"`
- ID uint64 `json:"id,omitempty"`
- UncompressedSize uint64 `json:"uncompressed_size,omitempty"`
- CompressedSize uint64 `json:"compressed_size,omitempty"`
-}
-
-type MessageEventType int32
-
-const (
- UnspecifiedMessageEvent MessageEventType = iota
- SentMessageEvent
- ReceivedMessageEvent
-)
-
-type TimeEventValue interface {
- labelTimeEventValue()
-}
-
-func (Annotation) labelTimeEventValue() {}
-func (MessageEvent) labelTimeEventValue() {}
-
-type Links struct {
- Link []*Link `json:"link,omitempty"`
- DroppedLinksCount int32 `json:"dropped_links_count,omitempty"`
-}
-
-type Link struct {
- TraceID []byte `json:"trace_id,omitempty"`
- SpanID []byte `json:"span_id,omitempty"`
- Type LinkType `json:"type,omitempty"`
- Attributes *Attributes `json:"attributes,omitempty"`
- TraceState *TraceState `json:"tracestate,omitempty"`
-}
-
-type LinkType int32
-
-const (
- UnspecifiedLinkType LinkType = 0
- ChildLinkType LinkType = 1
- ParentLinkType LinkType = 2
-)
-
-type Status struct {
- Code int32 `json:"code,omitempty"`
- Message string `json:"message,omitempty"`
-}
diff --git a/internal/event/export/prometheus/prometheus.go b/internal/event/export/prometheus/prometheus.go
index 0281f60a35f..82bb6c15dfc 100644
--- a/internal/event/export/prometheus/prometheus.go
+++ b/internal/event/export/prometheus/prometheus.go
@@ -66,7 +66,7 @@ func (e *Exporter) header(w http.ResponseWriter, name, description string, isGau
fmt.Fprintf(w, "# TYPE %s %s\n", name, kind)
}
-func (e *Exporter) row(w http.ResponseWriter, name string, group []label.Label, extra string, value interface{}) {
+func (e *Exporter) row(w http.ResponseWriter, name string, group []label.Label, extra string, value any) {
fmt.Fprint(w, name)
buf := &bytes.Buffer{}
fmt.Fprint(buf, group)
diff --git a/internal/event/keys/keys.go b/internal/event/keys/keys.go
index a02206e3015..4cfa51b6123 100644
--- a/internal/event/keys/keys.go
+++ b/internal/event/keys/keys.go
@@ -32,7 +32,7 @@ func (k *Value) Format(w io.Writer, buf []byte, l label.Label) {
}
// Get can be used to get a label for the key from a label.Map.
-func (k *Value) Get(lm label.Map) interface{} {
+func (k *Value) Get(lm label.Map) any {
if t := lm.Find(k); t.Valid() {
return k.From(t)
}
@@ -40,10 +40,10 @@ func (k *Value) Get(lm label.Map) interface{} {
}
// From can be used to get a value from a Label.
-func (k *Value) From(t label.Label) interface{} { return t.UnpackValue() }
+func (k *Value) From(t label.Label) any { return t.UnpackValue() }
// Of creates a new Label with this key and the supplied value.
-func (k *Value) Of(value interface{}) label.Label { return label.OfValue(k, value) }
+func (k *Value) Of(value any) label.Label { return label.OfValue(k, value) }
// Tag represents a key for tagging labels that have no value.
// These are used when the existence of the label is the entire information it
diff --git a/internal/event/label/label.go b/internal/event/label/label.go
index 0f526e1f9ab..92a39105731 100644
--- a/internal/event/label/label.go
+++ b/internal/event/label/label.go
@@ -8,6 +8,7 @@ import (
"fmt"
"io"
"reflect"
+ "slices"
"unsafe"
)
@@ -32,7 +33,7 @@ type Key interface {
type Label struct {
key Key
packed uint64
- untyped interface{}
+ untyped any
}
// Map is the interface to a collection of Labels indexed by key.
@@ -76,13 +77,13 @@ type mapChain struct {
// OfValue creates a new label from the key and value.
// This method is for implementing new key types, label creation should
// normally be done with the Of method of the key.
-func OfValue(k Key, value interface{}) Label { return Label{key: k, untyped: value} }
+func OfValue(k Key, value any) Label { return Label{key: k, untyped: value} }
// UnpackValue assumes the label was built using LabelOfValue and returns the value
// that was passed to that constructor.
// This method is for implementing new key types, for type safety normal
// access should be done with the From method of the key.
-func (t Label) UnpackValue() interface{} { return t.untyped }
+func (t Label) UnpackValue() any { return t.untyped }
// Of64 creates a new label from a key and a uint64. This is often
// used for non uint64 values that can be packed into a uint64.
@@ -154,10 +155,8 @@ func (f *filter) Valid(index int) bool {
func (f *filter) Label(index int) Label {
l := f.underlying.Label(index)
- for _, f := range f.keys {
- if l.Key() == f {
- return Label{}
- }
+ if slices.Contains(f.keys, l.Key()) {
+ return Label{}
}
return l
}
diff --git a/internal/expect/expect.go b/internal/expect/expect.go
index d977ea4e262..69875cd6585 100644
--- a/internal/expect/expect.go
+++ b/internal/expect/expect.go
@@ -86,7 +86,7 @@ type ReadFile func(filename string) ([]byte, error)
// MatchBefore returns the range of the line that matched the pattern, and
// invalid positions if there was no match, or an error if the line could not be
// found.
-func MatchBefore(fset *token.FileSet, readFile ReadFile, end token.Pos, pattern interface{}) (token.Pos, token.Pos, error) {
+func MatchBefore(fset *token.FileSet, readFile ReadFile, end token.Pos, pattern any) (token.Pos, token.Pos, error) {
f := fset.File(end)
content, err := readFile(f.Name())
if err != nil {
diff --git a/internal/expect/expect_test.go b/internal/expect/expect_test.go
index 3ad8d1a74fa..e8f8b6a7a07 100644
--- a/internal/expect/expect_test.go
+++ b/internal/expect/expect_test.go
@@ -155,7 +155,7 @@ func TestMarker(t *testing.T) {
}
}
-func checkMarker(t *testing.T, fset *token.FileSet, readFile expect.ReadFile, markers map[string]token.Pos, pos token.Pos, name string, pattern interface{}) {
+func checkMarker(t *testing.T, fset *token.FileSet, readFile expect.ReadFile, markers map[string]token.Pos, pos token.Pos, name string, pattern any) {
start, end, err := expect.MatchBefore(fset, readFile, pos, pattern)
if err != nil {
t.Errorf("%v: MatchBefore failed: %v", fset.Position(pos), err)
diff --git a/internal/expect/extract.go b/internal/expect/extract.go
index 1fb4349c48e..8ad1cb259e5 100644
--- a/internal/expect/extract.go
+++ b/internal/expect/extract.go
@@ -8,7 +8,9 @@ import (
"fmt"
"go/ast"
"go/parser"
+ goscanner "go/scanner"
"go/token"
+ "os"
"path/filepath"
"regexp"
"strconv"
@@ -32,21 +34,54 @@ type Identifier string
// See the package documentation for details about the syntax of those
// notes.
func Parse(fset *token.FileSet, filename string, content []byte) ([]*Note, error) {
- var src interface{}
- if content != nil {
- src = content
+ if content == nil {
+ data, err := os.ReadFile(filename)
+ if err != nil {
+ return nil, err
+ }
+ content = data
}
+
switch filepath.Ext(filename) {
+ case ".s":
+ // The assembler uses a custom scanner,
+ // but the go/scanner package is close
+ // enough: we only want the comments.
+ file := fset.AddFile(filename, -1, len(content))
+ var scan goscanner.Scanner
+ scan.Init(file, content, nil, goscanner.ScanComments)
+
+ var notes []*Note
+ for {
+ pos, tok, lit := scan.Scan()
+ if tok == token.EOF {
+ break
+ }
+ if tok == token.COMMENT {
+ text, adjust := getAdjustedNote(lit)
+ if text == "" {
+ continue
+ }
+ parsed, err := parse(fset, pos+token.Pos(adjust), text)
+ if err != nil {
+ return nil, err
+ }
+ notes = append(notes, parsed...)
+ }
+ }
+ return notes, nil
+
case ".go":
- // TODO: We should write this in terms of the scanner.
+ // TODO: We should write this in terms of the scanner, like the .s case above.
// there are ways you can break the parser such that it will not add all the
// comments to the ast, which may result in files where the tests are silently
// not run.
- file, err := parser.ParseFile(fset, filename, src, parser.ParseComments|parser.AllErrors|parser.SkipObjectResolution)
+ file, err := parser.ParseFile(fset, filename, content, parser.ParseComments|parser.AllErrors|parser.SkipObjectResolution)
if file == nil {
return nil, err
}
return ExtractGo(fset, file)
+
case ".mod":
file, err := modfile.Parse(filename, content, nil)
if err != nil {
@@ -64,6 +99,7 @@ func Parse(fset *token.FileSet, filename string, content []byte) ([]*Note, error
note.Pos += token.Pos(f.Base())
}
return notes, nil
+
case ".work":
file, err := modfile.ParseWork(filename, content, nil)
if err != nil {
@@ -220,7 +256,7 @@ func (t *tokens) Pos() token.Pos {
return t.base + token.Pos(t.scanner.Position.Offset)
}
-func (t *tokens) Errorf(msg string, args ...interface{}) {
+func (t *tokens) Errorf(msg string, args ...any) {
if t.err != nil {
return
}
diff --git a/internal/facts/facts.go b/internal/facts/facts.go
index e1c18d373c3..8e2997e6def 100644
--- a/internal/facts/facts.go
+++ b/internal/facts/facts.go
@@ -209,7 +209,7 @@ func (d *Decoder) Decode(read func(pkgPath string) ([]byte, error)) (*Set, error
// Facts may describe indirectly imported packages, or their objects.
m := make(map[key]analysis.Fact) // one big bucket
for _, imp := range d.pkg.Imports() {
- logf := func(format string, args ...interface{}) {
+ logf := func(format string, args ...any) {
if debug {
prefix := fmt.Sprintf("in %s, importing %s: ",
d.pkg.Path(), imp.Path())
diff --git a/internal/gcimporter/bimport.go b/internal/gcimporter/bimport.go
index d79a605ed13..734c46198df 100644
--- a/internal/gcimporter/bimport.go
+++ b/internal/gcimporter/bimport.go
@@ -14,7 +14,7 @@ import (
"sync"
)
-func errorf(format string, args ...interface{}) {
+func errorf(format string, args ...any) {
panic(fmt.Sprintf(format, args...))
}
diff --git a/internal/gcimporter/gcimporter_test.go b/internal/gcimporter/gcimporter_test.go
index 9b38a0e1e28..9dc65fa19f6 100644
--- a/internal/gcimporter/gcimporter_test.go
+++ b/internal/gcimporter/gcimporter_test.go
@@ -672,7 +672,7 @@ func TestIssue15517(t *testing.T) {
// file and package path are different, exposing the problem if present.
// The same issue occurs with vendoring.)
imports := make(map[string]*types.Package)
- for i := 0; i < 3; i++ {
+ for range 3 {
if _, err := gcimporter.Import(token.NewFileSet(), imports, "./././testdata/p", tmpdir, nil); err != nil {
t.Fatal(err)
}
@@ -785,7 +785,7 @@ type K = StillBad[string]
// Use the interface instances concurrently.
for _, inst := range insts {
var wg sync.WaitGroup
- for i := 0; i < 2; i++ {
+ for range 2 {
wg.Add(1)
go func() {
defer wg.Done()
diff --git a/internal/gcimporter/iexport.go b/internal/gcimporter/iexport.go
index 7dfc31a37d7..780873e3ae7 100644
--- a/internal/gcimporter/iexport.go
+++ b/internal/gcimporter/iexport.go
@@ -236,6 +236,7 @@ import (
"io"
"math/big"
"reflect"
+ "slices"
"sort"
"strconv"
"strings"
@@ -271,10 +272,10 @@ import (
// file system, be sure to include a cryptographic digest of the executable in
// the key to avoid version skew.
//
-// If the provided reportf func is non-nil, it will be used for reporting bugs
-// encountered during export.
-// TODO(rfindley): remove reportf when we are confident enough in the new
-// objectpath encoding.
+// If the provided reportf func is non-nil, it is used for reporting
+// bugs (e.g. recovered panics) encountered during export, enabling us
+// to obtain via telemetry the stack that would otherwise be lost by
+// merely returning an error.
func IExportShallow(fset *token.FileSet, pkg *types.Package, reportf ReportFunc) ([]byte, error) {
// In principle this operation can only fail if out.Write fails,
// but that's impossible for bytes.Buffer---and as a matter of
@@ -283,7 +284,7 @@ func IExportShallow(fset *token.FileSet, pkg *types.Package, reportf ReportFunc)
// TODO(adonovan): use byte slices throughout, avoiding copying.
const bundle, shallow = false, true
var out bytes.Buffer
- err := iexportCommon(&out, fset, bundle, shallow, iexportVersion, []*types.Package{pkg})
+ err := iexportCommon(&out, fset, bundle, shallow, iexportVersion, []*types.Package{pkg}, reportf)
return out.Bytes(), err
}
@@ -310,7 +311,7 @@ func IImportShallow(fset *token.FileSet, getPackages GetPackagesFunc, data []byt
}
// ReportFunc is the type of a function used to report formatted bugs.
-type ReportFunc = func(string, ...interface{})
+type ReportFunc = func(string, ...any)
// Current bundled export format version. Increase with each format change.
// 0: initial implementation
@@ -323,20 +324,27 @@ const bundleVersion = 0
// so that calls to IImportData can override with a provided package path.
func IExportData(out io.Writer, fset *token.FileSet, pkg *types.Package) error {
const bundle, shallow = false, false
- return iexportCommon(out, fset, bundle, shallow, iexportVersion, []*types.Package{pkg})
+ return iexportCommon(out, fset, bundle, shallow, iexportVersion, []*types.Package{pkg}, nil)
}
// IExportBundle writes an indexed export bundle for pkgs to out.
func IExportBundle(out io.Writer, fset *token.FileSet, pkgs []*types.Package) error {
const bundle, shallow = true, false
- return iexportCommon(out, fset, bundle, shallow, iexportVersion, pkgs)
+ return iexportCommon(out, fset, bundle, shallow, iexportVersion, pkgs, nil)
}
-func iexportCommon(out io.Writer, fset *token.FileSet, bundle, shallow bool, version int, pkgs []*types.Package) (err error) {
+func iexportCommon(out io.Writer, fset *token.FileSet, bundle, shallow bool, version int, pkgs []*types.Package, reportf ReportFunc) (err error) {
if !debug {
defer func() {
if e := recover(); e != nil {
+ // Report the stack via telemetry (see #71067).
+ if reportf != nil {
+ reportf("panic in exporter")
+ }
if ierr, ok := e.(internalError); ok {
+ // internalError usually means we exported a
+ // bad go/types data structure: a violation
+ // of an implicit precondition of Export.
err = ierr
return
}
@@ -458,7 +466,7 @@ func (p *iexporter) encodeFile(w *intWriter, file *token.File, needed []uint64)
w.uint64(size)
// Sort the set of needed offsets. Duplicates are harmless.
- sort.Slice(needed, func(i, j int) bool { return needed[i] < needed[j] })
+ slices.Sort(needed)
lines := file.Lines() // byte offset of each line start
w.uint64(uint64(len(lines)))
@@ -597,7 +605,7 @@ type filePositions struct {
needed []uint64 // unordered list of needed file offsets
}
-func (p *iexporter) trace(format string, args ...interface{}) {
+func (p *iexporter) trace(format string, args ...any) {
if !trace {
// Call sites should also be guarded, but having this check here allows
// easily enabling/disabling debug trace statements.
@@ -812,7 +820,7 @@ func (p *iexporter) doDecl(obj types.Object) {
n := named.NumMethods()
w.uint64(uint64(n))
- for i := 0; i < n; i++ {
+ for i := range n {
m := named.Method(i)
w.pos(m.Pos())
w.string(m.Name())
@@ -1089,7 +1097,7 @@ func (w *exportWriter) doTyp(t types.Type, pkg *types.Package) {
w.pkg(fieldPkg)
w.uint64(uint64(n))
- for i := 0; i < n; i++ {
+ for i := range n {
f := t.Field(i)
if w.p.shallow {
w.objectPath(f)
@@ -1138,7 +1146,7 @@ func (w *exportWriter) doTyp(t types.Type, pkg *types.Package) {
w.startType(unionType)
nt := t.Len()
w.uint64(uint64(nt))
- for i := 0; i < nt; i++ {
+ for i := range nt {
term := t.Term(i)
w.bool(term.Tilde())
w.typ(term.Type(), pkg)
@@ -1267,7 +1275,7 @@ func tparamName(exportName string) string {
func (w *exportWriter) paramList(tup *types.Tuple) {
n := tup.Len()
w.uint64(uint64(n))
- for i := 0; i < n; i++ {
+ for i := range n {
w.param(tup.At(i))
}
}
@@ -1583,6 +1591,6 @@ func (e internalError) Error() string { return "gcimporter: " + string(e) }
// "internalErrorf" as the former is used for bugs, whose cause is
// internal inconsistency, whereas the latter is used for ordinary
// situations like bad input, whose cause is external.
-func internalErrorf(format string, args ...interface{}) error {
+func internalErrorf(format string, args ...any) error {
return internalError(fmt.Sprintf(format, args...))
}
diff --git a/internal/gcimporter/iexport_test.go b/internal/gcimporter/iexport_test.go
index 5707b3784a5..fa8ecd30dc1 100644
--- a/internal/gcimporter/iexport_test.go
+++ b/internal/gcimporter/iexport_test.go
@@ -29,7 +29,7 @@ import (
func iexport(fset *token.FileSet, version int, pkg *types.Package) ([]byte, error) {
var buf bytes.Buffer
const bundle, shallow = false, false
- if err := gcimporter.IExportCommon(&buf, fset, bundle, shallow, version, []*types.Package{pkg}); err != nil {
+ if err := gcimporter.IExportCommon(&buf, fset, bundle, shallow, version, []*types.Package{pkg}, nil); err != nil {
return nil, err
}
return buf.Bytes(), nil
diff --git a/internal/gcimporter/iimport.go b/internal/gcimporter/iimport.go
index 12943927159..82e6c9d2dc1 100644
--- a/internal/gcimporter/iimport.go
+++ b/internal/gcimporter/iimport.go
@@ -16,6 +16,7 @@ import (
"go/types"
"io"
"math/big"
+ "slices"
"sort"
"strings"
@@ -314,7 +315,7 @@ func iimportCommon(fset *token.FileSet, getPackages GetPackagesFunc, data []byte
pkgs = pkgList[:1]
// record all referenced packages as imports
- list := append(([]*types.Package)(nil), pkgList[1:]...)
+ list := slices.Clone(pkgList[1:])
sort.Sort(byPath(list))
pkgs[0].SetImports(list)
}
@@ -400,7 +401,7 @@ type iimporter struct {
indent int // for tracing support
}
-func (p *iimporter) trace(format string, args ...interface{}) {
+func (p *iimporter) trace(format string, args ...any) {
if !trace {
// Call sites should also be guarded, but having this check here allows
// easily enabling/disabling debug trace statements.
diff --git a/internal/gcimporter/israce_test.go b/internal/gcimporter/israce_test.go
index 885ba1c01c5..c75a16b7a1b 100644
--- a/internal/gcimporter/israce_test.go
+++ b/internal/gcimporter/israce_test.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build race
-// +build race
package gcimporter_test
diff --git a/internal/gcimporter/ureader_yes.go b/internal/gcimporter/ureader_yes.go
index 522287d18d6..37b4a39e9e1 100644
--- a/internal/gcimporter/ureader_yes.go
+++ b/internal/gcimporter/ureader_yes.go
@@ -574,7 +574,7 @@ func (pr *pkgReader) objIdx(idx pkgbits.Index) (*types.Package, string) {
recv := types.NewVar(fn.Pos(), fn.Pkg(), "", named)
typesinternal.SetVarKind(recv, typesinternal.RecvVar)
- methods[i] = types.NewFunc(fn.Pos(), fn.Pkg(), fn.Name(), types.NewSignature(recv, sig.Params(), sig.Results(), sig.Variadic()))
+ methods[i] = types.NewFunc(fn.Pos(), fn.Pkg(), fn.Name(), types.NewSignatureType(recv, nil, nil, sig.Params(), sig.Results(), sig.Variadic()))
}
embeds := make([]types.Type, iface.NumEmbeddeds())
diff --git a/internal/gocommand/invoke.go b/internal/gocommand/invoke.go
index 7ea9013447b..58721202de7 100644
--- a/internal/gocommand/invoke.go
+++ b/internal/gocommand/invoke.go
@@ -141,7 +141,7 @@ func (runner *Runner) runPiped(ctx context.Context, inv Invocation, stdout, stde
// Wait for all in-progress go commands to return before proceeding,
// to avoid load concurrency errors.
- for i := 0; i < maxInFlight; i++ {
+ for range maxInFlight {
select {
case <-ctx.Done():
return ctx.Err(), ctx.Err()
diff --git a/gopls/internal/analysis/gofix/main.go b/internal/gofix/cmd/gofix/main.go
similarity index 73%
rename from gopls/internal/analysis/gofix/main.go
rename to internal/gofix/cmd/gofix/main.go
index fde633f2f62..9ec77943774 100644
--- a/gopls/internal/analysis/gofix/main.go
+++ b/internal/gofix/cmd/gofix/main.go
@@ -1,10 +1,7 @@
-// Copyright 2023 The Go Authors. All rights reserved.
+// Copyright 2025 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.
-//go:build ignore
-// +build ignore
-
// The inline command applies the inliner to the specified packages of
// Go source code. Run with:
//
@@ -13,7 +10,7 @@ package main
import (
"golang.org/x/tools/go/analysis/singlechecker"
- "golang.org/x/tools/gopls/internal/analysis/gofix"
+ "golang.org/x/tools/internal/gofix"
)
func main() { singlechecker.Main(gofix.Analyzer) }
diff --git a/gopls/internal/analysis/gofix/doc.go b/internal/gofix/doc.go
similarity index 80%
rename from gopls/internal/analysis/gofix/doc.go
rename to internal/gofix/doc.go
index a0c6a08ded9..15de4f28b27 100644
--- a/gopls/internal/analysis/gofix/doc.go
+++ b/internal/gofix/doc.go
@@ -5,7 +5,8 @@
/*
Package gofix defines an Analyzer that inlines calls to functions
and uses of constants
-marked with a "//go:fix inline" doc comment.
+marked with a "//go:fix inline" directive.
+A second analyzer only checks uses of the directive.
# Analyzer gofix
@@ -77,5 +78,16 @@ or before a group, applying to every constant in the group:
)
The proposal https://go.dev/issue/32816 introduces the "//go:fix" directives.
+
+You can use this (officially unsupported) command to apply gofix fixes en masse:
+
+ $ go run golang.org/x/tools/gopls/internal/analysis/gofix/cmd/gofix@latest -test ./...
+
+# Analyzer gofixdirective
+
+gofixdirective: validate uses of gofix comment directives
+
+The gofixdirective analyzer checks "//go:fix inline" directives for correctness.
+See the documentation for the gofix analyzer for more about "/go:fix inline".
*/
package gofix
diff --git a/internal/gofix/gofix.go b/internal/gofix/gofix.go
new file mode 100644
index 00000000000..565272b5e46
--- /dev/null
+++ b/internal/gofix/gofix.go
@@ -0,0 +1,660 @@
+// Copyright 2023 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 gofix
+
+import (
+ "fmt"
+ "go/ast"
+ "go/token"
+ "go/types"
+ "iter"
+ "slices"
+ "strings"
+
+ _ "embed"
+
+ "golang.org/x/tools/go/analysis"
+ "golang.org/x/tools/go/analysis/passes/inspect"
+ "golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/go/types/typeutil"
+ "golang.org/x/tools/internal/analysisinternal"
+ internalastutil "golang.org/x/tools/internal/astutil"
+ "golang.org/x/tools/internal/astutil/cursor"
+ "golang.org/x/tools/internal/astutil/edge"
+ "golang.org/x/tools/internal/diff"
+ "golang.org/x/tools/internal/refactor/inline"
+ "golang.org/x/tools/internal/typesinternal"
+)
+
+//go:embed doc.go
+var doc string
+
+var Analyzer = &analysis.Analyzer{
+ Name: "gofix",
+ Doc: analysisinternal.MustExtractDoc(doc, "gofix"),
+ URL: "https://pkg.go.dev/golang.org/x/tools/internal/gofix",
+ Run: func(pass *analysis.Pass) (any, error) { return run(pass, true) },
+ FactTypes: []analysis.Fact{
+ (*goFixInlineFuncFact)(nil),
+ (*goFixInlineConstFact)(nil),
+ (*goFixInlineAliasFact)(nil),
+ },
+ Requires: []*analysis.Analyzer{inspect.Analyzer},
+}
+
+var DirectiveAnalyzer = &analysis.Analyzer{
+ Name: "gofixdirective",
+ Doc: analysisinternal.MustExtractDoc(doc, "gofixdirective"),
+ URL: "https://pkg.go.dev/golang.org/x/tools/internal/gofix",
+ Run: func(pass *analysis.Pass) (any, error) { return run(pass, false) },
+ FactTypes: []analysis.Fact{
+ (*goFixInlineFuncFact)(nil),
+ (*goFixInlineConstFact)(nil),
+ (*goFixInlineAliasFact)(nil),
+ },
+ Requires: []*analysis.Analyzer{inspect.Analyzer},
+}
+
+// analyzer holds the state for this analysis.
+type analyzer struct {
+ pass *analysis.Pass
+ fix bool // only suggest fixes if true; else, just check directives
+ root cursor.Cursor
+ // memoization of repeated calls for same file.
+ fileContent map[string][]byte
+ // memoization of fact imports (nil => no fact)
+ inlinableFuncs map[*types.Func]*inline.Callee
+ inlinableConsts map[*types.Const]*goFixInlineConstFact
+ inlinableAliases map[*types.TypeName]*goFixInlineAliasFact
+}
+
+func run(pass *analysis.Pass, fix bool) (any, error) {
+ a := &analyzer{
+ pass: pass,
+ fix: fix,
+ root: cursor.Root(pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)),
+ fileContent: make(map[string][]byte),
+ inlinableFuncs: make(map[*types.Func]*inline.Callee),
+ inlinableConsts: make(map[*types.Const]*goFixInlineConstFact),
+ inlinableAliases: make(map[*types.TypeName]*goFixInlineAliasFact),
+ }
+ a.find()
+ a.inline()
+ return nil, nil
+}
+
+// find finds functions and constants annotated with an appropriate "//go:fix"
+// comment (the syntax proposed by #32816),
+// and exports a fact for each one.
+func (a *analyzer) find() {
+ for cur := range a.root.Preorder((*ast.FuncDecl)(nil), (*ast.GenDecl)(nil)) {
+ switch decl := cur.Node().(type) {
+ case *ast.FuncDecl:
+ a.findFunc(decl)
+
+ case *ast.GenDecl:
+ if decl.Tok != token.CONST && decl.Tok != token.TYPE {
+ continue
+ }
+ declInline := hasFixInline(decl.Doc)
+ // Accept inline directives on the entire decl as well as individual specs.
+ for _, spec := range decl.Specs {
+ switch spec := spec.(type) {
+ case *ast.TypeSpec: // Tok == TYPE
+ a.findAlias(spec, declInline)
+
+ case *ast.ValueSpec: // Tok == CONST
+ a.findConst(spec, declInline)
+ }
+ }
+ }
+ }
+}
+
+func (a *analyzer) findFunc(decl *ast.FuncDecl) {
+ if !hasFixInline(decl.Doc) {
+ return
+ }
+ content, err := a.readFile(decl)
+ if err != nil {
+ a.pass.Reportf(decl.Doc.Pos(), "invalid inlining candidate: cannot read source file: %v", err)
+ return
+ }
+ callee, err := inline.AnalyzeCallee(discard, a.pass.Fset, a.pass.Pkg, a.pass.TypesInfo, decl, content)
+ if err != nil {
+ a.pass.Reportf(decl.Doc.Pos(), "invalid inlining candidate: %v", err)
+ return
+ }
+ fn := a.pass.TypesInfo.Defs[decl.Name].(*types.Func)
+ a.pass.ExportObjectFact(fn, &goFixInlineFuncFact{callee})
+ a.inlinableFuncs[fn] = callee
+}
+
+func (a *analyzer) findAlias(spec *ast.TypeSpec, declInline bool) {
+ if !declInline && !hasFixInline(spec.Doc) {
+ return
+ }
+ if !spec.Assign.IsValid() {
+ a.pass.Reportf(spec.Pos(), "invalid //go:fix inline directive: not a type alias")
+ return
+ }
+
+ // Disallow inlines of type expressions containing array types.
+ // Given an array type like [N]int where N is a named constant, go/types provides
+ // only the value of the constant as an int64. So inlining A in this code:
+ //
+ // const N = 5
+ // type A = [N]int
+ //
+ // would result in [5]int, breaking the connection with N.
+ for n := range ast.Preorder(spec.Type) {
+ if ar, ok := n.(*ast.ArrayType); ok && ar.Len != nil {
+ // Make an exception when the array length is a literal int.
+ if lit, ok := ast.Unparen(ar.Len).(*ast.BasicLit); ok && lit.Kind == token.INT {
+ continue
+ }
+ a.pass.Reportf(spec.Pos(), "invalid //go:fix inline directive: array types not supported")
+ return
+ }
+ }
+
+ // Remember that this is an inlinable alias.
+ typ := &goFixInlineAliasFact{}
+ lhs := a.pass.TypesInfo.Defs[spec.Name].(*types.TypeName)
+ a.inlinableAliases[lhs] = typ
+ // Create a fact only if the LHS is exported and defined at top level.
+ // We create a fact even if the RHS is non-exported,
+ // so we can warn about uses in other packages.
+ if lhs.Exported() && typesinternal.IsPackageLevel(lhs) {
+ a.pass.ExportObjectFact(lhs, typ)
+ }
+}
+
+func (a *analyzer) findConst(spec *ast.ValueSpec, declInline bool) {
+ info := a.pass.TypesInfo
+ specInline := hasFixInline(spec.Doc)
+ if declInline || specInline {
+ for i, name := range spec.Names {
+ if i >= len(spec.Values) {
+ // Possible following an iota.
+ break
+ }
+ val := spec.Values[i]
+ var rhsID *ast.Ident
+ switch e := val.(type) {
+ case *ast.Ident:
+ // Constants defined with the predeclared iota cannot be inlined.
+ if info.Uses[e] == builtinIota {
+ a.pass.Reportf(val.Pos(), "invalid //go:fix inline directive: const value is iota")
+ return
+ }
+ rhsID = e
+ case *ast.SelectorExpr:
+ rhsID = e.Sel
+ default:
+ a.pass.Reportf(val.Pos(), "invalid //go:fix inline directive: const value is not the name of another constant")
+ return
+ }
+ lhs := info.Defs[name].(*types.Const)
+ rhs := info.Uses[rhsID].(*types.Const) // must be so in a well-typed program
+ con := &goFixInlineConstFact{
+ RHSName: rhs.Name(),
+ RHSPkgName: rhs.Pkg().Name(),
+ RHSPkgPath: rhs.Pkg().Path(),
+ }
+ if rhs.Pkg() == a.pass.Pkg {
+ con.rhsObj = rhs
+ }
+ a.inlinableConsts[lhs] = con
+ // Create a fact only if the LHS is exported and defined at top level.
+ // We create a fact even if the RHS is non-exported,
+ // so we can warn about uses in other packages.
+ if lhs.Exported() && typesinternal.IsPackageLevel(lhs) {
+ a.pass.ExportObjectFact(lhs, con)
+ }
+ }
+ }
+}
+
+// inline inlines each static call to an inlinable function
+// and each reference to an inlinable constant or type alias.
+//
+// TODO(adonovan): handle multiple diffs that each add the same import.
+func (a *analyzer) inline() {
+ for cur := range a.root.Preorder((*ast.CallExpr)(nil), (*ast.Ident)(nil)) {
+ switch n := cur.Node().(type) {
+ case *ast.CallExpr:
+ a.inlineCall(n, cur)
+
+ case *ast.Ident:
+ switch t := a.pass.TypesInfo.Uses[n].(type) {
+ case *types.TypeName:
+ a.inlineAlias(t, cur)
+ case *types.Const:
+ a.inlineConst(t, cur)
+ }
+ }
+ }
+}
+
+// If call is a call to an inlinable func, suggest inlining its use at cur.
+func (a *analyzer) inlineCall(call *ast.CallExpr, cur cursor.Cursor) {
+ if fn := typeutil.StaticCallee(a.pass.TypesInfo, call); fn != nil {
+ // Inlinable?
+ callee, ok := a.inlinableFuncs[fn]
+ if !ok {
+ var fact goFixInlineFuncFact
+ if a.pass.ImportObjectFact(fn, &fact) {
+ callee = fact.Callee
+ a.inlinableFuncs[fn] = callee
+ }
+ }
+ if callee == nil {
+ return // nope
+ }
+
+ // Inline the call.
+ content, err := a.readFile(call)
+ if err != nil {
+ a.pass.Reportf(call.Lparen, "invalid inlining candidate: cannot read source file: %v", err)
+ return
+ }
+ curFile := currentFile(cur)
+ caller := &inline.Caller{
+ Fset: a.pass.Fset,
+ Types: a.pass.Pkg,
+ Info: a.pass.TypesInfo,
+ File: curFile,
+ Call: call,
+ Content: content,
+ }
+ res, err := inline.Inline(caller, callee, &inline.Options{Logf: discard})
+ if err != nil {
+ a.pass.Reportf(call.Lparen, "%v", err)
+ return
+ }
+ if !a.fix {
+ return
+ }
+
+ if res.Literalized {
+ // Users are not fond of inlinings that literalize
+ // f(x) to func() { ... }(), so avoid them.
+ //
+ // (Unfortunately the inliner is very timid,
+ // and often literalizes when it cannot prove that
+ // reducing the call is safe; the user of this tool
+ // has no indication of what the problem is.)
+ return
+ }
+ got := res.Content
+
+ // Suggest the "fix".
+ var textEdits []analysis.TextEdit
+ for _, edit := range diff.Bytes(content, got) {
+ textEdits = append(textEdits, analysis.TextEdit{
+ Pos: curFile.FileStart + token.Pos(edit.Start),
+ End: curFile.FileStart + token.Pos(edit.End),
+ NewText: []byte(edit.New),
+ })
+ }
+ a.pass.Report(analysis.Diagnostic{
+ Pos: call.Pos(),
+ End: call.End(),
+ Message: fmt.Sprintf("Call of %v should be inlined", callee),
+ SuggestedFixes: []analysis.SuggestedFix{{
+ Message: fmt.Sprintf("Inline call of %v", callee),
+ TextEdits: textEdits,
+ }},
+ })
+ }
+}
+
+// If tn is the TypeName of an inlinable alias, suggest inlining its use at cur.
+func (a *analyzer) inlineAlias(tn *types.TypeName, curId cursor.Cursor) {
+ inalias, ok := a.inlinableAliases[tn]
+ if !ok {
+ var fact goFixInlineAliasFact
+ if a.pass.ImportObjectFact(tn, &fact) {
+ inalias = &fact
+ a.inlinableAliases[tn] = inalias
+ }
+ }
+ if inalias == nil {
+ return // nope
+ }
+
+ alias := tn.Type().(*types.Alias)
+ // Remember the names of the alias's type params. When we check for shadowing
+ // later, we'll ignore these because they won't appear in the replacement text.
+ typeParamNames := map[*types.TypeName]bool{}
+ for tp := range listIter(alias.TypeParams()) {
+ typeParamNames[tp.Obj()] = true
+ }
+ rhs := alias.Rhs()
+ curPath := a.pass.Pkg.Path()
+ curFile := currentFile(curId)
+ id := curId.Node().(*ast.Ident)
+ // We have an identifier A here (n), possibly qualified by a package
+ // identifier (sel.n), and an inlinable "type A = rhs" elsewhere.
+ //
+ // We can replace A with rhs if no name in rhs is shadowed at n's position,
+ // and every package in rhs is importable by the current package.
+
+ var (
+ importPrefixes = map[string]string{curPath: ""} // from pkg path to prefix
+ edits []analysis.TextEdit
+ )
+ for _, tn := range typenames(rhs) {
+ // Ignore the type parameters of the alias: they won't appear in the result.
+ if typeParamNames[tn] {
+ continue
+ }
+ var pkgPath, pkgName string
+ if pkg := tn.Pkg(); pkg != nil {
+ pkgPath = pkg.Path()
+ pkgName = pkg.Name()
+ }
+ if pkgPath == "" || pkgPath == curPath {
+ // The name is in the current package or the universe scope, so no import
+ // is required. Check that it is not shadowed (that is, that the type
+ // it refers to in rhs is the same one it refers to at n).
+ scope := a.pass.TypesInfo.Scopes[curFile].Innermost(id.Pos()) // n's scope
+ _, obj := scope.LookupParent(tn.Name(), id.Pos()) // what qn.name means in n's scope
+ if obj != tn {
+ return
+ }
+ } else if !analysisinternal.CanImport(a.pass.Pkg.Path(), pkgPath) {
+ // If this package can't see the package of this part of rhs, we can't inline.
+ return
+ } else if _, ok := importPrefixes[pkgPath]; !ok {
+ // Use AddImport to add pkgPath if it's not there already. Associate the prefix it assigns
+ // with the package path for use by the TypeString qualifier below.
+ _, prefix, eds := analysisinternal.AddImport(
+ a.pass.TypesInfo, curFile, pkgName, pkgPath, tn.Name(), id.Pos())
+ importPrefixes[pkgPath] = strings.TrimSuffix(prefix, ".")
+ edits = append(edits, eds...)
+ }
+ }
+ // Find the complete identifier, which may take any of these forms:
+ // Id
+ // Id[T]
+ // Id[K, V]
+ // pkg.Id
+ // pkg.Id[T]
+ // pkg.Id[K, V]
+ var expr ast.Expr = id
+ if ek, _ := curId.ParentEdge(); ek == edge.SelectorExpr_Sel {
+ curId = curId.Parent()
+ expr = curId.Node().(ast.Expr)
+ }
+ // If expr is part of an IndexExpr or IndexListExpr, we'll need that node.
+ // Given C[int], TypeOf(C) is generic but TypeOf(C[int]) is instantiated.
+ switch ek, _ := curId.ParentEdge(); ek {
+ case edge.IndexExpr_X:
+ expr = curId.Parent().Node().(*ast.IndexExpr)
+ case edge.IndexListExpr_X:
+ expr = curId.Parent().Node().(*ast.IndexListExpr)
+ }
+ t := a.pass.TypesInfo.TypeOf(expr).(*types.Alias) // type of entire identifier
+ if targs := t.TypeArgs(); targs.Len() > 0 {
+ // Instantiate the alias with the type args from this use.
+ // For example, given type A = M[K, V], compute the type of the use
+ // A[int, Foo] as M[int, Foo].
+ // Don't validate instantiation: it can't panic unless we have a bug,
+ // in which case seeing the stack trace via telemetry would be helpful.
+ instAlias, _ := types.Instantiate(nil, alias, slices.Collect(listIter(targs)), false)
+ rhs = instAlias.(*types.Alias).Rhs()
+ }
+ // To get the replacement text, render the alias RHS using the package prefixes
+ // we assigned above.
+ newText := types.TypeString(rhs, func(p *types.Package) string {
+ if p == a.pass.Pkg {
+ return ""
+ }
+ if prefix, ok := importPrefixes[p.Path()]; ok {
+ return prefix
+ }
+ panic(fmt.Sprintf("in %q, package path %q has no import prefix", rhs, p.Path()))
+ })
+ a.reportInline("type alias", "Type alias", expr, edits, newText)
+}
+
+// typenames returns the TypeNames for types within t (including t itself) that have
+// them: basic types, named types and alias types.
+// The same name may appear more than once.
+func typenames(t types.Type) []*types.TypeName {
+ var tns []*types.TypeName
+
+ var visit func(types.Type)
+ visit = func(t types.Type) {
+ if hasName, ok := t.(interface{ Obj() *types.TypeName }); ok {
+ tns = append(tns, hasName.Obj())
+ }
+ switch t := t.(type) {
+ case *types.Basic:
+ tns = append(tns, types.Universe.Lookup(t.Name()).(*types.TypeName))
+ case *types.Named:
+ for t := range listIter(t.TypeArgs()) {
+ visit(t)
+ }
+ case *types.Alias:
+ for t := range listIter(t.TypeArgs()) {
+ visit(t)
+ }
+ case *types.TypeParam:
+ tns = append(tns, t.Obj())
+ case *types.Pointer:
+ visit(t.Elem())
+ case *types.Slice:
+ visit(t.Elem())
+ case *types.Array:
+ visit(t.Elem())
+ case *types.Chan:
+ visit(t.Elem())
+ case *types.Map:
+ visit(t.Key())
+ visit(t.Elem())
+ case *types.Struct:
+ for i := range t.NumFields() {
+ visit(t.Field(i).Type())
+ }
+ case *types.Signature:
+ // Ignore the receiver: although it may be present, it has no meaning
+ // in a type expression.
+ // Ditto for receiver type params.
+ // Also, function type params cannot appear in a type expression.
+ if t.TypeParams() != nil {
+ panic("Signature.TypeParams in type expression")
+ }
+ visit(t.Params())
+ visit(t.Results())
+ case *types.Interface:
+ for i := range t.NumEmbeddeds() {
+ visit(t.EmbeddedType(i))
+ }
+ for i := range t.NumExplicitMethods() {
+ visit(t.ExplicitMethod(i).Type())
+ }
+ case *types.Tuple:
+ for v := range listIter(t) {
+ visit(v.Type())
+ }
+ case *types.Union:
+ panic("Union in type expression")
+ default:
+ panic(fmt.Sprintf("unknown type %T", t))
+ }
+ }
+
+ visit(t)
+
+ return tns
+}
+
+// If con is an inlinable constant, suggest inlining its use at cur.
+func (a *analyzer) inlineConst(con *types.Const, cur cursor.Cursor) {
+ incon, ok := a.inlinableConsts[con]
+ if !ok {
+ var fact goFixInlineConstFact
+ if a.pass.ImportObjectFact(con, &fact) {
+ incon = &fact
+ a.inlinableConsts[con] = incon
+ }
+ }
+ if incon == nil {
+ return // nope
+ }
+
+ // If n is qualified by a package identifier, we'll need the full selector expression.
+ curFile := currentFile(cur)
+ n := cur.Node().(*ast.Ident)
+
+ // We have an identifier A here (n), possibly qualified by a package identifier (sel.X,
+ // where sel is the parent of n), // and an inlinable "const A = B" elsewhere (incon).
+ // Consider replacing A with B.
+
+ // Check that the expression we are inlining (B) means the same thing
+ // (refers to the same object) in n's scope as it does in A's scope.
+ // If the RHS is not in the current package, AddImport will handle
+ // shadowing, so we only need to worry about when both expressions
+ // are in the current package.
+ if a.pass.Pkg.Path() == incon.RHSPkgPath {
+ // incon.rhsObj is the object referred to by B in the definition of A.
+ scope := a.pass.TypesInfo.Scopes[curFile].Innermost(n.Pos()) // n's scope
+ _, obj := scope.LookupParent(incon.RHSName, n.Pos()) // what "B" means in n's scope
+ if obj == nil {
+ // Should be impossible: if code at n can refer to the LHS,
+ // it can refer to the RHS.
+ panic(fmt.Sprintf("no object for inlinable const %s RHS %s", n.Name, incon.RHSName))
+ }
+ if obj != incon.rhsObj {
+ // "B" means something different here than at the inlinable const's scope.
+ return
+ }
+ } else if !analysisinternal.CanImport(a.pass.Pkg.Path(), incon.RHSPkgPath) {
+ // If this package can't see the RHS's package, we can't inline.
+ return
+ }
+ var (
+ importPrefix string
+ edits []analysis.TextEdit
+ )
+ if incon.RHSPkgPath != a.pass.Pkg.Path() {
+ _, importPrefix, edits = analysisinternal.AddImport(
+ a.pass.TypesInfo, curFile, incon.RHSPkgName, incon.RHSPkgPath, incon.RHSName, n.Pos())
+ }
+ // If n is qualified by a package identifier, we'll need the full selector expression.
+ var expr ast.Expr = n
+ if ek, _ := cur.ParentEdge(); ek == edge.SelectorExpr_Sel {
+ expr = cur.Parent().Node().(ast.Expr)
+ }
+ a.reportInline("constant", "Constant", expr, edits, importPrefix+incon.RHSName)
+}
+
+// reportInline reports a diagnostic for fixing an inlinable name.
+func (a *analyzer) reportInline(kind, capKind string, ident ast.Expr, edits []analysis.TextEdit, newText string) {
+ if !a.fix {
+ return
+ }
+ edits = append(edits, analysis.TextEdit{
+ Pos: ident.Pos(),
+ End: ident.End(),
+ NewText: []byte(newText),
+ })
+ name := analysisinternal.Format(a.pass.Fset, ident)
+ a.pass.Report(analysis.Diagnostic{
+ Pos: ident.Pos(),
+ End: ident.End(),
+ Message: fmt.Sprintf("%s %s should be inlined", capKind, name),
+ SuggestedFixes: []analysis.SuggestedFix{{
+ Message: fmt.Sprintf("Inline %s %s", kind, name),
+ TextEdits: edits,
+ }},
+ })
+}
+
+func (a *analyzer) readFile(node ast.Node) ([]byte, error) {
+ filename := a.pass.Fset.File(node.Pos()).Name()
+ content, ok := a.fileContent[filename]
+ if !ok {
+ var err error
+ content, err = a.pass.ReadFile(filename)
+ if err != nil {
+ return nil, err
+ }
+ a.fileContent[filename] = content
+ }
+ return content, nil
+}
+
+// currentFile returns the unique ast.File for a cursor.
+func currentFile(c cursor.Cursor) *ast.File {
+ for cf := range c.Enclosing((*ast.File)(nil)) {
+ return cf.Node().(*ast.File)
+ }
+ panic("no *ast.File enclosing a cursor: impossible")
+}
+
+// hasFixInline reports the presence of a "//go:fix inline" directive
+// in the comments.
+func hasFixInline(cg *ast.CommentGroup) bool {
+ for _, d := range internalastutil.Directives(cg) {
+ if d.Tool == "go" && d.Name == "fix" && d.Args == "inline" {
+ return true
+ }
+ }
+ return false
+}
+
+// A goFixInlineFuncFact is exported for each function marked "//go:fix inline".
+// It holds information about the callee to support inlining.
+type goFixInlineFuncFact struct{ Callee *inline.Callee }
+
+func (f *goFixInlineFuncFact) String() string { return "goFixInline " + f.Callee.String() }
+func (*goFixInlineFuncFact) AFact() {}
+
+// A goFixInlineConstFact is exported for each constant marked "//go:fix inline".
+// It holds information about an inlinable constant. Gob-serializable.
+type goFixInlineConstFact struct {
+ // Information about "const LHSName = RHSName".
+ RHSName string
+ RHSPkgPath string
+ RHSPkgName string
+ rhsObj types.Object // for current package
+}
+
+func (c *goFixInlineConstFact) String() string {
+ return fmt.Sprintf("goFixInline const %q.%s", c.RHSPkgPath, c.RHSName)
+}
+
+func (*goFixInlineConstFact) AFact() {}
+
+// A goFixInlineAliasFact is exported for each type alias marked "//go:fix inline".
+// It holds no information; its mere existence demonstrates that an alias is inlinable.
+type goFixInlineAliasFact struct{}
+
+func (c *goFixInlineAliasFact) String() string { return "goFixInline alias" }
+func (*goFixInlineAliasFact) AFact() {}
+
+func discard(string, ...any) {}
+
+var builtinIota = types.Universe.Lookup("iota")
+
+type list[T any] interface {
+ Len() int
+ At(int) T
+}
+
+// TODO(adonovan): eliminate in favor of go/types@go1.24 iterators.
+func listIter[L list[T], T any](lst L) iter.Seq[T] {
+ return func(yield func(T) bool) {
+ for i := range lst.Len() {
+ if !yield(lst.At(i)) {
+ return
+ }
+ }
+ }
+}
diff --git a/internal/gofix/gofix_test.go b/internal/gofix/gofix_test.go
new file mode 100644
index 00000000000..ae2df3860a8
--- /dev/null
+++ b/internal/gofix/gofix_test.go
@@ -0,0 +1,180 @@
+// Copyright 2018 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 gofix
+
+import (
+ "go/ast"
+ "go/importer"
+ "go/parser"
+ "go/token"
+ "go/types"
+ "slices"
+ "testing"
+
+ gocmp "github.com/google/go-cmp/cmp"
+ "golang.org/x/tools/go/analysis/analysistest"
+ "golang.org/x/tools/internal/testenv"
+)
+
+func TestAnalyzer(t *testing.T) {
+ if testenv.Go1Point() < 24 {
+ testenv.NeedsGoExperiment(t, "aliastypeparams")
+ }
+ analysistest.RunWithSuggestedFixes(t, analysistest.TestData(), Analyzer, "a", "b")
+}
+
+func TestDirectiveAnalyzer(t *testing.T) {
+ analysistest.RunWithSuggestedFixes(t, analysistest.TestData(), DirectiveAnalyzer, "directive")
+
+}
+
+func TestTypesWithNames(t *testing.T) {
+ // Test setup inspired by internal/analysisinternal/addimport_test.go.
+ testenv.NeedsDefaultImporter(t)
+
+ for _, test := range []struct {
+ typeExpr string
+ want []string
+ }{
+ {
+ "int",
+ []string{"int"},
+ },
+ {
+ "*int",
+ []string{"int"},
+ },
+ {
+ "[]*int",
+ []string{"int"},
+ },
+ {
+ "[2]int",
+ []string{"int"},
+ },
+ {
+ // go/types does not expose the length expression.
+ "[unsafe.Sizeof(uint(1))]int",
+ []string{"int"},
+ },
+ {
+ "map[string]int",
+ []string{"int", "string"},
+ },
+ {
+ "map[int]struct{x, y int}",
+ []string{"int"},
+ },
+ {
+ "T",
+ []string{"a.T"},
+ },
+ {
+ "iter.Seq[int]",
+ []string{"int", "iter.Seq"},
+ },
+ {
+ "io.Reader",
+ []string{"io.Reader"},
+ },
+ {
+ "map[*io.Writer]map[T]A",
+ []string{"a.A", "a.T", "io.Writer"},
+ },
+ {
+ "func(int, int) (bool, error)",
+ []string{"bool", "error", "int"},
+ },
+ {
+ "func(int, ...string) (T, *T, error)",
+ []string{"a.T", "error", "int", "string"},
+ },
+ {
+ "func(iter.Seq[int])",
+ []string{"int", "iter.Seq"},
+ },
+ {
+ "struct { a int; b bool}",
+ []string{"bool", "int"},
+ },
+ {
+ "struct { io.Reader; a int}",
+ []string{"int", "io.Reader"},
+ },
+ {
+ "map[*string]struct{x chan int; y [2]bool}",
+ []string{"bool", "int", "string"},
+ },
+ {
+ "interface {F(int) bool}",
+ []string{"bool", "int"},
+ },
+ {
+ "interface {io.Reader; F(int) bool}",
+ []string{"bool", "int", "io.Reader"},
+ },
+ {
+ "G", // a type parameter of the function
+ []string{"a.G"},
+ },
+ } {
+ src := `
+ package a
+ import ("io"; "iter"; "unsafe")
+ func _(io.Reader, iter.Seq[int]) uintptr {return unsafe.Sizeof(1)}
+ type T int
+ type A = T
+
+ func F[G any]() {
+ var V ` + test.typeExpr + `
+ _ = V
+ }`
+
+ // parse
+ fset := token.NewFileSet()
+ f, err := parser.ParseFile(fset, "a.go", src, 0)
+ if err != nil {
+ t.Errorf("%s: %v", test.typeExpr, err)
+ continue
+ }
+
+ // type-check
+ info := &types.Info{
+ Types: make(map[ast.Expr]types.TypeAndValue),
+ Scopes: make(map[ast.Node]*types.Scope),
+ Defs: make(map[*ast.Ident]types.Object),
+ Implicits: make(map[ast.Node]types.Object),
+ }
+ conf := &types.Config{
+ Error: func(err error) { t.Fatalf("%s: %v", test.typeExpr, err) },
+ Importer: importer.Default(),
+ }
+ pkg, err := conf.Check(f.Name.Name, fset, []*ast.File{f}, info)
+ if err != nil {
+ t.Errorf("%s: %v", test.typeExpr, err)
+ continue
+ }
+
+ // Look at V's type.
+ typ := pkg.Scope().Lookup("F").(*types.Func).
+ Scope().Lookup("V").(*types.Var).Type()
+ tns := typenames(typ)
+ // Sort names for comparison.
+ var got []string
+ for _, tn := range tns {
+ var prefix string
+ if p := tn.Pkg(); p != nil && p.Path() != "" {
+ prefix = p.Path() + "."
+ }
+ got = append(got, prefix+tn.Name())
+ }
+ slices.Sort(got)
+ got = slices.Compact(got)
+
+ if diff := gocmp.Diff(test.want, got); diff != "" {
+ t.Errorf("%s: mismatch (-want, +got):\n%s", test.typeExpr, diff)
+ }
+ }
+}
diff --git a/internal/gofix/testdata/src/a/a.go b/internal/gofix/testdata/src/a/a.go
new file mode 100644
index 00000000000..96f4f4d4e13
--- /dev/null
+++ b/internal/gofix/testdata/src/a/a.go
@@ -0,0 +1,195 @@
+package a
+
+import "a/internal"
+
+// Functions.
+
+func f() {
+ One() // want `Call of a.One should be inlined`
+
+ new(T).Two() // want `Call of \(a.T\).Two should be inlined`
+}
+
+type T struct{}
+
+//go:fix inline
+func One() int { return one } // want One:`goFixInline a.One`
+
+const one = 1
+
+//go:fix inline
+func (T) Two() int { return 2 } // want Two:`goFixInline \(a.T\).Two`
+
+// Constants.
+
+const Uno = 1
+
+//go:fix inline
+const In1 = Uno // want In1: `goFixInline const "a".Uno`
+
+const (
+ no1 = one
+
+ //go:fix inline
+ In2 = one // want In2: `goFixInline const "a".one`
+)
+
+//go:fix inline
+const (
+ in3 = one
+ in4 = one
+ bad1 = 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
+)
+
+//go:fix inline
+const in5,
+ in6,
+ bad2 = one, one,
+ one + 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
+
+// Make sure we don't crash on iota consts, but still process the whole decl.
+//
+//go:fix inline
+const (
+ a = iota // want `invalid //go:fix inline directive: const value is iota`
+ b
+ in7 = one
+)
+
+func _() {
+ x := In1 // want `Constant In1 should be inlined`
+ x = In2 // want `Constant In2 should be inlined`
+ x = in3 // want `Constant in3 should be inlined`
+ x = in4 // want `Constant in4 should be inlined`
+ x = in5 // want `Constant in5 should be inlined`
+ x = in6 // want `Constant in6 should be inlined`
+ x = in7 // want `Constant in7 should be inlined`
+ x = no1
+ _ = x
+
+ in1 := 1 // don't inline lvalues
+ _ = in1
+}
+
+const (
+ x = 1
+ //go:fix inline
+ in8 = x
+)
+
+//go:fix inline
+const D = internal.D // want D: `goFixInline const "a/internal".D`
+
+func shadow() {
+ var x int // shadows x at package scope
+
+ //go:fix inline
+ const a = iota // want `invalid //go:fix inline directive: const value is iota`
+
+ const iota = 2
+ // Below this point, iota is an ordinary constant.
+
+ //go:fix inline
+ const b = iota
+
+ x = a // a is defined with the predeclared iota, so it cannot be inlined
+ x = b // want `Constant b should be inlined`
+
+ // Don't offer to inline in8, because the result, "x", would mean something different
+ // in this scope than it does in the scope where in8 is defined.
+ x = in8
+
+ _ = x
+}
+
+// Type aliases
+
+//go:fix inline
+type A = T // want A: `goFixInline alias`
+
+var _ A // want `Type alias A should be inlined`
+
+//go:fix inline
+type AA = // want AA: `goFixInline alias`
+A // want `Type alias A should be inlined`
+
+var _ AA // want `Type alias AA should be inlined`
+
+//go:fix inline
+type (
+ B = []T // want B: `goFixInline alias`
+ C = map[*string][]error // want C: `goFixInline alias`
+)
+
+var _ B // want `Type alias B should be inlined`
+var _ C // want `Type alias C should be inlined`
+
+//go:fix inline
+type E = map[[Uno]string][]*T // want `invalid //go:fix inline directive: array types not supported`
+
+var _ E // nothing should happen here
+
+// literal array lengths are OK
+//
+//go:fix inline
+type EL = map[[2]string][]*T // want EL: `goFixInline alias`
+
+var _ EL // want `Type alias EL should be inlined`
+
+//go:fix inline
+type F = map[internal.T]T // want F: `goFixInline alias`
+
+var _ F // want `Type alias F should be inlined`
+
+//go:fix inline
+type G = []chan *internal.T // want G: `goFixInline alias`
+
+var _ G // want `Type alias G should be inlined`
+
+// local shadowing
+func _() {
+ type string = int
+ const T = 1
+
+ var _ B // nope: B's RHS contains T, which is shadowed
+ var _ C // nope: C's RHS contains string, which is shadowed
+}
+
+// local inlining
+func _[P any]() {
+ const a = 1
+ //go:fix inline
+ const b = a
+
+ x := b // want `Constant b should be inlined`
+
+ //go:fix inline
+ type u = []P
+
+ var y u // want `Type alias u should be inlined`
+
+ _ = x
+ _ = y
+}
+
+// generic type aliases
+
+//go:fix inline
+type (
+ Mapset[T comparable] = map[T]bool // want Mapset: `goFixInline alias`
+ Pair[X, Y any] = struct { // want Pair: `goFixInline alias`
+ X X
+ Y Y
+ }
+)
+
+var _ Mapset[int] // want `Type alias Mapset\[int\] should be inlined`
+
+var _ Pair[T, string] // want `Type alias Pair\[T, string\] should be inlined`
+
+func _[V any]() {
+ //go:fix inline
+ type M[K comparable] = map[K]V
+
+ var _ M[int] // want `Type alias M\[int\] should be inlined`
+}
diff --git a/internal/gofix/testdata/src/a/a.go.golden b/internal/gofix/testdata/src/a/a.go.golden
new file mode 100644
index 00000000000..64d08ec1548
--- /dev/null
+++ b/internal/gofix/testdata/src/a/a.go.golden
@@ -0,0 +1,199 @@
+package a
+
+import "a/internal"
+
+// Functions.
+
+func f() {
+ _ = one // want `Call of a.One should be inlined`
+
+ _ = 2 // want `Call of \(a.T\).Two should be inlined`
+}
+
+type T struct{}
+
+//go:fix inline
+func One() int { return one } // want One:`goFixInline a.One`
+
+const one = 1
+
+//go:fix inline
+func (T) Two() int { return 2 } // want Two:`goFixInline \(a.T\).Two`
+
+// Constants.
+
+const Uno = 1
+
+//go:fix inline
+const In1 = Uno // want In1: `goFixInline const "a".Uno`
+
+const (
+ no1 = one
+
+ //go:fix inline
+ In2 = one // want In2: `goFixInline const "a".one`
+)
+
+//go:fix inline
+const (
+ in3 = one
+ in4 = one
+ bad1 = 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
+)
+
+//go:fix inline
+const in5,
+ in6,
+ bad2 = one, one,
+ one + 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
+
+// Make sure we don't crash on iota consts, but still process the whole decl.
+//
+//go:fix inline
+const (
+ a = iota // want `invalid //go:fix inline directive: const value is iota`
+ b
+ in7 = one
+)
+
+func _() {
+ x := Uno // want `Constant In1 should be inlined`
+ x = one // want `Constant In2 should be inlined`
+ x = one // want `Constant in3 should be inlined`
+ x = one // want `Constant in4 should be inlined`
+ x = one // want `Constant in5 should be inlined`
+ x = one // want `Constant in6 should be inlined`
+ x = one // want `Constant in7 should be inlined`
+ x = no1
+ _ = x
+
+ in1 := 1 // don't inline lvalues
+ _ = in1
+}
+
+const (
+ x = 1
+ //go:fix inline
+ in8 = x
+)
+
+//go:fix inline
+const D = internal.D // want D: `goFixInline const "a/internal".D`
+
+func shadow() {
+ var x int // shadows x at package scope
+
+ //go:fix inline
+ const a = iota // want `invalid //go:fix inline directive: const value is iota`
+
+ const iota = 2
+ // Below this point, iota is an ordinary constant.
+
+ //go:fix inline
+ const b = iota
+
+ x = a // a is defined with the predeclared iota, so it cannot be inlined
+ x = iota // want `Constant b should be inlined`
+
+ // Don't offer to inline in8, because the result, "x", would mean something different
+ // in this scope than it does in the scope where in8 is defined.
+ x = in8
+
+ _ = x
+}
+
+// Type aliases
+
+//go:fix inline
+type A = T // want A: `goFixInline alias`
+
+var _ T // want `Type alias A should be inlined`
+
+//go:fix inline
+type AA = // want AA: `goFixInline alias`
+T // want `Type alias A should be inlined`
+
+var _ A // want `Type alias AA should be inlined`
+
+//go:fix inline
+type (
+ B = []T // want B: `goFixInline alias`
+ C = map[*string][]error // want C: `goFixInline alias`
+)
+
+var _ []T // want `Type alias B should be inlined`
+var _ map[*string][]error // want `Type alias C should be inlined`
+
+//go:fix inline
+type E = map[[Uno]string][]*T // want `invalid //go:fix inline directive: array types not supported`
+
+var _ E // nothing should happen here
+
+// literal array lengths are OK
+//
+//go:fix inline
+type EL = map[[2]string][]*T // want EL: `goFixInline alias`
+
+var _ map[[2]string][]*T // want `Type alias EL should be inlined`
+
+//go:fix inline
+type F = map[internal.T]T // want F: `goFixInline alias`
+
+var _ map[internal.T]T // want `Type alias F should be inlined`
+
+//go:fix inline
+type G = []chan *internal.T // want G: `goFixInline alias`
+
+var _ []chan *internal.T // want `Type alias G should be inlined`
+
+// local shadowing
+func _() {
+ type string = int
+ const T = 1
+
+ var _ B // nope: B's RHS contains T, which is shadowed
+ var _ C // nope: C's RHS contains string, which is shadowed
+}
+
+
+// local inlining
+func _[P any]() {
+ const a = 1
+ //go:fix inline
+ const b = a
+
+ x := a // want `Constant b should be inlined`
+
+ //go:fix inline
+ type u = []P
+
+ var y []P // want `Type alias u should be inlined`
+
+ _ = x
+ _ = y
+}
+
+// generic type aliases
+
+//go:fix inline
+type (
+ Mapset[T comparable] = map[T]bool // want Mapset: `goFixInline alias`
+ Pair[X, Y any] = struct { // want Pair: `goFixInline alias`
+ X X
+ Y Y
+ }
+)
+
+var _ map[int]bool // want `Type alias Mapset\[int\] should be inlined`
+
+var _ struct {
+ X T
+ Y string
+} // want `Type alias Pair\[T, string\] should be inlined`
+
+func _[V any]() {
+ //go:fix inline
+ type M[K comparable] = map[K]V
+
+ var _ map[int]V // want `Type alias M\[int\] should be inlined`
+}
diff --git a/internal/gofix/testdata/src/a/internal/d.go b/internal/gofix/testdata/src/a/internal/d.go
new file mode 100644
index 00000000000..60d0c1ab7e8
--- /dev/null
+++ b/internal/gofix/testdata/src/a/internal/d.go
@@ -0,0 +1,7 @@
+// According to the go toolchain's rule about internal packages,
+// this package is visible to package a, but not package b.
+package internal
+
+const D = 1
+
+type T int
diff --git a/gopls/internal/analysis/gofix/testdata/src/b/b.go b/internal/gofix/testdata/src/b/b.go
similarity index 61%
rename from gopls/internal/analysis/gofix/testdata/src/b/b.go
rename to internal/gofix/testdata/src/b/b.go
index 4bf9f0dc650..b358d7b4f67 100644
--- a/gopls/internal/analysis/gofix/testdata/src/b/b.go
+++ b/internal/gofix/testdata/src/b/b.go
@@ -28,3 +28,12 @@ func g() {
_ = a
_ = x
}
+
+const d = a.D // nope: a.D refers to a constant in a package that is not visible here.
+
+var _ a.A // want `Type alias a\.A should be inlined`
+var _ a.B // want `Type alias a\.B should be inlined`
+var _ a.C // want `Type alias a\.C should be inlined`
+var _ R // want `Type alias R should be inlined`
+
+var _ a.G // nope: a.G refers to a type in a package that is not visible here
diff --git a/gopls/internal/analysis/gofix/testdata/src/b/b.go.golden b/internal/gofix/testdata/src/b/b.go.golden
similarity index 54%
rename from gopls/internal/analysis/gofix/testdata/src/b/b.go.golden
rename to internal/gofix/testdata/src/b/b.go.golden
index b26a05c3046..4de7f09710f 100644
--- a/gopls/internal/analysis/gofix/testdata/src/b/b.go.golden
+++ b/internal/gofix/testdata/src/b/b.go.golden
@@ -2,10 +2,10 @@ package b
import a0 "a"
-import (
- "a"
- . "c"
-)
+import "io"
+
+import "a"
+import . "c"
func f() {
a.One() // want `cannot inline call to a.One because body refers to non-exported one`
@@ -32,3 +32,12 @@ func g() {
_ = a
_ = x
}
+
+const d = a.D // nope: a.D refers to a constant in a package that is not visible here.
+
+var _ a.T // want `Type alias a\.A should be inlined`
+var _ []a.T // want `Type alias a\.B should be inlined`
+var _ map[*string][]error // want `Type alias a\.C should be inlined`
+var _ map[io.Reader]io.Reader // want `Type alias R should be inlined`
+
+var _ a.G // nope: a.G refers to a type in a package that is not visible here
diff --git a/gopls/internal/analysis/gofix/testdata/src/c/c.go b/internal/gofix/testdata/src/c/c.go
similarity index 52%
rename from gopls/internal/analysis/gofix/testdata/src/c/c.go
rename to internal/gofix/testdata/src/c/c.go
index 36504b886a7..7f6a3f26fe2 100644
--- a/gopls/internal/analysis/gofix/testdata/src/c/c.go
+++ b/internal/gofix/testdata/src/c/c.go
@@ -2,4 +2,9 @@ package c
// This package is dot-imported by package b.
+import "io"
+
const C = 1
+
+//go:fix inline
+type R = map[io.Reader]io.Reader
diff --git a/internal/gofix/testdata/src/directive/directive.go b/internal/gofix/testdata/src/directive/directive.go
new file mode 100644
index 00000000000..47c2884c386
--- /dev/null
+++ b/internal/gofix/testdata/src/directive/directive.go
@@ -0,0 +1,63 @@
+package directive
+
+// Functions.
+
+func f() {
+ One()
+
+ new(T).Two()
+}
+
+type T struct{}
+
+//go:fix inline
+func One() int { return one } // want One:`goFixInline directive.One`
+
+const one = 1
+
+//go:fix inline
+func (T) Two() int { return 2 } // want Two:`goFixInline \(directive.T\).Two`
+
+// Constants.
+
+const Uno = 1
+
+//go:fix inline
+const In1 = Uno // want In1: `goFixInline const "directive".Uno`
+
+const (
+ no1 = one
+
+ //go:fix inline
+ In2 = one // want In2: `goFixInline const "directive".one`
+)
+
+//go:fix inline
+const bad1 = 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
+
+//go:fix inline
+const in5,
+ in6,
+ bad2 = one, one,
+ one + 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
+
+// Make sure we don't crash on iota consts, but still process the whole decl.
+//
+//go:fix inline
+const (
+ a = iota // want `invalid //go:fix inline directive: const value is iota`
+ b
+ in7 = one
+)
+
+const (
+ x = 1
+ //go:fix inline
+ in8 = x
+)
+
+//go:fix inline
+const in9 = iota // want `invalid //go:fix inline directive: const value is iota`
+
+//go:fix inline
+type E = map[[Uno]string][]*T // want `invalid //go:fix inline directive: array types not supported`
diff --git a/internal/gofix/testdata/src/directive/directive.go.golden b/internal/gofix/testdata/src/directive/directive.go.golden
new file mode 100644
index 00000000000..a6625e1731f
--- /dev/null
+++ b/internal/gofix/testdata/src/directive/directive.go.golden
@@ -0,0 +1,70 @@
+package golden
+
+import "a/internal"
+
+// Functions.
+
+func f() {
+ One()
+
+ new(T).Two()
+}
+
+type T struct{}
+
+//go:fix inline
+func One() int { return one }
+
+const one = 1
+
+//go:fix inline
+func (T) Two() int { return 2 }
+
+// Constants.
+
+const Uno = 1
+
+//go:fix inline
+const In1 = Uno // want In1: `goFixInline const "a".Uno`
+
+const (
+ no1 = one
+
+ //go:fix inline
+ In2 = one // want In2: `goFixInline const "a".one`
+)
+
+//go:fix inline
+const bad1 = 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
+
+//go:fix inline
+const in5,
+ in6,
+ bad2 = one, one,
+ one + 1 // want `invalid //go:fix inline directive: const value is not the name of another constant`
+
+// Make sure we don't crash on iota consts, but still process the whole decl.
+//
+//go:fix inline
+const (
+ a = iota // want `invalid //go:fix inline directive: const value is iota`
+ b
+ in7 = one
+)
+
+const (
+ x = 1
+ //go:fix inline
+ in8 = x
+)
+
+//go:fix inline
+const a = iota // want `invalid //go:fix inline directive: const value is iota`
+
+//go:fix inline
+type E = map[[Uno]string][]*T // want `invalid //go:fix inline directive: array types not supported`
+
+// literal array lengths are OK
+//
+//go:fix inline
+type EL = map[[2]string][]*T // want EL: `goFixInline alias`
diff --git a/internal/gopathwalk/walk.go b/internal/gopathwalk/walk.go
index 8361515519f..5252144d046 100644
--- a/internal/gopathwalk/walk.go
+++ b/internal/gopathwalk/walk.go
@@ -14,6 +14,7 @@ import (
"os"
"path/filepath"
"runtime"
+ "slices"
"strings"
"sync"
"time"
@@ -22,7 +23,7 @@ import (
// Options controls the behavior of a Walk call.
type Options struct {
// If Logf is non-nil, debug logging is enabled through this function.
- Logf func(format string, args ...interface{})
+ Logf func(format string, args ...any)
// Search module caches. Also disables legacy goimports ignore rules.
ModulesEnabled bool
@@ -81,7 +82,7 @@ func WalkSkip(roots []Root, add func(root Root, dir string), skip func(root Root
// walkDir creates a walker and starts fastwalk with this walker.
func walkDir(root Root, add func(Root, string), skip func(root Root, dir string) bool, opts Options) {
if opts.Logf == nil {
- opts.Logf = func(format string, args ...interface{}) {}
+ opts.Logf = func(format string, args ...any) {}
}
if _, err := os.Stat(root.Path); os.IsNotExist(err) {
opts.Logf("skipping nonexistent directory: %v", root.Path)
@@ -195,10 +196,8 @@ func (w *walker) getIgnoredDirs(path string) []string {
// shouldSkipDir reports whether the file should be skipped or not.
func (w *walker) shouldSkipDir(dir string) bool {
- for _, ignoredDir := range w.ignoredDirs {
- if dir == ignoredDir {
- return true
- }
+ if slices.Contains(w.ignoredDirs, dir) {
+ return true
}
if w.skip != nil {
// Check with the user specified callback.
diff --git a/internal/imports/fix.go b/internal/imports/fix.go
index bf6b0aaddde..89b96381cdc 100644
--- a/internal/imports/fix.go
+++ b/internal/imports/fix.go
@@ -32,6 +32,7 @@ import (
"golang.org/x/tools/internal/gocommand"
"golang.org/x/tools/internal/gopathwalk"
"golang.org/x/tools/internal/stdlib"
+ "maps"
)
// importToGroup is a list of functions which map from an import path to
@@ -559,7 +560,7 @@ func fixImportsDefault(fset *token.FileSet, f *ast.File, filename string, env *P
return err
}
apply(fset, f, fixes)
- return err
+ return nil
}
// getFixes gets the import fixes that need to be made to f in order to fix the imports.
@@ -585,7 +586,7 @@ func getFixesWithSource(ctx context.Context, fset *token.FileSet, f *ast.File, f
srcDir := filepath.Dir(abs)
if logf != nil {
- logf("fixImports(filename=%q), srcDir=%q ...", filename, abs, srcDir)
+ logf("fixImports(filename=%q), srcDir=%q ...", filename, srcDir)
}
// First pass: looking only at f, and using the naive algorithm to
@@ -968,9 +969,7 @@ func (e *ProcessEnv) CopyConfig() *ProcessEnv {
resolver: nil,
Env: map[string]string{},
}
- for k, v := range e.Env {
- copy.Env[k] = v
- }
+ maps.Copy(copy.Env, e.Env)
return copy
}
@@ -1003,9 +1002,7 @@ func (e *ProcessEnv) init() error {
if err := json.Unmarshal(stdout.Bytes(), &goEnv); err != nil {
return err
}
- for k, v := range goEnv {
- e.Env[k] = v
- }
+ maps.Copy(e.Env, goEnv)
e.initialized = true
return nil
}
@@ -1030,7 +1027,7 @@ func (e *ProcessEnv) GetResolver() (Resolver, error) {
//
// For gopls, we can optionally explicitly choose a resolver type, since we
// already know the view type.
- if len(e.Env["GOMOD"]) == 0 && len(e.Env["GOWORK"]) == 0 {
+ if e.Env["GOMOD"] == "" && (e.Env["GOWORK"] == "" || e.Env["GOWORK"] == "off") {
e.resolver = newGopathResolver(e)
e.logf("created gopath resolver")
} else if r, err := newModuleResolver(e, e.ModCache); err != nil {
diff --git a/internal/imports/fix_test.go b/internal/imports/fix_test.go
index 02ddd480dfd..5313956dd63 100644
--- a/internal/imports/fix_test.go
+++ b/internal/imports/fix_test.go
@@ -1680,7 +1680,7 @@ type testConfig struct {
}
// fm is the type for a packagestest.Module's Files, abbreviated for shorter lines.
-type fm map[string]interface{}
+type fm map[string]any
func (c testConfig) test(t *testing.T, fn func(*goimportTest)) {
t.Helper()
@@ -2912,7 +2912,7 @@ func _() {
wg sync.WaitGroup
)
wg.Add(n)
- for i := 0; i < n; i++ {
+ for range n {
go func() {
defer wg.Done()
_, err := t.process("foo.com", "p/first.go", nil, nil)
@@ -2983,7 +2983,7 @@ func TestSymbolSearchStarvation(t *testing.T) {
}
var candidates []pkgDistance
- for i := 0; i < candCount; i++ {
+ for i := range candCount {
name := fmt.Sprintf("bar%d", i)
candidates = append(candidates, pkgDistance{
pkg: &pkg{
diff --git a/internal/imports/mkindex.go b/internal/imports/mkindex.go
index ff006b0cd2e..10e8da5243d 100644
--- a/internal/imports/mkindex.go
+++ b/internal/imports/mkindex.go
@@ -1,5 +1,4 @@
//go:build ignore
-// +build ignore
// Copyright 2013 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
diff --git a/internal/imports/mod.go b/internal/imports/mod.go
index 8555e3f83da..df94ec8186e 100644
--- a/internal/imports/mod.go
+++ b/internal/imports/mod.go
@@ -13,6 +13,7 @@ import (
"path"
"path/filepath"
"regexp"
+ "slices"
"sort"
"strconv"
"strings"
@@ -150,8 +151,8 @@ func newModuleResolver(e *ProcessEnv, moduleCacheCache *DirInfoCache) (*ModuleRe
Path: "",
Dir: filepath.Join(filepath.Dir(goWork), "vendor"),
}
- r.modsByModPath = append(append([]*gocommand.ModuleJSON{}, mainModsVendor...), r.dummyVendorMod)
- r.modsByDir = append(append([]*gocommand.ModuleJSON{}, mainModsVendor...), r.dummyVendorMod)
+ r.modsByModPath = append(slices.Clone(mainModsVendor), r.dummyVendorMod)
+ r.modsByDir = append(slices.Clone(mainModsVendor), r.dummyVendorMod)
}
} else {
// Vendor mode is off, so run go list -m ... to find everything.
diff --git a/internal/imports/mod_cache.go b/internal/imports/mod_cache.go
index b1192696b28..b96c9d4bf71 100644
--- a/internal/imports/mod_cache.go
+++ b/internal/imports/mod_cache.go
@@ -128,7 +128,7 @@ func (d *DirInfoCache) ScanAndListen(ctx context.Context, listener cacheListener
// are going to be. Setting an arbitrary limit makes it much easier.
const maxInFlight = 10
sema := make(chan struct{}, maxInFlight)
- for i := 0; i < maxInFlight; i++ {
+ for range maxInFlight {
sema <- struct{}{}
}
@@ -156,7 +156,7 @@ func (d *DirInfoCache) ScanAndListen(ctx context.Context, listener cacheListener
d.mu.Lock()
delete(d.listeners, cookie)
d.mu.Unlock()
- for i := 0; i < maxInFlight; i++ {
+ for range maxInFlight {
<-sema
}
}
diff --git a/internal/imports/mod_test.go b/internal/imports/mod_test.go
index 890dc1b2e25..2862e84d184 100644
--- a/internal/imports/mod_test.go
+++ b/internal/imports/mod_test.go
@@ -25,6 +25,8 @@ import (
"golang.org/x/tools/internal/proxydir"
"golang.org/x/tools/internal/testenv"
"golang.org/x/tools/txtar"
+ "maps"
+ "slices"
)
// Tests that we can find packages in the stdlib.
@@ -928,12 +930,7 @@ func scanToSlice(resolver Resolver, exclude []gopathwalk.RootType) ([]*pkg, erro
var result []*pkg
filter := &scanCallback{
rootFound: func(root gopathwalk.Root) bool {
- for _, rt := range exclude {
- if root.Type == rt {
- return false
- }
- }
- return true
+ return !slices.Contains(exclude, root.Type)
},
dirFound: func(pkg *pkg) bool {
return true
@@ -1023,9 +1020,7 @@ func setup(t *testing.T, extraEnv map[string]string, main, wd string) *modTest {
WorkingDir: filepath.Join(mainDir, wd),
GocmdRunner: &gocommand.Runner{},
}
- for k, v := range extraEnv {
- env.Env[k] = v
- }
+ maps.Copy(env.Env, extraEnv)
if *testDebug {
env.Logf = log.Printf
}
diff --git a/internal/imports/sortimports.go b/internal/imports/sortimports.go
index da8194fd965..67c17bc4319 100644
--- a/internal/imports/sortimports.go
+++ b/internal/imports/sortimports.go
@@ -11,6 +11,7 @@ import (
"go/ast"
"go/token"
"log"
+ "slices"
"sort"
"strconv"
)
@@ -30,7 +31,7 @@ func sortImports(localPrefix string, tokFile *token.File, f *ast.File) {
if len(d.Specs) == 0 {
// Empty import block, remove it.
- f.Decls = append(f.Decls[:i], f.Decls[i+1:]...)
+ f.Decls = slices.Delete(f.Decls, i, i+1)
}
if !d.Lparen.IsValid() {
@@ -91,7 +92,7 @@ func mergeImports(f *ast.File) {
spec.(*ast.ImportSpec).Path.ValuePos = first.Pos()
first.Specs = append(first.Specs, spec)
}
- f.Decls = append(f.Decls[:i], f.Decls[i+1:]...)
+ f.Decls = slices.Delete(f.Decls, i, i+1)
i--
}
}
diff --git a/internal/jsonrpc2/conn.go b/internal/jsonrpc2/conn.go
index 1d76ef9726b..6e8625208d9 100644
--- a/internal/jsonrpc2/conn.go
+++ b/internal/jsonrpc2/conn.go
@@ -25,12 +25,12 @@ type Conn interface {
// The response will be unmarshaled from JSON into the result.
// The id returned will be unique from this connection, and can be used for
// logging or tracking.
- Call(ctx context.Context, method string, params, result interface{}) (ID, error)
+ Call(ctx context.Context, method string, params, result any) (ID, error)
// Notify invokes the target method but does not wait for a response.
// The params will be marshaled to JSON before sending over the wire, and will
// be handed to the method invoked.
- Notify(ctx context.Context, method string, params interface{}) error
+ Notify(ctx context.Context, method string, params any) error
// Go starts a goroutine to handle the connection.
// It must be called exactly once for each Conn.
@@ -76,7 +76,7 @@ func NewConn(s Stream) Conn {
return conn
}
-func (c *conn) Notify(ctx context.Context, method string, params interface{}) (err error) {
+func (c *conn) Notify(ctx context.Context, method string, params any) (err error) {
notify, err := NewNotification(method, params)
if err != nil {
return fmt.Errorf("marshaling notify parameters: %v", err)
@@ -96,7 +96,7 @@ func (c *conn) Notify(ctx context.Context, method string, params interface{}) (e
return err
}
-func (c *conn) Call(ctx context.Context, method string, params, result interface{}) (_ ID, err error) {
+func (c *conn) Call(ctx context.Context, method string, params, result any) (_ ID, err error) {
// generate a new request identifier
id := ID{number: atomic.AddInt64(&c.seq, 1)}
call, err := NewCall(id, method, params)
@@ -153,7 +153,7 @@ func (c *conn) Call(ctx context.Context, method string, params, result interface
}
func (c *conn) replier(req Request, spanDone func()) Replier {
- return func(ctx context.Context, result interface{}, err error) error {
+ return func(ctx context.Context, result any, err error) error {
defer func() {
recordStatus(ctx, err)
spanDone()
diff --git a/internal/jsonrpc2/handler.go b/internal/jsonrpc2/handler.go
index 27cb108922a..317b94f8ac1 100644
--- a/internal/jsonrpc2/handler.go
+++ b/internal/jsonrpc2/handler.go
@@ -18,7 +18,7 @@ type Handler func(ctx context.Context, reply Replier, req Request) error
// Replier is passed to handlers to allow them to reply to the request.
// If err is set then result will be ignored.
-type Replier func(ctx context.Context, result interface{}, err error) error
+type Replier func(ctx context.Context, result any, err error) error
// MethodNotFound is a Handler that replies to all call requests with the
// standard method not found response.
@@ -32,7 +32,7 @@ func MethodNotFound(ctx context.Context, reply Replier, req Request) error {
func MustReplyHandler(handler Handler) Handler {
return func(ctx context.Context, reply Replier, req Request) error {
called := false
- err := handler(ctx, func(ctx context.Context, result interface{}, err error) error {
+ err := handler(ctx, func(ctx context.Context, result any, err error) error {
if called {
panic(fmt.Errorf("request %q replied to more than once", req.Method()))
}
@@ -59,7 +59,7 @@ func CancelHandler(handler Handler) (Handler, func(id ID)) {
handling[call.ID()] = cancel
mu.Unlock()
innerReply := reply
- reply = func(ctx context.Context, result interface{}, err error) error {
+ reply = func(ctx context.Context, result any, err error) error {
mu.Lock()
delete(handling, call.ID())
mu.Unlock()
@@ -92,7 +92,7 @@ func AsyncHandler(handler Handler) Handler {
nextRequest = make(chan struct{})
releaser := &releaser{ch: nextRequest}
innerReply := reply
- reply = func(ctx context.Context, result interface{}, err error) error {
+ reply = func(ctx context.Context, result any, err error) error {
releaser.release(true)
return innerReply(ctx, result, err)
}
diff --git a/internal/jsonrpc2/jsonrpc2_test.go b/internal/jsonrpc2/jsonrpc2_test.go
index f62977edfce..b7688bc2334 100644
--- a/internal/jsonrpc2/jsonrpc2_test.go
+++ b/internal/jsonrpc2/jsonrpc2_test.go
@@ -23,8 +23,8 @@ var logRPC = flag.Bool("logrpc", false, "Enable jsonrpc2 communication logging")
type callTest struct {
method string
- params interface{}
- expect interface{}
+ params any
+ expect any
}
var callTests = []callTest{
@@ -35,10 +35,10 @@ var callTests = []callTest{
//TODO: expand the test cases
}
-func (test *callTest) newResults() interface{} {
+func (test *callTest) newResults() any {
switch e := test.expect.(type) {
- case []interface{}:
- var r []interface{}
+ case []any:
+ var r []any
for _, v := range e {
r = append(r, reflect.New(reflect.TypeOf(v)).Interface())
}
@@ -50,7 +50,7 @@ func (test *callTest) newResults() interface{} {
}
}
-func (test *callTest) verifyResults(t *testing.T, results interface{}) {
+func (test *callTest) verifyResults(t *testing.T, results any) {
if results == nil {
return
}
diff --git a/internal/jsonrpc2/messages.go b/internal/jsonrpc2/messages.go
index e87d772f398..5078b88f4ae 100644
--- a/internal/jsonrpc2/messages.go
+++ b/internal/jsonrpc2/messages.go
@@ -65,7 +65,7 @@ type Response struct {
// NewNotification constructs a new Notification message for the supplied
// method and parameters.
-func NewNotification(method string, params interface{}) (*Notification, error) {
+func NewNotification(method string, params any) (*Notification, error) {
p, merr := marshalToRaw(params)
return &Notification{method: method, params: p}, merr
}
@@ -98,7 +98,7 @@ func (n *Notification) UnmarshalJSON(data []byte) error {
// NewCall constructs a new Call message for the supplied ID, method and
// parameters.
-func NewCall(id ID, method string, params interface{}) (*Call, error) {
+func NewCall(id ID, method string, params any) (*Call, error) {
p, merr := marshalToRaw(params)
return &Call{id: id, method: method, params: p}, merr
}
@@ -135,7 +135,7 @@ func (c *Call) UnmarshalJSON(data []byte) error {
// NewResponse constructs a new Response message that is a reply to the
// supplied. If err is set result may be ignored.
-func NewResponse(id ID, result interface{}, err error) (*Response, error) {
+func NewResponse(id ID, result any, err error) (*Response, error) {
r, merr := marshalToRaw(result)
return &Response{id: id, result: r, err: err}, merr
}
@@ -229,7 +229,7 @@ func DecodeMessage(data []byte) (Message, error) {
return call, nil
}
-func marshalToRaw(obj interface{}) (json.RawMessage, error) {
+func marshalToRaw(obj any) (json.RawMessage, error) {
data, err := json.Marshal(obj)
if err != nil {
return json.RawMessage{}, err
diff --git a/internal/jsonrpc2_v2/conn.go b/internal/jsonrpc2_v2/conn.go
index df885bfa4c3..4c52a1fd34b 100644
--- a/internal/jsonrpc2_v2/conn.go
+++ b/internal/jsonrpc2_v2/conn.go
@@ -260,7 +260,7 @@ func newConnection(bindCtx context.Context, rwc io.ReadWriteCloser, binder Binde
// Notify invokes the target method but does not wait for a response.
// The params will be marshaled to JSON before sending over the wire, and will
// be handed to the method invoked.
-func (c *Connection) Notify(ctx context.Context, method string, params interface{}) (err error) {
+func (c *Connection) Notify(ctx context.Context, method string, params any) (err error) {
ctx, done := event.Start(ctx, method,
jsonrpc2.Method.Of(method),
jsonrpc2.RPCDirection.Of(jsonrpc2.Outbound),
@@ -309,7 +309,7 @@ func (c *Connection) Notify(ctx context.Context, method string, params interface
// be handed to the method invoked.
// You do not have to wait for the response, it can just be ignored if not needed.
// If sending the call failed, the response will be ready and have the error in it.
-func (c *Connection) Call(ctx context.Context, method string, params interface{}) *AsyncCall {
+func (c *Connection) Call(ctx context.Context, method string, params any) *AsyncCall {
// Generate a new request identifier.
id := Int64ID(atomic.AddInt64(&c.seq, 1))
ctx, endSpan := event.Start(ctx, method,
@@ -410,7 +410,7 @@ func (ac *AsyncCall) retire(response *Response) {
// Await waits for (and decodes) the results of a Call.
// The response will be unmarshaled from JSON into the result.
-func (ac *AsyncCall) Await(ctx context.Context, result interface{}) error {
+func (ac *AsyncCall) Await(ctx context.Context, result any) error {
select {
case <-ctx.Done():
return ctx.Err()
@@ -429,7 +429,7 @@ func (ac *AsyncCall) Await(ctx context.Context, result interface{}) error {
//
// Respond must be called exactly once for any message for which a handler
// returns ErrAsyncResponse. It must not be called for any other message.
-func (c *Connection) Respond(id ID, result interface{}, err error) error {
+func (c *Connection) Respond(id ID, result any, err error) error {
var req *incomingRequest
c.updateInFlight(func(s *inFlightState) {
req = s.incomingByID[id]
@@ -678,7 +678,7 @@ func (c *Connection) handleAsync() {
}
// processResult processes the result of a request and, if appropriate, sends a response.
-func (c *Connection) processResult(from interface{}, req *incomingRequest, result interface{}, err error) error {
+func (c *Connection) processResult(from any, req *incomingRequest, result any, err error) error {
switch err {
case ErrAsyncResponse:
if !req.IsCall() {
@@ -781,7 +781,7 @@ func (c *Connection) write(ctx context.Context, msg Message) error {
// internalErrorf reports an internal error. By default it panics, but if
// c.onInternalError is non-nil it instead calls that and returns an error
// wrapping ErrInternal.
-func (c *Connection) internalErrorf(format string, args ...interface{}) error {
+func (c *Connection) internalErrorf(format string, args ...any) error {
err := fmt.Errorf(format, args...)
if c.onInternalError == nil {
panic("jsonrpc2: " + err.Error())
@@ -803,7 +803,7 @@ func labelStatus(ctx context.Context, err error) {
// notDone is a context.Context wrapper that returns a nil Done channel.
type notDone struct{ ctx context.Context }
-func (ic notDone) Value(key interface{}) interface{} {
+func (ic notDone) Value(key any) any {
return ic.ctx.Value(key)
}
diff --git a/internal/jsonrpc2_v2/jsonrpc2.go b/internal/jsonrpc2_v2/jsonrpc2.go
index 9d775de0603..270f4f341d8 100644
--- a/internal/jsonrpc2_v2/jsonrpc2.go
+++ b/internal/jsonrpc2_v2/jsonrpc2.go
@@ -44,13 +44,13 @@ type Preempter interface {
// Otherwise, the result and error are processed as if returned by Handle.
//
// Preempt must not block. (The Context passed to it is for Values only.)
- Preempt(ctx context.Context, req *Request) (result interface{}, err error)
+ Preempt(ctx context.Context, req *Request) (result any, err error)
}
// A PreempterFunc implements the Preempter interface for a standalone Preempt function.
-type PreempterFunc func(ctx context.Context, req *Request) (interface{}, error)
+type PreempterFunc func(ctx context.Context, req *Request) (any, error)
-func (f PreempterFunc) Preempt(ctx context.Context, req *Request) (interface{}, error) {
+func (f PreempterFunc) Preempt(ctx context.Context, req *Request) (any, error) {
return f(ctx, req)
}
@@ -71,23 +71,23 @@ type Handler interface {
// connection is broken or the request is canceled or completed.
// (If Handle returns ErrAsyncResponse, ctx will remain uncanceled
// until either Cancel or Respond is called for the request's ID.)
- Handle(ctx context.Context, req *Request) (result interface{}, err error)
+ Handle(ctx context.Context, req *Request) (result any, err error)
}
type defaultHandler struct{}
-func (defaultHandler) Preempt(context.Context, *Request) (interface{}, error) {
+func (defaultHandler) Preempt(context.Context, *Request) (any, error) {
return nil, ErrNotHandled
}
-func (defaultHandler) Handle(context.Context, *Request) (interface{}, error) {
+func (defaultHandler) Handle(context.Context, *Request) (any, error) {
return nil, ErrNotHandled
}
// A HandlerFunc implements the Handler interface for a standalone Handle function.
-type HandlerFunc func(ctx context.Context, req *Request) (interface{}, error)
+type HandlerFunc func(ctx context.Context, req *Request) (any, error)
-func (f HandlerFunc) Handle(ctx context.Context, req *Request) (interface{}, error) {
+func (f HandlerFunc) Handle(ctx context.Context, req *Request) (any, error) {
return f(ctx, req)
}
diff --git a/internal/jsonrpc2_v2/jsonrpc2_test.go b/internal/jsonrpc2_v2/jsonrpc2_test.go
index d75a20739e8..e42f63736c0 100644
--- a/internal/jsonrpc2_v2/jsonrpc2_test.go
+++ b/internal/jsonrpc2_v2/jsonrpc2_test.go
@@ -87,24 +87,24 @@ type invoker interface {
type notify struct {
method string
- params interface{}
+ params any
}
type call struct {
method string
- params interface{}
- expect interface{}
+ params any
+ expect any
}
type async struct {
name string
method string
- params interface{}
+ params any
}
type collect struct {
name string
- expect interface{}
+ expect any
fails bool
}
@@ -180,7 +180,7 @@ func (test call) Invoke(t *testing.T, ctx context.Context, h *handler) {
func (test echo) Invoke(t *testing.T, ctx context.Context, h *handler) {
results := newResults(test.expect)
- if err := h.conn.Call(ctx, "echo", []interface{}{test.method, test.params}).Await(ctx, results); err != nil {
+ if err := h.conn.Call(ctx, "echo", []any{test.method, test.params}).Await(ctx, results); err != nil {
t.Fatalf("%v:Echo failed: %v", test.method, err)
}
verifyResults(t, test.method, results, test.expect)
@@ -221,10 +221,10 @@ func (test sequence) Invoke(t *testing.T, ctx context.Context, h *handler) {
}
// newResults makes a new empty copy of the expected type to put the results into
-func newResults(expect interface{}) interface{} {
+func newResults(expect any) any {
switch e := expect.(type) {
- case []interface{}:
- var r []interface{}
+ case []any:
+ var r []any
for _, v := range e {
r = append(r, reflect.New(reflect.TypeOf(v)).Interface())
}
@@ -237,7 +237,7 @@ func newResults(expect interface{}) interface{} {
}
// verifyResults compares the results to the expected values
-func verifyResults(t *testing.T, method string, results interface{}, expect interface{}) {
+func verifyResults(t *testing.T, method string, results any, expect any) {
if expect == nil {
if results != nil {
t.Errorf("%v:Got results %+v where none expected", method, expect)
@@ -278,7 +278,7 @@ func (h *handler) waiter(name string) chan struct{} {
return waiter
}
-func (h *handler) Preempt(ctx context.Context, req *jsonrpc2.Request) (interface{}, error) {
+func (h *handler) Preempt(ctx context.Context, req *jsonrpc2.Request) (any, error) {
switch req.Method {
case "unblock":
var name string
@@ -304,7 +304,7 @@ func (h *handler) Preempt(ctx context.Context, req *jsonrpc2.Request) (interface
}
}
-func (h *handler) Handle(ctx context.Context, req *jsonrpc2.Request) (interface{}, error) {
+func (h *handler) Handle(ctx context.Context, req *jsonrpc2.Request) (any, error) {
switch req.Method {
case "no_args":
if len(req.Params) > 0 {
@@ -349,11 +349,11 @@ func (h *handler) Handle(ctx context.Context, req *jsonrpc2.Request) (interface{
}
return path.Join(v...), nil
case "echo":
- var v []interface{}
+ var v []any
if err := json.Unmarshal(req.Params, &v); err != nil {
return nil, fmt.Errorf("%w: %s", jsonrpc2.ErrParse, err)
}
- var result interface{}
+ var result any
err := h.conn.Call(ctx, v[0].(string), v[1]).Await(ctx, &result)
return result, err
case "wait":
diff --git a/internal/jsonrpc2_v2/messages.go b/internal/jsonrpc2_v2/messages.go
index f02b879c3f2..9cfe6e70fe5 100644
--- a/internal/jsonrpc2_v2/messages.go
+++ b/internal/jsonrpc2_v2/messages.go
@@ -12,7 +12,7 @@ import (
// ID is a Request identifier.
type ID struct {
- value interface{}
+ value any
}
// Message is the interface to all jsonrpc2 message types.
@@ -59,18 +59,18 @@ func Int64ID(i int64) ID { return ID{value: i} }
func (id ID) IsValid() bool { return id.value != nil }
// Raw returns the underlying value of the ID.
-func (id ID) Raw() interface{} { return id.value }
+func (id ID) Raw() any { return id.value }
// NewNotification constructs a new Notification message for the supplied
// method and parameters.
-func NewNotification(method string, params interface{}) (*Request, error) {
+func NewNotification(method string, params any) (*Request, error) {
p, merr := marshalToRaw(params)
return &Request{Method: method, Params: p}, merr
}
// NewCall constructs a new Call message for the supplied ID, method and
// parameters.
-func NewCall(id ID, method string, params interface{}) (*Request, error) {
+func NewCall(id ID, method string, params any) (*Request, error) {
p, merr := marshalToRaw(params)
return &Request{ID: id, Method: method, Params: p}, merr
}
@@ -85,7 +85,7 @@ func (msg *Request) marshal(to *wireCombined) {
// NewResponse constructs a new Response message that is a reply to the
// supplied. If err is set result may be ignored.
-func NewResponse(id ID, result interface{}, rerr error) (*Response, error) {
+func NewResponse(id ID, result any, rerr error) (*Response, error) {
r, merr := marshalToRaw(result)
return &Response{ID: id, Result: r, Error: rerr}, merr
}
@@ -169,7 +169,7 @@ func DecodeMessage(data []byte) (Message, error) {
return resp, nil
}
-func marshalToRaw(obj interface{}) (json.RawMessage, error) {
+func marshalToRaw(obj any) (json.RawMessage, error) {
if obj == nil {
return nil, nil
}
diff --git a/internal/jsonrpc2_v2/serve_go116.go b/internal/jsonrpc2_v2/serve_go116.go
index 2dac7413f31..19114502d1c 100644
--- a/internal/jsonrpc2_v2/serve_go116.go
+++ b/internal/jsonrpc2_v2/serve_go116.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build go1.16
-// +build go1.16
package jsonrpc2
diff --git a/internal/jsonrpc2_v2/serve_pre116.go b/internal/jsonrpc2_v2/serve_pre116.go
index ef5477fecb9..9e8ece2ea7b 100644
--- a/internal/jsonrpc2_v2/serve_pre116.go
+++ b/internal/jsonrpc2_v2/serve_pre116.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build !go1.16
-// +build !go1.16
package jsonrpc2
diff --git a/internal/jsonrpc2_v2/serve_test.go b/internal/jsonrpc2_v2/serve_test.go
index c5c41e201cd..8eb572c9d01 100644
--- a/internal/jsonrpc2_v2/serve_test.go
+++ b/internal/jsonrpc2_v2/serve_test.go
@@ -148,7 +148,7 @@ type msg struct {
type fakeHandler struct{}
-func (fakeHandler) Handle(ctx context.Context, req *jsonrpc2.Request) (interface{}, error) {
+func (fakeHandler) Handle(ctx context.Context, req *jsonrpc2.Request) (any, error) {
switch req.Method {
case "ping":
return &msg{"pong"}, nil
@@ -296,7 +296,7 @@ func TestCloseCallRace(t *testing.T) {
pokec := make(chan *jsonrpc2.AsyncCall, 1)
s := jsonrpc2.NewServer(ctx, listener, jsonrpc2.BinderFunc(func(_ context.Context, srvConn *jsonrpc2.Connection) jsonrpc2.ConnectionOptions {
- h := jsonrpc2.HandlerFunc(func(ctx context.Context, _ *jsonrpc2.Request) (interface{}, error) {
+ h := jsonrpc2.HandlerFunc(func(ctx context.Context, _ *jsonrpc2.Request) (any, error) {
// Start a concurrent call from the server to the client.
// The point of this test is to ensure this doesn't deadlock
// if the client shuts down the connection concurrently.
diff --git a/internal/jsonrpc2_v2/wire.go b/internal/jsonrpc2_v2/wire.go
index 8f60fc62766..bc56951b5c3 100644
--- a/internal/jsonrpc2_v2/wire.go
+++ b/internal/jsonrpc2_v2/wire.go
@@ -45,7 +45,7 @@ const wireVersion = "2.0"
// We can decode this and then work out which it is.
type wireCombined struct {
VersionTag string `json:"jsonrpc"`
- ID interface{} `json:"id,omitempty"`
+ ID any `json:"id,omitempty"`
Method string `json:"method,omitempty"`
Params json.RawMessage `json:"params,omitempty"`
Result json.RawMessage `json:"result,omitempty"`
diff --git a/internal/jsonrpc2_v2/wire_test.go b/internal/jsonrpc2_v2/wire_test.go
index e9337373239..c155c92f287 100644
--- a/internal/jsonrpc2_v2/wire_test.go
+++ b/internal/jsonrpc2_v2/wire_test.go
@@ -63,7 +63,7 @@ func TestWireMessage(t *testing.T) {
}
}
-func newNotification(method string, params interface{}) jsonrpc2.Message {
+func newNotification(method string, params any) jsonrpc2.Message {
msg, err := jsonrpc2.NewNotification(method, params)
if err != nil {
panic(err)
@@ -71,7 +71,7 @@ func newNotification(method string, params interface{}) jsonrpc2.Message {
return msg
}
-func newID(id interface{}) jsonrpc2.ID {
+func newID(id any) jsonrpc2.ID {
switch v := id.(type) {
case nil:
return jsonrpc2.ID{}
@@ -86,7 +86,7 @@ func newID(id interface{}) jsonrpc2.ID {
}
}
-func newCall(id interface{}, method string, params interface{}) jsonrpc2.Message {
+func newCall(id any, method string, params any) jsonrpc2.Message {
msg, err := jsonrpc2.NewCall(newID(id), method, params)
if err != nil {
panic(err)
@@ -94,7 +94,7 @@ func newCall(id interface{}, method string, params interface{}) jsonrpc2.Message
return msg
}
-func newResponse(id interface{}, result interface{}, rerr error) jsonrpc2.Message {
+func newResponse(id any, result any, rerr error) jsonrpc2.Message {
msg, err := jsonrpc2.NewResponse(newID(id), result, rerr)
if err != nil {
panic(err)
diff --git a/internal/memoize/memoize.go b/internal/memoize/memoize.go
index e56af3bb45b..e49942a8827 100644
--- a/internal/memoize/memoize.go
+++ b/internal/memoize/memoize.go
@@ -42,7 +42,7 @@ import (
// The main purpose of the argument is to avoid the Function closure
// needing to retain large objects (in practice: the snapshot) in
// memory that can be supplied at call time by any caller.
-type Function func(ctx context.Context, arg interface{}) interface{}
+type Function func(ctx context.Context, arg any) any
// A RefCounted is a value whose functional lifetime is determined by
// reference counting.
@@ -94,7 +94,7 @@ type Promise struct {
// the function that will be used to populate the value
function Function
// value is set in completed state.
- value interface{}
+ value any
}
// NewPromise returns a promise for the future result of calling the
@@ -124,7 +124,7 @@ const (
//
// It will never cause the value to be generated.
// It will return the cached value, if present.
-func (p *Promise) Cached() interface{} {
+func (p *Promise) Cached() any {
p.mu.Lock()
defer p.mu.Unlock()
if p.state == stateCompleted {
@@ -144,7 +144,7 @@ func (p *Promise) Cached() interface{} {
// If all concurrent calls to Get are cancelled, the context provided
// to the function is cancelled. A later call to Get may attempt to
// call the function again.
-func (p *Promise) Get(ctx context.Context, arg interface{}) (interface{}, error) {
+func (p *Promise) Get(ctx context.Context, arg any) (any, error) {
if ctx.Err() != nil {
return nil, ctx.Err()
}
@@ -163,7 +163,7 @@ func (p *Promise) Get(ctx context.Context, arg interface{}) (interface{}, error)
}
// run starts p.function and returns the result. p.mu must be locked.
-func (p *Promise) run(ctx context.Context, arg interface{}) (interface{}, error) {
+func (p *Promise) run(ctx context.Context, arg any) (any, error) {
childCtx, cancel := context.WithCancel(xcontext.Detach(ctx))
p.cancel = cancel
p.state = stateRunning
@@ -210,7 +210,7 @@ func (p *Promise) run(ctx context.Context, arg interface{}) (interface{}, error)
}
// wait waits for the value to be computed, or ctx to be cancelled. p.mu must be locked.
-func (p *Promise) wait(ctx context.Context) (interface{}, error) {
+func (p *Promise) wait(ctx context.Context) (any, error) {
p.waiters++
done := p.done
p.mu.Unlock()
@@ -258,7 +258,7 @@ type Store struct {
evictionPolicy EvictionPolicy
promisesMu sync.Mutex
- promises map[interface{}]*Promise
+ promises map[any]*Promise
}
// NewStore creates a new store with the given eviction policy.
@@ -276,13 +276,13 @@ func NewStore(policy EvictionPolicy) *Store {
//
// Once the last reference has been released, the promise is removed from the
// store.
-func (store *Store) Promise(key interface{}, function Function) (*Promise, func()) {
+func (store *Store) Promise(key any, function Function) (*Promise, func()) {
store.promisesMu.Lock()
p, ok := store.promises[key]
if !ok {
p = NewPromise(reflect.TypeOf(key).String(), function)
if store.promises == nil {
- store.promises = map[interface{}]*Promise{}
+ store.promises = map[any]*Promise{}
}
store.promises[key] = p
}
@@ -323,7 +323,7 @@ func (s *Store) Stats() map[reflect.Type]int {
// DebugOnlyIterate iterates through the store and, for each completed
// promise, calls f(k, v) for the map key k and function result v. It
// should only be used for debugging purposes.
-func (s *Store) DebugOnlyIterate(f func(k, v interface{})) {
+func (s *Store) DebugOnlyIterate(f func(k, v any)) {
s.promisesMu.Lock()
defer s.promisesMu.Unlock()
diff --git a/internal/memoize/memoize_test.go b/internal/memoize/memoize_test.go
index c54572d59ca..08b097eb081 100644
--- a/internal/memoize/memoize_test.go
+++ b/internal/memoize/memoize_test.go
@@ -18,7 +18,7 @@ func TestGet(t *testing.T) {
evaled := 0
- h, release := store.Promise("key", func(context.Context, interface{}) interface{} {
+ h, release := store.Promise("key", func(context.Context, any) any {
evaled++
return "res"
})
@@ -30,7 +30,7 @@ func TestGet(t *testing.T) {
}
}
-func expectGet(t *testing.T, h *memoize.Promise, wantV interface{}) {
+func expectGet(t *testing.T, h *memoize.Promise, wantV any) {
t.Helper()
gotV, gotErr := h.Get(context.Background(), nil)
if gotV != wantV || gotErr != nil {
@@ -40,7 +40,7 @@ func expectGet(t *testing.T, h *memoize.Promise, wantV interface{}) {
func TestNewPromise(t *testing.T) {
calls := 0
- f := func(context.Context, interface{}) interface{} {
+ f := func(context.Context, any) any {
calls++
return calls
}
@@ -63,10 +63,10 @@ func TestStoredPromiseRefCounting(t *testing.T) {
var store memoize.Store
v1 := false
v2 := false
- p1, release1 := store.Promise("key1", func(context.Context, interface{}) interface{} {
+ p1, release1 := store.Promise("key1", func(context.Context, any) any {
return &v1
})
- p2, release2 := store.Promise("key2", func(context.Context, interface{}) interface{} {
+ p2, release2 := store.Promise("key2", func(context.Context, any) any {
return &v2
})
expectGet(t, p1, &v1)
@@ -75,7 +75,7 @@ func TestStoredPromiseRefCounting(t *testing.T) {
expectGet(t, p1, &v1)
expectGet(t, p2, &v2)
- p2Copy, release2Copy := store.Promise("key2", func(context.Context, interface{}) interface{} {
+ p2Copy, release2Copy := store.Promise("key2", func(context.Context, any) any {
return &v1
})
if p2 != p2Copy {
@@ -93,7 +93,7 @@ func TestStoredPromiseRefCounting(t *testing.T) {
}
release1()
- p2Copy, release2Copy = store.Promise("key2", func(context.Context, interface{}) interface{} {
+ p2Copy, release2Copy = store.Promise("key2", func(context.Context, any) any {
return &v2
})
if p2 == p2Copy {
@@ -109,7 +109,7 @@ func TestPromiseDestroyedWhileRunning(t *testing.T) {
c := make(chan int)
var v int
- h, release := store.Promise("key", func(ctx context.Context, _ interface{}) interface{} {
+ h, release := store.Promise("key", func(ctx context.Context, _ any) any {
<-c
<-c
if err := ctx.Err(); err != nil {
@@ -123,7 +123,7 @@ func TestPromiseDestroyedWhileRunning(t *testing.T) {
var wg sync.WaitGroup
wg.Add(1)
- var got interface{}
+ var got any
var err error
go func() {
got, err = h.Get(ctx, nil)
@@ -146,7 +146,7 @@ func TestPromiseDestroyedWhileRunning(t *testing.T) {
func TestDoubleReleasePanics(t *testing.T) {
var store memoize.Store
- _, release := store.Promise("key", func(ctx context.Context, _ interface{}) interface{} { return 0 })
+ _, release := store.Promise("key", func(ctx context.Context, _ any) any { return 0 })
panicked := false
diff --git a/internal/modindex/lookup.go b/internal/modindex/lookup.go
index 5499c5c67f3..bd605e0d763 100644
--- a/internal/modindex/lookup.go
+++ b/internal/modindex/lookup.go
@@ -120,7 +120,7 @@ func (ix *Index) Lookup(pkg, name string, prefix bool) []Candidate {
px.Results = int16(n)
if len(flds) >= 4 {
sig := strings.Split(flds[3], " ")
- for i := 0; i < len(sig); i++ {
+ for i := range sig {
// $ cannot otherwise occur. removing the spaces
// almost works, but for chan struct{}, e.g.
sig[i] = strings.Replace(sig[i], "$", " ", -1)
@@ -136,7 +136,7 @@ func (ix *Index) Lookup(pkg, name string, prefix bool) []Candidate {
func toFields(sig []string) []Field {
ans := make([]Field, len(sig)/2)
- for i := 0; i < len(ans); i++ {
+ for i := range ans {
ans[i] = Field{Arg: sig[2*i], Type: sig[2*i+1]}
}
return ans
diff --git a/internal/packagesinternal/packages.go b/internal/packagesinternal/packages.go
index 784605914e0..25ebab663ba 100644
--- a/internal/packagesinternal/packages.go
+++ b/internal/packagesinternal/packages.go
@@ -17,4 +17,4 @@ var TypecheckCgo int
var DepsErrors int // must be set as a LoadMode to call GetDepsErrors
var SetModFlag = func(config any, value string) {}
-var SetModFile = func(config interface{}, value string) {}
+var SetModFile = func(config any, value string) {}
diff --git a/internal/packagestest/expect.go b/internal/packagestest/expect.go
index e3e3509579d..a5f76f55686 100644
--- a/internal/packagestest/expect.go
+++ b/internal/packagestest/expect.go
@@ -72,7 +72,7 @@ const (
//
// It is safe to call this repeatedly with different method sets, but it is
// not safe to call it concurrently.
-func (e *Exported) Expect(methods map[string]interface{}) error {
+func (e *Exported) Expect(methods map[string]any) error {
if err := e.getNotes(); err != nil {
return err
}
@@ -98,7 +98,7 @@ func (e *Exported) Expect(methods map[string]interface{}) error {
n = &expect.Note{
Pos: n.Pos,
Name: markMethod,
- Args: []interface{}{n.Name, n.Name},
+ Args: []any{n.Name, n.Name},
}
}
mi, ok := ms[n.Name]
@@ -222,7 +222,7 @@ func (e *Exported) getMarkers() error {
}
// set markers early so that we don't call getMarkers again from Expect
e.markers = make(map[string]Range)
- return e.Expect(map[string]interface{}{
+ return e.Expect(map[string]any{
markMethod: e.Mark,
})
}
@@ -243,7 +243,7 @@ var (
// It takes the args remaining, and returns the args it did not consume.
// This allows a converter to consume 0 args for well known types, or multiple
// args for compound types.
-type converter func(*expect.Note, []interface{}) (reflect.Value, []interface{}, error)
+type converter func(*expect.Note, []any) (reflect.Value, []any, error)
// method is used to track information about Invoke methods that is expensive to
// calculate so that we can work it out once rather than per marker.
@@ -259,19 +259,19 @@ type method struct {
func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
switch {
case pt == noteType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
return reflect.ValueOf(n), args, nil
}, nil
case pt == fsetType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
return reflect.ValueOf(e.ExpectFileSet), args, nil
}, nil
case pt == exportedType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
return reflect.ValueOf(e), args, nil
}, nil
case pt == posType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
r, remains, err := e.rangeConverter(n, args)
if err != nil {
return reflect.Value{}, nil, err
@@ -279,7 +279,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
return reflect.ValueOf(r.Start), remains, nil
}, nil
case pt == positionType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
r, remains, err := e.rangeConverter(n, args)
if err != nil {
return reflect.Value{}, nil, err
@@ -287,7 +287,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
return reflect.ValueOf(e.ExpectFileSet.Position(r.Start)), remains, nil
}, nil
case pt == rangeType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
r, remains, err := e.rangeConverter(n, args)
if err != nil {
return reflect.Value{}, nil, err
@@ -295,7 +295,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
return reflect.ValueOf(r), remains, nil
}, nil
case pt == identifierType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -310,7 +310,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}, nil
case pt == regexType:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -323,7 +323,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}, nil
case pt.Kind() == reflect.String:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -339,7 +339,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}
}, nil
case pt.Kind() == reflect.Int64:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -353,7 +353,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}
}, nil
case pt.Kind() == reflect.Bool:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -366,7 +366,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
return reflect.ValueOf(b), args, nil
}, nil
case pt.Kind() == reflect.Slice:
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
converter, err := e.buildConverter(pt.Elem())
if err != nil {
return reflect.Value{}, nil, err
@@ -384,7 +384,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}, nil
default:
if pt.Kind() == reflect.Interface && pt.NumMethod() == 0 {
- return func(n *expect.Note, args []interface{}) (reflect.Value, []interface{}, error) {
+ return func(n *expect.Note, args []any) (reflect.Value, []any, error) {
if len(args) < 1 {
return reflect.Value{}, nil, fmt.Errorf("missing argument")
}
@@ -395,7 +395,7 @@ func (e *Exported) buildConverter(pt reflect.Type) (converter, error) {
}
}
-func (e *Exported) rangeConverter(n *expect.Note, args []interface{}) (Range, []interface{}, error) {
+func (e *Exported) rangeConverter(n *expect.Note, args []any) (Range, []any, error) {
tokFile := e.ExpectFileSet.File(n.Pos)
if len(args) < 1 {
return Range{}, nil, fmt.Errorf("missing argument")
diff --git a/internal/packagestest/expect_test.go b/internal/packagestest/expect_test.go
index d155f5fe9e2..4f148b4183e 100644
--- a/internal/packagestest/expect_test.go
+++ b/internal/packagestest/expect_test.go
@@ -19,7 +19,7 @@ func TestExpect(t *testing.T) {
}})
defer exported.Cleanup()
checkCount := 0
- if err := exported.Expect(map[string]interface{}{
+ if err := exported.Expect(map[string]any{
"check": func(src, target token.Position) {
checkCount++
},
diff --git a/internal/packagestest/export.go b/internal/packagestest/export.go
index f8d10718c09..4dd2b331736 100644
--- a/internal/packagestest/export.go
+++ b/internal/packagestest/export.go
@@ -97,7 +97,7 @@ type Module struct {
// The keys are the file fragment that follows the module name, the value can
// be a string or byte slice, in which case it is the contents of the
// file, otherwise it must be a Writer function.
- Files map[string]interface{}
+ Files map[string]any
// Overlay is the set of source file overlays for the module.
// The keys are the file fragment as in the Files configuration.
@@ -155,7 +155,6 @@ var All = []Exporter{GOPATH, Modules}
func TestAll(t *testing.T, f func(*testing.T, Exporter)) {
t.Helper()
for _, e := range All {
- e := e // in case f calls t.Parallel
t.Run(e.Name(), func(t *testing.T) {
t.Helper()
f(t, e)
@@ -169,7 +168,6 @@ func TestAll(t *testing.T, f func(*testing.T, Exporter)) {
func BenchmarkAll(b *testing.B, f func(*testing.B, Exporter)) {
b.Helper()
for _, e := range All {
- e := e // in case f calls t.Parallel
b.Run(e.Name(), func(b *testing.B) {
b.Helper()
f(b, e)
@@ -479,7 +477,7 @@ func GroupFilesByModules(root string) ([]Module, error) {
primarymod := &Module{
Name: root,
- Files: make(map[string]interface{}),
+ Files: make(map[string]any),
Overlay: make(map[string][]byte),
}
mods := map[string]*Module{
@@ -569,7 +567,7 @@ func GroupFilesByModules(root string) ([]Module, error) {
}
mods[path] = &Module{
Name: filepath.ToSlash(module),
- Files: make(map[string]interface{}),
+ Files: make(map[string]any),
Overlay: make(map[string][]byte),
}
currentModule = path
@@ -587,8 +585,8 @@ func GroupFilesByModules(root string) ([]Module, error) {
// This is to enable the common case in tests where you have a full copy of the
// package in your testdata.
// This will panic if there is any kind of error trying to walk the file tree.
-func MustCopyFileTree(root string) map[string]interface{} {
- result := map[string]interface{}{}
+func MustCopyFileTree(root string) map[string]any {
+ result := map[string]any{}
if err := filepath.Walk(filepath.FromSlash(root), func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
diff --git a/internal/packagestest/export_test.go b/internal/packagestest/export_test.go
index 6c074216fbe..fae8bd2d5ba 100644
--- a/internal/packagestest/export_test.go
+++ b/internal/packagestest/export_test.go
@@ -16,7 +16,7 @@ import (
var testdata = []packagestest.Module{{
Name: "golang.org/fake1",
- Files: map[string]interface{}{
+ Files: map[string]any{
"a.go": packagestest.Symlink("testdata/a.go"), // broken symlink
"b.go": "invalid file contents",
},
@@ -26,22 +26,22 @@ var testdata = []packagestest.Module{{
},
}, {
Name: "golang.org/fake2",
- Files: map[string]interface{}{
+ Files: map[string]any{
"other/a.go": "package fake2",
},
}, {
Name: "golang.org/fake2/v2",
- Files: map[string]interface{}{
+ Files: map[string]any{
"other/a.go": "package fake2",
},
}, {
Name: "golang.org/fake3@v1.0.0",
- Files: map[string]interface{}{
+ Files: map[string]any{
"other/a.go": "package fake3",
},
}, {
Name: "golang.org/fake3@v1.1.0",
- Files: map[string]interface{}{
+ Files: map[string]any{
"other/a.go": "package fake3",
},
}}
@@ -97,13 +97,13 @@ func TestGroupFilesByModules(t *testing.T) {
want: []packagestest.Module{
{
Name: "testdata/groups/one",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": true,
},
},
{
Name: "example.com/extra",
- Files: map[string]interface{}{
+ Files: map[string]any{
"help.go": true,
},
},
@@ -114,7 +114,7 @@ func TestGroupFilesByModules(t *testing.T) {
want: []packagestest.Module{
{
Name: "testdata/groups/two",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": true,
"expect/yo.go": true,
"expect/yo_test.go": true,
@@ -122,33 +122,33 @@ func TestGroupFilesByModules(t *testing.T) {
},
{
Name: "example.com/extra",
- Files: map[string]interface{}{
+ Files: map[string]any{
"yo.go": true,
"geez/help.go": true,
},
},
{
Name: "example.com/extra/v2",
- Files: map[string]interface{}{
+ Files: map[string]any{
"me.go": true,
"geez/help.go": true,
},
},
{
Name: "example.com/tempmod",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": true,
},
},
{
Name: "example.com/what@v1.0.0",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": true,
},
},
{
Name: "example.com/what@v1.1.0",
- Files: map[string]interface{}{
+ Files: map[string]any{
"main.go": true,
},
},
diff --git a/internal/pkgbits/decoder.go b/internal/pkgbits/decoder.go
index f6cb37c5c3d..c0aba26c482 100644
--- a/internal/pkgbits/decoder.go
+++ b/internal/pkgbits/decoder.go
@@ -259,7 +259,7 @@ func (r *Decoder) rawUvarint() uint64 {
func readUvarint(r *strings.Reader) (uint64, error) {
var x uint64
var s uint
- for i := 0; i < binary.MaxVarintLen64; i++ {
+ for i := range binary.MaxVarintLen64 {
b, err := r.ReadByte()
if err != nil {
if i > 0 && err == io.EOF {
diff --git a/internal/pprof/main.go b/internal/pprof/main.go
index 5e1ae633b4d..42aa187a6a7 100644
--- a/internal/pprof/main.go
+++ b/internal/pprof/main.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build ignore
-// +build ignore
// The pprof command prints the total time in a pprof profile provided
// through the standard input.
diff --git a/internal/proxydir/proxydir.go b/internal/proxydir/proxydir.go
index dc6b6ae94e8..bbd1ab4fd26 100644
--- a/internal/proxydir/proxydir.go
+++ b/internal/proxydir/proxydir.go
@@ -46,7 +46,7 @@ func WriteModuleVersion(rootDir, module, ver string, files map[string][]byte) (r
}
// info file, just the bare bones.
- infoContents := []byte(fmt.Sprintf(`{"Version": "%v", "Time":"2017-12-14T13:08:43Z"}`, ver))
+ infoContents := fmt.Appendf(nil, `{"Version": "%v", "Time":"2017-12-14T13:08:43Z"}`, ver)
if err := os.WriteFile(filepath.Join(dir, ver+".info"), infoContents, 0644); err != nil {
return err
}
diff --git a/internal/refactor/inline/callee.go b/internal/refactor/inline/callee.go
index b4ec43d551c..ca9426a2656 100644
--- a/internal/refactor/inline/callee.go
+++ b/internal/refactor/inline/callee.go
@@ -14,6 +14,7 @@ import (
"go/parser"
"go/token"
"go/types"
+ "slices"
"strings"
"golang.org/x/tools/go/types/typeutil"
@@ -303,7 +304,7 @@ func AnalyzeCallee(logf func(string, ...any), fset *token.FileSet, pkg *types.Pa
return nil, tuple.At(i).Type()
}
}
- for i := 0; i < sig.Results().Len(); i++ {
+ for i := range sig.Results().Len() {
expr, typ := argInfo(i)
var flags returnOperandFlags
if typ == types.Typ[types.UntypedNil] { // untyped nil is preserved by go/types
@@ -572,11 +573,9 @@ func analyzeAssignment(info *types.Info, stack []ast.Node) (assignable, ifaceAss
// Types do not need to match for an initializer with known type.
if spec, ok := parent.(*ast.ValueSpec); ok && spec.Type != nil {
- for _, v := range spec.Values {
- if v == expr {
- typ := info.TypeOf(spec.Type)
- return true, typ == nil || types.IsInterface(typ), false
- }
+ if slices.Contains(spec.Values, expr) {
+ typ := info.TypeOf(spec.Type)
+ return true, typ == nil || types.IsInterface(typ), false
}
}
@@ -616,7 +615,7 @@ func analyzeAssignment(info *types.Info, stack []ast.Node) (assignable, ifaceAss
return true, types.IsInterface(under.Elem()), false
case *types.Struct: // Struct{k: expr}
if id, _ := kv.Key.(*ast.Ident); id != nil {
- for fi := 0; fi < under.NumFields(); fi++ {
+ for fi := range under.NumFields() {
field := under.Field(fi)
if info.Uses[id] == field {
return true, types.IsInterface(field.Type()), false
@@ -715,7 +714,7 @@ func paramTypeAtIndex(sig *types.Signature, call *ast.CallExpr, index int) types
// given outer-to-inner stack, after stripping parentheses, along with the
// remaining stack up to the parent node.
//
-// If no such context exists, returns (nil, nil).
+// If no such context exists, returns (nil, nil, nil).
func exprContext(stack []ast.Node) (remaining []ast.Node, parent ast.Node, expr ast.Expr) {
expr, _ = stack[len(stack)-1].(ast.Expr)
if expr == nil {
diff --git a/internal/refactor/inline/calleefx.go b/internal/refactor/inline/calleefx.go
index 11246e5b969..26dc02c010b 100644
--- a/internal/refactor/inline/calleefx.go
+++ b/internal/refactor/inline/calleefx.go
@@ -31,7 +31,7 @@ const (
// }
//
// is [1 0 -2 2], indicating reads of y and x, followed by the unknown
-// effects of the g() call. and finally the read of parameter z. This
+// effects of the g() call, and finally the read of parameter z. This
// information is used during inlining to ascertain when it is safe
// for parameter references to be replaced by their corresponding
// argument expressions. Such substitutions are permitted only when
diff --git a/internal/refactor/inline/calleefx_test.go b/internal/refactor/inline/calleefx_test.go
index 1fc16aebaac..b643c7a06ac 100644
--- a/internal/refactor/inline/calleefx_test.go
+++ b/internal/refactor/inline/calleefx_test.go
@@ -107,7 +107,6 @@ func TestCalleeEffects(t *testing.T) {
},
}
for _, test := range tests {
- test := test
t.Run(test.descr, func(t *testing.T) {
fset := token.NewFileSet()
mustParse := func(filename string, content any) *ast.File {
diff --git a/internal/refactor/inline/everything_test.go b/internal/refactor/inline/everything_test.go
index 12b9ba47f21..a32e0709be1 100644
--- a/internal/refactor/inline/everything_test.go
+++ b/internal/refactor/inline/everything_test.go
@@ -13,6 +13,7 @@ import (
"log"
"os"
"path/filepath"
+ "slices"
"strings"
"testing"
@@ -193,7 +194,7 @@ func TestEverything(t *testing.T) {
t.Fatalf("transformed source does not parse: %v", err)
}
// Splice into original file list.
- syntax := append([]*ast.File(nil), callerPkg.Syntax...)
+ syntax := slices.Clone(callerPkg.Syntax)
for i := range callerPkg.Syntax {
if syntax[i] == callerFile {
syntax[i] = f
diff --git a/internal/refactor/inline/free.go b/internal/refactor/inline/free.go
new file mode 100644
index 00000000000..28cebeea3db
--- /dev/null
+++ b/internal/refactor/inline/free.go
@@ -0,0 +1,376 @@
+// Copyright 2025 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.
+
+// Copied, with considerable changes, from go/parser/resolver.go
+// at af53bd2c03.
+
+package inline
+
+import (
+ "go/ast"
+ "go/token"
+)
+
+// freeishNames computes an approximation to the free names of the AST
+// at node n based solely on syntax, inserting values into the map.
+//
+// In the absence of composite literals, the set of free names is exact. Composite
+// literals introduce an ambiguity that can only be resolved with type information:
+// whether F is a field name or a value in `T{F: ...}`.
+// If includeComplitIdents is true, this function conservatively assumes
+// T is not a struct type, so freeishNames overapproximates: the resulting
+// set may contain spurious entries that are not free lexical references
+// but are references to struct fields.
+// If includeComplitIdents is false, this function assumes that T *is*
+// a struct type, so freeishNames underapproximates: the resulting set
+// may omit names that are free lexical references.
+//
+// The code is based on go/parser.resolveFile, but heavily simplified. Crucial
+// differences are:
+// - Instead of resolving names to their objects, this function merely records
+// whether they are free.
+// - Labels are ignored: they do not refer to values.
+// - This is never called on FuncDecls or ImportSpecs, so the function
+// panics if it sees one.
+func freeishNames(free map[string]bool, n ast.Node, includeComplitIdents bool) {
+ v := &freeVisitor{free: free, includeComplitIdents: includeComplitIdents}
+ ast.Walk(v, n)
+ assert(v.scope == nil, "unbalanced scopes")
+}
+
+// A freeVisitor holds state for a free-name analysis.
+type freeVisitor struct {
+ scope *scope // the current innermost scope
+ free map[string]bool // free names seen so far
+ includeComplitIdents bool // include identifier key in composite literals
+}
+
+// scope contains all the names defined in a lexical scope.
+// It is like ast.Scope, but without deprecation warnings.
+type scope struct {
+ names map[string]bool
+ outer *scope
+}
+
+func (s *scope) defined(name string) bool {
+ for ; s != nil; s = s.outer {
+ if s.names[name] {
+ return true
+ }
+ }
+ return false
+}
+
+func (v *freeVisitor) Visit(n ast.Node) ast.Visitor {
+ switch n := n.(type) {
+
+ // Expressions.
+ case *ast.Ident:
+ v.resolve(n)
+
+ case *ast.FuncLit:
+ v.openScope()
+ defer v.closeScope()
+ v.walkFuncType(n.Type)
+ v.walkBody(n.Body)
+
+ case *ast.SelectorExpr:
+ v.walk(n.X)
+ // Skip n.Sel: it cannot be free.
+
+ case *ast.StructType:
+ v.openScope()
+ defer v.closeScope()
+ v.walkFieldList(n.Fields)
+
+ case *ast.FuncType:
+ v.openScope()
+ defer v.closeScope()
+ v.walkFuncType(n)
+
+ case *ast.CompositeLit:
+ v.walk(n.Type)
+ for _, e := range n.Elts {
+ if kv, _ := e.(*ast.KeyValueExpr); kv != nil {
+ if ident, _ := kv.Key.(*ast.Ident); ident != nil {
+ // It is not possible from syntax alone to know whether
+ // an identifier used as a composite literal key is
+ // a struct field (if n.Type is a struct) or a value
+ // (if n.Type is a map, slice or array).
+ if v.includeComplitIdents {
+ // Over-approximate by treating both cases as potentially
+ // free names.
+ v.resolve(ident)
+ } else {
+ // Under-approximate by ignoring potentially free names.
+ }
+ } else {
+ v.walk(kv.Key)
+ }
+ v.walk(kv.Value)
+ } else {
+ v.walk(e)
+ }
+ }
+
+ case *ast.InterfaceType:
+ v.openScope()
+ defer v.closeScope()
+ v.walkFieldList(n.Methods)
+
+ // Statements
+ case *ast.AssignStmt:
+ walkSlice(v, n.Rhs)
+ if n.Tok == token.DEFINE {
+ v.shortVarDecl(n.Lhs)
+ } else {
+ walkSlice(v, n.Lhs)
+ }
+
+ case *ast.LabeledStmt:
+ // ignore labels
+ // TODO(jba): consider labels?
+ v.walk(n.Stmt)
+
+ case *ast.BranchStmt:
+ // Ignore labels.
+ // TODO(jba): consider labels?
+
+ case *ast.BlockStmt:
+ v.openScope()
+ defer v.closeScope()
+ walkSlice(v, n.List)
+
+ case *ast.IfStmt:
+ v.openScope()
+ defer v.closeScope()
+ v.walk(n.Init)
+ v.walk(n.Cond)
+ v.walk(n.Body)
+ v.walk(n.Else)
+
+ case *ast.CaseClause:
+ walkSlice(v, n.List)
+ v.openScope()
+ defer v.closeScope()
+ walkSlice(v, n.Body)
+
+ case *ast.SwitchStmt:
+ v.openScope()
+ defer v.closeScope()
+ v.walk(n.Init)
+ v.walk(n.Tag)
+ v.walkBody(n.Body)
+
+ case *ast.TypeSwitchStmt:
+ if n.Init != nil {
+ v.openScope()
+ defer v.closeScope()
+ v.walk(n.Init)
+ }
+ v.openScope()
+ defer v.closeScope()
+ v.walk(n.Assign)
+ // We can use walkBody here because we don't track label scopes.
+ v.walkBody(n.Body)
+
+ case *ast.CommClause:
+ v.openScope()
+ defer v.closeScope()
+ v.walk(n.Comm)
+ walkSlice(v, n.Body)
+
+ case *ast.SelectStmt:
+ v.walkBody(n.Body)
+
+ case *ast.ForStmt:
+ v.openScope()
+ defer v.closeScope()
+ v.walk(n.Init)
+ v.walk(n.Cond)
+ v.walk(n.Post)
+ v.walk(n.Body)
+
+ case *ast.RangeStmt:
+ v.openScope()
+ defer v.closeScope()
+ v.walk(n.X)
+ var lhs []ast.Expr
+ if n.Key != nil {
+ lhs = append(lhs, n.Key)
+ }
+ if n.Value != nil {
+ lhs = append(lhs, n.Value)
+ }
+ if len(lhs) > 0 {
+ if n.Tok == token.DEFINE {
+ v.shortVarDecl(lhs)
+ } else {
+ walkSlice(v, lhs)
+ }
+ }
+ v.walk(n.Body)
+
+ // Declarations
+ case *ast.GenDecl:
+ switch n.Tok {
+ case token.CONST, token.VAR:
+ for _, spec := range n.Specs {
+ spec := spec.(*ast.ValueSpec)
+ walkSlice(v, spec.Values)
+ if spec.Type != nil {
+ v.walk(spec.Type)
+ }
+ v.declare(spec.Names...)
+ }
+ case token.TYPE:
+ for _, spec := range n.Specs {
+ spec := spec.(*ast.TypeSpec)
+ // Go spec: The scope of a type identifier declared inside a
+ // function begins at the identifier in the TypeSpec and ends
+ // at the end of the innermost containing block.
+ v.declare(spec.Name)
+ if spec.TypeParams != nil {
+ v.openScope()
+ defer v.closeScope()
+ v.walkTypeParams(spec.TypeParams)
+ }
+ v.walk(spec.Type)
+ }
+
+ case token.IMPORT:
+ panic("encountered import declaration in free analysis")
+ }
+
+ case *ast.FuncDecl:
+ panic("encountered top-level function declaration in free analysis")
+
+ default:
+ return v
+ }
+
+ return nil
+}
+
+func (r *freeVisitor) openScope() {
+ r.scope = &scope{map[string]bool{}, r.scope}
+}
+
+func (r *freeVisitor) closeScope() {
+ r.scope = r.scope.outer
+}
+
+func (r *freeVisitor) walk(n ast.Node) {
+ if n != nil {
+ ast.Walk(r, n)
+ }
+}
+
+// walkFuncType walks a function type. It is used for explicit
+// function types, like this:
+//
+// type RunFunc func(context.Context) error
+//
+// and function literals, like this:
+//
+// func(a, b int) int { return a + b}
+//
+// neither of which have type parameters.
+// Function declarations do involve type parameters, but we don't
+// handle them.
+func (r *freeVisitor) walkFuncType(typ *ast.FuncType) {
+ // The order here doesn't really matter, because names in
+ // a field list cannot appear in types.
+ // (The situation is different for type parameters, for which
+ // see [freeVisitor.walkTypeParams].)
+ r.resolveFieldList(typ.Params)
+ r.resolveFieldList(typ.Results)
+ r.declareFieldList(typ.Params)
+ r.declareFieldList(typ.Results)
+}
+
+// walkTypeParams is like walkFieldList, but declares type parameters eagerly so
+// that they may be resolved in the constraint expressions held in the field
+// Type.
+func (r *freeVisitor) walkTypeParams(list *ast.FieldList) {
+ r.declareFieldList(list)
+ r.resolveFieldList(list)
+}
+
+func (r *freeVisitor) walkBody(body *ast.BlockStmt) {
+ if body == nil {
+ return
+ }
+ walkSlice(r, body.List)
+}
+
+func (r *freeVisitor) walkFieldList(list *ast.FieldList) {
+ if list == nil {
+ return
+ }
+ r.resolveFieldList(list) // .Type may contain references
+ r.declareFieldList(list) // .Names declares names
+}
+
+func (r *freeVisitor) shortVarDecl(lhs []ast.Expr) {
+ // Go spec: A short variable declaration may redeclare variables provided
+ // they were originally declared in the same block with the same type, and
+ // at least one of the non-blank variables is new.
+ //
+ // However, it doesn't matter to free analysis whether a variable is declared
+ // fresh or redeclared.
+ for _, x := range lhs {
+ // In a well-formed program each expr must be an identifier,
+ // but be forgiving.
+ if id, ok := x.(*ast.Ident); ok {
+ r.declare(id)
+ }
+ }
+}
+
+func walkSlice[S ~[]E, E ast.Node](r *freeVisitor, list S) {
+ for _, e := range list {
+ r.walk(e)
+ }
+}
+
+// resolveFieldList resolves the types of the fields in list.
+// The companion method declareFieldList declares the names of the fields.
+func (r *freeVisitor) resolveFieldList(list *ast.FieldList) {
+ if list == nil {
+ return
+ }
+ for _, f := range list.List {
+ r.walk(f.Type)
+ }
+}
+
+// declareFieldList declares the names of the fields in list.
+// (Names in a FieldList always establish new bindings.)
+// The companion method resolveFieldList resolves the types of the fields.
+func (r *freeVisitor) declareFieldList(list *ast.FieldList) {
+ if list == nil {
+ return
+ }
+ for _, f := range list.List {
+ r.declare(f.Names...)
+ }
+}
+
+// resolve marks ident as free if it is not in scope.
+// TODO(jba): rename: no resolution is happening.
+func (r *freeVisitor) resolve(ident *ast.Ident) {
+ if s := ident.Name; s != "_" && !r.scope.defined(s) {
+ r.free[s] = true
+ }
+}
+
+// declare adds each non-blank ident to the current scope.
+func (r *freeVisitor) declare(idents ...*ast.Ident) {
+ for _, id := range idents {
+ if id.Name != "_" {
+ r.scope.names[id.Name] = true
+ }
+ }
+}
diff --git a/internal/refactor/inline/free_test.go b/internal/refactor/inline/free_test.go
new file mode 100644
index 00000000000..28fa56db099
--- /dev/null
+++ b/internal/refactor/inline/free_test.go
@@ -0,0 +1,239 @@
+// Copyright 2025 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 inline
+
+import (
+ "fmt"
+ "go/ast"
+ "go/parser"
+ "go/token"
+ "maps"
+ "slices"
+ "strings"
+ "testing"
+)
+
+func TestFreeishNames(t *testing.T) {
+ elems := func(m map[string]bool) string {
+ return strings.Join(slices.Sorted(maps.Keys(m)), " ")
+ }
+
+ type testcase struct {
+ code string // one or more exprs, decls or stmts
+ want string // space-separated list of free names
+ }
+
+ for _, tc := range []struct {
+ includeComplitIdents bool
+ cases []testcase
+ }{
+ {true, []testcase{
+ {
+ `x`,
+ "x",
+ },
+ {
+ `x.y.z`,
+ "x",
+ },
+ {
+ `T{a: 1, b: 2, c.d: e}`,
+ "a b c e T",
+ },
+ {
+ `f(x)`,
+ "f x",
+ },
+ {
+ `f.m(x)`,
+ "f x",
+ },
+ {
+ `func(x int) int { return x + y }`,
+ "int y",
+ },
+ {
+ `x = func(x int) int { return 2*x }()`,
+ "int x",
+ },
+ {
+ `func(x int) (y int) { return x + y }`,
+ "int",
+ },
+ {
+ `struct{a **int; b map[int][]bool}`,
+ "bool int",
+ },
+ {
+ `struct{f int}{f: 0}`,
+ "f int",
+ },
+ {
+ `interface{m1(int) bool; m2(x int) (y bool)}`,
+ "bool int",
+ },
+ {
+ `x := 1; x++`,
+ "",
+ },
+ {
+ `x = 1`,
+ "x",
+ },
+ {
+ `_ = 1`,
+ "",
+ },
+ {
+ `x, y := 1, 2; x = y + z`,
+ "z",
+ },
+ {
+ `x, y := y, x; x = y + z`,
+ "x y z",
+ },
+ {
+ `a, b := 0, 0; b, c := 0, 0; print(a, b, c, d)`,
+ "d print",
+ },
+ {
+ `label: x++`,
+ "x",
+ },
+ {
+ `if x == y {x}`,
+ "x y",
+ },
+ {
+ `if x := 1; x == y {x}`,
+ "y",
+ },
+ {
+ `if x := 1; x == y {x} else {z}`,
+ "y z",
+ },
+ {
+ `switch x { case 1: x; case y: z }`,
+ "x y z",
+ },
+ {
+ `switch x := 1; x { case 1: x; case y: z }`,
+ "y z",
+ },
+ {
+ `switch x.(type) { case int: x; case []int: y }`,
+ "int x y",
+ },
+ {
+ `switch x := 1; x.(type) { case int: x; case []int: y }`,
+ "int y",
+ },
+ {
+ `switch y := x.(type) { case int: x; case []int: y }`,
+ "int x",
+ },
+ {
+ `select { case c <- 1: x; case x := <-c: 2; default: y}`,
+ "c x y",
+ },
+ {
+ `for i := 0; i < 9; i++ { c <- j }`,
+ "c j",
+ },
+ {
+ `for i = 0; i < 9; i++ { c <- j }`,
+ "c i j",
+ },
+ {
+ `for i := range 9 { c <- j }`,
+ "c j",
+ },
+ {
+ `for i = range 9 { c <- j }`,
+ "c i j",
+ },
+ {
+ `for _, e := range []int{1, 2, x} {e}`,
+ "int x",
+ },
+ {
+ `var x, y int; f(x, y)`,
+ "f int",
+ },
+ {
+ `{var x, y int}; f(x, y)`,
+ "f int x y",
+ },
+ {
+ `const x = 1; { const y = iota; return x, y }`,
+ "iota",
+ },
+ {
+ `type t int; t(0)`,
+ "int",
+ },
+ {
+ `type t[T ~int] struct { t T }; x = t{t: 1}.t`, // field t shadowed by type decl
+ "int x",
+ },
+ {
+ `type t[S ~[]E, E any] S`,
+ "any",
+ },
+ {
+ `var a [unsafe.Sizeof(func(x int) { x + y })]int`,
+ "int unsafe y",
+ },
+ }},
+ {
+ false,
+ []testcase{
+ {
+ `x`,
+ "x",
+ },
+ {
+ `x.y.z`,
+ "x",
+ },
+ {
+ `T{a: 1, b: 2, c.d: e}`,
+ "c e T", // omit a and b
+ },
+ {
+ `type t[T ~int] struct { t T }; x = t{t: 1}.t`, // field t shadowed by type decl
+ "int x",
+ },
+ },
+ },
+ } {
+ t.Run(fmt.Sprintf("includeComplitIdents=%t", tc.includeComplitIdents), func(t *testing.T) {
+ for _, test := range tc.cases {
+ _, f := mustParse(t, "free.go", `package p; func _() {`+test.code+`}`)
+ n := f.Decls[0].(*ast.FuncDecl).Body
+ got := map[string]bool{}
+ want := map[string]bool{}
+ for _, n := range strings.Fields(test.want) {
+ want[n] = true
+ }
+
+ freeishNames(got, n, tc.includeComplitIdents)
+
+ if !maps.Equal(got, want) {
+ t.Errorf("\ncode %s\ngot %v\nwant %v", test.code, elems(got), elems(want))
+ }
+ }
+ })
+ }
+}
+
+func mustParse(t *testing.T, filename string, content any) (*token.FileSet, *ast.File) {
+ fset := token.NewFileSet()
+ f, err := parser.ParseFile(fset, filename, content, parser.ParseComments|parser.SkipObjectResolution)
+ if err != nil {
+ t.Fatalf("ParseFile: %v", err)
+ }
+ return fset, f
+}
diff --git a/internal/refactor/inline/inline.go b/internal/refactor/inline/inline.go
index 2c897c24954..edd5d836613 100644
--- a/internal/refactor/inline/inline.go
+++ b/internal/refactor/inline/inline.go
@@ -22,10 +22,11 @@ import (
"golang.org/x/tools/go/ast/astutil"
"golang.org/x/tools/go/types/typeutil"
- "golang.org/x/tools/imports"
+ "golang.org/x/tools/internal/analysisinternal"
internalastutil "golang.org/x/tools/internal/astutil"
"golang.org/x/tools/internal/typeparams"
"golang.org/x/tools/internal/typesinternal"
+ "maps"
)
// A Caller describes the function call and its enclosing context.
@@ -101,9 +102,9 @@ func (st *state) inline() (*Result, error) {
return nil, fmt.Errorf("internal error: caller syntax positions are inconsistent with file content (did you forget to use FileSet.PositionFor when computing the file name?)")
}
- // TODO(adonovan): use go1.21's ast.IsGenerated.
// Break the string literal so we can use inlining in this file. :)
- if bytes.Contains(caller.Content, []byte("// Code generated by "+"cmd/cgo; DO NOT EDIT.")) {
+ if ast.IsGenerated(caller.File) &&
+ bytes.Contains(caller.Content, []byte("// Code generated by "+"cmd/cgo; DO NOT EDIT.")) {
return nil, fmt.Errorf("cannot inline calls from files that import \"C\"")
}
@@ -270,12 +271,12 @@ func (st *state) inline() (*Result, error) {
}
}
- // Add new imports.
- //
+ // Add new imports that are still used.
+ newImports := trimNewImports(res.newImports, res.new)
// Insert new imports after last existing import,
// to avoid migration of pre-import comments.
// The imports will be organized below.
- if len(res.newImports) > 0 {
+ if len(newImports) > 0 {
// If we have imports to add, do so independent of the rest of the file.
// Otherwise, the length of the new imports may consume floating comments,
// causing them to be printed inside the imports block.
@@ -328,10 +329,10 @@ func (st *state) inline() (*Result, error) {
}
}
// Add new imports.
- for _, imp := range res.newImports {
+ for _, imp := range newImports {
// Check that the new imports are accessible.
path, _ := strconv.Unquote(imp.spec.Path.Value)
- if !canImport(caller.Types.Path(), path) {
+ if !analysisinternal.CanImport(caller.Types.Path(), path) {
return nil, fmt.Errorf("can't inline function %v as its body refers to inaccessible package %q", callee, path)
}
importDecl.Specs = append(importDecl.Specs, imp.spec)
@@ -354,30 +355,14 @@ func (st *state) inline() (*Result, error) {
}
// Delete imports referenced only by caller.Call.Fun.
- //
- // (We can't let imports.Process take care of it as it may
- // mistake obsolete imports for missing new imports when the
- // names are similar, as is common during a package migration.)
for _, oldImport := range res.oldImports {
specToDelete := oldImport.spec
- for _, decl := range f.Decls {
- if decl, ok := decl.(*ast.GenDecl); ok && decl.Tok == token.IMPORT {
- decl.Specs = slicesDeleteFunc(decl.Specs, func(spec ast.Spec) bool {
- imp := spec.(*ast.ImportSpec)
- // Since we re-parsed the file, we can't match by identity;
- // instead look for syntactic equivalence.
- return imp.Path.Value == specToDelete.Path.Value &&
- (imp.Name != nil) == (specToDelete.Name != nil) &&
- (imp.Name == nil || imp.Name.Name == specToDelete.Name.Name)
- })
-
- // Edge case: import "foo" => import ().
- if !decl.Lparen.IsValid() {
- decl.Lparen = decl.TokPos + token.Pos(len("import"))
- decl.Rparen = decl.Lparen + 1
- }
- }
+ name := ""
+ if specToDelete.Name != nil {
+ name = specToDelete.Name.Name
}
+ path, _ := strconv.Unquote(specToDelete.Path.Value)
+ astutil.DeleteNamedImport(caller.Fset, f, name, path)
}
var out bytes.Buffer
@@ -386,66 +371,6 @@ func (st *state) inline() (*Result, error) {
}
newSrc := out.Bytes()
- // Remove imports that are no longer referenced.
- //
- // It ought to be possible to compute the set of PkgNames used
- // by the "old" code, compute the free identifiers of the
- // "new" code using a syntax-only (no go/types) algorithm, and
- // see if the reduction in the number of uses of any PkgName
- // equals the number of times it appears in caller.Info.Uses,
- // indicating that it is no longer referenced by res.new.
- //
- // However, the notorious ambiguity of resolving T{F: 0} makes this
- // unreliable: without types, we can't tell whether F refers to
- // a field of struct T, or a package-level const/var of a
- // dot-imported (!) package.
- //
- // So, for now, we run imports.Process, which is
- // unsatisfactory as it has to run the go command, and it
- // looks at the user's module cache state--unnecessarily,
- // since this step cannot add new imports.
- //
- // TODO(adonovan): replace with a simpler implementation since
- // all the necessary imports are present but merely untidy.
- // That will be faster, and also less prone to nondeterminism
- // if there are bugs in our logic for import maintenance.
- //
- // However, golang.org/x/tools/internal/imports.ApplyFixes is
- // too simple as it requires the caller to have figured out
- // all the logical edits. In our case, we know all the new
- // imports that are needed (see newImports), each of which can
- // be specified as:
- //
- // &imports.ImportFix{
- // StmtInfo: imports.ImportInfo{path, name,
- // IdentName: name,
- // FixType: imports.AddImport,
- // }
- //
- // but we don't know which imports are made redundant by the
- // inlining itself. For example, inlining a call to
- // fmt.Println may make the "fmt" import redundant.
- //
- // Also, both imports.Process and internal/imports.ApplyFixes
- // reformat the entire file, which is not ideal for clients
- // such as gopls. (That said, the point of a canonical format
- // is arguably that any tool can reformat as needed without
- // this being inconvenient.)
- //
- // We could invoke imports.Process and parse its result,
- // compare against the original AST, compute a list of import
- // fixes, and return that too.
-
- // Recompute imports only if there were existing ones.
- if len(f.Imports) > 0 {
- formatted, err := imports.Process("output", newSrc, nil)
- if err != nil {
- logf("cannot reformat: %v <<%s>>", err, &out)
- return nil, err // cannot reformat (a bug?)
- }
- newSrc = formatted
- }
-
literalized := false
if call, ok := res.new.(*ast.CallExpr); ok && is[*ast.FuncLit](call.Fun) {
literalized = true
@@ -469,6 +394,183 @@ type newImport struct {
spec *ast.ImportSpec
}
+// importState tracks information about imports.
+type importState struct {
+ logf func(string, ...any)
+ caller *Caller
+ importMap map[string][]string // from package paths in the caller's file to local names
+ newImports []newImport // for references to free names in callee; to be added to the file
+ oldImports []oldImport // referenced only by caller.Call.Fun; to be removed from the file
+}
+
+// newImportState returns an importState with initial information about the caller's imports.
+func newImportState(logf func(string, ...any), caller *Caller, callee *gobCallee) *importState {
+ // For simplicity we ignore existing dot imports, so that a qualified
+ // identifier (QI) in the callee is always represented by a QI in the caller,
+ // allowing us to treat a QI like a selection on a package name.
+ is := &importState{
+ logf: logf,
+ caller: caller,
+ importMap: make(map[string][]string),
+ }
+
+ for _, imp := range caller.File.Imports {
+ if pkgName, ok := importedPkgName(caller.Info, imp); ok &&
+ pkgName.Name() != "." &&
+ pkgName.Name() != "_" {
+
+ // If the import's sole use is in caller.Call.Fun of the form p.F(...),
+ // where p.F is a qualified identifier, the p import may not be
+ // necessary.
+ //
+ // Only the qualified identifier case matters, as other references to
+ // imported package names in the Call.Fun expression (e.g.
+ // x.after(3*time.Second).f() or time.Second.String()) will remain after
+ // inlining, as arguments.
+ //
+ // If that is the case, proactively check if any of the callee FreeObjs
+ // need this import. Doing so eagerly simplifies the resulting logic.
+ needed := true
+ sel, ok := ast.Unparen(caller.Call.Fun).(*ast.SelectorExpr)
+ if ok && soleUse(caller.Info, pkgName) == sel.X {
+ needed = false // no longer needed by caller
+ // Check to see if any of the inlined free objects need this package.
+ for _, obj := range callee.FreeObjs {
+ if obj.PkgPath == pkgName.Imported().Path() && obj.Shadow[pkgName.Name()] == 0 {
+ needed = true // needed by callee
+ break
+ }
+ }
+ }
+
+ // Exclude imports not needed by the caller or callee after inlining; the second
+ // return value holds these.
+ if needed {
+ path := pkgName.Imported().Path()
+ is.importMap[path] = append(is.importMap[path], pkgName.Name())
+ } else {
+ is.oldImports = append(is.oldImports, oldImport{pkgName: pkgName, spec: imp})
+ }
+ }
+ }
+ return is
+}
+
+// importName finds an existing import name to use in a particular shadowing
+// context. It is used to determine the set of new imports in
+// localName, and is also used for writing out names in inlining
+// strategies below.
+func (i *importState) importName(pkgPath string, shadow shadowMap) string {
+ for _, name := range i.importMap[pkgPath] {
+ // Check that either the import preexisted, or that it was newly added
+ // (no PkgName) but is not shadowed, either in the callee (shadows) or
+ // caller (caller.lookup).
+ if shadow[name] == 0 {
+ found := i.caller.lookup(name)
+ if is[*types.PkgName](found) || found == nil {
+ return name
+ }
+ }
+ }
+ return ""
+}
+
+// localName returns the local name for a given imported package path,
+// adding one if it doesn't exists.
+func (i *importState) localName(pkgPath, pkgName string, shadow shadowMap) string {
+ // Does an import already exist that works in this shadowing context?
+ if name := i.importName(pkgPath, shadow); name != "" {
+ return name
+ }
+
+ newlyAdded := func(name string) bool {
+ return slices.ContainsFunc(i.newImports, func(n newImport) bool { return n.pkgName == name })
+ }
+
+ // shadowedInCaller reports whether a candidate package name
+ // already refers to a declaration in the caller.
+ shadowedInCaller := func(name string) bool {
+ obj := i.caller.lookup(name)
+ if obj == nil {
+ return false
+ }
+ // If obj will be removed, the name is available.
+ return !slices.ContainsFunc(i.oldImports, func(o oldImport) bool { return o.pkgName == obj })
+ }
+
+ // import added by callee
+ //
+ // Choose local PkgName based on last segment of
+ // package path plus, if needed, a numeric suffix to
+ // ensure uniqueness.
+ //
+ // "init" is not a legal PkgName.
+ //
+ // TODO(rfindley): is it worth preserving local package names for callee
+ // imports? Are they likely to be better or worse than the name we choose
+ // here?
+ base := pkgName
+ name := base
+ for n := 0; shadow[name] != 0 || shadowedInCaller(name) || newlyAdded(name) || name == "init"; n++ {
+ name = fmt.Sprintf("%s%d", base, n)
+ }
+ i.logf("adding import %s %q", name, pkgPath)
+ spec := &ast.ImportSpec{
+ Path: &ast.BasicLit{
+ Kind: token.STRING,
+ Value: strconv.Quote(pkgPath),
+ },
+ }
+ // Use explicit pkgname (out of necessity) when it differs from the declared name,
+ // or (for good style) when it differs from base(pkgpath).
+ if name != pkgName || name != pathpkg.Base(pkgPath) {
+ spec.Name = makeIdent(name)
+ }
+ i.newImports = append(i.newImports, newImport{
+ pkgName: name,
+ spec: spec,
+ })
+ i.importMap[pkgPath] = append(i.importMap[pkgPath], name)
+ return name
+}
+
+// trimNewImports removes imports that are no longer needed.
+//
+// The list of new imports as constructed by calls to [importState.localName]
+// includes all of the packages referenced by the callee.
+// But in the process of inlining, we may have dropped some of those references.
+// For example, if the callee looked like this:
+//
+// func F(x int) (p.T) {... /* no mention of p */ ...}
+//
+// and we inlined by assignment:
+//
+// v := ...
+//
+// then the reference to package p drops away.
+//
+// Remove the excess imports by seeing which remain in new, the expression
+// to be inlined.
+// We can find those by looking at the free names in new.
+// The list of free names cannot include spurious package names.
+// Free-name tracking is precise except for the case of an identifier
+// key in a composite literal, which names either a field or a value.
+// Neither fields nor values are package names.
+// Since they are not relevant to removing unused imports, we instruct
+// freeishNames to omit composite-literal keys that are identifiers.
+func trimNewImports(newImports []newImport, new ast.Node) []newImport {
+ free := map[string]bool{}
+ const omitComplitIdents = false
+ freeishNames(free, new, omitComplitIdents)
+ var res []newImport
+ for _, ni := range newImports {
+ if free[ni.pkgName] {
+ res = append(res, ni)
+ }
+ }
+ return res
+}
+
type inlineCallResult struct {
newImports []newImport // to add
oldImports []oldImport // to remove
@@ -585,144 +687,8 @@ func (st *state) inlineCall() (*inlineCallResult, error) {
assign1 = func(v *types.Var) bool { return !updatedLocals[v] }
}
- // import map, initially populated with caller imports, and updated below
- // with new imports necessary to reference free symbols in the callee.
- //
- // For simplicity we ignore existing dot imports, so that a qualified
- // identifier (QI) in the callee is always represented by a QI in the caller,
- // allowing us to treat a QI like a selection on a package name.
- importMap := make(map[string][]string) // maps package path to local name(s)
- var oldImports []oldImport // imports referenced only by caller.Call.Fun
-
- for _, imp := range caller.File.Imports {
- if pkgName, ok := importedPkgName(caller.Info, imp); ok &&
- pkgName.Name() != "." &&
- pkgName.Name() != "_" {
-
- // If the import's sole use is in caller.Call.Fun of the form p.F(...),
- // where p.F is a qualified identifier, the p import may not be
- // necessary.
- //
- // Only the qualified identifier case matters, as other references to
- // imported package names in the Call.Fun expression (e.g.
- // x.after(3*time.Second).f() or time.Second.String()) will remain after
- // inlining, as arguments.
- //
- // If that is the case, proactively check if any of the callee FreeObjs
- // need this import. Doing so eagerly simplifies the resulting logic.
- needed := true
- sel, ok := ast.Unparen(caller.Call.Fun).(*ast.SelectorExpr)
- if ok && soleUse(caller.Info, pkgName) == sel.X {
- needed = false // no longer needed by caller
- // Check to see if any of the inlined free objects need this package.
- for _, obj := range callee.FreeObjs {
- if obj.PkgPath == pkgName.Imported().Path() && obj.Shadow[pkgName.Name()] == 0 {
- needed = true // needed by callee
- break
- }
- }
- }
-
- if needed {
- path := pkgName.Imported().Path()
- importMap[path] = append(importMap[path], pkgName.Name())
- } else {
- oldImports = append(oldImports, oldImport{pkgName: pkgName, spec: imp})
- }
- }
- }
-
- // importName finds an existing import name to use in a particular shadowing
- // context. It is used to determine the set of new imports in
- // getOrMakeImportName, and is also used for writing out names in inlining
- // strategies below.
- importName := func(pkgPath string, shadow shadowMap) string {
- for _, name := range importMap[pkgPath] {
- // Check that either the import preexisted, or that it was newly added
- // (no PkgName) but is not shadowed, either in the callee (shadows) or
- // caller (caller.lookup).
- if shadow[name] == 0 {
- found := caller.lookup(name)
- if is[*types.PkgName](found) || found == nil {
- return name
- }
- }
- }
- return ""
- }
-
- // keep track of new imports that are necessary to reference any free names
- // in the callee.
- var newImports []newImport
-
- // getOrMakeImportName returns the local name for a given imported package path,
- // adding one if it doesn't exists.
- getOrMakeImportName := func(pkgPath, pkgName string, shadow shadowMap) string {
- // Does an import already exist that works in this shadowing context?
- if name := importName(pkgPath, shadow); name != "" {
- return name
- }
-
- newlyAdded := func(name string) bool {
- for _, new := range newImports {
- if new.pkgName == name {
- return true
- }
- }
- return false
- }
-
- // shadowedInCaller reports whether a candidate package name
- // already refers to a declaration in the caller.
- shadowedInCaller := func(name string) bool {
- obj := caller.lookup(name)
- if obj == nil {
- return false
- }
- // If obj will be removed, the name is available.
- for _, old := range oldImports {
- if old.pkgName == obj {
- return false
- }
- }
- return true
- }
-
- // import added by callee
- //
- // Choose local PkgName based on last segment of
- // package path plus, if needed, a numeric suffix to
- // ensure uniqueness.
- //
- // "init" is not a legal PkgName.
- //
- // TODO(rfindley): is it worth preserving local package names for callee
- // imports? Are they likely to be better or worse than the name we choose
- // here?
- base := pkgName
- name := base
- for n := 0; shadow[name] != 0 || shadowedInCaller(name) || newlyAdded(name) || name == "init"; n++ {
- name = fmt.Sprintf("%s%d", base, n)
- }
- logf("adding import %s %q", name, pkgPath)
- spec := &ast.ImportSpec{
- Path: &ast.BasicLit{
- Kind: token.STRING,
- Value: strconv.Quote(pkgPath),
- },
- }
- // Use explicit pkgname (out of necessity) when it differs from the declared name,
- // or (for good style) when it differs from base(pkgpath).
- if name != pkgName || name != pathpkg.Base(pkgPath) {
- spec.Name = makeIdent(name)
- }
- newImports = append(newImports, newImport{
- pkgName: name,
- spec: spec,
- })
- importMap[pkgPath] = append(importMap[pkgPath], name)
- return name
- }
+ // Extract information about the caller's imports.
+ istate := newImportState(logf, caller, callee)
// Compute the renaming of the callee's free identifiers.
objRenames := make([]ast.Expr, len(callee.FreeObjs)) // nil => no change
@@ -750,7 +716,7 @@ func (st *state) inlineCall() (*inlineCallResult, error) {
var newName ast.Expr
if obj.Kind == "pkgname" {
// Use locally appropriate import, creating as needed.
- n := getOrMakeImportName(obj.PkgPath, obj.PkgName, obj.Shadow)
+ n := istate.localName(obj.PkgPath, obj.PkgName, obj.Shadow)
newName = makeIdent(n) // imported package
} else if !obj.ValidPos {
// Built-in function, type, or value (e.g. nil, zero):
@@ -795,7 +761,7 @@ func (st *state) inlineCall() (*inlineCallResult, error) {
// Form a qualified identifier, pkg.Name.
if qualify {
- pkgName := getOrMakeImportName(obj.PkgPath, obj.PkgName, obj.Shadow)
+ pkgName := istate.localName(obj.PkgPath, obj.PkgName, obj.Shadow)
newName = &ast.SelectorExpr{
X: makeIdent(pkgName),
Sel: makeIdent(obj.Name),
@@ -806,8 +772,8 @@ func (st *state) inlineCall() (*inlineCallResult, error) {
}
res := &inlineCallResult{
- newImports: newImports,
- oldImports: oldImports,
+ newImports: istate.newImports,
+ oldImports: istate.oldImports,
}
// Parse callee function declaration.
@@ -928,9 +894,7 @@ func (st *state) inlineCall() (*inlineCallResult, error) {
elts = append(elts, arg.expr)
pure = pure && arg.pure
effects = effects || arg.effects
- for k, v := range arg.freevars {
- freevars[k] = v
- }
+ maps.Copy(freevars, arg.freevars)
}
args = append(ordinary, &argument{
expr: &ast.CompositeLit{
@@ -1156,7 +1120,7 @@ func (st *state) inlineCall() (*inlineCallResult, error) {
(!needBindingDecl || (bindingDecl != nil && len(bindingDecl.names) == 0)) {
// Reduces to: { var (bindings); lhs... := rhs... }
- if newStmts, ok := st.assignStmts(stmt, results, importName); ok {
+ if newStmts, ok := st.assignStmts(stmt, results, istate.importName); ok {
logf("strategy: reduce assign-context call to { return exprs }")
clearPositions(calleeDecl.Body)
@@ -2041,7 +2005,7 @@ func resolveEffects(logf logger, args []*argument, effects []int, sg substGraph)
argi := args[i]
if sg.has(argi) && !argi.pure {
// i is not bound: check whether it must be bound due to hazards.
- idx := index(effects, i)
+ idx := slices.Index(effects, i)
if idx >= 0 {
for _, j := range effects[:idx] {
var (
@@ -2312,7 +2276,8 @@ func createBindingDecl(logf logger, caller *Caller, args []*argument, calleeDecl
free[name] = true
}
}
- freeishNames(free, spec.Type)
+ const includeComplitIdents = true
+ freeishNames(free, spec.Type, includeComplitIdents)
for name := range free {
if names[name] {
logf("binding decl would shadow free name %q", name)
@@ -2443,36 +2408,6 @@ func freeVars(info *types.Info, e ast.Expr) map[string]bool {
return free
}
-// freeishNames computes an over-approximation to the free names
-// of the type syntax t, inserting values into the map.
-//
-// Because we don't have go/types annotations, we can't give an exact
-// result in all cases. In particular, an array type [n]T might have a
-// size such as unsafe.Sizeof(func() int{stmts...}()) and now the
-// precise answer depends upon all the statement syntax too. But that
-// never happens in practice.
-func freeishNames(free map[string]bool, t ast.Expr) {
- var visit func(n ast.Node) bool
- visit = func(n ast.Node) bool {
- switch n := n.(type) {
- case *ast.Ident:
- free[n.Name] = true
-
- case *ast.SelectorExpr:
- ast.Inspect(n.X, visit)
- return false // don't visit .Sel
-
- case *ast.Field:
- ast.Inspect(n.Type, visit)
- // Don't visit .Names:
- // FuncType parameters, interface methods, struct fields
- return false
- }
- return true
- }
- ast.Inspect(t, visit)
-}
-
// effects reports whether an expression might change the state of the
// program (through function calls and channel receives) and affect
// the evaluation of subsequent expressions.
@@ -2980,7 +2915,7 @@ func replaceNode(root ast.Node, from, to ast.Node) {
var visit func(reflect.Value)
visit = func(v reflect.Value) {
switch v.Kind() {
- case reflect.Ptr:
+ case reflect.Pointer:
if v.Interface() == from {
found = true
@@ -3015,13 +2950,13 @@ func replaceNode(root ast.Node, from, to ast.Node) {
}
case reflect.Struct:
- for i := 0; i < v.Type().NumField(); i++ {
+ for i := range v.Type().NumField() {
visit(v.Field(i))
}
case reflect.Slice:
compact := false
- for i := 0; i < v.Len(); i++ {
+ for i := range v.Len() {
visit(v.Index(i))
if v.Index(i).IsNil() {
compact = true
@@ -3032,7 +2967,7 @@ func replaceNode(root ast.Node, from, to ast.Node) {
// (Do this is a second pass to avoid
// unnecessary writes in the common case.)
j := 0
- for i := 0; i < v.Len(); i++ {
+ for i := range v.Len() {
if !v.Index(i).IsNil() {
v.Index(j).Set(v.Index(i))
j++
@@ -3092,7 +3027,7 @@ func clearPositions(root ast.Node) {
if n != nil {
v := reflect.ValueOf(n).Elem() // deref the pointer to struct
fields := v.Type().NumField()
- for i := 0; i < fields; i++ {
+ for i := range fields {
f := v.Field(i)
// Clearing Pos arbitrarily is destructive,
// as its presence may be semantically significant
@@ -3196,30 +3131,6 @@ func last[T any](slice []T) T {
return *new(T)
}
-// canImport reports whether one package is allowed to import another.
-//
-// TODO(adonovan): allow customization of the accessibility relation
-// (e.g. for Bazel).
-func canImport(from, to string) bool {
- // TODO(adonovan): better segment hygiene.
- if strings.HasPrefix(to, "internal/") {
- // Special case: only std packages may import internal/...
- // We can't reliably know whether we're in std, so we
- // use a heuristic on the first segment.
- first, _, _ := strings.Cut(from, "/")
- if strings.Contains(first, ".") {
- return false // example.com/foo ∉ std
- }
- if first == "testdata" {
- return false // testdata/foo ∉ std
- }
- }
- if i := strings.LastIndex(to, "/internal/"); i >= 0 {
- return strings.HasPrefix(from, to[:i])
- }
- return true
-}
-
// consistentOffsets reports whether the portion of caller.Content
// that corresponds to caller.Call can be parsed as a call expression.
// If not, the client has provided inconsistent information, possibly
@@ -3439,12 +3350,14 @@ func (st *state) assignStmts(callerStmt *ast.AssignStmt, returnOperands []ast.Ex
freeNames = make(map[string]bool) // free(ish) names among rhs expressions
nonTrivial = make(map[int]bool) // indexes in rhs of nontrivial result conversions
)
+ const includeComplitIdents = true
+
for i, expr := range callerStmt.Rhs {
if expr == caller.Call {
assert(callIdx == -1, "malformed (duplicative) AST")
callIdx = i
for j, returnOperand := range returnOperands {
- freeishNames(freeNames, returnOperand)
+ freeishNames(freeNames, returnOperand, includeComplitIdents)
rhs = append(rhs, returnOperand)
if resultInfo[j]&nonTrivialResult != 0 {
nonTrivial[i+j] = true
@@ -3457,7 +3370,7 @@ func (st *state) assignStmts(callerStmt *ast.AssignStmt, returnOperands []ast.Ex
// We must clone before clearing positions, since e came from the caller.
expr = internalastutil.CloneNode(expr)
clearPositions(expr)
- freeishNames(freeNames, expr)
+ freeishNames(freeNames, expr, includeComplitIdents)
rhs = append(rhs, expr)
}
}
@@ -3733,34 +3646,3 @@ func soleUse(info *types.Info, obj types.Object) (sole *ast.Ident) {
}
type unit struct{} // for representing sets as maps
-
-// slicesDeleteFunc removes any elements from s for which del returns true,
-// returning the modified slice.
-// slicesDeleteFunc zeroes the elements between the new length and the original length.
-// TODO(adonovan): use go1.21 slices.DeleteFunc
-func slicesDeleteFunc[S ~[]E, E any](s S, del func(E) bool) S {
- i := slicesIndexFunc(s, del)
- if i == -1 {
- return s
- }
- // Don't start copying elements until we find one to delete.
- for j := i + 1; j < len(s); j++ {
- if v := s[j]; !del(v) {
- s[i] = v
- i++
- }
- }
- // clear(s[i:]) // zero/nil out the obsolete elements, for GC
- return s[:i]
-}
-
-// slicesIndexFunc returns the first index i satisfying f(s[i]),
-// or -1 if none do.
-func slicesIndexFunc[S ~[]E, E any](s S, f func(E) bool) int {
- for i := range s {
- if f(s[i]) {
- return i
- }
- }
- return -1
-}
diff --git a/internal/refactor/inline/inline_test.go b/internal/refactor/inline/inline_test.go
index 03fb5ccdb17..a3934b5cd68 100644
--- a/internal/refactor/inline/inline_test.go
+++ b/internal/refactor/inline/inline_test.go
@@ -29,10 +29,33 @@ import (
"golang.org/x/tools/internal/expect"
"golang.org/x/tools/internal/refactor/inline"
"golang.org/x/tools/internal/testenv"
+ "golang.org/x/tools/internal/testfiles"
"golang.org/x/tools/txtar"
)
// TestData executes test scenarios specified by files in testdata/*.txtar.
+// Each txtar file describes two sets of files, some containing Go source
+// and others expected results.
+//
+// The Go source files and go.mod are parsed and type-checked as a Go module.
+// Some of these files contain marker comments (in a form described below) describing
+// the inlinings to perform and whether they should succeed or fail. A marker
+// indicating success refers to another file in the txtar, not a .go
+// file, that should contain the contents of the first file after inlining.
+//
+// The marker format for success is
+//
+// @inline(re"pat", wantfile)
+//
+// The first call in the marker's line that matches pat is inlined, and the contents
+// of the resulting file must match the contents of wantfile.
+//
+// The marker format for failure is
+//
+// @inline(re"pat", re"errpat")
+//
+// The first argument selects the call for inlining as before, and the second
+// is a regular expression that must match the text of resulting error.
func TestData(t *testing.T) {
testenv.NeedsGoPackages(t)
@@ -41,7 +64,6 @@ func TestData(t *testing.T) {
t.Fatal(err)
}
for _, file := range files {
- file := file
t.Run(filepath.Base(file), func(t *testing.T) {
t.Parallel()
@@ -56,10 +78,11 @@ func TestData(t *testing.T) {
if err != nil {
t.Fatal(err)
}
- dir := t.TempDir()
- if err := extractTxtar(ar, dir); err != nil {
+ fs, err := txtar.FS(ar)
+ if err != nil {
t.Fatal(err)
}
+ dir := testfiles.CopyToTmp(t, fs)
// Load packages.
cfg := &packages.Config{
@@ -118,8 +141,9 @@ func TestData(t *testing.T) {
var want any
switch x := note.Args[1].(type) {
case string, expect.Identifier:
+ name := fmt.Sprint(x)
for _, file := range ar.Files {
- if file.Name == fmt.Sprint(x) {
+ if file.Name == name {
want = file.Data
break
}
@@ -1769,7 +1793,6 @@ func TestRedundantConversions(t *testing.T) {
func runTests(t *testing.T, tests []testcase) {
for _, test := range tests {
- test := test
t.Run(test.descr, func(t *testing.T) {
fset := token.NewFileSet()
mustParse := func(filename string, content any) *ast.File {
@@ -1860,7 +1883,7 @@ func runTests(t *testing.T, tests []testcase) {
res, err := doIt()
// Want error?
- if rest := strings.TrimPrefix(test.want, "error: "); rest != test.want {
+ if rest, ok := strings.CutPrefix(test.want, "error: "); ok {
if err == nil {
t.Fatalf("unexpected success: want error matching %q", rest)
}
@@ -1941,20 +1964,6 @@ func checkTranscode(callee *inline.Callee) error {
return nil
}
-// TODO(adonovan): publish this a helper (#61386).
-func extractTxtar(ar *txtar.Archive, dir string) error {
- for _, file := range ar.Files {
- name := filepath.Join(dir, file.Name)
- if err := os.MkdirAll(filepath.Dir(name), 0777); err != nil {
- return err
- }
- if err := os.WriteFile(name, file.Data, 0666); err != nil {
- return err
- }
- }
- return nil
-}
-
// deepHash computes a cryptographic hash of an ast.Node so that
// if the data structure is mutated, the hash changes.
// It assumes Go variables do not change address.
@@ -1977,7 +1986,7 @@ func deepHash(n ast.Node) any {
var visit func(reflect.Value)
visit = func(v reflect.Value) {
switch v.Kind() {
- case reflect.Ptr:
+ case reflect.Pointer:
ptr := v.UnsafePointer()
writeUint64(uint64(uintptr(ptr)))
if !v.IsNil() {
diff --git a/internal/refactor/inline/testdata/assignment.txtar b/internal/refactor/inline/testdata/assignment.txtar
index c79c1732934..e201d601480 100644
--- a/internal/refactor/inline/testdata/assignment.txtar
+++ b/internal/refactor/inline/testdata/assignment.txtar
@@ -103,9 +103,7 @@ func _() {
-- b2 --
package a
-import (
- "testdata/b"
-)
+import "testdata/b"
func _() {
var y int
diff --git a/internal/refactor/inline/testdata/import-shadow-1.txtar b/internal/refactor/inline/testdata/import-shadow-1.txtar
new file mode 100644
index 00000000000..dc960ac3213
--- /dev/null
+++ b/internal/refactor/inline/testdata/import-shadow-1.txtar
@@ -0,0 +1,48 @@
+This file is identical to import-shadow.txtar except
+that the imports in a/a.go are not grouped.
+That is unusual, since goimports and related tools
+form groups.
+
+The result of inlining (bresult) also looks strange,
+but again, goimports would fix it up.
+
+-- go.mod --
+module testdata
+go 1.12
+
+-- a/a.go --
+package a
+
+import "testdata/b"
+import "log"
+
+func A() {
+ const log = "shadow"
+ b.B() //@ inline(re"B", bresult)
+}
+
+var _ log.Logger
+
+-- b/b.go --
+package b
+
+import "log"
+
+func B() {
+ log.Printf("")
+}
+
+-- bresult --
+package a
+
+import (
+ log0 "log"
+)
+import "log"
+
+func A() {
+ const log = "shadow"
+ log0.Printf("") //@ inline(re"B", bresult)
+}
+
+var _ log.Logger
diff --git a/internal/refactor/inline/testdata/import-shadow-2.txtar b/internal/refactor/inline/testdata/import-shadow-2.txtar
new file mode 100644
index 00000000000..14cd045c6c3
--- /dev/null
+++ b/internal/refactor/inline/testdata/import-shadow-2.txtar
@@ -0,0 +1,75 @@
+See import-shadow.txtar for a description.
+
+-- go.mod --
+module testdata
+go 1.12
+
+-- a/a.go --
+package a
+
+import "testdata/b"
+
+var x b.T
+
+func A(b int) {
+ x.F() //@ inline(re"F", fresult)
+}
+
+-- b/b.go --
+package b
+
+type T struct{}
+
+func (T) F() {
+ One()
+ Two()
+}
+
+func One() {}
+func Two() {}
+
+-- fresult --
+package a
+
+import (
+ "testdata/b"
+ b0 "testdata/b"
+)
+
+var x b.T
+
+func A(b int) {
+ b0.One()
+ b0.Two() //@ inline(re"F", fresult)
+}
+
+-- d/d.go --
+package d
+
+import "testdata/e"
+
+func D() {
+ const log = "shadow"
+ e.E() //@ inline(re"E", eresult)
+}
+
+-- e/e.go --
+package e
+
+import "log"
+
+func E() {
+ log.Printf("")
+}
+
+-- eresult --
+package d
+
+import (
+ log0 "log"
+)
+
+func D() {
+ const log = "shadow"
+ log0.Printf("") //@ inline(re"E", eresult)
+}
diff --git a/internal/refactor/inline/testdata/import-shadow.txtar b/internal/refactor/inline/testdata/import-shadow.txtar
index 9d1abdb9e95..c4ea9a61624 100644
--- a/internal/refactor/inline/testdata/import-shadow.txtar
+++ b/internal/refactor/inline/testdata/import-shadow.txtar
@@ -2,10 +2,10 @@ Just because a package (e.g. log) is imported by the caller,
and the name log is in scope, doesn't mean the name in scope
refers to the package: it could be locally shadowed.
-In all three scenarios below, renaming import with a fresh name is
-added because the usual name is locally shadowed: in cases 1, 2 an
-existing import is shadowed by (respectively) a local constant,
-parameter; in case 3 there is no existing import.
+In all three scenarios in this file and import-shadow-2.txtar, a renaming
+import with a fresh name is added because the usual name is locally
+shadowed: in cases 1, 2 an existing import is shadowed by (respectively)
+a local constant, parameter; in case 3 there is no existing import.
-- go.mod --
module testdata
@@ -14,8 +14,10 @@ go 1.12
-- a/a.go --
package a
-import "testdata/b"
-import "log"
+import (
+ "testdata/b"
+ "log"
+)
func A() {
const log = "shadow"
@@ -47,77 +49,3 @@ func A() {
}
var _ log.Logger
-
--- go.mod --
-module testdata
-go 1.12
-
--- a/a.go --
-package a
-
-import "testdata/b"
-
-var x b.T
-
-func A(b int) {
- x.F() //@ inline(re"F", fresult)
-}
-
--- b/b.go --
-package b
-
-type T struct{}
-
-func (T) F() {
- One()
- Two()
-}
-
-func One() {}
-func Two() {}
-
--- fresult --
-package a
-
-import (
- "testdata/b"
- b0 "testdata/b"
-)
-
-var x b.T
-
-func A(b int) {
- b0.One()
- b0.Two() //@ inline(re"F", fresult)
-}
-
--- d/d.go --
-package d
-
-import "testdata/e"
-
-func D() {
- const log = "shadow"
- e.E() //@ inline(re"E", eresult)
-}
-
--- e/e.go --
-package e
-
-import "log"
-
-func E() {
- log.Printf("")
-}
-
--- eresult --
-package d
-
-import (
- log0 "log"
-)
-
-func D() {
- const log = "shadow"
- log0.Printf("") //@ inline(re"E", eresult)
-}
diff --git a/internal/refactor/inline/util.go b/internal/refactor/inline/util.go
index 591dc4265c0..c3f049c73b0 100644
--- a/internal/refactor/inline/util.go
+++ b/internal/refactor/inline/util.go
@@ -22,16 +22,6 @@ func is[T any](x any) bool {
return ok
}
-// TODO(adonovan): use go1.21's slices.Index.
-func index[T comparable](slice []T, x T) int {
- for i, elem := range slice {
- if elem == x {
- return i
- }
- }
- return -1
-}
-
func btoi(b bool) int {
if b {
return 1
diff --git a/internal/robustio/copyfiles.go b/internal/robustio/copyfiles.go
index 8c93fcd7163..8aace49da8b 100644
--- a/internal/robustio/copyfiles.go
+++ b/internal/robustio/copyfiles.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build ignore
-// +build ignore
// The copyfiles script copies the contents of the internal cmd/go robustio
// package to the current directory, with adjustments to make it build.
diff --git a/internal/robustio/robustio_flaky.go b/internal/robustio/robustio_flaky.go
index d5c241857b4..c56e36ca624 100644
--- a/internal/robustio/robustio_flaky.go
+++ b/internal/robustio/robustio_flaky.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build windows || darwin
-// +build windows darwin
package robustio
diff --git a/internal/robustio/robustio_other.go b/internal/robustio/robustio_other.go
index 3a20cac6cf8..da9a46e4fac 100644
--- a/internal/robustio/robustio_other.go
+++ b/internal/robustio/robustio_other.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build !windows && !darwin
-// +build !windows,!darwin
package robustio
diff --git a/internal/robustio/robustio_plan9.go b/internal/robustio/robustio_plan9.go
index 9fa4cacb5a3..3026b9f6321 100644
--- a/internal/robustio/robustio_plan9.go
+++ b/internal/robustio/robustio_plan9.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build plan9
-// +build plan9
package robustio
diff --git a/internal/robustio/robustio_posix.go b/internal/robustio/robustio_posix.go
index cf74865d0b5..6b4beec96fc 100644
--- a/internal/robustio/robustio_posix.go
+++ b/internal/robustio/robustio_posix.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build !windows && !plan9
-// +build !windows,!plan9
package robustio
diff --git a/internal/stdlib/deps.go b/internal/stdlib/deps.go
new file mode 100644
index 00000000000..c50bf406b7f
--- /dev/null
+++ b/internal/stdlib/deps.go
@@ -0,0 +1,359 @@
+// Copyright 2025 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.
+
+// Code generated by generate.go. DO NOT EDIT.
+
+package stdlib
+
+type pkginfo struct {
+ name string
+ deps string // list of indices of dependencies, as varint-encoded deltas
+}
+
+var deps = [...]pkginfo{
+ {"archive/tar", "\x03j\x03E6\x01\v\x01\"\x01\x01\x02\x05\n\x02\x01\x02\x02\v"},
+ {"archive/zip", "\x02\x04`\a\x16\x0206\x01*\x05\x01\x11\x03\x02\r\x04"},
+ {"bufio", "\x03j~E\x13"},
+ {"bytes", "m+S\x03\fG\x02\x02"},
+ {"cmp", ""},
+ {"compress/bzip2", "\x02\x02\xe7\x01B"},
+ {"compress/flate", "\x02k\x03{\r\x024\x01\x03"},
+ {"compress/gzip", "\x02\x04`\a\x03\x15fT"},
+ {"compress/lzw", "\x02k\x03{"},
+ {"compress/zlib", "\x02\x04`\a\x03\x13\x01g"},
+ {"container/heap", "\xae\x02"},
+ {"container/list", ""},
+ {"container/ring", ""},
+ {"context", "m\\i\x01\f"},
+ {"crypto", "\x83\x01hD"},
+ {"crypto/aes", "\x10\n\a\x8e\x02"},
+ {"crypto/cipher", "\x03\x1e\x01\x01\x1d\x11\x1c,R"},
+ {"crypto/des", "\x10\x13\x1d-,\x96\x01\x03"},
+ {"crypto/dsa", "@\x04)~\x0e"},
+ {"crypto/ecdh", "\x03\v\f\x0e\x04\x14\x04\r\x1c~"},
+ {"crypto/ecdsa", "\x0e\x05\x03\x04\x01\x0e\x16\x01\x04\f\x01\x1c~\x0e\x04K\x01"},
+ {"crypto/ed25519", "\x0e\x1c\x16\n\a\x1c~D"},
+ {"crypto/elliptic", "0=~\x0e9"},
+ {"crypto/fips140", " \x05\x90\x01"},
+ {"crypto/hkdf", "-\x12\x01-\x16"},
+ {"crypto/hmac", "\x1a\x14\x11\x01\x112"},
+ {"crypto/internal/boring", "\x0e\x02\rf"},
+ {"crypto/internal/boring/bbig", "\x1a\xdf\x01L"},
+ {"crypto/internal/boring/bcache", "\xb3\x02\x12"},
+ {"crypto/internal/boring/sig", ""},
+ {"crypto/internal/cryptotest", "\x03\r\n)\x0e\x19\x06\x13\x12#\a\t\x11\x12\x11\x1a\r\r\x05\n"},
+ {"crypto/internal/entropy", "E"},
+ {"crypto/internal/fips140", ">/~8\r\x15"},
+ {"crypto/internal/fips140/aes", "\x03\x1d\x03\x02\x13\x04\x01\x01\x05*\x8d\x015"},
+ {"crypto/internal/fips140/aes/gcm", " \x01\x02\x02\x02\x11\x04\x01\x06*\x8b\x01"},
+ {"crypto/internal/fips140/alias", "\xc5\x02"},
+ {"crypto/internal/fips140/bigmod", "%\x17\x01\x06*\x8d\x01"},
+ {"crypto/internal/fips140/check", " \x0e\x06\b\x02\xad\x01Z"},
+ {"crypto/internal/fips140/check/checktest", "%\xfe\x01\""},
+ {"crypto/internal/fips140/drbg", "\x03\x1c\x01\x01\x04\x13\x04\b\x01(~\x0f8"},
+ {"crypto/internal/fips140/ecdh", "\x03\x1d\x05\x02\t\f1~\x0f8"},
+ {"crypto/internal/fips140/ecdsa", "\x03\x1d\x04\x01\x02\a\x02\x067~G"},
+ {"crypto/internal/fips140/ed25519", "\x03\x1d\x05\x02\x04\v7\xc2\x01\x03"},
+ {"crypto/internal/fips140/edwards25519", "%\a\f\x041\x8d\x018"},
+ {"crypto/internal/fips140/edwards25519/field", "%\x13\x041\x8d\x01"},
+ {"crypto/internal/fips140/hkdf", "\x03\x1d\x05\t\x069"},
+ {"crypto/internal/fips140/hmac", "\x03\x1d\x14\x01\x017"},
+ {"crypto/internal/fips140/mlkem", "\x03\x1d\x05\x02\x0e\x03\x041"},
+ {"crypto/internal/fips140/nistec", "%\f\a\x041\x8d\x01)\x0f\x13"},
+ {"crypto/internal/fips140/nistec/fiat", "%\x135\x8d\x01"},
+ {"crypto/internal/fips140/pbkdf2", "\x03\x1d\x05\t\x069"},
+ {"crypto/internal/fips140/rsa", "\x03\x1d\x04\x01\x02\r\x01\x01\x025~G"},
+ {"crypto/internal/fips140/sha256", "\x03\x1d\x1c\x01\x06*\x8d\x01"},
+ {"crypto/internal/fips140/sha3", "\x03\x1d\x18\x04\x010\x8d\x01K"},
+ {"crypto/internal/fips140/sha512", "\x03\x1d\x1c\x01\x06*\x8d\x01"},
+ {"crypto/internal/fips140/ssh", " \x05"},
+ {"crypto/internal/fips140/subtle", "#"},
+ {"crypto/internal/fips140/tls12", "\x03\x1d\x05\t\x06\x027"},
+ {"crypto/internal/fips140/tls13", "\x03\x1d\x05\b\a\b1"},
+ {"crypto/internal/fips140deps", ""},
+ {"crypto/internal/fips140deps/byteorder", "\x99\x01"},
+ {"crypto/internal/fips140deps/cpu", "\xad\x01\a"},
+ {"crypto/internal/fips140deps/godebug", "\xb5\x01"},
+ {"crypto/internal/fips140hash", "5\x1a4\xc2\x01"},
+ {"crypto/internal/fips140only", "'\r\x01\x01M26"},
+ {"crypto/internal/fips140test", ""},
+ {"crypto/internal/hpke", "\x0e\x01\x01\x03\x1a\x1d#,aM"},
+ {"crypto/internal/impl", "\xb0\x02"},
+ {"crypto/internal/randutil", "\xeb\x01\x12"},
+ {"crypto/internal/sysrand", "mi\"\x1e\r\x0f\x01\x01\v\x06"},
+ {"crypto/internal/sysrand/internal/seccomp", "m"},
+ {"crypto/md5", "\x0e2-\x16\x16a"},
+ {"crypto/mlkem", "/"},
+ {"crypto/pbkdf2", "2\r\x01-\x16"},
+ {"crypto/rand", "\x1a\x06\a\x19\x04\x01(~\x0eL"},
+ {"crypto/rc4", "#\x1d-\xc2\x01"},
+ {"crypto/rsa", "\x0e\f\x01\t\x0f\f\x01\x04\x06\a\x1c\x03\x1326\r\x01"},
+ {"crypto/sha1", "\x0e\f&-\x16\x16\x14M"},
+ {"crypto/sha256", "\x0e\f\x1aO"},
+ {"crypto/sha3", "\x0e'N\xc2\x01"},
+ {"crypto/sha512", "\x0e\f\x1cM"},
+ {"crypto/subtle", "8\x96\x01U"},
+ {"crypto/tls", "\x03\b\x02\x01\x01\x01\x01\x02\x01\x01\x01\x03\x01\a\x01\v\x02\n\x01\b\x05\x03\x01\x01\x01\x01\x02\x01\x02\x01\x17\x02\x03\x13\x16\x14\b6\x16\x15\r\n\x01\x01\x01\x02\x01\f\x06\x02\x01"},
+ {"crypto/tls/internal/fips140tls", " \x93\x02"},
+ {"crypto/x509", "\x03\v\x01\x01\x01\x01\x01\x01\x01\x011\x03\x02\x01\x01\x02\x05\x0e\x06\x02\x02\x03E\x033\x01\x02\t\x01\x01\x01\a\x0f\x05\x01\x06\x02\x05\f\x01\x02\r\x02\x01\x01\x02\x03\x01"},
+ {"crypto/x509/pkix", "c\x06\a\x89\x01F"},
+ {"database/sql", "\x03\nJ\x16\x03{\f\x06!\x05\n\x02\x03\x01\f\x02\x02\x02"},
+ {"database/sql/driver", "\r`\x03\xae\x01\x11\x10"},
+ {"debug/buildinfo", "\x03W\x02\x01\x01\b\a\x03`\x19\x02\x01*\x0f "},
+ {"debug/dwarf", "\x03c\a\x03{0\x13\x01\x01"},
+ {"debug/elf", "\x03\x06P\r\a\x03`\x1a\x01+\x19\x01\x15"},
+ {"debug/gosym", "\x03c\n\xbe\x01\x01\x01\x02"},
+ {"debug/macho", "\x03\x06P\r\n`\x1b+\x19\x01"},
+ {"debug/pe", "\x03\x06P\r\a\x03`\x1b+\x19\x01\x15"},
+ {"debug/plan9obj", "f\a\x03`\x1b+"},
+ {"embed", "m+:\x19\x01S"},
+ {"embed/internal/embedtest", ""},
+ {"encoding", ""},
+ {"encoding/ascii85", "\xeb\x01D"},
+ {"encoding/asn1", "\x03j\x03\x88\x01\x01%\x0f\x02\x01\x0f\x03\x01"},
+ {"encoding/base32", "\xeb\x01B\x02"},
+ {"encoding/base64", "f\x85\x01B\x02"},
+ {"encoding/binary", "m~\r&\x0f\x05"},
+ {"encoding/csv", "\x02\x01j\x03{E\x11\x02"},
+ {"encoding/gob", "\x02_\x05\a\x03`\x1b\f\x01\x02\x1c\b\x14\x01\x0e\x02"},
+ {"encoding/hex", "m\x03{B\x03"},
+ {"encoding/json", "\x03\x01]\x04\b\x03{\r&\x0f\x02\x01\x02\x0f\x01\x01\x02"},
+ {"encoding/pem", "\x03b\b~B\x03"},
+ {"encoding/xml", "\x02\x01^\f\x03{3\x05\f\x01\x02\x0f\x02"},
+ {"errors", "\xc9\x01|"},
+ {"expvar", "jK:\t\n\x14\r\n\x02\x03\x01\x10"},
+ {"flag", "a\f\x03{+\b\x05\n\x02\x01\x0f"},
+ {"fmt", "mE9\r\x1e\b\x0f\x02\x03\x11"},
+ {"go/ast", "\x03\x01l\x0f\x01k\x03(\b\x0f\x02\x01"},
+ {"go/ast/internal/tests", ""},
+ {"go/build", "\x02\x01j\x03\x01\x03\x02\a\x02\x01\x17\x1e\x04\x02\t\x14\x13\x01*\x01\x04\x01\a\n\x02\x01\x11\x02\x02"},
+ {"go/build/constraint", "m\xc2\x01\x01\x11\x02"},
+ {"go/constant", "p\x10x\x01\x015\x01\x02\x11"},
+ {"go/doc", "\x04l\x01\x06\t=.0\x12\x02\x01\x11\x02"},
+ {"go/doc/comment", "\x03m\xbd\x01\x01\x01\x01\x11\x02"},
+ {"go/format", "\x03m\x01\f\x01\x02kE"},
+ {"go/importer", "s\a\x01\x01\x04\x01j8"},
+ {"go/internal/gccgoimporter", "\x02\x01W\x13\x03\x05\v\x01h\x02+\x01\x05\x13\x01\v\b"},
+ {"go/internal/gcimporter", "\x02n\x10\x01/\x05\x0e(+\x17\x03\x02"},
+ {"go/internal/srcimporter", "p\x01\x02\n\x03\x01j+\x01\x05\x14\x02\x13"},
+ {"go/parser", "\x03j\x03\x01\x03\v\x01k\x01*\x06\x14"},
+ {"go/printer", "p\x01\x03\x03\tk\r\x1e\x17\x02\x01\x02\n\x05\x02"},
+ {"go/scanner", "\x03m\x10k1\x12\x01\x12\x02"},
+ {"go/token", "\x04l\xbd\x01\x02\x03\x01\x0e\x02"},
+ {"go/types", "\x03\x01\x06c\x03\x01\x04\b\x03\x02\x15\x1e\x06,\x04\x03\n$\a\n\x01\x01\x01\x02\x01\x0e\x02\x02"},
+ {"go/version", "\xba\x01v"},
+ {"hash", "\xeb\x01"},
+ {"hash/adler32", "m\x16\x16"},
+ {"hash/crc32", "m\x16\x16\x14\x85\x01\x01\x12"},
+ {"hash/crc64", "m\x16\x16\x99\x01"},
+ {"hash/fnv", "m\x16\x16a"},
+ {"hash/maphash", "\x94\x01\x05\x1b\x03AM"},
+ {"html", "\xb0\x02\x02\x11"},
+ {"html/template", "\x03g\x06\x19,6\x01\v\x1f\x05\x01\x02\x03\x0e\x01\x02\v\x01\x03\x02"},
+ {"image", "\x02k\x1f_\x0f5\x03\x01"},
+ {"image/color", ""},
+ {"image/color/palette", "\x8c\x01"},
+ {"image/draw", "\x8b\x01\x01\x04"},
+ {"image/gif", "\x02\x01\x05e\x03\x1b\x01\x01\x01\vR"},
+ {"image/internal/imageutil", "\x8b\x01"},
+ {"image/jpeg", "\x02k\x1e\x01\x04["},
+ {"image/png", "\x02\a]\n\x13\x02\x06\x01_D"},
+ {"index/suffixarray", "\x03c\a~\r)\f\x01"},
+ {"internal/abi", "\xb4\x01\x91\x01"},
+ {"internal/asan", "\xc5\x02"},
+ {"internal/bisect", "\xa3\x02\x0f\x01"},
+ {"internal/buildcfg", "pG_\x06\x02\x05\f\x01"},
+ {"internal/bytealg", "\xad\x01\x98\x01"},
+ {"internal/byteorder", ""},
+ {"internal/cfg", ""},
+ {"internal/chacha8rand", "\x99\x01\x1b\x91\x01"},
+ {"internal/copyright", ""},
+ {"internal/coverage", ""},
+ {"internal/coverage/calloc", ""},
+ {"internal/coverage/cfile", "j\x06\x17\x16\x01\x02\x01\x01\x01\x01\x01\x01\x01#\x01 +\x06\a\f\x01\x03\f\x06"},
+ {"internal/coverage/cformat", "\x04l-\x04J\f6\x01\x02\f"},
+ {"internal/coverage/cmerge", "p-["},
+ {"internal/coverage/decodecounter", "f\n-\v\x02A+\x19\x16"},
+ {"internal/coverage/decodemeta", "\x02d\n\x17\x16\v\x02A+"},
+ {"internal/coverage/encodecounter", "\x02d\n-\f\x01\x02?\f\x1f\x17"},
+ {"internal/coverage/encodemeta", "\x02\x01c\n\x13\x04\x16\r\x02?+/"},
+ {"internal/coverage/pods", "\x04l-y\x06\x05\f\x02\x01"},
+ {"internal/coverage/rtcov", "\xc5\x02"},
+ {"internal/coverage/slicereader", "f\n{Z"},
+ {"internal/coverage/slicewriter", "p{"},
+ {"internal/coverage/stringtab", "p8\x04?"},
+ {"internal/coverage/test", ""},
+ {"internal/coverage/uleb128", ""},
+ {"internal/cpu", "\xc5\x02"},
+ {"internal/dag", "\x04l\xbd\x01\x03"},
+ {"internal/diff", "\x03m\xbe\x01\x02"},
+ {"internal/exportdata", "\x02\x01j\x03\x03]\x1b+\x01\x05\x13\x01\x02"},
+ {"internal/filepathlite", "m+:\x1aA"},
+ {"internal/fmtsort", "\x04\x9a\x02\x0f"},
+ {"internal/fuzz", "\x03\nA\x18\x04\x03\x03\x01\f\x0356\r\x02\x1c\x01\x05\x02\x05\f\x01\x02\x01\x01\v\x04\x02"},
+ {"internal/goarch", ""},
+ {"internal/godebug", "\x96\x01 |\x01\x12"},
+ {"internal/godebugs", ""},
+ {"internal/goexperiment", ""},
+ {"internal/goos", ""},
+ {"internal/goroot", "\x96\x02\x01\x05\x14\x02"},
+ {"internal/gover", "\x04"},
+ {"internal/goversion", ""},
+ {"internal/itoa", ""},
+ {"internal/lazyregexp", "\x96\x02\v\x0f\x02"},
+ {"internal/lazytemplate", "\xeb\x01+\x1a\x02\v"},
+ {"internal/msan", "\xc5\x02"},
+ {"internal/nettrace", ""},
+ {"internal/obscuretestdata", "e\x86\x01+"},
+ {"internal/oserror", "m"},
+ {"internal/pkgbits", "\x03K\x18\a\x03\x05\vk\x0e\x1d\r\f\x01"},
+ {"internal/platform", ""},
+ {"internal/poll", "mO\x1a\x158\x0f\x01\x01\v\x06"},
+ {"internal/profile", "\x03\x04f\x03{6\r\x01\x01\x0f"},
+ {"internal/profilerecord", ""},
+ {"internal/race", "\x94\x01\xb1\x01"},
+ {"internal/reflectlite", "\x94\x01 4;\""},
+ {"internal/runtime/atomic", "\xc5\x02"},
+ {"internal/runtime/exithook", "\xca\x01{"},
+ {"internal/runtime/maps", "\x94\x01\x01\x1f\v\t\x05\x01w"},
+ {"internal/runtime/math", "\xb4\x01"},
+ {"internal/runtime/sys", "\xb4\x01\x04"},
+ {"internal/runtime/syscall", "\xc5\x02"},
+ {"internal/saferio", "\xeb\x01Z"},
+ {"internal/singleflight", "\xb2\x02"},
+ {"internal/stringslite", "\x98\x01\xad\x01"},
+ {"internal/sync", "\x94\x01 \x14k\x12"},
+ {"internal/synctest", "\xc5\x02"},
+ {"internal/syscall/execenv", "\xb4\x02"},
+ {"internal/syscall/unix", "\xa3\x02\x10\x01\x11"},
+ {"internal/sysinfo", "\x02\x01\xaa\x01>+\x1a\x02"},
+ {"internal/syslist", ""},
+ {"internal/testenv", "\x03\n`\x02\x01*\x1a\x10(*\x01\x05\a\f\x01\x02\x02\x01\n"},
+ {"internal/testlog", "\xb2\x02\x01\x12"},
+ {"internal/testpty", "m\x03\xa6\x01"},
+ {"internal/trace", "\x02\x01\x01\x06\\\a\x03m\x01\x01\x06\x06\x03\n5\x01\x02\x0f"},
+ {"internal/trace/event", ""},
+ {"internal/trace/event/go122", "pm"},
+ {"internal/trace/internal/oldtrace", "\x03\x01b\a\x03m\b\x06\r5\x01"},
+ {"internal/trace/internal/testgen/go122", "\x03c\nl\x01\x01\x03\x04\x010\v\x0f"},
+ {"internal/trace/raw", "\x02d\nm\b\x06D\x01\x11"},
+ {"internal/trace/testtrace", "\x02\x01j\x03l\x05\x05\x056\f\x02\x01"},
+ {"internal/trace/traceviewer", "\x02]\v\x06\x1a<\x16\b\a\x04\t\n\x14\x01\x05\a\f\x01\x02\r"},
+ {"internal/trace/traceviewer/format", ""},
+ {"internal/trace/version", "pm\x01\r"},
+ {"internal/txtar", "\x03m\xa6\x01\x1a"},
+ {"internal/types/errors", "\xaf\x02"},
+ {"internal/unsafeheader", "\xc5\x02"},
+ {"internal/xcoff", "Y\r\a\x03`\x1b+\x19\x01"},
+ {"internal/zstd", "f\a\x03{\x0f"},
+ {"io", "m\xc5\x01"},
+ {"io/fs", "m+*)0\x12\x12\x04"},
+ {"io/ioutil", "\xeb\x01\x01*\x17\x03"},
+ {"iter", "\xc8\x01[\""},
+ {"log", "p{\x05&\r\x0f\x01\f"},
+ {"log/internal", ""},
+ {"log/slog", "\x03\nT\t\x03\x03{\x04\x01\x02\x02\x04&\x05\n\x02\x01\x02\x01\f\x02\x02\x02"},
+ {"log/slog/internal", ""},
+ {"log/slog/internal/benchmarks", "\r`\x03{\x06\x03;\x10"},
+ {"log/slog/internal/buffer", "\xb2\x02"},
+ {"log/slog/internal/slogtest", "\xf1\x01"},
+ {"log/syslog", "m\x03\x7f\x12\x15\x1a\x02\r"},
+ {"maps", "\xee\x01W"},
+ {"math", "\xad\x01MK"},
+ {"math/big", "\x03j\x03)\x14>\r\x02\x023\x01\x02\x13"},
+ {"math/bits", "\xc5\x02"},
+ {"math/cmplx", "\xf8\x01\x02"},
+ {"math/rand", "\xb5\x01C:\x01\x12"},
+ {"math/rand/v2", "m,\x02]\x02K"},
+ {"mime", "\x02\x01b\b\x03{\f\x1f\x17\x03\x02\x0f\x02"},
+ {"mime/multipart", "\x02\x01G#\x03E6\f\x01\x06\x02\x14\x02\x06\x11\x02\x01\x15"},
+ {"mime/quotedprintable", "\x02\x01m{"},
+ {"net", "\x04\t`+\x1d\a\x04\x05\f\x01\x04\x15\x01$\x06\r\n\x05\x01\x01\v\x06\a"},
+ {"net/http", "\x02\x01\x04\x04\x02=\b\x13\x01\a\x03E6\x01\x03\b\x01\x02\x02\x02\x01\x02\x06\x02\x01\n\x01\x01\x05\x01\x02\x05\n\x01\x01\x01\x02\x01\f\x02\x02\x02\b\x01\x01\x01"},
+ {"net/http/cgi", "\x02P\x1b\x03{\x04\b\n\x01\x12\x01\x01\x01\x04\x01\x05\x02\n\x02\x01\x0f\x0e"},
+ {"net/http/cookiejar", "\x04i\x03\x91\x01\x01\b\v\x18\x03\x02\r\x04"},
+ {"net/http/fcgi", "\x02\x01\nY\a\x03{\x16\x01\x01\x13\x1a\x02\r"},
+ {"net/http/httptest", "\x02\x01\nE\x02\x1b\x01{\x04\x12\x01\t\t\x02\x19\x01\x02\r\x0e"},
+ {"net/http/httptrace", "\rEnA\x13\n!"},
+ {"net/http/httputil", "\x02\x01\n`\x03{\x04\x0f\x03\x01\x05\x02\x01\n\x01\x1b\x02\r\x0e"},
+ {"net/http/internal", "\x02\x01j\x03{"},
+ {"net/http/internal/ascii", "\xb0\x02\x11"},
+ {"net/http/internal/testcert", "\xb0\x02"},
+ {"net/http/pprof", "\x02\x01\nc\x19,\x11%\x04\x13\x13\x01\r\x06\x03\x01\x02\x01\x0f"},
+ {"net/internal/cgotest", ""},
+ {"net/internal/socktest", "p\xc2\x01\x02"},
+ {"net/mail", "\x02k\x03{\x04\x0f\x03\x13\x1c\x02\r\x04"},
+ {"net/netip", "\x04i+\x01#<\x025\x15"},
+ {"net/rpc", "\x02f\x05\x03\x10\na\x04\x12\x01\x1c\x0f\x03\x02"},
+ {"net/rpc/jsonrpc", "j\x03\x03{\x16\x10!"},
+ {"net/smtp", "\x19.\v\x13\b\x03{\x16\x13\x1c"},
+ {"net/textproto", "\x02\x01j\x03{\r\t.\x01\x02\x13"},
+ {"net/url", "m\x03\x87\x01$\x12\x02\x01\x15"},
+ {"os", "m+\x01\x18\x03\b\t\r\x03\x01\x04\x11\x017\n\x05\x01\x01\v\x06"},
+ {"os/exec", "\x03\n`H \x01\x15\x01*\x06\a\f\x01\x04\v"},
+ {"os/exec/internal/fdtest", "\xb4\x02"},
+ {"os/signal", "\r\x89\x02\x17\x05\x02"},
+ {"os/user", "\x02\x01j\x03{+\r\f\x01\x02"},
+ {"path", "m+\xab\x01"},
+ {"path/filepath", "m+\x19;*\r\n\x03\x04\x0f"},
+ {"plugin", "m"},
+ {"reflect", "m'\x04\x1c\b\f\x04\x02\x1a\x06\n+\f\x03\x0f\x02\x02"},
+ {"reflect/internal/example1", ""},
+ {"reflect/internal/example2", ""},
+ {"regexp", "\x03\xe8\x017\v\x02\x01\x02\x0f\x02"},
+ {"regexp/syntax", "\xad\x02\x01\x01\x01\x11\x02"},
+ {"runtime", "\x94\x01\x04\x01\x02\f\x06\a\x02\x01\x01\x0f\x03\x01\x01\x01\x01\x01\x03s"},
+ {"runtime/coverage", "\x9f\x01L"},
+ {"runtime/debug", "pUQ\r\n\x02\x01\x0f\x06"},
+ {"runtime/internal/startlinetest", ""},
+ {"runtime/internal/wasitest", ""},
+ {"runtime/metrics", "\xb6\x01B+\""},
+ {"runtime/pprof", "\x02\x01\x01\x03\x06Y\a\x03$3$\r\x1e\r\n\x01\x01\x01\x02\x02\b\x03\x06"},
+ {"runtime/race", "\xab\x02"},
+ {"runtime/race/internal/amd64v1", ""},
+ {"runtime/trace", "\rc{8\x0f\x01\x12"},
+ {"slices", "\x04\xea\x01\fK"},
+ {"sort", "\xc9\x0113"},
+ {"strconv", "m+:&\x02I"},
+ {"strings", "m'\x04:\x19\x03\f8\x0f\x02\x02"},
+ {"structs", ""},
+ {"sync", "\xc8\x01\vP\x10\x12"},
+ {"sync/atomic", "\xc5\x02"},
+ {"syscall", "m(\x03\x01\x1b\b\x03\x03\x06\aT\x0f\x01\x12"},
+ {"testing", "\x03\n`\x02\x01G\x11\x0f\x14\r\x04\x1a\x06\x02\x05\x02\a\x01\x02\x01\x02\x01\f\x02\x02\x02"},
+ {"testing/fstest", "m\x03{\x01\v$\x12\x03\b\a"},
+ {"testing/internal/testdeps", "\x02\v\xa6\x01'\x11+\x03\x05\x03\b\a\x02\r"},
+ {"testing/iotest", "\x03j\x03{\x04"},
+ {"testing/quick", "o\x01\x88\x01\x04\"\x12\x0f"},
+ {"testing/slogtest", "\r`\x03\x81\x01-\x05\x12\n"},
+ {"text/scanner", "\x03m{++\x02"},
+ {"text/tabwriter", "p{X"},
+ {"text/template", "m\x03B9\x01\v\x1e\x01\x05\x01\x02\x05\r\x02\f\x03\x02"},
+ {"text/template/parse", "\x03m\xb3\x01\f\x01\x11\x02"},
+ {"time", "m+\x1d\x1d()\x0f\x02\x11"},
+ {"time/tzdata", "m\xc7\x01\x11"},
+ {"unicode", ""},
+ {"unicode/utf16", ""},
+ {"unicode/utf8", ""},
+ {"unique", "\x94\x01>\x01P\x0f\x13\x12"},
+ {"unsafe", ""},
+ {"vendor/golang.org/x/crypto/chacha20", "\x10V\a\x8d\x01)'"},
+ {"vendor/golang.org/x/crypto/chacha20poly1305", "\x10V\a\xd9\x01\x04\x01\a"},
+ {"vendor/golang.org/x/crypto/cryptobyte", "c\n\x03\x89\x01%!\n"},
+ {"vendor/golang.org/x/crypto/cryptobyte/asn1", ""},
+ {"vendor/golang.org/x/crypto/internal/alias", "\xc5\x02"},
+ {"vendor/golang.org/x/crypto/internal/poly1305", "Q\x15\x94\x01"},
+ {"vendor/golang.org/x/net/dns/dnsmessage", "m"},
+ {"vendor/golang.org/x/net/http/httpguts", "\x81\x02\x13\x1c\x13\r"},
+ {"vendor/golang.org/x/net/http/httpproxy", "m\x03\x91\x01\x0f\x05\x01\x1a\x13\r"},
+ {"vendor/golang.org/x/net/http2/hpack", "\x03j\x03{G"},
+ {"vendor/golang.org/x/net/idna", "p\x88\x018\x13\x10\x02\x01"},
+ {"vendor/golang.org/x/net/nettest", "\x03c\a\x03{\x11\x05\x15\x01\f\f\x01\x02\x02\x01\n"},
+ {"vendor/golang.org/x/sys/cpu", "\x96\x02\r\f\x01\x15"},
+ {"vendor/golang.org/x/text/secure/bidirule", "m\xd6\x01\x11\x01"},
+ {"vendor/golang.org/x/text/transform", "\x03j~X"},
+ {"vendor/golang.org/x/text/unicode/bidi", "\x03\be\x7f?\x15"},
+ {"vendor/golang.org/x/text/unicode/norm", "f\n{G\x11\x11"},
+ {"weak", "\x94\x01\x8f\x01\""},
+}
diff --git a/internal/stdlib/deps_test.go b/internal/stdlib/deps_test.go
new file mode 100644
index 00000000000..41d2d126ec5
--- /dev/null
+++ b/internal/stdlib/deps_test.go
@@ -0,0 +1,36 @@
+// Copyright 2025 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 stdlib_test
+
+import (
+ "iter"
+ "os"
+ "slices"
+ "sort"
+ "strings"
+ "testing"
+
+ "github.com/google/go-cmp/cmp"
+ "golang.org/x/tools/internal/stdlib"
+)
+
+func TestImports(t *testing.T) { testDepsFunc(t, "testdata/nethttp.imports", stdlib.Imports) }
+func TestDeps(t *testing.T) { testDepsFunc(t, "testdata/nethttp.deps", stdlib.Dependencies) }
+
+// testDepsFunc checks that the specified dependency function applied
+// to net/http returns the set of dependencies in the named file.
+func testDepsFunc(t *testing.T, filename string, depsFunc func(pkgs ...string) iter.Seq[string]) {
+ data, err := os.ReadFile(filename)
+ if err != nil {
+ t.Fatal(err)
+ }
+ want := strings.Split(strings.TrimSpace(string(data)), "\n")
+ got := slices.Collect(depsFunc("net/http"))
+ sort.Strings(want)
+ sort.Strings(got)
+ if diff := cmp.Diff(got, want); diff != "" {
+ t.Fatalf("Deps mismatch (-want +got):\n%s", diff)
+ }
+}
diff --git a/internal/stdlib/generate.go b/internal/stdlib/generate.go
index d4964f60955..cfef0a2438f 100644
--- a/internal/stdlib/generate.go
+++ b/internal/stdlib/generate.go
@@ -3,16 +3,22 @@
// license that can be found in the LICENSE file.
//go:build ignore
-// +build ignore
// The generate command reads all the GOROOT/api/go1.*.txt files and
// generates a single combined manifest.go file containing the Go
// standard library API symbols along with versions.
+//
+// It also runs "go list -deps std" and records the import graph. This
+// information may be used, for example, to ensure that tools don't
+// suggest fixes that import package P when analyzing one of P's
+// dependencies.
package main
import (
"bytes"
"cmp"
+ "encoding/binary"
+ "encoding/json"
"errors"
"fmt"
"go/format"
@@ -20,6 +26,7 @@ import (
"io/fs"
"log"
"os"
+ "os/exec"
"path/filepath"
"regexp"
"runtime"
@@ -30,6 +37,13 @@ import (
)
func main() {
+ manifest()
+ deps()
+}
+
+// -- generate std manifest --
+
+func manifest() {
pkgs := make(map[string]map[string]symInfo) // package -> symbol -> info
symRE := regexp.MustCompile(`^pkg (\S+).*?, (var|func|type|const|method \([^)]*\)) ([\pL\p{Nd}_]+)(.*)`)
@@ -132,7 +146,7 @@ func main() {
// Write the combined manifest.
var buf bytes.Buffer
- buf.WriteString(`// Copyright 2024 The Go Authors. All rights reserved.
+ buf.WriteString(`// Copyright 2025 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.
@@ -158,7 +172,7 @@ var PackageSymbols = map[string][]Symbol{
if err != nil {
log.Fatal(err)
}
- if err := os.WriteFile("manifest.go", fmtbuf, 0666); err != nil {
+ if err := os.WriteFile("manifest.go", fmtbuf, 0o666); err != nil {
log.Fatal(err)
}
}
@@ -224,3 +238,111 @@ func removeTypeParam(s string) string {
}
return s
}
+
+// -- generate dependency graph --
+
+func deps() {
+ stdout := new(bytes.Buffer)
+ cmd := exec.Command("go", "list", "-deps", "-json", "std")
+ cmd.Stdout = stdout
+ cmd.Stderr = os.Stderr
+ cmd.Env = append(os.Environ(), "CGO_ENABLED=0", "GOOS=linux", "GOARCH=amd64")
+ if err := cmd.Run(); err != nil {
+ log.Fatal(err)
+ }
+
+ type Package struct {
+ // go list JSON output
+ ImportPath string // import path of package in dir
+ Imports []string // import paths used by this package
+
+ // encoding
+ index int
+ deps []int // indices of direct imports, sorted
+ }
+ pkgs := make(map[string]*Package)
+ var keys []string
+ for dec := json.NewDecoder(stdout); dec.More(); {
+ var pkg Package
+ if err := dec.Decode(&pkg); err != nil {
+ log.Fatal(err)
+ }
+ pkgs[pkg.ImportPath] = &pkg
+ keys = append(keys, pkg.ImportPath)
+ }
+
+ // Sort and number the packages.
+ // There are 344 as of Mar 2025.
+ slices.Sort(keys)
+ for i, name := range keys {
+ pkgs[name].index = i
+ }
+
+ // Encode the dependencies.
+ for _, pkg := range pkgs {
+ for _, imp := range pkg.Imports {
+ if imp == "C" {
+ continue
+ }
+ pkg.deps = append(pkg.deps, pkgs[imp].index)
+ }
+ slices.Sort(pkg.deps)
+ }
+
+ // Emit the table.
+ var buf bytes.Buffer
+ buf.WriteString(`// Copyright 2025 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.
+
+// Code generated by generate.go. DO NOT EDIT.
+
+package stdlib
+
+type pkginfo struct {
+ name string
+ deps string // list of indices of dependencies, as varint-encoded deltas
+}
+var deps = [...]pkginfo{
+`)
+ for _, name := range keys {
+ prev := 0
+ var deps []int
+ for _, v := range pkgs[name].deps {
+ deps = append(deps, v-prev) // delta
+ prev = v
+ }
+ var data []byte
+ for _, v := range deps {
+ data = binary.AppendUvarint(data, uint64(v))
+ }
+ fmt.Fprintf(&buf, "\t{%q, %q},\n", name, data)
+ }
+ fmt.Fprintln(&buf, "}")
+
+ fmtbuf, err := format.Source(buf.Bytes())
+ if err != nil {
+ log.Fatal(err)
+ }
+ if err := os.WriteFile("deps.go", fmtbuf, 0o666); err != nil {
+ log.Fatal(err)
+ }
+
+ // Also generate the data for the test.
+ for _, t := range [...]struct{ flag, filename string }{
+ {"-deps=true", "testdata/nethttp.deps"},
+ {`-f={{join .Imports "\n"}}`, "testdata/nethttp.imports"},
+ } {
+ stdout := new(bytes.Buffer)
+ cmd := exec.Command("go", "list", t.flag, "net/http")
+ cmd.Stdout = stdout
+ cmd.Stderr = os.Stderr
+ cmd.Env = append(os.Environ(), "CGO_ENABLED=0", "GOOS=linux", "GOARCH=amd64")
+ if err := cmd.Run(); err != nil {
+ log.Fatal(err)
+ }
+ if err := os.WriteFile(t.filename, stdout.Bytes(), 0666); err != nil {
+ log.Fatal(err)
+ }
+ }
+}
diff --git a/internal/stdlib/import.go b/internal/stdlib/import.go
new file mode 100644
index 00000000000..f6909878a8a
--- /dev/null
+++ b/internal/stdlib/import.go
@@ -0,0 +1,89 @@
+// Copyright 2025 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 stdlib
+
+// This file provides the API for the import graph of the standard library.
+//
+// Be aware that the compiler-generated code for every package
+// implicitly depends on package "runtime" and a handful of others
+// (see runtimePkgs in GOROOT/src/cmd/internal/objabi/pkgspecial.go).
+
+import (
+ "encoding/binary"
+ "iter"
+ "slices"
+ "strings"
+)
+
+// Imports returns the sequence of packages directly imported by the
+// named standard packages, in name order.
+// The imports of an unknown package are the empty set.
+//
+// The graph is built into the application and may differ from the
+// graph in the Go source tree being analyzed by the application.
+func Imports(pkgs ...string) iter.Seq[string] {
+ return func(yield func(string) bool) {
+ for _, pkg := range pkgs {
+ if i, ok := find(pkg); ok {
+ var depIndex uint64
+ for data := []byte(deps[i].deps); len(data) > 0; {
+ delta, n := binary.Uvarint(data)
+ depIndex += delta
+ if !yield(deps[depIndex].name) {
+ return
+ }
+ data = data[n:]
+ }
+ }
+ }
+ }
+}
+
+// Dependencies returns the set of all dependencies of the named
+// standard packages, including the initial package,
+// in a deterministic topological order.
+// The dependencies of an unknown package are the empty set.
+//
+// The graph is built into the application and may differ from the
+// graph in the Go source tree being analyzed by the application.
+func Dependencies(pkgs ...string) iter.Seq[string] {
+ return func(yield func(string) bool) {
+ for _, pkg := range pkgs {
+ if i, ok := find(pkg); ok {
+ var seen [1 + len(deps)/8]byte // bit set of seen packages
+ var visit func(i int) bool
+ visit = func(i int) bool {
+ bit := byte(1) << (i % 8)
+ if seen[i/8]&bit == 0 {
+ seen[i/8] |= bit
+ var depIndex uint64
+ for data := []byte(deps[i].deps); len(data) > 0; {
+ delta, n := binary.Uvarint(data)
+ depIndex += delta
+ if !visit(int(depIndex)) {
+ return false
+ }
+ data = data[n:]
+ }
+ if !yield(deps[i].name) {
+ return false
+ }
+ }
+ return true
+ }
+ if !visit(i) {
+ return
+ }
+ }
+ }
+ }
+}
+
+// find returns the index of pkg in the deps table.
+func find(pkg string) (int, bool) {
+ return slices.BinarySearchFunc(deps[:], pkg, func(p pkginfo, n string) int {
+ return strings.Compare(p.name, n)
+ })
+}
diff --git a/internal/stdlib/manifest.go b/internal/stdlib/manifest.go
index 9f0b871ff6b..2b418796abb 100644
--- a/internal/stdlib/manifest.go
+++ b/internal/stdlib/manifest.go
@@ -1,4 +1,4 @@
-// Copyright 2024 The Go Authors. All rights reserved.
+// Copyright 2025 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.
@@ -2151,6 +2151,8 @@ var PackageSymbols = map[string][]Symbol{
{"(Type).String", Method, 0},
{"(Version).GoString", Method, 0},
{"(Version).String", Method, 0},
+ {"(VersionIndex).Index", Method, 24},
+ {"(VersionIndex).IsHidden", Method, 24},
{"ARM_MAGIC_TRAMP_NUMBER", Const, 0},
{"COMPRESS_HIOS", Const, 6},
{"COMPRESS_HIPROC", Const, 6},
@@ -3834,6 +3836,7 @@ var PackageSymbols = map[string][]Symbol{
{"SymType", Type, 0},
{"SymVis", Type, 0},
{"Symbol", Type, 0},
+ {"Symbol.HasVersion", Field, 24},
{"Symbol.Info", Field, 0},
{"Symbol.Library", Field, 13},
{"Symbol.Name", Field, 0},
@@ -3843,18 +3846,12 @@ var PackageSymbols = map[string][]Symbol{
{"Symbol.Value", Field, 0},
{"Symbol.Version", Field, 13},
{"Symbol.VersionIndex", Field, 24},
- {"Symbol.VersionScope", Field, 24},
- {"SymbolVersionScope", Type, 24},
{"Type", Type, 0},
{"VER_FLG_BASE", Const, 24},
{"VER_FLG_INFO", Const, 24},
{"VER_FLG_WEAK", Const, 24},
{"Version", Type, 0},
- {"VersionScopeGlobal", Const, 24},
- {"VersionScopeHidden", Const, 24},
- {"VersionScopeLocal", Const, 24},
- {"VersionScopeNone", Const, 24},
- {"VersionScopeSpecific", Const, 24},
+ {"VersionIndex", Type, 24},
},
"debug/gosym": {
{"(*DecodingError).Error", Method, 0},
diff --git a/internal/stdlib/stdlib.go b/internal/stdlib/stdlib.go
index 98904017f2c..3d96d3bf686 100644
--- a/internal/stdlib/stdlib.go
+++ b/internal/stdlib/stdlib.go
@@ -6,7 +6,7 @@
// Package stdlib provides a table of all exported symbols in the
// standard library, along with the version at which they first
-// appeared.
+// appeared. It also provides the import graph of std packages.
package stdlib
import (
diff --git a/internal/stdlib/testdata/nethttp.deps b/internal/stdlib/testdata/nethttp.deps
new file mode 100644
index 00000000000..71e58a0c693
--- /dev/null
+++ b/internal/stdlib/testdata/nethttp.deps
@@ -0,0 +1,169 @@
+internal/goarch
+unsafe
+internal/abi
+internal/unsafeheader
+internal/cpu
+internal/bytealg
+internal/byteorder
+internal/chacha8rand
+internal/coverage/rtcov
+internal/godebugs
+internal/goexperiment
+internal/goos
+internal/profilerecord
+internal/runtime/atomic
+internal/runtime/exithook
+internal/asan
+internal/msan
+internal/race
+internal/runtime/math
+internal/runtime/sys
+internal/runtime/maps
+internal/runtime/syscall
+internal/stringslite
+runtime
+internal/reflectlite
+errors
+sync/atomic
+internal/sync
+sync
+io
+iter
+math/bits
+unicode
+unicode/utf8
+bytes
+strings
+bufio
+cmp
+internal/itoa
+math
+strconv
+reflect
+slices
+internal/fmtsort
+internal/oserror
+path
+internal/bisect
+internal/godebug
+syscall
+time
+io/fs
+internal/filepathlite
+internal/syscall/unix
+internal/poll
+internal/syscall/execenv
+internal/testlog
+os
+fmt
+sort
+compress/flate
+encoding/binary
+hash
+hash/crc32
+compress/gzip
+container/list
+context
+crypto
+crypto/internal/fips140deps/godebug
+crypto/internal/fips140
+crypto/internal/fips140/alias
+crypto/internal/fips140deps/byteorder
+crypto/internal/fips140deps/cpu
+crypto/internal/impl
+crypto/internal/fips140/sha256
+crypto/internal/fips140/subtle
+crypto/internal/fips140/sha3
+crypto/internal/fips140/sha512
+crypto/internal/fips140/hmac
+crypto/internal/fips140/check
+crypto/internal/fips140/aes
+crypto/internal/sysrand
+crypto/internal/entropy
+math/rand/v2
+crypto/internal/randutil
+crypto/internal/fips140/drbg
+crypto/internal/fips140/aes/gcm
+crypto/internal/fips140only
+crypto/subtle
+crypto/cipher
+crypto/internal/boring/sig
+crypto/internal/boring
+math/rand
+math/big
+crypto/rand
+crypto/aes
+crypto/des
+crypto/internal/fips140/nistec/fiat
+crypto/internal/fips140/nistec
+crypto/internal/fips140/ecdh
+crypto/internal/fips140/edwards25519/field
+crypto/ecdh
+crypto/elliptic
+crypto/internal/boring/bbig
+crypto/internal/fips140/bigmod
+crypto/internal/fips140/ecdsa
+crypto/sha3
+crypto/internal/fips140hash
+crypto/sha512
+unicode/utf16
+encoding/asn1
+vendor/golang.org/x/crypto/cryptobyte/asn1
+vendor/golang.org/x/crypto/cryptobyte
+crypto/ecdsa
+crypto/internal/fips140/edwards25519
+crypto/internal/fips140/ed25519
+crypto/ed25519
+crypto/hmac
+crypto/internal/fips140/hkdf
+crypto/internal/fips140/mlkem
+crypto/internal/fips140/tls12
+crypto/internal/fips140/tls13
+vendor/golang.org/x/crypto/internal/alias
+vendor/golang.org/x/crypto/chacha20
+vendor/golang.org/x/crypto/internal/poly1305
+vendor/golang.org/x/sys/cpu
+vendor/golang.org/x/crypto/chacha20poly1305
+crypto/internal/hpke
+crypto/md5
+crypto/rc4
+crypto/internal/fips140/rsa
+crypto/rsa
+crypto/sha1
+crypto/sha256
+crypto/tls/internal/fips140tls
+crypto/dsa
+encoding/hex
+crypto/x509/pkix
+encoding/base64
+encoding/pem
+maps
+vendor/golang.org/x/net/dns/dnsmessage
+internal/nettrace
+internal/singleflight
+weak
+unique
+net/netip
+net
+net/url
+path/filepath
+crypto/x509
+crypto/tls
+vendor/golang.org/x/text/transform
+log/internal
+log
+vendor/golang.org/x/text/unicode/bidi
+vendor/golang.org/x/text/secure/bidirule
+vendor/golang.org/x/text/unicode/norm
+vendor/golang.org/x/net/idna
+net/textproto
+vendor/golang.org/x/net/http/httpguts
+vendor/golang.org/x/net/http/httpproxy
+vendor/golang.org/x/net/http2/hpack
+mime
+mime/quotedprintable
+mime/multipart
+net/http/httptrace
+net/http/internal
+net/http/internal/ascii
+net/http
diff --git a/internal/stdlib/testdata/nethttp.imports b/internal/stdlib/testdata/nethttp.imports
new file mode 100644
index 00000000000..de41e46c0fe
--- /dev/null
+++ b/internal/stdlib/testdata/nethttp.imports
@@ -0,0 +1,46 @@
+bufio
+bytes
+compress/gzip
+container/list
+context
+crypto/rand
+crypto/tls
+encoding/base64
+encoding/binary
+errors
+fmt
+vendor/golang.org/x/net/http/httpguts
+vendor/golang.org/x/net/http/httpproxy
+vendor/golang.org/x/net/http2/hpack
+vendor/golang.org/x/net/idna
+internal/godebug
+io
+io/fs
+log
+maps
+math
+math/bits
+math/rand
+mime
+mime/multipart
+net
+net/http/httptrace
+net/http/internal
+net/http/internal/ascii
+net/textproto
+net/url
+os
+path
+path/filepath
+reflect
+runtime
+slices
+sort
+strconv
+strings
+sync
+sync/atomic
+time
+unicode
+unicode/utf8
+unsafe
diff --git a/internal/testenv/testenv.go b/internal/testenv/testenv.go
index 144f4f8fd64..fa53f37f7aa 100644
--- a/internal/testenv/testenv.go
+++ b/internal/testenv/testenv.go
@@ -149,7 +149,7 @@ func HasTool(tool string) error {
func cgoEnabled(bypassEnvironment bool) (bool, error) {
cmd := exec.Command("go", "env", "CGO_ENABLED")
if bypassEnvironment {
- cmd.Env = append(append([]string(nil), os.Environ()...), "CGO_ENABLED=")
+ cmd.Env = append(os.Environ(), "CGO_ENABLED=")
}
out, err := cmd.Output()
if err != nil {
@@ -251,8 +251,8 @@ func NeedsGoPackagesEnv(t testing.TB, env []string) {
t.Helper()
for _, v := range env {
- if strings.HasPrefix(v, "GOPACKAGESDRIVER=") {
- tool := strings.TrimPrefix(v, "GOPACKAGESDRIVER=")
+ if after, ok := strings.CutPrefix(v, "GOPACKAGESDRIVER="); ok {
+ tool := after
if tool == "off" {
NeedsTool(t, "go")
} else {
@@ -278,6 +278,16 @@ func NeedsGoBuild(t testing.TB) {
NeedsTool(t, "go")
}
+// NeedsDefaultImporter skips t if the test uses the default importer,
+// returned by [go/importer.Default].
+func NeedsDefaultImporter(t testing.TB) {
+ t.Helper()
+ // The default importer may call `go list`
+ // (in src/internal/exportdata/exportdata.go:lookupGorootExport),
+ // so check for the go tool.
+ NeedsTool(t, "go")
+}
+
// ExitIfSmallMachine emits a helpful diagnostic and calls os.Exit(0) if the
// current machine is a builder known to have scarce resources.
//
diff --git a/internal/testenv/testenv_notunix.go b/internal/testenv/testenv_notunix.go
index e9ce0d3649d..85b3820e3fb 100644
--- a/internal/testenv/testenv_notunix.go
+++ b/internal/testenv/testenv_notunix.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build !(unix || aix || darwin || dragonfly || freebsd || linux || netbsd || openbsd || solaris)
-// +build !unix,!aix,!darwin,!dragonfly,!freebsd,!linux,!netbsd,!openbsd,!solaris
package testenv
diff --git a/internal/testenv/testenv_unix.go b/internal/testenv/testenv_unix.go
index bc6af1ff81d..d635b96b31b 100644
--- a/internal/testenv/testenv_unix.go
+++ b/internal/testenv/testenv_unix.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build unix || aix || darwin || dragonfly || freebsd || linux || netbsd || openbsd || solaris
-// +build unix aix darwin dragonfly freebsd linux netbsd openbsd solaris
package testenv
diff --git a/internal/testfiles/testfiles.go b/internal/testfiles/testfiles.go
index 78733976b3b..dee63c1c2f0 100644
--- a/internal/testfiles/testfiles.go
+++ b/internal/testfiles/testfiles.go
@@ -7,7 +7,6 @@
package testfiles
import (
- "io"
"io/fs"
"os"
"path/filepath"
@@ -46,7 +45,7 @@ import (
func CopyToTmp(t testing.TB, src fs.FS, rename ...string) string {
dstdir := t.TempDir()
- if err := copyFS(dstdir, src); err != nil {
+ if err := os.CopyFS(dstdir, src); err != nil {
t.Fatal(err)
}
for _, r := range rename {
@@ -64,33 +63,6 @@ func CopyToTmp(t testing.TB, src fs.FS, rename ...string) string {
return dstdir
}
-// Copy the files in src to dst.
-// Use os.CopyFS when 1.23 can be used in x/tools.
-func copyFS(dstdir string, src fs.FS) error {
- return fs.WalkDir(src, ".", func(path string, d fs.DirEntry, err error) error {
- if err != nil {
- return err
- }
- newpath := filepath.Join(dstdir, path)
- if d.IsDir() {
- return os.MkdirAll(newpath, 0777)
- }
- r, err := src.Open(path)
- if err != nil {
- return err
- }
- defer r.Close()
-
- w, err := os.Create(newpath)
- if err != nil {
- return err
- }
- defer w.Close()
- _, err = io.Copy(w, r)
- return err
- })
-}
-
// ExtractTxtarFileToTmp read a txtar archive on a given path,
// extracts it to a temporary directory, and returns the
// temporary directory.
diff --git a/internal/tokeninternal/tokeninternal.go b/internal/tokeninternal/tokeninternal.go
index 0a73e2ebda3..549bb183976 100644
--- a/internal/tokeninternal/tokeninternal.go
+++ b/internal/tokeninternal/tokeninternal.go
@@ -9,6 +9,7 @@ package tokeninternal
import (
"fmt"
"go/token"
+ "slices"
"sort"
"sync"
"sync/atomic"
@@ -18,7 +19,29 @@ import (
// AddExistingFiles adds the specified files to the FileSet if they
// are not already present. It panics if any pair of files in the
// resulting FileSet would overlap.
+//
+// TODO(adonovan): add this a method to FileSet; see
+// https://github.com/golang/go/issues/73205
func AddExistingFiles(fset *token.FileSet, files []*token.File) {
+
+ // This function cannot be implemented as:
+ //
+ // for _, file := range files {
+ // if prev := fset.File(token.Pos(file.Base())); prev != nil {
+ // if prev != file {
+ // panic("FileSet contains a different file at the same base")
+ // }
+ // continue
+ // }
+ // file2 := fset.AddFile(file.Name(), file.Base(), file.Size())
+ // file2.SetLines(file.Lines())
+ // }
+ //
+ // because all calls to AddFile must be in increasing order.
+ // AddExistingFiles lets us augment an existing FileSet
+ // sequentially, so long as all sets of files have disjoint
+ // ranges.
+
// Punch through the FileSet encapsulation.
type tokenFileSet struct {
// This type remained essentially consistent from go1.16 to go1.21.
@@ -83,10 +106,7 @@ func AddExistingFiles(fset *token.FileSet, files []*token.File) {
// of their Base.
func FileSetFor(files ...*token.File) *token.FileSet {
fset := token.NewFileSet()
- for _, f := range files {
- f2 := fset.AddFile(f.Name(), f.Base(), f.Size())
- f2.SetLines(f.Lines())
- }
+ AddExistingFiles(fset, files)
return fset
}
@@ -94,12 +114,5 @@ func FileSetFor(files ...*token.File) *token.FileSet {
// create copies of the token.Files in fset: they are added to the resulting
// FileSet unmodified.
func CloneFileSet(fset *token.FileSet) *token.FileSet {
- var files []*token.File
- fset.Iterate(func(f *token.File) bool {
- files = append(files, f)
- return true
- })
- newFileSet := token.NewFileSet()
- AddExistingFiles(newFileSet, files)
- return newFileSet
+ return FileSetFor(slices.Collect(fset.Iterate)...)
}
diff --git a/internal/tool/tool.go b/internal/tool/tool.go
index 46f5b87fa35..6420c9667d9 100644
--- a/internal/tool/tool.go
+++ b/internal/tool/tool.go
@@ -81,7 +81,7 @@ func (e commandLineError) Error() string { return string(e) }
// CommandLineErrorf is like fmt.Errorf except that it returns a value that
// triggers printing of the command line help.
// In general you should use this when generating command line validation errors.
-func CommandLineErrorf(message string, args ...interface{}) error {
+func CommandLineErrorf(message string, args ...any) error {
return commandLineError(fmt.Sprintf(message, args...))
}
@@ -250,7 +250,7 @@ func addFlags(f *flag.FlagSet, field reflect.StructField, value reflect.Value) *
child := value.Type().Field(i)
v := value.Field(i)
// make sure we have a pointer
- if v.Kind() != reflect.Ptr {
+ if v.Kind() != reflect.Pointer {
v = v.Addr()
}
// check if that field is a flag or contains flags
@@ -289,7 +289,7 @@ func addFlag(f *flag.FlagSet, value reflect.Value, flagName string, help string)
func resolve(v reflect.Value) reflect.Value {
for {
switch v.Kind() {
- case reflect.Interface, reflect.Ptr:
+ case reflect.Interface, reflect.Pointer:
v = v.Elem()
default:
return v
diff --git a/internal/typeparams/copytermlist.go b/internal/typeparams/copytermlist.go
index 5357f9d2fd7..1edaaa01c9a 100644
--- a/internal/typeparams/copytermlist.go
+++ b/internal/typeparams/copytermlist.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build ignore
-// +build ignore
// copytermlist.go copies the term list algorithm from GOROOT/src/go/types.
diff --git a/internal/typeparams/free.go b/internal/typeparams/free.go
index 0ade5c2949e..709d2fc1447 100644
--- a/internal/typeparams/free.go
+++ b/internal/typeparams/free.go
@@ -70,7 +70,7 @@ func (w *Free) Has(typ types.Type) (res bool) {
case *types.Tuple:
n := t.Len()
- for i := 0; i < n; i++ {
+ for i := range n {
if w.Has(t.At(i).Type()) {
return true
}
diff --git a/internal/typeparams/normalize.go b/internal/typeparams/normalize.go
index 93c80fdc96c..f49802b8ef7 100644
--- a/internal/typeparams/normalize.go
+++ b/internal/typeparams/normalize.go
@@ -120,7 +120,7 @@ type termSet struct {
terms termlist
}
-func indentf(depth int, format string, args ...interface{}) {
+func indentf(depth int, format string, args ...any) {
fmt.Fprintf(os.Stderr, strings.Repeat(".", depth)+format+"\n", args...)
}
diff --git a/internal/typeparams/termlist.go b/internal/typeparams/termlist.go
index cbd12f80131..9bc29143f6a 100644
--- a/internal/typeparams/termlist.go
+++ b/internal/typeparams/termlist.go
@@ -1,3 +1,6 @@
+// Code generated by "go test -run=Generate -write=all"; DO NOT EDIT.
+// Source: ../../cmd/compile/internal/types2/termlist.go
+
// Copyright 2021 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.
@@ -7,8 +10,8 @@
package typeparams
import (
- "bytes"
"go/types"
+ "strings"
)
// A termlist represents the type set represented by the union
@@ -22,15 +25,18 @@ type termlist []*term
// It is in normal form.
var allTermlist = termlist{new(term)}
+// termSep is the separator used between individual terms.
+const termSep = " | "
+
// String prints the termlist exactly (without normalization).
func (xl termlist) String() string {
if len(xl) == 0 {
return "∅"
}
- var buf bytes.Buffer
+ var buf strings.Builder
for i, x := range xl {
if i > 0 {
- buf.WriteString(" | ")
+ buf.WriteString(termSep)
}
buf.WriteString(x.String())
}
diff --git a/internal/typeparams/typeterm.go b/internal/typeparams/typeterm.go
index 7350bb702a1..fa758cdc989 100644
--- a/internal/typeparams/typeterm.go
+++ b/internal/typeparams/typeterm.go
@@ -1,3 +1,6 @@
+// Code generated by "go test -run=Generate -write=all"; DO NOT EDIT.
+// Source: ../../cmd/compile/internal/types2/typeterm.go
+
// Copyright 2021 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.
diff --git a/internal/typesinternal/classify_call.go b/internal/typesinternal/classify_call.go
new file mode 100644
index 00000000000..649c82b6bea
--- /dev/null
+++ b/internal/typesinternal/classify_call.go
@@ -0,0 +1,135 @@
+// Copyright 2018 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 typesinternal
+
+import (
+ "fmt"
+ "go/ast"
+ "go/types"
+ _ "unsafe"
+)
+
+// CallKind describes the function position of an [*ast.CallExpr].
+type CallKind int
+
+const (
+ CallStatic CallKind = iota // static call to known function
+ CallInterface // dynamic call through an interface method
+ CallDynamic // dynamic call of a func value
+ CallBuiltin // call to a builtin function
+ CallConversion // a conversion (not a call)
+)
+
+var callKindNames = []string{
+ "CallStatic",
+ "CallInterface",
+ "CallDynamic",
+ "CallBuiltin",
+ "CallConversion",
+}
+
+func (k CallKind) String() string {
+ if i := int(k); i >= 0 && i < len(callKindNames) {
+ return callKindNames[i]
+ }
+ return fmt.Sprintf("typeutil.CallKind(%d)", k)
+}
+
+// ClassifyCall classifies the function position of a call expression ([*ast.CallExpr]).
+// It distinguishes among true function calls, calls to builtins, and type conversions,
+// and further classifies function calls as static calls (where the function is known),
+// dynamic interface calls, and other dynamic calls.
+//
+// For the declarations:
+//
+// func f() {}
+// func g[T any]() {}
+// var v func()
+// var s []func()
+// type I interface { M() }
+// var i I
+//
+// ClassifyCall returns the following:
+//
+// f() CallStatic
+// g[int]() CallStatic
+// i.M() CallInterface
+// min(1, 2) CallBuiltin
+// v() CallDynamic
+// s[0]() CallDynamic
+// int(x) CallConversion
+// []byte("") CallConversion
+func ClassifyCall(info *types.Info, call *ast.CallExpr) CallKind {
+ if info.Types == nil {
+ panic("ClassifyCall: info.Types is nil")
+ }
+ if info.Types[call.Fun].IsType() {
+ return CallConversion
+ }
+ obj := info.Uses[UsedIdent(info, call.Fun)]
+ // Classify the call by the type of the object, if any.
+ switch obj := obj.(type) {
+ case *types.Builtin:
+ return CallBuiltin
+ case *types.Func:
+ if interfaceMethod(obj) {
+ return CallInterface
+ }
+ return CallStatic
+ default:
+ return CallDynamic
+ }
+}
+
+// UsedIdent returns the identifier such that info.Uses[UsedIdent(info, e)]
+// is the [types.Object] used by e, if any.
+//
+// If e is one of various forms of reference:
+//
+// f, c, v, T lexical reference
+// pkg.X qualified identifier
+// f[T] or pkg.F[K,V] instantiations of the above kinds
+// expr.f field or method value selector
+// T.f method expression selector
+//
+// UsedIdent returns the identifier whose is associated value in [types.Info.Uses]
+// is the object to which it refers.
+//
+// For the declarations:
+//
+// func F[T any] {...}
+// type I interface { M() }
+// var (
+// x int
+// s struct { f int }
+// a []int
+// i I
+// )
+//
+// UsedIdent returns the following:
+//
+// Expr UsedIdent
+// x x
+// s.f f
+// F[int] F
+// i.M M
+// I.M M
+// min min
+// int int
+// 1 nil
+// a[0] nil
+// []byte nil
+//
+// Note: if e is an instantiated function or method, UsedIdent returns
+// the corresponding generic function or method on the generic type.
+func UsedIdent(info *types.Info, e ast.Expr) *ast.Ident {
+ return usedIdent(info, e)
+}
+
+//go:linkname usedIdent golang.org/x/tools/go/types/typeutil.usedIdent
+func usedIdent(info *types.Info, e ast.Expr) *ast.Ident
+
+//go:linkname interfaceMethod golang.org/x/tools/go/types/typeutil.interfaceMethod
+func interfaceMethod(f *types.Func) bool
diff --git a/internal/typesinternal/classify_call_test.go b/internal/typesinternal/classify_call_test.go
new file mode 100644
index 00000000000..e875727d1a5
--- /dev/null
+++ b/internal/typesinternal/classify_call_test.go
@@ -0,0 +1,160 @@
+// Copyright 2018 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 typesinternal_test
+
+import (
+ "bytes"
+ "fmt"
+ "go/ast"
+ "go/format"
+ "go/importer"
+ "go/parser"
+ "go/token"
+ "go/types"
+ "testing"
+
+ ti "golang.org/x/tools/internal/typesinternal"
+)
+
+func TestClassifyCallAndUsed(t *testing.T) {
+ const src = `
+ package p
+
+ func g(int)
+
+ type A[T any] *T
+
+ func F[T any](T) {}
+
+ type S struct{ f func(int) }
+ func (S) g(int)
+
+ type I interface{ m(int) }
+
+ var (
+ z S
+ a struct{b struct{c S}}
+ f = g
+ m map[int]func()
+ n []func()
+ p *int
+ )
+
+ func tests[T int]() {
+ var zt T
+
+ g(1)
+ f(1)
+ println()
+ z.g(1) // a concrete method
+ a.b.c.g(1) // same
+ S.g(z, 1) // method expression
+ z.f(1) // struct field
+ I(nil).m(1) // interface method, then type conversion (preorder traversal)
+ m[0]() // a map
+ n[0]() // a slice
+ F[int](1) // instantiated function
+ F[T](zt) // generic function
+ func() {}() // function literal
+ _=[]byte("") // type expression
+ _=A[int](p) // instantiated type
+ _=T(1) // type param
+ // parenthesized forms
+ (z.g)(1)
+ (z).g(1)
+
+
+ // A[T](1) // generic type: illegal
+ }
+ `
+
+ fset := token.NewFileSet()
+ cfg := &types.Config{
+ Error: func(err error) { t.Fatal(err) },
+ Importer: importer.Default(),
+ }
+ info := ti.NewTypesInfo()
+ // parse
+ f, err := parser.ParseFile(fset, "classify.go", src, 0)
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ // type-check
+ pkg, err := cfg.Check(f.Name.Name, fset, []*ast.File{f}, info)
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ lookup := func(sym string) types.Object {
+ return pkg.Scope().Lookup(sym)
+ }
+
+ member := func(sym, fieldOrMethod string) types.Object {
+ obj, _, _ := types.LookupFieldOrMethod(lookup(sym).Type(), false, pkg, fieldOrMethod)
+ return obj
+ }
+
+ printlnObj := types.Universe.Lookup("println")
+
+ typeParam := lookup("tests").Type().(*types.Signature).TypeParams().At(0).Obj()
+
+ // Expected Calls are in the order of CallExprs at the end of src, above.
+ wants := []struct {
+ kind ti.CallKind
+ usedObj types.Object // the object obtained from the result of UsedIdent
+ }{
+ {ti.CallStatic, lookup("g")}, // g
+ {ti.CallDynamic, lookup("f")}, // f
+ {ti.CallBuiltin, printlnObj}, // println
+ {ti.CallStatic, member("S", "g")}, // z.g
+ {ti.CallStatic, member("S", "g")}, // a.b.c.g
+ {ti.CallStatic, member("S", "g")}, // S.g(z, 1)
+ {ti.CallDynamic, member("z", "f")}, // z.f
+ {ti.CallInterface, member("I", "m")}, // I(nil).m
+ {ti.CallConversion, lookup("I")}, // I(nil)
+ {ti.CallDynamic, nil}, // m[0]
+ {ti.CallDynamic, nil}, // n[0]
+ {ti.CallStatic, lookup("F")}, // F[int]
+ {ti.CallStatic, lookup("F")}, // F[T]
+ {ti.CallDynamic, nil}, // f(){}
+ {ti.CallConversion, nil}, // []byte
+ {ti.CallConversion, lookup("A")}, // A[int]
+ {ti.CallConversion, typeParam}, // T
+ {ti.CallStatic, member("S", "g")}, // (z.g)
+ {ti.CallStatic, member("S", "g")}, // (z).g
+ }
+
+ i := 0
+ ast.Inspect(f, func(n ast.Node) bool {
+ if call, ok := n.(*ast.CallExpr); ok {
+ if i >= len(wants) {
+ t.Fatal("more calls than wants")
+ }
+ var buf bytes.Buffer
+ if err := format.Node(&buf, fset, n); err != nil {
+ t.Fatal(err)
+ }
+ prefix := fmt.Sprintf("%s (#%d)", buf.String(), i)
+
+ gotKind := ti.ClassifyCall(info, call)
+ want := wants[i]
+
+ if gotKind != want.kind {
+ t.Errorf("%s kind: got %s, want %s", prefix, gotKind, want.kind)
+ }
+
+ w := want.usedObj
+ if g := info.Uses[ti.UsedIdent(info, call.Fun)]; g != w {
+ t.Errorf("%s used obj: got %v (%[2]T), want %v", prefix, g, w)
+ }
+ i++
+ }
+ return true
+ })
+ if i != len(wants) {
+ t.Fatal("more wants than calls")
+ }
+}
diff --git a/internal/typesinternal/element_test.go b/internal/typesinternal/element_test.go
index b4475633270..95f1ab33478 100644
--- a/internal/typesinternal/element_test.go
+++ b/internal/typesinternal/element_test.go
@@ -9,6 +9,8 @@ import (
"go/parser"
"go/token"
"go/types"
+ "maps"
+ "slices"
"strings"
"testing"
@@ -142,12 +144,7 @@ func TestForEachElement(t *testing.T) {
}
}
if fail {
- for k := range got {
- t.Logf("got element: %s", k)
- }
- // TODO(adonovan): use this when go1.23 is assured:
- // t.Logf("got elements:\n%s",
- // strings.Join(slices.Sorted(maps.Keys(got)), "\n"))
+ t.Logf("got elements:\n%s", strings.Join(slices.Sorted(maps.Keys(got)), "\n"))
}
}
}
diff --git a/internal/typesinternal/typeindex/typeindex.go b/internal/typesinternal/typeindex/typeindex.go
new file mode 100644
index 00000000000..34087a98fbf
--- /dev/null
+++ b/internal/typesinternal/typeindex/typeindex.go
@@ -0,0 +1,223 @@
+// Copyright 2025 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 typeindex provides an [Index] of type information for a
+// package, allowing efficient lookup of, say, whether a given symbol
+// is referenced and, if so, where from; or of the [cursor.Cursor] for
+// the declaration of a particular [types.Object] symbol.
+package typeindex
+
+import (
+ "encoding/binary"
+ "go/ast"
+ "go/types"
+ "iter"
+
+ "golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/go/types/typeutil"
+ "golang.org/x/tools/internal/astutil/cursor"
+ "golang.org/x/tools/internal/astutil/edge"
+ "golang.org/x/tools/internal/typesinternal"
+)
+
+// New constructs an Index for the package of type-annotated syntax
+//
+// TODO(adonovan): accept a FileSet too?
+// We regret not requiring one in inspector.New.
+func New(inspect *inspector.Inspector, pkg *types.Package, info *types.Info) *Index {
+ ix := &Index{
+ inspect: inspect,
+ info: info,
+ packages: make(map[string]*types.Package),
+ def: make(map[types.Object]cursor.Cursor),
+ uses: make(map[types.Object]*uses),
+ }
+
+ addPackage := func(pkg2 *types.Package) {
+ if pkg2 != nil && pkg2 != pkg {
+ ix.packages[pkg2.Path()] = pkg2
+ }
+ }
+
+ for cur := range cursor.Root(inspect).Preorder((*ast.ImportSpec)(nil), (*ast.Ident)(nil)) {
+ switch n := cur.Node().(type) {
+ case *ast.ImportSpec:
+ // Index direct imports, including blank ones.
+ if pkgname := info.PkgNameOf(n); pkgname != nil {
+ addPackage(pkgname.Imported())
+ }
+
+ case *ast.Ident:
+ // Index all defining and using identifiers.
+ if obj := info.Defs[n]; obj != nil {
+ ix.def[obj] = cur
+ }
+
+ if obj := info.Uses[n]; obj != nil {
+ // Index indirect dependencies (via fields and methods).
+ if !typesinternal.IsPackageLevel(obj) {
+ addPackage(obj.Pkg())
+ }
+
+ us, ok := ix.uses[obj]
+ if !ok {
+ us = &uses{}
+ us.code = us.initial[:0]
+ ix.uses[obj] = us
+ }
+ delta := cur.Index() - us.last
+ if delta < 0 {
+ panic("non-monotonic")
+ }
+ us.code = binary.AppendUvarint(us.code, uint64(delta))
+ us.last = cur.Index()
+ }
+ }
+ }
+ return ix
+}
+
+// An Index holds an index mapping [types.Object] symbols to their syntax.
+// In effect, it is the inverse of [types.Info].
+type Index struct {
+ inspect *inspector.Inspector
+ info *types.Info
+ packages map[string]*types.Package // packages of all symbols referenced from this package
+ def map[types.Object]cursor.Cursor // Cursor of *ast.Ident that defines the Object
+ uses map[types.Object]*uses // Cursors of *ast.Idents that use the Object
+}
+
+// A uses holds the list of Cursors of Idents that use a given symbol.
+//
+// The Uses map of [types.Info] is substantial, so it pays to compress
+// its inverse mapping here, both in space and in CPU due to reduced
+// allocation. A Cursor is 2 words; a Cursor.Index is 4 bytes; but
+// since Cursors are naturally delivered in ascending order, we can
+// use varint-encoded deltas at a cost of only ~1.7-2.2 bytes per use.
+//
+// Many variables have only one or two uses, so their encoded uses may
+// fit in the 4 bytes of initial, saving further CPU and space
+// essentially for free since the struct's size class is 4 words.
+type uses struct {
+ code []byte // varint-encoded deltas of successive Cursor.Index values
+ last int32 // most recent Cursor.Index value; used during encoding
+ initial [4]byte // use slack in size class as initial space for code
+}
+
+// Uses returns the sequence of Cursors of [*ast.Ident]s in this package
+// that refer to obj. If obj is nil, the sequence is empty.
+func (ix *Index) Uses(obj types.Object) iter.Seq[cursor.Cursor] {
+ return func(yield func(cursor.Cursor) bool) {
+ if uses := ix.uses[obj]; uses != nil {
+ var last int32
+ for code := uses.code; len(code) > 0; {
+ delta, n := binary.Uvarint(code)
+ last += int32(delta)
+ if !yield(cursor.At(ix.inspect, last)) {
+ return
+ }
+ code = code[n:]
+ }
+ }
+ }
+}
+
+// Used reports whether any of the specified objects are used, in
+// other words, obj != nil && Uses(obj) is non-empty for some obj in objs.
+//
+// (This treatment of nil allows Used to be called directly on the
+// result of [Index.Object] so that analyzers can conveniently skip
+// packages that don't use a symbol of interest.)
+func (ix *Index) Used(objs ...types.Object) bool {
+ for _, obj := range objs {
+ if obj != nil && ix.uses[obj] != nil {
+ return true
+ }
+ }
+ return false
+}
+
+// Def returns the Cursor of the [*ast.Ident] in this package
+// that declares the specified object, if any.
+func (ix *Index) Def(obj types.Object) (cursor.Cursor, bool) {
+ cur, ok := ix.def[obj]
+ return cur, ok
+}
+
+// Package returns the package of the specified path,
+// or nil if it is not referenced from this package.
+func (ix *Index) Package(path string) *types.Package {
+ return ix.packages[path]
+}
+
+// Object returns the package-level symbol name within the package of
+// the specified path, or nil if the package or symbol does not exist
+// or is not visible from this package.
+func (ix *Index) Object(path, name string) types.Object {
+ if pkg := ix.Package(path); pkg != nil {
+ return pkg.Scope().Lookup(name)
+ }
+ return nil
+}
+
+// Selection returns the named method or field belonging to the
+// package-level type returned by Object(path, typename).
+func (ix *Index) Selection(path, typename, name string) types.Object {
+ if obj := ix.Object(path, typename); obj != nil {
+ if tname, ok := obj.(*types.TypeName); ok {
+ obj, _, _ := types.LookupFieldOrMethod(tname.Type(), true, obj.Pkg(), name)
+ return obj
+ }
+ }
+ return nil
+}
+
+// Calls returns the sequence of cursors for *ast.CallExpr nodes that
+// call the specified callee, as defined by [typeutil.Callee].
+// If callee is nil, the sequence is empty.
+func (ix *Index) Calls(callee types.Object) iter.Seq[cursor.Cursor] {
+ return func(yield func(cursor.Cursor) bool) {
+ for cur := range ix.Uses(callee) {
+ ek, _ := cur.ParentEdge()
+
+ // The call may be of the form f() or x.f(),
+ // optionally with parens; ascend from f to call.
+ //
+ // It is tempting but wrong to use the first
+ // CallExpr ancestor: we have to make sure the
+ // ident is in the CallExpr.Fun position, otherwise
+ // f(f, f) would have two spurious matches.
+ // Avoiding Enclosing is also significantly faster.
+
+ // inverse unparen: f -> (f)
+ for ek == edge.ParenExpr_X {
+ cur = cur.Parent()
+ ek, _ = cur.ParentEdge()
+ }
+
+ // ascend selector: f -> x.f
+ if ek == edge.SelectorExpr_Sel {
+ cur = cur.Parent()
+ ek, _ = cur.ParentEdge()
+ }
+
+ // inverse unparen again
+ for ek == edge.ParenExpr_X {
+ cur = cur.Parent()
+ ek, _ = cur.ParentEdge()
+ }
+
+ // ascend from f or x.f to call
+ if ek == edge.CallExpr_Fun {
+ curCall := cur.Parent()
+ call := curCall.Node().(*ast.CallExpr)
+ if typeutil.Callee(ix.info, call) == callee {
+ if !yield(curCall) {
+ return
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/internal/typesinternal/typeindex/typeindex_test.go b/internal/typesinternal/typeindex/typeindex_test.go
new file mode 100644
index 00000000000..c8b08dc9d00
--- /dev/null
+++ b/internal/typesinternal/typeindex/typeindex_test.go
@@ -0,0 +1,159 @@
+// Copyright 2025 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.
+
+//go:build go1.24
+
+package typeindex_test
+
+import (
+ "go/ast"
+ "slices"
+ "testing"
+
+ "golang.org/x/tools/go/ast/inspector"
+ "golang.org/x/tools/go/packages"
+ "golang.org/x/tools/go/types/typeutil"
+ "golang.org/x/tools/internal/astutil/cursor"
+ "golang.org/x/tools/internal/testenv"
+ "golang.org/x/tools/internal/typesinternal/typeindex"
+)
+
+func TestIndex(t *testing.T) {
+ testenv.NeedsGoPackages(t)
+ var (
+ pkg = loadNetHTTP(t)
+ inspect = inspector.New(pkg.Syntax)
+ index = typeindex.New(inspect, pkg.Types, pkg.TypesInfo)
+ fmtSprintf = index.Object("fmt", "Sprintf")
+ )
+
+ // Gather calls and uses of fmt.Sprintf in net/http.
+ var (
+ wantUses []*ast.Ident
+ wantCalls []*ast.CallExpr
+ )
+ for n := range inspect.PreorderSeq((*ast.CallExpr)(nil), (*ast.Ident)(nil)) {
+ switch n := n.(type) {
+ case *ast.CallExpr:
+ if typeutil.Callee(pkg.TypesInfo, n) == fmtSprintf {
+ wantCalls = append(wantCalls, n)
+ }
+ case *ast.Ident:
+ if pkg.TypesInfo.Uses[n] == fmtSprintf {
+ wantUses = append(wantUses, n)
+ }
+ }
+ }
+ // sanity check (expect about 60 of each)
+ if wantUses == nil || wantCalls == nil {
+ t.Fatalf("no calls or uses of fmt.Sprintf in net/http")
+ }
+
+ var (
+ gotUses []*ast.Ident
+ gotCalls []*ast.CallExpr
+ )
+ for curId := range index.Uses(fmtSprintf) {
+ gotUses = append(gotUses, curId.Node().(*ast.Ident))
+ }
+ for curCall := range index.Calls(fmtSprintf) {
+ gotCalls = append(gotCalls, curCall.Node().(*ast.CallExpr))
+ }
+
+ if !slices.Equal(gotUses, wantUses) {
+ t.Errorf("index.Uses(fmt.Sprintf) = %v, want %v", gotUses, wantUses)
+ }
+ if !slices.Equal(gotCalls, wantCalls) {
+ t.Errorf("index.Calls(fmt.Sprintf) = %v, want %v", gotCalls, wantCalls)
+ }
+}
+
+func loadNetHTTP(tb testing.TB) *packages.Package {
+ cfg := &packages.Config{Mode: packages.LoadSyntax}
+ pkgs, err := packages.Load(cfg, "net/http")
+ if err != nil {
+ tb.Fatal(err)
+ }
+ return pkgs[0]
+}
+
+func BenchmarkIndex(b *testing.B) {
+ // Load net/http, a large package, and find calls to net.Dial.
+ //
+ // There is currently exactly one, which provides an extreme
+ // demonstration of the performance advantage of the Index.
+ //
+ // Index construction costs approximately 7x the cursor
+ // traversal, so it breaks even when it replaces 7 passes.
+ // The cost of index lookup is approximately zero.
+ pkg := loadNetHTTP(b)
+
+ // Build the Inspector (~2.8ms).
+ var inspect *inspector.Inspector
+ b.Run("inspector.New", func(b *testing.B) {
+ for b.Loop() {
+ inspect = inspector.New(pkg.Syntax)
+ }
+ })
+
+ // Build the Index (~6.6ms).
+ var index *typeindex.Index
+ b.Run("typeindex.New", func(b *testing.B) {
+ b.ReportAllocs() // 2.48MB/op
+ for b.Loop() {
+ index = typeindex.New(inspect, pkg.Types, pkg.TypesInfo)
+ }
+ })
+
+ target := index.Object("net", "Dial")
+
+ var countA, countB, countC int
+
+ // unoptimized inspect implementation (~1.6ms, 1x)
+ b.Run("inspect", func(b *testing.B) {
+ for b.Loop() {
+ countA = 0
+ for _, file := range pkg.Syntax {
+ ast.Inspect(file, func(n ast.Node) bool {
+ if call, ok := n.(*ast.CallExpr); ok {
+ if typeutil.Callee(pkg.TypesInfo, call) == target {
+ countA++
+ }
+ }
+ return true
+ })
+ }
+ }
+ })
+ if countA == 0 {
+ b.Errorf("target %v not found", target)
+ }
+
+ // unoptimized cursor implementation (~390us, 4x faster)
+ b.Run("cursor", func(b *testing.B) {
+ for b.Loop() {
+ countB = 0
+ for curCall := range cursor.Root(inspect).Preorder((*ast.CallExpr)(nil)) {
+ call := curCall.Node().(*ast.CallExpr)
+ if typeutil.Callee(pkg.TypesInfo, call) == target {
+ countB++
+ }
+ }
+ }
+ })
+
+ // indexed implementation (~120ns, >10,000x faster)
+ b.Run("index", func(b *testing.B) {
+ for b.Loop() {
+ countC = 0
+ for range index.Calls(target) {
+ countC++
+ }
+ }
+ })
+
+ if countA != countB || countA != countC {
+ b.Fatalf("inconsistent results (inspect=%d, cursor=%d, index=%d)", countA, countB, countC)
+ }
+}
diff --git a/internal/typesinternal/types.go b/internal/typesinternal/types.go
index 34534879630..cc244689ef8 100644
--- a/internal/typesinternal/types.go
+++ b/internal/typesinternal/types.go
@@ -7,6 +7,7 @@
package typesinternal
import (
+ "go/ast"
"go/token"
"go/types"
"reflect"
@@ -32,12 +33,14 @@ func SetUsesCgo(conf *types.Config) bool {
return true
}
-// ReadGo116ErrorData extracts additional information from types.Error values
+// ErrorCodeStartEnd extracts additional information from types.Error values
// generated by Go version 1.16 and later: the error code, start position, and
// end position. If all positions are valid, start <= err.Pos <= end.
//
// If the data could not be read, the final result parameter will be false.
-func ReadGo116ErrorData(err types.Error) (code ErrorCode, start, end token.Pos, ok bool) {
+//
+// TODO(adonovan): eliminate start/end when proposal #71803 is accepted.
+func ErrorCodeStartEnd(err types.Error) (code ErrorCode, start, end token.Pos, ok bool) {
var data [3]int
// By coincidence all of these fields are ints, which simplifies things.
v := reflect.ValueOf(err)
@@ -125,3 +128,17 @@ func Origin(t NamedOrAlias) NamedOrAlias {
func IsPackageLevel(obj types.Object) bool {
return obj.Pkg() != nil && obj.Parent() == obj.Pkg().Scope()
}
+
+// NewTypesInfo returns a *types.Info with all maps populated.
+func NewTypesInfo() *types.Info {
+ return &types.Info{
+ Types: map[ast.Expr]types.TypeAndValue{},
+ Instances: map[*ast.Ident]types.Instance{},
+ Defs: map[*ast.Ident]types.Object{},
+ Uses: map[*ast.Ident]types.Object{},
+ Implicits: map[ast.Node]types.Object{},
+ Selections: map[*ast.SelectorExpr]*types.Selection{},
+ Scopes: map[ast.Node]*types.Scope{},
+ FileVersions: map[*ast.File]string{},
+ }
+}
diff --git a/internal/typesinternal/zerovalue_test.go b/internal/typesinternal/zerovalue_test.go
index 8ec1012dfda..67295a95020 100644
--- a/internal/typesinternal/zerovalue_test.go
+++ b/internal/typesinternal/zerovalue_test.go
@@ -68,15 +68,15 @@ type aliasNamed = foo
func _[T any]() {
type aliasTypeParam = T
- // type aliasWithTypeParam[u any] = struct {
- // x u
- // y T
- // }
- // type aliasWithTypeParams[u, q any] = struct {
- // x u
- // y q
- // z T
- // }
+ type aliasWithTypeParam[u any] = struct {
+ x u
+ y T
+ }
+ type aliasWithTypeParams[u, q any] = struct {
+ x u
+ y q
+ z T
+ }
type namedWithTypeParam[u any] struct {
x u
@@ -135,9 +135,8 @@ func _[T any]() {
_ aliasTypeParam // *new(T)
_ *aliasTypeParam // nil
- // TODO(hxjiang): add test for alias type param after stop supporting go1.22.
- // _ aliasWithTypeParam[int] // aliasWithTypeParam[int]{}
- // _ aliasWithTypeParams[int, string] // aliasWithTypeParams[int, string]{}
+ _ aliasWithTypeParam[int] // aliasWithTypeParam[int]{}
+ _ aliasWithTypeParams[int, string] // aliasWithTypeParams[int, string]{}
_ namedWithTypeParam[int] // namedWithTypeParam[int]{}
_ namedWithTypeParams[int, string] // namedWithTypeParams[int, string]{}
diff --git a/internal/xcontext/xcontext.go b/internal/xcontext/xcontext.go
index ff8ed4ebb95..641dfe5a102 100644
--- a/internal/xcontext/xcontext.go
+++ b/internal/xcontext/xcontext.go
@@ -17,7 +17,7 @@ func Detach(ctx context.Context) context.Context { return detachedContext{ctx} }
type detachedContext struct{ parent context.Context }
-func (v detachedContext) Deadline() (time.Time, bool) { return time.Time{}, false }
-func (v detachedContext) Done() <-chan struct{} { return nil }
-func (v detachedContext) Err() error { return nil }
-func (v detachedContext) Value(key interface{}) interface{} { return v.parent.Value(key) }
+func (v detachedContext) Deadline() (time.Time, bool) { return time.Time{}, false }
+func (v detachedContext) Done() <-chan struct{} { return nil }
+func (v detachedContext) Err() error { return nil }
+func (v detachedContext) Value(key any) any { return v.parent.Value(key) }
diff --git a/playground/socket/socket.go b/playground/socket/socket.go
index 9e5b4a954d2..c7843e59734 100644
--- a/playground/socket/socket.go
+++ b/playground/socket/socket.go
@@ -3,7 +3,6 @@
// license that can be found in the LICENSE file.
//go:build !appengine
-// +build !appengine
// Package socket implements a WebSocket-based playground backend.
// Clients connect to a websocket handler and send run/kill commands, and
@@ -29,6 +28,7 @@ import (
"os/exec"
"path/filepath"
"runtime"
+ "slices"
"strings"
"time"
"unicode/utf8"
@@ -440,12 +440,7 @@ func (p *process) cmd(dir string, args ...string) *exec.Cmd {
}
func isNacl() bool {
- for _, v := range append(Environ(), os.Environ()...) {
- if v == "GOOS=nacl" {
- return true
- }
- }
- return false
+ return slices.Contains(append(Environ(), os.Environ()...), "GOOS=nacl")
}
// naclCmd returns an *exec.Cmd that executes bin under native client.
diff --git a/playground/socket/socket_test.go b/playground/socket/socket_test.go
index d410afea875..942f27e2af5 100644
--- a/playground/socket/socket_test.go
+++ b/playground/socket/socket_test.go
@@ -52,7 +52,7 @@ func TestLimiter(t *testing.T) {
ch := make(chan *Message)
go func() {
var m Message
- for i := 0; i < msgLimit+10; i++ {
+ for range msgLimit + 10 {
ch <- &m
}
ch <- &Message{Kind: "end"}
diff --git a/present/link.go b/present/link.go
index ef96bf4ef6b..f6a8be1e693 100644
--- a/present/link.go
+++ b/present/link.go
@@ -86,10 +86,10 @@ func parseInlineLink(s string) (link string, length int) {
// If the URL is http://foo.com, drop the http://
// In other words, render [[http://golang.org]] as:
// golang.org
- if strings.HasPrefix(rawURL, url.Scheme+"://") {
- simpleURL = strings.TrimPrefix(rawURL, url.Scheme+"://")
- } else if strings.HasPrefix(rawURL, url.Scheme+":") {
- simpleURL = strings.TrimPrefix(rawURL, url.Scheme+":")
+ if after, ok := strings.CutPrefix(rawURL, url.Scheme+"://"); ok {
+ simpleURL = after
+ } else if after, ok := strings.CutPrefix(rawURL, url.Scheme+":"); ok {
+ simpleURL = after
}
}
return renderLink(rawURL, simpleURL), end + 2
diff --git a/present/parse_test.go b/present/parse_test.go
index dad57ea77ca..bb0fe72fad0 100644
--- a/present/parse_test.go
+++ b/present/parse_test.go
@@ -27,7 +27,6 @@ func TestTestdata(t *testing.T) {
}
files := append(filesP, filesMD...)
for _, file := range files {
- file := file
name := filepath.Base(file)
if name == "README" {
continue
diff --git a/refactor/eg/eg.go b/refactor/eg/eg.go
index 15dfbd6ca0f..8de1fd7d1de 100644
--- a/refactor/eg/eg.go
+++ b/refactor/eg/eg.go
@@ -8,12 +8,14 @@ package eg // import "golang.org/x/tools/refactor/eg"
import (
"bytes"
+ "errors"
"fmt"
"go/ast"
"go/format"
"go/printer"
"go/token"
"go/types"
+ "maps"
"os"
)
@@ -158,6 +160,10 @@ type Transformer struct {
// described in the package documentation.
// tmplInfo is the type information for tmplFile.
func NewTransformer(fset *token.FileSet, tmplPkg *types.Package, tmplFile *ast.File, tmplInfo *types.Info, verbose bool) (*Transformer, error) {
+ // These maps are required by types.Info.TypeOf.
+ if tmplInfo.Types == nil || tmplInfo.Defs == nil || tmplInfo.Uses == nil {
+ return nil, errors.New("eg.NewTransformer: types.Info argument missing one of Types, Defs or Uses")
+ }
// Check the template.
beforeSig := funcSig(tmplPkg, "before")
if beforeSig == nil {
@@ -350,18 +356,10 @@ func stmtAndExpr(fn *ast.FuncDecl) ([]ast.Stmt, ast.Expr, error) {
// mergeTypeInfo adds type info from src to dst.
func mergeTypeInfo(dst, src *types.Info) {
- for k, v := range src.Types {
- dst.Types[k] = v
- }
- for k, v := range src.Defs {
- dst.Defs[k] = v
- }
- for k, v := range src.Uses {
- dst.Uses[k] = v
- }
- for k, v := range src.Selections {
- dst.Selections[k] = v
- }
+ maps.Copy(dst.Types, src.Types)
+ maps.Copy(dst.Defs, src.Defs)
+ maps.Copy(dst.Uses, src.Uses)
+ maps.Copy(dst.Selections, src.Selections)
}
// (debugging only)
diff --git a/refactor/eg/eg_test.go b/refactor/eg/eg_test.go
index eb54f0b3f95..4dc24f53358 100644
--- a/refactor/eg/eg_test.go
+++ b/refactor/eg/eg_test.go
@@ -5,7 +5,6 @@
// No testdata on Android.
//go:build !android
-// +build !android
package eg_test
diff --git a/refactor/eg/match.go b/refactor/eg/match.go
index 31f8af28f23..d85a473b978 100644
--- a/refactor/eg/match.go
+++ b/refactor/eg/match.go
@@ -13,8 +13,6 @@ import (
"log"
"os"
"reflect"
-
- "golang.org/x/tools/go/ast/astutil"
)
// matchExpr reports whether pattern x matches y.
@@ -34,8 +32,8 @@ func (tr *Transformer) matchExpr(x, y ast.Expr) bool {
if x == nil || y == nil {
return false
}
- x = unparen(x)
- y = unparen(y)
+ x = ast.Unparen(x)
+ y = ast.Unparen(y)
// Is x a wildcard? (a reference to a 'before' parameter)
if xobj, ok := tr.wildcardObj(x); ok {
@@ -229,8 +227,6 @@ func (tr *Transformer) matchWildcard(xobj *types.Var, y ast.Expr) bool {
// -- utilities --------------------------------------------------------
-func unparen(e ast.Expr) ast.Expr { return astutil.Unparen(e) }
-
// isRef returns the object referred to by this (possibly qualified)
// identifier, or nil if the node is not a referring identifier.
func isRef(n ast.Node, info *types.Info) types.Object {
diff --git a/refactor/eg/rewrite.go b/refactor/eg/rewrite.go
index 3f71c53b7bb..6fb1e44ef30 100644
--- a/refactor/eg/rewrite.go
+++ b/refactor/eg/rewrite.go
@@ -338,7 +338,7 @@ func (tr *Transformer) subst(env map[string]ast.Expr, pattern, pos reflect.Value
}
return v
- case reflect.Ptr:
+ case reflect.Pointer:
v := reflect.New(p.Type()).Elem()
if elem := p.Elem(); elem.IsValid() {
v.Set(tr.subst(env, elem, pos).Addr())
diff --git a/refactor/importgraph/graph_test.go b/refactor/importgraph/graph_test.go
index f3378a41e86..a07cc633454 100644
--- a/refactor/importgraph/graph_test.go
+++ b/refactor/importgraph/graph_test.go
@@ -5,7 +5,6 @@
// Incomplete std lib sources on Android.
//go:build !android
-// +build !android
package importgraph_test
diff --git a/refactor/rename/rename.go b/refactor/rename/rename.go
index 3e944b2df38..cb218434e49 100644
--- a/refactor/rename/rename.go
+++ b/refactor/rename/rename.go
@@ -491,7 +491,7 @@ func (r *renamer) update() error {
for _, info := range r.packages {
for _, f := range info.Files {
tokenFile := r.iprog.Fset.File(f.FileStart)
- if filesToUpdate[tokenFile] && generated(f, tokenFile) {
+ if filesToUpdate[tokenFile] && ast.IsGenerated(f) {
generatedFileNames = append(generatedFileNames, tokenFile.Name())
}
}
diff --git a/refactor/rename/spec.go b/refactor/rename/spec.go
index 1d8c32c9dc3..0a6d7d4346c 100644
--- a/refactor/rename/spec.go
+++ b/refactor/rename/spec.go
@@ -19,7 +19,6 @@ import (
"log"
"os"
"path/filepath"
- "regexp"
"strconv"
"strings"
@@ -155,7 +154,7 @@ func parseObjectSpec(spec *spec, main string) error {
}
if e, ok := e.(*ast.SelectorExpr); ok {
- x := unparen(e.X)
+ x := ast.Unparen(e.X)
// Strip off star constructor, if any.
if star, ok := x.(*ast.StarExpr); ok {
@@ -172,7 +171,7 @@ func parseObjectSpec(spec *spec, main string) error {
if x, ok := x.(*ast.SelectorExpr); ok {
// field/method of type e.g. ("encoding/json".Decoder).Decode
- y := unparen(x.X)
+ y := ast.Unparen(x.X)
if pkg := parseImportPath(y); pkg != "" {
spec.pkg = pkg // e.g. "encoding/json"
spec.pkgMember = x.Sel.Name // e.g. "Decoder"
@@ -321,7 +320,7 @@ func findFromObjectsInFile(iprog *loader.Program, spec *spec) ([]types.Object, e
if spec.offset != 0 {
// We cannot refactor generated files since position information is invalidated.
- if generated(f, thisFile) {
+ if ast.IsGenerated(f) {
return nil, fmt.Errorf("cannot rename identifiers in generated file containing DO NOT EDIT marker: %s", thisFile.Name())
}
@@ -566,25 +565,3 @@ func ambiguityError(fset *token.FileSet, objects []types.Object) error {
return fmt.Errorf("ambiguous specifier %s matches %s",
objects[0].Name(), buf.String())
}
-
-// Matches cgo generated comment as well as the proposed standard:
-//
-// https://golang.org/s/generatedcode
-var generatedRx = regexp.MustCompile(`// .*DO NOT EDIT\.?`)
-
-// generated reports whether ast.File is a generated file.
-func generated(f *ast.File, tokenFile *token.File) bool {
-
- // Iterate over the comments in the file
- for _, commentGroup := range f.Comments {
- for _, comment := range commentGroup.List {
- if matched := generatedRx.MatchString(comment.Text); matched {
- // Check if comment is at the beginning of the line in source
- if pos := tokenFile.Position(comment.Slash); pos.Column == 1 {
- return true
- }
- }
- }
- }
- return false
-}
diff --git a/refactor/rename/util.go b/refactor/rename/util.go
index 7c1a634e4ed..cb7cea3a86e 100644
--- a/refactor/rename/util.go
+++ b/refactor/rename/util.go
@@ -5,7 +5,6 @@
package rename
import (
- "go/ast"
"go/token"
"go/types"
"os"
@@ -14,8 +13,6 @@ import (
"runtime"
"strings"
"unicode"
-
- "golang.org/x/tools/go/ast/astutil"
)
func objectKind(obj types.Object) string {
@@ -93,8 +90,6 @@ func sameFile(x, y string) bool {
return false
}
-func unparen(e ast.Expr) ast.Expr { return astutil.Unparen(e) }
-
func is[T any](x any) bool {
_, ok := x.(T)
return ok
diff --git a/refactor/satisfy/find.go b/refactor/satisfy/find.go
index 3d693aa04ab..766cc575387 100644
--- a/refactor/satisfy/find.go
+++ b/refactor/satisfy/find.go
@@ -84,6 +84,9 @@ type Finder struct {
// info.{Defs,Uses,Selections,Types} must have been populated by the
// type-checker.
func (f *Finder) Find(info *types.Info, files []*ast.File) {
+ if info.Defs == nil || info.Uses == nil || info.Selections == nil || info.Types == nil {
+ panic("Finder.Find: one of info.{Defs,Uses,Selections.Types} is not populated")
+ }
if f.Result == nil {
f.Result = make(map[Constraint]bool)
}
@@ -126,13 +129,13 @@ func (f *Finder) exprN(e ast.Expr) types.Type {
case *ast.CallExpr:
// x, err := f(args)
- sig := coreType(f.expr(e.Fun)).(*types.Signature)
+ sig := typeparams.CoreType(f.expr(e.Fun)).(*types.Signature)
f.call(sig, e.Args)
case *ast.IndexExpr:
// y, ok := x[i]
x := f.expr(e.X)
- f.assign(f.expr(e.Index), coreType(x).(*types.Map).Key())
+ f.assign(f.expr(e.Index), typeparams.CoreType(x).(*types.Map).Key())
case *ast.TypeAssertExpr:
// y, ok := x.(T)
@@ -213,7 +216,7 @@ func (f *Finder) builtin(obj *types.Builtin, sig *types.Signature, args []ast.Ex
f.expr(args[1])
} else {
// append(x, y, z)
- tElem := coreType(s).(*types.Slice).Elem()
+ tElem := typeparams.CoreType(s).(*types.Slice).Elem()
for _, arg := range args[1:] {
f.assign(tElem, f.expr(arg))
}
@@ -222,7 +225,7 @@ func (f *Finder) builtin(obj *types.Builtin, sig *types.Signature, args []ast.Ex
case "delete":
m := f.expr(args[0])
k := f.expr(args[1])
- f.assign(coreType(m).(*types.Map).Key(), k)
+ f.assign(typeparams.CoreType(m).(*types.Map).Key(), k)
default:
// ordinary call
@@ -273,7 +276,7 @@ func (f *Finder) assign(lhs, rhs types.Type) {
if types.Identical(lhs, rhs) {
return
}
- if !isInterface(lhs) {
+ if !types.IsInterface(lhs) {
return
}
@@ -354,7 +357,7 @@ func (f *Finder) expr(e ast.Expr) types.Type {
f.sig = saved
case *ast.CompositeLit:
- switch T := coreType(typeparams.Deref(tv.Type)).(type) {
+ switch T := typeparams.CoreType(typeparams.Deref(tv.Type)).(type) {
case *types.Struct:
for i, elem := range e.Elts {
if kv, ok := elem.(*ast.KeyValueExpr); ok {
@@ -405,7 +408,7 @@ func (f *Finder) expr(e ast.Expr) types.Type {
// x[i] or m[k] -- index or lookup operation
x := f.expr(e.X)
i := f.expr(e.Index)
- if ux, ok := coreType(x).(*types.Map); ok {
+ if ux, ok := typeparams.CoreType(x).(*types.Map); ok {
f.assign(ux.Key(), i)
}
}
@@ -440,7 +443,7 @@ func (f *Finder) expr(e ast.Expr) types.Type {
// unsafe call. Treat calls to functions in unsafe like ordinary calls,
// except that their signature cannot be determined by their func obj.
// Without this special handling, f.expr(e.Fun) would fail below.
- if s, ok := unparen(e.Fun).(*ast.SelectorExpr); ok {
+ if s, ok := ast.Unparen(e.Fun).(*ast.SelectorExpr); ok {
if obj, ok := f.info.Uses[s.Sel].(*types.Builtin); ok && obj.Pkg().Path() == "unsafe" {
sig := f.info.Types[e.Fun].Type.(*types.Signature)
f.call(sig, e.Args)
@@ -449,7 +452,7 @@ func (f *Finder) expr(e ast.Expr) types.Type {
}
// builtin call
- if id, ok := unparen(e.Fun).(*ast.Ident); ok {
+ if id, ok := ast.Unparen(e.Fun).(*ast.Ident); ok {
if obj, ok := f.info.Uses[id].(*types.Builtin); ok {
sig := f.info.Types[id].Type.(*types.Signature)
f.builtin(obj, sig, e.Args)
@@ -458,7 +461,7 @@ func (f *Finder) expr(e ast.Expr) types.Type {
}
// ordinary call
- f.call(coreType(f.expr(e.Fun)).(*types.Signature), e.Args)
+ f.call(typeparams.CoreType(f.expr(e.Fun)).(*types.Signature), e.Args)
}
case *ast.StarExpr:
@@ -518,7 +521,7 @@ func (f *Finder) stmt(s ast.Stmt) {
case *ast.SendStmt:
ch := f.expr(s.Chan)
val := f.expr(s.Value)
- f.assign(coreType(ch).(*types.Chan).Elem(), val)
+ f.assign(typeparams.CoreType(ch).(*types.Chan).Elem(), val)
case *ast.IncDecStmt:
f.expr(s.X)
@@ -622,9 +625,9 @@ func (f *Finder) stmt(s ast.Stmt) {
var I types.Type
switch ass := s.Assign.(type) {
case *ast.ExprStmt: // x.(type)
- I = f.expr(unparen(ass.X).(*ast.TypeAssertExpr).X)
+ I = f.expr(ast.Unparen(ass.X).(*ast.TypeAssertExpr).X)
case *ast.AssignStmt: // y := x.(type)
- I = f.expr(unparen(ass.Rhs[0]).(*ast.TypeAssertExpr).X)
+ I = f.expr(ast.Unparen(ass.Rhs[0]).(*ast.TypeAssertExpr).X)
}
for _, cc := range s.Body.List {
cc := cc.(*ast.CaseClause)
@@ -668,7 +671,7 @@ func (f *Finder) stmt(s ast.Stmt) {
var xelem types.Type
// Keys of array, *array, slice, string aren't interesting
// since the RHS key type is just an int.
- switch ux := coreType(x).(type) {
+ switch ux := typeparams.CoreType(x).(type) {
case *types.Chan:
xelem = ux.Elem()
case *types.Map:
@@ -683,13 +686,13 @@ func (f *Finder) stmt(s ast.Stmt) {
var xelem types.Type
// Values of type strings aren't interesting because
// the RHS value type is just a rune.
- switch ux := coreType(x).(type) {
+ switch ux := typeparams.CoreType(x).(type) {
case *types.Array:
xelem = ux.Elem()
case *types.Map:
xelem = ux.Elem()
case *types.Pointer: // *array
- xelem = coreType(typeparams.Deref(ux)).(*types.Array).Elem()
+ xelem = typeparams.CoreType(typeparams.Deref(ux)).(*types.Array).Elem()
case *types.Slice:
xelem = ux.Elem()
}
@@ -707,12 +710,6 @@ func (f *Finder) stmt(s ast.Stmt) {
// -- Plundered from golang.org/x/tools/go/ssa -----------------
-func unparen(e ast.Expr) ast.Expr { return ast.Unparen(e) }
-
-func isInterface(T types.Type) bool { return types.IsInterface(T) }
-
-func coreType(T types.Type) types.Type { return typeparams.CoreType(T) }
-
func instance(info *types.Info, expr ast.Expr) bool {
var id *ast.Ident
switch x := expr.(type) {