go/internal/lsp/source/hover.go
Rebecca Stambler 62e1d13d53 internal/lsp: add basic support for hover
This change adds a very simple implementation of hovering. It doesn't
show any documentation, just the object string for the given object.

Also, this change sets the prefix for composite literals, making sure we
don't insert duplicate text.

Change-Id: Ib706ec821a9e459a6c61c10f5dd28d1798944fa3
Reviewed-on: https://go-review.googlesource.com/c/152599
Run-TryBot: Rebecca Stambler <rstambler@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Ian Cottrell <iancottrell@google.com>
2018-12-05 22:25:06 +00:00

51 lines
1.2 KiB
Go

// 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 source
import (
"context"
"fmt"
"go/token"
"go/types"
)
func Hover(ctx context.Context, f *File, pos token.Pos) (string, Range, error) {
fAST, err := f.GetAST()
if err != nil {
return "", Range{}, err
}
pkg, err := f.GetPackage()
if err != nil {
return "", Range{}, err
}
i, err := findIdentifier(fAST, pos)
if err != nil {
return "", Range{}, err
}
if i.ident == nil {
return "", Range{}, fmt.Errorf("not a valid identifier")
}
obj := pkg.TypesInfo.ObjectOf(i.ident)
if obj == nil {
return "", Range{}, fmt.Errorf("no object")
}
if i.wasEmbeddedField {
// the original position was on the embedded field declaration
// so we try to dig out the type and jump to that instead
if v, ok := obj.(*types.Var); ok {
if n, ok := v.Type().(*types.Named); ok {
obj = n.Obj()
}
}
}
// TODO(rstambler): Add documentation and improve quality of object string.
content := types.ObjectString(obj, qualifier(fAST, pkg.Types, pkg.TypesInfo))
markdown := "```go\n" + content + "\n```"
return markdown, Range{
Start: i.ident.Pos(),
End: i.ident.End(),
}, nil
}