blob: a396793e48abca36b2e631ad6387358fb0a5bd18 [file] [log] [blame]
// 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 golang
import (
"context"
"fmt"
"go/token"
"golang.org/x/tools/gopls/internal/cache"
"golang.org/x/tools/gopls/internal/file"
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/internal/event"
)
// TypeDefinition handles the textDocument/typeDefinition request for Go files.
func TypeDefinition(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle, position protocol.Position) ([]protocol.Location, error) {
ctx, done := event.Start(ctx, "golang.TypeDefinition")
defer done()
pkg, pgf, err := NarrowestPackageForFile(ctx, snapshot, fh.URI())
if err != nil {
return nil, err
}
pos, err := pgf.PositionPos(position)
if err != nil {
return nil, err
}
// TODO(rfindley): handle type switch implicits correctly here: if the user
// jumps to the type definition of x in x := y.(type), it makes sense to jump
// to the type of y.
_, obj, _ := referencedObject(pkg, pgf, pos)
if obj == nil {
return nil, nil
}
tname := typeToObject(obj.Type())
if tname == nil {
return nil, fmt.Errorf("no type definition for %s", obj.Name())
}
if isBuiltin(tname) {
return nil, nil // built-ins (error, comparable) have no position
}
loc, err := mapPosition(ctx, pkg.FileSet(), snapshot, tname.Pos(), tname.Pos()+token.Pos(len(tname.Name())))
if err != nil {
return nil, err
}
return []protocol.Location{loc}, nil
}