1 /****************************************************************************
2 **
3 ** Copyright (C) 2019 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qt Creator.
7 **
8 ** Commercial License Usage
9 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** accordance with the commercial license agreement provided with the
11 ** Software or, alternatively, in accordance with the terms contained in
12 ** a written agreement between you and The Qt Company. For licensing terms
13 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** information use the contact form at https://www.qt.io/contact-us.
15 **
16 ** GNU General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU
18 ** General Public License version 3 as published by the Free Software
19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
20 ** included in the packaging of this file. Please review the following
21 ** information to ensure the GNU General Public License requirements will
22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 **
24 ****************************************************************************/
25 
26 #pragma once
27 
28 #include "languageclient_global.h"
29 
30 #include <languageserverprotocol/languagefeatures.h>
31 #include <texteditor/basehoverhandler.h>
32 
33 #include <functional>
34 
35 namespace LanguageClient {
36 
37 class Client;
38 
39 using HelpItemProvider = std::function<void(const LanguageServerProtocol::HoverRequest::Response &,
40                                             const LanguageServerProtocol::DocumentUri &uri)>;
41 
42 class LANGUAGECLIENT_EXPORT HoverHandler final : public TextEditor::BaseHoverHandler
43 {
44     Q_DECLARE_TR_FUNCTIONS(HoverHandler)
45 public:
46     explicit HoverHandler(Client *client);
47     ~HoverHandler() override;
48 
49     void abort() override;
50 
setHelpItemProvider(const HelpItemProvider & provider)51     void setHelpItemProvider(const HelpItemProvider &provider) { m_helpItemProvider = provider; }
52     void setHelpItem(const LanguageServerProtocol::MessageId &msgId, const Core::HelpItem &help);
53 
54 protected:
55     void identifyMatch(TextEditor::TextEditorWidget *editorWidget,
56                        int pos,
57                        ReportPriority report) override;
58 
59 private:
60     void handleResponse(const LanguageServerProtocol::HoverRequest::Response &response);
61     void setContent(const LanguageServerProtocol::HoverContent &content);
62 
63     QPointer<Client> m_client;
64     Utils::optional<LanguageServerProtocol::MessageId> m_currentRequest;
65     LanguageServerProtocol::DocumentUri m_uri;
66     LanguageServerProtocol::HoverRequest::Response m_response;
67     TextEditor::BaseHoverHandler::ReportPriority m_report;
68     HelpItemProvider m_helpItemProvider;
69 };
70 
71 } // namespace LanguageClient
72