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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include "clangdiagnosticconfig.h"
#include "cppeditor_global.h"
#include <utils/filepath.h>
#include <utils/store.h>
namespace ProjectExplorer { class Project; }
namespace Utils { class MacroExpander; }
namespace CppEditor {
// TODO: Can we move this to ClangCodeModel?
class CPPEDITOR_EXPORT ClangdSettings : public QObject
{
Q_OBJECT
public:
enum class IndexingPriority { Off, Background, Normal, Low, };
enum class HeaderSourceSwitchMode { BuiltinOnly, ClangdOnly, Both };
enum class CompletionRankingModel { Default, DecisionForest, Heuristics };
static QString priorityToString(const IndexingPriority &priority);
static QString priorityToDisplayString(const IndexingPriority &priority);
static QString headerSourceSwitchModeToDisplayString(HeaderSourceSwitchMode mode);
static QString rankingModelToCmdLineString(CompletionRankingModel model);
static QString rankingModelToDisplayString(CompletionRankingModel model);
static QString defaultProjectIndexPathTemplate();
static QString defaultSessionIndexPathTemplate();
class CPPEDITOR_EXPORT Data
{
public:
Utils::Store toMap() const;
void fromMap(const Utils::Store &map);
friend bool operator==(const Data &s1, const Data &s2)
{
return s1.useClangd == s2.useClangd
&& s1.executableFilePath == s2.executableFilePath
&& s1.projectIndexPathTemplate == s2.projectIndexPathTemplate
&& s1.sessionIndexPathTemplate == s2.sessionIndexPathTemplate
&& s1.sessionsWithOneClangd == s2.sessionsWithOneClangd
&& s1.customDiagnosticConfigs == s2.customDiagnosticConfigs
&& s1.diagnosticConfigId == s2.diagnosticConfigId
&& s1.workerThreadLimit == s2.workerThreadLimit
&& s1.indexingPriority == s2.indexingPriority
&& s1.headerSourceSwitchMode == s2.headerSourceSwitchMode
&& s1.completionRankingModel == s2.completionRankingModel
&& s1.autoIncludeHeaders == s2.autoIncludeHeaders
&& s1.documentUpdateThreshold == s2.documentUpdateThreshold
&& s1.sizeThresholdEnabled == s2.sizeThresholdEnabled
&& s1.sizeThresholdInKb == s2.sizeThresholdInKb
&& s1.haveCheckedHardwareReqirements == s2.haveCheckedHardwareReqirements
&& s1.updateDependentSources == s2.updateDependentSources
&& s1.completionResults == s2.completionResults;
}
friend bool operator!=(const Data &s1, const Data &s2) { return !(s1 == s2); }
Utils::FilePath executableFilePath;
QStringList sessionsWithOneClangd;
ClangDiagnosticConfigs customDiagnosticConfigs;
Utils::Id diagnosticConfigId;
int workerThreadLimit = 0;
int documentUpdateThreshold = 500;
qint64 sizeThresholdInKb = 1024;
bool useClangd = true;
IndexingPriority indexingPriority = IndexingPriority::Low;
QString projectIndexPathTemplate = defaultProjectIndexPathTemplate();
QString sessionIndexPathTemplate = defaultSessionIndexPathTemplate();
HeaderSourceSwitchMode headerSourceSwitchMode = HeaderSourceSwitchMode::Both;
CompletionRankingModel completionRankingModel = CompletionRankingModel::Default;
bool autoIncludeHeaders = false;
bool sizeThresholdEnabled = false;
bool haveCheckedHardwareReqirements = false;
bool updateDependentSources = false;
int completionResults = defaultCompletionResults();
private:
static int defaultCompletionResults();
};
ClangdSettings(const Data &data) : m_data(data) {}
static ClangdSettings &instance();
bool useClangd() const;
static void setUseClangd(bool use);
static void setUseClangdAndSave(bool use);
static bool hardwareFulfillsRequirements();
static bool haveCheckedHardwareRequirements();
static void setDefaultClangdPath(const Utils::FilePath &filePath);
static void setCustomDiagnosticConfigs(const ClangDiagnosticConfigs &configs);
Utils::FilePath clangdFilePath() const;
IndexingPriority indexingPriority() const { return m_data.indexingPriority; }
Utils::FilePath projectIndexPath(const Utils::MacroExpander &expander) const;
Utils::FilePath sessionIndexPath(const Utils::MacroExpander &expander) const;
HeaderSourceSwitchMode headerSourceSwitchMode() const { return m_data.headerSourceSwitchMode; }
CompletionRankingModel completionRankingModel() const { return m_data.completionRankingModel; }
bool autoIncludeHeaders() const { return m_data.autoIncludeHeaders; }
bool updateDependentSources() const { return m_data.updateDependentSources; }
int workerThreadLimit() const { return m_data.workerThreadLimit; }
int documentUpdateThreshold() const { return m_data.documentUpdateThreshold; }
qint64 sizeThresholdInKb() const { return m_data.sizeThresholdInKb; }
bool sizeThresholdEnabled() const { return m_data.sizeThresholdEnabled; }
int completionResults() const { return m_data.completionResults; }
bool sizeIsOkay(const Utils::FilePath &fp) const;
ClangDiagnosticConfigs customDiagnosticConfigs() const;
Utils::Id diagnosticConfigId() const;
ClangDiagnosticConfig diagnosticConfig() const;
enum class Granularity { Project, Session };
Granularity granularity() const;
void setData(const Data &data, bool saveAndEmitSignal = true);
Data data() const { return m_data; }
Utils::FilePath clangdIncludePath() const;
static Utils::FilePath clangdUserConfigFilePath();
#ifdef WITH_TESTS
static void setClangdFilePath(const Utils::FilePath &filePath);
#endif
signals:
void changed();
private:
ClangdSettings();
void loadSettings();
void saveSettings();
Data m_data;
};
class CPPEDITOR_EXPORT ClangdProjectSettings
{
public:
ClangdProjectSettings(ProjectExplorer::Project *project);
ClangdSettings::Data settings() const;
void setSettings(const ClangdSettings::Data &data);
bool useGlobalSettings() const { return m_useGlobalSettings; }
void setUseGlobalSettings(bool useGlobal);
void setDiagnosticConfigId(Utils::Id configId);
void blockIndexing();
void unblockIndexing();
private:
void loadSettings();
void saveSettings();
ProjectExplorer::Project * const m_project;
ClangdSettings::Data m_customSettings;
bool m_useGlobalSettings = true;
bool m_blockIndexing = false;
};
namespace Internal {
void setupClangdProjectSettingsPanel();
void setupClangdSettingsPage();
}
} // namespace CppEditor
|
