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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
/****************************************************************************
**
** 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.
**
****************************************************************************/
#include "highlightersettingspage.h"
#include "highlightersettings.h"
#include "highlighter.h"
#include <coreplugin/icore.h>
#include <utils/hostosinfo.h>
#include <utils/layoutbuilder.h>
#include <utils/pathchooser.h>
#include <QApplication>
#include <QDir>
#include <QLabel>
#include <QLineEdit>
#include <QMessageBox>
#include <QPointer>
#include <QPushButton>
using namespace TextEditor::Internal;
using namespace Utils;
namespace TextEditor {
namespace Internal {
class HighlighterSettingsPageWidget : public QWidget
{
public:
QLabel *definitionsInfolabel;
QPushButton *downloadDefinitions;
QLabel *updateStatus;
PathChooser *definitionFilesPath;
QPushButton *reloadDefinitions;
QPushButton *resetCache;
QLineEdit *ignoreEdit;
HighlighterSettingsPageWidget()
{
resize(521, 332);
definitionsInfolabel = new QLabel(this);
definitionsInfolabel->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);
definitionsInfolabel->setTextFormat(Qt::RichText);
definitionsInfolabel->setAlignment(Qt::AlignLeading|Qt::AlignLeft|Qt::AlignVCenter);
definitionsInfolabel->setWordWrap(true);
definitionsInfolabel->setOpenExternalLinks(true);
definitionsInfolabel->setText(tr("<html><head/><body><p>Highlight definitions are provided by the "
"<a href=\"https://api.kde.org/frameworks/syntax-highlighting/html/index.html\">"
"KSyntaxHighlighting</a> engine.</p></body></html>"));
downloadDefinitions = new QPushButton(tr("Download Definitions"));
downloadDefinitions->setToolTip(tr("Download missing and update existing syntax definition files."));
updateStatus = new QLabel;
definitionFilesPath = new PathChooser;
definitionFilesPath->setExpectedKind(PathChooser::ExistingDirectory);
definitionFilesPath->setHistoryCompleter("TextEditor.Highlighter.History");
reloadDefinitions = new QPushButton(tr("Reload Definitions"));
reloadDefinitions->setToolTip(tr("Reload externally modified definition files."));
resetCache = new QPushButton(tr("Reset Remembered Definitions"));
resetCache->setToolTip(tr("Reset definitions remembered for files that can be "
"associated with more than one highlighter definition."));
ignoreEdit = new QLineEdit;
using namespace Layouting;
Column {
definitionsInfolabel,
Space(3),
Group {
title(tr("Syntax Highlight Definition Files")),
Column {
Row { downloadDefinitions, updateStatus, st },
Row { tr("User Highlight Definition Files"),
definitionFilesPath, reloadDefinitions },
Row { st, resetCache }
}
},
Row { tr("Ignored file patterns:"), ignoreEdit },
st
}.attachTo(this);
connect(downloadDefinitions, &QPushButton::pressed,
[label = QPointer<QLabel>(updateStatus)]() {
Highlighter::downloadDefinitions([label] {
if (label)
label->setText(tr("Download finished"));
});
});
connect(reloadDefinitions, &QPushButton::pressed, this, [] {
Highlighter::reload();
});
connect(resetCache, &QPushButton::clicked, this, [] {
Highlighter::clearDefinitionForDocumentCache();
});
}
};
} // Internal
class HighlighterSettingsPagePrivate
{
Q_DECLARE_TR_FUNCTIONS(TextEditor::Internal::HighlighterSettingsPage)
public:
HighlighterSettingsPagePrivate() = default;
void ensureInitialized();
void migrateGenericHighlighterFiles();
void settingsFromUI();
void settingsToUI();
bool settingsChanged();
bool m_initialized = false;
const QString m_settingsPrefix{"Text"};
HighlighterSettings m_settings;
QPointer<HighlighterSettingsPageWidget> m_widget;
};
void HighlighterSettingsPagePrivate::migrateGenericHighlighterFiles()
{
QDir userDefinitionPath(m_settings.definitionFilesPath().toString());
if (userDefinitionPath.mkdir("syntax")) {
const auto link = Utils::HostOsInfo::isAnyUnixHost()
? static_cast<bool(*)(const QString &, const QString &)>(&QFile::link)
: static_cast<bool(*)(const QString &, const QString &)>(&QFile::copy);
for (const QFileInfo &file : userDefinitionPath.entryInfoList({"*.xml"}, QDir::Files))
link(file.filePath(), file.absolutePath() + "/syntax/" + file.fileName());
}
}
void HighlighterSettingsPagePrivate::ensureInitialized()
{
if (m_initialized)
return;
m_initialized = true;
m_settings.fromSettings(m_settingsPrefix, Core::ICore::settings());
migrateGenericHighlighterFiles();
}
HighlighterSettingsPage::HighlighterSettingsPage()
: d(new HighlighterSettingsPagePrivate)
{
setId(Constants::TEXT_EDITOR_HIGHLIGHTER_SETTINGS);
setDisplayName(HighlighterSettingsPagePrivate::tr("Generic Highlighter"));
setCategory(TextEditor::Constants::TEXT_EDITOR_SETTINGS_CATEGORY);
setDisplayCategory(QCoreApplication::translate("TextEditor", "Text Editor"));
setCategoryIconPath(TextEditor::Constants::TEXT_EDITOR_SETTINGS_CATEGORY_ICON_PATH);
}
HighlighterSettingsPage::~HighlighterSettingsPage()
{
delete d;
}
QWidget *HighlighterSettingsPage::widget()
{
if (!d->m_widget) {
d->m_widget = new HighlighterSettingsPageWidget;
d->settingsToUI();
}
return d->m_widget;
}
void HighlighterSettingsPage::apply()
{
if (!d->m_widget) // page was not shown
return;
if (d->settingsChanged())
d->settingsFromUI();
}
void HighlighterSettingsPage::finish()
{
delete d->m_widget;
d->m_widget = nullptr;
}
const HighlighterSettings &HighlighterSettingsPage::highlighterSettings() const
{
d->ensureInitialized();
return d->m_settings;
}
void HighlighterSettingsPagePrivate::settingsFromUI()
{
ensureInitialized();
m_settings.setDefinitionFilesPath(m_widget->definitionFilesPath->filePath());
m_settings.setIgnoredFilesPatterns(m_widget->ignoreEdit->text());
m_settings.toSettings(m_settingsPrefix, Core::ICore::settings());
}
void HighlighterSettingsPagePrivate::settingsToUI()
{
ensureInitialized();
m_widget->definitionFilesPath->setFilePath(m_settings.definitionFilesPath());
m_widget->ignoreEdit->setText(m_settings.ignoredFilesPatterns());
}
bool HighlighterSettingsPagePrivate::settingsChanged()
{
ensureInitialized();
return m_settings.definitionFilesPath() != m_widget->definitionFilesPath->filePath()
|| m_settings.ignoredFilesPatterns() != m_widget->ignoreEdit->text();
}
} // TextEditor
|
