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
|
/****************************************************************************
**
** Copyright (C) 2016 Lorenz Haas
** 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 "uncrustifysettings.h"
#include "uncrustifyconstants.h"
#include "../beautifierconstants.h"
#include <coreplugin/icore.h>
#include <QDateTime>
#include <QFile>
#include <QFileInfo>
#include <QProcess>
#include <QRegularExpression>
#include <QXmlStreamWriter>
namespace Beautifier {
namespace Internal {
namespace Uncrustify {
namespace {
const QString kUseOtherFiles = QLatin1String("useOtherFiles");
const QString kUseHomeFile = QLatin1String("useHomeFile");
const QString kUseCustomStyle = QLatin1String("useCustomStyle");
const QString kCustomStyle = QLatin1String("customStyle");
const QString kFormatEntireFileFallback = QLatin1String("formatEntireFileFallback");
}
UncrustifySettings::UncrustifySettings() :
AbstractSettings(QLatin1String(Constants::Uncrustify::SETTINGS_NAME), QLatin1String(".cfg"))
{
connect(&m_versionProcess,
static_cast<void(QProcess::*)(int, QProcess::ExitStatus)>(&QProcess::finished),
this, &UncrustifySettings::parseVersionProcessResult);
setCommand(QLatin1String("uncrustify"));
m_settings.insert(kUseOtherFiles, QVariant(true));
m_settings.insert(kUseHomeFile, QVariant(false));
m_settings.insert(kUseCustomStyle, QVariant(false));
m_settings.insert(kCustomStyle, QVariant());
m_settings.insert(kFormatEntireFileFallback, QVariant(true));
read();
}
bool UncrustifySettings::useOtherFiles() const
{
return m_settings.value(kUseOtherFiles).toBool();
}
void UncrustifySettings::setUseOtherFiles(bool useOtherFiles)
{
m_settings.insert(kUseOtherFiles, QVariant(useOtherFiles));
}
bool UncrustifySettings::useHomeFile() const
{
return m_settings.value(kUseHomeFile).toBool();
}
void UncrustifySettings::setUseHomeFile(bool useHomeFile)
{
m_settings.insert(kUseHomeFile, QVariant(useHomeFile));
}
bool UncrustifySettings::useCustomStyle() const
{
return m_settings.value(kUseCustomStyle).toBool();
}
void UncrustifySettings::setUseCustomStyle(bool useCustomStyle)
{
m_settings.insert(kUseCustomStyle, QVariant(useCustomStyle));
}
QString UncrustifySettings::customStyle() const
{
return m_settings.value(kCustomStyle).toString();
}
void UncrustifySettings::setCustomStyle(const QString &customStyle)
{
m_settings.insert(kCustomStyle, QVariant(customStyle));
}
bool UncrustifySettings::formatEntireFileFallback() const
{
return m_settings.value(kFormatEntireFileFallback).toBool();
}
void UncrustifySettings::setFormatEntireFileFallback(bool formatEntireFileFallback)
{
m_settings.insert(kFormatEntireFileFallback, QVariant(formatEntireFileFallback));
}
QString UncrustifySettings::documentationFilePath() const
{
return Core::ICore::userResourcePath() + QLatin1Char('/')
+ QLatin1String(Beautifier::Constants::SETTINGS_DIRNAME) + QLatin1Char('/')
+ QLatin1String(Beautifier::Constants::DOCUMENTATION_DIRNAME) + QLatin1Char('/')
+ QLatin1String(Constants::Uncrustify::SETTINGS_NAME) + QLatin1String(".xml");
}
void UncrustifySettings::createDocumentationFile() const
{
QProcess process;
process.start(command(), QStringList() << QLatin1String("--show-config"));
process.waitForFinished(2000); // show config should be really fast.
if (process.error() != QProcess::UnknownError)
return;
QFile file(documentationFilePath());
const QFileInfo fi(file);
if (!fi.exists())
fi.dir().mkpath(fi.absolutePath());
if (!file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text))
return;
bool contextWritten = false;
QXmlStreamWriter stream(&file);
stream.setAutoFormatting(true);
stream.writeStartDocument(QLatin1String("1.0"), true);
stream.writeComment(QLatin1String("Created ")
+ QDateTime::currentDateTime().toString(Qt::ISODate));
stream.writeStartElement(QLatin1String(Constants::DOCUMENTATION_XMLROOT));
const QStringList lines = QString::fromUtf8(process.readAll()).split(QLatin1Char('\n'));
const int totalLines = lines.count();
for (int i = 0; i < totalLines; ++i) {
const QString &line = lines.at(i);
if (line.startsWith(QLatin1Char('#')) || line.trimmed().isEmpty())
continue;
const int firstSpace = line.indexOf(QLatin1Char(' '));
const QString keyword = line.left(firstSpace);
const QString options = line.right(line.size() - firstSpace).trimmed();
QStringList docu;
while (++i < totalLines) {
const QString &subline = lines.at(i);
if (line.startsWith(QLatin1Char('#')) || subline.trimmed().isEmpty()) {
const QString text = QLatin1String("<p><span class=\"option\">") + keyword
+ QLatin1String("</span> <span class=\"param\">") + options
+ QLatin1String("</span></p><p>")
+ (docu.join(QLatin1Char(' ')).toHtmlEscaped())
+ QLatin1String("</p>");
stream.writeStartElement(QLatin1String(Constants::DOCUMENTATION_XMLENTRY));
stream.writeTextElement(QLatin1String(Constants::DOCUMENTATION_XMLKEY), keyword);
stream.writeTextElement(QLatin1String(Constants::DOCUMENTATION_XMLDOC), text);
stream.writeEndElement();
contextWritten = true;
break;
} else {
docu << subline;
}
}
}
stream.writeEndElement();
stream.writeEndDocument();
// An empty file causes error messages and a contextless file preventing this function to run
// again in order to generate the documentation successfully. Thus delete the file.
if (!contextWritten) {
file.close();
file.remove();
}
}
static bool parseVersion(const QString &text, int &version)
{
// The version in Uncrustify is printed like "uncrustify 0.62"
const QRegularExpression rx(QLatin1String("([0-9]{1})\\.([0-9]{2})"));
const QRegularExpressionMatch match = rx.match(text);
if (!match.hasMatch())
return false;
const int major = match.captured(1).toInt() * 100;
const int minor = match.captured(2).toInt();
version = major + minor;
return true;
}
void UncrustifySettings::updateVersion()
{
if (m_versionProcess.state() != QProcess::NotRunning) {
m_versionProcess.kill();
m_versionProcess.waitForFinished();
}
m_versionProcess.start(command(), QStringList() << QLatin1String("--version"));
}
void UncrustifySettings::parseVersionProcessResult(int exitCode, QProcess::ExitStatus exitStatus)
{
Q_UNUSED(exitCode)
if (exitStatus != QProcess::NormalExit)
return;
if (!parseVersion(QString::fromUtf8(m_versionProcess.readAllStandardOutput()), m_version))
parseVersion(QString::fromUtf8(m_versionProcess.readAllStandardError()), m_version);
}
} // namespace Uncrustify
} // namespace Internal
} // namespace Beautifier
|
