1
0
mirror of https://github.com/golang/go synced 2024-11-05 11:46:12 -07:00
go/internal/lsp/symbols.go
Heschi Kreinick 412b8bda49 internal/lsp/cache: ref-count snapshots
To manually collect cache entries, we need to know when a snapshot is
idle. Add a reference count in the form of a WaitGroup and keep track of
its uses. The pattern is that any time a snapshot is returned, it comes
with a release function that decrements the ref count.

Almost all uses of a snapshot originate in a user-facing request,
handled in beginFileRequest. There it's mostly an exercise in passing
Snapshots around instead of Views.

In the other places I took the path of least resistance. For file
modifications I tried to minimize the amount of code that needed to deal
with snapshots. For diagnostics I just acquired the snapshot at the
diagnostics call.

Change-Id: Id48a2df3acdd97f27d905e2c2be23072f28f196b
Reviewed-on: https://go-review.googlesource.com/c/tools/+/241837
Run-TryBot: Heschi Kreinick <heschi@google.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-08-03 22:08:54 +00:00

52 lines
1.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 lsp
import (
"context"
"golang.org/x/tools/internal/event"
"golang.org/x/tools/internal/lsp/debug/tag"
"golang.org/x/tools/internal/lsp/protocol"
"golang.org/x/tools/internal/lsp/source"
)
func (s *Server) documentSymbol(ctx context.Context, params *protocol.DocumentSymbolParams) ([]interface{}, error) {
ctx, done := event.Start(ctx, "lsp.Server.documentSymbol")
defer done()
snapshot, fh, ok, release, err := s.beginFileRequest(ctx, params.TextDocument.URI, source.Go)
defer release()
if !ok {
return []interface{}{}, err
}
docSymbols, err := source.DocumentSymbols(ctx, snapshot, fh)
if err != nil {
event.Error(ctx, "DocumentSymbols failed", err, tag.URI.Of(fh.URI()))
return []interface{}{}, nil
}
// Convert the symbols to an interface array.
// TODO: Remove this once the lsp deprecates SymbolInformation.
symbols := make([]interface{}, len(docSymbols))
for i, s := range docSymbols {
if snapshot.View().Options().HierarchicalDocumentSymbolSupport {
symbols[i] = s
continue
}
// If the client does not support hierarchical document symbols, then
// we need to be backwards compatible for now and return SymbolInformation.
symbols[i] = protocol.SymbolInformation{
Name: s.Name,
Kind: s.Kind,
Deprecated: s.Deprecated,
Location: protocol.Location{
URI: params.TextDocument.URI,
Range: s.Range,
},
}
}
return symbols, nil
}