forked from qt-creator/qt-creator
77054c2fa3
Change-Id: Idbd7c5cdadba4f269b2033df91db0e05bb5281d5 Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
59 lines
2.2 KiB
C++
59 lines
2.2 KiB
C++
// Copyright (C) 2019 The Qt Company Ltd.
|
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
|
|
|
|
#pragma once
|
|
|
|
#include "languageclient_global.h"
|
|
|
|
#include <languageserverprotocol/languagefeatures.h>
|
|
#include <texteditor/basehoverhandler.h>
|
|
|
|
#include <functional>
|
|
|
|
namespace LanguageClient {
|
|
|
|
class Client;
|
|
|
|
using HelpItemProvider = std::function<void(const LanguageServerProtocol::HoverRequest::Response &,
|
|
const Utils::FilePath &path)>;
|
|
|
|
class LANGUAGECLIENT_EXPORT HoverHandler final : public TextEditor::BaseHoverHandler
|
|
{
|
|
public:
|
|
explicit HoverHandler(Client *client);
|
|
~HoverHandler() 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 setHelpItem(const LanguageServerProtocol::MessageId &msgId, const Core::HelpItem &help);
|
|
|
|
protected:
|
|
void identifyMatch(TextEditor::TextEditorWidget *editorWidget,
|
|
int pos,
|
|
ReportPriority report) override;
|
|
|
|
private:
|
|
void handleResponse(const LanguageServerProtocol::HoverRequest::Response &response,
|
|
const QTextCursor &cursor);
|
|
void setContent(const LanguageServerProtocol::HoverContent &content);
|
|
bool reportDiagnostics(const QTextCursor &cursor);
|
|
|
|
QPointer<Client> m_client;
|
|
std::optional<LanguageServerProtocol::MessageId> m_currentRequest;
|
|
Utils::FilePath m_filePath;
|
|
LanguageServerProtocol::HoverRequest::Response m_response;
|
|
TextEditor::BaseHoverHandler::ReportPriority m_report;
|
|
HelpItemProvider m_helpItemProvider;
|
|
bool m_preferDiagnostics = true;
|
|
};
|
|
|
|
} // namespace LanguageClient
|