blob: f204de7fd9c5e97fa186982a0257504179e08f31 (
plain)
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
|
/****************************************************************************
**
** 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.
**
****************************************************************************/
#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 LanguageServerProtocol::DocumentUri &uri)>;
class LANGUAGECLIENT_EXPORT HoverHandler final : public TextEditor::BaseHoverHandler
{
Q_DECLARE_TR_FUNCTIONS(HoverHandler)
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;
Utils::optional<LanguageServerProtocol::MessageId> m_currentRequest;
LanguageServerProtocol::DocumentUri m_uri;
LanguageServerProtocol::HoverRequest::Response m_response;
TextEditor::BaseHoverHandler::ReportPriority m_report;
HelpItemProvider m_helpItemProvider;
bool m_preferDiagnostics = true;
};
} // namespace LanguageClient
|
