mirror of
https://github.com/golang/go
synced 2024-11-18 20:24:41 -07:00
e4e22f76d0
This change adds support when hierarchicalDocumentSymbolSupport is false, this can happen with editors who have not supported textDocument/DocumentSymbol. As a result, these older lsp clients need to recieve []protocol.SymbolInformation rather than []protocol.DocumentSymbol. This change required some changes to internal/lsp/cmd to handle not knowing which type it is receiving, this required manual parsing inside of cmd/symbols.go. Fixes golang/go#34893 Change-Id: I944ae24302f155b561047227f65bee34b160def1 Reviewed-on: https://go-review.googlesource.com/c/tools/+/221823 Run-TryBot: Rohan Challa <rohan@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
110 lines
2.5 KiB
Go
110 lines
2.5 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 cmd
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"flag"
|
|
"fmt"
|
|
"sort"
|
|
|
|
"golang.org/x/tools/internal/lsp/protocol"
|
|
"golang.org/x/tools/internal/span"
|
|
"golang.org/x/tools/internal/tool"
|
|
)
|
|
|
|
// symbols implements the symbols verb for gopls
|
|
type symbols struct {
|
|
app *Application
|
|
}
|
|
|
|
func (r *symbols) Name() string { return "symbols" }
|
|
func (r *symbols) Usage() string { return "<file>" }
|
|
func (r *symbols) ShortHelp() string { return "display selected file's symbols" }
|
|
func (r *symbols) DetailedHelp(f *flag.FlagSet) {
|
|
fmt.Fprint(f.Output(), `
|
|
Example:
|
|
$ gopls symbols helper/helper.go
|
|
`)
|
|
f.PrintDefaults()
|
|
}
|
|
func (r *symbols) Run(ctx context.Context, args ...string) error {
|
|
if len(args) != 1 {
|
|
return tool.CommandLineErrorf("symbols expects 1 argument (position)")
|
|
}
|
|
|
|
conn, err := r.app.connect(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer conn.terminate(ctx)
|
|
|
|
from := span.Parse(args[0])
|
|
p := protocol.DocumentSymbolParams{
|
|
TextDocument: protocol.TextDocumentIdentifier{
|
|
URI: protocol.URIFromSpanURI(from.URI()),
|
|
},
|
|
}
|
|
symbols, err := conn.DocumentSymbol(ctx, &p)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
for _, s := range symbols {
|
|
s, ok := s.(map[string]interface{})
|
|
if !ok {
|
|
continue
|
|
}
|
|
bytes, err := json.Marshal(s)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if _, ok := s["selectionRange"]; ok {
|
|
if err := parseDocumentSymbol(bytes); err != nil {
|
|
return err
|
|
}
|
|
continue
|
|
}
|
|
if err := parseSymbolInformation(bytes); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func parseDocumentSymbol(bytes []byte) error {
|
|
var s protocol.DocumentSymbol
|
|
if err := json.Unmarshal(bytes, &s); err != nil {
|
|
return err
|
|
}
|
|
fmt.Printf("%s %s %s\n", s.Name, s.Kind, positionToString(s.SelectionRange))
|
|
// Sort children for consistency
|
|
sort.Slice(s.Children, func(i, j int) bool {
|
|
return s.Children[i].Name < s.Children[j].Name
|
|
})
|
|
for _, c := range s.Children {
|
|
fmt.Printf("\t%s %s %s\n", c.Name, c.Kind, positionToString(c.SelectionRange))
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func parseSymbolInformation(bytes []byte) error {
|
|
var s protocol.SymbolInformation
|
|
if err := json.Unmarshal(bytes, &s); err != nil {
|
|
return err
|
|
}
|
|
fmt.Printf("%s %s %s\n", s.Name, s.Kind, positionToString(s.Location.Range))
|
|
return nil
|
|
}
|
|
|
|
func positionToString(r protocol.Range) string {
|
|
return fmt.Sprintf("%v:%v-%v:%v",
|
|
r.Start.Line+1,
|
|
r.Start.Character+1,
|
|
r.End.Line+1,
|
|
r.End.Character+1,
|
|
)
|
|
}
|