LanguageClient: add hover handler

Change-Id: Iddf30828ef26a157ab935d0abe708087ab123dd6 Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2019-05-15 11:19:31 +02:00
parent e04339b1e8
commit c874f07d53
15 changed files with 346 additions and 53 deletions
--- a/src/plugins/languageclient/languageclienthoverhandler.cpp
+++ b/src/plugins/languageclient/languageclienthoverhandler.cpp
@@ -0,0 +1,148 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+****************************************************************************/
+
+#include "languageclienthoverhandler.h"
+
+#include "client.h"
+
+#include <texteditor/textdocument.h>
+#include <texteditor/texteditor.h>
+#include <utils/mimetypes/mimedatabase.h>
+#include <utils/qtcassert.h>
+#include <utils/tooltip/tooltip.h>
+
+using namespace LanguageServerProtocol;
+
+namespace LanguageClient {
+
+HoverHandler::HoverHandler(Client *client)
+    : m_client(client)
+{}
+
+HoverHandler::~HoverHandler()
+{
+    abort();
+}
+
+void HoverHandler::abort()
+{
+    if (m_client && m_client->reachable() && m_currentRequest.has_value())
+        m_client->cancelRequest(*m_currentRequest);
+    m_currentRequest.reset();
+}
+
+void HoverHandler::identifyMatch(TextEditor::TextEditorWidget *editorWidget,
+                                 int pos,
+                                 TextEditor::BaseHoverHandler::ReportPriority report)
+{
+    if (m_currentRequest.has_value())
+        abort();
+    if (m_client.isNull()
+        || !m_client->documentOpen(editorWidget->textDocument())
+        || !m_client->capabilities().hoverProvider().value_or(false)) {
+        report(Priority_None);
+        return;
+    }
+
+    bool sendMessage = m_client->capabilities().hoverProvider().value_or(false);
+    if (Utils::optional<bool> registered = m_client->dynamicCapabilities().isRegistered(
+            HoverRequest::methodName)) {
+        sendMessage = registered.value();
+        if (sendMessage) {
+            const TextDocumentRegistrationOptions option(
+                m_client->dynamicCapabilities().option(HoverRequest::methodName).toObject());
+            if (option.isValid(nullptr)) {
+                sendMessage = option.filterApplies(editorWidget->textDocument()->filePath(),
+                                                   Utils::mimeTypeForName(
+                                                       editorWidget->textDocument()->mimeType()));
+            }
+        }
+    }
+    if (!sendMessage) {
+        report(Priority_None);
+        return;
+    }
+
+    m_report = report;
+    auto uri = DocumentUri::fromFileName(editorWidget->textDocument()->filePath());
+    QTextCursor cursor = editorWidget->textCursor();
+    cursor.setPosition(pos);
+    TextDocumentPositionParams params(uri, Position(cursor));
+    HoverRequest request(params);
+    request.setResponseCallback(
+        [this](const HoverRequest::Response &response) { handleResponse(response); });
+    m_client->sendContent(request);
+}
+
+void HoverHandler::operateTooltip(TextEditor::TextEditorWidget *editorWidget, const QPoint &point)
+{
+    if (toolTip().isEmpty())
+        Utils::ToolTip::hide();
+    else
+        Utils::ToolTip::show(point, toolTip(), editorWidget);
+}
+
+void HoverHandler::handleResponse(const HoverRequest::Response &response)
+{
+    m_currentRequest.reset();
+    if (Utils::optional<HoverRequest::Response::Error> error = response.error()) {
+        if (m_client)
+            m_client->log(error.value());
+    }
+    if (Utils::optional<Hover> result = response.result())
+        setContent(result.value().content());
+    m_report(priority());
+}
+
+static QString toolTipForMarkedStrings(const QList<MarkedString> &markedStrings)
+{
+    QString tooltip;
+    for (const MarkedString &markedString : markedStrings) {
+        if (!tooltip.isEmpty())
+            tooltip += '\n';
+        if (auto string = Utils::get_if<QString>(&markedString))
+            tooltip += *string;
+        else if (auto string = Utils::get_if<MarkedLanguageString>(&markedString))
+            tooltip += string->value() + " [" + string->language() + ']';
+    }
+    return tooltip;
+}
+
+void HoverHandler::setContent(const HoverContent &hoverContent)
+{
+    if (auto markupContent = Utils::get_if<MarkupContent>(&hoverContent)) {
+        const QString &content = markupContent->content();
+        if (markupContent->kind() == MarkupKind::plaintext)
+            setToolTip(content);
+        else if (m_client)
+            m_client->log(tr("Got unsupported markup hover content: ") + content);
+    } else if (auto markedString = Utils::get_if<MarkedString>(&hoverContent)) {
+        setToolTip(toolTipForMarkedStrings({*markedString}));
+    } else if (auto markedStrings = Utils::get_if<QList<MarkedString>>(&hoverContent)) {
+        setToolTip(toolTipForMarkedStrings(*markedStrings));
+    }
+}
+
+} // namespace LanguageClient