forked from qt-creator/qt-creator
LanguageClient: Add option to always send hover requests
Even if we already have a diangostic visible at this location. This is used in the coco server to display additional information inside the coverage browser. Change-Id: I0d75f2e9f469ebdf6df7d6948a8e3e6b0cc58969 Reviewed-by: Christian Stenger <christian.stenger@qt.io>
This commit is contained in:
@@ -47,6 +47,7 @@ CocoLanguageClient::CocoLanguageClient(const FilePath &coco, const FilePath &csm
|
|||||||
: Client(clientInterface(coco, csmes))
|
: Client(clientInterface(coco, csmes))
|
||||||
{
|
{
|
||||||
setName("Coco");
|
setName("Coco");
|
||||||
|
hoverHandler()->setPreferDiagnosticts(false);
|
||||||
setActivateDocumentAutomatically(false);
|
setActivateDocumentAutomatically(false);
|
||||||
LanguageFilter allFiles;
|
LanguageFilter allFiles;
|
||||||
allFiles.filePattern = QStringList{"*"};
|
allFiles.filePattern = QStringList{"*"};
|
||||||
|
@@ -54,6 +54,11 @@ void HoverHandler::abort()
|
|||||||
m_response = {};
|
m_response = {};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void HoverHandler::setPreferDiagnosticts(bool prefer)
|
||||||
|
{
|
||||||
|
m_preferDiagnostics = prefer;
|
||||||
|
}
|
||||||
|
|
||||||
void HoverHandler::setHelpItem(const LanguageServerProtocol::MessageId &msgId,
|
void HoverHandler::setHelpItem(const LanguageServerProtocol::MessageId &msgId,
|
||||||
const Core::HelpItem &help)
|
const Core::HelpItem &help)
|
||||||
{
|
{
|
||||||
@@ -68,6 +73,18 @@ void HoverHandler::setHelpItem(const LanguageServerProtocol::MessageId &msgId,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
bool HoverHandler::reportDiagnostics(const QTextCursor &cursor)
|
||||||
|
{
|
||||||
|
const QList<Diagnostic> &diagnostics = m_client->diagnosticsAt(m_uri, cursor);
|
||||||
|
if (diagnostics.isEmpty())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
const QStringList messages = Utils::transform(diagnostics, &Diagnostic::message);
|
||||||
|
setToolTip(messages.join('\n'));
|
||||||
|
m_report(Priority_Diagnostic);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
void HoverHandler::identifyMatch(TextEditor::TextEditorWidget *editorWidget,
|
void HoverHandler::identifyMatch(TextEditor::TextEditorWidget *editorWidget,
|
||||||
int pos,
|
int pos,
|
||||||
TextEditor::BaseHoverHandler::ReportPriority report)
|
TextEditor::BaseHoverHandler::ReportPriority report)
|
||||||
@@ -81,15 +98,12 @@ void HoverHandler::identifyMatch(TextEditor::TextEditorWidget *editorWidget,
|
|||||||
}
|
}
|
||||||
m_uri = DocumentUri::fromFilePath(editorWidget->textDocument()->filePath());
|
m_uri = DocumentUri::fromFilePath(editorWidget->textDocument()->filePath());
|
||||||
m_response = {};
|
m_response = {};
|
||||||
QTextCursor tc = editorWidget->textCursor();
|
m_report = report;
|
||||||
tc.setPosition(pos);
|
|
||||||
const QList<Diagnostic> &diagnostics = m_client->diagnosticsAt(m_uri, tc);
|
QTextCursor cursor = editorWidget->textCursor();
|
||||||
if (!diagnostics.isEmpty()) {
|
cursor.setPosition(pos);
|
||||||
const QStringList messages = Utils::transform(diagnostics, &Diagnostic::message);
|
if (m_preferDiagnostics && reportDiagnostics(cursor))
|
||||||
setToolTip(messages.join('\n'));
|
|
||||||
report(Priority_Diagnostic);
|
|
||||||
return;
|
return;
|
||||||
}
|
|
||||||
|
|
||||||
const Utils::optional<Utils::variant<bool, WorkDoneProgressOptions>> &provider
|
const Utils::optional<Utils::variant<bool, WorkDoneProgressOptions>> &provider
|
||||||
= m_client->capabilities().hoverProvider();
|
= m_client->capabilities().hoverProvider();
|
||||||
@@ -114,17 +128,15 @@ void HoverHandler::identifyMatch(TextEditor::TextEditorWidget *editorWidget,
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
m_report = report;
|
HoverRequest request{TextDocumentPositionParams(TextDocumentIdentifier(m_uri),
|
||||||
QTextCursor cursor = editorWidget->textCursor();
|
Position(cursor))};
|
||||||
cursor.setPosition(pos);
|
|
||||||
HoverRequest request((TextDocumentPositionParams(TextDocumentIdentifier(m_uri), Position(cursor))));
|
|
||||||
m_currentRequest = request.id();
|
m_currentRequest = request.id();
|
||||||
request.setResponseCallback(
|
request.setResponseCallback(
|
||||||
[this](const HoverRequest::Response &response) { handleResponse(response); });
|
[this, cursor](const HoverRequest::Response &response) { handleResponse(response, cursor); });
|
||||||
m_client->sendMessage(request);
|
m_client->sendMessage(request);
|
||||||
}
|
}
|
||||||
|
|
||||||
void HoverHandler::handleResponse(const HoverRequest::Response &response)
|
void HoverHandler::handleResponse(const HoverRequest::Response &response, const QTextCursor &cursor)
|
||||||
{
|
{
|
||||||
m_currentRequest.reset();
|
m_currentRequest.reset();
|
||||||
if (Utils::optional<HoverRequest::Response::Error> error = response.error()) {
|
if (Utils::optional<HoverRequest::Response::Error> error = response.error()) {
|
||||||
@@ -139,6 +151,8 @@ void HoverHandler::handleResponse(const HoverRequest::Response &response)
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
setContent(hover->content());
|
setContent(hover->content());
|
||||||
|
} else if (!m_preferDiagnostics && reportDiagnostics(cursor)) {
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
m_report(priority());
|
m_report(priority());
|
||||||
|
@@ -48,6 +48,13 @@ public:
|
|||||||
|
|
||||||
void abort() override;
|
void abort() override;
|
||||||
|
|
||||||
|
/// If prefer diagnostics is enabled the hover handler checks whether a diagnostics is at the
|
||||||
|
/// pos passed to identifyMatch _before_ sending hover request to the server. If a diagnostic
|
||||||
|
/// can be found it will be used as a tooltip and no hover request is sent to the server.
|
||||||
|
/// If prefer diagnostics is disabled the diagnostics are only checked if the response is empty.
|
||||||
|
/// Defaults to prefer diagnostics.
|
||||||
|
void setPreferDiagnosticts(bool prefer);
|
||||||
|
|
||||||
void setHelpItemProvider(const HelpItemProvider &provider) { m_helpItemProvider = provider; }
|
void setHelpItemProvider(const HelpItemProvider &provider) { m_helpItemProvider = provider; }
|
||||||
void setHelpItem(const LanguageServerProtocol::MessageId &msgId, const Core::HelpItem &help);
|
void setHelpItem(const LanguageServerProtocol::MessageId &msgId, const Core::HelpItem &help);
|
||||||
|
|
||||||
@@ -57,8 +64,10 @@ protected:
|
|||||||
ReportPriority report) override;
|
ReportPriority report) override;
|
||||||
|
|
||||||
private:
|
private:
|
||||||
void handleResponse(const LanguageServerProtocol::HoverRequest::Response &response);
|
void handleResponse(const LanguageServerProtocol::HoverRequest::Response &response,
|
||||||
|
const QTextCursor &cursor);
|
||||||
void setContent(const LanguageServerProtocol::HoverContent &content);
|
void setContent(const LanguageServerProtocol::HoverContent &content);
|
||||||
|
bool reportDiagnostics(const QTextCursor &cursor);
|
||||||
|
|
||||||
QPointer<Client> m_client;
|
QPointer<Client> m_client;
|
||||||
Utils::optional<LanguageServerProtocol::MessageId> m_currentRequest;
|
Utils::optional<LanguageServerProtocol::MessageId> m_currentRequest;
|
||||||
@@ -66,6 +75,7 @@ private:
|
|||||||
LanguageServerProtocol::HoverRequest::Response m_response;
|
LanguageServerProtocol::HoverRequest::Response m_response;
|
||||||
TextEditor::BaseHoverHandler::ReportPriority m_report;
|
TextEditor::BaseHoverHandler::ReportPriority m_report;
|
||||||
HelpItemProvider m_helpItemProvider;
|
HelpItemProvider m_helpItemProvider;
|
||||||
|
bool m_preferDiagnostics = true;
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace LanguageClient
|
} // namespace LanguageClient
|
||||||
|
Reference in New Issue
Block a user