/
hover.py
181 lines (149 loc) · 6.57 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
import mdpopups
import sublime
import sublime_plugin
import webbrowser
from html import escape
try:
from typing import List, Optional, Any, Dict
assert List and Optional and Any and Dict
except ImportError:
pass
from .core.configurations import is_supported_syntax
from .diagnostics import get_point_diagnostics
from .core.registry import session_for_view, LspTextCommand
from .core.protocol import Request, DiagnosticSeverity
from .core.documents import get_document_position
from .core.popups import popup_css, popup_class
from .core.settings import client_configs
SUBLIME_WORD_MASK = 515
NO_HOVER_SCOPES = 'comment, string'
class HoverHandler(sublime_plugin.ViewEventListener):
def __init__(self, view):
self.view = view
@classmethod
def is_applicable(cls, settings):
syntax = settings.get('syntax')
return syntax and is_supported_syntax(syntax, client_configs.all)
def on_hover(self, point, hover_zone):
if hover_zone != sublime.HOVER_TEXT or self.view.is_popup_visible():
return
self.view.run_command("lsp_hover", {"point": point})
_test_contents = [] # type: List[str]
class_for_severity = {
DiagnosticSeverity.Error: 'errors',
DiagnosticSeverity.Warning: 'warnings',
DiagnosticSeverity.Information: 'info',
DiagnosticSeverity.Hint: 'hints'
}
class LspHoverCommand(LspTextCommand):
def __init__(self, view):
super().__init__(view)
def is_likely_at_symbol(self, point):
word_at_sel = self.view.classify(point)
return word_at_sel & SUBLIME_WORD_MASK and not self.view.match_selector(point, NO_HOVER_SCOPES)
def run(self, edit, point=None):
if point is None:
point = self.view.sel()[0].begin()
if self.is_likely_at_symbol(point):
self.request_symbol_hover(point)
point_diagnostics = get_point_diagnostics(self.view, point)
if point_diagnostics:
self.show_hover(point, self.diagnostics_content(point_diagnostics))
def request_symbol_hover(self, point) -> None:
session = session_for_view(self.view, point)
if session:
if session.has_capability('hoverProvider'):
document_position = get_document_position(self.view, point)
if document_position:
if session.client:
session.client.send_request(
Request.hover(document_position),
lambda response: self.handle_response(response, point))
def handle_response(self, response: 'Optional[Any]', point) -> None:
all_content = ""
point_diagnostics = get_point_diagnostics(self.view, point)
if point_diagnostics:
all_content += self.diagnostics_content(point_diagnostics)
all_content += self.hover_content(point, response)
all_content += self.symbol_actions_content()
_test_contents.clear()
_test_contents.append(all_content) # for testing only
self.show_hover(point, all_content)
def symbol_actions_content(self):
actions = []
if self.has_client_with_capability('definitionProvider'):
actions.append("<a href='{}'>{}</a>".format('definition', 'Definition'))
if self.has_client_with_capability('referencesProvider'):
actions.append("<a href='{}'>{}</a>".format('references', 'References'))
if self.has_client_with_capability('renameProvider'):
actions.append("<a href='{}'>{}</a>".format('rename', 'Rename'))
return "<p>" + " | ".join(actions) + "</p>"
def format_diagnostic(self, diagnostic):
if diagnostic.source:
return "<pre>[{}] {}</pre>".format(diagnostic.source, escape(diagnostic.message, False))
else:
return "<pre>{}</pre>".format(escape(diagnostic.message, False))
def diagnostics_content(self, diagnostics):
by_severity = {} # type: Dict[int, List[str]]
for diagnostic in diagnostics:
by_severity.setdefault(diagnostic.severity, []).append(self.format_diagnostic(diagnostic))
formatted = []
for severity, items in by_severity.items():
formatted.append("<div class='{}'>".format(class_for_severity[severity]))
formatted.extend(items)
formatted.append("<a href='{}'>{}</a>".format('code-actions',
'Code Actions'))
formatted.append("</div>")
return "".join(formatted)
def hover_content(self, point, response: 'Optional[Any]') -> str:
contents = ["No description available."]
if isinstance(response, dict):
# Flow returns None sometimes
# See: https://github.com/flowtype/flow-language-server/issues/51
response_content = response.get('contents')
if response_content:
if isinstance(response_content, list):
contents = response_content
else:
contents = [response_content]
formatted = []
for item in contents:
value = ""
language = None
if isinstance(item, str):
value = item
else:
value = item.get("value")
language = item.get("language")
if language:
formatted.append("```{}\n{}\n```\n".format(language, value))
else:
formatted.append(value)
return mdpopups.md2html(self.view, "\n".join(formatted))
def show_hover(self, point, contents):
mdpopups.show_popup(
self.view,
contents,
css=popup_css,
md=False,
flags=sublime.HIDE_ON_MOUSE_MOVE_AWAY,
location=point,
wrapper_class=popup_class,
max_width=800,
on_navigate=lambda href: self.on_hover_navigate(href, point))
def on_hover_navigate(self, href, point):
if href == 'definition':
self.run_command_from_point(point, "lsp_symbol_definition")
elif href == 'references':
self.run_command_from_point(point, "lsp_symbol_references")
elif href == 'rename':
self.run_command_from_point(point, "lsp_symbol_rename")
elif href == 'code-actions':
self.run_command_from_point(point, "lsp_code_actions")
else:
webbrowser.open_new_tab(href)
def run_command_from_point(self, point, command_name):
sel = self.view.sel()
sel.clear()
sel.add(sublime.Region(point, point))
self.view.run_command(command_name)