-
Notifications
You must be signed in to change notification settings - Fork 182
/
references.py
182 lines (147 loc) · 7.39 KB
/
references.py
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
import os
import sublime
import linecache
from .core.documents import is_at_word, get_position
from .core.panels import ensure_panel
from .core.protocol import Request, Point
from .core.registry import LspTextCommand, windows
from .core.settings import PLUGIN_NAME, settings
from .core.typing import List, Dict, Optional, Tuple, TypedDict
from .core.url import uri_to_filename
from .core.views import get_line, text_document_position_params
ReferenceDict = TypedDict('ReferenceDict', {'uri': str, 'range': dict})
def ensure_references_panel(window: sublime.Window) -> 'Optional[sublime.View]':
return ensure_panel(window, "references", r"^\s*\S\s+(\S.*):$", r"^\s+([0-9]+):?([0-9]+).*$",
"Packages/" + PLUGIN_NAME + "/Syntaxes/References.sublime-syntax")
class LspSymbolReferencesCommand(LspTextCommand):
def __init__(self, view: sublime.View) -> None:
super().__init__(view)
self.reflist = [] # type: List[List[str]]
self.word_region = None # type: Optional[sublime.Region]
self.word = ""
self.base_dir = None # type: Optional[str]
def is_enabled(self, event: Optional[dict] = None) -> bool:
if self.has_client_with_capability('referencesProvider'):
return is_at_word(self.view, event)
return False
def run(self, edit: sublime.Edit, event: Optional[dict] = None) -> None:
client = self.client_with_capability('referencesProvider')
file_path = self.view.file_name()
if client and file_path:
pos = get_position(self.view, event)
window = self.view.window()
self.word_region = self.view.word(pos)
self.word = self.view.substr(self.word_region)
# use relative paths if file on the same root.
base_dir = windows.lookup(window).get_project_path(file_path)
if base_dir:
if os.path.commonprefix([base_dir, file_path]):
self.base_dir = base_dir
document_position = text_document_position_params(self.view, pos)
document_position['context'] = {"includeDeclaration": False}
request = Request.references(document_position)
client.send_request(request, lambda response: self.handle_response(response, pos))
def handle_response(self, response: Optional[List[ReferenceDict]], pos: int) -> None:
window = self.view.window()
if response is None:
response = []
if window:
references_count = len(response)
# return if there are no references
if references_count < 1:
window.run_command("hide_panel", {"panel": "output.references"})
window.status_message("No references found")
return
references_by_file = self._group_references_by_file(response)
if settings.show_references_in_quick_panel:
self.show_quick_panel(references_by_file)
else:
self.show_references_panel(references_by_file)
def show_quick_panel(self, references_by_file: Dict[str, List[Tuple[Point, str]]]) -> None:
selected_index = -1
current_file_path = self.view.file_name()
self.reflist.clear()
for file_path, references in references_by_file.items():
for reference in references:
point, line = reference
item = ['{}:{}:{}'.format(self.get_relative_path(file_path), point.row + 1, point.col + 1), line]
self.reflist.append(item)
# pre-select a reference in the current file.
if current_file_path == file_path and selected_index == -1:
selected_index = len(self.reflist) - 1
flags = sublime.KEEP_OPEN_ON_FOCUS_LOST
window = self.view.window()
if window:
window.show_quick_panel(
self.reflist,
self.on_ref_choice,
flags,
selected_index,
self.on_ref_highlight
)
def on_ref_choice(self, index: int) -> None:
self.open_ref_index(index)
def on_ref_highlight(self, index: int) -> None:
self.open_ref_index(index, transient=True)
def open_ref_index(self, index: int, transient: bool = False) -> None:
if index != -1:
flags = sublime.ENCODED_POSITION | sublime.TRANSIENT if transient else sublime.ENCODED_POSITION
window = self.view.window()
if window:
window.open_file(self.get_selected_file_path(index), flags)
def show_references_panel(self, references_by_file: Dict[str, List[Tuple[Point, str]]]) -> None:
window = self.view.window()
if window:
panel = ensure_references_panel(window)
if not panel:
return
text = ''
references_count = 0
for file, references in references_by_file.items():
text += '◌ {}:\n'.format(self.get_relative_path(file))
for reference in references:
references_count += 1
point, line = reference
text += '\t{:>8}:{:<4} {}\n'.format(point.row + 1, point.col + 1, line)
# append a new line after each file name
text += '\n'
base_dir = windows.lookup(window).get_project_path(self.view.file_name() or "")
panel.settings().set("result_base_dir", base_dir)
panel.run_command("lsp_clear_panel")
window.run_command("show_panel", {"panel": "output.references"})
panel.run_command('append', {
'characters': "{} references for '{}'\n\n{}".format(references_count, self.word, text),
'force': True,
'scroll_to_end': False
})
# highlight all word occurrences
regions = panel.find_all(r"\b{}\b".format(self.word))
panel.add_regions('ReferenceHighlight', regions, 'comment', flags=sublime.DRAW_OUTLINED)
def get_selected_file_path(self, index: int) -> str:
return self.get_full_path(self.reflist[index][0])
def get_relative_path(self, file_path: str) -> str:
if self.base_dir:
return os.path.relpath(file_path, self.base_dir)
else:
return file_path
def get_full_path(self, file_path: str) -> str:
if self.base_dir:
return os.path.join(self.base_dir, file_path)
return file_path
def want_event(self) -> bool:
return True
def _group_references_by_file(self, references: List[ReferenceDict]
) -> Dict[str, List[Tuple[Point, str]]]:
""" Return a dictionary that groups references by the file it belongs. """
grouped_references = {} # type: Dict[str, List[Tuple[Point, str]]]
for reference in references:
file_path = uri_to_filename(reference["uri"])
point = Point.from_lsp(reference['range']['start'])
# get line of the reference, to showcase its use
reference_line = get_line(self.view.window(), file_path, point.row)
if grouped_references.get(file_path) is None:
grouped_references[file_path] = []
grouped_references[file_path].append((point, reference_line))
# we don't want to cache the line, we always want to get fresh data
linecache.clearcache()
return grouped_references