-
Notifications
You must be signed in to change notification settings - Fork 182
/
hover.py
268 lines (234 loc) · 11.7 KB
/
hover.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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
from .code_actions import actions_manager
from .code_actions import CodeActionOrCommand
from .core.logging import debug
from .core.promise import Promise
from .core.protocol import Diagnostic
from .core.protocol import Error
from .core.protocol import Hover
from .core.protocol import Position
from .core.protocol import RangeLsp
from .core.protocol import Request
from .core.registry import LspTextCommand
from .core.registry import windows
from .core.sessions import SessionBufferProtocol
from .core.settings import userprefs
from .core.typing import List, Optional, Dict, Tuple, Sequence, Union
from .core.views import diagnostic_severity
from .core.views import first_selection_region
from .core.views import format_diagnostic_for_html
from .core.views import FORMAT_MARKED_STRING, FORMAT_MARKUP_CONTENT, minihtml
from .core.views import is_location_href
from .core.views import make_command_link
from .core.views import make_link
from .core.views import show_lsp_popup
from .core.views import text_document_position_params
from .core.views import unpack_href_location
from .core.views import update_lsp_popup
from .core.windows import AbstractViewListener
from urllib.parse import unquote, urlparse
import functools
import re
import sublime
import webbrowser
SUBLIME_WORD_MASK = 515
SessionName = str
ResolvedHover = Union[Hover, Error]
_test_contents = [] # type: List[str]
class LinkKind:
__slots__ = ("lsp_name", "label", "subl_cmd_name", "supports_side_by_side")
def __init__(self, lsp_name: str, label: str, subl_cmd_name: str, supports_side_by_side: bool) -> None:
self.lsp_name = lsp_name
self.label = label
self.subl_cmd_name = subl_cmd_name
self.supports_side_by_side = supports_side_by_side
def link(self, point: int, view: sublime.View) -> str:
args = {'point': point}
link = make_command_link(self.subl_cmd_name, self.label, args, None, view)
if self.supports_side_by_side:
args['side_by_side'] = True
link += ' ' + make_command_link(self.subl_cmd_name, '◨', args, 'icon', view)
return link
link_kinds = [
LinkKind("definition", "Definition", "lsp_symbol_definition", True),
LinkKind("typeDefinition", "Type Definition", "lsp_symbol_type_definition", True),
LinkKind("declaration", "Declaration", "lsp_symbol_declaration", True),
LinkKind("implementation", "Implementation", "lsp_symbol_implementation", True),
LinkKind("references", "References", "lsp_symbol_references", False),
LinkKind("rename", "Rename", "lsp_symbol_rename", False),
]
class LspHoverCommand(LspTextCommand):
def __init__(self, view: sublime.View) -> None:
super().__init__(view)
self._base_dir = None # type: Optional[str]
def run(
self,
edit: sublime.Edit,
only_diagnostics: bool = False,
point: Optional[int] = None,
event: Optional[dict] = None
) -> None:
temp_point = point
if temp_point is None:
region = first_selection_region(self.view)
if region is not None:
temp_point = region.begin()
if temp_point is None:
return
window = self.view.window()
if not window:
return
hover_point = temp_point
wm = windows.lookup(window)
self._base_dir = wm.get_project_path(self.view.file_name() or "")
self._hover_responses = [] # type: List[Hover]
self._actions_by_config = {} # type: Dict[str, List[CodeActionOrCommand]]
self._diagnostics_by_config = [] # type: Sequence[Tuple[SessionBufferProtocol, Sequence[Diagnostic]]]
# TODO: For code actions it makes more sense to use the whole selection under mouse (if available)
# rather than just the hover point.
def run_async() -> None:
listener = wm.listener_for_view(self.view)
if not listener:
return
if not only_diagnostics:
self.request_symbol_hover_async(listener, hover_point)
self._diagnostics_by_config, covering = listener.diagnostics_touching_point_async(
hover_point, userprefs().show_diagnostics_severity_level)
if self._diagnostics_by_config:
self.show_hover(listener, hover_point, only_diagnostics)
if not only_diagnostics and userprefs().show_code_actions_in_hover:
actions_manager.request_for_region_async(
self.view, covering, self._diagnostics_by_config,
functools.partial(self.handle_code_actions, listener, hover_point))
sublime.set_timeout_async(run_async)
def request_symbol_hover_async(self, listener: AbstractViewListener, point: int) -> None:
hover_promises = [] # type: List[Promise[ResolvedHover]]
document_position = text_document_position_params(self.view, point)
for session in listener.sessions_async('hoverProvider'):
hover_promises.append(session.send_request_task(
Request("textDocument/hover", document_position, self.view)
))
Promise.all(hover_promises).then(lambda responses: self._on_all_settled(responses, listener, point))
def _on_all_settled(self, responses: List[ResolvedHover], listener: AbstractViewListener, point: int) -> None:
hovers = [] # type: List[Hover]
errors = [] # type: List[Error]
for response in responses:
if isinstance(response, Error):
errors.append(response)
continue
if response:
hovers.append(response)
if errors:
error_messages = ", ".join(str(error) for error in errors)
sublime.status_message('Hover error: {}'.format(error_messages))
self._hover_responses = hovers
self.show_hover(listener, point, only_diagnostics=False)
def handle_code_actions(
self,
listener: AbstractViewListener,
point: int,
responses: Dict[str, List[CodeActionOrCommand]]
) -> None:
self._actions_by_config = responses
self.show_hover(listener, point, only_diagnostics=False)
def provider_exists(self, listener: AbstractViewListener, link: LinkKind) -> bool:
return bool(listener.session_async('{}Provider'.format(link.lsp_name)))
def symbol_actions_content(self, listener: AbstractViewListener, point: int) -> str:
if userprefs().show_symbol_action_links:
actions = [lk.link(point, self.view) for lk in link_kinds if self.provider_exists(listener, lk)]
if actions:
return '<div class="actions">' + " | ".join(actions) + "</div>"
return ""
def diagnostics_content(self) -> str:
formatted = []
for sb, diagnostics in self._diagnostics_by_config:
by_severity = {} # type: Dict[int, List[str]]
formatted.append('<div class="diagnostics">')
for diagnostic in diagnostics:
by_severity.setdefault(diagnostic_severity(diagnostic), []).append(
format_diagnostic_for_html(self.view, sb.session.config, diagnostic, self._base_dir))
for items in by_severity.values():
formatted.extend(items)
formatted.append("</div>")
return "".join(formatted)
def code_actions_content(self) -> str:
formatted = []
for config_name, actions in self._actions_by_config.items():
action_count = len(actions)
if action_count > 0:
href = "{}:{}".format('code-actions', config_name)
if action_count > 1:
text = "choose code action ({} available)".format(action_count)
else:
text = actions[0].get('title', 'code action')
formatted.append('<div class="actions">[{}] Code action: {}</div>'.format(
config_name, make_link(href, text)))
return "".join(formatted)
def hover_content(self) -> str:
contents = []
for hover_response in self._hover_responses:
content = (hover_response.get('contents') or '') if isinstance(hover_response, dict) else ''
contents.append(minihtml(self.view, content, allowed_formats=FORMAT_MARKED_STRING | FORMAT_MARKUP_CONTENT))
return '<hr>'.join(contents)
def show_hover(self, listener: AbstractViewListener, point: int, only_diagnostics: bool) -> None:
sublime.set_timeout(lambda: self._show_hover(listener, point, only_diagnostics))
def _show_hover(self, listener: AbstractViewListener, point: int, only_diagnostics: bool) -> None:
hover_content = self.hover_content()
contents = self.diagnostics_content() + hover_content + self.code_actions_content()
if contents and not only_diagnostics and hover_content:
contents += self.symbol_actions_content(listener, point)
_test_contents.clear()
_test_contents.append(contents) # for testing only
if contents:
if self.view.is_popup_visible():
update_lsp_popup(self.view, contents)
else:
show_lsp_popup(
self.view,
contents,
flags=sublime.HIDE_ON_MOUSE_MOVE_AWAY,
location=point,
on_navigate=lambda href: self._on_navigate(href, point))
def _on_navigate(self, href: str, point: int) -> None:
if href.startswith("subl:"):
pass
elif href.startswith("file:"):
window = self.view.window()
if window:
decoded = unquote(href) # decode percent-encoded characters
parsed = urlparse(decoded)
filepath = parsed.path
if sublime.platform() == "windows":
filepath = re.sub(r"^/([a-zA-Z]:)", r"\1", filepath) # remove slash preceding drive letter
fn = "{}:{}".format(filepath, parsed.fragment) if parsed.fragment else filepath
window.open_file(fn, flags=sublime.ENCODED_POSITION)
elif href.startswith('code-actions:'):
_, config_name = href.split(":")
titles = [command["title"] for command in self._actions_by_config[config_name]]
self.view.run_command("lsp_selection_set", {"regions": [(point, point)]})
if len(titles) > 1:
window = self.view.window()
if window:
window.show_quick_panel(titles, lambda i: self.handle_code_action_select(config_name, i),
placeholder="Code actions")
else:
self.handle_code_action_select(config_name, 0)
elif is_location_href(href):
session_name, uri, row, col_utf16 = unpack_href_location(href)
session = self.session_by_name(session_name)
if session:
position = {"line": row, "character": col_utf16} # type: Position
r = {"start": position, "end": position} # type: RangeLsp
sublime.set_timeout_async(functools.partial(session.open_uri_async, uri, r))
else:
# NOTE: Remove this check when on py3.8.
if not (href.lower().startswith("http://") or href.lower().startswith("https://")):
href = "http://" + href
if not webbrowser.open(href):
debug("failed to open:", href)
def handle_code_action_select(self, config_name: str, index: int) -> None:
if index > -1:
def run_async() -> None:
session = self.session_by_name(config_name)
if session:
session.run_code_action_async(self._actions_by_config[config_name][index], progress=True)
sublime.set_timeout_async(run_async)