mirror of
https://github.com/golang/go
synced 2024-11-18 14:54:40 -07:00
156eb2ae29
This is a straight move of some code with no changes. It splits the part of the telemetry code that will become a standalone library from the bit that belongs in the lsp. Change-Id: Icedb6bf1f3711da9251450531729984df6df7787 Reviewed-on: https://go-review.googlesource.com/c/tools/+/190403 Run-TryBot: Ian Cottrell <iancottrell@google.com> Reviewed-by: Emmanuel Odeke <emm.odeke@gmail.com> TryBot-Result: Gobot Gobot <gobot@golang.org>
106 lines
2.6 KiB
Go
106 lines
2.6 KiB
Go
// 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 lsp
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
|
|
"golang.org/x/tools/internal/lsp/protocol"
|
|
"golang.org/x/tools/internal/lsp/source"
|
|
"golang.org/x/tools/internal/span"
|
|
"golang.org/x/tools/internal/telemetry/log"
|
|
)
|
|
|
|
type hoverKind int
|
|
|
|
const (
|
|
singleLine = hoverKind(iota)
|
|
noDocumentation
|
|
synopsisDocumentation
|
|
fullDocumentation
|
|
|
|
// structured is an experimental setting that returns a structured hover format.
|
|
// This format separates the signature from the documentation, so that the client
|
|
// can do more manipulation of these fields.
|
|
//
|
|
// This should only be used by clients that support this behavior.
|
|
structured
|
|
)
|
|
|
|
func (s *Server) hover(ctx context.Context, params *protocol.TextDocumentPositionParams) (*protocol.Hover, error) {
|
|
uri := span.NewURI(params.TextDocument.URI)
|
|
view := s.session.ViewOf(uri)
|
|
f, m, err := getGoFile(ctx, view, uri)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
spn, err := m.PointSpan(params.Position)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
identRange, err := spn.Range(m.Converter)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
ident, err := source.Identifier(ctx, f, identRange.Start)
|
|
if err != nil {
|
|
return nil, nil
|
|
}
|
|
hover, err := ident.Hover(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
identSpan, err := ident.Range.Span()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
rng, err := m.Range(identSpan)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
contents := s.toProtocolHoverContents(ctx, hover)
|
|
return &protocol.Hover{
|
|
Contents: contents,
|
|
Range: &rng,
|
|
}, nil
|
|
}
|
|
|
|
func (s *Server) toProtocolHoverContents(ctx context.Context, h *source.HoverInformation) protocol.MarkupContent {
|
|
content := protocol.MarkupContent{
|
|
Kind: s.preferredContentFormat,
|
|
}
|
|
signature := h.Signature
|
|
if content.Kind == protocol.Markdown {
|
|
signature = fmt.Sprintf("```go\n%s\n```", h.Signature)
|
|
}
|
|
switch s.hoverKind {
|
|
case singleLine:
|
|
content.Value = h.SingleLine
|
|
case noDocumentation:
|
|
content.Value = signature
|
|
case synopsisDocumentation:
|
|
if h.Synopsis != "" {
|
|
content.Value = fmt.Sprintf("%s\n%s", h.Synopsis, signature)
|
|
} else {
|
|
content.Value = signature
|
|
}
|
|
case fullDocumentation:
|
|
if h.FullDocumentation != "" {
|
|
content.Value = fmt.Sprintf("%s\n%s", signature, h.FullDocumentation)
|
|
} else {
|
|
content.Value = signature
|
|
}
|
|
case structured:
|
|
b, err := json.Marshal(h)
|
|
if err != nil {
|
|
log.Error(ctx, "failed to marshal structured hover", err)
|
|
}
|
|
content.Value = string(b)
|
|
}
|
|
return content
|
|
}
|