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
|
/* KDevelop CMake Support
*
* Copyright 2009 Aleix Pol <aleixpol@kde.org>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*/
#include "cmakecommandscontents.h"
#include <interfaces/iruntimecontroller.h>
#include <interfaces/iruntime.h>
#include <interfaces/icore.h>
#include <interfaces/idocumentation.h>
#include <interfaces/idocumentationcontroller.h>
#include "cmakebuilderconfig.h"
#include "cmakedoc.h"
#include <QProcess>
#include <KLocalizedString>
#include <array>
static const std::array<QString, 6> args = {
QStringLiteral("--help-command"),
QStringLiteral("--help-variable"),
QStringLiteral("--help-module"),
QStringLiteral("--help-property"),
QStringLiteral("--help-policy"),
QString(),
};
static const std::array<QString, 5> modules = {
i18nc("@item cmake", "Commands"),
i18nc("@item cmake", "Variables"),
i18nc("@item cmake", "Modules"),
i18nc("@item cmake", "Properties"),
i18nc("@item cmake", "Policies"),
};
CMakeCommandsContents::CMakeCommandsContents(QObject* parent)
: QAbstractItemModel(parent)
, m_namesForType(CMakeDocumentation::EOType)
{
for (int i = 0; i <= CMakeDocumentation::Policy; ++i) {
const QStringList params = { args[i]+QStringLiteral("-list") };
auto* process = new QProcess(this);
process->setProperty("type", i);
process->setProgram(CMakeBuilderSettings::self()->cmakeExecutable().toLocalFile());
process->setArguments(params);
KDevelop::ICore::self()->runtimeController()->currentRuntime()->startProcess(process);
connect(process, QOverload<int, QProcess::ExitStatus>::of(&QProcess::finished),
this, &CMakeCommandsContents::processOutput);
}
}
void CMakeCommandsContents::processOutput(int code)
{
auto* process = qobject_cast<QProcess*>(sender());
if (code!=0) {
qDebug() << "failed" << process;
return;
}
const CMakeDocumentation::Type type = CMakeDocumentation::Type(process->property("type").toInt());
QTextStream stream(process);
QString line = stream.readLine(); //discard first line
QVector<QString> names;
while(stream.readLineInto(&line)) {
names += line;
}
beginInsertRows(index(type, 0, {}), 0, names.count()-1);
for (auto& name : qAsConst(names)) {
m_typeForName.insert(name, type);
}
m_namesForType[type] = names;
endInsertRows();
}
CMakeDocumentation::Type CMakeCommandsContents::typeFor(const QString& identifier) const
{
//TODO can do much better
if(m_typeForName.contains(identifier)) {
return m_typeForName[identifier];
} else if(m_typeForName.contains(identifier.toLower())) {
return m_typeForName[identifier.toLower()];
} else if(m_typeForName.contains(identifier.toUpper())) {
return m_typeForName[identifier.toUpper()];
}
return CMakeDocumentation::EOType;
}
QString CMakeCommandsContents::descriptionForIdentifier(const QString& id, CMakeDocumentation::Type t) const
{
QString desc;
if(args[t].size() != 0) {
desc = CMake::executeProcess(CMakeBuilderSettings::self()->cmakeExecutable().toLocalFile(), { args[t], id.simplified() });
desc.remove(QLatin1String(":ref:"));
const QString rst2html = QStandardPaths::findExecutable(QStringLiteral("rst2html"));
if (rst2html.isEmpty()) {
desc = (QLatin1String("<html><body style='background:#fff'><pre><code>") + desc.toHtmlEscaped() + QLatin1String("</code></pre>")
+ i18n("<p>For better CMake documentation rendering, install rst2html.</p>")
+ QLatin1String("</body></html>"));
} else {
QProcess p;
p.start(rst2html, { QStringLiteral("--no-toc-backlinks"), QStringLiteral("--quiet") });
p.write(desc.toUtf8());
p.closeWriteChannel();
p.waitForFinished();
desc = QString::fromUtf8(p.readAllStandardOutput());
}
}
return desc;
}
void CMakeCommandsContents::showItemAt(const QModelIndex& idx) const
{
if(idx.isValid() && int(idx.internalId())>=0) {
QString desc=CMakeDoc::s_provider->descriptionForIdentifier(idx.data().toString(),
(ICMakeDocumentation::Type) idx.parent().row());
CMakeDoc::Ptr doc(new CMakeDoc(idx.data().toString(), desc));
KDevelop::ICore::self()->documentationController()->showDocumentation(doc);
}
}
QModelIndex CMakeCommandsContents::parent(const QModelIndex& child) const
{
if(child.isValid() && child.column()==0 && int(child.internalId())>=0)
return createIndex(child.internalId(),0, -1);
return QModelIndex();
}
QModelIndex CMakeCommandsContents::index(int row, int column, const QModelIndex& parent) const
{
if(row<0 || column!=0)
return QModelIndex();
if(!parent.isValid() && row==ICMakeDocumentation::EOType)
return QModelIndex();
return createIndex(row,column, int(parent.isValid() ? parent.row() : -1));
}
int CMakeCommandsContents::rowCount(const QModelIndex& parent) const
{
if(!parent.isValid())
return ICMakeDocumentation::EOType;
else if(int(parent.internalId())<0) {
int ss=names((ICMakeDocumentation::Type) parent.row()).size();
return ss;
}
return 0;
}
QVariant CMakeCommandsContents::data(const QModelIndex& index, int role) const
{
if (index.isValid()) {
if(role==Qt::DisplayRole) {
int internal(index.internalId());
if(internal>=0)
return m_namesForType[internal].count() > index.row() ? QVariant(m_namesForType[internal].at(index.row())) : QVariant();
else
return modules[index.row()];
}
}
return QVariant();
}
int CMakeCommandsContents::columnCount(const QModelIndex& /*parent*/) const
{
return 1;
}
QVector<QString> CMakeCommandsContents::names(ICMakeDocumentation::Type t) const
{
return m_namesForType[t];
}
|
