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 "utils/optional.h"
31 
32 #include <languageserverprotocol/languagefeatures.h>
33 #include <languageserverprotocol/lsptypes.h>
34 
35 #include <QMap>
36 #include <QObject>
37 #include <QSet>
38 #include <QTimer>
39 
40 namespace LanguageClient {
41 
42 class Client;
43 
44 class LANGUAGECLIENT_EXPORT DocumentSymbolCache : public QObject
45 {
46     Q_OBJECT
47 public:
48     DocumentSymbolCache(Client *client);
49 
50     void requestSymbols(const LanguageServerProtocol::DocumentUri &uri);
51 
52 signals:
53     void gotSymbols(const LanguageServerProtocol::DocumentUri &uri,
54                     const LanguageServerProtocol::DocumentSymbolsResult &symbols);
55 
56 private:
57     void requestSymbolsImpl();
58     void handleResponse(const LanguageServerProtocol::DocumentUri &uri,
59                         const LanguageServerProtocol::DocumentSymbolsRequest::Response &response);
60 
61     QMap<LanguageServerProtocol::DocumentUri, LanguageServerProtocol::DocumentSymbolsResult> m_cache;
62     Client *m_client = nullptr;
63     QTimer m_compressionTimer;
64     QSet<LanguageServerProtocol::DocumentUri> m_compressedUris;
65 };
66 
67 } // namespace LanguageClient
68