1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
package lspext
import (
"fmt"
"sort"
"strings"
"github.com/sourcegraph/go-lsp"
)
// WorkspaceSymbolParams is the extension workspace/symbol parameter type.
type WorkspaceSymbolParams struct {
Query string `json:"query,omitempty"`
Limit int `json:"limit"`
Symbol SymbolDescriptor `json:"symbol,omitempty"`
}
// WorkspaceReferencesParams is parameters for the `workspace/xreferences` extension
//
// See: https://github.com/sourcegraph/language-server-protocol/blob/master/extension-workspace-reference.md
//
type WorkspaceReferencesParams struct {
// Query represents metadata about the symbol that is being searched for.
Query SymbolDescriptor `json:"query"`
// Hints provides optional hints about where the language server should
// look in order to find the symbol (this is an optimization). It is up to
// the language server to define the schema of this object.
Hints map[string]interface{} `json:"hints,omitempty"`
// Limit if positive will limit the number of results returned.
Limit int `json:"limit,omitempty"`
}
// ReferenceInformation represents information about a reference to programming
// constructs like variables, classes, interfaces etc.
type ReferenceInformation struct {
// Reference is the location in the workspace where the `symbol` has been
// referenced.
Reference lsp.Location `json:"reference"`
// Symbol is metadata information describing the symbol being referenced.
Symbol SymbolDescriptor `json:"symbol"`
}
// SymbolDescriptor represents information about a programming construct like a
// variable, class, interface, etc that has a reference to it. It is up to the
// language server to define the schema of this object.
//
// SymbolDescriptor usually uniquely identifies a symbol, but it is not
// guaranteed to do so.
type SymbolDescriptor map[string]interface{}
// SymbolLocationInformation is the response type for the `textDocument/xdefinition` extension.
type SymbolLocationInformation struct {
// A concrete location at which the definition is located, if any.
Location lsp.Location `json:"location,omitempty"`
// Metadata about the definition.
Symbol SymbolDescriptor `json:"symbol"`
}
// Contains tells if this SymbolDescriptor fully contains all of the keys and
// values in the other symbol descriptor.
func (s SymbolDescriptor) Contains(other SymbolDescriptor) bool {
for k, v := range other {
v2, ok := s[k]
if !ok || v != v2 {
return false
}
}
return true
}
// String returns a consistently ordered string representation of the
// SymbolDescriptor. It is useful for testing.
func (s SymbolDescriptor) String() string {
sm := make(sortedMap, 0, len(s))
for k, v := range s {
sm = append(sm, mapValue{key: k, value: v})
}
sort.Sort(sm)
var str string
for _, v := range sm {
str += fmt.Sprintf("%s:%v ", v.key, v.value)
}
return strings.TrimSpace(str)
}
type mapValue struct {
key string
value interface{}
}
type sortedMap []mapValue
func (s sortedMap) Len() int { return len(s) }
func (s sortedMap) Less(i, j int) bool { return s[i].key < s[j].key }
func (s sortedMap) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
|
